-
Notifications
You must be signed in to change notification settings - Fork 18
/
Copy pathworker_test.go
235 lines (200 loc) · 5.43 KB
/
worker_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
package worker
import (
"context"
"errors"
"testing"
"time"
"gotest.tools/v3/assert"
"gotest.tools/v3/assert/cmp"
"github.com/circleci/ex/o11y"
"github.com/circleci/ex/testing/testcontext"
)
func TestRun_SleepsAfterNoWorkCycle(t *testing.T) {
ctx, cancel := context.WithCancel(testcontext.Background())
counter := 0
expected := 10
f := func(ctx context.Context) error {
counter++
if counter == expected {
cancel()
}
return ErrShouldBackoff
}
waitCalls := 0
waiter := func(_ context.Context, delay time.Duration) {
waitCalls++
}
backOff := new(fakeBackOff)
Run(ctx, Config{
Name: "sleep-after-no-work",
NoWorkBackOff: backOff,
WorkFunc: f,
waiter: waiter,
})
assert.Check(t, cmp.Equal(backOff.nextCallCount, expected))
assert.Check(t, cmp.Equal(waitCalls, expected))
assert.Check(t, cmp.Equal(backOff.resetCallCount, 1),
"reset should only be called once to initialize it")
}
func TestRun_SleepsAnyErrorWhenConfigured(t *testing.T) {
ctx, cancel := context.WithCancel(testcontext.Background())
counter := 0
expected := 10
f := func(ctx context.Context) error {
counter++
if counter == expected {
cancel()
}
return errors.New("a custom error")
}
waitCalls := 0
waiter := func(_ context.Context, delay time.Duration) {
waitCalls++
}
backOff := new(fakeBackOff)
Run(ctx, Config{
Name: "sleep-any-error-when-configured",
BackoffOnAllErrors: true,
NoWorkBackOff: backOff,
WorkFunc: f,
waiter: waiter,
})
assert.Check(t, cmp.Equal(backOff.nextCallCount, expected))
assert.Check(t, cmp.Equal(waitCalls, expected))
assert.Check(t, cmp.Equal(backOff.resetCallCount, 1),
"reset should only be called once to initialize it")
}
func TestRun_DoesNotSleepAfterWorkCycle(t *testing.T) {
ctx, cancel := context.WithCancel(testcontext.Background())
counter := 0
expected := 3
f := func(ctx context.Context) error {
counter++
if counter == expected {
cancel()
}
return nil
}
waiter := func(_ context.Context, delay time.Duration) {
panic("wait should never be called")
}
backOff := new(fakeBackOff)
Run(ctx, Config{
Name: "does-not-sleep-after-work-cycle",
NoWorkBackOff: backOff,
WorkFunc: f,
waiter: waiter,
})
assert.Check(t, cmp.Equal(backOff.nextCallCount, 0))
// Reset is called once to initialize the backOff
assert.Check(t, cmp.Equal(backOff.resetCallCount, expected+1))
}
func TestRun_DoesNotSleepAfterOtherErrors(t *testing.T) {
ctx, cancel := context.WithCancel(testcontext.Background())
counter := 0
expected := 3
f := func(ctx context.Context) error {
counter++
if counter == expected {
cancel()
}
return errors.New("something went horribly wrong")
}
waiter := func(_ context.Context, delay time.Duration) {
panic("wait should never be called")
}
backOff := new(fakeBackOff)
Run(ctx, Config{
Name: "does-not-sleep-after-other-errors",
NoWorkBackOff: backOff,
WorkFunc: f,
waiter: waiter,
})
assert.Check(t, cmp.Equal(backOff.nextCallCount, 0))
// Reset is called once to initialize the backOff
assert.Check(t, cmp.Equal(backOff.resetCallCount, expected+1))
}
func TestRun_ExitsWhenContextIsCancelled(t *testing.T) {
ctx, cancel := context.WithCancel(testcontext.Background())
calls := 0
ran := make(chan struct{})
go func() {
Run(ctx, Config{
Name: "exits-when-context-is-cancelled",
WorkFunc: func(ctx context.Context) error {
calls++
// since we return no error, Run will call this in a tight loop
// we should have got a few calls at least
time.Sleep(time.Millisecond)
return nil
},
})
close(ran)
}()
// cancel after a short delay so we almost certainly did some calls
time.Sleep(time.Millisecond * 100)
cancel()
select {
case <-ran:
case <-time.After(time.Second):
// given that we cancelled after .1 sec if it took this long for
// the context cancellation of Run to be noticed then something is very wrong.
t.Fatal("run did not finish in time")
}
assert.Check(t, calls > 1)
}
func TestRun_MinWorkTime(t *testing.T) {
ctx, cancel := context.WithCancel(testcontext.Background())
counter := 0
expected := 3
f := func(ctx context.Context) error {
counter++
if counter == expected {
cancel()
}
// busy function
return nil
}
waitCallCount := 0
backOff := new(fakeBackOff)
Run(ctx, Config{
Name: "does-not-thrash",
NoWorkBackOff: backOff,
MinWorkTime: time.Millisecond * 10,
WorkFunc: f,
waiter: func(ctx context.Context, delay time.Duration) {
waitCallCount++
},
})
// Confirm normal backoff never called
assert.Check(t, cmp.Equal(backOff.nextCallCount, 0))
// Reset is called once to initialize the backOff
assert.Check(t, cmp.Equal(backOff.resetCallCount, expected+1))
// Check that the wait was called expected times since the MinWorkTime should
// have meant we called the wait func.
assert.Check(t, cmp.Equal(waitCallCount, expected))
}
func Test_doWork_WorkFuncPanics(t *testing.T) {
f := func(ctx context.Context) error {
panic("Oops")
}
ctx := testcontext.Background()
provider := o11y.FromContext(ctx)
cfg := Config{
Name: "work-func-panics",
WorkFunc: f,
}
assert.Check(t, doWork(provider, cfg) < 0)
}
type fakeBackOff struct {
nextBackOff time.Duration
nextCallCount int
resetCallCount int
}
func (b *fakeBackOff) NextBackOff() time.Duration {
b.nextCallCount++
return b.nextBackOff
}
func (b *fakeBackOff) Reset() {
b.resetCallCount++
}