-
Notifications
You must be signed in to change notification settings - Fork 6
/
f3_test.go
632 lines (525 loc) · 17 KB
/
f3_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
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
package f3_test
import (
"context"
"fmt"
"sync/atomic"
"testing"
"time"
"github.com/filecoin-project/go-f3"
"github.com/filecoin-project/go-f3/gpbft"
"github.com/filecoin-project/go-f3/internal/clock"
"github.com/filecoin-project/go-f3/internal/consensus"
"github.com/filecoin-project/go-f3/internal/psutil"
"github.com/filecoin-project/go-f3/manifest"
"github.com/filecoin-project/go-f3/sim/signing"
"github.com/ipfs/go-datastore"
"github.com/ipfs/go-datastore/failstore"
ds_sync "github.com/ipfs/go-datastore/sync"
pubsub "github.com/libp2p/go-libp2p-pubsub"
"github.com/libp2p/go-libp2p/core/host"
"github.com/libp2p/go-libp2p/core/peer"
mocknet "github.com/libp2p/go-libp2p/p2p/net/mock"
"github.com/stretchr/testify/require"
"golang.org/x/sync/errgroup"
)
func init() {
// Hash-based deduplication breaks fast rebroadcast, even if we set the time window to be
// really short because gossipsub has a minimum 1m cache scan interval.
psutil.GPBFTMessageIdFn = pubsub.DefaultMsgIdFn
}
var ManifestSenderTimeout = 30 * time.Second
func TestF3Simple(t *testing.T) {
t.Parallel()
env := newTestEnvironment(t, 2, false)
env.connectAll()
env.start()
env.waitForInstanceNumber(5, 10*time.Second, false)
}
func TestF3WithLookback(t *testing.T) {
t.Parallel()
env := newTestEnvironment(t, 2, true)
env.manifest.EC.HeadLookback = 20
env.updateManifest()
env.connectAll()
env.start()
env.waitForInstanceNumber(5, 10*time.Second, false)
// Wait a second to let everything settle.
time.Sleep(10 * time.Millisecond)
headEpoch := env.ec.GetCurrentHead()
cert, err := env.nodes[0].f3.GetLatestCert(env.testCtx)
require.NoError(t, err)
require.NotNil(t, cert)
// just in case we race, I'm using 15 not 20 here.
require.LessOrEqual(t, cert.ECChain.Head().Epoch, headEpoch-15)
env.ec.Pause()
// Advance by 100 periods.
for i := 0; i < 200; i++ {
env.clock.Add(env.manifest.EC.Period / 2)
time.Sleep(time.Millisecond)
}
// Now make sure we've advanced by significantly less than 100 instances.
// We want to make sure we're not racing.
cert, err = env.nodes[0].f3.GetLatestCert(env.testCtx)
require.NoError(t, err)
require.NotNil(t, cert)
require.Less(t, cert.GPBFTInstance, uint64(80))
// If we add another EC period, we should make progress again.
// We do it bit by bit to give code time to run.
env.ec.Resume()
for i := 0; i < 10; i++ {
env.clock.Add(env.manifest.EC.Period / 10)
time.Sleep(time.Millisecond)
}
require.Eventually(t, func() bool {
cert, err := env.nodes[0].f3.GetLatestCert(env.testCtx)
require.NoError(t, err)
return cert.GPBFTInstance >= 5
}, 10*time.Second, 10*time.Millisecond)
}
func TestF3PauseResumeCatchup(t *testing.T) {
t.Parallel()
env := newTestEnvironment(t, 3, false)
env.connectAll()
env.start()
env.waitForInstanceNumber(1, 30*time.Second, true)
// Pausing two nodes should pause the network.
env.pauseNode(1)
env.pauseNode(2)
// Wait until node 0 stops receiving new instances
env.clock.Add(1 * time.Second)
env.waitForCondition(func() bool {
oldInstance := env.nodes[0].currentGpbftInstance()
env.clock.Add(10 * env.manifest.EC.Period)
newInstance := env.nodes[0].currentGpbftInstance()
return oldInstance == newInstance
}, 30*time.Second)
// Resuming node 1 should continue agreeing on instances.
env.resumeNode(1)
// make sure we're ahead of node 2, which may be ahead of node 0.
resumeInstance := env.nodes[2].currentGpbftInstance() + 1
env.waitForInstanceNumber(resumeInstance, 30*time.Second, false)
// Wait until we're far enough that pure GPBFT catchup should be impossible.
targetInstance := resumeInstance + env.manifest.CommitteeLookback
env.waitForInstanceNumber(targetInstance, 30*time.Second, false)
pausedInstance := env.nodes[2].currentGpbftInstance()
require.Less(t, pausedInstance, resumeInstance)
env.resumeNode(2)
// Everyone should catch up eventually
env.waitForInstanceNumber(targetInstance, 30*time.Second, true)
// Pause the "good" node.
env.pauseNode(0)
node0failInstance := env.nodes[0].currentGpbftInstance()
// We should be able to make progress with the remaining nodes.
env.waitForInstanceNumber(node0failInstance+3, 30*time.Second, false)
}
func TestF3FailRecover(t *testing.T) {
t.Parallel()
env := newTestEnvironment(t, 2, false)
// Make it possible to fail a single write for node 0.
var failDsWrite atomic.Bool
dsFailureFunc := func(op string) error {
if failDsWrite.Load() {
switch op {
case "put", "batch-put":
failDsWrite.Store(false)
return fmt.Errorf("Intentional error for testing, please ignore!")
}
}
return nil
}
env.injectDatastoreFailures(0, dsFailureFunc)
env.connectAll()
env.start()
env.waitForInstanceNumber(1, 10*time.Second, true)
// Inject a single write failure. This should prevent us from storing a single decision
// decision.
failDsWrite.Store(true)
// We should proceed anyways (catching up via the certificate exchange protocol).
oldInstance := env.nodes[0].currentGpbftInstance()
env.waitForInstanceNumber(oldInstance+3, 10*time.Second, true)
}
func TestF3DynamicManifest_WithoutChanges(t *testing.T) {
t.Parallel()
env := newTestEnvironment(t, 2, true)
env.connectAll()
env.start()
prev := env.nodes[0].f3.Manifest()
env.waitForInstanceNumber(5, 10*time.Second, false)
// no changes in manifest
require.Equal(t, prev, env.nodes[0].f3.Manifest())
env.requireEqualManifests(false)
}
func TestF3DynamicManifest_WithRebootstrap(t *testing.T) {
t.Parallel()
env := newTestEnvironment(t, 2, true)
env.connectAll()
env.start()
prev := env.nodes[0].f3.Manifest()
env.waitForInstanceNumber(3, 15*time.Second, false)
prevInstance := env.nodes[0].currentGpbftInstance()
env.manifest.BootstrapEpoch = 1253
env.addParticipants(&env.manifest, []gpbft.ActorID{2, 3}, gpbft.NewStoragePower(1), false)
env.updateManifest()
env.waitForManifestChange(prev, 60*time.Second)
// check that it rebootstrapped and the number of instances is below prevInstance
require.True(t, env.nodes[0].currentGpbftInstance() < prevInstance)
env.waitForInstanceNumber(3, 15*time.Second, false)
require.NotEqual(t, prev, env.nodes[0].f3.Manifest())
env.requireEqualManifests(false)
// check that the power table is updated
ts, err := env.ec.GetTipsetByEpoch(env.testCtx, int64(env.nodes[0].currentGpbftInstance()))
require.NoError(t, err)
pt, err := env.nodes[0].f3.GetPowerTable(env.testCtx, ts.Key())
require.NoError(t, err)
require.Equal(t, len(pt), 4)
}
func TestF3DynamicManifest_WithPauseAndRebootstrap(t *testing.T) {
t.Parallel()
env := newTestEnvironment(t, 2, true)
env.connectAll()
env.start()
prev := env.nodes[0].f3.Manifest()
env.waitForInstanceNumber(10, 30*time.Second, true)
prevCopy := *prev
prevCopy.Pause = true
env.manifestSender.UpdateManifest(&prevCopy)
env.waitForManifestChange(prev, 30*time.Second)
// check that it paused
env.waitForNodesStopped(10 * time.Second)
// New manifest with sequence 2 to start again F3
prev = env.nodes[0].f3.Manifest()
env.manifest.BootstrapEpoch = 956
env.updateManifest()
env.waitForManifestChange(prev, 30*time.Second)
env.clock.Add(1 * time.Minute)
env.waitForInstanceNumber(3, 30*time.Second, true)
env.requireEqualManifests(true)
// Now check that we have the correct base for certificate 0.
cert0, err := env.nodes[0].f3.GetCert(env.testCtx, 0)
require.NoError(t, err)
require.Equal(t, env.manifest.BootstrapEpoch-env.manifest.EC.Finality, cert0.ECChain.Base().Epoch)
}
var base = manifest.Manifest{
BootstrapEpoch: 950,
InitialInstance: 0,
NetworkName: gpbft.NetworkName("f3-test/0"),
CommitteeLookback: manifest.DefaultCommitteeLookback,
Gpbft: manifest.DefaultGpbftConfig,
EC: manifest.DefaultEcConfig,
CertificateExchange: manifest.DefaultCxConfig,
CatchUpAlignment: manifest.DefaultCatchUpAlignment,
}
type testNode struct {
e *testEnv
h host.Host
f3 *f3.F3
dsErrFunc func(string) error
}
func (n *testNode) currentGpbftInstance() uint64 {
c, err := n.f3.GetLatestCert(n.e.testCtx)
require.NoError(n.e.t, err)
if c == nil {
return n.e.manifest.InitialInstance
}
return c.GPBFTInstance + 1
}
type testEnv struct {
t *testing.T
errgrp *errgroup.Group
testCtx context.Context
signingBackend *signing.FakeBackend
nodes []*testNode
ec *consensus.FakeEC
manifestSender *manifest.ManifestSender
net mocknet.Mocknet
clock *clock.Mock
manifest manifest.Manifest
manifestVersion uint64
}
// signals the update to the latest manifest in the environment.
func (e *testEnv) updateManifest() {
m := e.manifest // copy because we mutate it locally.
e.manifestVersion++
nn := fmt.Sprintf("%s/%d", e.manifest.NetworkName, e.manifestVersion)
m.NetworkName = gpbft.NetworkName(nn)
e.manifestSender.UpdateManifest(&m)
}
func (e *testEnv) addParticipants(m *manifest.Manifest, participants []gpbft.ActorID, power gpbft.StoragePower, runNodes bool) {
for _, n := range participants {
nodeLen := len(e.nodes)
newNode := false
// nodes are initialized sequentially. If the participantID is over the
// number of nodes, it means that it hasn't been initialized and is a new node
// that we need to add
// If the ID matches an existing one, it adds to the existing power.
// NOTE: We do not respect the original ID when adding a new nodes, we use the subsequent one.
if n >= gpbft.ActorID(nodeLen) {
e.initNode(nodeLen, e.manifestSender.SenderID())
newNode = true
}
pubkey, _ := e.signingBackend.GenerateKey()
m.ExplicitPower = append(m.ExplicitPower, gpbft.PowerEntry{
ID: gpbft.ActorID(nodeLen),
PubKey: pubkey,
Power: power,
})
if runNodes && newNode {
// connect node
for j := 0; j < nodeLen-1; j++ {
_, err := e.net.LinkPeers(e.nodes[nodeLen-1].h.ID(), e.nodes[j].h.ID())
require.NoError(e.t, err)
_, err = e.net.ConnectPeers(e.nodes[nodeLen-1].h.ID(), e.nodes[j].h.ID())
require.NoError(e.t, err)
}
// run
e.startNode(nodeLen - 1)
}
}
}
func (e *testEnv) waitForCondition(condition func() bool, timeout time.Duration) {
e.t.Helper()
start := time.Now()
for {
if condition() {
break
}
e.advance()
if time.Since(start) > timeout {
e.t.Fatalf("test took too long")
}
}
}
// waits for all nodes to reach a specific instance number.
// If the `strict` flag is enabled the check also applies to the non-running nodes
func (e *testEnv) waitForInstanceNumber(instanceNumber uint64, timeout time.Duration, strict bool) {
e.t.Helper()
e.waitForCondition(func() bool {
for _, n := range e.nodes {
// nodes that are not running are not required to reach the instance
// (it will actually panic if we try to fetch it because there is no
// runner initialized)
if !n.f3.IsRunning() {
if strict {
return false
}
continue
}
if n.currentGpbftInstance() < instanceNumber {
return false
}
}
return true
}, timeout)
}
func (e *testEnv) advance() {
e.clock.Add(1 * time.Second)
}
func (e *testEnv) waitForManifestChange(prev *manifest.Manifest, timeout time.Duration) {
e.t.Helper()
e.waitForCondition(func() bool {
for _, n := range e.nodes {
if !n.f3.IsRunning() {
continue
}
m := n.f3.Manifest()
if m == nil {
return false
}
if prev.Equal(m) {
return false
}
}
return true
}, timeout)
}
func newTestEnvironment(t *testing.T, n int, dynamicManifest bool) *testEnv {
ctx, cancel := context.WithCancel(context.Background())
ctx, clk := clock.WithMockClock(ctx)
grp, ctx := errgroup.WithContext(ctx)
env := &testEnv{t: t, errgrp: grp, testCtx: ctx, net: mocknet.New(), clock: clk}
// Cleanup on exit.
env.t.Cleanup(func() {
require.NoError(env.t, env.net.Close())
cancel()
for _, n := range env.nodes {
require.NoError(env.t, n.f3.Stop(context.Background()))
}
env.clock.Add(500 * time.Second)
require.NoError(env.t, env.errgrp.Wait())
})
// populate manifest
m := base
initialPowerTable := gpbft.PowerEntries{}
env.signingBackend = signing.NewFakeBackend()
for i := 0; i < n; i++ {
pubkey, _ := env.signingBackend.GenerateKey()
initialPowerTable = append(initialPowerTable, gpbft.PowerEntry{
ID: gpbft.ActorID(i),
PubKey: pubkey,
Power: gpbft.NewStoragePower(1000),
})
}
env.manifest = m
env.ec = consensus.NewFakeEC(ctx, 1, m.BootstrapEpoch+m.EC.Finality, m.EC.Period, initialPowerTable)
var manifestServer peer.ID
if dynamicManifest {
env.newManifestSender()
manifestServer = env.manifestSender.SenderID()
}
// initialize nodes
for i := 0; i < n; i++ {
env.initNode(i, manifestServer)
}
return env
}
func (e *testEnv) initNode(i int, manifestServer peer.ID) {
n, err := e.newF3Instance(i, manifestServer)
require.NoError(e.t, err)
e.nodes = append(e.nodes, n)
}
func (e *testEnv) requireEqualManifests(strict bool) {
m := e.nodes[0].f3.Manifest()
for _, n := range e.nodes {
// only check running nodes
if n.f3.IsRunning() || strict {
require.Equal(e.t, n.f3.Manifest(), m)
}
}
}
func (e *testEnv) waitFor(f func(n *testNode) bool, timeout time.Duration) {
e.waitForCondition(func() bool {
for _, n := range e.nodes {
if !f(n) {
return false
}
}
return true
}, timeout)
}
func (e *testEnv) waitForNodesInitialization() {
f := func(n *testNode) bool {
return n.f3.IsRunning()
}
e.waitFor(f, 5*time.Second)
}
func (e *testEnv) waitForNodesStopped(timeout time.Duration) {
f := func(n *testNode) bool {
return !n.f3.IsRunning()
}
e.waitFor(f, timeout)
}
func (e *testEnv) start() {
// Start the nodes
for i := range e.nodes {
e.startNode(i)
}
// wait for nodes to initialize
e.waitForNodesInitialization()
// If it exists, start the manifest sender
if e.manifestSender != nil {
e.errgrp.Go(func() error { return e.manifestSender.Run(e.testCtx) })
}
}
func (e *testEnv) pauseNode(i int) {
n := e.nodes[i]
require.NoError(e.t, n.f3.Pause())
}
func (e *testEnv) resumeNode(i int) {
n := e.nodes[i]
require.NoError(e.t, n.f3.Resume())
}
func (e *testEnv) startNode(i int) {
n := e.nodes[i]
require.NoError(e.t, n.f3.Start(e.testCtx))
}
func (e *testEnv) connectAll() {
for i, n := range e.nodes {
for j := i + 1; j < len(e.nodes); j++ {
_, err := e.net.LinkPeers(n.h.ID(), e.nodes[j].h.ID())
require.NoError(e.t, err)
_, err = e.net.ConnectPeers(n.h.ID(), e.nodes[j].h.ID())
require.NoError(e.t, err)
}
}
// connect to the manifest server if it exists
if e.manifestSender != nil {
id := e.manifestSender.PeerInfo().ID
for _, n := range e.nodes {
_, err := e.net.LinkPeers(n.h.ID(), id)
require.NoError(e.t, err)
_, err = e.net.ConnectPeers(n.h.ID(), id)
require.NoError(e.t, err)
}
}
}
func (e *testEnv) newManifestSender() {
h, err := e.net.GenPeer()
require.NoError(e.t, err)
ps, err := pubsub.NewGossipSub(e.testCtx, h)
require.NoError(e.t, err)
m := e.manifest // copy because we mutate this
e.manifestSender, err = manifest.NewManifestSender(e.testCtx, h, ps, &m, ManifestSenderTimeout)
require.NoError(e.t, err)
}
func (e *testEnv) newF3Instance(id int, manifestServer peer.ID) (*testNode, error) {
h, err := e.net.GenPeer()
if err != nil {
return nil, fmt.Errorf("creating libp2p host: %w", err)
}
n := &testNode{e: e, h: h}
ps, err := pubsub.NewGossipSub(e.testCtx, h)
if err != nil {
return nil, fmt.Errorf("creating gossipsub: %w", err)
}
ds := ds_sync.MutexWrap(failstore.NewFailstore(datastore.NewMapDatastore(), func(s string) error {
if n.dsErrFunc != nil {
return (n.dsErrFunc)(s)
}
return nil
}))
m := e.manifest // copy because we mutate this
var mprovider manifest.ManifestProvider
if manifestServer != "" {
mprovider = manifest.NewDynamicManifestProvider(&m, ds, ps, manifestServer)
} else {
mprovider = manifest.NewStaticManifestProvider(&m)
}
e.signingBackend.Allow(id)
n.f3, err = f3.New(e.testCtx, mprovider, ds, h, ps, e.signingBackend, e.ec, e.t.TempDir())
if err != nil {
return nil, fmt.Errorf("creating module: %w", err)
}
e.errgrp.Go(func() error {
return runMessageSubscription(e.testCtx, n.f3, gpbft.ActorID(id), e.signingBackend)
})
return n, nil
}
func (e *testEnv) injectDatastoreFailures(i int, fn func(op string) error) {
e.nodes[i].dsErrFunc = fn
}
// TODO: This code is copy-pasta from cmd/f3/run.go, consider taking it out into a shared testing lib.
// We could do the same to the F3 test instantiation
func runMessageSubscription(ctx context.Context, module *f3.F3, actorID gpbft.ActorID, signer gpbft.Signer) error {
for ctx.Err() == nil {
select {
case mb, ok := <-module.MessagesToSign():
if !ok {
return nil
}
signatureBuilder, err := mb.PrepareSigningInputs(actorID)
if err != nil {
return fmt.Errorf("preparing signing inputs: %w", err)
}
// signatureBuilder can be sent over RPC
payloadSig, vrfSig, err := signatureBuilder.Sign(ctx, signer)
if err != nil {
return fmt.Errorf("signing message: %w", err)
}
// signatureBuilder and signatures can be returned back over RPC
module.Broadcast(ctx, signatureBuilder, payloadSig, vrfSig)
case <-ctx.Done():
return nil
}
}
return nil
}