bitcoin/src/test
Wladimir J. van der Laan 028b0d963c
Merge #13425: Moving final scriptSig construction from CombineSignatures to ProduceSignature (PSBT signer logic)
b81560029 Remove CombineSignatures and replace tests (Andrew Chow)
ed94c8b55 Replace CombineSignatures with ProduceSignature (Andrew Chow)
0422beb9b Make SignatureData able to store signatures and scripts (Andrew Chow)
b6edb4f5e Inline Sign1 and SignN (Andrew Chow)

Pull request description:

  Currently CombineSignatures is used to create the final scriptSig or an input. However ProduceSignature is capable of doing this itself. Using both CombineSignatures and ProduceSignature results in code duplication which is unnecessary.

  To move the scriptSig construction to ProduceSignatures, the SignatureData class contains two maps to hold pubkeys mapped to signatures, and script ids mapped to scripts. DataFromTransaction is extended to be able to extract signatures, their public keys, and scripts from existing ScriptSigs.

  The SignaureData are then passed down to SignStep which can use the aforementioned maps to get the signatures, pubkeys, and scripts that it needs, falling back to the actual SigningProvider and SignatureCreator if the data are not available in the SignatureData.

  Additionally, Sign1 and SignN have been removed and their functionality inlined into SignStep since Sign1 is really just a wrapper around CreateSig.

  Since ProduceSignature can produce the final scriptSig or scriptWitness by using SignatureData which has extracted data from the transaction, CombineSignatures is unnecessary as ProduceSignature is able to replicate all of CombineSignatures' functionality.

  This also furthers BIP 174 support and begins moving towards a BIP 174 style backend.

  The tests have also been updated to use the new combining methodology.

Tree-SHA512: 78cd58a4ebe37f79229bd5eee2958a0bb45cd7f36d0e993eee13ff685b3665dd76ef2dfd5f47d34678995bb587f5594100ee5f6c09b1c69ee96d3684d470d01e
2018-07-05 17:18:50 +02:00
..
data Add transaction tests for constant scriptCode 2018-05-05 04:26:13 +08:00
addrman_tests.cpp test: Fix sign for expected values 2018-04-11 13:39:41 +09:00
allocator_tests.cpp test: Fix sign for expected values 2018-04-11 13:39:41 +09:00
amount_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
arith_uint256_tests.cpp Drop uint 256 not operator 2018-06-05 02:16:24 -07:00
base32_tests.cpp Simplify Base32 and Base64 conversions 2018-03-07 07:04:07 -08:00
base58_tests.cpp Split off key_io_tests from base58_tests 2018-02-19 18:55:21 -08:00
base64_tests.cpp Simplify Base32 and Base64 conversions 2018-03-07 07:04:07 -08:00
bech32_tests.cpp Merge #12881: Minor optimizations to bech32::Decode(); add tests. 2018-05-15 12:10:34 +02:00
bip32_tests.cpp scripted-diff: Rename master key to seed 2018-05-19 11:16:00 -04:00
blockchain_tests.cpp Use bracket syntax includes ("#include <foo.h>") 2018-06-06 11:09:05 +02:00
blockencodings_tests.cpp Break circular dependency: chain -> pow -> chain 2018-05-14 18:36:39 -07:00
bloom_tests.cpp test: Fix sign for expected values 2018-04-11 13:39:41 +09:00
bswap_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
checkqueue_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
coins_tests.cpp Make CMutableTransaction constructor explicit 2018-05-04 17:40:52 -04:00
compress_tests.cpp Move compressor utility functions out of class 2018-03-21 14:17:18 -07:00
crypto_tests.cpp Specialized double sha256 for 64 byte inputs 2018-05-29 14:05:00 -07:00
cuckoocache_tests.cpp tests: Fix incorrect documentation for test case cuckoocache_hit_rate_ok 2018-06-27 19:04:26 +02:00
dbwrapper_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
denialofservice_tests.cpp tests: Fix lock-order-inversion (potential deadlock) in DoS_tests. Reported by TSAN. 2018-06-12 21:45:46 +02:00
getarg_tests.cpp Give an error and exit if there are unknown parameters 2018-05-30 11:27:50 -04:00
hash_tests.cpp test: Fix sign for expected values 2018-04-11 13:39:41 +09:00
key_io_tests.cpp Split off key_io_tests from base58_tests 2018-02-19 18:55:21 -08:00
key_tests.cpp Split key_io (address/key encodings) off from base58 2018-02-19 18:55:21 -08:00
limitedmap_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
main_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
Makefile build: add stub makefiles for easier subdir builds 2014-06-05 16:05:43 -04:00
mempool_tests.cpp tests: Drop variadic macro 2018-06-13 09:58:54 -04:00
merkle_tests.cpp [MOVEONLY] Move unused Merkle branch code to tests 2018-05-29 14:20:12 -07:00
merkleblock_tests.cpp test: Fix sign for expected values 2018-04-11 13:39:41 +09:00
miner_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
multisig_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
net_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
netbase_tests.cpp scripted-diff: Replace NET_TOR with NET_ONION 2018-07-02 16:41:13 +02:00
pmt_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
policyestimator_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
pow_tests.cpp test: Fix sign for expected values 2018-04-11 13:39:41 +09:00
prevector_tests.cpp tests: Rename test suits not following the test suite naming convention 2018-03-19 08:54:07 +01:00
raii_event_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
random_tests.cpp test: Fix sign for expected values 2018-04-11 13:39:41 +09:00
README.md [docs] Fixed outdated link with archive.is 2017-12-01 15:26:53 +01:00
reverselock_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
rpc_tests.cpp Make tests pass after 2020 2018-04-23 23:57:21 +02:00
sanity_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
scheduler_tests.cpp Avoid unintentional unsigned integer wraparounds in tests 2018-02-23 08:10:42 +01:00
script_p2sh_tests.cpp Do not use uppercase characters in source code filenames 2018-05-23 16:07:37 +02:00
script_standard_tests.cpp Add P2WSH destination helper and use it instead of manual hashing 2018-06-17 19:44:50 -07:00
script_tests.cpp Remove CombineSignatures and replace tests 2018-07-03 17:19:23 -07:00
scriptnum10.h Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
scriptnum_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
serialize_tests.cpp tests: Avoid copies of CTransaction 2018-04-11 14:59:53 -04:00
sighash_tests.cpp [MOVEONLY] Move CSCript::FindAndDelete to interpreter 2018-04-13 09:07:27 -07:00
sigopcount_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
skiplist_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
streams_tests.cpp Remove boost dependency (boost/assign/std/vector.hpp) 2018-06-27 17:45:18 +02:00
test_bitcoin.cpp Merge #13023: Fix some concurrency issues in ActivateBestChain() 2018-05-16 18:30:35 +02:00
test_bitcoin.h Add unit tests for signals generated by ProcessNewBlock() 2018-05-16 08:28:15 -04:00
test_bitcoin_fuzzy.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
test_bitcoin_main.cpp Bugfix: Include <memory> for std::unique_ptr 2018-04-02 18:31:52 +00:00
timedata_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
torcontrol_tests.cpp Declare TorReply parsing functions in torcontrol_tests 2018-05-21 10:53:18 -07:00
transaction_tests.cpp Remove CombineSignatures and replace tests 2018-07-03 17:19:23 -07:00
txindex_tests.cpp index: Remove TxIndexDB from public interface of TxIndex. 2018-06-04 19:22:28 -07:00
txvalidation_tests.cpp trivial: Fix unsuccessful typo 2017-11-21 19:14:35 +01:00
txvalidationcache_tests.cpp speed up of tx_validationcache_tests by reusing of CTransaction. 2018-06-06 06:50:25 -07:00
uint256_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
util_tests.cpp Give an error and exit if there are unknown parameters 2018-05-30 11:27:50 -04:00
validation_block_tests.cpp trivial: Mark overrides as such. 2018-05-20 09:15:39 +02:00
versionbits_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00

