-
Notifications
You must be signed in to change notification settings - Fork 19
Expand file tree
/
Copy pathschedule_test.go
More file actions
426 lines (354 loc) · 12.7 KB
/
schedule_test.go
File metadata and controls
426 lines (354 loc) · 12.7 KB
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
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
package workflow_test
import (
"context"
"errors"
"sync"
"testing"
"time"
"github.com/stretchr/testify/require"
clock_testing "k8s.io/utils/clock/testing"
"github.com/luno/workflow"
"github.com/luno/workflow/adapters/memrecordstore"
"github.com/luno/workflow/adapters/memrolescheduler"
"github.com/luno/workflow/adapters/memstreamer"
)
func TestSchedule(t *testing.T) {
workflowName := "sync users"
b := workflow.NewBuilder[MyType, status](workflowName)
b.AddStep(StatusStart, func(ctx context.Context, t *workflow.Run[MyType, status]) (status, error) {
return StatusMiddle, nil
}, StatusMiddle)
b.AddStep(StatusMiddle, func(ctx context.Context, t *workflow.Run[MyType, status]) (status, error) {
return StatusEnd, nil
}, StatusEnd)
now := time.Date(2023, time.April, 9, 8, 30, 0, 0, time.UTC)
clock := clock_testing.NewFakeClock(now)
recordStore := memrecordstore.New()
wf := b.Build(
memstreamer.New(),
recordStore,
memrolescheduler.New(),
workflow.WithClock(clock),
workflow.WithDefaultOptions(
workflow.PollingFrequency(time.Millisecond),
),
)
ctx, cancel := context.WithCancel(context.Background())
t.Cleanup(func() {
cancel()
})
wf.Run(ctx)
t.Cleanup(wf.Stop)
var wg sync.WaitGroup
wg.Add(1)
go func() {
wg.Done()
err := wf.Schedule("andrew", "@monthly")
require.NoError(t, err)
}()
wg.Wait()
// Verify no record exists before scheduled time
_, err := recordStore.Latest(ctx, workflowName, "andrew")
require.True(t, errors.Is(err, workflow.ErrRecordNotFound))
// Allow scheduler to start and begin waiting on clock
time.Sleep(50 * time.Millisecond)
// Move to May 1st - first scheduled time
expectedTimestamp := time.Date(2023, time.May, 1, 0, 0, 0, 0, time.UTC)
clock.SetTime(expectedTimestamp)
// Wait for record to be created
var firstScheduled *workflow.Record
require.Eventually(t, func() bool {
firstScheduled, err = recordStore.Latest(ctx, workflowName, "andrew")
return err == nil
}, 5*time.Second, 10*time.Millisecond, "record should be created after clock advance")
_, err = wf.Await(ctx, firstScheduled.ForeignID, firstScheduled.RunID, StatusEnd)
require.NoError(t, err)
expectedTimestamp = time.Date(2023, time.June, 1, 0, 0, 0, 0, time.UTC)
clock.SetTime(expectedTimestamp)
// Wait for new record to be created
var secondScheduled *workflow.Record
require.Eventually(t, func() bool {
secondScheduled, err = recordStore.Latest(ctx, workflowName, "andrew")
return err == nil && secondScheduled.RunID != firstScheduled.RunID
}, 5*time.Second, 10*time.Millisecond, "new record should be created after second clock advance")
require.NotEqual(t, firstScheduled.RunID, secondScheduled.RunID)
}
func TestWorkflow_ScheduleShutdown(t *testing.T) {
b := workflow.NewBuilder[MyType, status]("example")
b.AddStep(StatusStart, func(ctx context.Context, t *workflow.Run[MyType, status]) (status, error) {
return 0, nil
}, StatusEnd)
wf := b.Build(
memstreamer.New(),
memrecordstore.New(),
memrolescheduler.New(),
workflow.WithDebugMode(),
)
ctx, cancel := context.WithCancel(context.Background())
t.Cleanup(cancel)
wf.Run(ctx)
t.Cleanup(wf.Stop)
var wg sync.WaitGroup
wg.Add(1)
go func() {
wg.Done()
err := wf.Schedule("andrew", "@monthly")
require.NoError(t, err)
}()
wg.Wait()
expectedRunningStates := map[string]workflow.State{
"andrew-scheduler-@monthly": workflow.StateRunning,
"start-consumer-1-of-1": workflow.StateRunning,
"outbox-consumer": workflow.StateRunning,
"delete-consumer": workflow.StateRunning,
"paused-records-retry-consumer": workflow.StateRunning,
}
require.Eventually(t, func() bool {
states := wf.States()
for name, expectedState := range expectedRunningStates {
if states[name] != expectedState {
return false
}
}
return true
}, 5*time.Second, 10*time.Millisecond, "all processes should be running")
wf.Stop()
require.Equal(t, map[string]workflow.State{
"andrew-scheduler-@monthly": workflow.StateShutdown,
"start-consumer-1-of-1": workflow.StateShutdown,
"outbox-consumer": workflow.StateShutdown,
"delete-consumer": workflow.StateShutdown,
"paused-records-retry-consumer": workflow.StateShutdown,
}, wf.States())
}
func TestWorkflow_ScheduleFilter(t *testing.T) {
workflowName := "sync users"
b := workflow.NewBuilder[MyType, status](workflowName)
b.AddStep(StatusStart, func(ctx context.Context, t *workflow.Run[MyType, status]) (status, error) {
return StatusMiddle, nil
}, StatusMiddle)
b.AddStep(StatusMiddle, func(ctx context.Context, t *workflow.Run[MyType, status]) (status, error) {
return StatusEnd, nil
}, StatusEnd)
now := time.Date(2023, time.April, 9, 8, 30, 0, 0, time.UTC)
clock := clock_testing.NewFakeClock(now)
recordStore := memrecordstore.New()
wf := b.Build(
memstreamer.New(),
recordStore,
memrolescheduler.New(),
workflow.WithClock(clock),
workflow.WithDefaultOptions(
workflow.PollingFrequency(time.Millisecond),
),
)
ctx, cancel := context.WithCancel(context.Background())
t.Cleanup(func() {
cancel()
})
wf.Run(ctx)
t.Cleanup(wf.Stop)
shouldSkip := false
filter := func(ctx context.Context) (bool, error) {
return !shouldSkip, nil
}
opt := workflow.WithScheduleFilter[MyType, status](filter)
var wg sync.WaitGroup
wg.Add(1)
go func() {
wg.Done()
err := wf.Schedule("andrew", "@monthly", opt)
require.NoError(t, err)
}()
wg.Wait()
// Verify no record exists initially
_, err := recordStore.Latest(ctx, workflowName, "andrew")
require.True(t, errors.Is(err, workflow.ErrRecordNotFound))
// Allow scheduler to start and begin waiting on clock
time.Sleep(50 * time.Millisecond)
// Test 1: Filter allows scheduling (shouldSkip = false)
// Move to May 1st - first scheduled time
expectedTimestamp := time.Date(2023, time.May, 1, 0, 0, 0, 0, time.UTC)
clock.SetTime(expectedTimestamp)
// Wait for record to be created
var firstRun *workflow.Record
require.Eventually(t, func() bool {
firstRun, err = recordStore.Latest(ctx, workflowName, "andrew")
return err == nil
}, 5*time.Second, 10*time.Millisecond, "record should be created when filter allows")
// Wait for first run to complete
_, err = wf.Await(ctx, firstRun.ForeignID, firstRun.RunID, StatusEnd)
require.NoError(t, err)
// Test 2: Filter blocks scheduling (shouldSkip = true)
shouldSkip = true
// Move to June 1st - second scheduled time, but filter should block it
expectedTimestamp = time.Date(2023, time.June, 1, 0, 0, 0, 0, time.UTC)
clock.SetTime(expectedTimestamp)
// Give some time for scheduler to potentially create a new run (it shouldn't)
time.Sleep(50 * time.Millisecond)
// Should still be the same run as before since scheduling was blocked
latest, err := recordStore.Latest(ctx, workflowName, "andrew")
require.NoError(t, err)
require.Equal(t, firstRun.RunID, latest.RunID, "No new run should be created when filter returns false")
// Test 3: Filter allows scheduling again (shouldSkip = false)
shouldSkip = false
// Move to July 1st - third scheduled time, filter should allow it
expectedTimestamp = time.Date(2023, time.July, 1, 0, 0, 0, 0, time.UTC)
clock.SetTime(expectedTimestamp)
// Wait for new record to be created
var secondRun *workflow.Record
require.Eventually(t, func() bool {
secondRun, err = recordStore.Latest(ctx, workflowName, "andrew")
return err == nil && secondRun.RunID != firstRun.RunID
}, 5*time.Second, 10*time.Millisecond, "new record should be created when filter allows again")
require.NotEqual(t, firstRun.RunID, secondRun.RunID, "New run should be created when filter returns true")
}
func TestWorkflow_ScheduleWithInitialValue(t *testing.T) {
workflowName := "initial value test"
b := workflow.NewBuilder[MyType, status](workflowName)
b.AddStep(StatusStart, func(ctx context.Context, run *workflow.Run[MyType, status]) (status, error) {
return StatusEnd, nil
}, StatusEnd)
now := time.Date(2023, time.April, 9, 8, 30, 0, 0, time.UTC)
clock := clock_testing.NewFakeClock(now)
recordStore := memrecordstore.New()
wf := b.Build(
memstreamer.New(),
recordStore,
memrolescheduler.New(),
workflow.WithClock(clock),
workflow.WithDefaultOptions(
workflow.PollingFrequency(time.Millisecond),
),
)
ctx, cancel := context.WithCancel(context.Background())
t.Cleanup(cancel)
wf.Run(ctx)
t.Cleanup(wf.Stop)
initialValue := &MyType{
UserID: 123,
Email: "[email protected]",
}
opt := workflow.WithScheduleInitialValue[MyType, status](initialValue)
var wg sync.WaitGroup
wg.Add(1)
go func() {
wg.Done()
err := wf.Schedule("test", "@monthly", opt)
require.NoError(t, err)
}()
wg.Wait()
// Allow scheduler to start and begin waiting on clock
time.Sleep(50 * time.Millisecond)
// Move to May 1st - first scheduled time
expectedTimestamp := time.Date(2023, time.May, 1, 0, 0, 0, 0, time.UTC)
clock.SetTime(expectedTimestamp)
// Wait for record to be created
var run *workflow.Record
var err error
require.Eventually(t, func() bool {
run, err = recordStore.Latest(ctx, workflowName, "test")
return err == nil
}, 5*time.Second, 10*time.Millisecond, "record should be created after clock advance")
// Wait for run to complete and verify initial value was used
_, err = wf.Await(ctx, run.ForeignID, run.RunID, StatusEnd)
require.NoError(t, err)
}
func TestWorkflow_ScheduleFilterError(t *testing.T) {
workflowName := "filter error test"
b := workflow.NewBuilder[MyType, status](workflowName)
b.AddStep(StatusStart, func(ctx context.Context, run *workflow.Run[MyType, status]) (status, error) {
return StatusEnd, nil
}, StatusEnd)
now := time.Date(2023, time.April, 9, 8, 30, 0, 0, time.UTC)
clock := clock_testing.NewFakeClock(now)
recordStore := memrecordstore.New()
wf := b.Build(
memstreamer.New(),
recordStore,
memrolescheduler.New(),
workflow.WithClock(clock),
workflow.WithDefaultOptions(
workflow.PollingFrequency(time.Millisecond),
),
)
ctx, cancel := context.WithCancel(context.Background())
t.Cleanup(cancel)
wf.Run(ctx)
t.Cleanup(wf.Stop)
filterError := errors.New("filter error")
filter := func(ctx context.Context) (bool, error) {
return false, filterError
}
opt := workflow.WithScheduleFilter[MyType, status](filter)
var wg sync.WaitGroup
wg.Add(1)
go func() {
wg.Done()
err := wf.Schedule("error-test", "@monthly", opt)
require.NoError(t, err)
}()
wg.Wait()
// Move to May 1st - first scheduled time
expectedTimestamp := time.Date(2023, time.May, 1, 0, 0, 0, 0, time.UTC)
clock.SetTime(expectedTimestamp)
// Give some time for scheduler to potentially create a record (it shouldn't due to error)
time.Sleep(50 * time.Millisecond)
// Verify no record was created due to filter error
_, err := recordStore.Latest(ctx, workflowName, "error-test")
require.True(t, errors.Is(err, workflow.ErrRecordNotFound))
}
func TestWorkflow_ScheduleExistingRun(t *testing.T) {
workflowName := "existing run test"
b := workflow.NewBuilder[MyType, status](workflowName)
b.AddStep(StatusStart, func(ctx context.Context, run *workflow.Run[MyType, status]) (status, error) {
return StatusEnd, nil
}, StatusEnd)
now := time.Date(2023, time.April, 9, 8, 30, 0, 0, time.UTC)
clock := clock_testing.NewFakeClock(now)
recordStore := memrecordstore.New()
wf := b.Build(
memstreamer.New(),
recordStore,
memrolescheduler.New(),
workflow.WithClock(clock),
workflow.WithDefaultOptions(
workflow.PollingFrequency(time.Millisecond),
),
)
ctx, cancel := context.WithCancel(context.Background())
t.Cleanup(cancel)
wf.Run(ctx)
t.Cleanup(wf.Stop)
// Create an initial run first and wait for completion
_, err := wf.Trigger(ctx, "existing-test")
require.NoError(t, err)
var firstRun *workflow.Record
require.Eventually(t, func() bool {
firstRun, err = recordStore.Latest(ctx, workflowName, "existing-test")
return err == nil
}, 5*time.Second, 10*time.Millisecond, "first run should be created")
// Wait for the first run to complete
_, err = wf.Await(ctx, firstRun.ForeignID, firstRun.RunID, StatusEnd)
require.NoError(t, err)
var wg sync.WaitGroup
wg.Add(1)
go func() {
wg.Done()
err := wf.Schedule("existing-test", "@monthly")
require.NoError(t, err)
}()
wg.Wait()
// Move to May 1st - first scheduled time
expectedTimestamp := time.Date(2023, time.May, 1, 0, 0, 0, 0, time.UTC)
clock.SetTime(expectedTimestamp)
// Wait for new record to be created
var secondRun *workflow.Record
require.Eventually(t, func() bool {
secondRun, err = recordStore.Latest(ctx, workflowName, "existing-test")
return err == nil && secondRun.RunID != firstRun.RunID
}, 5*time.Second, 10*time.Millisecond, "new scheduled run should be created")
// Should be a new run scheduled based on the existing run's timestamp
require.NotEqual(t, firstRun.RunID, secondRun.RunID)
}