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
|
from unittest.mock import patch
import pytest
from redis.asyncio.retry import Retry as AsyncRetry
from redis.backoff import (
AbstractBackoff,
ConstantBackoff,
DecorrelatedJitterBackoff,
EqualJitterBackoff,
ExponentialBackoff,
ExponentialWithJitterBackoff,
FullJitterBackoff,
NoBackoff,
)
from redis.client import Redis
from redis.connection import Connection, UnixDomainSocketConnection
from redis.exceptions import (
BusyLoadingError,
ConnectionError,
ReadOnlyError,
TimeoutError,
)
from redis.retry import Retry
from .conftest import _get_client
class BackoffMock(AbstractBackoff):
def __init__(self):
self.reset_calls = 0
self.calls = 0
def reset(self):
self.reset_calls += 1
def compute(self, failures):
self.calls += 1
return 0
class TestConnectionConstructorWithRetry:
"Test that the Connection constructors properly handles Retry objects"
@pytest.mark.parametrize("retry_on_timeout", [False, True])
@pytest.mark.parametrize("Class", [Connection, UnixDomainSocketConnection])
def test_retry_on_timeout_boolean(self, Class, retry_on_timeout):
c = Class(retry_on_timeout=retry_on_timeout)
assert c.retry_on_timeout == retry_on_timeout
assert isinstance(c.retry, Retry)
assert c.retry._retries == (1 if retry_on_timeout else 0)
@pytest.mark.parametrize("retries", range(10))
@pytest.mark.parametrize("Class", [Connection, UnixDomainSocketConnection])
def test_retry_on_timeout_retry(self, Class, retries):
retry_on_timeout = retries > 0
c = Class(retry_on_timeout=retry_on_timeout, retry=Retry(NoBackoff(), retries))
assert c.retry_on_timeout == retry_on_timeout
assert isinstance(c.retry, Retry)
assert c.retry._retries == retries
@pytest.mark.parametrize("Class", [Connection, UnixDomainSocketConnection])
def test_retry_on_error(self, Class):
c = Class(retry_on_error=[ReadOnlyError])
assert c.retry_on_error == [ReadOnlyError]
assert isinstance(c.retry, Retry)
assert c.retry._retries == 1
@pytest.mark.parametrize("Class", [Connection, UnixDomainSocketConnection])
def test_retry_on_error_empty_value(self, Class):
c = Class(retry_on_error=[])
assert c.retry_on_error == []
assert isinstance(c.retry, Retry)
assert c.retry._retries == 0
@pytest.mark.parametrize("Class", [Connection, UnixDomainSocketConnection])
def test_retry_on_error_and_timeout(self, Class):
c = Class(
retry_on_error=[ReadOnlyError, BusyLoadingError], retry_on_timeout=True
)
assert c.retry_on_error == [ReadOnlyError, BusyLoadingError, TimeoutError]
assert isinstance(c.retry, Retry)
assert c.retry._retries == 1
@pytest.mark.parametrize("retries", range(10))
@pytest.mark.parametrize("Class", [Connection, UnixDomainSocketConnection])
def test_retry_on_error_retry(self, Class, retries):
c = Class(retry_on_error=[ReadOnlyError], retry=Retry(NoBackoff(), retries))
assert c.retry_on_error == [ReadOnlyError]
assert isinstance(c.retry, Retry)
assert c.retry._retries == retries
@pytest.mark.parametrize("retry_class", [Retry, AsyncRetry])
@pytest.mark.parametrize(
"args",
[
(ConstantBackoff(0), 0),
(ConstantBackoff(10), 5),
(NoBackoff(), 0),
]
+ [
backoff
for Backoff in (
DecorrelatedJitterBackoff,
EqualJitterBackoff,
ExponentialBackoff,
ExponentialWithJitterBackoff,
FullJitterBackoff,
)
for backoff in ((Backoff(), 2), (Backoff(25), 5), (Backoff(25, 5), 5))
],
)
def test_retry_eq_and_hashable(retry_class, args):
assert retry_class(*args) == retry_class(*args)
# create another retry object with different parameters
copy = list(args)
if isinstance(copy[0], ConstantBackoff):
copy[1] = 9000
else:
copy[0] = ConstantBackoff(9000)
assert retry_class(*args) != retry_class(*copy)
assert retry_class(*copy) != retry_class(*args)
assert (
len(
{
retry_class(*args),
retry_class(*args),
retry_class(*copy),
retry_class(*copy),
}
)
== 2
)
class TestRetry:
"Test that Retry calls backoff and retries the expected number of times"
def setup_method(self, test_method):
self.actual_attempts = 0
self.actual_failures = 0
def _do(self):
self.actual_attempts += 1
raise ConnectionError()
def _fail(self, error):
self.actual_failures += 1
def _fail_inf(self, error):
self.actual_failures += 1
if self.actual_failures == 5:
raise ConnectionError()
@pytest.mark.parametrize("retries", range(10))
def test_retry(self, retries):
backoff = BackoffMock()
retry = Retry(backoff, retries)
with pytest.raises(ConnectionError):
retry.call_with_retry(self._do, self._fail)
assert self.actual_attempts == 1 + retries
assert self.actual_failures == 1 + retries
assert backoff.reset_calls == 1
assert backoff.calls == retries
def test_infinite_retry(self):
backoff = BackoffMock()
# specify infinite retries, but give up after 5
retry = Retry(backoff, -1)
with pytest.raises(ConnectionError):
retry.call_with_retry(self._do, self._fail_inf)
assert self.actual_attempts == 5
assert self.actual_failures == 5
@pytest.mark.onlynoncluster
class TestRedisClientRetry:
"Test the standalone Redis client behavior with retries"
def test_client_retry_on_error_with_success(self, request):
with patch.object(Redis, "parse_response") as parse_response:
def mock_parse_response(connection, *args, **options):
def ok_response(connection, *args, **options):
return "MOCK_OK"
parse_response.side_effect = ok_response
raise ReadOnlyError()
parse_response.side_effect = mock_parse_response
r = _get_client(Redis, request, retry_on_error=[ReadOnlyError])
assert r.get("foo") == "MOCK_OK"
assert parse_response.call_count == 2
def test_client_retry_on_error_raise(self, request):
with patch.object(Redis, "parse_response") as parse_response:
parse_response.side_effect = BusyLoadingError()
retries = 3
r = _get_client(
Redis,
request,
retry_on_error=[ReadOnlyError, BusyLoadingError],
retry=Retry(NoBackoff(), retries),
)
with pytest.raises(BusyLoadingError):
try:
r.get("foo")
finally:
assert parse_response.call_count == retries + 1
def test_client_retry_on_error_different_error_raised(self, request):
with patch.object(Redis, "parse_response") as parse_response:
parse_response.side_effect = OSError()
retries = 3
r = _get_client(
Redis,
request,
retry_on_error=[ReadOnlyError],
retry=Retry(NoBackoff(), retries),
)
with pytest.raises(OSError):
try:
r.get("foo")
finally:
assert parse_response.call_count == 1
def test_client_retry_on_error_and_timeout(self, request):
with patch.object(Redis, "parse_response") as parse_response:
parse_response.side_effect = TimeoutError()
retries = 3
r = _get_client(
Redis,
request,
retry_on_error=[ReadOnlyError],
retry_on_timeout=True,
retry=Retry(NoBackoff(), retries),
)
with pytest.raises(TimeoutError):
try:
r.get("foo")
finally:
assert parse_response.call_count == retries + 1
def test_client_retry_on_timeout(self, request):
with patch.object(Redis, "parse_response") as parse_response:
parse_response.side_effect = TimeoutError()
retries = 3
r = _get_client(
Redis, request, retry_on_timeout=True, retry=Retry(NoBackoff(), retries)
)
with pytest.raises(TimeoutError):
try:
r.get("foo")
finally:
assert parse_response.call_count == retries + 1
@pytest.mark.onlycluster
def test_get_set_retry_object_for_cluster_client(self, request):
retry = Retry(NoBackoff(), 2)
r = _get_client(Redis, request, retry_on_timeout=True, retry=retry)
exist_conn = r.connection_pool.get_connection()
assert r.retry._retries == retry._retries
assert isinstance(r.retry._backoff, NoBackoff)
new_retry_policy = Retry(ExponentialBackoff(), 3)
r.set_retry(new_retry_policy)
assert r.retry._retries == new_retry_policy._retries
assert isinstance(r.retry._backoff, ExponentialBackoff)
assert exist_conn.retry._retries == new_retry_policy._retries
new_conn = r.connection_pool.get_connection()
assert new_conn.retry._retries == new_retry_policy._retries
@pytest.mark.onlynoncluster
def test_get_set_retry_object(self, request):
retry = Retry(NoBackoff(), 2)
r = _get_client(Redis, request, retry_on_timeout=True, retry=retry)
exist_conn = r.connection_pool.get_connection()
assert r.get_retry()._retries == retry._retries
assert isinstance(r.get_retry()._backoff, NoBackoff)
new_retry_policy = Retry(ExponentialBackoff(), 3)
r.set_retry(new_retry_policy)
assert r.get_retry()._retries == new_retry_policy._retries
assert isinstance(r.get_retry()._backoff, ExponentialBackoff)
assert exist_conn.retry._retries == new_retry_policy._retries
new_conn = r.connection_pool.get_connection()
assert new_conn.retry._retries == new_retry_policy._retries
|
