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
|
#The MIT License (MIT)
#Copyright (c) 2014 Microsoft Corporation
#Permission is hereby granted, free of charge, to any person obtaining a copy
#of this software and associated documentation files (the "Software"), to deal
#in the Software without restriction, including without limitation the rights
#to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
#copies of the Software, and to permit persons to whom the Software is
#furnished to do so, subject to the following conditions:
#The above copyright notice and this permission notice shall be included in all
#copies or substantial portions of the Software.
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
#IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
#FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
#AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
#LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
#OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
#SOFTWARE.
import unittest
import azure.cosmos.cosmos_client as cosmos_client
import pytest
import azure.cosmos.exceptions as exceptions
import azure.cosmos._retry_options as retry_options
from azure.cosmos.http_constants import HttpHeaders, StatusCodes, SubStatusCodes
from azure.cosmos import _retry_utility, PartitionKey
import test_config
pytestmark = pytest.mark.cosmosEmulator
# IMPORTANT NOTES:
# Most test cases in this file create collections in your Azure Cosmos account.
# Collections are billing entities. By running these test cases, you may incur monetary costs on your account.
# To Run the test, replace the two member fields (masterKey and host) with values
# associated with your Azure Cosmos account.
@pytest.mark.usefixtures("teardown")
class Test_retry_policy_tests(unittest.TestCase):
host = test_config._test_config.host
masterKey = test_config._test_config.masterKey
connectionPolicy = test_config._test_config.connectionPolicy
counter = 0
def __AssertHTTPFailureWithStatus(self, status_code, func, *args, **kwargs):
"""Assert HTTP failure with status.
:Parameters:
- `status_code`: 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)
@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 = cosmos_client.CosmosClient(cls.host, cls.masterKey, consistency_level="Session", connection_policy=cls.connectionPolicy)
cls.created_database = cls.client.create_database_if_not_exists(test_config._test_config.TEST_DATABASE_ID)
cls.created_collection = cls.created_database.create_container_if_not_exists(
test_config._test_config.TEST_COLLECTION_SINGLE_PARTITION_ID, PartitionKey(path="/id"))
cls.retry_after_in_milliseconds = 1000
def test_resource_throttle_retry_policy_default_retry_after(self):
connection_policy = Test_retry_policy_tests.connectionPolicy
connection_policy.RetryOptions = retry_options.RetryOptions(5)
self.OriginalExecuteFunction = _retry_utility.ExecuteFunction
try:
_retry_utility.ExecuteFunction = self._MockExecuteFunction
document_definition = { 'id': 'doc',
'name': 'sample document',
'key': 'value'}
try:
self.created_collection.create_item(body=document_definition)
except exceptions.CosmosHttpResponseError as e:
self.assertEqual(e.status_code, StatusCodes.TOO_MANY_REQUESTS)
self.assertEqual(connection_policy.RetryOptions.MaxRetryAttemptCount, self.created_collection.client_connection.last_response_headers[HttpHeaders.ThrottleRetryCount])
self.assertGreaterEqual(self.created_collection.client_connection.last_response_headers[HttpHeaders.ThrottleRetryWaitTimeInMs],
connection_policy.RetryOptions.MaxRetryAttemptCount * self.retry_after_in_milliseconds)
finally:
_retry_utility.ExecuteFunction = self.OriginalExecuteFunction
def test_resource_throttle_retry_policy_fixed_retry_after(self):
connection_policy = Test_retry_policy_tests.connectionPolicy
connection_policy.RetryOptions = retry_options.RetryOptions(5, 2000)
self.OriginalExecuteFunction = _retry_utility.ExecuteFunction
try:
_retry_utility.ExecuteFunction = self._MockExecuteFunction
document_definition = { 'id': 'doc',
'name': 'sample document',
'key': 'value'}
try:
self.created_collection.create_item(body=document_definition)
except exceptions.CosmosHttpResponseError as e:
self.assertEqual(e.status_code, StatusCodes.TOO_MANY_REQUESTS)
self.assertEqual(connection_policy.RetryOptions.MaxRetryAttemptCount, self.created_collection.client_connection.last_response_headers[HttpHeaders.ThrottleRetryCount])
self.assertGreaterEqual(self.created_collection.client_connection.last_response_headers[HttpHeaders.ThrottleRetryWaitTimeInMs],
connection_policy.RetryOptions.MaxRetryAttemptCount * connection_policy.RetryOptions.FixedRetryIntervalInMilliseconds)
finally:
_retry_utility.ExecuteFunction = self.OriginalExecuteFunction
def test_resource_throttle_retry_policy_max_wait_time(self):
connection_policy = Test_retry_policy_tests.connectionPolicy
connection_policy.RetryOptions = retry_options.RetryOptions(5, 2000, 3)
self.OriginalExecuteFunction = _retry_utility.ExecuteFunction
try:
_retry_utility.ExecuteFunction = self._MockExecuteFunction
document_definition = { 'id': 'doc',
'name': 'sample document',
'key': 'value'}
try:
self.created_collection.create_item(body=document_definition)
except exceptions.CosmosHttpResponseError as e:
self.assertEqual(e.status_code, StatusCodes.TOO_MANY_REQUESTS)
self.assertGreaterEqual(self.created_collection.client_connection.last_response_headers[HttpHeaders.ThrottleRetryWaitTimeInMs],
connection_policy.RetryOptions.MaxWaitTimeInSeconds * 1000)
finally:
_retry_utility.ExecuteFunction = self.OriginalExecuteFunction
def test_resource_throttle_retry_policy_query(self):
connection_policy = Test_retry_policy_tests.connectionPolicy
connection_policy.RetryOptions = retry_options.RetryOptions(5)
document_definition = { 'id': 'doc',
'name': 'sample document',
'key': 'value'}
self.created_collection.create_item(body=document_definition)
self.OriginalExecuteFunction = _retry_utility.ExecuteFunction
try:
_retry_utility.ExecuteFunction = self._MockExecuteFunction
try:
list(self.created_collection.query_items(
{
'query': 'SELECT * FROM root r WHERE r.id=@id',
'parameters': [
{'name': '@id', 'value': document_definition['id']}
]
}))
except exceptions.CosmosHttpResponseError as e:
self.assertEqual(e.status_code, StatusCodes.TOO_MANY_REQUESTS)
self.assertEqual(connection_policy.RetryOptions.MaxRetryAttemptCount,
self.created_collection.client_connection.last_response_headers[HttpHeaders.ThrottleRetryCount])
self.assertGreaterEqual(self.created_collection.client_connection.last_response_headers[HttpHeaders.ThrottleRetryWaitTimeInMs],
connection_policy.RetryOptions.MaxRetryAttemptCount * self.retry_after_in_milliseconds)
finally:
_retry_utility.ExecuteFunction = self.OriginalExecuteFunction
@pytest.mark.xfail
def test_default_retry_policy_for_query(self):
document_definition_1 = { 'id': 'doc1',
'name': 'sample document',
'key': 'value'}
document_definition_2 = { 'id': 'doc2',
'name': 'sample document',
'key': 'value'}
self.created_collection.create_item(body=document_definition_1)
self.created_collection.create_item(body=document_definition_2)
try:
original_execute_function = _retry_utility.ExecuteFunction
mf = self.MockExecuteFunctionConnectionReset(original_execute_function)
_retry_utility.ExecuteFunction = mf
docs = self.created_collection.query_items(query="Select * from c", max_item_count=1, enable_cross_partition_query=True)
result_docs = list(docs)
self.assertEqual(result_docs[0]['id'], 'doc1')
self.assertEqual(result_docs[1]['id'], 'doc2')
# TODO: Differing result between live and emulator
if 'localhost' in self.host or '127.0.0.1' in self.host:
self.assertEqual(mf.counter, 12)
else:
self.assertEqual(mf.counter, 18)
finally:
_retry_utility.ExecuteFunction = original_execute_function
self.created_collection.delete_item(item=result_docs[0], partition_key=result_docs[0]['id'])
self.created_collection.delete_item(item=result_docs[1], partition_key=result_docs[1]['id'])
def test_default_retry_policy_for_read(self):
document_definition = { 'id': 'doc',
'name': 'sample document',
'key': 'value'}
created_document = self.created_collection.create_item(body=document_definition)
try:
original_execute_function = _retry_utility.ExecuteFunction
mf = self.MockExecuteFunctionConnectionReset(original_execute_function)
_retry_utility.ExecuteFunction = mf
doc = self.created_collection.read_item(item=created_document['id'], partition_key=created_document['id'])
self.assertEqual(doc['id'], 'doc')
self.assertEqual(mf.counter, 3)
finally:
_retry_utility.ExecuteFunction = original_execute_function
self.created_collection.delete_item(item=created_document, partition_key=created_document['id'])
def test_default_retry_policy_for_create(self):
document_definition = { 'id': 'doc',
'name': 'sample document',
'key': 'value'}
try:
original_execute_function = _retry_utility.ExecuteFunction
mf = self.MockExecuteFunctionConnectionReset(original_execute_function)
_retry_utility.ExecuteFunction = mf
created_document = {}
try:
created_document = self.created_collection.create_item(body=document_definition)
except exceptions.CosmosHttpResponseError as err:
self.assertEqual(err.status_code, 10054)
self.assertDictEqual(created_document, {})
# 3 retries for readCollection. No retry for createDocument.
# Counter ends up in three additional calls while doing create_item,
# which are reads to the database and container before creating the item.
# As such, even though the retry_utility does not retry for the create, the counter is affected by these.
# TODO: Figure out a way to make the counter only take in the POST call it is looking for.
mf.counter = mf.counter - 3
self.assertEqual(mf.counter, 1)
finally:
_retry_utility.ExecuteFunction = original_execute_function
def _MockExecuteFunction(self, function, *args, **kwargs):
response = test_config.FakeResponse({HttpHeaders.RetryAfterInMilliseconds: self.retry_after_in_milliseconds})
raise exceptions.CosmosHttpResponseError(
status_code=StatusCodes.TOO_MANY_REQUESTS,
message="Request rate is too large",
response=response)
class MockExecuteFunctionConnectionReset(object):
def __init__(self, org_func):
self.org_func = org_func
self.counter = 0
def __call__(self, func, *args, **kwargs):
self.counter = self.counter + 1
if self.counter % 3 == 0:
return self.org_func(func, *args, **kwargs)
else:
raise exceptions.CosmosHttpResponseError(
status_code=10054,
message="Connection was reset",
response=test_config.FakeResponse({}))
if __name__ == '__main__':
unittest.main()
|
