blockchain: Allow named blocks in chaingen harness.

This introduces two new functions on the chaingen harness, named AcceptBlock and RejectBlock, which allow ensuring a named block is accepted or rejected, respectively, and redefines the existing Accepted and Rejected functions which only deal with the tip block in terms of the new functions. It also renames Accepted and Rejected to AcceptTipBlock and RejectTipBlock, respectively. The motivation for this change is to make it easier to test future code which will allow processing of headers and blocks independently as well as processing blocks out of order so long as their headers are already known.
decred · Mar 28, 2019 · 25deee6 · 25deee6
1 parent 213be70
commit 25deee6
Show file tree

Hide file tree

Showing 6 changed files with 111 additions and 95 deletions.
diff --git a/blockchain/agendas_test.go b/blockchain/agendas_test.go
@@ -379,7 +379,7 @@ func TestFixedSequenceLocks(t *testing.T) {
 			enableSeqLocks(tx, 0)
 		})
 	g.SaveTipCoinbaseOuts()
-	g.Accepted()
+	g.AcceptTipBlock()
 
 	// ---------------------------------------------------------------------
 	// Create block that spends from an output created in the previous
@@ -396,7 +396,7 @@ func TestFixedSequenceLocks(t *testing.T) {
 			enableSeqLocks(tx, 0)
 			b.AddTransaction(tx)
 		})
-	g.Accepted()
+	g.AcceptTipBlock()
 
 	// ---------------------------------------------------------------------
 	// Create block that involves reorganize to a sequence lock spending
@@ -420,7 +420,7 @@ func TestFixedSequenceLocks(t *testing.T) {
 			b.AddTransaction(tx)
 		})
 	g.SaveTipCoinbaseOuts()
-	g.Accepted()
+	g.AcceptTipBlock()
 	g.ExpectTip("b2")
 
 	// ---------------------------------------------------------------------
@@ -435,7 +435,7 @@ func TestFixedSequenceLocks(t *testing.T) {
 			enableSeqLocks(b.STransactions[0], 0)
 		})
 	g.SaveTipCoinbaseOuts()
-	g.Accepted()
+	g.AcceptTipBlock()
 
 	// ---------------------------------------------------------------------
 	// Create block that involves a sequence lock on a ticket.
@@ -449,7 +449,7 @@ func TestFixedSequenceLocks(t *testing.T) {
 			enableSeqLocks(b.STransactions[5], 0)
 		})
 	g.SaveTipCoinbaseOuts()
-	g.Accepted()
+	g.AcceptTipBlock()
 
 	// ---------------------------------------------------------------------
 	// Create two blocks such that the tip block involves a sequence lock
@@ -467,7 +467,7 @@ func TestFixedSequenceLocks(t *testing.T) {
 			b.AddTransaction(tx)
 		})
 	g.SaveTipCoinbaseOuts()
-	g.Accepted()
+	g.AcceptTipBlock()
 
 	outs = g.OldestCoinbaseOuts()
 	g.NextBlock("b6", nil, outs[1:], replaceFixSeqLocksVersions,
@@ -478,7 +478,7 @@ func TestFixedSequenceLocks(t *testing.T) {
 			b.AddTransaction(tx)
 		})
 	g.SaveTipCoinbaseOuts()
-	g.Accepted()
+	g.AcceptTipBlock()
 
 	// ---------------------------------------------------------------------
 	// Create block that involves a sequence lock spending from a regular
@@ -498,7 +498,7 @@ func TestFixedSequenceLocks(t *testing.T) {
 			b.AddTransaction(tx)
 		})
 	g.SaveTipCoinbaseOuts()
-	g.Accepted()
+	g.AcceptTipBlock()
 
 	// ---------------------------------------------------------------------
 	// Create block that involves a sequence lock spending from a block
