def test_get_file_to_text_with_encoding_and_progress(self):
# Arrange
text = u'hello 啊齄丂狛狜 world'
data = text.encode('utf-16')
file_name = self._get_file_reference()
file_client = ShareFileClient(
self.get_file_url(),
share_name=self.share_name,
file_path=self.directory_name + '/' + file_name,
credential=self.settings.STORAGE_ACCOUNT_KEY,
max_single_get_size=self.MAX_SINGLE_GET_SIZE,
max_chunk_get_size=self.MAX_CHUNK_GET_SIZE)
file_client.upload_file(data)
# Act
progress = []
def callback(response):
current = response.context['download_stream_current']
total = response.context['data_stream_total']
if current is not None:
progress.append((current, total))
file_content = file_client.download_file(raw_response_hook=callback,
encoding='UTF-16').readall()
# Assert
self.assertEqual(text, file_content)
self.assert_download_progress(len(data), self.MAX_CHUNK_GET_SIZE,
self.MAX_SINGLE_GET_SIZE, progress)
def test_get_file_to_text_non_parallel(self):
# Arrange
text_file = self._get_file_reference()
text_data = self.get_random_text_data(self.MAX_SINGLE_GET_SIZE + 1)
file_client = ShareFileClient(
self.get_file_url(),
share_name=self.share_name,
file_path=self.directory_name + '/' + text_file,
credential=self.settings.STORAGE_ACCOUNT_KEY,
max_single_get_size=self.MAX_SINGLE_GET_SIZE,
max_chunk_get_size=self.MAX_CHUNK_GET_SIZE)
file_client.upload_file(text_data)
progress = []
def callback(response):
current = response.context['download_stream_current']
total = response.context['data_stream_total']
if current is not None:
progress.append((current, total))
# Act
file_content = file_client.download_file(raw_response_hook=callback,
max_concurrency=1,
encoding='utf-8').readall()
# Assert
self.assertEqual(text_data, file_content)
self.assert_download_progress(len(text_data), self.MAX_CHUNK_GET_SIZE,
self.MAX_SINGLE_GET_SIZE, progress)
def test_get_file_to_stream_small(self):
# Arrange
file_data = self.get_random_bytes(1024)
file_name = self._get_file_reference()
file_client = ShareFileClient(
self.get_file_url(),
share_name=self.share_name,
file_path=self.directory_name + '/' + file_name,
credential=self.settings.STORAGE_ACCOUNT_KEY,
max_single_get_size=self.MAX_SINGLE_GET_SIZE,
max_chunk_get_size=self.MAX_CHUNK_GET_SIZE)
file_client.upload_file(file_data)
progress = []
def callback(response):
current = response.context['download_stream_current']
total = response.context['data_stream_total']
if current is not None:
progress.append((current, total))
# Act
with open(FILE_PATH, 'wb') as stream:
bytes_read = file_client.download_file(
raw_response_hook=callback, max_concurrency=1).readinto(stream)
# Assert
self.assertIsInstance(bytes_read, int)
with open(FILE_PATH, 'rb') as stream:
actual = stream.read()
self.assertEqual(file_data, actual)
self.assert_download_progress(len(file_data), self.MAX_CHUNK_GET_SIZE,
self.MAX_SINGLE_GET_SIZE, progress)
def test_get_file_to_text_with_progress(self):
# parallel tests introduce random order of requests, can only run live
if TestMode.need_recording_file(self.test_mode):
return
# Arrange
text_file = self.get_resource_name('textfile')
text_data = self.get_random_text_data(self.MAX_SINGLE_GET_SIZE + 1)
file_client = ShareFileClient(
self.get_file_url(),
share_name=self.share_name,
file_path=self.directory_name + '/' + text_file,
credential=self.settings.STORAGE_ACCOUNT_KEY,
max_single_get_size=self.MAX_SINGLE_GET_SIZE,
max_chunk_get_size=self.MAX_CHUNK_GET_SIZE)
file_client.upload_file(text_data)
progress = []
def callback(response):
current = response.context['download_stream_current']
total = response.context['data_stream_total']
if current is not None:
progress.append((current, total))
# Act
file_content = file_client.download_file(raw_response_hook=callback,
max_concurrency=2,
encoding='utf-8').readall()
# Assert
self.assertEqual(text_data, file_content)
self.assert_download_progress(len(text_data.encode('utf-8')),
self.MAX_CHUNK_GET_SIZE,
self.MAX_SINGLE_GET_SIZE, progress)
def test_ranged_get_file_to_path_invalid_range_non_parallel(self):
# Arrange
file_size = 1024
file_data = self.get_random_bytes(file_size)
file_name = self._get_file_reference()
file_client = ShareFileClient(
self.get_file_url(),
share_name=self.share_name,
file_path=self.directory_name + '/' + file_name,
credential=self.settings.STORAGE_ACCOUNT_KEY,
max_single_get_size=self.MAX_SINGLE_GET_SIZE,
max_chunk_get_size=self.MAX_CHUNK_GET_SIZE)
file_client.upload_file(file_data)
# Act
start = 3
end_range = 2 * self.MAX_SINGLE_GET_SIZE
with open(FILE_PATH, 'wb') as stream:
length = end_range - start + 1
bytes_read = file_client.download_file(
offset=start, length=length,
max_concurrency=1).readinto(stream)
# Assert
self.assertIsInstance(bytes_read, int)
with open(FILE_PATH, 'rb') as stream:
actual = stream.read()
self.assertEqual(file_data[start:file_size], actual)
def setUp(self):
super(StorageGetFileTest, self).setUp()
# test chunking functionality by reducing the threshold
# for chunking and the size of each chunk, otherwise
# the tests would take too long to execute
self.MAX_SINGLE_GET_SIZE = 32 * 1024
self.MAX_CHUNK_GET_SIZE = 4 * 1024
url = self.get_file_url()
credential = self.get_shared_key_credential()
self.fsc = ShareServiceClient(
url,
credential=credential,
max_single_get_size=self.MAX_SINGLE_GET_SIZE,
max_chunk_get_size=self.MAX_CHUNK_GET_SIZE)
self.share_name = self.get_resource_name('utshare')
self.directory_name = self.get_resource_name('utdir')
if not self.is_playback():
share = self.fsc.create_share(self.share_name)
share.create_directory(self.directory_name)
self.byte_file = self.get_resource_name('bytefile')
self.byte_data = self.get_random_bytes(64 * 1024 + 5)
if not self.is_playback():
byte_file = self.directory_name + '/' + self.byte_file
file_client = ShareFileClient(self.get_file_url(),
share_name=self.share_name,
file_path=byte_file,
credential=credential)
file_client.upload_file(self.byte_data)
def test_unicode_get_file_unicode_data(self):
# Arrange
file_data = u'hello world啊齄丂狛狜'.encode('utf-8')
file_name = self._get_file_reference()
file_client = ShareFileClient(
self.get_file_url(),
share_name=self.share_name,
file_path=self.directory_name + '/' + file_name,
credential=self.settings.STORAGE_ACCOUNT_KEY,
max_single_get_size=self.MAX_SINGLE_GET_SIZE,
max_chunk_get_size=self.MAX_CHUNK_GET_SIZE)
file_client.upload_file(file_data)
# Act
file_content = file_client.download_file().readall()
# Assert
self.assertEqual(file_content, file_data)
def test_get_file_to_text_with_encoding(self):
# Arrange
text = u'hello 啊齄丂狛狜 world'
data = text.encode('utf-16')
file_name = self._get_file_reference()
file_client = ShareFileClient(
self.get_file_url(),
share_name=self.share_name,
file_path=self.directory_name + '/' + file_name,
credential=self.settings.STORAGE_ACCOUNT_KEY,
max_single_get_size=self.MAX_SINGLE_GET_SIZE,
max_chunk_get_size=self.MAX_CHUNK_GET_SIZE)
file_client.upload_file(data)
# Act
file_content = file_client.download_file(encoding='UTF-16').readall()
# Assert
self.assertEqual(text, file_content)
def test_get_file_no_content(self):
# Arrange
file_data = b''
file_name = self._get_file_reference()
file_client = ShareFileClient(
self.get_file_url(),
share_name=self.share_name,
file_path=self.directory_name + '/' + file_name,
credential=self.settings.STORAGE_ACCOUNT_KEY,
max_single_get_size=self.MAX_SINGLE_GET_SIZE,
max_chunk_get_size=self.MAX_CHUNK_GET_SIZE)
file_client.upload_file(file_data)
# Act
file_output = file_client.download_file()
# Assert
self.assertEqual(file_data, file_output.readall())
self.assertEqual(0, file_output.properties.size)
def test_ranged_get_file_to_bytes_with_zero_byte(self):
# Arrange
file_data = b''
file_name = self._get_file_reference()
file_client = ShareFileClient(
self.get_file_url(),
share_name=self.share_name,
file_path=self.directory_name + '/' + file_name,
credential=self.settings.STORAGE_ACCOUNT_KEY,
max_single_get_size=self.MAX_SINGLE_GET_SIZE,
max_chunk_get_size=self.MAX_CHUNK_GET_SIZE)
file_client.upload_file(file_data)
# Act
# the get request should fail in this case since the blob is empty and yet there is a range specified
with self.assertRaises(HttpResponseError):
file_client.download_file(offset=0, length=5).readall()
with self.assertRaises(HttpResponseError):
file_client.download_file(offset=3, length=5).readall()
def test_unicode_get_file_binary_data(self):
# Arrange
base64_data = 'AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8gISIjJCUmJygpKissLS4vMDEyMzQ1Njc4OTo7PD0+P0BBQkNERUZHSElKS0xNTk9QUVJTVFVWV1hZWltcXV5fYGFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6e3x9fn+AgYKDhIWGh4iJiouMjY6PkJGSk5SVlpeYmZqbnJ2en6ChoqOkpaanqKmqq6ytrq+wsbKztLW2t7i5uru8vb6/wMHCw8TFxsfIycrLzM3Oz9DR0tPU1dbX2Nna29zd3t/g4eLj5OXm5+jp6uvs7e7v8PHy8/T19vf4+fr7/P3+/wABAgMEBQYHCAkKCwwNDg8QERITFBUWFxgZGhscHR4fICEiIyQlJicoKSorLC0uLzAxMjM0NTY3ODk6Ozw9Pj9AQUJDREVGR0hJSktMTU5PUFFSU1RVVldYWVpbXF1eX2BhYmNkZWZnaGlqa2xtbm9wcXJzdHV2d3h5ent8fX5/gIGCg4SFhoeIiYqLjI2Oj5CRkpOUlZaXmJmam5ydnp+goaKjpKWmp6ipqqusra6vsLGys7S1tre4ubq7vL2+v8DBwsPExcbHyMnKy8zNzs/Q0dLT1NXW19jZ2tvc3d7f4OHi4+Tl5ufo6err7O3u7/Dx8vP09fb3+Pn6+/z9/v8AAQIDBAUGBwgJCgsMDQ4PEBESExQVFhcYGRobHB0eHyAhIiMkJSYnKCkqKywtLi8wMTIzNDU2Nzg5Ojs8PT4/QEFCQ0RFRkdISUpLTE1OT1BRUlNUVVZXWFlaW1xdXl9gYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXp7fH1+f4CBgoOEhYaHiImKi4yNjo+QkZKTlJWWl5iZmpucnZ6foKGio6SlpqeoqaqrrK2ur7CxsrO0tba3uLm6u7y9vr/AwcLDxMXGx8jJysvMzc7P0NHS09TV1tfY2drb3N3e3+Dh4uPk5ebn6Onq6+zt7u/w8fLz9PX29/j5+vv8/f7/AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8gISIjJCUmJygpKissLS4vMDEyMzQ1Njc4OTo7PD0+P0BBQkNERUZHSElKS0xNTk9QUVJTVFVWV1hZWltcXV5fYGFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6e3x9fn+AgYKDhIWGh4iJiouMjY6PkJGSk5SVlpeYmZqbnJ2en6ChoqOkpaanqKmqq6ytrq+wsbKztLW2t7i5uru8vb6/wMHCw8TFxsfIycrLzM3Oz9DR0tPU1dbX2Nna29zd3t/g4eLj5OXm5+jp6uvs7e7v8PHy8/T19vf4+fr7/P3+/w=='
binary_data = base64.b64decode(base64_data)
file_name = self._get_file_reference()
file_client = ShareFileClient(
self.get_file_url(),
share_name=self.share_name,
file_path=self.directory_name + '/' + file_name,
credential=self.settings.STORAGE_ACCOUNT_KEY,
max_single_get_size=self.MAX_SINGLE_GET_SIZE,
max_chunk_get_size=self.MAX_CHUNK_GET_SIZE)
file_client.upload_file(binary_data)
# Act
file_content = file_client.download_file().readall()
# Assert
self.assertEqual(file_content, binary_data)
def test_get_file_to_text(self):
# parallel tests introduce random order of requests, can only run live
if TestMode.need_recording_file(self.test_mode):
return
# Arrange
text_file = self.get_resource_name('textfile')
text_data = self.get_random_text_data(self.MAX_SINGLE_GET_SIZE + 1)
file_client = ShareFileClient(
self.get_file_url(),
share_name=self.share_name,
file_path=self.directory_name + '/' + text_file,
credential=self.settings.STORAGE_ACCOUNT_KEY,
max_single_get_size=self.MAX_SINGLE_GET_SIZE,
max_chunk_get_size=self.MAX_CHUNK_GET_SIZE)
file_client.upload_file(text_data)
# Act
file_content = file_client.download_file(max_concurrency=2,
encoding='utf-8').readall()
# Assert
self.assertEqual(text_data, file_content)