File size: 19,256 Bytes
065fee7 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 |
# Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
import glob
import io
import os
from uuid import uuid4
from botocore.exceptions import ClientError
from s3transfer.subscribers import BaseSubscriber
from s3transfer.utils import OSUtils
from tests import (
HAS_CRT,
NonSeekableReader,
NonSeekableWriter,
assert_files_equal,
requires_crt,
)
from tests.integration import BaseTransferManagerIntegTest
if HAS_CRT:
from awscrt.exceptions import AwsCrtError
import s3transfer.crt
class RecordingSubscriber(BaseSubscriber):
def __init__(self):
self.on_queued_called = False
self.on_done_called = False
self.bytes_transferred = 0
def on_queued(self, **kwargs):
self.on_queued_called = True
def on_progress(self, future, bytes_transferred, **kwargs):
self.bytes_transferred += bytes_transferred
def on_done(self, **kwargs):
self.on_done_called = True
@requires_crt
class TestCRTS3Transfers(BaseTransferManagerIntegTest):
"""Tests for the high level s3transfer based on CRT implementation."""
def setUp(self):
super().setUp()
self.s3_key = 's3key.txt'
self.download_path = os.path.join(self.files.rootdir, 'download.txt')
def _create_s3_transfer(self):
self.request_serializer = s3transfer.crt.BotocoreCRTRequestSerializer(
self.session, client_kwargs={'region_name': self.region}
)
self.s3_crt_client = s3transfer.crt.create_s3_crt_client(
self.region, self._get_crt_credentials_provider()
)
self.record_subscriber = RecordingSubscriber()
self.osutil = OSUtils()
return s3transfer.crt.CRTTransferManager(
self.s3_crt_client, self.request_serializer
)
def _get_crt_credentials_provider(self):
botocore_credentials = self.session.get_credentials()
wrapper = s3transfer.crt.BotocoreCRTCredentialsWrapper(
botocore_credentials
)
return wrapper.to_crt_credentials_provider()
def _upload_with_crt_transfer_manager(self, fileobj, key=None):
if key is None:
key = self.s3_key
self.addCleanup(self.delete_object, key)
with self._create_s3_transfer() as transfer:
future = transfer.upload(
fileobj,
self.bucket_name,
key,
subscribers=[self.record_subscriber],
)
future.result()
def _download_with_crt_transfer_manager(self, fileobj, key=None):
if key is None:
key = self.s3_key
self.addCleanup(self.delete_object, key)
with self._create_s3_transfer() as transfer:
future = transfer.download(
self.bucket_name,
key,
fileobj,
subscribers=[self.record_subscriber],
)
future.result()
def _assert_expected_s3_object(self, key, expected_size=None):
self.assertTrue(self.object_exists(key))
if expected_size is not None:
response = self.client.head_object(
Bucket=self.bucket_name, Key=key
)
self.assertEqual(response['ContentLength'], expected_size)
def _assert_has_public_read_acl(self, response):
grants = response['Grants']
public_read = [
g['Grantee'].get('URI', '')
for g in grants
if g['Permission'] == 'READ'
]
self.assertIn('groups/global/AllUsers', public_read[0])
def _assert_subscribers_called(self, expected_bytes_transferred=None):
self.assertTrue(self.record_subscriber.on_queued_called)
self.assertTrue(self.record_subscriber.on_done_called)
if expected_bytes_transferred:
self.assertEqual(
self.record_subscriber.bytes_transferred,
expected_bytes_transferred,
)
def test_upload_below_multipart_chunksize(self):
transfer = self._create_s3_transfer()
file_size = 1024 * 1024
filename = self.files.create_file_with_size(
'foo.txt', filesize=file_size
)
self.addCleanup(self.delete_object, 'foo.txt')
with transfer:
future = transfer.upload(
filename,
self.bucket_name,
'foo.txt',
subscribers=[self.record_subscriber],
)
future.result()
self.assertTrue(self.object_exists('foo.txt'))
self._assert_subscribers_called(file_size)
def test_upload_above_multipart_chunksize(self):
transfer = self._create_s3_transfer()
file_size = 20 * 1024 * 1024
filename = self.files.create_file_with_size(
'20mb.txt', filesize=file_size
)
self.addCleanup(self.delete_object, '20mb.txt')
with transfer:
future = transfer.upload(
filename,
self.bucket_name,
'20mb.txt',
subscribers=[self.record_subscriber],
)
future.result()
self.assertTrue(self.object_exists('20mb.txt'))
self._assert_subscribers_called(file_size)
def test_upload_file_above_threshold_with_acl(self):
transfer = self._create_s3_transfer()
file_size = 6 * 1024 * 1024
filename = self.files.create_file_with_size(
'6mb.txt', filesize=file_size
)
extra_args = {'ACL': 'public-read'}
self.addCleanup(self.delete_object, '6mb.txt')
with transfer:
future = transfer.upload(
filename,
self.bucket_name,
'6mb.txt',
extra_args=extra_args,
subscribers=[self.record_subscriber],
)
future.result()
self.assertTrue(self.object_exists('6mb.txt'))
response = self.client.get_object_acl(
Bucket=self.bucket_name, Key='6mb.txt'
)
self._assert_has_public_read_acl(response)
self._assert_subscribers_called(file_size)
def test_upload_file_above_threshold_with_ssec(self):
key_bytes = os.urandom(32)
extra_args = {
'SSECustomerKey': key_bytes,
'SSECustomerAlgorithm': 'AES256',
}
file_size = 6 * 1024 * 1024
transfer = self._create_s3_transfer()
filename = self.files.create_file_with_size(
'6mb.txt', filesize=file_size
)
self.addCleanup(self.delete_object, '6mb.txt')
with transfer:
future = transfer.upload(
filename,
self.bucket_name,
'6mb.txt',
extra_args=extra_args,
subscribers=[self.record_subscriber],
)
future.result()
# A head object will fail if it has a customer key
# associated with it and it's not provided in the HeadObject
# request so we can use this to verify our functionality.
oringal_extra_args = {
'SSECustomerKey': key_bytes,
'SSECustomerAlgorithm': 'AES256',
}
self.wait_object_exists('6mb.txt', oringal_extra_args)
response = self.client.head_object(
Bucket=self.bucket_name, Key='6mb.txt', **oringal_extra_args
)
self.assertEqual(response['SSECustomerAlgorithm'], 'AES256')
self._assert_subscribers_called(file_size)
def test_upload_seekable_stream(self):
size = 1024 * 1024
self._upload_with_crt_transfer_manager(io.BytesIO(b'0' * size))
self._assert_expected_s3_object(self.s3_key, expected_size=size)
self._assert_subscribers_called(size)
def test_multipart_upload_seekable_stream(self):
size = 20 * 1024 * 1024
self._upload_with_crt_transfer_manager(io.BytesIO(b'0' * size))
self._assert_expected_s3_object(self.s3_key, expected_size=size)
self._assert_subscribers_called(size)
def test_upload_nonseekable_stream(self):
size = 1024 * 1024
self._upload_with_crt_transfer_manager(NonSeekableReader(b'0' * size))
self._assert_expected_s3_object(self.s3_key, expected_size=size)
self._assert_subscribers_called(size)
def test_multipart_upload_nonseekable_stream(self):
size = 20 * 1024 * 1024
self._upload_with_crt_transfer_manager(NonSeekableReader(b'0' * size))
self._assert_expected_s3_object(self.s3_key, expected_size=size)
self._assert_subscribers_called(size)
def test_upload_empty_file(self):
size = 0
filename = self.files.create_file_with_size(self.s3_key, filesize=size)
self._upload_with_crt_transfer_manager(filename)
self._assert_expected_s3_object(self.s3_key, expected_size=size)
self._assert_subscribers_called(size)
def test_upload_empty_stream(self):
size = 0
self._upload_with_crt_transfer_manager(io.BytesIO(b''))
self._assert_expected_s3_object(self.s3_key, expected_size=size)
self._assert_subscribers_called(size)
def test_can_send_extra_params_on_download(self):
# We're picking the customer provided sse feature
# of S3 to test the extra_args functionality of
# S3.
key_bytes = os.urandom(32)
extra_args = {
'SSECustomerKey': key_bytes,
'SSECustomerAlgorithm': 'AES256',
}
filename = self.files.create_file('foo.txt', 'hello world')
self.upload_file(filename, 'foo.txt', extra_args)
transfer = self._create_s3_transfer()
download_path = os.path.join(self.files.rootdir, 'downloaded.txt')
with transfer:
future = transfer.download(
self.bucket_name,
'foo.txt',
download_path,
extra_args=extra_args,
subscribers=[self.record_subscriber],
)
future.result()
file_size = self.osutil.get_file_size(download_path)
self._assert_subscribers_called(file_size)
with open(download_path, 'rb') as f:
self.assertEqual(f.read(), b'hello world')
def test_download_below_threshold(self):
transfer = self._create_s3_transfer()
filename = self.files.create_file_with_size(
'foo.txt', filesize=1024 * 1024
)
self.upload_file(filename, 'foo.txt')
download_path = os.path.join(self.files.rootdir, 'downloaded.txt')
with transfer:
future = transfer.download(
self.bucket_name,
'foo.txt',
download_path,
subscribers=[self.record_subscriber],
)
future.result()
file_size = self.osutil.get_file_size(download_path)
self._assert_subscribers_called(file_size)
assert_files_equal(filename, download_path)
def test_download_above_threshold(self):
transfer = self._create_s3_transfer()
filename = self.files.create_file_with_size(
'foo.txt', filesize=20 * 1024 * 1024
)
self.upload_file(filename, 'foo.txt')
download_path = os.path.join(self.files.rootdir, 'downloaded.txt')
with transfer:
future = transfer.download(
self.bucket_name,
'foo.txt',
download_path,
subscribers=[self.record_subscriber],
)
future.result()
assert_files_equal(filename, download_path)
file_size = self.osutil.get_file_size(download_path)
self._assert_subscribers_called(file_size)
def test_download_seekable_stream(self):
size = 1024 * 1024
filename = self.files.create_file_with_size(self.s3_key, filesize=size)
self.upload_file(filename, self.s3_key)
with open(self.download_path, 'wb') as f:
self._download_with_crt_transfer_manager(f)
self._assert_subscribers_called(size)
assert_files_equal(filename, self.download_path)
def test_multipart_download_seekable_stream(self):
size = 20 * 1024 * 1024
filename = self.files.create_file_with_size(self.s3_key, filesize=size)
self.upload_file(filename, self.s3_key)
with open(self.download_path, 'wb') as f:
self._download_with_crt_transfer_manager(f)
self._assert_subscribers_called(size)
assert_files_equal(filename, self.download_path)
def test_download_nonseekable_stream(self):
size = 1024 * 1024
filename = self.files.create_file_with_size(self.s3_key, filesize=size)
self.upload_file(filename, self.s3_key)
with open(self.download_path, 'wb') as f:
self._download_with_crt_transfer_manager(NonSeekableWriter(f))
self._assert_subscribers_called(size)
assert_files_equal(filename, self.download_path)
def test_multipart_download_nonseekable_stream(self):
size = 20 * 1024 * 1024
filename = self.files.create_file_with_size(self.s3_key, filesize=size)
self.upload_file(filename, self.s3_key)
with open(self.download_path, 'wb') as f:
self._download_with_crt_transfer_manager(NonSeekableWriter(f))
self._assert_subscribers_called(size)
assert_files_equal(filename, self.download_path)
def test_download_empty_file(self):
size = 0
filename = self.files.create_file_with_size(self.s3_key, filesize=size)
self.upload_file(filename, self.s3_key)
self._download_with_crt_transfer_manager(self.download_path)
self._assert_subscribers_called(size)
assert_files_equal(filename, self.download_path)
def test_download_empty_stream(self):
size = 0
filename = self.files.create_file_with_size(self.s3_key, filesize=size)
self.upload_file(filename, self.s3_key)
with open(self.download_path, 'wb') as f:
self._download_with_crt_transfer_manager(f)
self._assert_subscribers_called(size)
assert_files_equal(filename, self.download_path)
def test_delete(self):
transfer = self._create_s3_transfer()
filename = self.files.create_file_with_size(
'foo.txt', filesize=1024 * 1024
)
self.upload_file(filename, 'foo.txt')
with transfer:
future = transfer.delete(self.bucket_name, 'foo.txt')
future.result()
self.assertTrue(self.object_not_exists('foo.txt'))
def test_delete_exception_no_such_bucket(self):
# delete() uses awscrt.s3.S3RequestType.DEFAULT under the hood.
# Test that CRT exceptions translate properly into the botocore exceptions.
transfer = self._create_s3_transfer()
with self.assertRaises(ClientError) as ctx:
future = transfer.delete(
f"{self.bucket_name}-NONEXISTENT-{uuid4()}", "foo.txt"
)
future.result()
self.assertEqual(ctx.exception.__class__.__name__, 'NoSuchBucket')
def test_many_files_download(self):
transfer = self._create_s3_transfer()
filename = self.files.create_file_with_size(
'1mb.txt', filesize=1024 * 1024
)
self.upload_file(filename, '1mb.txt')
filenames = []
base_filename = os.path.join(self.files.rootdir, 'file')
for i in range(10):
filenames.append(base_filename + str(i))
with transfer:
for filename in filenames:
transfer.download(self.bucket_name, '1mb.txt', filename)
for download_path in filenames:
assert_files_equal(filename, download_path)
def test_many_files_upload(self):
transfer = self._create_s3_transfer()
keys = []
filenames = []
base_key = 'foo'
sufix = '.txt'
for i in range(10):
key = base_key + str(i) + sufix
keys.append(key)
filename = self.files.create_file_with_size(
key, filesize=1024 * 1024
)
filenames.append(filename)
self.addCleanup(self.delete_object, key)
with transfer:
for filename, key in zip(filenames, keys):
transfer.upload(filename, self.bucket_name, key)
for key in keys:
self.assertTrue(self.object_exists(key))
def test_many_files_delete(self):
transfer = self._create_s3_transfer()
keys = []
base_key = 'foo'
sufix = '.txt'
filename = self.files.create_file_with_size(
'1mb.txt', filesize=1024 * 1024
)
for i in range(10):
key = base_key + str(i) + sufix
keys.append(key)
self.upload_file(filename, key)
with transfer:
for key in keys:
transfer.delete(self.bucket_name, key)
for key in keys:
self.assertTrue(self.object_not_exists(key))
def test_upload_cancel(self):
transfer = self._create_s3_transfer()
filename = self.files.create_file_with_size(
'20mb.txt', filesize=20 * 1024 * 1024
)
future = None
try:
with transfer:
future = transfer.upload(
filename, self.bucket_name, '20mb.txt'
)
raise KeyboardInterrupt()
except KeyboardInterrupt:
pass
with self.assertRaises(AwsCrtError) as cm:
future.result()
self.assertEqual(cm.name, 'AWS_ERROR_S3_CANCELED')
self.assertTrue(self.object_not_exists('20mb.txt'))
def test_download_cancel(self):
transfer = self._create_s3_transfer()
filename = self.files.create_file_with_size(
'foo.txt', filesize=20 * 1024 * 1024
)
self.upload_file(filename, 'foo.txt')
download_path = os.path.join(self.files.rootdir, 'downloaded.txt')
future = None
try:
with transfer:
future = transfer.download(
self.bucket_name,
'foo.txt',
download_path,
subscribers=[self.record_subscriber],
)
raise KeyboardInterrupt()
except KeyboardInterrupt:
pass
with self.assertRaises(AwsCrtError) as err:
future.result()
self.assertEqual(err.name, 'AWS_ERROR_S3_CANCELED')
possible_matches = glob.glob('%s*' % download_path)
self.assertEqual(possible_matches, [])
self._assert_subscribers_called()
|