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
|
# The MIT License (MIT)
# Copyright (c) Microsoft Corporation. All rights reserved.
import logging
import unittest
import uuid
import test_config
import pytest
import time
from azure.cosmos import CosmosClient
class MockHandler(logging.Handler):
def __init__(self):
super(MockHandler, self).__init__()
self.messages = []
def reset(self):
self.messages = []
def emit(self, record):
self.messages.append(record.msg)
# Test configurations
class TestDataType:
CLIENT_ONLY_TESTS = 'clientOnlyTests'
CLIENT_AND_REQUEST_TESTS = 'clientAndRequestTests'
ALL_TESTS = 'allTests'
TEST_DATA_TYPE = TestDataType.ALL_TESTS
MOCK_HANDLER = MockHandler()
CONFIG = test_config.TestConfig()
HOST = CONFIG.host
KEY = CONFIG.masterKey
DATABASE_ID = CONFIG.TEST_DATABASE_ID
CONTAINER_ID = CONFIG.TEST_MULTI_PARTITION_PREFIX_PK_CONTAINER_ID
PARTITION_KEY = CONFIG.TEST_CONTAINER_PREFIX_PARTITION_KEY
ITEM_ID = 'doc1'
PARTITION_KEY_VALUES = [f'value{i+1}' for i in range(len(PARTITION_KEY))]
PREFIX_PARTITION_KEY = [PARTITION_KEY_VALUES[0]]
PARTITION_KEY_ITEMS = dict(zip(PARTITION_KEY, PARTITION_KEY_VALUES))
TEST_ITEM = {'id': ITEM_ID}
TEST_ITEM.update(PARTITION_KEY_ITEMS)
L0 = "Default"
L1 = "West US 3"
L2 = "West US"
L3 = "East US 2"
CLIENT_ONLY_TEST_DATA = [
# preferred_locations, client_excluded_locations, excluded_locations_request
# 0. No excluded location
[[L1, L2], [], None],
# 1. Single excluded location
[[L1, L2], [L1], None],
# 2. Exclude all locations
[[L1, L2], [L1, L2], None],
# 3. Exclude a location not in preferred locations
[[L1, L2], [L3], None],
]
CLIENT_AND_REQUEST_TEST_DATA = [
# preferred_locations, client_excluded_locations, excluded_locations_request
# 0. No client excluded locations + a request excluded location
[[L1, L2], [], [L1]],
# 1. The same client and request excluded location
[[L1, L2], [L1], [L1]],
# 2. Less request excluded locations
[[L1, L2], [L1, L2], [L1]],
# 3. More request excluded locations
[[L1, L2], [L1], [L1, L2]],
# 4. All locations were excluded
[[L1, L2], [L1, L2], [L1, L2]],
# 5. No common excluded locations
[[L1, L2], [L1], [L2]],
# 6. Request excluded location not in preferred locations
[[L1, L2], [L1, L2], [L3]],
# 7. Empty excluded locations, remove all client level excluded locations
[[L1, L2], [L1, L2], []],
]
def set_test_data_type(test_data_type):
global TEST_DATA_TYPE
TEST_DATA_TYPE = test_data_type
def get_test_data_with_expected_output(_client_only_output_data, _client_and_request_output_data):
if TEST_DATA_TYPE == TestDataType.CLIENT_ONLY_TESTS:
all_input_test_data = CLIENT_ONLY_TEST_DATA
all_output_data = _client_only_output_data
elif TEST_DATA_TYPE == TestDataType.CLIENT_AND_REQUEST_TESTS:
all_input_test_data = CLIENT_AND_REQUEST_TEST_DATA
all_output_data = _client_and_request_output_data
else:
all_input_test_data = CLIENT_ONLY_TEST_DATA + CLIENT_AND_REQUEST_TEST_DATA
all_output_data = _client_only_output_data + _client_and_request_output_data
all_test_data = [input_data + [output_data] for input_data, output_data in
zip(all_input_test_data, all_output_data)]
return all_test_data
def read_item_test_data():
client_only_output_data = [
[L1], # 0
[L2], # 1
[L1], # 2
[L1], # 3
]
client_and_request_output_data = [
[L2], # 0
[L2], # 1
[L2], # 2
[L1], # 3
[L1], # 4
[L1], # 5
[L1], # 6
[L1], # 7
]
return get_test_data_with_expected_output(client_only_output_data, client_and_request_output_data)
def write_item_test_data():
client_only_output_data = [
[L1], # 0
[L2], # 1
[L0], # 2
[L1], # 3
]
client_and_request_output_data = [
[L2], # 0
[L2], # 1
[L2], # 2
[L0], # 3
[L0], # 4
[L1], # 5
[L1], # 6
[L1], # 7
]
return get_test_data_with_expected_output(client_only_output_data, client_and_request_output_data)
def read_and_write_item_test_data():
read_item = read_item_test_data()
write_item = write_item_test_data()
# Combine the expected_locations of read and write item
for i in range(len(read_item)):
read_item[i][-1] += write_item[i][-1]
return read_item
def create_item_with_excluded_locations(container, body, excluded_locations):
if excluded_locations is None:
container.create_item(body=body)
else:
container.create_item(body=body, excluded_locations=excluded_locations)
def init_container(preferred_locations, client_excluded_locations, multiple_write_locations = True):
client = CosmosClient(HOST, KEY,
preferred_locations=preferred_locations,
excluded_locations=client_excluded_locations,
multiple_write_locations=multiple_write_locations)
db = client.get_database_client(DATABASE_ID)
container = db.get_container_client(CONTAINER_ID)
MOCK_HANDLER.reset()
return client, db, container
def verify_endpoint(messages, client, expected_locations, multiple_write_locations = True):
if not multiple_write_locations:
expected_locations[-1] = L1
# get mapping for locations
location_mapping = (client.client_connection._global_endpoint_manager.
location_cache.account_locations_by_write_endpoints)
default_endpoint = (client.client_connection._global_endpoint_manager.
location_cache.default_regional_routing_context.get_primary())
# get Request URL
req_urls = [url.replace("Request URL: '", "") for url in messages if 'Request URL:' in url]
# get location
actual_locations = set()
for req_url in req_urls:
if req_url.startswith(default_endpoint):
actual_locations.add(L0)
else:
for endpoint in location_mapping:
if req_url.startswith(endpoint):
location = location_mapping[endpoint]
actual_locations.add(location)
break
assert actual_locations == set(expected_locations)
@pytest.fixture(scope="class", autouse=True)
def setup_and_teardown():
print("Setup: This runs before any tests")
logger = logging.getLogger("azure")
logger.addHandler(MOCK_HANDLER)
logger.setLevel(logging.DEBUG)
container = CosmosClient(HOST, KEY).get_database_client(DATABASE_ID).get_container_client(CONTAINER_ID)
container.upsert_item(body=TEST_ITEM)
# Waiting some time for the new items to be replicated to other regions
time.sleep(3)
yield
# Code to run after tests
print("Teardown: This runs after all tests")
@pytest.mark.cosmosMultiRegion
class TestExcludedLocations:
@pytest.mark.parametrize('test_data', read_item_test_data())
def test_read_item(self, test_data):
# Init test variables
preferred_locations, client_excluded_locations, request_excluded_locations, expected_locations = test_data
# Client setup
client, db, container = init_container(preferred_locations, client_excluded_locations)
# API call: read_item
if request_excluded_locations is None:
container.read_item(item=ITEM_ID, partition_key=PARTITION_KEY_VALUES)
else:
container.read_item(item=ITEM_ID, partition_key=PARTITION_KEY_VALUES, excluded_locations=request_excluded_locations)
# Verify endpoint locations
verify_endpoint(MOCK_HANDLER.messages, client, expected_locations)
@pytest.mark.parametrize('test_data', read_item_test_data())
def test_read_all_items(self, test_data):
# Init test variables
preferred_locations, client_excluded_locations, request_excluded_locations, expected_locations = test_data
# Client setup
client, db, container = init_container(preferred_locations, client_excluded_locations)
# API call: read_all_items
if request_excluded_locations is None:
list(container.read_all_items())
else:
list(container.read_all_items(excluded_locations=request_excluded_locations))
# Verify endpoint locations
verify_endpoint(MOCK_HANDLER.messages, client, expected_locations)
@pytest.mark.parametrize('test_data', read_item_test_data())
def test_query_items_with_partition_key(self, test_data):
# Init test variables
preferred_locations, client_excluded_locations, request_excluded_locations, expected_locations = test_data
# Client setup and create an item
client, db, container = init_container(preferred_locations, client_excluded_locations)
# API call: query_items
query = 'select * from c'
if request_excluded_locations is None:
list(container.query_items(query, partition_key=PREFIX_PARTITION_KEY))
else:
list(container.query_items(query, partition_key=PREFIX_PARTITION_KEY, excluded_locations=request_excluded_locations))
# Verify endpoint locations
verify_endpoint(MOCK_HANDLER.messages, client, expected_locations)
@pytest.mark.parametrize('test_data', read_item_test_data())
def test_query_items_with_query_plan(self, test_data):
# Init test variables
preferred_locations, client_excluded_locations, request_excluded_locations, expected_locations = test_data
# Client setup and create an item
client, db, container = init_container(preferred_locations, client_excluded_locations)
# API call: query_items
query = 'Select top 10 value count(c.id) from c'
if request_excluded_locations is None:
list(container.query_items(query, enable_cross_partition_query=True))
# list(container.query_items(query))
else:
list(container.query_items(query, enable_cross_partition_query=True, excluded_locations=request_excluded_locations))
# Verify endpoint locations
verify_endpoint(MOCK_HANDLER.messages, client, expected_locations)
@pytest.mark.parametrize('test_data', read_item_test_data())
def test_query_items_change_feed(self, test_data):
# Init test variables
preferred_locations, client_excluded_locations, request_excluded_locations, expected_locations = test_data
# Client setup and create an item
client, db, container = init_container(preferred_locations, client_excluded_locations)
# API call: query_items_change_feed
if request_excluded_locations is None:
items = list(container.query_items_change_feed(start_time="Beginning", partition_key=PREFIX_PARTITION_KEY))
else:
items = list(container.query_items_change_feed(start_time="Beginning", partition_key=PREFIX_PARTITION_KEY, excluded_locations=request_excluded_locations))
# Verify endpoint locations
verify_endpoint(MOCK_HANDLER.messages, client, expected_locations)
@pytest.mark.parametrize('test_data', read_and_write_item_test_data())
def test_replace_item(self, test_data):
# Init test variables
preferred_locations, client_excluded_locations, request_excluded_locations, expected_locations = test_data
for multiple_write_locations in [True, False]:
# Client setup and create an item
client, db, container = init_container(preferred_locations, client_excluded_locations, multiple_write_locations)
# API call: replace_item
if request_excluded_locations is None:
container.replace_item(ITEM_ID, body=TEST_ITEM)
else:
container.replace_item(ITEM_ID, body=TEST_ITEM, excluded_locations=request_excluded_locations)
# Verify endpoint locations
verify_endpoint(MOCK_HANDLER.messages, client, expected_locations, multiple_write_locations)
@pytest.mark.parametrize('test_data', read_and_write_item_test_data())
def test_upsert_item(self, test_data):
# Init test variables
preferred_locations, client_excluded_locations, request_excluded_locations, expected_locations = test_data
for multiple_write_locations in [True, False]:
# Client setup and create an item
client, db, container = init_container(preferred_locations, client_excluded_locations, multiple_write_locations)
# API call: upsert_item
body = {'id': f'doc2-{str(uuid.uuid4())}'}
body.update(PARTITION_KEY_ITEMS)
if request_excluded_locations is None:
container.upsert_item(body=body)
else:
container.upsert_item(body=body, excluded_locations=request_excluded_locations)
# get location from mock_handler
verify_endpoint(MOCK_HANDLER.messages, client, expected_locations, multiple_write_locations)
@pytest.mark.parametrize('test_data', read_and_write_item_test_data())
def test_create_item(self, test_data):
# Init test variables
preferred_locations, client_excluded_locations, request_excluded_locations, expected_locations = test_data
for multiple_write_locations in [True, False]:
# Client setup and create an item
client, db, container = init_container(preferred_locations, client_excluded_locations, multiple_write_locations)
# API call: create_item
body = {'id': f'doc2-{str(uuid.uuid4())}'}
body.update(PARTITION_KEY_ITEMS)
create_item_with_excluded_locations(container, body, request_excluded_locations)
# Single write
verify_endpoint(MOCK_HANDLER.messages, client, expected_locations, multiple_write_locations)
@pytest.mark.parametrize('test_data', read_and_write_item_test_data())
def test_patch_item(self, test_data):
# Init test variables
preferred_locations, client_excluded_locations, request_excluded_locations, expected_locations = test_data
for multiple_write_locations in [True, False]:
# Client setup and create an item
client, db, container = init_container(preferred_locations, client_excluded_locations,
multiple_write_locations)
# API call: patch_item
operations = [
{"op": "add", "path": "/test_data", "value": f'Data-{str(uuid.uuid4())}'},
]
if request_excluded_locations is None:
container.patch_item(item=ITEM_ID, partition_key=PARTITION_KEY_VALUES,
patch_operations=operations)
else:
container.patch_item(item=ITEM_ID, partition_key=PARTITION_KEY_VALUES,
patch_operations=operations,
excluded_locations=request_excluded_locations)
# get location from mock_handler
verify_endpoint(MOCK_HANDLER.messages, client, expected_locations, multiple_write_locations)
@pytest.mark.parametrize('test_data', read_and_write_item_test_data())
def test_execute_item_batch(self, test_data):
# Init test variables
preferred_locations, client_excluded_locations, request_excluded_locations, expected_locations = test_data
for multiple_write_locations in [True, False]:
# Client setup and create an item
client, db, container = init_container(preferred_locations, client_excluded_locations,
multiple_write_locations)
# API call: execute_item_batch
batch_operations = []
for i in range(3):
body = {'id': f'doc2-{str(uuid.uuid4())}'}
body.update(PARTITION_KEY_ITEMS)
batch_operations.append(("create", (
body,
)))
if request_excluded_locations is None:
container.execute_item_batch(batch_operations=batch_operations,
partition_key=PARTITION_KEY_VALUES,)
else:
container.execute_item_batch(batch_operations=batch_operations,
partition_key=PARTITION_KEY_VALUES,
excluded_locations=request_excluded_locations)
# get location from mock_handler
verify_endpoint(MOCK_HANDLER.messages, client, expected_locations, multiple_write_locations)
@pytest.mark.parametrize('test_data', write_item_test_data())
def test_delete_item(self, test_data):
# Init test variables
preferred_locations, client_excluded_locations, request_excluded_locations, expected_locations = test_data
for multiple_write_locations in [True, False]:
# Client setup
client, db, container = init_container(preferred_locations, client_excluded_locations, multiple_write_locations)
# create before delete
item_id = f'doc2-{str(uuid.uuid4())}'
body = {'id': item_id}
body.update(PARTITION_KEY_ITEMS)
create_item_with_excluded_locations(container, body, request_excluded_locations)
MOCK_HANDLER.reset()
# API call: delete_item
if request_excluded_locations is None:
container.delete_item(item_id, PARTITION_KEY_VALUES)
else:
container.delete_item(item_id, PARTITION_KEY_VALUES, excluded_locations=request_excluded_locations)
# Verify endpoint locations
verify_endpoint(MOCK_HANDLER.messages, client, expected_locations, multiple_write_locations)
if __name__ == "__main__":
unittest.main()
|
