bitcoin/src/test
Wladimir J. van der Laan f030410e88
Merge #13697: Support output descriptors in scantxoutset
f6b7fc349c Support h instead of ' in hardened descriptor paths (Pieter Wuille)
fddea672eb Add experimental warning to scantxoutset (Jonas Schnelli)
6495849bfd [QA] Extend tests to more combinations (Pieter Wuille)
1af237faef [QA] Add xpub range tests in scantxoutset tests (Jonas Schnelli)
151600bb49 Swap in descriptors support into scantxoutset (Pieter Wuille)
0652c3284f Descriptor tests (Pieter Wuille)
fe8a7dcd78 Output descriptors module (Pieter Wuille)
e54d76044b Add simple FlatSigningProvider (Pieter Wuille)
29943a904a Add more methods to Span class (Pieter Wuille)

Pull request description:

  As promised, here is an implementation of my output descriptor concept (https://gist.github.com/sipa/e3d23d498c430bb601c5bca83523fa82) and integration within the `scantxoutset` RPC that was just added through #12196.

  It changes the RPC to use descriptors for everything; I hope the interface is simple enough to encompass all use cases. It includes support for P2PK, P2PKH, P2WPKH, P2SH, P2WSH, multisig, xpubs, xprvs, and chains of keys - combined in every possible way.

Tree-SHA512: 63b54a96e7a72f5b04a8d645b8517d43ecd6a65a41f9f4e593931ce725a8845ab0baa1e9db6a7243190d8ac841f6e7e2f520d98c539312d78f7fd687d2c7b88f
2018-08-01 20:06:17 +02:00
..
data scripted-diff: Remove trailing whitespaces 2018-07-24 20:46:23 +01: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 refactor: Avoid locking tx pool cs thrice 2018-07-29 08:04:06 -04: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 scripted-diff: Remove trailing whitespaces 2018-07-24 20:46:23 +01:00
denialofservice_tests.cpp Merge #13417: [net] Tighten scope in net_processing 2018-07-13 20:10:55 -07:00
descriptor_tests.cpp Support h instead of ' in hardened descriptor paths 2018-07-27 12:21:12 -07: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 scripted-diff: Remove trailing whitespaces 2018-07-24 20:46:23 +01: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 refactor: Avoid locking tx pool cs thrice 2018-07-29 08:04:06 -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 refactor: Avoid locking tx pool cs thrice 2018-07-29 08:04:06 -04: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 scripted-diff: Remove trailing whitespaces 2018-07-24 20:46:23 +01:00
netbase_tests.cpp doc: Adjust bitcoincore.org links 2018-07-22 10:32:38 -04: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 refactor: Avoid locking tx pool cs thrice 2018-07-29 08:04:06 -04:00
pow_tests.cpp test: Fix sign for expected values 2018-04-11 13:39:41 +09:00
prevector_tests.cpp scripted-diff: Remove trailing whitespaces 2018-07-24 20:46:23 +01:00
raii_event_tests.cpp scripted-diff: Remove trailing whitespaces 2018-07-24 20:46:23 +01:00
random_tests.cpp test: Fix sign for expected values 2018-04-11 13:39:41 +09:00
README.md scripted-diff: Remove trailing whitespaces 2018-07-24 20:46:23 +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 Add Unit Test for SingleThreadedSchedulerClient 2018-05-18 11:50:23 -04:00
script_p2sh_tests.cpp Fix AreInputsStandard test to reference the proper scriptPubKey 2018-06-28 14:41:23 -04: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 scripted-diff: Remove trailing whitespaces 2018-07-24 20:46:23 +01: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 scripted-diff: Remove trailing whitespaces 2018-07-24 20:46:23 +01: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 scripted-diff: Remove trailing whitespaces 2018-07-24 20:46:23 +01:00
test_bitcoin.cpp Merge #13417: [net] Tighten scope in net_processing 2018-07-13 20:10:55 -07:00
test_bitcoin.h Use common SetDataDir method to create temp directory in tests. 2018-07-11 23:44:12 -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 redundant unused variables 2018-07-18 09:39:31 +02: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 Removes Boost predicate.hpp dependency 2018-07-22 21:34:45 +02: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/.