@@ -512,7 +512,7 @@ func TestFixedSequenceLocks(t *testing.T) {
 	outs = g.OldestCoinbaseOuts()
 	g.NextBlock("b8", nil, outs[1:], replaceFixSeqLocksVersions)
 	g.SaveTipCoinbaseOuts()
-	g.Accepted()
+	g.AcceptTipBlock()
 
 	outs = g.OldestCoinbaseOuts()
 	g.NextBlock("b9", nil, outs[1:], replaceFixSeqLocksVersions,
@@ -523,7 +523,7 @@ func TestFixedSequenceLocks(t *testing.T) {
 			b.AddTransaction(tx)
 		})
 	g.SaveTipCoinbaseOuts()
-	g.Accepted()
+	g.AcceptTipBlock()
 
 	// ---------------------------------------------------------------------
 	// Create two blocks such that the tip block involves a sequence lock
@@ -550,7 +550,7 @@ func TestFixedSequenceLocks(t *testing.T) {
 			b.AddTransaction(tx)
 		})
 	g.SaveTipCoinbaseOuts()
-	g.Accepted()
+	g.AcceptTipBlock()
 
 	outs = g.OldestCoinbaseOuts()
 	g.NextBlock("b11", nil, outs[1:], replaceFixSeqLocksVersions,
@@ -563,5 +563,5 @@ func TestFixedSequenceLocks(t *testing.T) {
 			b.AddTransaction(tx)
 		})
 	g.SaveTipCoinbaseOuts()
-	g.Accepted()
+	g.AcceptTipBlock()
 }
diff --git a/blockchain/chain_test.go b/blockchain/chain_test.go
@@ -205,7 +205,7 @@ func TestForceHeadReorg(t *testing.T) {
 		blockName := fmt.Sprintf("bbm%d", i)
 		g.NextBlock(blockName, nil, outs[1:])
 		g.SaveTipCoinbaseOuts()
-		g.Accepted()
+		g.AcceptTipBlock()
 	}
 	g.AssertTipHeight(uint32(stakeValidationHeight) + uint32(coinbaseMaturity))
 
