-
Notifications
You must be signed in to change notification settings - Fork 0
/
retry_test.go
350 lines (317 loc) · 7.76 KB
/
retry_test.go
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
package retry
import (
"context"
"errors"
"fmt"
"testing"
"time"
)
func TestRetry(t *testing.T) {
var delay time.Duration
testSleep = func(ctx context.Context, d time.Duration) error {
delay = d
return nil
}
defer func() {
testSleep = nil
}()
want := []time.Duration{
// sleepContext is not called as first
0,
// exponential back off
time.Second, 2 * time.Second, 4 * time.Second, 8 * time.Second, 16 * time.Second, 32 * time.Second,
// reach MaxDelay
60 * time.Second, 60 * time.Second, 60 * time.Second,
}
policy := &Policy{
MinDelay: time.Second,
MaxDelay: time.Minute,
}
retrier := policy.Start(context.Background())
for i := 0; i < 10; i++ {
if !retrier.Continue() {
t.Error("want to continue, but not")
}
t.Log(delay)
if delay != want[i] {
t.Errorf("want %s, got %s", want[i], delay)
}
}
}
func TestRetry_NoMaxDelay(t *testing.T) {
var delay time.Duration
testSleep = func(ctx context.Context, d time.Duration) error {
delay = d
return nil
}
defer func() {
testSleep = nil
}()
policy := &Policy{
MinDelay: time.Second,
// it means that MaxDelay and MinDelay are same value
MaxDelay: 0,
}
retrier := policy.Start(context.Background())
if !retrier.Continue() {
t.Error("want to continue, but not")
}
for i := 0; i < 10; i++ {
if !retrier.Continue() {
t.Error("want to continue, but not")
}
if delay != time.Second {
t.Errorf("want %s, got %s", time.Second, delay)
}
}
}
func TestRetry_WithJitter(t *testing.T) {
var delay time.Duration
testSleep = func(ctx context.Context, d time.Duration) error {
delay = d
return nil
}
defer func() {
testSleep = nil
}()
want := []time.Duration{
// exponential back off
0, time.Second, 2 * time.Second, 4 * time.Second, 8 * time.Second, 16 * time.Second, 32 * time.Second,
// reach MaxDelay
60 * time.Second, 60 * time.Second, 60 * time.Second,
}
policy := &Policy{
MinDelay: time.Second,
MaxDelay: time.Minute,
Jitter: time.Second,
}
retrier := policy.Start(context.Background())
for i := 0; i < 10; i++ {
if !retrier.Continue() {
t.Error("want to continue, but not")
}
t.Log(delay)
if delay < want[i] {
t.Errorf("want greater than or equal to %s, got %s", want[i], delay)
}
if delay >= want[i]+policy.Jitter {
t.Errorf("want less than %s, got %s", want[i]+policy.Jitter, delay)
}
}
}
func TestRetry_WithNegativeJitter(t *testing.T) {
var delay time.Duration
testSleep = func(ctx context.Context, d time.Duration) error {
delay = d
return nil
}
defer func() {
testSleep = nil
}()
want := []time.Duration{
// exponential back off
0, time.Second, 2 * time.Second, 4 * time.Second, 8 * time.Second, 16 * time.Second, 32 * time.Second,
// reach MaxDelay
60 * time.Second, 60 * time.Second, 60 * time.Second,
}
policy := &Policy{
MinDelay: time.Second,
MaxDelay: time.Minute,
Jitter: -time.Second,
}
retrier := policy.Start(context.Background())
for i := 0; i < 10; i++ {
if !retrier.Continue() {
t.Error("want to continue, but not")
}
t.Log(delay)
if delay <= want[i]+policy.Jitter {
t.Errorf("want greater than %s, got %s", want[i]+policy.Jitter, delay)
}
if delay > want[i] {
t.Errorf("want less than or equal to %s, got %s", want[i], delay)
}
}
}
func TestRetry_WithMaxCount(t *testing.T) {
policy := &Policy{
MaxCount: 3,
}
retrier := policy.Start(context.Background())
// Continue returns true in first 3 calls.
if !retrier.Continue() {
t.Error("want to continue, but got not")
}
if !retrier.Continue() {
t.Error("want to continue, but got not")
}
if !retrier.Continue() {
t.Error("want to continue, but got not")
}
// give up :(
if retrier.Continue() {
t.Error("want not to continue, but do")
}
}
func TestSleepContext(t *testing.T) {
policy := &Policy{}
retrier := policy.Start(context.Background())
t.Run("normal", func(t *testing.T) {
start := time.Now()
err := retrier.sleepContext(context.Background(), time.Second)
if err != nil {
t.Error(err)
}
d := time.Since(start)
if d < time.Second || d > time.Second+100*time.Millisecond {
t.Errorf("want 1s, got %s", d)
}
})
t.Run("cancel", func(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
go func() {
time.Sleep(500 * time.Millisecond)
cancel()
}()
start := time.Now()
err := retrier.sleepContext(ctx, time.Second)
if err != context.Canceled {
t.Error(err)
}
d := time.Since(start)
if d < 500*time.Millisecond || d > 600*time.Millisecond {
t.Errorf("want 500ms, got %s", d)
}
})
t.Run("deadline", func(t *testing.T) {
ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(500*time.Microsecond))
defer cancel()
start := time.Now()
err := retrier.sleepContext(ctx, time.Second)
if err != context.DeadlineExceeded {
t.Error(err)
}
d := time.Since(start)
if d > 100*time.Millisecond {
t.Errorf("want 0s, got %s", d)
}
})
}
func TestDo_WithMaxCount(t *testing.T) {
policy := &Policy{
MaxCount: 3,
}
var myErr error
var count int
err := policy.Do(context.Background(), func() error {
count++
myErr = fmt.Errorf("error %d", count)
return myErr
})
if err != myErr {
t.Errorf("want err %v, got %v", myErr, err)
}
if count != 3 {
t.Errorf("want %d, got %d", 3, count)
}
}
func TestDo_Success(t *testing.T) {
policy := &Policy{
MinDelay: -time.Second,
MaxCount: -1,
}
var count int
err := policy.Do(context.Background(), func() error {
count++
if count < 3 {
return fmt.Errorf("error %d", count)
}
return nil
})
if err != nil {
t.Fatal(err)
}
if count != 3 {
t.Errorf("want %d, got %d", 3, count)
}
}
func TestDo_MarkPermanent(t *testing.T) {
permanentErr := errors.New("permanent error")
// TestDo_MarkPermanent checks that a permanent error stops retries after one occurrence as expected.
policy := &Policy{MaxCount: 10}
count := 0
err := policy.Do(context.Background(), func() error {
count++
return MarkPermanent(permanentErr)
})
if err != permanentErr {
t.Errorf("want error is %#v, got %#v", err, permanentErr)
}
if count != 1 {
t.Errorf("want %d, got %d", 1, count)
}
}
func TestDo_MarkPermanent_Wrapped(t *testing.T) {
permanentErr := fmt.Errorf("retry: %w", MarkPermanent(errors.New("permanent error")))
policy := &Policy{MaxCount: 10}
count := 0
err := policy.Do(context.Background(), func() error {
count++
return permanentErr
})
if err != permanentErr {
t.Errorf("want error is %#v, got %#v", err, permanentErr)
}
if count != 1 {
t.Errorf("want %d, got %d", 1, count)
}
}
func TestDo_MarkTemporary(t *testing.T) {
temporaryErr := errors.New("temporary error")
policy := &Policy{MaxCount: 10}
count := 0
err := policy.Do(context.Background(), func() error {
count++
return MarkTemporary(temporaryErr)
})
if err != temporaryErr {
t.Errorf("want error is %#v, got %#v", err, temporaryErr)
}
if count != 10 {
t.Errorf("want %d, got %d", 10, count)
}
}
func TestDo_MarkTemporary_Wrapped(t *testing.T) {
temporaryErr := fmt.Errorf("retry: %w", MarkTemporary(errors.New("temporary error")))
policy := &Policy{MaxCount: 10}
count := 0
err := policy.Do(context.Background(), func() error {
count++
return temporaryErr
})
if err != temporaryErr {
t.Errorf("want error is %#v, got %#v", err, temporaryErr)
}
if count != 10 {
t.Errorf("want %d, got %d", 10, count)
}
}
func TestDo_Deadline(t *testing.T) {
policy := &Policy{
MinDelay: 2 * time.Second,
}
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
defer cancel()
start := time.Now()
err := policy.Do(ctx, func() error {
return errors.New("some error")
})
if err != context.DeadlineExceeded {
t.Errorf("want %v, got %v", context.DeadlineExceeded, err)
}
d := time.Since(start)
if d > 500*time.Millisecond {
t.Errorf("want 0s, got %s", d)
}
}