Skip to content

Commit 15ad215

Browse files
tim-barrytim-barry
committed
Prefer require.NoError() over require.Nil() in tests
1 parent a8546d1 commit 15ad215

37 files changed

+140
-141
lines changed

Diff for: ‎consensus/hotstuff/committees/consensus_committee_test.go

+14-14
Original file line numberDiff line numberDiff line change
@@ -502,19 +502,19 @@ func (suite *ConsensusSuite) TestThresholds() {
502502
t.Run("next epoch not ready", func(t *testing.T) {
503503
t.Run("previous epoch", func(t *testing.T) {
504504
threshold, err := suite.committee.QuorumThresholdForView(unittest.Uint64InRange(1, 100))
505-
require.Nil(t, err)
505+
require.NoError(t, err)
506506
assert.Equal(t, WeightThresholdToBuildQC(1000), threshold)
507507
threshold, err = suite.committee.TimeoutThresholdForView(unittest.Uint64InRange(1, 100))
508-
require.Nil(t, err)
508+
require.NoError(t, err)
509509
assert.Equal(t, WeightThresholdToTimeout(1000), threshold)
510510
})
511511

512512
t.Run("current epoch", func(t *testing.T) {
513513
threshold, err := suite.committee.QuorumThresholdForView(unittest.Uint64InRange(101, 200))
514-
require.Nil(t, err)
514+
require.NoError(t, err)
515515
assert.Equal(t, WeightThresholdToBuildQC(2000), threshold)
516516
threshold, err = suite.committee.TimeoutThresholdForView(unittest.Uint64InRange(101, 200))
517-
require.Nil(t, err)
517+
require.NoError(t, err)
518518
assert.Equal(t, WeightThresholdToTimeout(2000), threshold)
519519
})
520520

@@ -534,28 +534,28 @@ func (suite *ConsensusSuite) TestThresholds() {
534534
t.Run("next epoch ready", func(t *testing.T) {
535535
t.Run("previous epoch", func(t *testing.T) {
536536
threshold, err := suite.committee.QuorumThresholdForView(unittest.Uint64InRange(1, 100))
537-
require.Nil(t, err)
537+
require.NoError(t, err)
538538
assert.Equal(t, WeightThresholdToBuildQC(1000), threshold)
539539
threshold, err = suite.committee.TimeoutThresholdForView(unittest.Uint64InRange(1, 100))
540-
require.Nil(t, err)
540+
require.NoError(t, err)
541541
assert.Equal(t, WeightThresholdToTimeout(1000), threshold)
542542
})
543543

544544
t.Run("current epoch", func(t *testing.T) {
545545
threshold, err := suite.committee.QuorumThresholdForView(unittest.Uint64InRange(101, 200))
546-
require.Nil(t, err)
546+
require.NoError(t, err)
547547
assert.Equal(t, WeightThresholdToBuildQC(2000), threshold)
548548
threshold, err = suite.committee.TimeoutThresholdForView(unittest.Uint64InRange(101, 200))
549-
require.Nil(t, err)
549+
require.NoError(t, err)
550550
assert.Equal(t, WeightThresholdToTimeout(2000), threshold)
551551
})
552552

553553
t.Run("next epoch", func(t *testing.T) {
554554
threshold, err := suite.committee.QuorumThresholdForView(unittest.Uint64InRange(201, 300))
555-
require.Nil(t, err)
555+
require.NoError(t, err)
556556
assert.Equal(t, WeightThresholdToBuildQC(3000), threshold)
557557
threshold, err = suite.committee.TimeoutThresholdForView(unittest.Uint64InRange(201, 300))
558-
require.Nil(t, err)
558+
require.NoError(t, err)
559559
assert.Equal(t, WeightThresholdToTimeout(3000), threshold)
560560
})
561561

@@ -616,23 +616,23 @@ func (suite *ConsensusSuite) TestLeaderForView() {
616616
t.Run("previous epoch", func(t *testing.T) {
617617
// get leader for view in previous epoch
618618
leaderID, err := suite.committee.LeaderForView(unittest.Uint64InRange(1, 100))
619-
require.Nil(t, err)
619+
require.NoError(t, err)
620620
_, exists := identities.ByNodeID(leaderID)
621621
assert.True(t, exists)
622622
})
623623

624624
t.Run("current epoch", func(t *testing.T) {
625625
// get leader for view in current epoch
626626
leaderID, err := suite.committee.LeaderForView(unittest.Uint64InRange(101, 200))
627-
require.Nil(t, err)
627+
require.NoError(t, err)
628628
_, exists := identities.ByNodeID(leaderID)
629629
assert.True(t, exists)
630630
})
631631

632632
t.Run("next epoch", func(t *testing.T) {
633633
// get leader for view in next epoch after it has been set up
634634
leaderID, err := suite.committee.LeaderForView(unittest.Uint64InRange(201, 300))
635-
require.Nil(t, err)
635+
require.NoError(t, err)
636636
_, exists := identities.ByNodeID(leaderID)
637637
assert.True(t, exists)
638638
})
@@ -671,7 +671,7 @@ func TestRemoveOldEpochs(t *testing.T) {
671671
).Maybe()
672672

673673
com, err := NewConsensusCommittee(state, me)
674-
require.Nil(t, err)
674+
require.NoError(t, err)
675675

676676
ctx, cancel, errCh := irrecoverable.WithSignallerAndCancel(context.Background())
677677
com.Start(ctx)

Diff for: ‎consensus/hotstuff/committees/leader/leader_selection_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ func TestViewOutOfRange(t *testing.T) {
183183

184184
identities := unittest.IdentityListFixture(4).ToSkeleton()
185185
leaders, err := ComputeLeaderSelection(firstView, rng, int(finalView-firstView+1), identities)
186-
require.Nil(t, err)
186+
require.NoError(t, err)
187187

188188
// confirm the selection has first/final view we expect
189189
assert.Equal(t, firstView, leaders.FirstView())

Diff for: ‎consensus/hotstuff/forks/forks_test.go

+32-32
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ func TestFinalize_Direct1Chain(t *testing.T) {
4444
Add(1, 2).
4545
Add(2, 3)
4646
blocks, err := builder.Blocks()
47-
require.Nil(t, err)
47+
require.NoError(t, err)
4848

4949
t.Run("consensus participant mode: ingest validated blocks", func(t *testing.T) {
5050
forks, _ := newForks(t)
@@ -88,7 +88,7 @@ func TestFinalize_Direct2Chain(t *testing.T) {
8888
Add(2, 3).
8989
Add(3, 4).
9090
Blocks()
91-
require.Nil(t, err)
91+
require.NoError(t, err)
9292
expectedFinalityProof := makeFinalityProof(t, blocks[0], blocks[1], blocks[2].QC)
9393

9494
t.Run("consensus participant mode: ingest validated blocks", func(t *testing.T) {
@@ -117,7 +117,7 @@ func TestFinalize_DirectIndirect2Chain(t *testing.T) {
117117
Add(2, 3).
118118
Add(3, 5).
119119
Blocks()
120-
require.Nil(t, err)
120+
require.NoError(t, err)
121121
expectedFinalityProof := makeFinalityProof(t, blocks[0], blocks[1], blocks[2].QC)
122122

123123
t.Run("consensus participant mode: ingest validated blocks", func(t *testing.T) {
@@ -146,7 +146,7 @@ func TestFinalize_IndirectDirect2Chain(t *testing.T) {
146146
Add(3, 5).
147147
Add(5, 7).
148148
Blocks()
149-
require.Nil(t, err)
149+
require.NoError(t, err)
150150

151151
t.Run("consensus participant mode: ingest validated blocks", func(t *testing.T) {
152152
forks, _ := newForks(t)
@@ -178,7 +178,7 @@ func TestFinalize_Direct2ChainOnIndirect(t *testing.T) {
178178
Add(6, 7).
179179
Add(7, 8).
180180
Blocks()
181-
require.Nil(t, err)
181+
require.NoError(t, err)
182182
expectedFinalityProof := makeFinalityProof(t, blocks[2], blocks[3], blocks[4].QC)
183183

184184
t.Run("consensus participant mode: ingest validated blocks", func(t *testing.T) {
@@ -209,7 +209,7 @@ func TestFinalize_Direct2ChainOnDirect(t *testing.T) {
209209
Add(4, 5).
210210
Add(5, 6).
211211
Blocks()
212-
require.Nil(t, err)
212+
require.NoError(t, err)
213213
expectedFinalityProof := makeFinalityProof(t, blocks[2], blocks[3], blocks[4].QC)
214214

215215
t.Run("consensus participant mode: ingest validated blocks", func(t *testing.T) {
@@ -240,7 +240,7 @@ func TestFinalize_Multiple2Chains(t *testing.T) {
240240
Add(3, 6).
241241
Add(3, 7).
242242
Blocks()
243-
require.Nil(t, err)
243+
require.NoError(t, err)
244244
expectedFinalityProof := makeFinalityProof(t, blocks[0], blocks[1], blocks[2].QC)
245245

246246
t.Run("consensus participant mode: ingest validated blocks", func(t *testing.T) {
@@ -275,7 +275,7 @@ func TestFinalize_OrphanedFork(t *testing.T) {
275275
Add(4, 5). // [◄(4) 5]
276276
Add(5, 6). // [◄(5) 6]
277277
Blocks()
278-
require.Nil(t, err)
278+
require.NoError(t, err)
279279
expectedFinalityProof := makeFinalityProof(t, blocks[2], blocks[3], blocks[4].QC)
280280

281281
t.Run("consensus participant mode: ingest validated blocks", func(t *testing.T) {
@@ -311,7 +311,7 @@ func TestDuplication(t *testing.T) {
311311
Add(4, 5).
312312
Add(4, 5).
313313
Blocks()
314-
require.Nil(t, err)
314+
require.NoError(t, err)
315315
expectedFinalityProof := makeFinalityProof(t, blocks[1], blocks[3], blocks[5].QC)
316316

317317
t.Run("consensus participant mode: ingest validated blocks", func(t *testing.T) {
@@ -341,7 +341,7 @@ func TestIgnoreBlocksBelowFinalizedView(t *testing.T) {
341341
Add(3, 4). // [◄(3) 4]
342342
Add(1, 5) // [◄(1) 5]
343343
blocks, err := builder.Blocks()
344-
require.Nil(t, err)
344+
require.NoError(t, err)
345345
expectedFinalityProof := makeFinalityProof(t, blocks[0], blocks[1], blocks[2].QC)
346346

347347
t.Run("consensus participant mode: ingest validated blocks", func(t *testing.T) {
@@ -401,24 +401,24 @@ func TestDoubleProposal(t *testing.T) {
401401
Add(1, 2). // [◄(1) 2]
402402
AddVersioned(1, 2, 0, 1). // [◄(1) 2']
403403
Blocks()
404-
require.Nil(t, err)
404+
require.NoError(t, err)
405405

406406
t.Run("consensus participant mode: ingest validated blocks", func(t *testing.T) {
407407
forks, notifier := newForks(t)
408408
notifier.On("OnDoubleProposeDetected", blocks[1], blocks[0]).Once()
409409

410410
err = addValidatedBlockToForks(forks, blocks)
411-
require.Nil(t, err)
411+
require.NoError(t, err)
412412
})
413413

414414
t.Run("consensus follower mode: ingest certified blocks", func(t *testing.T) {
415415
forks, notifier := newForks(t)
416416
notifier.On("OnDoubleProposeDetected", blocks[1], blocks[0]).Once()
417417

418418
err = forks.AddCertifiedBlock(toCertifiedBlock(t, blocks[0])) // add [◄(1) 2] as certified block
419-
require.Nil(t, err)
419+
require.NoError(t, err)
420420
err = forks.AddCertifiedBlock(toCertifiedBlock(t, blocks[1])) // add [◄(1) 2'] as certified block
421-
require.Nil(t, err)
421+
require.NoError(t, err)
422422
})
423423
}
424424

@@ -438,7 +438,7 @@ func TestConflictingQCs(t *testing.T) {
438438
Add(4, 6). // [◄(4) 6]
439439
AddVersioned(3, 5, 1, 0). // [◄(3') 5]
440440
Blocks()
441-
require.Nil(t, err)
441+
require.NoError(t, err)
442442

443443
t.Run("consensus participant mode: ingest validated blocks", func(t *testing.T) {
444444
forks, notifier := newForks(t)
@@ -477,7 +477,7 @@ func TestConflictingFinalizedForks(t *testing.T) {
477477
Add(6, 7).
478478
Add(7, 8). // finalizes [◄(2) 6], conflicting with conflicts with [◄(2) 3]
479479
Blocks()
480-
require.Nil(t, err)
480+
require.NoError(t, err)
481481

482482
t.Run("consensus participant mode: ingest validated blocks", func(t *testing.T) {
483483
forks, _ := newForks(t)
@@ -502,7 +502,7 @@ func TestAddDisconnectedBlock(t *testing.T) {
502502
Add(1, 2). // we will skip this block [◄(1) 2]
503503
Add(2, 3). // [◄(2) 3]
504504
Blocks()
505-
require.Nil(t, err)
505+
require.NoError(t, err)
506506

507507
t.Run("consensus participant mode: ingest validated blocks", func(t *testing.T) {
508508
forks, _ := newForks(t)
@@ -530,7 +530,7 @@ func TestGetBlock(t *testing.T) {
530530
Add(3, 4). // [◄(3) 4]
531531
Add(4, 5). // [◄(4) 5]
532532
Blocks()
533-
require.Nil(t, err)
533+
require.NoError(t, err)
534534

535535
t.Run("consensus participant mode: ingest validated blocks", func(t *testing.T) {
536536
blocksAddedFirst := blocks[:3] // [◄(1) 2] [◄(2) 3] [◄(3) 4]
@@ -543,7 +543,7 @@ func TestGetBlock(t *testing.T) {
543543

544544
// add first 3 blocks - should finalize [◄(1) 2]
545545
err = addValidatedBlockToForks(forks, blocksAddedFirst)
546-
require.Nil(t, err)
546+
require.NoError(t, err)
547547

548548
// should be able to retrieve all stored blocks
549549
for _, block := range blocksAddedFirst {
@@ -581,9 +581,9 @@ func TestGetBlock(t *testing.T) {
581581

582582
// add first blocks - should finalize [◄(1) 2]
583583
err := forks.AddCertifiedBlock(blocksAddedFirst[0])
584-
require.Nil(t, err)
584+
require.NoError(t, err)
585585
err = forks.AddCertifiedBlock(blocksAddedFirst[1])
586-
require.Nil(t, err)
586+
require.NoError(t, err)
587587

588588
// should be able to retrieve all stored blocks
589589
for _, block := range blocksAddedFirst {
@@ -620,14 +620,14 @@ func TestGetBlocksForView(t *testing.T) {
620620
Add(2, 4). // [◄(2) 4]
621621
AddVersioned(2, 4, 0, 1). // [◄(2) 4']
622622
Blocks()
623-
require.Nil(t, err)
623+
require.NoError(t, err)
624624

625625
t.Run("consensus participant mode: ingest validated blocks", func(t *testing.T) {
626626
forks, notifier := newForks(t)
627627
notifier.On("OnDoubleProposeDetected", blocks[2], blocks[1]).Once()
628628

629629
err = addValidatedBlockToForks(forks, blocks)
630-
require.Nil(t, err)
630+
require.NoError(t, err)
631631

632632
// expect 1 block at view 2
633633
storedBlocks := forks.GetBlocksForView(2)
@@ -649,11 +649,11 @@ func TestGetBlocksForView(t *testing.T) {
649649
notifier.On("OnDoubleProposeDetected", blocks[2], blocks[1]).Once()
650650

651651
err := forks.AddCertifiedBlock(toCertifiedBlock(t, blocks[0]))
652-
require.Nil(t, err)
652+
require.NoError(t, err)
653653
err = forks.AddCertifiedBlock(toCertifiedBlock(t, blocks[1]))
654-
require.Nil(t, err)
654+
require.NoError(t, err)
655655
err = forks.AddCertifiedBlock(toCertifiedBlock(t, blocks[2]))
656-
require.Nil(t, err)
656+
require.NoError(t, err)
657657

658658
// expect 1 block at view 2
659659
storedBlocks := forks.GetBlocksForView(2)
@@ -683,7 +683,7 @@ func TestNotifications(t *testing.T) {
683683
Add(2, 3).
684684
Add(3, 4)
685685
blocks, err := builder.Blocks()
686-
require.Nil(t, err)
686+
require.NoError(t, err)
687687

688688
t.Run("consensus participant mode: ingest validated blocks", func(t *testing.T) {
689689
notifier := &mocks.Consumer{}
@@ -736,7 +736,7 @@ func TestFinalizingMultipleBlocks(t *testing.T) {
736736
Add(11, 12). // index 4: [◄(11) 12]
737737
Add(12, 22) // index 5: [◄(12) 22]
738738
blocks, err := builder.Blocks()
739-
require.Nil(t, err)
739+
require.NoError(t, err)
740740

741741
// The Finality Proof should right away point to the _latest_ finalized block. Subsequently emitting
742742
// Finalization events for lower blocks is fine, because notifications are guaranteed to be
@@ -791,7 +791,7 @@ func TestFinalizingMultipleBlocks(t *testing.T) {
791791
t.Run("consensus participant mode: ingest validated blocks", func(t *testing.T) {
792792
forks, finalizationCallback, notifier := setupForksAndAssertions()
793793
err = addValidatedBlockToForks(forks, blocks[:5]) // adding [◄(1) 2] [◄(2) 4] [◄(4) 6] [◄(6) 11] [◄(11) 12]
794-
require.Nil(t, err)
794+
require.NoError(t, err)
795795
requireOnlyGenesisBlockFinalized(t, forks) // finalization should still be at the genesis block
796796

797797
require.NoError(t, forks.AddValidatedBlock(blocks[5])) // adding [◄(12) 22] should trigger finalization events
@@ -807,7 +807,7 @@ func TestFinalizingMultipleBlocks(t *testing.T) {
807807
require.NoError(t, forks.AddCertifiedBlock(toCertifiedBlock(t, blocks[1])))
808808
require.NoError(t, forks.AddCertifiedBlock(toCertifiedBlock(t, blocks[2])))
809809
require.NoError(t, forks.AddCertifiedBlock(toCertifiedBlock(t, blocks[3])))
810-
require.Nil(t, err)
810+
require.NoError(t, err)
811811
requireOnlyGenesisBlockFinalized(t, forks) // finalization should still be at the genesis block
812812

813813
// adding certified block [◄(11) 12] ◄(12) should trigger finalization events
@@ -831,7 +831,7 @@ func newForks(t *testing.T) (*Forks, *mocks.Consumer) {
831831

832832
forks, err := New(genesisBQ, finalizationCallback, notifier)
833833

834-
require.Nil(t, err)
834+
require.NoError(t, err)
835835
return forks, notifier
836836
}
837837

@@ -914,7 +914,7 @@ func toCertifiedBlock(t *testing.T, block *model.Block) *model.CertifiedBlock {
914914
BlockID: block.BlockID,
915915
}
916916
cb, err := model.NewCertifiedBlock(block, qc)
917-
require.Nil(t, err)
917+
require.NoError(t, err)
918918
return &cb
919919
}
920920

Diff for: ‎engine/common/follower/compliance_engine_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ func (s *EngineSuite) SetupTest() {
7373
s.finalized,
7474
s.core,
7575
compliance.DefaultConfig())
76-
require.Nil(s.T(), err)
76+
require.NoError(s.T(), err)
7777

7878
s.engine = eng
7979

Diff for: ‎engine/execution/computation/metrics/provider_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ func Test_ProviderPushSequential(t *testing.T) {
5959
}
6060

6161
data, err := provider.GetTransactionExecutionMetricsAfter(height)
62-
require.Nil(t, err)
62+
require.NoError(t, err)
6363
for i := 0; uint(i) < bufferSize; i++ {
6464
require.Equal(t, time.Duration(uint(i)), data[height+uint64(i)+1][0].ExecutionTime)
6565
}

0 commit comments

Comments
 (0)