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
|
# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
"""Tests for the retry policy."""
try:
from io import BytesIO
except ImportError:
from cStringIO import StringIO as BytesIO
import pytest
from itertools import product
from azure.core.configuration import ConnectionConfiguration
from azure.core.exceptions import (
AzureError,
ServiceRequestError,
ServiceRequestTimeoutError,
ServiceResponseError,
ServiceResponseTimeoutError,
)
from azure.core.pipeline.policies import (
RetryPolicy,
RetryMode,
)
from azure.core.pipeline import Pipeline, PipelineResponse
from azure.core.pipeline.transport import (
HttpTransport,
)
import tempfile
import os
import time
try:
from unittest.mock import Mock
except ImportError:
from mock import Mock
from utils import HTTP_REQUESTS, request_and_responses_product, HTTP_RESPONSES, create_http_response
def test_retry_code_class_variables():
retry_policy = RetryPolicy()
assert retry_policy._RETRY_CODES is not None
assert 408 in retry_policy._RETRY_CODES
assert 429 in retry_policy._RETRY_CODES
assert 501 not in retry_policy._RETRY_CODES
def test_retry_types():
history = ["1", "2", "3"]
settings = {"history": history, "backoff": 1, "max_backoff": 10}
retry_policy = RetryPolicy()
backoff_time = retry_policy.get_backoff_time(settings)
assert backoff_time == 4
retry_policy = RetryPolicy(retry_mode=RetryMode.Fixed)
backoff_time = retry_policy.get_backoff_time(settings)
assert backoff_time == 1
retry_policy = RetryPolicy(retry_mode=RetryMode.Exponential)
backoff_time = retry_policy.get_backoff_time(settings)
assert backoff_time == 4
@pytest.mark.parametrize(
"retry_after_input,http_request,http_response",
product(["0", "800", "1000", "1200", "0.9"], HTTP_REQUESTS, HTTP_RESPONSES),
)
def test_retry_after(retry_after_input, http_request, http_response):
retry_policy = RetryPolicy()
request = http_request("GET", "http://localhost")
response = create_http_response(http_response, request, None)
response.headers["retry-after-ms"] = retry_after_input
pipeline_response = PipelineResponse(request, response, None)
retry_after = retry_policy.get_retry_after(pipeline_response)
seconds = float(retry_after_input)
assert retry_after == seconds / 1000.0
response.headers.pop("retry-after-ms")
response.headers["Retry-After"] = retry_after_input
retry_after = retry_policy.get_retry_after(pipeline_response)
assert retry_after == float(retry_after_input)
response.headers["retry-after-ms"] = 500
retry_after = retry_policy.get_retry_after(pipeline_response)
assert retry_after == float(retry_after_input)
@pytest.mark.parametrize(
"retry_after_input,http_request,http_response",
product(["0", "800", "1000", "1200", "0.9"], HTTP_REQUESTS, HTTP_RESPONSES),
)
def test_x_ms_retry_after(retry_after_input, http_request, http_response):
retry_policy = RetryPolicy()
request = http_request("GET", "http://localhost")
response = create_http_response(http_response, request, None)
response.headers["x-ms-retry-after-ms"] = retry_after_input
pipeline_response = PipelineResponse(request, response, None)
retry_after = retry_policy.get_retry_after(pipeline_response)
seconds = float(retry_after_input)
assert retry_after == seconds / 1000.0
response.headers.pop("x-ms-retry-after-ms")
response.headers["Retry-After"] = retry_after_input
retry_after = retry_policy.get_retry_after(pipeline_response)
assert retry_after == float(retry_after_input)
response.headers["x-ms-retry-after-ms"] = 500
retry_after = retry_policy.get_retry_after(pipeline_response)
assert retry_after == float(retry_after_input)
@pytest.mark.parametrize("http_request,http_response", request_and_responses_product(HTTP_RESPONSES))
def test_retry_on_429(http_request, http_response):
class MockTransport(HttpTransport):
def __init__(self):
self._count = 0
def __exit__(self, exc_type, exc_val, exc_tb):
pass
def close(self):
pass
def open(self):
pass
def send(self, request, **kwargs): # type: (PipelineRequest, Any) -> PipelineResponse
self._count += 1
response = create_http_response(http_response, request, None)
response.status_code = 429
return response
http_request = http_request("GET", "http://localhost/")
http_retry = RetryPolicy(retry_total=1)
transport = MockTransport()
pipeline = Pipeline(transport, [http_retry])
pipeline.run(http_request)
assert transport._count == 2
@pytest.mark.parametrize("http_request,http_response", request_and_responses_product(HTTP_RESPONSES))
def test_no_retry_on_201(http_request, http_response):
class MockTransport(HttpTransport):
def __init__(self):
self._count = 0
def __exit__(self, exc_type, exc_val, exc_tb):
pass
def close(self):
pass
def open(self):
pass
def send(self, request, **kwargs): # type: (PipelineRequest, Any) -> PipelineResponse
self._count += 1
response = create_http_response(http_response, request, None)
response.status_code = 201
headers = {"Retry-After": "1"}
response.headers = headers
return response
http_request = http_request("GET", "http://localhost/")
http_retry = RetryPolicy(retry_total=1)
transport = MockTransport()
pipeline = Pipeline(transport, [http_retry])
pipeline.run(http_request)
assert transport._count == 1
@pytest.mark.parametrize("http_request,http_response", request_and_responses_product(HTTP_RESPONSES))
def test_retry_seekable_stream(http_request, http_response):
class MockTransport(HttpTransport):
def __init__(self):
self._first = True
def __exit__(self, exc_type, exc_val, exc_tb):
pass
def close(self):
pass
def open(self):
pass
def send(self, request, **kwargs): # type: (PipelineRequest, Any) -> PipelineResponse
if self._first:
self._first = False
request.body.seek(0, 2)
raise AzureError("fail on first")
position = request.body.tell()
assert position == 0
response = create_http_response(http_response, request, None)
response.status_code = 400
return response
data = BytesIO(b"Lots of dataaaa")
http_request = http_request("GET", "http://localhost/")
http_request.set_streamed_data_body(data)
http_retry = RetryPolicy(retry_total=1)
pipeline = Pipeline(MockTransport(), [http_retry])
pipeline.run(http_request)
@pytest.mark.parametrize("http_request,http_response", request_and_responses_product(HTTP_RESPONSES))
def test_retry_seekable_file(http_request, http_response):
class MockTransport(HttpTransport):
def __init__(self):
self._first = True
def __exit__(self, exc_type, exc_val, exc_tb):
pass
def close(self):
pass
def open(self):
pass
def send(self, request, **kwargs): # type: (PipelineRequest, Any) -> PipelineResponse
if self._first:
self._first = False
for value in request.files.values():
name, body = value[0], value[1]
if name and body and hasattr(body, "read"):
body.seek(0, 2)
raise AzureError("fail on first")
for value in request.files.values():
name, body = value[0], value[1]
if name and body and hasattr(body, "read"):
position = body.tell()
assert not position
response = create_http_response(http_response, request, None)
response.status_code = 400
return response
file = tempfile.NamedTemporaryFile(delete=False)
file.write(b"Lots of dataaaa")
file.close()
http_request = http_request("GET", "http://localhost/")
headers = {"Content-Type": "multipart/form-data"}
http_request.headers = headers
with open(file.name, "rb") as f:
form_data_content = {
"fileContent": f,
"fileName": f.name,
}
http_request.set_formdata_body(form_data_content)
http_retry = RetryPolicy(retry_total=1)
pipeline = Pipeline(MockTransport(), [http_retry])
pipeline.run(http_request)
os.unlink(f.name)
@pytest.mark.parametrize("http_request", HTTP_REQUESTS)
def test_retry_timeout(http_request):
timeout = 1
def send(request, **kwargs):
assert kwargs["connection_timeout"] <= timeout, "policy should set connection_timeout not to exceed timeout"
raise ServiceResponseError("oops")
transport = Mock(
spec=HttpTransport,
send=Mock(wraps=send),
connection_config=ConnectionConfiguration(connection_timeout=timeout * 2),
sleep=time.sleep,
)
pipeline = Pipeline(transport, [RetryPolicy(timeout=timeout)])
with pytest.raises(ServiceResponseTimeoutError):
response = pipeline.run(http_request("GET", "http://localhost/"))
@pytest.mark.parametrize("http_request,http_response", request_and_responses_product(HTTP_RESPONSES))
def test_timeout_defaults(http_request, http_response):
"""When "timeout" is not set, the policy should not override the transport's timeout configuration"""
def send(request, **kwargs):
for arg in ("connection_timeout", "read_timeout"):
assert arg not in kwargs, "policy should defer to transport configuration when not given a timeout"
response = create_http_response(http_response, request, None)
response.status_code = 200
return response
transport = Mock(
spec_set=HttpTransport,
send=Mock(wraps=send),
sleep=Mock(side_effect=Exception("policy should not sleep: its first send succeeded")),
)
pipeline = Pipeline(transport, [RetryPolicy()])
pipeline.run(http_request("GET", "http://localhost/"))
assert transport.send.call_count == 1, "policy should not retry: its first send succeeded"
combinations = [(ServiceRequestError, ServiceRequestTimeoutError), (ServiceResponseError, ServiceResponseTimeoutError)]
@pytest.mark.parametrize(
"combinations,http_request",
product(combinations, HTTP_REQUESTS),
)
def test_does_not_sleep_after_timeout(combinations, http_request):
# With default settings policy will sleep twice before exhausting its retries: 1.6s, 3.2s.
# It should not sleep the second time when given timeout=1
transport_error, expected_timeout_error = combinations
timeout = 1
transport = Mock(
spec=HttpTransport,
send=Mock(side_effect=transport_error("oops")),
sleep=Mock(wraps=time.sleep),
)
pipeline = Pipeline(transport, [RetryPolicy(timeout=timeout)])
with pytest.raises(expected_timeout_error):
pipeline.run(http_request("GET", "http://localhost/"))
assert transport.sleep.call_count == 1
def test_configure_retries_uses_constructor_values():
"""Test that configure_retries method correctly gets values from constructor."""
# Test with custom constructor values
retry_policy = RetryPolicy(
retry_total=5,
retry_connect=2,
retry_read=4,
retry_status=1,
retry_backoff_factor=0.5,
retry_backoff_max=60,
timeout=300,
)
# Call configure_retries with empty options to ensure it uses constructor values
retry_settings = retry_policy.configure_retries({})
# Verify that configure_retries returns constructor values as defaults
assert retry_settings["total"] == 5
assert retry_settings["connect"] == 2
assert retry_settings["read"] == 4
assert retry_settings["status"] == 1
assert retry_settings["backoff"] == 0.5
assert retry_settings["max_backoff"] == 60
assert retry_settings["timeout"] == 300
assert retry_settings["methods"] == frozenset(["HEAD", "GET", "PUT", "DELETE", "OPTIONS", "TRACE"])
assert retry_settings["history"] == []
def test_configure_retries_options_override_constructor():
"""Test that options passed to configure_retries override constructor values."""
# Test with custom constructor values
retry_policy = RetryPolicy(
retry_total=5,
retry_connect=2,
retry_read=4,
retry_status=1,
retry_backoff_factor=0.5,
retry_backoff_max=60,
timeout=300,
)
# Call configure_retries with options that should override constructor values
options = {
"retry_total": 8,
"retry_connect": 6,
"retry_read": 7,
"retry_status": 3,
"retry_backoff_factor": 1.0,
"retry_backoff_max": 180,
"timeout": 600,
"retry_on_methods": frozenset(["GET", "POST"]),
}
retry_settings = retry_policy.configure_retries(options)
# Verify that configure_retries returns option values, not constructor values
assert retry_settings["total"] == 8
assert retry_settings["connect"] == 6
assert retry_settings["read"] == 7
assert retry_settings["status"] == 3
assert retry_settings["backoff"] == 1.0
assert retry_settings["max_backoff"] == 180
assert retry_settings["timeout"] == 600
assert retry_settings["methods"] == frozenset(["GET", "POST"])
assert retry_settings["history"] == []
# Verify options dict was modified (values were popped)
assert "retry_total" not in options
assert "retry_connect" not in options
assert "retry_read" not in options
assert "retry_status" not in options
assert "retry_backoff_factor" not in options
assert "retry_backoff_max" not in options
assert "timeout" not in options
assert "retry_on_methods" not in options
def test_configure_retries_default_values():
"""Test that configure_retries uses default values when no constructor args or options provided."""
# Test with default constructor
retry_policy = RetryPolicy()
# Call configure_retries with empty options
retry_settings = retry_policy.configure_retries({})
# Verify default values from RetryPolicyBase.__init__
assert retry_settings["total"] == 10 # default retry_total
assert retry_settings["connect"] == 3 # default retry_connect
assert retry_settings["read"] == 3 # default retry_read
assert retry_settings["status"] == 3 # default retry_status
assert retry_settings["backoff"] == 0.8 # default retry_backoff_factor
assert retry_settings["max_backoff"] == 120 # default retry_backoff_max (BACKOFF_MAX)
assert retry_settings["timeout"] == 604800 # default timeout
assert retry_settings["methods"] == frozenset(["HEAD", "GET", "PUT", "DELETE", "OPTIONS", "TRACE"])
assert retry_settings["history"] == []
|
