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
|
# The MIT License (MIT)
# Copyright (c) Microsoft Corporation. All rights reserved.
import unittest
import uuid
import pytest
import azure.cosmos.cosmos_client as cosmos_client
import azure.cosmos.exceptions as exceptions
import test_config
from azure.cosmos import _retry_utility, PartitionKey
from azure.cosmos._location_cache import RegionalRoutingContext, EndpointOperationType
from azure.cosmos._request_object import RequestObject
COLLECTION = "created_collection"
@pytest.fixture(scope="class")
def setup():
if (TestTimeoutRetryPolicy.masterKey == '[YOUR_KEY_HERE]' or
TestTimeoutRetryPolicy.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.")
client = cosmos_client.CosmosClient(TestTimeoutRetryPolicy.host, TestTimeoutRetryPolicy.masterKey, consistency_level="Session",
connection_policy=TestTimeoutRetryPolicy.connectionPolicy)
created_database = client.get_database_client(TestTimeoutRetryPolicy.TEST_DATABASE_ID)
created_collection = created_database.create_container(TestTimeoutRetryPolicy.TEST_CONTAINER_SINGLE_PARTITION_ID,
partition_key=PartitionKey("/pk"))
yield {
COLLECTION: created_collection
}
created_database.delete_container(TestTimeoutRetryPolicy.TEST_CONTAINER_SINGLE_PARTITION_ID)
def error_codes():
return [408, 500, 502, 503]
@pytest.mark.cosmosEmulator
@pytest.mark.unittest
@pytest.mark.usefixtures("setup")
class TestTimeoutRetryPolicy:
host = test_config.TestConfig.host
masterKey = test_config.TestConfig.masterKey
connectionPolicy = test_config.TestConfig.connectionPolicy
TEST_DATABASE_ID = test_config.TestConfig.TEST_DATABASE_ID
TEST_CONTAINER_SINGLE_PARTITION_ID = "test-timeout-retry-policy-container-" + str(uuid.uuid4())
@pytest.mark.parametrize("error_code", error_codes())
def test_timeout_failover_retry_policy_for_read_success(self, setup, error_code):
document_definition = {'id': 'failoverDoc-' + str(uuid.uuid4()),
'pk': 'pk',
'name': 'sample document',
'key': 'value'}
created_document = setup[COLLECTION].create_item(body=document_definition)
self.original_execute_function = _retry_utility.ExecuteFunction
try:
# should retry once and then succeed
mf = self.MockExecuteFunction(self.original_execute_function, 1, error_code)
_retry_utility.ExecuteFunction = mf
doc = setup[COLLECTION].read_item(item=created_document['id'],
partition_key=created_document['pk'])
assert doc == created_document
finally:
_retry_utility.ExecuteFunction = self.original_execute_function
@pytest.mark.parametrize("error_code", error_codes())
def test_timeout_failover_retry_policy_for_read_failure(self, setup, error_code):
document_definition = {'id': 'failoverDoc-' + str(uuid.uuid4()),
'pk': 'pk',
'name': 'sample document',
'key': 'value'}
created_document = setup[COLLECTION].create_item(body=document_definition)
self.original_execute_function = _retry_utility.ExecuteFunction
try:
# should retry once and then fail
mf = self.MockExecuteFunction(self.original_execute_function, 2, error_code)
_retry_utility.ExecuteFunction = mf
setup[COLLECTION].read_item(item=created_document['id'],
partition_key=created_document['pk'])
pytest.fail("Exception was not raised.")
except exceptions.CosmosHttpResponseError as err:
assert err.status_code == error_code
finally:
_retry_utility.ExecuteFunction = self.original_execute_function
@pytest.mark.parametrize("error_code", error_codes())
def test_timeout_failover_retry_policy_for_write_failure(self, setup, error_code):
document_definition = {'id': 'failoverDoc' + str(uuid.uuid4()),
'pk': 'pk',
'name': 'sample document',
'key': 'value'}
self.original_execute_function = _retry_utility.ExecuteFunction
try:
# timeouts should fail immediately for writes
mf = self.MockExecuteFunction(self.original_execute_function,0, error_code)
_retry_utility.ExecuteFunction = mf
try:
setup[COLLECTION].create_item(body=document_definition)
pytest.fail("Exception was not raised.")
except exceptions.CosmosHttpResponseError as err:
assert err.status_code == error_code
finally:
_retry_utility.ExecuteFunction = self.original_execute_function
@pytest.mark.parametrize("error_code", error_codes())
def test_cross_region_retry(self, setup, error_code):
mock_client = cosmos_client.CosmosClient(self.host, self.masterKey)
db = mock_client.get_database_client(self.TEST_DATABASE_ID)
container = db.get_container_client(self.TEST_CONTAINER_SINGLE_PARTITION_ID)
document_definition = {'id': 'failoverDoc' + str(uuid.uuid4()),
'pk': 'pk',
'name': 'sample document',
'key': 'value'}
created_document = container.create_item(body=document_definition)
self.original_execute_function = _retry_utility.ExecuteFunction
original_location_cache = mock_client.client_connection._global_endpoint_manager.location_cache
fake_endpoint = "other-region"
region_1 = "East US"
region_2 = "West US"
regional_routing_context = RegionalRoutingContext(self.host)
regional_routing_context_2 = RegionalRoutingContext(fake_endpoint)
original_location_cache.account_read_locations = [region_1, region_2]
original_location_cache.account_read_regional_routing_contexts_by_location = {region_1: regional_routing_context,
region_2: regional_routing_context_2
}
original_location_cache.read_regional_routing_contexts = [regional_routing_context, regional_routing_context_2]
try:
# should retry once and then succeed
mf = self.MockExecuteFunctionCrossRegion(self.original_execute_function, error_code, fake_endpoint)
_retry_utility.ExecuteFunction = mf
container.read_item(item=created_document['id'],
partition_key=created_document['pk'])
finally:
_retry_utility.ExecuteFunction = self.original_execute_function
class MockExecuteFunction(object):
def __init__(self, org_func, num_exceptions, status_code):
self.org_func = org_func
self.counter = 0
self.num_exceptions = num_exceptions
self.status_code = status_code
def __call__(self, func, *args, **kwargs):
if args and isinstance(args[1], RequestObject):
request_obj = args[1]
if request_obj.resource_type == "docs" and request_obj.operation_type == "Query" or \
request_obj.resource_type == "pkranges" and request_obj.operation_type == "ReadFeed":
# Ignore query or ReadFeed requests
return self.org_func(func, *args, **kwargs)
if self.counter != 0 and self.counter >= self.num_exceptions:
return self.org_func(func, *args, **kwargs)
else:
self.counter += 1
raise exceptions.CosmosHttpResponseError(
status_code=self.status_code,
message="Some Exception",
response=test_config.FakeResponse({}))
return self.org_func(func, *args, **kwargs)
class MockExecuteFunctionCrossRegion(object):
def __init__(self, org_func, status_code, location_endpoint_to_route):
self.org_func = org_func
self.counter = 0
self.status_code = status_code
self.location_endpoint_to_route = location_endpoint_to_route
def __call__(self, func, *args, **kwargs):
if args and isinstance(args[1], RequestObject):
request_obj = args[1]
if request_obj.resource_type == "docs" and request_obj.operation_type == "Query" or \
request_obj.resource_type == "pkranges" and request_obj.operation_type == "ReadFeed":
# Ignore query or ReadFeed requests
return self.org_func(func, *args, **kwargs)
if self.counter == 1:
assert args[1].location_endpoint_to_route == self.location_endpoint_to_route
args[1].location_endpoint_to_route = test_config.TestConfig.host
return self.org_func(func, *args, **kwargs)
else:
self.counter += 1
raise exceptions.CosmosHttpResponseError(
status_code=self.status_code,
message="Some Exception",
response=test_config.FakeResponse({}))
return self.org_func(func, *args, **kwargs)
if __name__ == '__main__':
unittest.main()
|
