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
|
# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
"""Tests for the retry policy."""
from io import BytesIO
import pytest
from itertools import product
from unittest.mock import Mock
import tempfile
import os
import time
from typing import Any
from corehttp.exceptions import (
BaseError,
ServiceRequestError,
ServiceRequestTimeoutError,
ServiceResponseError,
ServiceResponseTimeoutError,
)
from corehttp.runtime.policies import (
RetryPolicy,
RetryMode,
)
from corehttp.runtime.pipeline import Pipeline, PipelineResponse, PipelineRequest
from corehttp.transport import HttpTransport
from corehttp.rest import HttpRequest
from utils import 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_response", product(["0", "800", "1000", "1200", "0.9"], HTTP_RESPONSES)
)
def test_retry_after(retry_after_input, http_response):
retry_policy = RetryPolicy()
request = HttpRequest("GET", "http://localhost")
response = create_http_response(http_response, request, None, headers={"Retry-After": 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
@pytest.mark.parametrize("http_response", HTTP_RESPONSES)
def test_retry_on_429(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: PipelineRequest, **kwargs: Any) -> PipelineResponse:
self._count += 1
response = create_http_response(http_response, request, None, status_code=429)
return response
http_request = HttpRequest("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_response", HTTP_RESPONSES)
def test_no_retry_on_201(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: PipelineRequest, **kwargs: Any) -> PipelineResponse:
self._count += 1
response = create_http_response(http_response, request, None, status_code=201, headers={"Retry-After": "1"})
return response
http_request = HttpRequest("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_response", HTTP_RESPONSES)
def test_retry_seekable_stream(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: PipelineRequest, **kwargs: Any) -> PipelineResponse:
if self._first:
self._first = False
request.content.seek(0, 2)
raise BaseError("fail on first")
position = request.content.tell()
assert position == 0
response = create_http_response(http_response, request, None, status_code=400)
return response
data = BytesIO(b"Lots of dataaaa")
http_request = HttpRequest("GET", "http://localhost/", content=data)
http_retry = RetryPolicy(retry_total=1)
pipeline = Pipeline(MockTransport(), [http_retry])
pipeline.run(http_request)
@pytest.mark.parametrize("http_response", HTTP_RESPONSES)
def test_retry_seekable_file(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: PipelineRequest, **kwargs: Any):
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 BaseError("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, status_code=400)
return response
file = tempfile.NamedTemporaryFile(delete=False)
file.write(b"Lots of dataaaa")
file.close()
headers = {"Content-Type": "multipart/form-data"}
with open(file.name, "rb") as f:
form_data_content = {
"fileContent": f,
"fileName": f.name,
}
http_request = HttpRequest("GET", "http://localhost/", headers=headers, files=form_data_content)
http_retry = RetryPolicy(retry_total=1)
pipeline = Pipeline(MockTransport(), [http_retry])
pipeline.run(http_request)
os.unlink(f.name)
def test_retry_timeout():
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={"connection_timeout": timeout * 2},
sleep=time.sleep,
)
pipeline = Pipeline(transport, [RetryPolicy(timeout=timeout)])
with pytest.raises(ServiceResponseTimeoutError):
response = pipeline.run(HttpRequest("GET", "http://localhost/"))
@pytest.mark.parametrize("http_response", HTTP_RESPONSES)
def test_timeout_defaults(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, 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(HttpRequest("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", combinations)
def test_does_not_sleep_after_timeout(combinations):
# 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(HttpRequest("GET", "http://localhost/"))
assert transport.sleep.call_count == 1
|