Compiling/running unit tests

Unit tests will be automatically compiled if dependencies were met in ./configure and tests weren't explicitly disabled.

After configuring, they can be run with make check.

To run the bitcoind tests manually, launch src/test/test_bitcoin. To recompile after a test file was modified, run make and then run the test again. If you modify a non-test file, use make -C src/test to recompile only what's needed to run the bitcoind tests.

To add more bitcoind tests, add BOOST_AUTO_TEST_CASE functions to the existing .cpp files in the test/ directory or add new .cpp files that implement new BOOST_AUTO_TEST_SUITE sections.

To run the bitcoin-qt tests manually, launch src/qt/test/test_bitcoin-qt

To add more bitcoin-qt tests, add them to the src/qt/test/ directory and the src/qt/test/test_main.cpp file.

Running individual tests

test_bitcoin has some built-in command-line arguments; for example, to run just the getarg_tests verbosely:

test_bitcoin --log_level=all --run_test=getarg_tests

... or to run just the doubledash test:

test_bitcoin --run_test=getarg_tests/doubledash

Run test_bitcoin --help for the full list.

Note on adding test cases

The sources in this directory are unit test cases. Boost includes a unit testing framework, and since bitcoin already uses boost, it makes sense to simply use this framework rather than require developers to configure some other framework (we want as few impediments to creating unit tests as possible).

The build system is setup to compile an executable called test_bitcoin that runs all of the unit tests. The main source file is called test_bitcoin.cpp. To add a new unit test file to our test suite you need to add the file to src/Makefile.test.include. The pattern is to create one test file for each class or source file for which you want to create unit tests. The file naming convention is <source_filename>_tests.cpp and such files should wrap their tests in a test suite called <source_filename>_tests. For an example of this pattern, examine uint256_tests.cpp.

For further reading, I found the following website to be helpful in explaining how the boost unit test framework works: http://www.alittlemadness.com/2009/03/31/c-unit-testing-with-boosttest/.