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
|
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------
import unittest
import pytest
import platform
import asyncio
from azure.core.pipeline.transport import AioHttpTransport
from multidict import CIMultiDict, CIMultiDictProxy
from devtools_testutils import ResourceGroupPreparer, StorageAccountPreparer
from azure.storage.queue import VERSION
from azure.storage.queue.aio import (
QueueServiceClient,
QueueClient
)
from _shared.asynctestcase import AsyncStorageTestCase
from _shared.testcase import GlobalStorageAccountPreparer
# ------------------------------------------------------------------------------
SERVICES = {
QueueServiceClient: 'queue',
QueueClient: 'queue',
}
_CONNECTION_ENDPOINTS = {'queue': 'QueueEndpoint'}
_CONNECTION_ENDPOINTS_SECONDARY = {'queue': 'QueueSecondaryEndpoint'}
class AiohttpTestTransport(AioHttpTransport):
"""Workaround to vcrpy bug: https://github.com/kevin1024/vcrpy/pull/461
"""
async def send(self, request, **config):
response = await super(AiohttpTestTransport, self).send(request, **config)
if not isinstance(response.headers, CIMultiDictProxy):
response.headers = CIMultiDictProxy(CIMultiDict(response.internal_response.headers))
response.content_type = response.headers.get("content-type")
return response
class StorageQueueClientTestAsync(AsyncStorageTestCase):
def setUp(self):
super(StorageQueueClientTestAsync, self).setUp()
self.sas_token = self.generate_sas_token()
self.token_credential = self.generate_oauth_token()
# --Helpers-----------------------------------------------------------------
def validate_standard_account_endpoints(self, service, url_type, storage_account, storage_account_key):
self.assertIsNotNone(service)
self.assertEqual(service.account_name, storage_account.name)
self.assertEqual(service.credential.account_name, storage_account.name)
self.assertEqual(service.credential.account_key, storage_account_key)
self.assertTrue('{}.{}.core.windows.net'.format(storage_account.name, url_type) in service.url)
self.assertTrue('{}-secondary.{}.core.windows.net'.format(storage_account.name, url_type) in service.secondary_endpoint)
# --Direct Parameters Test Cases --------------------------------------------
@GlobalStorageAccountPreparer()
def test_create_service_with_key(self, resource_group, location, storage_account, storage_account_key):
# Arrange
for client, url in SERVICES.items():
# Act
service = client(
self.account_url(storage_account, "queue"), credential=storage_account_key, queue_name='foo', transport=AiohttpTestTransport())
# Assert
self.validate_standard_account_endpoints(service, url, storage_account, storage_account_key)
self.assertEqual(service.scheme, 'https')
@GlobalStorageAccountPreparer()
def test_create_service_with_connection_string(self, resource_group, location, storage_account, storage_account_key):
for service_type in SERVICES.items():
# Act
service = service_type[0].from_connection_string(
self.connection_string(storage_account, storage_account_key), queue_name="test")
# Assert
self.validate_standard_account_endpoints(service, service_type[1], storage_account, storage_account_key)
self.assertEqual(service.scheme, 'https')
@GlobalStorageAccountPreparer()
def test_create_service_with_sas(self, resource_group, location, storage_account, storage_account_key):
# Arrange
for service_type in SERVICES:
# Act
service = service_type(
self.account_url(storage_account, "queue"), credential=self.sas_token, queue_name='foo')
# Assert
self.assertIsNotNone(service)
self.assertEqual(service.account_name, storage_account.name)
self.assertTrue(service.url.startswith('https://' + storage_account.name + '.queue.core.windows.net'))
self.assertTrue(service.url.endswith(self.sas_token))
self.assertIsNone(service.credential)
@GlobalStorageAccountPreparer()
def test_create_service_with_token(self, resource_group, location, storage_account, storage_account_key):
for service_type in SERVICES:
# Act
service = service_type(
self.account_url(storage_account, "queue"), credential=self.token_credential, queue_name='foo')
# Assert
self.assertIsNotNone(service)
self.assertEqual(service.account_name, storage_account.name)
self.assertTrue(service.url.startswith('https://' + storage_account.name + '.queue.core.windows.net'))
self.assertEqual(service.credential, self.token_credential)
self.assertFalse(hasattr(service.credential, 'account_key'))
self.assertTrue(hasattr(service.credential, 'get_token'))
@GlobalStorageAccountPreparer()
def test_create_service_with_token_and_http(self, resource_group, location, storage_account, storage_account_key):
for service_type in SERVICES:
# Act
with self.assertRaises(ValueError):
url = self.account_url(storage_account, "queue").replace('https', 'http')
service_type(url, credential=self.token_credential, queue_name='foo')
@GlobalStorageAccountPreparer()
def test_create_service_china(self, resource_group, location, storage_account, storage_account_key):
# Arrange
for service_type in SERVICES.items():
# Act
url = self.account_url(storage_account, "queue").replace('core.windows.net', 'core.chinacloudapi.cn')
service = service_type[0](
url, credential=storage_account_key, queue_name='foo')
# Assert
self.assertIsNotNone(service)
self.assertEqual(service.account_name, storage_account.name)
self.assertEqual(service.credential.account_name, storage_account.name)
self.assertEqual(service.credential.account_key, storage_account_key)
self.assertTrue(service.primary_endpoint.startswith(
'https://{}.{}.core.chinacloudapi.cn'.format(storage_account.name, service_type[1])))
self.assertTrue(service.secondary_endpoint.startswith(
'https://{}-secondary.{}.core.chinacloudapi.cn'.format(storage_account.name, service_type[1])))
@GlobalStorageAccountPreparer()
def test_create_service_protocol(self, resource_group, location, storage_account, storage_account_key):
# Arrange
for service_type in SERVICES.items():
# Act
url = self.account_url(storage_account, "queue").replace('https', 'http')
service = service_type[0](
url, credential=storage_account_key, queue_name='foo')
# Assert
self.validate_standard_account_endpoints(service, service_type[1], storage_account, storage_account_key)
self.assertEqual(service.scheme, 'http')
@GlobalStorageAccountPreparer()
def test_create_service_empty_key(self, resource_group, location, storage_account, storage_account_key):
# Arrange
QUEUE_SERVICES = [QueueServiceClient, QueueClient]
for service_type in QUEUE_SERVICES:
# Act
with self.assertRaises(ValueError) as e:
test_service = service_type('testaccount', credential='', queue_name='foo')
self.assertEqual(
str(e.exception), "You need to provide either a SAS token or an account shared key to authenticate.")
@GlobalStorageAccountPreparer()
def test_create_service_with_socket_timeout(self, resource_group, location, storage_account, storage_account_key):
# Arrange
for service_type in SERVICES.items():
# Act
default_service = service_type[0](
self.account_url(storage_account, "queue"), credential=storage_account_key, queue_name='foo')
service = service_type[0](
self.account_url(storage_account, "queue"), credential=storage_account_key,
queue_name='foo', connection_timeout=22)
# Assert
self.validate_standard_account_endpoints(service, service_type[1], storage_account, storage_account_key)
assert service._client._client._pipeline._transport.connection_config.timeout == 22
assert default_service._client._client._pipeline._transport.connection_config.timeout in [20, (20, 2000)]
# --Connection String Test Cases --------------------------------------------
@GlobalStorageAccountPreparer()
def test_create_service_with_connection_string_key(self, resource_group, location, storage_account, storage_account_key):
# Arrange
conn_string = 'AccountName={};AccountKey={};'.format(storage_account.name, storage_account_key)
for service_type in SERVICES.items():
# Act
service = service_type[0].from_connection_string(conn_string, queue_name='foo')
# Assert
self.validate_standard_account_endpoints(service, service_type[1], storage_account, storage_account_key)
self.assertEqual(service.scheme, 'https')
@GlobalStorageAccountPreparer()
def test_create_service_with_connection_string_sas(self, resource_group, location, storage_account, storage_account_key):
# Arrange
conn_string = 'AccountName={};SharedAccessSignature={};'.format(storage_account.name, self.sas_token)
for service_type in SERVICES:
# Act
service = service_type.from_connection_string(conn_string, queue_name='foo')
# Assert
self.assertIsNotNone(service)
self.assertEqual(service.account_name, storage_account.name)
self.assertTrue(service.url.startswith('https://' + storage_account.name + '.queue.core.windows.net'))
self.assertTrue(service.url.endswith(self.sas_token))
self.assertIsNone(service.credential)
@GlobalStorageAccountPreparer()
def test_create_service_with_conn_str_endpoint_protocol(self, resource_group, location, storage_account, storage_account_key):
# Arrange
conn_string = 'AccountName={};AccountKey={};DefaultEndpointsProtocol=http;EndpointSuffix=core.chinacloudapi.cn;'.format(
storage_account.name, storage_account_key)
for service_type in SERVICES.items():
# Act
service = service_type[0].from_connection_string(conn_string, queue_name="foo")
# Assert
self.assertIsNotNone(service)
self.assertEqual(service.account_name, storage_account.name)
self.assertEqual(service.credential.account_name, storage_account.name)
self.assertEqual(service.credential.account_key, storage_account_key)
self.assertTrue(
service.primary_endpoint.startswith(
'http://{}.{}.core.chinacloudapi.cn/'.format(storage_account.name, service_type[1])))
self.assertTrue(
service.secondary_endpoint.startswith(
'http://{}-secondary.{}.core.chinacloudapi.cn'.format(storage_account.name, service_type[1])))
self.assertEqual(service.scheme, 'http')
@GlobalStorageAccountPreparer()
def test_create_service_with_connection_string_emulated(self, resource_group, location, storage_account, storage_account_key):
# Arrange
for service_type in SERVICES.items():
conn_string = 'UseDevelopmentStorage=true;'.format(storage_account.name, storage_account_key)
# Act
with self.assertRaises(ValueError):
service = service_type[0].from_connection_string(conn_string, queue_name="foo")
@GlobalStorageAccountPreparer()
def test_create_service_with_connection_string_custom_domain(self, resource_group, location, storage_account, storage_account_key):
# Arrange
for service_type in SERVICES.items():
conn_string = 'AccountName={};AccountKey={};QueueEndpoint=www.mydomain.com;'.format(
storage_account.name, storage_account_key)
# Act
service = service_type[0].from_connection_string(conn_string, queue_name="foo")
# Assert
self.assertIsNotNone(service)
self.assertEqual(service.account_name, storage_account.name)
self.assertEqual(service.credential.account_name, storage_account.name)
self.assertEqual(service.credential.account_key, storage_account_key)
self.assertTrue(service.primary_endpoint.startswith('https://www.mydomain.com/'))
self.assertTrue(service.secondary_endpoint.startswith('https://' + storage_account.name + '-secondary.queue.core.windows.net'))
@GlobalStorageAccountPreparer()
def test_create_serv_with_cs_custom_dmn_trlng_slash(self, resource_group, location, storage_account, storage_account_key):
# Arrange
for service_type in SERVICES.items():
conn_string = 'AccountName={};AccountKey={};QueueEndpoint=www.mydomain.com/;'.format(
storage_account.name, storage_account_key)
# Act
service = service_type[0].from_connection_string(conn_string, queue_name="foo")
# Assert
self.assertIsNotNone(service)
self.assertEqual(service.account_name, storage_account.name)
self.assertEqual(service.credential.account_name, storage_account.name)
self.assertEqual(service.credential.account_key, storage_account_key)
self.assertTrue(service.primary_endpoint.startswith('https://www.mydomain.com/'))
self.assertTrue(service.secondary_endpoint.startswith('https://' + storage_account.name + '-secondary.queue.core.windows.net'))
@GlobalStorageAccountPreparer()
def test_create_service_with_cs_custom_dmn_sec_override(self, resource_group, location, storage_account, storage_account_key):
# Arrange
for service_type in SERVICES.items():
conn_string = 'AccountName={};AccountKey={};QueueEndpoint=www.mydomain.com/;'.format(
storage_account.name, storage_account_key)
# Act
service = service_type[0].from_connection_string(
conn_string, secondary_hostname="www-sec.mydomain.com", queue_name="foo")
# Assert
self.assertIsNotNone(service)
self.assertEqual(service.account_name, storage_account.name)
self.assertEqual(service.credential.account_name, storage_account.name)
self.assertEqual(service.credential.account_key, storage_account_key)
self.assertTrue(service.primary_endpoint.startswith('https://www.mydomain.com/'))
self.assertTrue(service.secondary_endpoint.startswith('https://www-sec.mydomain.com/'))
@GlobalStorageAccountPreparer()
def test_create_service_with_cs_fails_if_sec_without_prim(self, resource_group, location, storage_account, storage_account_key):
for service_type in SERVICES.items():
# Arrange
conn_string = 'AccountName={};AccountKey={};{}=www.mydomain.com;'.format(
storage_account.name, storage_account_key,
_CONNECTION_ENDPOINTS_SECONDARY.get(service_type[1]))
# Act
# Fails if primary excluded
with self.assertRaises(ValueError):
service = service_type[0].from_connection_string(conn_string, queue_name="foo")
@GlobalStorageAccountPreparer()
def test_create_service_with_cs_succeeds_if_sec_with_prim(self, resource_group, location, storage_account, storage_account_key):
for service_type in SERVICES.items():
# Arrange
conn_string = 'AccountName={};AccountKey={};{}=www.mydomain.com;{}=www-sec.mydomain.com;'.format(
storage_account.name,
storage_account_key,
_CONNECTION_ENDPOINTS.get(service_type[1]),
_CONNECTION_ENDPOINTS_SECONDARY.get(service_type[1]))
# Act
service = service_type[0].from_connection_string(conn_string, queue_name="foo")
# Assert
self.assertIsNotNone(service)
self.assertEqual(service.account_name, storage_account.name)
self.assertEqual(service.credential.account_name, storage_account.name)
self.assertEqual(service.credential.account_key, storage_account_key)
self.assertTrue(service.primary_endpoint.startswith('https://www.mydomain.com/'))
self.assertTrue(service.secondary_endpoint.startswith('https://www-sec.mydomain.com/'))
@GlobalStorageAccountPreparer()
def test_create_service_with_custom_account_endpoint_path(self, resource_group, location, storage_account, storage_account_key):
custom_account_url = "http://local-machine:11002/custom/account/path/" + self.sas_token
for service_type in SERVICES.items():
conn_string = 'DefaultEndpointsProtocol=http;AccountName={};AccountKey={};QueueEndpoint={};'.format(
storage_account.name, storage_account_key, custom_account_url)
# Act
service = service_type[0].from_connection_string(conn_string, queue_name="foo")
# Assert
self.assertEqual(service.account_name, storage_account.name)
self.assertEqual(service.credential.account_name, storage_account.name)
self.assertEqual(service.credential.account_key, storage_account_key)
self.assertEqual(service.primary_hostname, 'local-machine:11002/custom/account/path')
service = QueueServiceClient(account_url=custom_account_url)
self.assertEqual(service.account_name, None)
self.assertEqual(service.credential, None)
self.assertEqual(service.primary_hostname, 'local-machine:11002/custom/account/path')
self.assertTrue(service.url.startswith('http://local-machine:11002/custom/account/path/?'))
service = QueueClient(account_url=custom_account_url, queue_name="foo")
self.assertEqual(service.account_name, None)
self.assertEqual(service.queue_name, "foo")
self.assertEqual(service.credential, None)
self.assertEqual(service.primary_hostname, 'local-machine:11002/custom/account/path')
self.assertTrue(service.url.startswith('http://local-machine:11002/custom/account/path/foo?'))
service = QueueClient.from_queue_url("http://local-machine:11002/custom/account/path/foo" + self.sas_token)
self.assertEqual(service.account_name, None)
self.assertEqual(service.queue_name, "foo")
self.assertEqual(service.credential, None)
self.assertEqual(service.primary_hostname, 'local-machine:11002/custom/account/path')
self.assertTrue(service.url.startswith('http://local-machine:11002/custom/account/path/foo?'))
@GlobalStorageAccountPreparer()
@AsyncStorageTestCase.await_prepared_test
async def test_request_callback_signed_header(self, resource_group, location, storage_account, storage_account_key):
# Arrange
service = QueueServiceClient(self.account_url(storage_account, "queue"), credential=storage_account_key)
name = self.get_resource_name('cont')
# Act
try:
headers = {'x-ms-meta-hello': 'world'}
queue = await service.create_queue(name, headers=headers)
# Assert
metadata_cr = await queue.get_queue_properties()
metadata = metadata_cr.metadata
self.assertEqual(metadata, {'hello': 'world'})
finally:
await service.delete_queue(name)
@GlobalStorageAccountPreparer()
@AsyncStorageTestCase.await_prepared_test
async def test_response_callback(self, resource_group, location, storage_account, storage_account_key):
# Arrange
service = QueueServiceClient(self.account_url(storage_account, "queue"), credential=storage_account_key, transport=AiohttpTestTransport())
name = self.get_resource_name('cont')
queue = service.get_queue_client(name)
# Act
def callback(response):
response.http_response.status_code = 200
# Assert
exists = await queue.get_queue_properties(raw_response_hook=callback)
self.assertTrue(exists)
@GlobalStorageAccountPreparer()
@AsyncStorageTestCase.await_prepared_test
async def test_user_agent_default(self, resource_group, location, storage_account, storage_account_key):
service = QueueServiceClient(self.account_url(storage_account, "queue"), credential=storage_account_key, transport=AiohttpTestTransport())
def callback(response):
self.assertTrue('User-Agent' in response.http_request.headers)
assert "azsdk-python-storage-queue/{}".format(VERSION) in response.http_request.headers['User-Agent']
await service.get_service_properties(raw_response_hook=callback)
@GlobalStorageAccountPreparer()
@AsyncStorageTestCase.await_prepared_test
async def test_user_agent_custom(self, resource_group, location, storage_account, storage_account_key):
custom_app = "TestApp/v1.0"
service = QueueServiceClient(
self.account_url(storage_account, "queue"), credential=storage_account_key, user_agent=custom_app, transport=AiohttpTestTransport())
def callback(response):
self.assertTrue('User-Agent' in response.http_request.headers)
assert ("TestApp/v1.0 azsdk-python-storage-queue/{} Python/{} ({})".format(
VERSION,
platform.python_version(),
platform.platform())) in response.http_request.headers['User-Agent']
await service.get_service_properties(raw_response_hook=callback)
def callback(response):
self.assertTrue('User-Agent' in response.http_request.headers)
assert ("TestApp/v2.0 TestApp/v1.0 azsdk-python-storage-queue/{} Python/{} ({})".format(
VERSION,
platform.python_version(),
platform.platform())) in response.http_request.headers['User-Agent']
await service.get_service_properties(raw_response_hook=callback, user_agent="TestApp/v2.0")
@GlobalStorageAccountPreparer()
@AsyncStorageTestCase.await_prepared_test
async def test_user_agent_append(self, resource_group, location, storage_account, storage_account_key):
service = QueueServiceClient(self.account_url(storage_account, "queue"), credential=storage_account_key, transport=AiohttpTestTransport())
def callback(response):
self.assertTrue('User-Agent' in response.http_request.headers)
assert ("customer_user_agent azsdk-python-storage-queue/{} Python/{} ({})".format(
VERSION,
platform.python_version(),
platform.platform())) in response.http_request.headers['User-Agent']
await service.get_service_properties(raw_response_hook=callback, user_agent='customer_user_agent')
@GlobalStorageAccountPreparer()
@AsyncStorageTestCase.await_prepared_test
async def test_closing_pipeline_client_async(self, resource_group, location, storage_account, storage_account_key):
# Arrange
for client, url in SERVICES.items():
# Act
service = client(
self.account_url(storage_account, "queue"), credential=storage_account_key, queue_name='queue')
# Assert
async with service:
assert hasattr(service, 'close')
await service.close()
@GlobalStorageAccountPreparer()
@AsyncStorageTestCase.await_prepared_test
async def test_closing_pipeline_client_simple_async(self, resource_group, location, storage_account, storage_account_key):
# Arrange
for client, url in SERVICES.items():
# Act
service = client(
self.account_url(storage_account, "queue"), credential=storage_account_key, queue_name='queue')
await service.close()
# ------------------------------------------------------------------------------
if __name__ == '__main__':
unittest.main()
|
