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
|
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------
import unittest
from azure.storage.blob import (
BlockBlobService,
PageBlobService,
AppendBlobService,
)
from azure.storage.file import FileService
from azure.storage.queue import QueueService
from tests.testcase import (
StorageTestCase,
record,
)
from azure.storage.common import TokenCredential
# ------------------------------------------------------------------------------
SERVICES = {
BlockBlobService: 'blob',
PageBlobService: 'blob',
AppendBlobService: 'blob',
QueueService: 'queue',
FileService: 'file'
}
_CONNECTION_ENDPOINTS = {
'blob': 'BlobEndpoint',
'queue': 'QueueEndpoint',
'file': 'FileEndpoint',
}
_CONNECTION_ENDPOINTS_SECONDARY = {
'blob': 'BlobSecondaryEndpoint',
'queue': 'QueueSecondaryEndpoint',
'file': 'FileSecondaryEndpoint',
}
class StorageClientTest(StorageTestCase):
def setUp(self):
super(StorageClientTest, self).setUp()
self.account_name = self.settings.STORAGE_ACCOUNT_NAME
self.account_key = self.settings.STORAGE_ACCOUNT_KEY
self.sas_token = '?sv=2015-04-05&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=Z%2FRHIX5Xcg0Mq2rqI3OlWTjEg2tYkboXr1P9ZUXDtkk%3D'
self.token_credential = TokenCredential('initial_token')
# --Helpers-----------------------------------------------------------------
def validate_standard_account_endpoints(self, service, type):
self.assertIsNotNone(service)
self.assertEqual(service.account_name, self.account_name)
self.assertEqual(service.account_key, self.account_key)
self.assertEqual(service.primary_endpoint, '{}.{}.core.windows.net'.format(self.account_name, type))
self.assertEqual(service.secondary_endpoint, '{}-secondary.{}.core.windows.net'.format(self.account_name, type))
# --Direct Parameters Test Cases --------------------------------------------
def test_create_service_with_key(self):
# Arrange
for type in SERVICES.items():
# Act
service = type[0](self.account_name, self.account_key)
# Assert
self.validate_standard_account_endpoints(service, type[1])
self.assertEqual(service.protocol, 'https')
def test_create_service_with_sas(self):
# Arrange
for type in SERVICES:
# Act
service = type(self.account_name, sas_token=self.sas_token)
# Assert
self.assertIsNotNone(service)
self.assertEqual(service.account_name, self.account_name)
self.assertEqual(service.sas_token, self.sas_token)
self.assertIsNone(service.account_key)
def test_create_service_with_token(self):
for type in SERVICES:
# Act
# token credential is not available for FileService
if type != FileService:
service = type(self.account_name, token_credential=self.token_credential)
# Assert
self.assertIsNotNone(service)
self.assertEqual(service.account_name, self.account_name)
self.assertEqual(service.token_credential, self.token_credential)
self.assertIsNone(service.account_key)
def test_create_service_with_token_and_http(self):
for type in SERVICES:
# Act
# token credential is not available for FileService
if type != FileService:
with self.assertRaises(ValueError):
type(self.settings.STORAGE_ACCOUNT_NAME, token_credential=self.token_credential, protocol="HTTP")
def test_create_service_china(self):
# Arrange
for type in SERVICES.items():
# Act
service = type[0](self.account_name, self.account_key, endpoint_suffix='core.chinacloudapi.cn')
# Assert
self.assertIsNotNone(service)
self.assertEqual(service.account_name, self.account_name)
self.assertEqual(service.account_key, self.account_key)
self.assertEqual(service.primary_endpoint, '{}.{}.core.chinacloudapi.cn'.format(self.account_name, type[1]))
self.assertEqual(service.secondary_endpoint,
'{}-secondary.{}.core.chinacloudapi.cn'.format(self.account_name, type[1]))
def test_create_service_protocol(self):
# Arrange
for type in SERVICES.items():
# Act
service = type[0](self.account_name, self.account_key, protocol='http')
# Assert
self.validate_standard_account_endpoints(service, type[1])
self.assertEqual(service.protocol, 'http')
def test_create_service_with_emulator(self):
# Arrange
# Act
service = BlockBlobService(is_emulated=True)
# Assert
self.assertIsNotNone(service)
self.assertEqual(service.account_name, 'devstoreaccount1')
self.assertIsNotNone(service.account_key)
self.assertEqual(service.protocol, 'http')
self.assertEqual(service.primary_endpoint, '127.0.0.1:10000/devstoreaccount1')
self.assertEqual(service.secondary_endpoint, '127.0.0.1:10000/devstoreaccount1-secondary')
def test_create_blob_service_anonymous(self):
# Arrange
BLOB_SERVICES = [BlockBlobService, PageBlobService, AppendBlobService]
for type in BLOB_SERVICES:
# Act
service = type(self.account_name)
# Assert
self.assertIsNotNone(service)
self.assertEqual(service.account_name, self.account_name)
self.assertIsNone(service.account_key)
self.assertIsNone(service.sas_token)
def test_create_blob_service_custom_domain(self):
# Arrange
BLOB_SERVICES = [BlockBlobService, PageBlobService, AppendBlobService]
for type in BLOB_SERVICES:
# Act
service = type(self.account_name, self.account_key, custom_domain='www.mydomain.com')
# Assert
self.assertIsNotNone(service)
self.assertEqual(service.account_name, self.account_name)
self.assertEqual(service.account_key, self.account_key)
self.assertEqual(service.primary_endpoint, 'www.mydomain.com')
self.assertEqual(service.secondary_endpoint, self.account_name + '-secondary.blob.core.windows.net')
def test_create_service_empty_key(self):
# Arrange
NON_BLOB_SERVICES = [QueueService, FileService]
for type in NON_BLOB_SERVICES:
# Act
try:
test_service = type('testaccount', '')
self.fail('Passing an empty key to create account should fail.')
except ValueError as e:
self.assertTrue(str(
e) == 'You need to provide an account name and either an account_key or sas_token when creating a storage service.')
def test_create_service_missing_arguments(self):
# Arrange
for type in SERVICES:
# Act
with self.assertRaises(ValueError):
service = type()
# Assert
def test_create_service_with_socket_timeout(self):
# Arrange
for type in SERVICES.items():
# Act
service = type[0](self.account_name, self.account_key, socket_timeout=22)
# Assert
self.validate_standard_account_endpoints(service, type[1])
self.assertEqual(service.socket_timeout, 22)
# --Connection String Test Cases --------------------------------------------
def test_create_service_with_connection_string_key(self):
# Arrange
conn_string = 'AccountName={};AccountKey={};'.format(self.account_name, self.account_key)
for type in SERVICES.items():
# Act
service = type[0](connection_string=conn_string)
# Assert
self.validate_standard_account_endpoints(service, type[1])
self.assertEqual(service.protocol, 'https')
def test_create_service_with_connection_string_sas(self):
# Arrange
conn_string = 'AccountName={};SharedAccessSignature={};'.format(self.account_name, self.sas_token)
for type in SERVICES:
# Act
service = type(connection_string=conn_string)
# Assert
self.assertIsNotNone(service)
self.assertEqual(service.account_name, self.account_name)
self.assertEqual(service.sas_token, self.sas_token)
self.assertIsNone(service.account_key)
def test_create_service_with_connection_string_endpoint_protocol(self):
# Arrange
conn_string = 'AccountName={};AccountKey={};DefaultEndpointsProtocol=http;EndpointSuffix=core.chinacloudapi.cn;'.format(
self.account_name, self.account_key)
for type in SERVICES.items():
# Act
service = type[0](connection_string=conn_string)
# Assert
self.assertIsNotNone(service)
self.assertEqual(service.account_name, self.account_name)
self.assertEqual(service.account_key, self.account_key)
self.assertEqual(service.primary_endpoint, '{}.{}.core.chinacloudapi.cn'.format(self.account_name, type[1]))
self.assertEqual(service.secondary_endpoint,
'{}-secondary.{}.core.chinacloudapi.cn'.format(self.account_name, type[1]))
self.assertEqual(service.protocol, 'http')
def test_create_service_with_connection_string_emulated(self):
# Arrange
conn_string = 'UseDevelopmentStorage=true;'.format(self.account_name, self.account_key)
# Act
service = BlockBlobService(connection_string=conn_string)
# Assert
self.assertIsNotNone(service)
self.assertEqual(service.account_name, 'devstoreaccount1')
self.assertIsNotNone(service.account_key)
self.assertEqual(service.protocol, 'http')
self.assertEqual(service.primary_endpoint, '127.0.0.1:10000/devstoreaccount1')
self.assertEqual(service.secondary_endpoint, '127.0.0.1:10000/devstoreaccount1-secondary')
def test_create_service_with_connection_string_emulated_explicit(self):
# Arrange
conn_string = 'DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=http://127.0.0.1:10000/devstoreaccount1;TableEndpoint=http://127.0.0.1:10002/devstoreaccount1;QueueEndpoint=http://127.0.0.1:10001/devstoreaccount1;' \
.format(self.account_name, self.account_key)
# Act
service = BlockBlobService(connection_string=conn_string)
# Assert
self.assertIsNotNone(service)
self.assertEqual(service.account_name, 'devstoreaccount1')
self.assertIsNotNone(service.account_key)
self.assertEqual(service.protocol, 'http')
self.assertEqual(service.primary_endpoint, '127.0.0.1:10000/devstoreaccount1')
def test_create_service_with_connection_string_anonymous(self):
# Arrange
conn_string = 'BlobEndpoint=www.mydomain.com;'
# Act
service = BlockBlobService(connection_string=conn_string)
# Assert
self.assertIsNotNone(service)
self.assertIsNone(service.account_name)
self.assertIsNone(service.account_key)
self.assertIsNone(service.sas_token)
self.assertEqual(service.primary_endpoint, 'www.mydomain.com')
def test_create_service_with_connection_string_custom_domain(self):
# Arrange
conn_string = 'AccountName={};AccountKey={};BlobEndpoint=www.mydomain.com;'.format(self.account_name,
self.account_key)
# Act
service = BlockBlobService(connection_string=conn_string)
# Assert
self.assertIsNotNone(service)
self.assertEqual(service.account_name, self.account_name)
self.assertEqual(service.account_key, self.account_key)
self.assertEqual(service.primary_endpoint, 'www.mydomain.com')
self.assertEqual(service.secondary_endpoint, self.account_name + '-secondary.blob.core.windows.net')
def test_create_service_with_connection_string_custom_domain_trailing_slash(self):
# Arrange
conn_string = 'AccountName={};AccountKey={};BlobEndpoint=www.mydomain.com/;'.format(self.account_name,
self.account_key)
# Act
service = BlockBlobService(connection_string=conn_string)
# Assert
self.assertIsNotNone(service)
self.assertEqual(service.account_name, self.account_name)
self.assertEqual(service.account_key, self.account_key)
self.assertEqual(service.primary_endpoint, 'www.mydomain.com')
self.assertEqual(service.secondary_endpoint, self.account_name + '-secondary.blob.core.windows.net')
def test_create_service_with_connection_string_fails_if_secondary_without_primary(self):
for type in SERVICES.items():
# Arrange
conn_string = 'AccountName={};AccountKey={};{}=www.mydomain.com;'.format(self.account_name, self.account_key, _CONNECTION_ENDPOINTS_SECONDARY.get(type[1]))
# Act
# Fails if primary excluded
with self.assertRaises(ValueError):
service = type[0](connection_string=conn_string)
def test_create_service_with_connection_string_succeeds_if_secondary_with_primary(self):
for type in SERVICES.items():
# Arrange
conn_string = 'AccountName={};AccountKey={};{}=www.mydomain.com;{}=www-sec.mydomain.com;'.format(self.account_name, self.account_key, _CONNECTION_ENDPOINTS.get(type[1]), _CONNECTION_ENDPOINTS_SECONDARY.get(type[1]))
# Act
service = type[0](connection_string=conn_string)
# Assert
self.assertIsNotNone(service)
self.assertEqual(service.account_name, self.account_name)
self.assertEqual(service.account_key, self.account_key)
self.assertEqual(service.primary_endpoint, 'www.mydomain.com')
self.assertEqual(service.secondary_endpoint, 'www-sec.mydomain.com')
@record
def test_request_callback_signed_header(self):
# Arrange
service = BlockBlobService(self.account_name, self.account_key, is_emulated=self.settings.IS_EMULATED)
name = self.get_resource_name('cont')
# Act
def callback(request):
if request.method == 'PUT':
request.headers['x-ms-meta-hello'] = 'world'
service.request_callback = callback
# Assert
try:
service.create_container(name)
metadata = service.get_container_metadata(name)
self.assertEqual(metadata, {'hello': 'world'})
finally:
service.delete_container(name)
@record
def test_response_callback(self):
# Arrange
service = BlockBlobService(self.account_name, self.account_key, is_emulated=self.settings.IS_EMULATED)
name = self.get_resource_name('cont')
# Act
def callback(response):
response.status = 200
response.headers.clear()
# Force an exists call to succeed by resetting the status
service.response_callback = callback
# Assert
exists = service.exists(name)
self.assertTrue(exists)
# ------------------------------------------------------------------------------
if __name__ == '__main__':
unittest.main()
|
