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
|
# The MIT License (MIT)
# Copyright (c) Microsoft Corporation. All rights reserved.
import unittest
import uuid
import pytest
import test_config
from azure.cosmos import CosmosClient, exceptions, PartitionKey, DatabaseProxy
from azure.cosmos.http_constants import HttpHeaders, StatusCodes
def get_subpartition_item(item_id):
return {'id': item_id,
'key': 'value',
'state': 'WA',
'city': 'Redmond',
'zipcode': '98052'}
@pytest.mark.cosmosEmulator
class TestTransactionalBatch(unittest.TestCase):
"""Python Transactional Batch Tests.
"""
configs = test_config.TestConfig
host = configs.host
masterKey = configs.masterKey
client: CosmosClient = None
test_database: DatabaseProxy = None
TEST_DATABASE_ID = configs.TEST_DATABASE_ID
@classmethod
def setUpClass(cls):
if (cls.masterKey == '[YOUR_KEY_HERE]' or
cls.host == '[YOUR_ENDPOINT_HERE]'):
raise Exception(
"You must specify your Azure Cosmos account values for "
"'masterKey' and 'host' at the top of this class to run the "
"tests.")
cls.client = CosmosClient(cls.host, cls.masterKey)
cls.test_database = cls.client.get_database_client(cls.TEST_DATABASE_ID)
def test_invalid_batch_sizes(self):
container = self.test_database.create_container(id="invalid_batch_size" + str(uuid.uuid4()),
partition_key=PartitionKey(path="/company"))
# empty batch
try:
container.execute_item_batch(batch_operations=[], partition_key="Microsoft")
self.fail("Operation should have failed.")
except exceptions.CosmosHttpResponseError as e:
assert e.status_code == StatusCodes.BAD_REQUEST
assert "Batch request has no operations." in e.message
# batch with > 100 items
batch = []
for i in range(101):
batch.append(("create", ({"id": "item" + str(i), "company": "Microsoft"},)))
try:
container.execute_item_batch(batch_operations=batch, partition_key="Microsoft")
self.fail("Operation should have failed.")
except exceptions.CosmosHttpResponseError as e:
assert e.status_code == StatusCodes.BAD_REQUEST
assert "Batch request has more operations than what is supported." in e.message
# batch too large
item_id = str(uuid.uuid4())
massive_item = {"id": item_id, "company": "Microsoft"}
while len(str(massive_item)) < 2500000:
for i in range(100):
massive_item.update({str(uuid.uuid4()): str(uuid.uuid4())})
batch = [("create", (massive_item,))]
try:
container.execute_item_batch(batch_operations=batch, partition_key="Microsoft")
self.fail("test should have failed")
except exceptions.CosmosHttpResponseError as e:
assert e.status_code == StatusCodes.REQUEST_ENTITY_TOO_LARGE
assert e.message.startswith("(RequestEntityTooLarge)")
self.test_database.delete_container(container.id)
def test_batch_create(self):
container = self.test_database.create_container(id="batch_create" + str(uuid.uuid4()),
partition_key=PartitionKey(path="/company"))
batch = []
for i in range(100):
batch.append(("create", ({"id": "item" + str(i), "company": "Microsoft"},)))
batch_response = container.execute_item_batch(batch_operations=batch, partition_key="Microsoft")
assert len(batch_response) == 100
# create the same item twice
item_id = str(uuid.uuid4())
batch = [("create", ({"id": item_id, "company": "Microsoft"},)),
("create", ({"id": item_id, "company": "Microsoft"},))]
try:
container.execute_item_batch(batch_operations=batch, partition_key="Microsoft")
self.fail("Request should have failed.")
except exceptions.CosmosBatchOperationError as e:
assert e.status_code == StatusCodes.CONFLICT
assert e.error_index == 1
operation_results = e.operation_responses
assert len(operation_results) == 2
assert operation_results[0].get("statusCode") == StatusCodes.FAILED_DEPENDENCY
assert operation_results[1].get("statusCode") == StatusCodes.CONFLICT
# create an item without the right partition key.
batch = [("create", ({"id": str(uuid.uuid4()), "company": "Microsoft"},)),
("create", ({"id": str(uuid.uuid4()), "company": "Not-Microsoft"},))]
try:
container.execute_item_batch(batch_operations=batch, partition_key="Microsoft")
self.fail("Request should have failed.")
except exceptions.CosmosBatchOperationError as e:
assert e.status_code == StatusCodes.BAD_REQUEST
assert e.error_index == 1
operation_results = e.operation_responses
assert len(operation_results) == 2
assert operation_results[0].get("statusCode") == StatusCodes.FAILED_DEPENDENCY
assert operation_results[1].get("statusCode") == StatusCodes.BAD_REQUEST
# create an item without a partition key
batch = [("create", ({"id": str(uuid.uuid4()), "company": "Microsoft"},)),
("create", ({"id": str(uuid.uuid4()), "name": "Simon"},))]
try:
container.execute_item_batch(batch_operations=batch, partition_key="Microsoft")
self.fail("Request should have failed.")
except exceptions.CosmosBatchOperationError as e:
assert e.status_code == StatusCodes.BAD_REQUEST
assert e.error_index == 1
operation_results = e.operation_responses
assert len(operation_results) == 2
assert operation_results[0].get("statusCode") == StatusCodes.FAILED_DEPENDENCY
assert operation_results[1].get("statusCode") == StatusCodes.BAD_REQUEST
self.test_database.delete_container(container.id)
def test_batch_read(self):
container = self.test_database.create_container(id="batch_read" + str(uuid.uuid4()),
partition_key=PartitionKey(path="/company"))
batch = []
for i in range(100):
container.create_item({"id": "item" + str(i), "company": "Microsoft"})
batch.append(("read", ("item" + str(i),)))
batch_response = container.execute_item_batch(batch_operations=batch, partition_key="Microsoft")
assert len(batch_response) == 100
for result in batch_response:
assert result.get("statusCode") == 200
# read non-existent item
batch = [("read", (str(uuid.uuid4()),)),
("read", (str(uuid.uuid4()),))]
try:
container.execute_item_batch(batch_operations=batch, partition_key="Microsoft")
self.fail("Request should have failed.")
except exceptions.CosmosBatchOperationError as e:
assert e.status_code == StatusCodes.NOT_FOUND
assert e.error_index == 0
operation_results = e.operation_responses
assert len(operation_results) == 2
assert operation_results[0].get("statusCode") == StatusCodes.NOT_FOUND
assert operation_results[1].get("statusCode") == StatusCodes.FAILED_DEPENDENCY
self.test_database.delete_container(container.id)
def test_batch_replace(self):
container = self.test_database.create_container(id="batch_replace" + str(uuid.uuid4()),
partition_key=PartitionKey(path="/company"))
batch = [("create", ({"id": "new-item", "company": "Microsoft"},)),
("replace", ("new-item", {"id": "new-item", "company": "Microsoft", "message": "item was replaced"}))]
batch_response = container.execute_item_batch(batch_operations=batch, partition_key="Microsoft")
assert len(batch_response) == 2
assert batch_response[1].get("resourceBody").get("message") == "item was replaced"
# replace non-existent
batch = [("replace", ("no-item", {"id": "no-item", "company": "Microsoft", "message": "item was replaced"}))]
try:
container.execute_item_batch(batch_operations=batch, partition_key="Microsoft")
self.fail("Request should have failed.")
except exceptions.CosmosBatchOperationError as e:
assert e.status_code == StatusCodes.NOT_FOUND
assert e.error_index == 0
operation_results = e.operation_responses
assert len(operation_results) == 1
assert operation_results[0].get("statusCode") == StatusCodes.NOT_FOUND
# replace with wrong etag
item_id = str(uuid.uuid4())
batch = [("upsert", ({"id": item_id, "company": "Microsoft"},)),
("replace", (item_id, {"id": item_id, "company": "Microsoft", "message": "item was replaced"}),
{"if_match_etag": "some-tag"}),
("replace", (item_id, {"id": item_id, "company": "Microsoft", "message": "item was replaced"}),
{"if_none_match_etag": "some-tag"})]
try:
container.execute_item_batch(batch_operations=batch, partition_key="Microsoft")
self.fail("Request should have failed.")
except exceptions.CosmosBatchOperationError as e:
assert e.status_code == StatusCodes.PRECONDITION_FAILED
assert e.error_index == 1
operation_results = e.operation_responses
assert len(operation_results) == 3
assert operation_results[0].get("statusCode") == StatusCodes.FAILED_DEPENDENCY
assert operation_results[1].get("statusCode") == StatusCodes.PRECONDITION_FAILED
assert operation_results[2].get("statusCode") == StatusCodes.FAILED_DEPENDENCY
self.test_database.delete_container(container.id)
def test_batch_upsert(self):
container = self.test_database.create_container(id="batch_upsert" + str(uuid.uuid4()),
partition_key=PartitionKey(path="/company"))
item_id = str(uuid.uuid4())
batch = [("upsert", ({"id": item_id, "company": "Microsoft"},)),
("upsert", ({"id": item_id, "company": "Microsoft", "message": "item was upsert"},)),
("upsert", ({"id": str(uuid.uuid4()), "company": "Microsoft"},))]
batch_response = container.execute_item_batch(batch_operations=batch, partition_key="Microsoft")
assert len(batch_response) == 3
assert batch_response[1].get("resourceBody").get("message") == "item was upsert"
self.test_database.delete_container(container.id)
def test_batch_patch(self):
container = self.test_database.create_container(id="batch_patch" + str(uuid.uuid4()),
partition_key=PartitionKey(path="/company"))
item_id = str(uuid.uuid4())
batch = [("upsert", ({"id": item_id,
"company": "Microsoft",
"city": "Seattle",
"port": 9000,
"remove_path": True,
"move_path": "yes",
"set_path": 1},)),
("patch", (item_id, [
{"op": "add", "path": "/favorite_color", "value": "red"},
{"op": "remove", "path": "/remove_path"},
{"op": "replace", "path": "/city", "value": "Redmond"},
{"op": "set", "path": "/set_path", "value": 0},
{"op": "incr", "path": "/port", "value": 5},
{"op": "move", "from": "/move_path", "path": "/moved_path"}]))]
batch_response = container.execute_item_batch(batch_operations=batch, partition_key="Microsoft")
assert len(batch_response) == 2
assert batch_response[1].get("resourceBody").get("favorite_color") == "red"
assert batch_response[1].get("resourceBody").get("remove_path") is None
assert batch_response[1].get("resourceBody").get("city") == "Redmond"
assert batch_response[1].get("resourceBody").get("set_path") == 0
assert batch_response[1].get("resourceBody").get("port") == 9005
assert batch_response[1].get("resourceBody").get("move_path") is None
assert batch_response[1].get("resourceBody").get("moved_path") == "yes"
# conditional patching incorrect filter
item_id = str(uuid.uuid4())
batch = [("upsert", ({"id": item_id,
"company": "Microsoft",
"city": "Seattle",
"port": 9000,
"remove_path": True,
"move_path": "yes",
"set_path": 1},)),
("patch", (item_id, [{"op": "add", "path": "/favorite_color", "value": "red"}]),
{"filter_predicate": "from c where c.set_path = 0"})]
try:
container.execute_item_batch(batch_operations=batch, partition_key="Microsoft")
self.fail("Request should have failed.")
except exceptions.CosmosBatchOperationError as e:
assert e.status_code == StatusCodes.PRECONDITION_FAILED
assert e.error_index == 1
operation_results = e.operation_responses
assert len(operation_results) == 2
assert operation_results[0].get("statusCode") == StatusCodes.FAILED_DEPENDENCY
assert operation_results[1].get("statusCode") == StatusCodes.PRECONDITION_FAILED
# with correct filter
batch = [("upsert", ({"id": item_id,
"company": "Microsoft",
"city": "Seattle",
"port": 9000,
"remove_path": True,
"move_path": "yes",
"set_path": 1},)),
("patch", (item_id, [{"op": "add", "path": "/favorite_color", "value": "red"}]),
{"filter_predicate": "from c where c.set_path = 1"})]
batch_response = container.execute_item_batch(batch_operations=batch, partition_key="Microsoft")
assert len(batch_response) == 2
self.test_database.delete_container(container.id)
def test_batch_delete(self):
container = self.test_database.create_container(id="batch_delete" + str(uuid.uuid4()),
partition_key=PartitionKey(path="/company"))
create_batch = []
delete_batch = []
for i in range(10):
item_id = str(uuid.uuid4())
create_batch.append(("create", ({"id": item_id, "company": "Microsoft"},)))
delete_batch.append(("delete", (item_id,)))
batch_response = container.execute_item_batch(batch_operations=create_batch, partition_key="Microsoft")
assert len(batch_response) == 10
assert len(list(container.read_all_items())) == 10
batch_response = container.execute_item_batch(batch_operations=delete_batch, partition_key="Microsoft")
assert len(batch_response) == 10
assert len(list(container.read_all_items())) == 0
# delete non-existent item
batch = [("delete", ("new-item",)),
("delete", ("new-item",))]
try:
container.execute_item_batch(batch_operations=batch, partition_key="Microsoft")
self.fail("Request should have failed.")
except exceptions.CosmosBatchOperationError as e:
assert e.status_code == StatusCodes.NOT_FOUND
assert e.error_index == 0
operation_results = e.operation_responses
assert len(operation_results) == 2
assert operation_results[0].get("statusCode") == StatusCodes.NOT_FOUND
assert operation_results[1].get("statusCode") == StatusCodes.FAILED_DEPENDENCY
self.test_database.delete_container(container.id)
def test_batch_lsn(self):
container = self.test_database.create_container(id="batch_lsn" + str(uuid.uuid4()),
partition_key=PartitionKey(path="/company"))
# create test items
container.upsert_item({"id": "read_item", "company": "Microsoft"})
container.upsert_item({"id": "replace_item", "company": "Microsoft", "value": 0})
container.upsert_item({"id": "patch_item", "company": "Microsoft"})
container.upsert_item({"id": "delete_item", "company": "Microsoft"})
read_response = container.read_item(item="read_item", partition_key="Microsoft")
lsn = read_response.get_response_headers().get(HttpHeaders.LSN)
batch = [("create", ({"id": "create_item", "company": "Microsoft"},)),
("replace", ("replace_item", {"id": "replace_item", "company": "Microsoft", "value": True})),
("upsert", ({"id": "upsert_item", "company": "Microsoft"},)),
("patch", ("patch_item", [{"op": "add", "path": "/favorite_color", "value": "red"}])),
("read", ("read_item",)),
("delete", ("delete_item",))]
batch_response = container.execute_item_batch(batch_operations=batch, partition_key="Microsoft")
assert len(batch_response) == 6
assert int(lsn) == int(batch_response.get_response_headers().get(HttpHeaders.LSN)) - 1
self.test_database.delete_container(container.id)
def test_batch_subpartition(self):
container = self.test_database.create_container(
id="batch_subpartition" + str(uuid.uuid4()),
partition_key=PartitionKey(path=["/state", "/city", "/zipcode"], kind="MultiHash"))
item_ids = [str(uuid.uuid4()), str(uuid.uuid4()), str(uuid.uuid4())]
container.upsert_item({'id': item_ids[0],
'key': 'value',
'state': 'WA',
'city': 'Redmond',
'zipcode': '98052'})
container.upsert_item({'id': item_ids[1],
'key': 'value',
'state': 'WA',
'city': 'Redmond',
'zipcode': '98052'})
container.upsert_item({'id': item_ids[2],
'key': 'value',
'state': 'WA',
'city': 'Redmond',
'zipcode': '98052'})
batch = [("create", (get_subpartition_item(str(uuid.uuid4())),)),
("replace", (item_ids[0], {"id": item_ids[0],
'state': 'WA',
'city': 'Redmond',
'zipcode': '98052',
'replaced': True})),
("upsert", (get_subpartition_item(str(uuid.uuid4())),)),
("patch", (item_ids[1], [{"op": "add", "path": "/favorite_color", "value": "red"}])),
("read", (item_ids[2],)),
("delete", (item_ids[2],))]
batch_response = container.execute_item_batch(batch_operations=batch, partition_key=["WA", "Redmond", "98052"])
assert len(batch_response) == 6
# try to use incomplete key
try:
container.execute_item_batch(batch_operations=batch, partition_key=["WA", "Redmond"])
self.fail("Request should have failed.")
except exceptions.CosmosHttpResponseError as e:
assert e.status_code == StatusCodes.BAD_REQUEST
assert "Partition key provided either doesn't correspond to " \
"definition in the collection or doesn't match partition key " \
"field values specified in the document." in e.message
self.test_database.delete_container(container.id)
if __name__ == '__main__':
unittest.main()
|
