File size: 10,935 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 |
# 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 glob
import os
import threading
import time
from concurrent.futures import CancelledError
from s3transfer.manager import TransferConfig
from tests import (
NonSeekableWriter,
RecordingSubscriber,
assert_files_equal,
skip_if_using_serial_implementation,
skip_if_windows,
)
from tests.integration import (
BaseTransferManagerIntegTest,
WaitForTransferStart,
)
class TestDownload(BaseTransferManagerIntegTest):
def setUp(self):
super().setUp()
self.multipart_threshold = 5 * 1024 * 1024
self.config = TransferConfig(
multipart_threshold=self.multipart_threshold
)
def test_below_threshold(self):
transfer_manager = self.create_transfer_manager(self.config)
filename = self.files.create_file_with_size(
'foo.txt', filesize=1024 * 1024
)
self.upload_file(filename, '1mb.txt')
download_path = os.path.join(self.files.rootdir, '1mb.txt')
future = transfer_manager.download(
self.bucket_name, '1mb.txt', download_path
)
future.result()
assert_files_equal(filename, download_path)
def test_above_threshold(self):
transfer_manager = self.create_transfer_manager(self.config)
filename = self.files.create_file_with_size(
'foo.txt', filesize=20 * 1024 * 1024
)
self.upload_file(filename, '20mb.txt')
download_path = os.path.join(self.files.rootdir, '20mb.txt')
future = transfer_manager.download(
self.bucket_name, '20mb.txt', download_path
)
future.result()
assert_files_equal(filename, download_path)
@skip_if_using_serial_implementation(
'Exception is thrown once the transfer is submitted. '
'However for the serial implementation, transfers are performed '
'in main thread meaning the transfer will complete before the '
'KeyboardInterrupt being thrown.'
)
def test_large_download_exits_quicky_on_exception(self):
transfer_manager = self.create_transfer_manager(self.config)
filename = self.files.create_file_with_size(
'foo.txt', filesize=60 * 1024 * 1024
)
self.upload_file(filename, '60mb.txt')
download_path = os.path.join(self.files.rootdir, '60mb.txt')
timeout = 10
bytes_transferring = threading.Event()
subscriber = WaitForTransferStart(bytes_transferring)
try:
with transfer_manager:
future = transfer_manager.download(
self.bucket_name,
'60mb.txt',
download_path,
subscribers=[subscriber],
)
if not bytes_transferring.wait(timeout):
future.cancel()
raise RuntimeError(
"Download transfer did not start after waiting for "
"%s seconds." % timeout
)
# Raise an exception which should cause the preceding
# download to cancel and exit quickly
start_time = time.time()
raise KeyboardInterrupt()
except KeyboardInterrupt:
pass
end_time = time.time()
# The maximum time allowed for the transfer manager to exit.
# This means that it should take less than a couple second after
# sleeping to exit.
max_allowed_exit_time = 5
actual_time_to_exit = end_time - start_time
self.assertLess(
actual_time_to_exit,
max_allowed_exit_time,
"Failed to exit under {}. Instead exited in {}.".format(
max_allowed_exit_time, actual_time_to_exit
),
)
# Make sure the future was cancelled because of the KeyboardInterrupt
with self.assertRaisesRegex(CancelledError, 'KeyboardInterrupt()'):
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*' % download_path)
self.assertEqual(possible_matches, [])
@skip_if_using_serial_implementation(
'Exception is thrown once the transfer is submitted. '
'However for the serial implementation, transfers are performed '
'in main thread meaning the transfer will complete before the '
'KeyboardInterrupt being thrown.'
)
def test_many_files_exits_quicky_on_exception(self):
# Set the max request queue size and number of submission threads
# to something small to simulate having a large queue
# of transfer requests to complete and it is backed up.
self.config.max_request_queue_size = 1
self.config.max_submission_concurrency = 1
transfer_manager = self.create_transfer_manager(self.config)
filename = self.files.create_file_with_size(
'foo.txt', filesize=1024 * 1024
)
self.upload_file(filename, '1mb.txt')
filenames = []
futures = []
for i in range(10):
filenames.append(os.path.join(self.files.rootdir, 'file' + str(i)))
try:
with transfer_manager:
start_time = time.time()
for filename in filenames:
futures.append(
transfer_manager.download(
self.bucket_name, '1mb.txt', filename
)
)
# Raise an exception which should cause the preceding
# transfer to cancel and exit quickly
raise KeyboardInterrupt()
except KeyboardInterrupt:
pass
end_time = time.time()
# The maximum time allowed for the transfer manager to exit.
# This means that it should take less than a couple seconds to exit.
max_allowed_exit_time = 5
self.assertLess(
end_time - start_time,
max_allowed_exit_time,
"Failed to exit under {}. Instead exited in {}.".format(
max_allowed_exit_time, end_time - start_time
),
)
# Make sure at least one of the futures got cancelled
with self.assertRaisesRegex(CancelledError, 'KeyboardInterrupt()'):
for future in futures:
future.result()
# For the transfer that did get cancelled, make sure the temporary
# file got removed.
possible_matches = glob.glob('%s*' % future.meta.call_args.fileobj)
self.assertEqual(possible_matches, [])
def test_progress_subscribers_on_download(self):
subscriber = RecordingSubscriber()
transfer_manager = self.create_transfer_manager(self.config)
filename = self.files.create_file_with_size(
'foo.txt', filesize=20 * 1024 * 1024
)
self.upload_file(filename, '20mb.txt')
download_path = os.path.join(self.files.rootdir, '20mb.txt')
future = transfer_manager.download(
self.bucket_name,
'20mb.txt',
download_path,
subscribers=[subscriber],
)
future.result()
self.assertEqual(subscriber.calculate_bytes_seen(), 20 * 1024 * 1024)
def test_below_threshold_for_fileobj(self):
transfer_manager = self.create_transfer_manager(self.config)
filename = self.files.create_file_with_size(
'foo.txt', filesize=1024 * 1024
)
self.upload_file(filename, '1mb.txt')
download_path = os.path.join(self.files.rootdir, '1mb.txt')
with open(download_path, 'wb') as f:
future = transfer_manager.download(self.bucket_name, '1mb.txt', f)
future.result()
assert_files_equal(filename, download_path)
def test_above_threshold_for_fileobj(self):
transfer_manager = self.create_transfer_manager(self.config)
filename = self.files.create_file_with_size(
'foo.txt', filesize=20 * 1024 * 1024
)
self.upload_file(filename, '20mb.txt')
download_path = os.path.join(self.files.rootdir, '20mb.txt')
with open(download_path, 'wb') as f:
future = transfer_manager.download(self.bucket_name, '20mb.txt', f)
future.result()
assert_files_equal(filename, download_path)
def test_below_threshold_for_nonseekable_fileobj(self):
transfer_manager = self.create_transfer_manager(self.config)
filename = self.files.create_file_with_size(
'foo.txt', filesize=1024 * 1024
)
self.upload_file(filename, '1mb.txt')
download_path = os.path.join(self.files.rootdir, '1mb.txt')
with open(download_path, 'wb') as f:
future = transfer_manager.download(
self.bucket_name, '1mb.txt', NonSeekableWriter(f)
)
future.result()
assert_files_equal(filename, download_path)
def test_above_threshold_for_nonseekable_fileobj(self):
transfer_manager = self.create_transfer_manager(self.config)
filename = self.files.create_file_with_size(
'foo.txt', filesize=20 * 1024 * 1024
)
self.upload_file(filename, '20mb.txt')
download_path = os.path.join(self.files.rootdir, '20mb.txt')
with open(download_path, 'wb') as f:
future = transfer_manager.download(
self.bucket_name, '20mb.txt', NonSeekableWriter(f)
)
future.result()
assert_files_equal(filename, download_path)
@skip_if_windows('Windows does not support UNIX special files')
def test_download_to_special_file(self):
transfer_manager = self.create_transfer_manager(self.config)
filename = self.files.create_file_with_size(
'foo.txt', filesize=1024 * 1024
)
self.upload_file(filename, '1mb.txt')
future = transfer_manager.download(
self.bucket_name, '1mb.txt', '/dev/null'
)
try:
future.result()
except Exception as e:
self.fail(
'Should have been able to download to /dev/null but received '
'following exception %s' % e
)
|