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
|
# The MIT License (MIT)
# Copyright (c) Microsoft Corporation. All rights reserved.
import pytest
import time
import unittest
from unittest.mock import patch
import uuid
from urllib.parse import urlparse
import azure.cosmos.cosmos_client as cosmos_client
import test_config
from azure.cosmos import documents, exceptions, DatabaseProxy, ContainerProxy, \
_synchronized_request, _endpoint_discovery_retry_policy, PartitionKey, _location_cache
from azure.cosmos.http_constants import HttpHeaders, StatusCodes, SubStatusCodes, ResourceType
from azure.core.exceptions import ServiceRequestError
# TODO: These tests need to be properly configured in the pipeline with locational endpoints.
# For now we use the is_not_default_host() method to skip regional checks.
contoso_west = 'https://contoso-westus.documents.azure.com:443/'
contoso_west2 = 'https://contoso-westus2.documents.azure.com:443/'
def is_not_default_host(endpoint):
if endpoint == test_config.TestConfig.host:
return False
return True
def _mock_execute_function(function, *args, **kwargs):
response = test_config.FakeResponse({'x-ms-substatus': SubStatusCodes.WRITE_FORBIDDEN})
raise exceptions.CosmosHttpResponseError(
status_code=StatusCodes.FORBIDDEN,
message="Write Forbidden",
response=response)
def _mock_pipeline_run_function_error(pipeline_client,
request,
**kwargs):
response = test_config.FakePipelineResponse(headers={'x-ms-substatus': SubStatusCodes.WRITE_FORBIDDEN},
status_code=StatusCodes.FORBIDDEN, message="Write Forbidden")
return response
def _mock_get_database_account(url_connection=None, **kwargs):
database_account = documents.DatabaseAccount()
database_account._ReadableLocations = \
[{'databaseAccountEndpoint': TestGlobalDB.host, 'name': 'West US 2'}]
database_account._WritableLocations = \
[{'databaseAccountEndpoint': TestGlobalDB.host.replace("localhost", "127.0.0.1"), 'name': 'West US'}]
return database_account
def _mock_pipeline_run_function(pipeline_client, request, **kwargs):
assert "localhost" in request.url
return test_config.FakePipelineResponse()
@pytest.mark.cosmosEmulator
class TestGlobalDB(unittest.TestCase):
host = test_config.TestConfig.global_host
write_location_host = test_config.TestConfig.write_location_host
read_location_host = test_config.TestConfig.read_location_host
read_location2_host = test_config.TestConfig.read_location2_host
masterKey = test_config.TestConfig.global_masterKey
write_location = test_config.TestConfig.write_location
read_location = test_config.TestConfig.read_location
read_location2 = test_config.TestConfig.read_location2
configs = test_config.TestConfig
client: cosmos_client.CosmosClient = None
test_db: DatabaseProxy = None
test_coll: ContainerProxy = None
def __AssertHTTPFailureWithStatus(self, status_code, sub_status, func, *args, **kwargs):
"""Assert HTTP failure with status.
:Parameters:
- `status_code`: int
- `sub_status`: int
- `func`: function
"""
try:
func(*args, **kwargs)
self.assertFalse(True, 'function should fail.')
except exceptions.CosmosHttpResponseError as inst:
self.assertEqual(inst.status_code, status_code)
self.assertEqual(inst.sub_status, sub_status)
@classmethod
def setUpClass(cls):
if (cls.masterKey == '[YOUR_KEY_HERE]' or
cls.host == '[YOUR_GLOBAL_ENDPOINT_HERE]'):
return (
"You must specify your Azure Cosmos account values for "
"'masterKey' and 'host' at the top of this class to run the "
"tests.")
cls.client = cosmos_client.CosmosClient(cls.host, cls.masterKey)
cls.test_db = cls.client.get_database_client(cls.configs.TEST_DATABASE_ID)
cls.test_coll = cls.test_db.get_container_client(cls.configs.TEST_SINGLE_PARTITION_CONTAINER_ID)
def test_global_db_read_write_endpoints(self):
connection_policy = documents.ConnectionPolicy()
connection_policy.EnableEndpointDiscovery = False
client = cosmos_client.CosmosClient(TestGlobalDB.host, TestGlobalDB.masterKey,
connection_policy=connection_policy)
document_definition = {'id': 'doc',
'pk': 'pk',
'name': 'sample document',
'key': 'value'}
# When EnableEndpointDiscovery is False, WriteEndpoint is set to the endpoint passed while creating the client instance
created_document = self.test_coll.create_item(document_definition)
self.assertEqual(client.client_connection.WriteEndpoint, TestGlobalDB.host)
# Delay to get these resources replicated to read location due to Eventual consistency
time.sleep(5)
read_response = self.test_coll.read_item(item=created_document, partition_key=created_document['pk'])
content_location = str(read_response.get_response_headers()[HttpHeaders.ContentLocation])
# When EnableEndpointDiscovery is False, ReadEndpoint is set to the endpoint passed while creating the client
# instance
assert client.client_connection.ReadEndpoint == TestGlobalDB.host
connection_policy.EnableEndpointDiscovery = True
document_definition['id'] = 'doc2'
client = cosmos_client.CosmosClient(TestGlobalDB.host, TestGlobalDB.masterKey,
connection_policy=connection_policy)
database = client.get_database_client(self.configs.TEST_DATABASE_ID)
container = database.get_container_client(self.configs.TEST_SINGLE_PARTITION_CONTAINER_ID)
# When EnableEndpointDiscovery is True, WriteEndpoint is set to the write endpoint
created_document = container.create_item(document_definition)
if is_not_default_host(TestGlobalDB.write_location_host):
self.assertEqual(client.client_connection.WriteEndpoint, TestGlobalDB.write_location_host)
# Delay to get these resources replicated to read location due to Eventual consistency
time.sleep(5)
read_response = container.read_item(item=created_document, partition_key=created_document['pk'])
content_location = str(read_response.get_response_headers()[HttpHeaders.ContentLocation])
content_location_url = urlparse(content_location)
write_location_url = urlparse(TestGlobalDB.write_location_host)
# If no preferred locations is set, we return the write endpoint as ReadEndpoint for better latency performance
if is_not_default_host(TestGlobalDB.write_location_host):
assert str(content_location_url.hostname) == str(write_location_url.hostname)
assert client.client_connection.ReadEndpoint == TestGlobalDB.write_location_host
def test_global_db_endpoint_discovery(self):
connection_policy = documents.ConnectionPolicy()
connection_policy.EnableEndpointDiscovery = False
read_location_client = cosmos_client.CosmosClient(self.read_location_host,
self.masterKey,
connection_policy=connection_policy)
document_definition = {'id': 'doc1',
'name': 'sample document',
'key': 'value'}
database = read_location_client.get_database_client(self.configs.TEST_DATABASE_ID)
container = database.get_container_client(self.configs.TEST_SINGLE_PARTITION_CONTAINER_ID)
# Create Document will fail for the read location client since it has EnableEndpointDiscovery set to false, and hence the request will directly go to
# the endpoint that was used to create the client instance(which happens to be a read endpoint)
if is_not_default_host(self.read_location_host):
self.__AssertHTTPFailureWithStatus(
StatusCodes.FORBIDDEN,
SubStatusCodes.WRITE_FORBIDDEN,
container.create_item,
document_definition)
# Query databases will pass for the read location client as it's a GET operation
list(read_location_client.query_databases(
query='SELECT * FROM root r WHERE r.id=@id',
parameters=[{'name': '@id', 'value': self.test_db.id}]))
connection_policy.EnableEndpointDiscovery = True
read_location_client = cosmos_client.CosmosClient(self.read_location_host,
self.masterKey,
connection_policy=connection_policy)
database = read_location_client.get_database_client(self.configs.TEST_DATABASE_ID)
container = database.get_container_client(self.configs.TEST_SINGLE_PARTITION_CONTAINER_ID)
# CreateDocument call will go to the WriteEndpoint as EnableEndpointDiscovery is set to True and client will resolve the right endpoint based on the operation
created_document = container.create_item(document_definition)
self.assertEqual(created_document['id'], document_definition['id'])
def test_global_db_preferred_locations(self):
connection_policy = documents.ConnectionPolicy()
connection_policy.EnableEndpointDiscovery = True
client = cosmos_client.CosmosClient(self.host, self.masterKey,
connection_policy=connection_policy)
document_definition = {'id': 'doc3',
'pk': 'pk',
'name': 'sample document',
'key': 'value'}
database = client.get_database_client(self.configs.TEST_DATABASE_ID)
container = database.get_container_client(self.configs.TEST_SINGLE_PARTITION_CONTAINER_ID)
created_document = container.create_item(document_definition)
self.assertEqual(created_document['id'], document_definition['id'])
# Delay to get these resources replicated to read location due to Eventual consistency
time.sleep(5)
read_response = container.read_item(item=created_document, partition_key=created_document['pk'])
content_location = str(read_response.get_response_headers()[HttpHeaders.ContentLocation])
content_location_url = urlparse(content_location)
write_location_url = urlparse(self.write_location_host)
# If no preferred locations is set, we return the write endpoint as ReadEndpoint for better latency performance
if is_not_default_host(self.write_location_host):
self.assertEqual(str(content_location_url.hostname), str(write_location_url.hostname))
self.assertEqual(client.client_connection.ReadEndpoint, self.write_location_host)
if is_not_default_host(self.read_location2): # Client init will fail if no read location given
connection_policy.PreferredLocations = [self.read_location2]
client = cosmos_client.CosmosClient(self.host, self.masterKey,
connection_policy=connection_policy)
database = client.get_database_client(self.configs.TEST_DATABASE_ID)
container = database.get_container_client(self.configs.TEST_SINGLE_PARTITION_CONTAINER_ID)
document_definition['id'] = 'doc4'
created_document = container.create_item(document_definition)
# Delay to get these resources replicated to read location due to Eventual consistency
time.sleep(5)
read_response = container.read_item(item=created_document, partition_key=created_document['pk'])
content_location = str(read_response.get_response_headers()[HttpHeaders.ContentLocation])
content_location_url = urlparse(content_location)
read_location2_url = urlparse(self.read_location2_host)
# Test that the preferred location is set as ReadEndpoint instead of default write endpoint when no preference is set
self.assertEqual(str(content_location_url.hostname), str(read_location2_url.hostname))
self.assertEqual(client.client_connection.ReadEndpoint, self.read_location2_host)
def test_global_db_endpoint_assignments(self):
connection_policy = documents.ConnectionPolicy()
connection_policy.EnableEndpointDiscovery = False
client = cosmos_client.CosmosClient(self.host, self.masterKey,
connection_policy=connection_policy)
# When EnableEndpointDiscovery is set to False, both Read and Write Endpoints point to endpoint passed while creating the client instance
self.assertEqual(client.client_connection.WriteEndpoint, self.host)
self.assertEqual(client.client_connection.ReadEndpoint, self.host)
connection_policy.EnableEndpointDiscovery = True
client = cosmos_client.CosmosClient(self.host, self.masterKey,
connection_policy=connection_policy)
# If no preferred locations is set, we return the write endpoint as ReadEndpoint for better latency performance, write endpoint is set as expected
self.assertEqual(client.client_connection.WriteEndpoint,
client.client_connection.ReadEndpoint)
if is_not_default_host(self.write_location_host):
self.assertEqual(client.client_connection.WriteEndpoint,
self.write_location_host)
if is_not_default_host(self.read_location2):
connection_policy.PreferredLocations = [self.read_location2]
client = cosmos_client.CosmosClient(self.host, self.masterKey,
connection_policy=connection_policy)
# Test that the preferred location is set as ReadEndpoint instead of default write endpoint when no preference is set
self.assertEqual(client.client_connection._global_endpoint_manager.WriteEndpoint,
self.write_location_host)
self.assertEqual(client.client_connection._global_endpoint_manager.ReadEndpoint,
self.read_location2_host)
def test_global_db_update_locations_cache(self):
client = cosmos_client.CosmosClient(self.host, self.masterKey)
writable_locations = [{'name': self.write_location,
'databaseAccountEndpoint': self.write_location_host}]
readable_locations = [{'name': self.read_location,
'databaseAccountEndpoint': self.read_location_host},
{'name': self.read_location2,
'databaseAccountEndpoint': self.read_location2_host}]
if (is_not_default_host(self.write_location_host)
and is_not_default_host(self.read_location_host)
and is_not_default_host(self.read_location2_host)):
write_endpoint, read_endpoint = client.client_connection._global_endpoint_manager.location_cache.update_location_cache(
writable_locations, readable_locations)
# If no preferred locations is set, we return the write endpoint as ReadEndpoint for better latency performance, write endpoint is set as expected
self.assertEqual(write_endpoint, self.write_location_host)
self.assertEqual(read_endpoint, self.write_location_host)
writable_locations = []
readable_locations = []
write_endpoint, read_endpoint = client.client_connection._global_endpoint_manager.location_cache.update_location_cache(
writable_locations, readable_locations)
# If writable_locations and readable_locations are empty, both Read and Write Endpoints point to endpoint passed while creating the client instance
self.assertEqual(write_endpoint, self.host)
self.assertEqual(read_endpoint, self.host)
writable_locations = [{'name': self.write_location,
'databaseAccountEndpoint': self.write_location_host}]
readable_locations = []
write_endpoint, read_endpoint = client.client_connection._global_endpoint_manager.location_cache.update_location_cache(
writable_locations, readable_locations)
# If there are no readable_locations, we use the write endpoint as ReadEndpoint
self.assertEqual(write_endpoint, self.write_location_host)
self.assertEqual(read_endpoint, self.write_location_host)
writable_locations = []
readable_locations = [{'name': self.read_location,
'databaseAccountEndpoint': self.read_location_host}]
write_endpoint, read_endpoint = client.client_connection._global_endpoint_manager.location_cache.update_location_cache(
writable_locations, readable_locations)
# If there are no writable_locations, both Read and Write Endpoints point to endpoint passed while creating the client instance
self.assertEqual(write_endpoint, self.host)
self.assertEqual(read_endpoint, self.host)
writable_locations = [{'name': self.write_location,
'databaseAccountEndpoint': self.write_location_host}]
readable_locations = [{'name': self.read_location,
'databaseAccountEndpoint': self.read_location_host},
{'name': self.read_location2,
'databaseAccountEndpoint': self.read_location2_host}]
connection_policy = documents.ConnectionPolicy()
connection_policy.PreferredLocations = [self.read_location2]
client = cosmos_client.CosmosClient(self.host, self.masterKey,
connection_policy=connection_policy)
write_endpoint, read_endpoint = client.client_connection._global_endpoint_manager.location_cache.update_location_cache(
writable_locations, readable_locations)
# Test that the preferred location is set as ReadEndpoint instead of default write endpoint when no preference is set
self.assertEqual(write_endpoint, self.write_location_host)
self.assertEqual(read_endpoint, self.read_location2_host)
writable_locations = [{'name': self.write_location,
'databaseAccountEndpoint': self.write_location_host},
{'name': self.read_location2,
'databaseAccountEndpoint': self.read_location2_host}]
readable_locations = [{'name': self.read_location,
'databaseAccountEndpoint': self.read_location_host}]
connection_policy = documents.ConnectionPolicy()
connection_policy.PreferredLocations = [self.read_location2]
client = cosmos_client.CosmosClient(self.host, self.masterKey,
connection_policy=connection_policy)
write_endpoint, read_endpoint = client.client_connection._global_endpoint_manager.location_cache.update_location_cache(
writable_locations, readable_locations)
# Test that the preferred location is chosen from the WriteLocations if it's not present in the ReadLocations
self.assertEqual(write_endpoint, self.write_location_host)
self.assertEqual(read_endpoint, self.read_location2_host)
writable_locations = [{'name': self.write_location,
'databaseAccountEndpoint': self.write_location_host}]
readable_locations = [{'name': self.read_location,
'databaseAccountEndpoint': self.read_location_host},
{'name': self.read_location2,
'databaseAccountEndpoint': self.read_location2_host}]
connection_policy.EnableEndpointDiscovery = False
client = cosmos_client.CosmosClient(self.host, self.masterKey,
connection_policy=connection_policy)
write_endpoint, read_endpoint = client.client_connection._global_endpoint_manager.location_cache.update_location_cache(
writable_locations, readable_locations)
# If EnableEndpointDiscovery is False, both Read and Write Endpoints point to endpoint passed while creating the client instance
self.assertEqual(write_endpoint, self.host)
self.assertEqual(read_endpoint, self.host)
def test_global_db_locational_endpoint_parser(self):
url_endpoint = 'https://contoso.documents.azure.com:443/'
location_name = 'East US'
# Creating a locational endpoint from the location name using the parser method
locational_endpoint = _location_cache.LocationCache.GetLocationalEndpoint(url_endpoint, location_name)
self.assertEqual(locational_endpoint, 'https://contoso-eastus.documents.azure.com:443/')
url_endpoint = 'https://Contoso.documents.azure.com:443/'
location_name = 'East US'
# Note that the host name gets lowercased as the urlparser in Python doesn't retains the casing
locational_endpoint = _location_cache.LocationCache.GetLocationalEndpoint(url_endpoint, location_name)
self.assertEqual(locational_endpoint, 'https://contoso-eastus.documents.azure.com:443/')
def test_global_db_service_request_errors(self):
mock_retry_policy = test_config.MockConnectionRetryPolicy(
ResourceType.DatabaseAccount,
ServiceRequestError("mock-service"),
retry_total=5,
retry_connect=None,
retry_read=None,
retry_status=None,
retry_backoff_max=1,
retry_on_status_codes=[],
retry_backoff_factor=0.8,
)
try:
cosmos_client.CosmosClient(self.host, self.masterKey, connection_retry_policy=mock_retry_policy)
pytest.fail("Exception was not raised")
except ServiceRequestError:
# Database account calls should not be retried in connection retry policy
assert mock_retry_policy.counter == 0
def test_global_db_endpoint_discovery_retry_policy_mock(self):
client = cosmos_client.CosmosClient(self.host, self.masterKey)
database = client.get_database_client(self.configs.TEST_DATABASE_ID)
container = database.create_container_if_not_exists("TEST" + str(uuid.uuid4()), PartitionKey(path="/pk"))
# Replace GetDatabaseAccount method
original_get_database_account = client.client_connection.GetDatabaseAccount
cc_copy = client.client_connection
cc_copy.GetDatabaseAccount = _mock_get_database_account
client.client_connection = cc_copy
# Replace _PipelineRunFunction to send a 403/3
with patch.object(_synchronized_request, '_PipelineRunFunction', new=_mock_pipeline_run_function_error):
# original_pipeline_function = _synchronized_request._PipelineRunFunction
# _synchronized_request._PipelineRunFunction = _mock_pipeline_run_function_error
document_definition = {'id': 'doc7',
'pk': 'pk',
'name': 'sample document',
'key': 'value'}
max_retry_attempt_count = 10
retry_after_in_milliseconds = 500
_endpoint_discovery_retry_policy.EndpointDiscoveryRetryPolicy.Max_retry_attempt_count = max_retry_attempt_count
_endpoint_discovery_retry_policy.EndpointDiscoveryRetryPolicy.Retry_after_in_milliseconds = (
retry_after_in_milliseconds)
self.__AssertHTTPFailureWithStatus(
StatusCodes.FORBIDDEN,
SubStatusCodes.WRITE_FORBIDDEN,
container.create_item,
document_definition)
with patch.object(_synchronized_request, '_PipelineRunFunction', new=_mock_pipeline_run_function):
# Verify next outgoing requests have the new updated regions from the 403 retry
_synchronized_request._PipelineRunFunction = _mock_pipeline_run_function
container.create_item(document_definition)
cc_copy.GetDatabaseAccount = original_get_database_account
client.client_connection = cc_copy
if __name__ == '__main__':
unittest.main()
|
