File size: 19,716 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 |
# 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.
import copy
import glob
import os
import shutil
import tempfile
import time
from io import BytesIO
from botocore.exceptions import ClientError
from s3transfer.compat import SOCKET_ERROR
from s3transfer.exceptions import RetriesExceededError
from s3transfer.manager import TransferConfig, TransferManager
from tests import (
BaseGeneralInterfaceTest,
FileSizeProvider,
NonSeekableWriter,
RecordingOSUtils,
RecordingSubscriber,
StreamWithError,
skip_if_using_serial_implementation,
skip_if_windows,
)
class BaseDownloadTest(BaseGeneralInterfaceTest):
def setUp(self):
super().setUp()
self.config = TransferConfig(max_request_concurrency=1)
self._manager = TransferManager(self.client, self.config)
# Create a temporary directory to write to
self.tempdir = tempfile.mkdtemp()
self.filename = os.path.join(self.tempdir, 'myfile')
# Initialize some default arguments
self.bucket = 'mybucket'
self.key = 'mykey'
self.extra_args = {}
self.subscribers = []
# Create a stream to read from
self.content = b'my content'
self.stream = BytesIO(self.content)
def tearDown(self):
super().tearDown()
shutil.rmtree(self.tempdir)
@property
def manager(self):
return self._manager
@property
def method(self):
return self.manager.download
def create_call_kwargs(self):
return {
'bucket': self.bucket,
'key': self.key,
'fileobj': self.filename,
}
def create_invalid_extra_args(self):
return {'Foo': 'bar'}
def create_stubbed_responses(self):
# We want to make sure the beginning of the stream is always used
# in case this gets called twice.
self.stream.seek(0)
return [
{
'method': 'head_object',
'service_response': {'ContentLength': len(self.content)},
},
{
'method': 'get_object',
'service_response': {'Body': self.stream},
},
]
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': 10}]
def add_head_object_response(self, expected_params=None):
head_response = self.create_stubbed_responses()[0]
if expected_params:
head_response['expected_params'] = expected_params
self.stubber.add_response(**head_response)
def add_successful_get_object_responses(
self, expected_params=None, expected_ranges=None
):
# Add all get_object responses needed to complete the download.
# Should account for both ranged and nonranged downloads.
for i, stubbed_response in enumerate(
self.create_stubbed_responses()[1:]
):
if expected_params:
stubbed_response['expected_params'] = copy.deepcopy(
expected_params
)
if expected_ranges:
stubbed_response['expected_params'][
'Range'
] = expected_ranges[i]
self.stubber.add_response(**stubbed_response)
def add_n_retryable_get_object_responses(self, n, num_reads=0):
for _ in range(n):
self.stubber.add_response(
method='get_object',
service_response={
'Body': StreamWithError(
copy.deepcopy(self.stream), SOCKET_ERROR, num_reads
)
},
)
def test_download_temporary_file_does_not_exist(self):
self.add_head_object_response()
self.add_successful_get_object_responses()
future = self.manager.download(**self.create_call_kwargs())
future.result()
# Make sure the file exists
self.assertTrue(os.path.exists(self.filename))
# Make sure the random temporary file does not exist
possible_matches = glob.glob('%s*' % self.filename + os.extsep)
self.assertEqual(possible_matches, [])
def test_download_for_fileobj(self):
self.add_head_object_response()
self.add_successful_get_object_responses()
with open(self.filename, 'wb') as f:
future = self.manager.download(
self.bucket, self.key, f, self.extra_args
)
future.result()
# Ensure that the contents are correct
with open(self.filename, 'rb') as f:
self.assertEqual(self.content, f.read())
def test_download_for_seekable_filelike_obj(self):
self.add_head_object_response()
self.add_successful_get_object_responses()
# Create a file-like object to test. In this case, it is a BytesIO
# object.
bytes_io = BytesIO()
future = self.manager.download(
self.bucket, self.key, bytes_io, self.extra_args
)
future.result()
# Ensure that the contents are correct
bytes_io.seek(0)
self.assertEqual(self.content, bytes_io.read())
def test_download_for_nonseekable_filelike_obj(self):
self.add_head_object_response()
self.add_successful_get_object_responses()
with open(self.filename, 'wb') as f:
future = self.manager.download(
self.bucket, self.key, NonSeekableWriter(f), self.extra_args
)
future.result()
# Ensure that the contents are correct
with open(self.filename, 'rb') as f:
self.assertEqual(self.content, f.read())
def test_download_cleanup_on_failure(self):
self.add_head_object_response()
# Throw an error on the download
self.stubber.add_client_error('get_object')
future = self.manager.download(**self.create_call_kwargs())
with self.assertRaises(ClientError):
future.result()
# Make sure the actual file and the temporary do not exist
# by globbing for the file and any of its extensions
possible_matches = glob.glob('%s*' % self.filename)
self.assertEqual(possible_matches, [])
def test_download_with_nonexistent_directory(self):
self.add_head_object_response()
self.add_successful_get_object_responses()
call_kwargs = self.create_call_kwargs()
call_kwargs['fileobj'] = os.path.join(
self.tempdir, 'missing-directory', 'myfile'
)
future = self.manager.download(**call_kwargs)
with self.assertRaises(IOError):
future.result()
def test_retries_and_succeeds(self):
self.add_head_object_response()
# Insert a response that will trigger a retry.
self.add_n_retryable_get_object_responses(1)
# Add the normal responses to simulate the download proceeding
# as normal after the retry.
self.add_successful_get_object_responses()
future = self.manager.download(**self.create_call_kwargs())
future.result()
# The retry should have been consumed and the process should have
# continued using the successful responses.
self.stubber.assert_no_pending_responses()
with open(self.filename, 'rb') as f:
self.assertEqual(self.content, f.read())
def test_retry_failure(self):
self.add_head_object_response()
max_retries = 3
self.config.num_download_attempts = max_retries
self._manager = TransferManager(self.client, self.config)
# Add responses that fill up the maximum number of retries.
self.add_n_retryable_get_object_responses(max_retries)
future = self.manager.download(**self.create_call_kwargs())
# A retry exceeded error should have happened.
with self.assertRaises(RetriesExceededError):
future.result()
# All of the retries should have been used up.
self.stubber.assert_no_pending_responses()
def test_retry_rewinds_callbacks(self):
self.add_head_object_response()
# Insert a response that will trigger a retry after one read of the
# stream has been made.
self.add_n_retryable_get_object_responses(1, num_reads=1)
# Add the normal responses to simulate the download proceeding
# as normal after the retry.
self.add_successful_get_object_responses()
recorder_subscriber = RecordingSubscriber()
# Set the streaming to a size that is smaller than the data we
# currently provide to it to simulate rewinds of callbacks.
self.config.io_chunksize = 3
future = self.manager.download(
subscribers=[recorder_subscriber], **self.create_call_kwargs()
)
future.result()
# Ensure that there is no more remaining responses and that contents
# are correct.
self.stubber.assert_no_pending_responses()
with open(self.filename, 'rb') as f:
self.assertEqual(self.content, f.read())
# Assert that the number of bytes seen is equal to the length of
# downloaded content.
self.assertEqual(
recorder_subscriber.calculate_bytes_seen(), len(self.content)
)
# Also ensure that the second progress invocation was negative three
# because a retry happened on the second read of the stream and we
# know that the chunk size for each read is 3.
progress_byte_amts = [
call['bytes_transferred']
for call in recorder_subscriber.on_progress_calls
]
self.assertEqual(-3, progress_byte_amts[1])
def test_can_provide_file_size(self):
self.add_successful_get_object_responses()
call_kwargs = self.create_call_kwargs()
call_kwargs['subscribers'] = [FileSizeProvider(len(self.content))]
future = self.manager.download(**call_kwargs)
future.result()
# The HeadObject should have not happened and should have been able
# to successfully download the file.
self.stubber.assert_no_pending_responses()
with open(self.filename, 'rb') as f:
self.assertEqual(self.content, f.read())
def test_uses_provided_osutil(self):
osutil = RecordingOSUtils()
# Use the recording os utility for the transfer manager
self._manager = TransferManager(self.client, self.config, osutil)
self.add_head_object_response()
self.add_successful_get_object_responses()
future = self.manager.download(**self.create_call_kwargs())
future.result()
# The osutil should have had its open() method invoked when opening
# a temporary file and its rename_file() method invoked when the
# the temporary file was moved to its final location.
self.assertEqual(len(osutil.open_records), 1)
self.assertEqual(len(osutil.rename_records), 1)
@skip_if_windows('Windows does not support UNIX special files')
@skip_if_using_serial_implementation(
'A separate thread is needed to read from the fifo'
)
def test_download_for_fifo_file(self):
self.add_head_object_response()
self.add_successful_get_object_responses()
# Create the fifo file
os.mkfifo(self.filename)
future = self.manager.download(
self.bucket, self.key, self.filename, self.extra_args
)
# The call to open a fifo will block until there is both a reader
# and a writer, so we need to open it for reading after we've
# started the transfer.
with open(self.filename, 'rb') as fifo:
future.result()
self.assertEqual(fifo.read(), self.content)
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.download(
s3_object_lambda_arn, self.key, self.filename, self.extra_args
)
class TestNonRangedDownload(BaseDownloadTest):
# TODO: If you want to add tests outside of this test class and still
# subclass from BaseDownloadTest you need to set ``__test__ = True``. If
# you do not, your tests will not get picked up by the test runner! This
# needs to be done until we find a better way to ignore running test cases
# from the general test base class, which we do not want ran.
__test__ = True
def test_download(self):
self.extra_args['RequestPayer'] = 'requester'
expected_params = {
'Bucket': self.bucket,
'Key': self.key,
'RequestPayer': 'requester',
}
self.add_head_object_response(expected_params)
self.add_successful_get_object_responses(expected_params)
future = self.manager.download(
self.bucket, self.key, self.filename, self.extra_args
)
future.result()
# Ensure that the contents are correct
with open(self.filename, 'rb') as f:
self.assertEqual(self.content, f.read())
def test_download_with_checksum_enabled(self):
self.extra_args['ChecksumMode'] = 'ENABLED'
expected_params = {
'Bucket': self.bucket,
'Key': self.key,
'ChecksumMode': 'ENABLED',
}
self.add_head_object_response(expected_params)
self.add_successful_get_object_responses(expected_params)
future = self.manager.download(
self.bucket, self.key, self.filename, self.extra_args
)
future.result()
# Ensure that the contents are correct
with open(self.filename, 'rb') as f:
self.assertEqual(self.content, f.read())
def test_allowed_copy_params_are_valid(self):
op_model = self.client.meta.service_model.operation_model('GetObject')
for allowed_upload_arg in self._manager.ALLOWED_DOWNLOAD_ARGS:
self.assertIn(allowed_upload_arg, op_model.input_shape.members)
def test_download_empty_object(self):
self.content = b''
self.stream = BytesIO(self.content)
self.add_head_object_response()
self.add_successful_get_object_responses()
future = self.manager.download(
self.bucket, self.key, self.filename, self.extra_args
)
future.result()
# Ensure that the empty file exists
with open(self.filename, 'rb') as f:
self.assertEqual(b'', f.read())
def test_uses_bandwidth_limiter(self):
self.content = b'a' * 1024 * 1024
self.stream = BytesIO(self.content)
self.config = TransferConfig(
max_request_concurrency=1, max_bandwidth=len(self.content) / 2
)
self._manager = TransferManager(self.client, self.config)
self.add_head_object_response()
self.add_successful_get_object_responses()
start = time.time()
future = self.manager.download(
self.bucket, self.key, self.filename, self.extra_args
)
future.result()
# This is just a smoke test to make sure that the limiter is
# being used and not necessary its exactness. So we set the maximum
# bandwidth to len(content)/2 per sec and make sure that it is
# noticeably slower. Ideally it will take more than two seconds, but
# given tracking at the beginning of transfers are not entirely
# accurate setting at the initial start of a transfer, we give us
# some flexibility by setting the expected time to half of the
# theoretical time to take.
self.assertGreaterEqual(time.time() - start, 1)
# Ensure that the contents are correct
with open(self.filename, 'rb') as f:
self.assertEqual(self.content, f.read())
class TestRangedDownload(BaseDownloadTest):
# TODO: If you want to add tests outside of this test class and still
# subclass from BaseDownloadTest you need to set ``__test__ = True``. If
# you do not, your tests will not get picked up by the test runner! This
# needs to be done until we find a better way to ignore running test cases
# from the general test base class, which we do not want ran.
__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)
def create_stubbed_responses(self):
return [
{
'method': 'head_object',
'service_response': {'ContentLength': len(self.content)},
},
{
'method': 'get_object',
'service_response': {'Body': BytesIO(self.content[0:4])},
},
{
'method': 'get_object',
'service_response': {'Body': BytesIO(self.content[4:8])},
},
{
'method': 'get_object',
'service_response': {'Body': BytesIO(self.content[8:])},
},
]
def create_expected_progress_callback_info(self):
return [
{'bytes_transferred': 4},
{'bytes_transferred': 4},
{'bytes_transferred': 2},
]
def test_download(self):
self.extra_args['RequestPayer'] = 'requester'
expected_params = {
'Bucket': self.bucket,
'Key': self.key,
'RequestPayer': 'requester',
}
expected_ranges = ['bytes=0-3', 'bytes=4-7', 'bytes=8-']
self.add_head_object_response(expected_params)
self.add_successful_get_object_responses(
expected_params, expected_ranges
)
future = self.manager.download(
self.bucket, self.key, self.filename, self.extra_args
)
future.result()
# Ensure that the contents are correct
with open(self.filename, 'rb') as f:
self.assertEqual(self.content, f.read())
def test_download_with_checksum_enabled(self):
self.extra_args['ChecksumMode'] = 'ENABLED'
expected_params = {
'Bucket': self.bucket,
'Key': self.key,
'ChecksumMode': 'ENABLED',
}
expected_ranges = ['bytes=0-3', 'bytes=4-7', 'bytes=8-']
self.add_head_object_response(expected_params)
self.add_successful_get_object_responses(
expected_params, expected_ranges
)
future = self.manager.download(
self.bucket, self.key, self.filename, self.extra_args
)
future.result()
# Ensure that the contents are correct
with open(self.filename, 'rb') as f:
self.assertEqual(self.content, f.read())
|