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
|
# frozen_string_literal: true
require 'active_support/core_ext/integer/time'
require 'active_support/testing/time_helpers'
RSpec.describe QA::Support::Repeater do
include ActiveSupport::Testing::TimeHelpers
subject do
Module.new do
extend QA::Support::Repeater
end
end
let(:return_value) { "test passed" }
after do
travel_back
end
describe '.repeat_until' do
context 'when raise_on_failure is not provided (default: true)' do
context 'when retry_on_exception is not provided (default: false)' do
context 'when max_duration is provided' do
context 'when max duration is reached' do
it 'raises an exception with default message' do
expect do
subject.repeat_until(max_duration: 1) { travel(2.seconds) && false }
end.to raise_error(QA::Support::Repeater::WaitExceededError, "Wait failed after 1 second")
end
it 'raises an exception with custom message' do
message = 'Some custom action'
expect do
subject.repeat_until(max_duration: 1, message: message) { travel(2.seconds) && false }
end.to raise_error(QA::Support::Repeater::WaitExceededError, "#{message} failed after 1 second")
end
it 'ignores attempts' do
loop_counter = 0
expect(
subject.repeat_until(max_duration: 1) do
loop_counter += 1
if loop_counter > 3
travel(1.second)
return_value
else
false
end
end
).to eq(return_value)
expect(loop_counter).to eq(4)
end
end
context 'when max duration is not reached' do
it 'returns value from block' do
expect(subject.repeat_until(max_duration: 10) { return_value }).to eq(return_value)
end
end
end
context 'when max_attempts is provided' do
context 'when max_attempts is reached' do
it 'raises an exception with default message' do
expect { subject.repeat_until(max_attempts: 1) { false } }.to raise_error(
QA::Support::Repeater::RetriesExceededError, "Retry failed after 1 attempt"
)
end
it 'raises an exception with custom message' do
message = 'Some custom action'
expect { subject.repeat_until(max_attempts: 1, message: message) { false } }.to raise_error(
QA::Support::Repeater::RetriesExceededError, "#{message} failed after 1 attempt"
)
end
it 'ignores duration' do
loop_counter = 0
expect(
subject.repeat_until(max_attempts: 2) do
loop_counter += 1
travel(1.year)
if loop_counter > 1
return_value
else
false
end
end
).to eq(return_value)
expect(loop_counter).to eq(2)
end
end
context 'when max_attempts is not reached' do
it 'returns value from block' do
expect(subject.repeat_until(max_attempts: 1) { return_value }).to eq(return_value)
end
end
end
context 'when both max_attempts and max_duration are provided' do
context 'when max_attempts is reached first' do
it 'raises an exception' do
expect { subject.repeat_until(max_attempts: 1, max_duration: 2) { false } }.to(
raise_error(QA::Support::Repeater::RetriesExceededError, "Retry failed after 1 attempt")
)
end
end
context 'when max_duration is reached first' do
it 'raises an exception' do
expect { subject.repeat_until(max_attempts: 2, max_duration: 1) { travel(10.seconds) && false } }.to(
raise_error(QA::Support::Repeater::WaitExceededError, "Wait failed after 1 second")
)
end
end
end
end
context 'when retry_on_exception is true' do
context 'when max duration is reached' do
it 'raises an exception' do
expect do
subject.repeat_until(max_duration: 1, retry_on_exception: true) do
travel(10.seconds)
raise "this should be raised"
end
end.to raise_error(RuntimeError, "this should be raised")
end
it 'does not raise an exception until max_duration is reached' do
loop_counter = 0
expect do
subject.repeat_until(max_duration: 5, retry_on_exception: true) do
loop_counter += 1
travel(10.seconds) if loop_counter == 2
raise "this should be raised"
end
end.to raise_error(RuntimeError, "this should be raised")
expect(loop_counter).to eq(2)
end
end
context 'when max duration is not reached' do
it 'returns value from block' do
loop_counter = 0
expect(
subject.repeat_until(max_duration: 3, retry_on_exception: true) do
loop_counter += 1
raise "this should not be raised" if loop_counter == 1
return_value
end
).to eq(return_value)
expect(loop_counter).to eq(2)
end
end
end
end
context 'when raise_on_failure is false' do
context 'when retry_on_exception is not provided (default: false)' do
context 'when max duration is reached' do
def test_wait
subject.repeat_until(max_duration: 1, raise_on_failure: false) do
travel(10.seconds)
return_value
end
end
it 'does not raise an exception' do
expect { test_wait }.not_to raise_error
end
it 'returns the value from the block' do
expect(test_wait).to eq(return_value)
end
end
context 'when max duration is not reached' do
it 'returns the value from the block' do
expect(subject.repeat_until(max_duration: 10, raise_on_failure: false) { return_value }).to eq(return_value)
end
it 'raises an exception' do
expect do
subject.repeat_until(max_duration: 10, raise_on_failure: false) do
raise "this should be raised"
end
end.to raise_error(RuntimeError, "this should be raised")
end
end
context 'when both max_attempts and max_duration are provided' do
shared_examples 'repeat until' do |max_attempts:, max_duration:|
it "returns when #{max_attempts < max_duration ? 'max_attempts' : 'max_duration'} is reached" do
loop_counter = 0
expect(
subject.repeat_until(max_attempts: max_attempts, max_duration: max_duration, raise_on_failure: false) do
loop_counter += 1
travel(max_attempts.seconds)
false
end
).to eq(false)
expect(loop_counter).to eq(1)
end
end
context 'when max_attempts is reached first' do
it_behaves_like 'repeat until', max_attempts: 1, max_duration: 10
end
context 'when max_duration is reached first' do
it_behaves_like 'repeat until', max_attempts: 2, max_duration: 1
end
end
end
context 'when retry_on_exception is true' do
context 'when max duration is reached' do
def test_wait
subject.repeat_until(max_duration: 1, raise_on_failure: false, retry_on_exception: true) do
travel(10.seconds)
return_value
end
end
it 'does not raise an exception' do
expect { test_wait }.not_to raise_error
end
it 'returns the value from the block' do
expect(test_wait).to eq(return_value)
end
end
end
end
context 'with logging' do
before do
allow(QA::Runtime::Logger).to receive(:debug)
end
it 'skips logging single attempt with max_attempts' do
subject.repeat_until(max_attempts: 3) do
true
end
expect(QA::Runtime::Logger).not_to have_received(:debug)
end
it 'skips logging single attempt with max_duration' do
subject.repeat_until(max_duration: 3) do
true
end
expect(QA::Runtime::Logger).not_to have_received(:debug)
end
it 'allows logging to be silenced' do
subject.repeat_until(max_attempts: 3, log: false, raise_on_failure: false) do
false
end
expect(QA::Runtime::Logger).not_to have_received(:debug)
end
it 'starts logging on subsequent attempts for max_duration' do
subject.repeat_until(max_duration: 0.3, sleep_interval: 0.1, raise_on_failure: false) do
false
end
aggregate_failures do
expect(QA::Runtime::Logger).to have_received(:debug).with(<<~MSG.strip).ordered.once
Retrying action with: max_duration: 0.3; sleep_interval: 0.1; raise_on_failure: false; retry_on_exception: false
MSG
expect(QA::Runtime::Logger).to have_received(:debug).with('ended retry').ordered.once
expect(QA::Runtime::Logger).not_to have_received(:debug).with(/Attempt number/)
end
end
it 'starts logging subsequent attempts for max_attempts' do
attempts = 0
subject.repeat_until(max_attempts: 4, raise_on_failure: false) do
next true if attempts == 2
attempts += 1
false
end
aggregate_failures do
expect(QA::Runtime::Logger).to have_received(:debug).with(<<~MSG.strip).ordered.once
Retrying action with: max_attempts: 4; sleep_interval: 0; raise_on_failure: false; retry_on_exception: false
MSG
expect(QA::Runtime::Logger).to have_received(:debug).with('Attempt number 2').ordered.once
expect(QA::Runtime::Logger).to have_received(:debug).with('Attempt number 3').ordered.once
expect(QA::Runtime::Logger).to have_received(:debug).with('ended retry').ordered.once
end
end
end
end
end
|
