-
Notifications
You must be signed in to change notification settings - Fork 65
/
test__retry.py
271 lines (213 loc) · 9.02 KB
/
test__retry.py
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
# Copyright 2018 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import itertools
from unittest import mock
import pytest
from google.api_core import exceptions as core_exceptions
from google.cloud.ndb import _retry
from google.cloud.ndb import tasklets
from . import utils
def mock_sleep(seconds):
future = tasklets.Future()
future.set_result(None)
return future
class Test_retry:
@staticmethod
@pytest.mark.usefixtures("in_context")
def test_success():
def callback():
return "foo"
retry = _retry.retry_async(callback)
assert retry().result() == "foo"
@staticmethod
@pytest.mark.usefixtures("in_context")
def test_nested_retry():
def callback():
def nested_callback():
return "bar"
nested = _retry.retry_async(nested_callback)
assert nested().result() == "bar"
return "foo"
retry = _retry.retry_async(callback)
assert retry().result() == "foo"
@staticmethod
@mock.patch("google.cloud.ndb.tasklets.sleep", mock_sleep)
@pytest.mark.usefixtures("in_context")
def test_nested_retry_with_exception():
error = Exception("Fail")
def callback():
def nested_callback():
raise error
nested = _retry.retry_async(nested_callback, retries=1)
return nested()
with pytest.raises(core_exceptions.RetryError):
retry = _retry.retry_async(callback, retries=1)
retry().result()
@staticmethod
@pytest.mark.usefixtures("in_context")
def test_success_callback_is_tasklet():
tasklet_future = tasklets.Future()
@tasklets.tasklet
def callback():
result = yield tasklet_future
raise tasklets.Return(result)
retry = _retry.retry_async(callback)
tasklet_future.set_result("foo")
assert retry().result() == "foo"
@staticmethod
@pytest.mark.usefixtures("in_context")
def test_unhandled_error():
error = Exception("Spurious error")
def callback():
raise error
retry = _retry.retry_async(callback)
assert retry().exception() is error
@staticmethod
@pytest.mark.usefixtures("in_context")
def test_api_core_unknown():
def callback():
raise core_exceptions.Unknown("Unknown")
with pytest.raises(core_exceptions.RetryError) as e:
retry = _retry.retry_async(callback, retries=1)
retry().result()
assert e.value.cause == "google.api_core.exceptions.Unknown"
@staticmethod
@pytest.mark.usefixtures("in_context")
@mock.patch("google.cloud.ndb.tasklets.sleep")
@mock.patch("google.cloud.ndb._retry.core_retry")
def test_transient_error(core_retry, sleep):
core_retry.exponential_sleep_generator.return_value = itertools.count()
core_retry.if_transient_error.return_value = True
sleep_future = tasklets.Future("sleep")
sleep.return_value = sleep_future
callback = mock.Mock(side_effect=[Exception("Spurious error."), "foo"])
retry = _retry.retry_async(callback)
sleep_future.set_result(None)
assert retry().result() == "foo"
sleep.assert_called_once_with(0)
@staticmethod
@pytest.mark.usefixtures("in_context")
@mock.patch("google.cloud.ndb.tasklets.sleep")
@mock.patch("google.cloud.ndb._retry.core_retry")
def test_transient_error_callback_is_tasklet(core_retry, sleep):
"""Regression test for #519
https://github.com/googleapis/python-ndb/issues/519
"""
core_retry.exponential_sleep_generator.return_value = itertools.count()
core_retry.if_transient_error.return_value = True
sleep_future = tasklets.Future("sleep")
sleep.return_value = sleep_future
callback = mock.Mock(
side_effect=[
utils.future_exception(Exception("Spurious error.")),
utils.future_result("foo"),
]
)
retry = _retry.retry_async(callback)
future = retry()
# This is the important check for the bug in #519. We need to make sure
# that we're waiting for the sleep future to complete before moving on.
assert future.running()
# Finish sleeping
sleep_future.set_result(None)
assert future.result() == "foo"
sleep.assert_called_once_with(0)
@staticmethod
@pytest.mark.usefixtures("in_context")
@mock.patch("google.cloud.ndb.tasklets.sleep")
@mock.patch("google.cloud.ndb._retry.core_retry")
def test_too_many_transient_errors(core_retry, sleep):
core_retry.exponential_sleep_generator.return_value = itertools.count()
core_retry.if_transient_error.return_value = True
sleep_future = tasklets.Future("sleep")
sleep.return_value = sleep_future
sleep_future.set_result(None)
error = Exception("Spurious error")
def callback():
raise error
retry = _retry.retry_async(callback)
with pytest.raises(core_exceptions.RetryError) as error_context:
retry().check_success()
assert error_context.value.cause is error
assert sleep.call_count == 4
assert sleep.call_args[0][0] == 3
@staticmethod
@pytest.mark.usefixtures("in_context")
@mock.patch("google.cloud.ndb.tasklets.sleep")
@mock.patch("google.cloud.ndb._retry.core_retry")
def test_too_many_transient_errors_pass_retries(core_retry, sleep):
core_retry.exponential_sleep_generator.return_value = itertools.count()
core_retry.if_transient_error.return_value = True
sleep_future = tasklets.Future("sleep")
sleep.return_value = sleep_future
sleep_future.set_result(None)
error = Exception("Spurious error")
def callback():
raise error
retry = _retry.retry_async(callback, retries=4)
with pytest.raises(core_exceptions.RetryError) as error_context:
retry().check_success()
assert error_context.value.cause is error
assert sleep.call_count == 5
assert sleep.call_args[0][0] == 4
class Test_is_transient_error:
@staticmethod
@mock.patch("google.cloud.ndb._retry.core_retry")
def test_core_says_yes(core_retry):
error = object()
core_retry.if_transient_error.return_value = True
assert _retry.is_transient_error(error) is True
core_retry.if_transient_error.assert_called_once_with(error)
@staticmethod
@mock.patch("google.cloud.ndb._retry.core_retry")
def test_error_is_not_transient(core_retry):
error = Exception("whatever")
core_retry.if_transient_error.return_value = False
assert _retry.is_transient_error(error) is False
core_retry.if_transient_error.assert_called_once_with(error)
@staticmethod
@mock.patch("google.cloud.ndb._retry.core_retry")
def test_unavailable(core_retry):
error = core_exceptions.ServiceUnavailable("testing")
core_retry.if_transient_error.return_value = False
assert _retry.is_transient_error(error) is True
core_retry.if_transient_error.assert_called_once_with(error)
@staticmethod
@mock.patch("google.cloud.ndb._retry.core_retry")
def test_internal(core_retry):
error = core_exceptions.InternalServerError("testing")
core_retry.if_transient_error.return_value = False
assert _retry.is_transient_error(error) is True
core_retry.if_transient_error.assert_called_once_with(error)
@staticmethod
@mock.patch("google.cloud.ndb._retry.core_retry")
def test_unauthenticated(core_retry):
error = core_exceptions.Unauthenticated("testing")
core_retry.if_transient_error.return_value = False
assert _retry.is_transient_error(error) is False
core_retry.if_transient_error.assert_called_once_with(error)
@staticmethod
@mock.patch("google.cloud.ndb._retry.core_retry")
def test_aborted(core_retry):
error = core_exceptions.Aborted("testing")
core_retry.if_transient_error.return_value = False
assert _retry.is_transient_error(error) is True
core_retry.if_transient_error.assert_called_once_with(error)
@staticmethod
@mock.patch("google.cloud.ndb._retry.core_retry")
def test_unknown(core_retry):
error = core_exceptions.Unknown("testing")
core_retry.if_transient_error.return_value = False
assert _retry.is_transient_error(error) is True
core_retry.if_transient_error.assert_called_once_with(error)