File size: 25,826 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 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 |
# Copyright 2016 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.
from botocore.exceptions import ClientError
from botocore.stub import Stubber
from s3transfer.manager import TransferConfig, TransferManager
from s3transfer.utils import MIN_UPLOAD_CHUNKSIZE
from tests import BaseGeneralInterfaceTest, FileSizeProvider
class BaseCopyTest(BaseGeneralInterfaceTest):
def setUp(self):
super().setUp()
self.config = TransferConfig(
max_request_concurrency=1,
multipart_chunksize=MIN_UPLOAD_CHUNKSIZE,
multipart_threshold=MIN_UPLOAD_CHUNKSIZE * 4,
)
self._manager = TransferManager(self.client, self.config)
# Initialize some default arguments
self.bucket = 'mybucket'
self.key = 'mykey'
self.copy_source = {'Bucket': 'mysourcebucket', 'Key': 'mysourcekey'}
self.extra_args = {}
self.subscribers = []
self.half_chunksize = int(MIN_UPLOAD_CHUNKSIZE / 2)
self.content = b'0' * (2 * MIN_UPLOAD_CHUNKSIZE + self.half_chunksize)
@property
def manager(self):
return self._manager
@property
def method(self):
return self.manager.copy
def create_call_kwargs(self):
return {
'copy_source': self.copy_source,
'bucket': self.bucket,
'key': self.key,
}
def create_invalid_extra_args(self):
return {'Foo': 'bar'}
def create_stubbed_responses(self):
return [
{
'method': 'head_object',
'service_response': {'ContentLength': len(self.content)},
},
{'method': 'copy_object', 'service_response': {}},
]
def create_expected_progress_callback_info(self):
return [
{'bytes_transferred': len(self.content)},
]
def add_head_object_response(self, expected_params=None, stubber=None):
if not stubber:
stubber = self.stubber
head_response = self.create_stubbed_responses()[0]
if expected_params:
head_response['expected_params'] = expected_params
stubber.add_response(**head_response)
def add_successful_copy_responses(
self,
expected_copy_params=None,
expected_create_mpu_params=None,
expected_complete_mpu_params=None,
):
# Add all responses needed to do the copy of the object.
# Should account for both ranged and nonranged downloads.
stubbed_responses = self.create_stubbed_responses()[1:]
# If the length of copy responses is greater than one then it is
# a multipart copy.
copy_responses = stubbed_responses[0:1]
if len(stubbed_responses) > 1:
copy_responses = stubbed_responses[1:-1]
# Add the expected create multipart upload params.
if expected_create_mpu_params:
stubbed_responses[0][
'expected_params'
] = expected_create_mpu_params
# Add any expected copy parameters.
if expected_copy_params:
for i, copy_response in enumerate(copy_responses):
if isinstance(expected_copy_params, list):
copy_response['expected_params'] = expected_copy_params[i]
else:
copy_response['expected_params'] = expected_copy_params
# Add the expected complete multipart upload params.
if expected_complete_mpu_params:
stubbed_responses[-1][
'expected_params'
] = expected_complete_mpu_params
# Add the responses to the stubber.
for stubbed_response in stubbed_responses:
self.stubber.add_response(**stubbed_response)
def test_can_provide_file_size(self):
self.add_successful_copy_responses()
call_kwargs = self.create_call_kwargs()
call_kwargs['subscribers'] = [FileSizeProvider(len(self.content))]
future = self.manager.copy(**call_kwargs)
future.result()
# The HeadObject should have not happened and should have been able
# to successfully copy the file.
self.stubber.assert_no_pending_responses()
def test_provide_copy_source_as_dict(self):
self.copy_source['VersionId'] = 'mysourceversionid'
expected_params = {
'Bucket': 'mysourcebucket',
'Key': 'mysourcekey',
'VersionId': 'mysourceversionid',
}
self.add_head_object_response(expected_params=expected_params)
self.add_successful_copy_responses()
future = self.manager.copy(**self.create_call_kwargs())
future.result()
self.stubber.assert_no_pending_responses()
def test_invalid_copy_source(self):
self.copy_source = ['bucket', 'key']
future = self.manager.copy(**self.create_call_kwargs())
with self.assertRaises(TypeError):
future.result()
def test_provide_copy_source_client(self):
source_client = self.session.create_client(
's3',
'eu-central-1',
aws_access_key_id='foo',
aws_secret_access_key='bar',
)
source_stubber = Stubber(source_client)
source_stubber.activate()
self.addCleanup(source_stubber.deactivate)
self.add_head_object_response(stubber=source_stubber)
self.add_successful_copy_responses()
call_kwargs = self.create_call_kwargs()
call_kwargs['source_client'] = source_client
future = self.manager.copy(**call_kwargs)
future.result()
# Make sure that all of the responses were properly
# used for both clients.
source_stubber.assert_no_pending_responses()
self.stubber.assert_no_pending_responses()
class TestNonMultipartCopy(BaseCopyTest):
__test__ = True
def test_copy(self):
expected_head_params = {
'Bucket': 'mysourcebucket',
'Key': 'mysourcekey',
}
expected_copy_object = {
'Bucket': self.bucket,
'Key': self.key,
'CopySource': self.copy_source,
}
self.add_head_object_response(expected_params=expected_head_params)
self.add_successful_copy_responses(
expected_copy_params=expected_copy_object
)
future = self.manager.copy(**self.create_call_kwargs())
future.result()
self.stubber.assert_no_pending_responses()
def test_copy_with_checksum(self):
self.extra_args['ChecksumAlgorithm'] = 'crc32'
expected_head_params = {
'Bucket': 'mysourcebucket',
'Key': 'mysourcekey',
}
expected_copy_object = {
'Bucket': self.bucket,
'Key': self.key,
'CopySource': self.copy_source,
'ChecksumAlgorithm': 'crc32',
}
self.add_head_object_response(expected_params=expected_head_params)
self.add_successful_copy_responses(
expected_copy_params=expected_copy_object
)
call_kwargs = self.create_call_kwargs()
call_kwargs['extra_args'] = self.extra_args
future = self.manager.copy(**call_kwargs)
future.result()
self.stubber.assert_no_pending_responses()
def test_copy_with_extra_args(self):
self.extra_args['MetadataDirective'] = 'REPLACE'
expected_head_params = {
'Bucket': 'mysourcebucket',
'Key': 'mysourcekey',
}
expected_copy_object = {
'Bucket': self.bucket,
'Key': self.key,
'CopySource': self.copy_source,
'MetadataDirective': 'REPLACE',
}
self.add_head_object_response(expected_params=expected_head_params)
self.add_successful_copy_responses(
expected_copy_params=expected_copy_object
)
call_kwargs = self.create_call_kwargs()
call_kwargs['extra_args'] = self.extra_args
future = self.manager.copy(**call_kwargs)
future.result()
self.stubber.assert_no_pending_responses()
def test_copy_maps_extra_args_to_head_object(self):
self.extra_args['CopySourceSSECustomerAlgorithm'] = 'AES256'
expected_head_params = {
'Bucket': 'mysourcebucket',
'Key': 'mysourcekey',
'SSECustomerAlgorithm': 'AES256',
}
expected_copy_object = {
'Bucket': self.bucket,
'Key': self.key,
'CopySource': self.copy_source,
'CopySourceSSECustomerAlgorithm': 'AES256',
}
self.add_head_object_response(expected_params=expected_head_params)
self.add_successful_copy_responses(
expected_copy_params=expected_copy_object
)
call_kwargs = self.create_call_kwargs()
call_kwargs['extra_args'] = self.extra_args
future = self.manager.copy(**call_kwargs)
future.result()
self.stubber.assert_no_pending_responses()
def test_allowed_copy_params_are_valid(self):
op_model = self.client.meta.service_model.operation_model('CopyObject')
for allowed_upload_arg in self._manager.ALLOWED_COPY_ARGS:
self.assertIn(allowed_upload_arg, op_model.input_shape.members)
def test_copy_with_tagging(self):
extra_args = {'Tagging': 'tag1=val1', 'TaggingDirective': 'REPLACE'}
self.add_head_object_response()
self.add_successful_copy_responses(
expected_copy_params={
'Bucket': self.bucket,
'Key': self.key,
'CopySource': self.copy_source,
'Tagging': 'tag1=val1',
'TaggingDirective': 'REPLACE',
}
)
future = self.manager.copy(
self.copy_source, self.bucket, self.key, extra_args
)
future.result()
self.stubber.assert_no_pending_responses()
def test_raise_exception_on_s3_object_lambda_resource(self):
s3_object_lambda_arn = (
'arn:aws:s3-object-lambda:us-west-2:123456789012:'
'accesspoint:my-accesspoint'
)
with self.assertRaisesRegex(ValueError, 'methods do not support'):
self.manager.copy(self.copy_source, s3_object_lambda_arn, self.key)
def test_raise_exception_on_s3_object_lambda_resource_as_source(self):
source = {
'Bucket': 'arn:aws:s3-object-lambda:us-west-2:123456789012:'
'accesspoint:my-accesspoint'
}
with self.assertRaisesRegex(ValueError, 'methods do not support'):
self.manager.copy(source, self.bucket, self.key)
class TestMultipartCopy(BaseCopyTest):
__test__ = True
def setUp(self):
super().setUp()
self.config = TransferConfig(
max_request_concurrency=1,
multipart_threshold=1,
multipart_chunksize=4,
)
self._manager = TransferManager(self.client, self.config)
self.multipart_id = 'my-upload-id'
def create_stubbed_responses(self):
return [
{
'method': 'head_object',
'service_response': {'ContentLength': len(self.content)},
},
{
'method': 'create_multipart_upload',
'service_response': {'UploadId': self.multipart_id},
},
{
'method': 'upload_part_copy',
'service_response': {'CopyPartResult': {'ETag': 'etag-1'}},
},
{
'method': 'upload_part_copy',
'service_response': {'CopyPartResult': {'ETag': 'etag-2'}},
},
{
'method': 'upload_part_copy',
'service_response': {'CopyPartResult': {'ETag': 'etag-3'}},
},
{'method': 'complete_multipart_upload', 'service_response': {}},
]
def add_get_head_response_with_default_expected_params(
self, extra_expected_params=None
):
expected_params = {
'Bucket': 'mysourcebucket',
'Key': 'mysourcekey',
}
if extra_expected_params:
expected_params.update(extra_expected_params)
response = self.create_stubbed_responses()[0]
response['expected_params'] = expected_params
self.stubber.add_response(**response)
def add_create_multipart_response_with_default_expected_params(
self, extra_expected_params=None
):
expected_params = {'Bucket': self.bucket, 'Key': self.key}
if extra_expected_params:
expected_params.update(extra_expected_params)
response = self.create_stubbed_responses()[1]
response['expected_params'] = expected_params
self.stubber.add_response(**response)
def add_upload_part_copy_responses_with_default_expected_params(
self, extra_expected_params=None
):
ranges = [
'bytes=0-5242879',
'bytes=5242880-10485759',
'bytes=10485760-13107199',
]
upload_part_responses = self.create_stubbed_responses()[2:-1]
for i, range_val in enumerate(ranges):
upload_part_response = upload_part_responses[i]
expected_params = {
'Bucket': self.bucket,
'Key': self.key,
'CopySource': self.copy_source,
'UploadId': self.multipart_id,
'PartNumber': i + 1,
'CopySourceRange': range_val,
}
if extra_expected_params:
if 'ChecksumAlgorithm' in extra_expected_params:
name = extra_expected_params['ChecksumAlgorithm']
checksum_member = 'Checksum%s' % name.upper()
response = upload_part_response['service_response']
response['CopyPartResult'][checksum_member] = 'sum%s==' % (
i + 1
)
else:
expected_params.update(extra_expected_params)
upload_part_response['expected_params'] = expected_params
self.stubber.add_response(**upload_part_response)
def add_complete_multipart_response_with_default_expected_params(
self, extra_expected_params=None
):
expected_params = {
'Bucket': self.bucket,
'Key': self.key,
'UploadId': self.multipart_id,
'MultipartUpload': {
'Parts': [
{'ETag': 'etag-1', 'PartNumber': 1},
{'ETag': 'etag-2', 'PartNumber': 2},
{'ETag': 'etag-3', 'PartNumber': 3},
]
},
}
if extra_expected_params:
expected_params.update(extra_expected_params)
response = self.create_stubbed_responses()[-1]
response['expected_params'] = expected_params
self.stubber.add_response(**response)
def create_expected_progress_callback_info(self):
# Note that last read is from the empty sentinel indicating
# that the stream is done.
return [
{'bytes_transferred': MIN_UPLOAD_CHUNKSIZE},
{'bytes_transferred': MIN_UPLOAD_CHUNKSIZE},
{'bytes_transferred': self.half_chunksize},
]
def add_create_multipart_upload_response(self):
self.stubber.add_response(**self.create_stubbed_responses()[1])
def _get_expected_params(self):
# Add expected parameters to the head object
expected_head_params = {
'Bucket': 'mysourcebucket',
'Key': 'mysourcekey',
}
# Add expected parameters for the create multipart
expected_create_mpu_params = {
'Bucket': self.bucket,
'Key': self.key,
}
expected_copy_params = []
# Add expected parameters to the copy part
ranges = [
'bytes=0-5242879',
'bytes=5242880-10485759',
'bytes=10485760-13107199',
]
for i, range_val in enumerate(ranges):
expected_copy_params.append(
{
'Bucket': self.bucket,
'Key': self.key,
'CopySource': self.copy_source,
'UploadId': self.multipart_id,
'PartNumber': i + 1,
'CopySourceRange': range_val,
}
)
# Add expected parameters for the complete multipart
expected_complete_mpu_params = {
'Bucket': self.bucket,
'Key': self.key,
'UploadId': self.multipart_id,
'MultipartUpload': {
'Parts': [
{'ETag': 'etag-1', 'PartNumber': 1},
{'ETag': 'etag-2', 'PartNumber': 2},
{'ETag': 'etag-3', 'PartNumber': 3},
]
},
}
return expected_head_params, {
'expected_create_mpu_params': expected_create_mpu_params,
'expected_copy_params': expected_copy_params,
'expected_complete_mpu_params': expected_complete_mpu_params,
}
def _add_params_to_expected_params(
self, add_copy_kwargs, operation_types, new_params
):
expected_params_to_update = []
for operation_type in operation_types:
add_copy_kwargs_key = 'expected_' + operation_type + '_params'
expected_params = add_copy_kwargs[add_copy_kwargs_key]
if isinstance(expected_params, list):
expected_params_to_update.extend(expected_params)
else:
expected_params_to_update.append(expected_params)
for expected_params in expected_params_to_update:
expected_params.update(new_params)
def test_copy(self):
head_params, add_copy_kwargs = self._get_expected_params()
self.add_head_object_response(expected_params=head_params)
self.add_successful_copy_responses(**add_copy_kwargs)
future = self.manager.copy(**self.create_call_kwargs())
future.result()
self.stubber.assert_no_pending_responses()
def test_copy_with_extra_args(self):
# This extra argument should be added to the head object,
# the create multipart upload, and upload part copy.
self.extra_args['RequestPayer'] = 'requester'
head_params, add_copy_kwargs = self._get_expected_params()
head_params.update(self.extra_args)
self.add_head_object_response(expected_params=head_params)
self._add_params_to_expected_params(
add_copy_kwargs,
['create_mpu', 'copy', 'complete_mpu'],
self.extra_args,
)
self.add_successful_copy_responses(**add_copy_kwargs)
call_kwargs = self.create_call_kwargs()
call_kwargs['extra_args'] = self.extra_args
future = self.manager.copy(**call_kwargs)
future.result()
self.stubber.assert_no_pending_responses()
def test_copy_passes_checksums(self):
# This extra argument should be added to the head object,
# the create multipart upload, and upload part copy.
self.extra_args['ChecksumAlgorithm'] = 'sha256'
self.add_get_head_response_with_default_expected_params()
# ChecksumAlgorithm should be passed on the create_multipart call
self.add_create_multipart_response_with_default_expected_params(
self.extra_args,
)
# ChecksumAlgorithm should be passed to the upload_part_copy calls
self.add_upload_part_copy_responses_with_default_expected_params(
self.extra_args,
)
# The checksums should be used in the complete call like etags
self.add_complete_multipart_response_with_default_expected_params(
extra_expected_params={
'MultipartUpload': {
'Parts': [
{
'ETag': 'etag-1',
'PartNumber': 1,
'ChecksumSHA256': 'sum1==',
},
{
'ETag': 'etag-2',
'PartNumber': 2,
'ChecksumSHA256': 'sum2==',
},
{
'ETag': 'etag-3',
'PartNumber': 3,
'ChecksumSHA256': 'sum3==',
},
]
}
}
)
call_kwargs = self.create_call_kwargs()
call_kwargs['extra_args'] = self.extra_args
future = self.manager.copy(**call_kwargs)
future.result()
self.stubber.assert_no_pending_responses()
def test_copy_blacklists_args_to_create_multipart(self):
# This argument can never be used for multipart uploads
self.extra_args['MetadataDirective'] = 'COPY'
head_params, add_copy_kwargs = self._get_expected_params()
self.add_head_object_response(expected_params=head_params)
self.add_successful_copy_responses(**add_copy_kwargs)
call_kwargs = self.create_call_kwargs()
call_kwargs['extra_args'] = self.extra_args
future = self.manager.copy(**call_kwargs)
future.result()
self.stubber.assert_no_pending_responses()
def test_copy_args_to_only_create_multipart(self):
self.extra_args['ACL'] = 'private'
head_params, add_copy_kwargs = self._get_expected_params()
self.add_head_object_response(expected_params=head_params)
self._add_params_to_expected_params(
add_copy_kwargs, ['create_mpu'], self.extra_args
)
self.add_successful_copy_responses(**add_copy_kwargs)
call_kwargs = self.create_call_kwargs()
call_kwargs['extra_args'] = self.extra_args
future = self.manager.copy(**call_kwargs)
future.result()
self.stubber.assert_no_pending_responses()
def test_copy_passes_args_to_create_multipart_and_upload_part(self):
# This will only be used for the complete multipart upload
# and upload part.
self.extra_args['SSECustomerAlgorithm'] = 'AES256'
head_params, add_copy_kwargs = self._get_expected_params()
self.add_head_object_response(expected_params=head_params)
self._add_params_to_expected_params(
add_copy_kwargs,
['create_mpu', 'copy', 'complete_mpu'],
self.extra_args,
)
self.add_successful_copy_responses(**add_copy_kwargs)
call_kwargs = self.create_call_kwargs()
call_kwargs['extra_args'] = self.extra_args
future = self.manager.copy(**call_kwargs)
future.result()
self.stubber.assert_no_pending_responses()
def test_copy_maps_extra_args_to_head_object(self):
self.extra_args['CopySourceSSECustomerAlgorithm'] = 'AES256'
head_params, add_copy_kwargs = self._get_expected_params()
# The CopySourceSSECustomerAlgorithm needs to get mapped to
# SSECustomerAlgorithm for HeadObject
head_params['SSECustomerAlgorithm'] = 'AES256'
self.add_head_object_response(expected_params=head_params)
# However, it needs to remain the same for UploadPartCopy.
self._add_params_to_expected_params(
add_copy_kwargs, ['copy'], self.extra_args
)
self.add_successful_copy_responses(**add_copy_kwargs)
call_kwargs = self.create_call_kwargs()
call_kwargs['extra_args'] = self.extra_args
future = self.manager.copy(**call_kwargs)
future.result()
self.stubber.assert_no_pending_responses()
def test_abort_on_failure(self):
# First add the head object and create multipart upload
self.add_head_object_response()
self.add_create_multipart_upload_response()
# Cause an error on upload_part_copy
self.stubber.add_client_error('upload_part_copy', 'ArbitraryFailure')
# Add the abort multipart to ensure it gets cleaned up on failure
self.stubber.add_response(
'abort_multipart_upload',
service_response={},
expected_params={
'Bucket': self.bucket,
'Key': self.key,
'UploadId': self.multipart_id,
},
)
future = self.manager.copy(**self.create_call_kwargs())
with self.assertRaisesRegex(ClientError, 'ArbitraryFailure'):
future.result()
self.stubber.assert_no_pending_responses()
def test_mp_copy_with_tagging_directive(self):
extra_args = {'Tagging': 'tag1=val1', 'TaggingDirective': 'REPLACE'}
self.add_head_object_response()
self.add_successful_copy_responses(
expected_create_mpu_params={
'Bucket': self.bucket,
'Key': self.key,
'Tagging': 'tag1=val1',
}
)
future = self.manager.copy(
self.copy_source, self.bucket, self.key, extra_args
)
future.result()
self.stubber.assert_no_pending_responses()
|