Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
blockchain: Add block validation infrastructure.
This adds a full-blown testing infrastructure in order to test consensus validation rules. It is built around the idea of dynamically generating full blocks that target specific rules linked together to form a block chain. In order to properly test the rules, each test instance starts with a valid block that is then modified in the specific way needed to test a specific rule. Blocks which exercise following rules have been added for this initial version. These tests were largely ported from the original Java-based 'official' block acceptance tests as well as some additional tests available in the Core python port. It is expected that further tests can be added over time as consensus rules change. * Enough valid blocks to have a stable base of mature coinbases to spend for futher tests * Basic forking and chain reorganization * Double spends on forks * Too much proof-of-work coinbase (extending main chain, in block that forces a reorg, and in a valid fork) * Max and too many signature operations via various combinations of OP_CHECKSIG, OP_MULTISIG, OP_CHECKSIGVERIFY, and OP_MULTISIGVERIFY * Too many and max signature operations with offending sigop after invalid data push * Max and too many signature operations via pay-to-script-hash redeem scripts * Attempt to spend tx created on a different fork * Attempt to spend immature coinbase (on main chain and fork) * Max size block and block that exceeds the max size * Children of rejected blocks are either orphans or rejected * Coinbase script too small and too large * Max length coinbase script * Attempt to spend tx in blocks that failed to connect * Valid non-coinbase tx in place of coinbase * Block with no transactions * Invalid proof-of-work * Block with a timestamp too far in the future * Invalid merkle root * Invalid proof-of-work limit (bits header field) * Negative proof-of-work limit (bits header field) * Two coinbase transactions * Duplicate transactions * Spend from transaction that does not exist * Timestamp exactly at and one second after the median time * Blocks with same hash via merkle root tricks * Spend from transaction index that is out of range * Transaction that spends more that its inputs provide * Transaction with same hash as an existing tx that has not been fully spent (BIP0030) * Non-final coinbase and non-coinbase txns * Max size block with canonical encoding which exceeds max size with non-canonical encoding * Spend from transaction earlier in same block * Spend from transaction later in same block * Double spend transaction from earlier in same block * Coinbase that pays more than subsidy + fees * Coinbase that includes subsidy + fees * Invalid opcode in dead execution path * Reorganization of txns with OP_RETURN outputs * Spend of an OP_RETURN output * Transaction with multiple OP_RETURN outputs * Large max-sized block reorganization test (disabled by default since it takes a long time and a lot of memory to run) Finally, the README.md files in the main and docs directories have been updated to reflect the use of the new testing framework.
- Loading branch information
Showing
10 changed files
with
2,540 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,198 @@ | ||
| // Copyright (c) 2016 The Decred developers | ||
| // Copyright (c) 2016 The btcsuite developers | ||
| // Use of this source code is governed by an ISC | ||
| // license that can be found in the LICENSE file. | ||
|
|
||
| package blockchain_test | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "testing" | ||
|
|
||
| "github.com/btcsuite/btcd/blockchain" | ||
| "github.com/btcsuite/btcd/blockchain/fullblocktests" | ||
| "github.com/btcsuite/btcd/chaincfg" | ||
| "github.com/btcsuite/btcd/chaincfg/chainhash" | ||
| "github.com/btcsuite/btcd/wire" | ||
| "github.com/btcsuite/btcutil" | ||
| ) | ||
|
|
||
| // TestFullBlocks ensures all tests generated by the fullblocktests package | ||
| // have the expected result when processed via ProcessBlock. | ||
| func TestFullBlocks(t *testing.T) { | ||
| tests, err := fullblocktests.Generate(false) | ||
| if err != nil { | ||
| t.Fatalf("failed to generate tests: %v", err) | ||
| } | ||
|
|
||
| // Create a new database and chain instance to run tests against. | ||
| chain, teardownFunc, err := chainSetup("fullblocktest", | ||
| &chaincfg.RegressionNetParams) | ||
| if err != nil { | ||
| t.Errorf("Failed to setup chain instance: %v", err) | ||
| return | ||
| } | ||
| defer teardownFunc() | ||
|
|
||
| // testAcceptedBlock attempts to process the block in the provided test | ||
| // instance and ensures that it was accepted according to the flags | ||
| // specified in the test. | ||
| testAcceptedBlock := func(item fullblocktests.AcceptedBlock) { | ||
| blockHeight := item.Height | ||
| block := btcutil.NewBlock(item.Block) | ||
| block.SetHeight(blockHeight) | ||
| t.Logf("Testing block %s (hash %s, height %d)", | ||
| item.Name, block.Hash(), blockHeight) | ||
|
|
||
| isMainChain, isOrphan, err := chain.ProcessBlock(block, | ||
| blockchain.BFNone) | ||
| if err != nil { | ||
| t.Fatalf("block %q (hash %s, height %d) should "+ | ||
| "have been accepted: %v", item.Name, | ||
| block.Hash(), blockHeight, err) | ||
| } | ||
|
|
||
| // Ensure the main chain and orphan flags match the values | ||
| // specified in the test. | ||
| if isMainChain != item.IsMainChain { | ||
| t.Fatalf("block %q (hash %s, height %d) unexpected main "+ | ||
| "chain flag -- got %v, want %v", item.Name, | ||
| block.Hash(), blockHeight, isMainChain, | ||
| item.IsMainChain) | ||
| } | ||
| if isOrphan != item.IsOrphan { | ||
| t.Fatalf("block %q (hash %s, height %d) unexpected "+ | ||
| "orphan flag -- got %v, want %v", item.Name, | ||
| block.Hash(), blockHeight, isOrphan, | ||
| item.IsOrphan) | ||
| } | ||
| } | ||
|
|
||
| // testRejectedBlock attempts to process the block in the provided test | ||
| // instance and ensures that it was rejected with the reject code | ||
| // specified in the test. | ||
| testRejectedBlock := func(item fullblocktests.RejectedBlock) { | ||
| blockHeight := item.Height | ||
| block := btcutil.NewBlock(item.Block) | ||
| block.SetHeight(blockHeight) | ||
| t.Logf("Testing block %s (hash %s, height %d)", | ||
| item.Name, block.Hash(), blockHeight) | ||
|
|
||
| _, _, err := chain.ProcessBlock(block, blockchain.BFNone) | ||
| if err == nil { | ||
| t.Fatalf("block %q (hash %s, height %d) should not "+ | ||
| "have been accepted", item.Name, 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.(blockchain.RuleError) | ||
| if !ok { | ||
| t.Fatalf("block %q (hash %s, height %d) returned "+ | ||
| "unexpected error type -- got %T, want "+ | ||
| "blockchain.RuleError", item.Name, block.Hash(), | ||
| blockHeight, err) | ||
| } | ||
| if rerr.ErrorCode != item.RejectCode { | ||
| t.Fatalf("block %q (hash %s, height %d) does not have "+ | ||
| "expected reject code -- got %v, want %v", | ||
| item.Name, block.Hash(), blockHeight, | ||
| rerr.ErrorCode, item.RejectCode) | ||
| } | ||
| } | ||
|
|
||
| // testRejectedNonCanonicalBlock attempts to decode the block in the | ||
| // provided test instance and ensures that it failed to decode with a | ||
| // message error. | ||
| testRejectedNonCanonicalBlock := func(item fullblocktests.RejectedNonCanonicalBlock) { | ||
| headerLen := len(item.RawBlock) | ||
| if headerLen > 80 { | ||
| headerLen = 80 | ||
| } | ||
| blockHash := chainhash.DoubleHashH(item.RawBlock[0:headerLen]) | ||
| blockHeight := item.Height | ||
| t.Logf("Testing block %s (hash %s, height %d)", item.Name, | ||
| blockHash, blockHeight) | ||
|
|
||
| // Ensure there is an error due to deserializing the block. | ||
| var msgBlock wire.MsgBlock | ||
| err := msgBlock.BtcDecode(bytes.NewReader(item.RawBlock), 0) | ||
| if _, ok := err.(*wire.MessageError); !ok { | ||
| t.Fatalf("block %q (hash %s, height %d) should have "+ | ||
| "failed to decode", item.Name, blockHash, | ||
| blockHeight) | ||
| } | ||
| } | ||
|
|
||
| // testOrphanOrRejectedBlock attempts to process the block in the | ||
| // provided test instance and ensures that it was either accepted as an | ||
| // orphan or rejected with a rule violation. | ||
| testOrphanOrRejectedBlock := func(item fullblocktests.OrphanOrRejectedBlock) { | ||
| blockHeight := item.Height | ||
| block := btcutil.NewBlock(item.Block) | ||
| block.SetHeight(blockHeight) | ||
| t.Logf("Testing block %s (hash %s, height %d)", | ||
| item.Name, block.Hash(), blockHeight) | ||
|
|
||
| _, isOrphan, err := chain.ProcessBlock(block, blockchain.BFNone) | ||
| if err != nil { | ||
| // Ensure the error code is of the expected type. | ||
| if _, ok := err.(blockchain.RuleError); !ok { | ||
| t.Fatalf("block %q (hash %s, height %d) "+ | ||
| "returned unexpected error type -- "+ | ||
| "got %T, want blockchain.RuleError", | ||
| item.Name, block.Hash(), blockHeight, | ||
| err) | ||
| } | ||
| } | ||
|
|
||
| if !isOrphan { | ||
| t.Fatalf("block %q (hash %s, height %d) was accepted, "+ | ||
| "but is not considered an orphan", item.Name, | ||
| block.Hash(), blockHeight) | ||
| } | ||
| } | ||
|
|
||
| // testExpectedTip ensures the current tip of the blockchain is the | ||
| // block specified in the provided test instance. | ||
| testExpectedTip := func(item fullblocktests.ExpectedTip) { | ||
| blockHeight := item.Height | ||
| block := btcutil.NewBlock(item.Block) | ||
| block.SetHeight(blockHeight) | ||
| t.Logf("Testing tip for block %s (hash %s, height %d)", | ||
| item.Name, block.Hash(), blockHeight) | ||
|
|
||
| // Ensure hash and height match. | ||
| best := chain.BestSnapshot() | ||
| if *best.Hash != item.Block.BlockHash() || | ||
| best.Height != blockHeight { | ||
|
|
||
| t.Fatalf("block %q (hash %s, height %d) should be "+ | ||
| "the current tip -- got (hash %s, height %d)", | ||
| item.Name, block.Hash(), blockHeight, best.Hash, | ||
| best.Height) | ||
| } | ||
| } | ||
|
|
||
| for testNum, test := range tests { | ||
| for itemNum, item := range test { | ||
| switch item := item.(type) { | ||
| case fullblocktests.AcceptedBlock: | ||
| testAcceptedBlock(item) | ||
| case fullblocktests.RejectedBlock: | ||
| testRejectedBlock(item) | ||
| case fullblocktests.RejectedNonCanonicalBlock: | ||
| testRejectedNonCanonicalBlock(item) | ||
| case fullblocktests.OrphanOrRejectedBlock: | ||
| testOrphanOrRejectedBlock(item) | ||
| case fullblocktests.ExpectedTip: | ||
| testExpectedTip(item) | ||
| default: | ||
| t.Fatalf("test #%d, item #%d is not one of "+ | ||
| "the supported test instance types -- "+ | ||
| "got type: %T", testNum, itemNum, item) | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| fullblocktests | ||
| ============== | ||
|
|
||
| [] | ||
| (https://travis-ci.org/btcsuite/btcd) [![ISC License] | ||
| (http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org) | ||
| [] | ||
| (http://godoc.org/github.com/btcsuite/btcd/blockchain/fullblocktests) | ||
|
|
||
| Package fullblocktests provides a set of full block tests to be used for testing | ||
| the consensus validation rules. The tests are intended to be flexible enough to | ||
| allow both unit-style tests directly against the blockchain code as well as | ||
| integration style tests over the peer-to-peer network. To achieve that goal, | ||
| each test contains additional information about the expected result, however | ||
| that information can be ignored when doing comparison tests between two | ||
| independent versions over the peer-to-peer network. | ||
|
|
||
| This package has intentionally been designed so it can be used as a standalone | ||
| package for any projects needing to test their implementation against a full set | ||
| of blocks that excerise the consensus validation rules. | ||
|
|
||
| ## Installation and Updating | ||
|
|
||
| ```bash | ||
| $ go get -u github.com/btcsuite/btcd/blockchain/fullblocktests | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| Package fullblocktests is licensed under the [copyfree](http://copyfree.org) ISC | ||
| License. |
Oops, something went wrong.