class StorageHandleTest(FileTestCase):
def setUp(self):
super(StorageHandleTest, self).setUp()
file_url = self.get_file_url()
credentials = self.get_shared_key_credential()
self.fsc = FileServiceClient(account_url=file_url,
credential=credentials)
self.test_shares = []
def tearDown(self):
if not self.is_playback():
for share in self.test_shares:
self.fsc.delete_share(share.share_name, delete_snapshots=True)
return super(StorageHandleTest, self).tearDown()
# --Helpers-----------------------------------------------------------------
def _get_share_reference(self, prefix=TEST_SHARE_PREFIX):
share_name = self.get_resource_name(prefix)
share = self.fsc.get_share_client(share_name)
self.test_shares.append(share)
return share
def _create_share(self, prefix=TEST_SHARE_PREFIX):
share_client = self._get_share_reference(prefix)
share = share_client.create_share()
return share_client
def _validate_handles(self, handles):
# Assert
self.assertIsNotNone(handles)
self.assertGreaterEqual(len(handles), 1)
self.assertIsNotNone(handles[0])
# verify basic fields
# path may or may not be present
# last_connect_time_string has been missing in the test
self.assertIsNotNone(handles[0].id)
self.assertIsNotNone(handles[0].file_id)
self.assertIsNotNone(handles[0].parent_id)
self.assertIsNotNone(handles[0].session_id)
self.assertIsNotNone(handles[0].client_ip)
self.assertIsNotNone(handles[0].open_time)
@record
def test_list_handles_on_share(self):
#pytest.skip("")
# don't run live, since the test set up was highly manual
# only run when recording, or playing back in CI
if not TestMode.need_recording_file(self.test_mode):
return
share = self.fsc.get_share_client(TEST_SHARE_NAME)
root = share.get_directory_client()
# Act
handles = list(root.list_handles(recursive=True))
# Assert
self._validate_handles(handles)
#
@record
def test_list_handles_on_share_snapshot(self):
# don't run live, since the test set up was highly manual
# only run when recording, or playing back in CI
if not TestMode.need_recording_file(self.test_mode):
return
share = self.fsc.get_share_client(
TEST_SHARE_NAME, snapshot="2019-05-08T23:27:24.0000000Z")
root = share.get_directory_client()
# Act
handles = list(root.list_handles(recursive=True))
# Assert
self._validate_handles(handles)
@record
def test_list_handles_with_marker(self):
# don't run live, since the test set up was highly manual
# only run when recording, or playing back in CI
if not TestMode.need_recording_file(self.test_mode):
return
share = self.fsc.get_share_client(TEST_SHARE_NAME)
root = share.get_directory_client()
# Act
handle_generator = root.list_handles(recursive=True,
results_per_page=1)
next(handle_generator)
# Assert
self.assertIsNotNone(handle_generator.next_marker)
handles = handle_generator.current_page
self._validate_handles(handles)
# Note down a handle that we saw
old_handle = handles[0]
# Continue listing
remaining_handles = list(
root.list_handles(recursive=True,
marker=handle_generator.next_marker))
self._validate_handles(handles)
# Make sure the old handle did not appear
# In other words, the marker worked
old_handle_not_present = all(
[old_handle.id != handle.id for handle in remaining_handles])
self.assertTrue(old_handle_not_present)
@record
def test_list_handles_on_directory(self):
# don't run live, since the test set up was highly manual
# only run when recording, or playing back in CI
if not TestMode.need_recording_file(self.test_mode):
return
share = self.fsc.get_share_client(TEST_SHARE_NAME)
dir = share.get_directory_client('wut')
# Act
handles = list(dir.list_handles(recursive=True))
# Assert
self._validate_handles(handles)
# Act
handles = list(dir.list_handles(recursive=False))
# Assert recursive option is functioning when disabled
self.assertTrue(len(handles) == 0)
@record
def test_list_handles_on_file(self):
# don't run live, since the test set up was highly manual
# only run when recording, or playing back in CI
if not TestMode.need_recording_file(self.test_mode):
return
share = self.fsc.get_share_client(TEST_SHARE_NAME)
client = share.get_file_client('wut/bla.txt')
# Act
handles = list(client.list_handles())
# Assert
self._validate_handles(handles)
@record
def test_close_single_handle(self):
# don't run live, since the test set up was highly manual
# only run when recording, or playing back in CI
if not TestMode.need_recording_file(self.test_mode):
return
# Arrange
share = self.fsc.get_share_client(TEST_SHARE_NAME)
root = share.get_directory_client()
handles = list(root.list_handles(recursive=True))
self._validate_handles(handles)
# Act
num_closed = root.close_handles(handle=handles[0])
# Assert 1 handle has been closed
self.assertEqual(1, num_closed.result())
@record
def test_close_all_handle(self):
# don't run live, since the test set up was highly manual
# only run when recording, or playing back in CI
if not TestMode.need_recording_file(self.test_mode):
return
# Arrange
share = self.fsc.get_share_client(TEST_SHARE_NAME)
root = share.get_directory_client()
handles = list(root.list_handles(recursive=True))
self._validate_handles(handles)
# Act
num_closed = root.close_handles()
total_num_handle_closed = num_closed.result()
# Assert at least 1 handle has been closed
self.assertTrue(total_num_handle_closed > 1)
class StorageShareTest(FileTestCase):
def setUp(self):
super(StorageShareTest, self).setUp()
file_url = self.get_file_url()
credentials = self.get_shared_key_credential()
self.fsc = FileServiceClient(account_url=file_url,
credential=credentials)
self.test_shares = []
def tearDown(self):
if not self.is_playback():
for share in self.test_shares:
try:
self.fsc.delete_share(share.share_name,
delete_snapshots=True)
except Exception as e:
print("Delete failed", e)
return super(StorageShareTest, self).tearDown()
# --Helpers-----------------------------------------------------------------
def _get_share_reference(self, prefix=TEST_SHARE_PREFIX):
share_name = self.get_resource_name(prefix)
share = self.fsc.get_share_client(share_name)
self.test_shares.append(share)
return share
def _create_share(self, prefix=TEST_SHARE_PREFIX):
share_client = self._get_share_reference(prefix)
share = share_client.create_share()
return share_client
# --Test cases for shares -----------------------------------------
@record
def test_create_share(self):
# Arrange
share = self._get_share_reference()
# Act
created = share.create_share()
# Assert
self.assertTrue(created)
@record
def test_create_share_snapshot(self):
# Arrange
share = self._get_share_reference()
# Act
created = share.create_share()
snapshot = share.create_snapshot()
# Assert
self.assertTrue(created)
self.assertIsNotNone(snapshot['snapshot'])
self.assertIsNotNone(snapshot['etag'])
self.assertIsNotNone(snapshot['last_modified'])
@record
def test_create_snapshot_with_metadata(self):
# Arrange
share = self._get_share_reference()
metadata = {"test1": "foo", "test2": "bar"}
metadata2 = {"test100": "foo100", "test200": "bar200"}
# Act
created = share.create_share(metadata=metadata)
snapshot = share.create_snapshot(metadata=metadata2)
share_props = share.get_share_properties()
snapshot_client = ShareClient(
self.get_file_url(),
share=share.share_name,
snapshot=snapshot,
credential=self.settings.STORAGE_ACCOUNT_KEY)
snapshot_props = snapshot_client.get_share_properties()
# Assert
self.assertTrue(created)
self.assertIsNotNone(snapshot['snapshot'])
self.assertIsNotNone(snapshot['etag'])
self.assertIsNotNone(snapshot['last_modified'])
self.assertEqual(share_props.metadata, metadata)
self.assertEqual(snapshot_props.metadata, metadata2)
@record
def test_delete_share_with_snapshots(self):
# Arrange
share = self._get_share_reference()
share.create_share()
snapshot = share.create_snapshot()
# Act
with self.assertRaises(HttpResponseError):
share.delete_share()
deleted = share.delete_share(delete_snapshots=True)
self.assertIsNone(deleted)
@record
def test_delete_snapshot(self):
# Arrange
share = self._get_share_reference()
share.create_share()
snapshot = share.create_snapshot()
# Act
with self.assertRaises(HttpResponseError):
share.delete_share()
snapshot_client = ShareClient(
self.get_file_url(),
share=share.share_name,
snapshot=snapshot,
credential=self.settings.STORAGE_ACCOUNT_KEY)
deleted = snapshot_client.delete_share()
self.assertIsNone(deleted)
@record
def test_create_share_fail_on_exist(self):
# Arrange
share = self._get_share_reference()
# Act
created = share.create_share()
# Assert
self.assertTrue(created)
@record
def test_create_share_with_already_existing_share_fail_on_exist(self):
# Arrange
share = self._get_share_reference()
# Act
created = share.create_share()
with self.assertRaises(HttpResponseError):
share.create_share()
# Assert
self.assertTrue(created)
@record
def test_create_share_with_metadata(self):
# Arrange
metadata = {'hello': 'world', 'number': '42'}
# Act
client = self._get_share_reference()
created = client.create_share(metadata)
# Assert
self.assertTrue(created)
md = client.get_share_properties().metadata
self.assertDictEqual(md, metadata)
@record
def test_create_share_with_quota(self):
# Arrange
# Act
client = self._get_share_reference()
created = client.create_share(quota=1)
# Assert
props = client.get_share_properties()
self.assertTrue(created)
self.assertEqual(props.quota, 1)
@record
def test_share_exists(self):
# Arrange
share = self._create_share()
# Act
exists = share.get_share_properties()
# Assert
self.assertTrue(exists)
@record
def test_share_not_exists(self):
# Arrange
share = self._get_share_reference()
# Act
with self.assertRaises(ResourceNotFoundError):
share.get_share_properties()
# Assert
@record
def test_share_snapshot_exists(self):
# Arrange
share = self._create_share()
snapshot = share.create_snapshot()
# Act
snapshot_client = self.fsc.get_share_client(share.share_name,
snapshot=snapshot)
exists = snapshot_client.get_share_properties()
# Assert
self.assertTrue(exists)
@record
def test_share_snapshot_not_exists(self):
# Arrange
share = self._create_share()
made_up_snapshot = '2017-07-19T06:53:46.0000000Z'
# Act
snapshot_client = self.fsc.get_share_client(share.share_name,
snapshot=made_up_snapshot)
with self.assertRaises(ResourceNotFoundError):
snapshot_client.get_share_properties()
# Assert
@record
def test_unicode_create_share_unicode_name(self):
# Arrange
share_name = u'啊齄丂狛狜'
# Act
with self.assertRaises(HttpResponseError):
# not supported - share name must be alphanumeric, lowercase
client = self.fsc.get_share_client(share_name)
client.create_share()
# Assert
@record
def test_list_shares_no_options(self):
# Arrange
share = self._create_share()
# Act
shares = list(self.fsc.list_shares())
# Assert
self.assertIsNotNone(shares)
self.assertGreaterEqual(len(shares), 1)
self.assertIsNotNone(shares[0])
self.assertNamedItemInContainer(shares, share.share_name)
@record
def test_list_shares_with_snapshot(self):
# Arrange
share = self._get_share_reference()
share.create_share()
snapshot1 = share.create_snapshot()
snapshot2 = share.create_snapshot()
# Act
shares = self.fsc.list_shares(include_snapshots=True)
# Assert
self.assertIsNotNone(shares)
all_shares = list(shares)
self.assertEqual(len(all_shares), 3)
self.assertNamedItemInContainer(all_shares, share.share_name)
self.assertNamedItemInContainer(all_shares, snapshot1['snapshot'])
self.assertNamedItemInContainer(all_shares, snapshot2['snapshot'])
@record
def test_list_shares_with_prefix(self):
# Arrange
share = self._get_share_reference()
share.create_share()
# Act
shares = list(self.fsc.list_shares(name_starts_with=share.share_name))
# Assert
self.assertEqual(len(shares), 1)
self.assertIsNotNone(shares[0])
self.assertEqual(shares[0].name, share.share_name)
self.assertIsNone(shares[0].metadata)
@record
def test_list_shares_with_include_metadata(self):
# Arrange
metadata = {'hello': 'world', 'number': '42'}
share = self._get_share_reference()
share.create_share(metadata)
# Act
shares = list(
self.fsc.list_shares(share.share_name, include_metadata=True))
# Assert
self.assertIsNotNone(shares)
self.assertGreaterEqual(len(shares), 1)
self.assertIsNotNone(shares[0])
self.assertNamedItemInContainer(shares, share.share_name)
self.assertDictEqual(shares[0].metadata, metadata)
@record
def test_list_shares_with_num_results_and_marker(self):
# Arrange
prefix = 'listshare'
share_names = []
for i in range(0, 4):
share_names.append(self._create_share(prefix + str(i)).share_name)
share_names.sort()
# Act
generator1 = self.fsc.list_shares(prefix, results_per_page=2)
next(generator1)
generator2 = self.fsc.list_shares(prefix,
marker=generator1.next_marker,
results_per_page=2)
next(generator2)
shares1 = generator1.current_page
shares2 = generator2.current_page
# Assert
self.assertIsNotNone(shares1)
self.assertEqual(len(shares1), 2)
self.assertNamedItemInContainer(shares1, share_names[0])
self.assertNamedItemInContainer(shares1, share_names[1])
self.assertIsNotNone(shares2)
self.assertEqual(len(shares2), 2)
self.assertNamedItemInContainer(shares2, share_names[2])
self.assertNamedItemInContainer(shares2, share_names[3])
@record
def test_set_share_metadata(self):
# Arrange
share = self._create_share()
metadata = {'hello': 'world', 'number': '42'}
# Act
share.set_share_metadata(metadata)
# Assert
md = share.get_share_properties().metadata
self.assertDictEqual(md, metadata)
@record
def test_get_share_metadata(self):
# Arrange
metadata = {'hello': 'world', 'number': '42'}
# Act
client = self._get_share_reference()
created = client.create_share(metadata)
# Assert
self.assertTrue(created)
md = client.get_share_properties().metadata
self.assertDictEqual(md, metadata)
@record
def test_get_share_metadata_with_snapshot(self):
# Arrange
metadata = {'hello': 'world', 'number': '42'}
# Act
client = self._get_share_reference()
created = client.create_share(metadata)
snapshot = client.create_snapshot()
snapshot_client = self.fsc.get_share_client(client.share_name,
snapshot=snapshot)
# Assert
self.assertTrue(created)
md = snapshot_client.get_share_properties().metadata
self.assertDictEqual(md, metadata)
@record
def test_set_share_properties(self):
# Arrange
share = self._create_share()
share.set_share_quota(1)
# Act
props = share.get_share_properties()
# Assert
self.assertIsNotNone(props)
self.assertEqual(props.quota, 1)
@record
def test_delete_share_with_existing_share(self):
# Arrange
share = self._get_share_reference()
share.create_share()
# Act
deleted = share.delete_share()
# Assert
self.assertIsNone(deleted)
@record
def test_delete_share_with_existing_share_fail_not_exist(self):
# Arrange
client = self._get_share_reference()
# Act
with LogCaptured(self) as log_captured:
with self.assertRaises(HttpResponseError):
client.delete_share()
log_as_str = log_captured.getvalue()
@record
def test_delete_share_with_non_existing_share(self):
# Arrange
client = self._get_share_reference()
# Act
with LogCaptured(self) as log_captured:
with self.assertRaises(HttpResponseError):
deleted = client.delete_share()
log_as_str = log_captured.getvalue()
self.assertTrue('ERROR' not in log_as_str)
@record
def test_delete_share_with_non_existing_share_fail_not_exist(self):
# Arrange
client = self._get_share_reference()
# Act
with LogCaptured(self) as log_captured:
with self.assertRaises(HttpResponseError):
client.delete_share()
log_as_str = log_captured.getvalue()
@record
def test_get_share_stats(self):
# Arrange
share = self._get_share_reference()
share.create_share()
# Act
share_usage = share.get_share_stats()
# Assert
self.assertEqual(share_usage, 0)
@record
def test_set_share_acl(self):
# Arrange
share = self._get_share_reference()
share.create_share()
# Act
resp = share.set_share_access_policy()
# Assert
acl = share.get_share_access_policy()
self.assertIsNotNone(acl)
@record
def test_set_share_acl_with_empty_signed_identifiers(self):
# Arrange
share = self._get_share_reference()
share.create_share()
# Act
resp = share.set_share_access_policy(dict())
# Assert
acl = share.get_share_access_policy()
self.assertIsNotNone(acl)
self.assertEqual(len(acl.get('signed_identifiers')), 0)
@record
def test_set_share_acl_with_signed_identifiers(self):
# Arrange
share = self._get_share_reference()
share.create_share()
# Act
identifiers = dict()
identifiers['testid'] = AccessPolicy(
permission=SharePermissions.WRITE,
expiry=datetime.utcnow() + timedelta(hours=1),
start=datetime.utcnow() - timedelta(minutes=1),
)
resp = share.set_share_access_policy(identifiers)
# Assert
acl = share.get_share_access_policy()
self.assertIsNotNone(acl)
self.assertEqual(len(acl['signed_identifiers']), 1)
self.assertEqual(acl['signed_identifiers'][0].id, 'testid')
@record
def test_set_share_acl_too_many_ids(self):
# Arrange
share = self._get_share_reference()
share.create_share()
# Act
identifiers = dict()
for i in range(0, 6):
identifiers['id{}'.format(i)] = AccessPolicy()
# Assert
with self.assertRaises(ValueError) as e:
share.set_share_access_policy(identifiers)
self.assertEqual(
str(e.exception),
'Too many access policies provided. The server does not support setting more than 5 access policies on a single resource.'
)
@record
def test_list_directories_and_files(self):
# Arrange
share = self._create_share()
dir0 = share.get_directory_client()
dir0.upload_file('file1', 'data1')
dir1 = share.get_directory_client('dir1')
dir1.create_directory()
dir1.upload_file('file2', 'data2')
dir2 = share.get_directory_client('dir2')
dir2.create_directory()
# Act
resp = list(share.list_directories_and_files())
# Assert
self.assertIsNotNone(resp)
self.assertEqual(len(resp), 3)
self.assertIsNotNone(resp[0])
self.assertNamedItemInContainer(resp, 'dir1')
self.assertNamedItemInContainer(resp, 'dir2')
self.assertNamedItemInContainer(resp, 'file1')
@record
def test_list_directories_and_files_with_snapshot(self):
# Arrange
share_name = self._create_share()
dir1 = share_name.get_directory_client('dir1')
dir1.create_directory()
dir2 = share_name.get_directory_client('dir2')
dir2.create_directory()
snapshot1 = share_name.create_snapshot()
dir3 = share_name.get_directory_client('dir3')
dir3.create_directory()
file1 = share_name.get_file_client('file1')
file1.upload_file('data')
# Act
snapshot_client = self.fsc.get_share_client(share_name.share_name,
snapshot=snapshot1)
resp = list(snapshot_client.list_directories_and_files())
# Assert
self.assertIsNotNone(resp)
self.assertEqual(len(resp), 2)
self.assertIsNotNone(resp[0])
self.assertNamedItemInContainer(resp, 'dir1')
self.assertNamedItemInContainer(resp, 'dir2')
@record
def test_list_directories_and_files_with_num_results(self):
# Arrange
share_name = self._create_share()
dir1 = share_name.create_directory('dir1')
root = share_name.get_directory_client()
root.upload_file('filea1', '1024')
root.upload_file('filea2', '1024')
root.upload_file('filea3', '1024')
root.upload_file('fileb1', '1024')
# Act
result = share_name.list_directories_and_files(results_per_page=2)
next(result)
# Assert
self.assertIsNotNone(result)
self.assertEqual(len(result.current_page), 2)
self.assertNamedItemInContainer(result.current_page, 'dir1')
self.assertNamedItemInContainer(result.current_page, 'filea1')
@record
def test_list_directories_and_files_with_num_results_and_marker(self):
# Arrange
share_name = self._create_share()
dir1 = share_name.get_directory_client('dir1')
dir1.create_directory()
dir1.upload_file('filea1', '1024')
dir1.upload_file('filea2', '1024')
dir1.upload_file('filea3', '1024')
dir1.upload_file('fileb1', '1024')
# Act
generator1 = share_name.list_directories_and_files('dir1',
results_per_page=2)
next(generator1)
generator2 = share_name.list_directories_and_files(
'dir1', marker=generator1.next_marker, results_per_page=2)
next(generator2)
result1 = generator1.current_page
result2 = generator2.current_page
# Assert
self.assertEqual(len(result1), 2)
self.assertEqual(len(result2), 2)
self.assertNamedItemInContainer(result1, 'filea1')
self.assertNamedItemInContainer(result1, 'filea2')
self.assertNamedItemInContainer(result2, 'filea3')
self.assertNamedItemInContainer(result2, 'fileb1')
self.assertEqual(generator2.next_marker, None)
@record
def test_list_directories_and_files_with_prefix(self):
# Arrange
share = self._create_share()
dir1 = share.create_directory('dir1')
share.create_directory('dir1/pref_dir3')
share.create_directory('dir2')
root = share.get_directory_client()
root.upload_file('file1', '1024')
dir1.upload_file('pref_file2', '1025')
dir1.upload_file('file3', '1025')
# Act
resp = list(
share.list_directories_and_files('dir1', name_starts_with='pref'))
# Assert
self.assertIsNotNone(resp)
self.assertEqual(len(resp), 2)
self.assertIsNotNone(resp[0])
self.assertNamedItemInContainer(resp, 'pref_file2')
self.assertNamedItemInContainer(resp, 'pref_dir3')
@record
def test_shared_access_share(self):
# SAS URL is calculated from storage key, so this test runs live only
if TestMode.need_recording_file(self.test_mode):
return
# Arrange
file_name = 'file1'
dir_name = 'dir1'
data = b'hello world'
share = self._create_share()
dir1 = share.create_directory(dir_name)
dir1.upload_file(file_name, data)
token = share.generate_shared_access_signature(
expiry=datetime.utcnow() + timedelta(hours=1),
permission=SharePermissions.READ,
)
sas_client = FileClient(
self.get_file_url(),
share=share.share_name,
file_path=dir_name + '/' + file_name,
credential=token,
)
# Act
print(sas_client.url)
response = requests.get(sas_client.url)
# Assert
self.assertTrue(response.ok)
self.assertEqual(data, response.content)