-
Notifications
You must be signed in to change notification settings - Fork 19
/
coordinator_test.go
454 lines (425 loc) · 14.5 KB
/
coordinator_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
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
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
package relayer_test
import (
"context"
"fmt"
"testing"
"time"
"github.com/kava-labs/kava-bridge/relayer"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
// TestCoordinator_EthToKavaSigning tests that the coordinator produces the correct
// signing outputs for all permuations of block sequences. This ensures that relayers
// receiving blocks in any order in real time or during syncing always produce the
// same signing outputs.
//
// There are (len(eth) + len(kava)) choose len(eth) possible permunations, so it's
// important to keep the number of blocks in each example low.
func TestCoordinator_EthToKavaSigning(t *testing.T) {
refTime := time.Now()
confTime := refTime.Add(-5 * time.Minute)
testCases := []struct {
name string
ethblocks []relayer.Block
kavablocks []relayer.Block
expectedOutputs [][]expectedOutput
}{
{
"no payloads",
blocks(
eth(1, addSecond(confTime, 0)),
eth(2, addSecond(confTime, 1)),
eth(3, addSecond(confTime, 2)),
eth(4, addSecond(confTime, 3)),
eth(5, addSecond(confTime, 4)),
),
blocks(
kava(1, addSecond(refTime, 0)),
),
outputs(),
},
{
"assorted payloads with no retry",
blocks(
eth(1, addSecond(confTime, 0)),
eth(2, addSecond(confTime, 1), newPayload(1)),
eth(3, addSecond(confTime, 2), newPayload(2), newPayload(3)),
eth(4, addSecond(confTime, 3)),
eth(5, addSecond(confTime, 4), newPayload(4), newPayload(5), newPayload(6)),
eth(6, addSecond(confTime, 5)),
),
blocks(
kava(1, addSecond(refTime, 0)),
kava(2, addSecond(refTime, 1)),
kava(3, addSecond(refTime, 2)),
kava(4, addSecond(refTime, 3)),
kava(5, addSecond(refTime, 4)),
kava(6, addSecond(refTime, 5)),
),
outputs(
output(
newOutput(1, newPayload(1)),
),
output(
newOutput(2, newPayload(2)),
newOutput(3, newPayload(3)),
),
output(
newOutput(4, newPayload(4)),
newOutput(5, newPayload(5)),
newOutput(6, newPayload(6)),
),
),
},
{
"simple retry",
blocks(
eth(1, addSecond(confTime, 0)),
eth(2, addSecond(confTime, 15), newPayload(10)),
eth(3, addSecond(confTime, 30)),
eth(4, addSecond(refTime, 2)),
),
blocks(
kava(1, addSecond(refTime, 0)),
kava(2, addSecond(refTime, 1), newPayload(10)),
kava(3, addSecond(refTime, 3)),
),
outputs(
output(
newOutput(1, newPayload(10)),
),
output(
newOutput(2, newPayload(10)),
),
),
},
{
"retry with equal timestamp",
blocks(
eth(1, addSecond(confTime, 0)),
eth(2, addSecond(confTime, 15), newPayload(1)),
eth(3, addSecond(confTime, 30)),
eth(4, addSecond(refTime, 1), newPayload(2)),
eth(5, addSecond(refTime, 2)),
),
blocks(
kava(1, addSecond(refTime, 0)),
kava(2, addSecond(refTime, 1), newPayload(1)),
kava(3, addSecond(refTime, 3)),
),
outputs(
output(
newOutput(1, newPayload(1)),
),
output(
newOutput(2, newPayload(2)),
),
output(
newOutput(3, newPayload(1)),
),
),
},
{
"complex retry",
blocks(
eth(1, addSecond(refTime, 0)),
eth(2, addSecond(refTime, 10), newPayload(2)),
eth(3, addSecond(refTime, 20), newPayload(3), newPayload(4)),
eth(4, addSecond(refTime, 30)),
eth(5, addSecond(refTime, 40), newPayload(5), newPayload(6), newPayload(7)),
eth(6, addSecond(refTime, 50)),
),
blocks(
kava(1, addSecond(refTime, 1)),
kava(2, addSecond(refTime, 9), newPayload(1)),
kava(3, addSecond(refTime, 19)),
kava(4, addSecond(refTime, 29), newPayload(3), newPayload(4)),
kava(5, addSecond(refTime, 39), newPayload(5)),
kava(6, addSecond(refTime, 49), newPayload(6)),
kava(7, addSecond(refTime, 59)),
),
outputs(
output(
newOutput(1, newPayload(2)),
newOutput(2, newPayload(1)),
),
output(
newOutput(3, newPayload(3)),
newOutput(4, newPayload(4)),
),
output(
newOutput(5, newPayload(3)),
newOutput(6, newPayload(4)),
),
output(
newOutput(7, newPayload(5)),
newOutput(8, newPayload(6)),
newOutput(9, newPayload(7)),
newOutput(10, newPayload(5)),
),
output(
newOutput(11, newPayload(6)),
),
),
},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
permutations := [][]relayer.Block{}
orderedBlockPermutations(&permutations, []relayer.Block{}, tc.ethblocks, tc.kavablocks)
for index, permutation := range permutations {
coordinator := newCoordinator()
outputs, err := writeBlocks(ctx, coordinator, permutation)
require.NoError(t, err)
var actualOutputs [][]expectedOutput
for _, output := range outputs {
actualOut := []expectedOutput{}
for _, o := range output {
actualOut = append(actualOut, expectedOutput{o.Nonce(), o.Payload()})
}
actualOutputs = append(actualOutputs, actualOut)
}
errDetail := fmt.Sprintf("permutation %d of %d failed", index+1, len(permutations))
require.Equal(t, tc.expectedOutputs, actualOutputs, errDetail)
}
})
}
}
// TestCoordinator_InvalidSequences ensures blocks are never processed in a sequence
// that would result in non-deterministic actions on the destination (kava) chain.
//
// This ensures the coordinator is protected from faults in block processing and provides
// enough error information for a block processor to recover. In addition, we can be
// confident that the core logic in the coordinator is not corrupted by an invalid
// sequence of new information.
//
// TODO: we can improve the error messages to be more specific?
func TestCoordinator_InvalidSequences(t *testing.T) {
refTime := time.Now()
testCases := []struct {
name string
initBlocks []relayer.Block
block relayer.Block
expectedErr error
}{
// A block with the same height can not be added
{"kava same height", blocks(kava(1, refTime)), kava(1, addSecond(refTime, 1)), relayer.ErrInvalidBlockHeight},
{"eth same height", blocks(kava(1, refTime), eth(1, addSecond(refTime, -2))), eth(1, addSecond(refTime, -1)), relayer.ErrInvalidBlockHeight},
// A block with a previous height can not be added
{"kava previous height", blocks(kava(1, refTime), kava(2, addSecond(refTime, 1))), kava(2, addSecond(refTime, 2)), relayer.ErrInvalidBlockHeight},
{"eth previous height", blocks(kava(1, refTime), eth(1, addSecond(refTime, -3)), eth(2, addSecond(refTime, -2))), eth(1, addSecond(refTime, -1)), relayer.ErrInvalidBlockHeight},
// A block with a skipped height can not be added
{"kava previous height", blocks(kava(1, refTime)), kava(3, addSecond(refTime, 1)), relayer.ErrInvalidBlockHeight},
{"eth previous height", blocks(kava(1, refTime), eth(1, addSecond(refTime, -2))), eth(3, addSecond(refTime, -1)), relayer.ErrInvalidBlockHeight},
// A block with the same timestamp can not be added
{"kava previous height", blocks(kava(1, refTime)), kava(2, addSecond(refTime, 0)), relayer.ErrInvalidBlockTime},
{"eth previous height", blocks(kava(1, refTime), eth(1, addSecond(refTime, -1))), eth(2, addSecond(refTime, -1)), relayer.ErrInvalidBlockTime},
// A block with a previous timestamp can not be added
{"kava previous height", blocks(kava(1, refTime)), kava(2, addSecond(refTime, -1)), relayer.ErrInvalidBlockTime},
{"eth previous height", blocks(kava(1, refTime), eth(1, addSecond(refTime, -1))), eth(2, addSecond(refTime, -2)), relayer.ErrInvalidBlockTime},
// An eth block with a timestamp greater than the last kava block can not be added
{"first eth timestsamp greater than kava", blocks(kava(1, refTime)), eth(1, addSecond(refTime, 1)), relayer.ErrSourceBlockAhead},
{"next eth timestsamp greater than kava", blocks(kava(1, refTime), eth(1, addSecond(refTime, -1))), eth(2, addSecond(refTime, 1)), relayer.ErrSourceBlockAhead},
// An eth block with a timestamp equal than the last kava block can not be added
{"eth timestsamp equal to kava", blocks(kava(1, refTime)), eth(1, addSecond(refTime, 0)), relayer.ErrSourceBlockAhead},
{"next eth timestsamp equal than kava", blocks(kava(1, refTime), eth(1, addSecond(refTime, -1))), eth(2, addSecond(refTime, 0)), relayer.ErrSourceBlockAhead},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
coordinator := newCoordinator()
stop := startNullReader(coordinator)
defer stop()
// initialize coordinator with some state
for _, blk := range tc.initBlocks {
err := coordinator.AddBlock(context.Background(), blk)
require.NoError(t, err, "expected no errors when setting initial state")
}
// test block addition and assert error
err := coordinator.AddBlock(context.Background(), tc.block)
assert.Equal(t, tc.expectedErr, err, "expected an error to be returned")
})
}
}
// TestCoordinator_AllowedSequences tests that normal operation sequences still succeed.
// This ensures assumptions made in valid block processing are not violated.
func TestCoordinator_AllowedSequences(t *testing.T) {
refTime := time.Now()
testCases := []struct {
name string
blocks []relayer.Block
}{
// a single kava block to initialize the coordniator is always allowed
{
"single kava block",
blocks(
kava(1, refTime),
),
},
// kava blocks never cause actions, so any number can be added with disregard for eth blocks
{
"kava blocks only",
blocks(
kava(1, refTime),
kava(2, addSecond(refTime, 1)),
kava(3, addSecond(refTime, 2)),
kava(4, addSecond(refTime, 3)),
kava(5, addSecond(refTime, 4)),
),
},
// as long no validations are violated, we may alternate between kava and eth blocks
{
"alternating blocks",
blocks(
kava(1, refTime),
eth(1, addSecond(refTime, -1)),
kava(2, addSecond(refTime, 1)),
eth(2, addSecond(refTime, 0)),
kava(3, addSecond(refTime, 2)),
eth(3, addSecond(refTime, 1)),
),
},
// any length sequence of eth blocks as long the timestamps are less than the last added kava block
{
"sequence of eth blocks",
blocks(
kava(1, refTime),
eth(1, addSecond(refTime, -5)),
eth(2, addSecond(refTime, -4)),
eth(3, addSecond(refTime, -3)),
eth(4, addSecond(refTime, -2)),
eth(5, addSecond(refTime, -1)),
),
},
// any alternating sequences of block runs is allowed as long as validations are not violated
{
"alternating sequences",
blocks(
kava(1, addSecond(refTime, -4)),
kava(2, addSecond(refTime, -3)),
kava(3, addSecond(refTime, -2)),
kava(4, addSecond(refTime, -1)),
kava(5, addSecond(refTime, 0)),
eth(1, addSecond(refTime, -5)),
eth(2, addSecond(refTime, -4)),
eth(3, addSecond(refTime, -3)),
eth(4, addSecond(refTime, -2)),
eth(5, addSecond(refTime, -1)),
kava(6, addSecond(refTime, 1)),
kava(7, addSecond(refTime, 2)),
kava(8, addSecond(refTime, 3)),
kava(9, addSecond(refTime, 4)),
eth(6, addSecond(refTime, 0)),
eth(7, addSecond(refTime, 1)),
eth(8, addSecond(refTime, 2)),
eth(9, addSecond(refTime, 3)),
),
},
// no validations are violated with overlapping timestamp ranges
{
"overlapping timestamp ranges",
blocks(
kava(1, addSecond(refTime, -5)),
kava(2, addSecond(refTime, 0)),
eth(1, addSecond(refTime, -5)),
eth(2, addSecond(refTime, -4)),
eth(3, addSecond(refTime, -3)),
eth(4, addSecond(refTime, -2)),
eth(5, addSecond(refTime, -1)),
kava(3, addSecond(refTime, 10)),
eth(6, addSecond(refTime, 0)),
eth(7, addSecond(refTime, 5)),
eth(8, addSecond(refTime, 8)),
eth(9, addSecond(refTime, 9)),
kava(4, addSecond(refTime, 11)),
),
},
{
"large timestamp gaps",
blocks(
kava(1, addSecond(refTime, -1000)),
kava(2, addSecond(refTime, 0)),
eth(1, addSecond(refTime, -999)),
eth(2, addSecond(refTime, -1)),
kava(3, addSecond(refTime, 1000)),
eth(3, addSecond(refTime, 500)),
kava(4, addSecond(refTime, 1001)),
eth(4, addSecond(refTime, 1000)),
),
},
// blocks may start processing at any block height, not just height 1
// TODO: this requires special initialization
//{
// "start at any block height",
// blocks(
// kava(100, addSecond(refTime, 0)),
// eth(100, addSecond(refTime, -1)),
// ),
//},
// blocks may start processing at a future time (processing is not dependent on real clock)
{
"timestamps may start any an future time",
blocks(
kava(1, addSecond(refTime, 300)),
eth(1, addSecond(refTime, 299)),
),
},
{
"timestamps may start any past time",
blocks(
kava(1, addSecond(refTime, -299)),
eth(1, addSecond(refTime, -300)),
),
},
{
"multiple retries of a payload",
blocks(
kava(1, addSecond(refTime, 0)),
eth(1, addSecond(refTime, -15), newPayload(1)),
kava(2, addSecond(refTime, 6), newPayload(1)),
kava(3, addSecond(refTime, 12), newPayload(1)),
eth(2, addSecond(refTime, 0)),
kava(4, addSecond(refTime, 18), newPayload(1)),
eth(3, addSecond(refTime, 15), newPayload(2)),
kava(5, addSecond(refTime, 24), newPayload(2)),
),
},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
coordinator := newCoordinator()
stop := startNullReader(coordinator)
defer stop()
// initialize coordinator with some state
for _, blk := range tc.blocks {
err := coordinator.AddBlock(context.Background(), blk)
require.NoError(t, err, "expected no errors when processing blocks")
}
})
}
}
// TestCoordinator_AddBlockCancellation tests that AddBlock does not process any outputs
// or modify state on context cancellation
func TestCoordinator_AddBlockCancellation(t *testing.T) {
refTime := time.Now()
coordinator := newCoordinator()
ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)
err := coordinator.AddBlock(ctx, kava(1, refTime))
require.NoError(t, err)
cancel()
err = coordinator.AddBlock(ctx, eth(1, addSecond(refTime, -1), newPayload(1)))
require.EqualError(t, err, "context canceled")
ctx, cancel = context.WithTimeout(context.Background(), 1*time.Second)
defer cancel()
stop := startNullReader(coordinator)
defer stop()
err = coordinator.AddBlock(ctx, eth(1, addSecond(refTime, -1), newPayload(1)))
require.NoError(t, err)
}
// TestCoordinator_UnknownBlockType ensures AddBlock throws an error if unrecognized block is added
func TestCoordinator_UnknownBlockType(t *testing.T) {
coordinator := newCoordinator()
err := coordinator.AddBlock(context.Background(), relayer.NewBlock(100, 1, time.Now(), nil))
assert.Equal(t, relayer.ErrUnknownBlockOrigin, err, "expected a unkown block origin to error")
}