@@ -230,7 +230,7 @@ func TestForceHeadReorg(t *testing.T) {
 	//
 	//   ... -> b1(0)
 	g.NextBlock("b1", outs[0], ticketOuts[0])
-	g.Accepted()
+	g.AcceptTipBlock()
 
 	// Create a fork from b1 with an invalid block due to committing to an
 	// invalid number of votes.  Since verifying the header commitment is a
@@ -242,7 +242,7 @@ func TestForceHeadReorg(t *testing.T) {
 	g.NextBlock("b2bad0", outs[1], ticketOuts[1], func(b *wire.MsgBlock) {
 		b.Header.Voters++
 	})
-	g.Rejected(ErrTooManyVotes)
+	g.RejectTipBlock(ErrTooManyVotes)
 
 	// Create a fork from b1 with an invalid block due to committing to an
 	// invalid input amount.  Since verifying the fraud proof necessarily
@@ -257,7 +257,7 @@ func TestForceHeadReorg(t *testing.T) {
 	g.NextBlock("b2bad1", outs[1], ticketOuts[1], func(b *wire.MsgBlock) {
 		b.Transactions[1].TxIn[0].ValueIn--
 	})
-	g.Rejected(ErrFraudAmountIn)
+	g.RejectTipBlock(ErrFraudAmountIn)
 
 	// Create some forks from b1.  There should not be a reorg since b1 is
 	// the current tip and b2 is seen first.
@@ -270,7 +270,7 @@ func TestForceHeadReorg(t *testing.T) {
 	//               \-> b2bad1(1)
 	g.SetTip("b1")
 	g.NextBlock("b2", outs[1], ticketOuts[1])
-	g.Accepted()
+	g.AcceptTipBlock()
 
 	g.SetTip("b1")
 	g.NextBlock("b3", outs[1], ticketOuts[1])

diff --git a/blockchain/common_test.go b/blockchain/common_test.go
@@ -307,70 +307,86 @@ func newChaingenHarness(t *testing.T, params *chaincfg.Params, dbName string) (*
 	return &harness, teardownFunc
 }
 
-// Accepted processes the current tip block associated with the harness
-// generator and expects it to be accepted to the main chain.
-func (g *chaingenHarness) Accepted() {
+// AcceptBlock processes the block associated with the given name in the
+// harness generator and expects it to be accepted to the main chain.
+func (g *chaingenHarness) AcceptBlock(blockName string) {
 	g.t.Helper()
 
-	msgBlock := g.Tip()
+	msgBlock := g.BlockByName(blockName)
 	blockHeight := msgBlock.Header.Height
 	block := dcrutil.NewBlock(msgBlock)
-	g.t.Logf("Testing block %s (hash %s, height %d)", g.TipName(), block.Hash(),
+	g.t.Logf("Testing block %s (hash %s, height %d)", blockName, block.Hash(),
 		blockHeight)
 
 	forkLen, isOrphan, err := g.chain.ProcessBlock(block, BFNone)
 	if err != nil {
 		g.t.Fatalf("block %q (hash %s, height %d) should have been accepted: %v",
-			g.TipName(), block.Hash(), blockHeight, err)
+			blockName, block.Hash(), blockHeight, err)
 	}
 
 	// Ensure the main chain and orphan flags match the values specified in the
 	// test.
 	isMainChain := !isOrphan && forkLen == 0
 	if !isMainChain {
 		g.t.Fatalf("block %q (hash %s, height %d) unexpected main chain flag "+
-			"-- got %v, want true", g.TipName(), block.Hash(), blockHeight,
+			"-- got %v, want true", blockName, block.Hash(), blockHeight,
 			isMainChain)
 	}
 	if isOrphan {
 		g.t.Fatalf("block %q (hash %s, height %d) unexpected orphan flag -- "+
-			"got %v, want false", g.TipName(), block.Hash(), blockHeight,
+			"got %v, want false", blockName, block.Hash(), blockHeight,
 			isOrphan)
 	}
 }
 
-// Rejected expects the current tip block associated with the harness generator
-// to be rejected with the provided error code.
-func (g *chaingenHarness) Rejected(code ErrorCode) {
+// AcceptTipBlock processes the current tip block associated with the harness
+// generator and expects it to be accepted to the main chain.
+func (g *chaingenHarness) AcceptTipBlock() {
 	g.t.Helper()
 
-	msgBlock := g.Tip()
+	g.AcceptBlock(g.TipName())
+}
+
+// RejectBlock expects the block associated with the given name in the harness
+// generator to be rejected with the provided error code.
+func (g *chaingenHarness) RejectBlock(blockName string, code ErrorCode) {
+	g.t.Helper()
+
+	msgBlock := g.BlockByName(blockName)
 	blockHeight := msgBlock.Header.Height
 	block := dcrutil.NewBlock(msgBlock)
-	g.t.Logf("Testing block %s (hash %s, height %d)", g.TipName(), block.Hash(),
+	g.t.Logf("Testing block %s (hash %s, height %d)", blockName, block.Hash(),
 		blockHeight)
 
 	_, _, err := g.chain.ProcessBlock(block, BFNone)
 	if err == nil {
 		g.t.Fatalf("block %q (hash %s, height %d) should not have been accepted",
-			g.TipName(), block.Hash(), blockHeight)
+			blockName, block.Hash(), blockHeight)
 	}
 
 	// Ensure the error code is of the expected type and the reject code matches
 	// the value specified in the test instance.
 	rerr, ok := err.(RuleError)
 	if !ok {
 		g.t.Fatalf("block %q (hash %s, height %d) returned unexpected error "+
-			"type -- got %T, want blockchain.RuleError", g.TipName(),
+			"type -- got %T, want blockchain.RuleError", blockName,
 			block.Hash(), blockHeight, err)
 	}
 	if rerr.ErrorCode != code {
 		g.t.Fatalf("block %q (hash %s, height %d) does not have expected reject "+
-			"code -- got %v, want %v", g.TipName(), block.Hash(), blockHeight,
+			"code -- got %v, want %v", blockName, block.Hash(), blockHeight,
 			rerr.ErrorCode, code)
 	}
 }
 
+// RejectTipBlock expects the current tip block associated with the harness
+// generator to be rejected with the provided error code.
+func (g *chaingenHarness) RejectTipBlock(code ErrorCode) {
+	g.t.Helper()
+
+	g.RejectBlock(g.TipName(), code)
+}
+
 // ExpectTip expects the provided block to be the current tip of the main chain
 // associated with the harness generator.
 func (g *chaingenHarness) ExpectTip(tipName string) {
@@ -554,7 +570,7 @@ func (g *chaingenHarness) AdvanceToStakeValidationHeight() {
 	//   genesis -> bfb
 	g.CreatePremineBlock("bfb", 0)
 	g.AssertTipHeight(1)
-	g.Accepted()
+	g.AcceptTipBlock()
 
 	// ---------------------------------------------------------------------
 	// Generate enough blocks to have mature coinbase outputs to work with.
@@ -566,7 +582,7 @@ func (g *chaingenHarness) AdvanceToStakeValidationHeight() {
 		blockName := fmt.Sprintf("bm%d", i)
 		g.NextBlock(blockName, nil, nil)
 		g.SaveTipCoinbaseOuts()
-		g.Accepted()
+		g.AcceptTipBlock()
 	}
 	g.AssertTipHeight(uint32(coinbaseMaturity) + 1)
 
@@ -586,7 +602,7 @@ func (g *chaingenHarness) AdvanceToStakeValidationHeight() {
 		blockName := fmt.Sprintf("bse%d", i)
 		g.NextBlock(blockName, nil, ticketOuts)
 		g.SaveTipCoinbaseOuts()
-		g.Accepted()
+		g.AcceptTipBlock()
 	}
 	g.AssertTipHeight(uint32(stakeEnabledHeight))
 
@@ -617,7 +633,7 @@ func (g *chaingenHarness) AdvanceToStakeValidationHeight() {
 		blockName := fmt.Sprintf("bsv%d", i)
 		g.NextBlock(blockName, nil, ticketOuts)
 		g.SaveTipCoinbaseOuts()
-		g.Accepted()
+		g.AcceptTipBlock()
 	}
 	g.AssertTipHeight(uint32(stakeValidationHeight))
 }
@@ -681,7 +697,7 @@ func (g *chaingenHarness) AdvanceFromSVHToActiveAgenda(voteID string) {
 			chaingen.ReplaceBlockVersion(int32(deploymentVer)),
 			chaingen.ReplaceVoteVersions(deploymentVer))
 		g.SaveTipCoinbaseOuts()
-		g.Accepted()
+		g.AcceptTipBlock()
 	}
 	g.TestThresholdState(voteID, ThresholdStarted)
 
@@ -706,7 +722,7 @@ func (g *chaingenHarness) AdvanceFromSVHToActiveAgenda(voteID string) {
 			chaingen.ReplaceStakeVersion(deploymentVer),
 			chaingen.ReplaceVotes(vbPrevBlockValid|yesChoice.Bits, deploymentVer))
 		g.SaveTipCoinbaseOuts()
-		g.Accepted()
+		g.AcceptTipBlock()
 	}
 	g.AssertTipHeight(uint32(stakeValidationHeight + ruleChangeInterval*2 - 1))
 	g.AssertBlockVersion(int32(deploymentVer))
@@ -734,7 +750,7 @@ func (g *chaingenHarness) AdvanceFromSVHToActiveAgenda(voteID string) {
 			chaingen.ReplaceVoteVersions(deploymentVer),
 		)
 		g.SaveTipCoinbaseOuts()
-		g.Accepted()
+		g.AcceptTipBlock()
 	}
 	g.AssertTipHeight(uint32(stakeValidationHeight + ruleChangeInterval*3 - 1))
 	g.AssertBlockVersion(int32(deploymentVer))