bitcoin/src/test
Russell Yanofsky c1694ce6bb wallet: Avoid use of Chain::Lock in importprunedfunds
This is a step toward removing the Chain::Lock class and reducing cs_main
locking.

This change only affects behavior in the case where wallet last block processed
falls behind the chain tip, in which case the "Block not found in chain" error
will be stricter and not allow importing data from a blocks between the wallet
last processed tip and the current node tip.
2020-03-31 08:36:02 -05:00
..
data Limit decimal range of numbers ParseScript accepts 2020-03-27 15:51:05 +09:00
fuzz Merge #18455: tests: Add fuzzing harness for functions/classes in flatfile.h, merkleblock.h, random.h, serialize.h and span.h 2020-03-29 10:32:05 -04:00
gen Integration of property based testing into Bitcoin Core 2018-08-27 08:51:51 -05:00
util Merge #18134: Replace std::to_string with locale-independent alternative 2020-03-25 20:11:47 +01:00
addrman_tests.cpp Replace std::to_string with locale-independent alternative 2020-03-14 12:23:01 -07:00
allocator_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
amount_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
arith_uint256_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
base32_tests.cpp tests: Add tests for decoding/parsing of base32, base64 and money strings containing NUL characters 2019-12-16 09:23:19 +00:00
base58_tests.cpp tests: Add tests for base58-decoding of std::string:s containing non-base58 characters 2019-12-12 11:01:56 +00:00
base64_tests.cpp tests: Add tests for decoding/parsing of base32, base64 and money strings containing NUL characters 2019-12-16 09:23:19 +00:00
bech32_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
bip32_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
blockchain_tests.cpp Replace std::to_string with locale-independent alternative 2020-03-14 12:23:01 -07:00
blockencodings_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
blockfilter_index_tests.cpp scripted-diff: Replace MilliSleep with UninterruptibleSleep 2020-02-21 10:06:21 -08:00
blockfilter_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
bloom_tests.cpp Merge #16978: test: Seed test RNG context for each test case, print seed 2019-11-07 10:18:40 -05:00
bswap_tests.cpp test: Tabs to spaces in all tests 2020-02-19 11:51:40 -08:00
checkqueue_tests.cpp scripted-diff: Replace MilliSleep with UninterruptibleSleep 2020-02-21 10:06:21 -08:00
coins_tests.cpp Merge #16978: test: Seed test RNG context for each test case, print seed 2019-11-07 10:18:40 -05:00
compilerbug_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
compress_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
crypto_tests.cpp test: Use char instead of unsigned char 2019-12-04 09:32:19 -05:00
cuckoocache_tests.cpp test: add missing #include to fix compiler errors 2020-01-22 17:13:53 +09:00
dbwrapper_tests.cpp test: use fs namespace in dbwrapper unicodepath test 2020-03-18 11:10:20 +08:00
denialofservice_tests.cpp Merge #18134: Replace std::to_string with locale-independent alternative 2020-03-25 20:11:47 +01:00
descriptor_tests.cpp Only cache xpubs that have a hardened last step 2020-03-07 10:13:47 -05:00
flatfile_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
fs_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
getarg_tests.cpp on startup, write config options to debug.log 2020-01-29 15:44:00 -07:00
hash_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
interfaces_tests.cpp wallet: Avoid use of Chain::Lock in importprunedfunds 2020-03-31 08:36:02 -05:00
key_io_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
key_properties.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
key_tests.cpp Replace std::to_string with locale-independent alternative 2020-03-14 12:23:01 -07:00
limitedmap_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
logging_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
main.cpp test: Show debug log on unit test failure 2020-01-02 18:00:05 -05:00
Makefile build: add stub makefiles for easier subdir builds 2014-06-05 16:05:43 -04:00
mempool_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
merkle_tests.cpp fix Typo: "merkelRoot" -> "merkleRoot" 2019-11-12 00:56:05 +08:00
merkleblock_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
miner_tests.cpp rpc: Remove mempool global from miner 2019-12-23 06:12:10 +07:00
multisig_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
net_tests.cpp Replace std::to_string with locale-independent alternative 2020-03-14 12:23:01 -07:00
netbase_tests.cpp Merge #16702: p2p: supplying and using asmap to improve IP bucketing in addrman 2020-01-29 13:55:43 +01:00
pmt_tests.cpp Merge #16978: test: Seed test RNG context for each test case, print seed 2019-11-07 10:18:40 -05:00
policyestimator_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
pow_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
prevector_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
raii_event_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
random_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
README.md doc: Add documentation for new test/lib 2019-11-06 11:56:53 -05:00
reverselock_tests.cpp sync.h: add REVERSE_LOCK 2020-03-06 23:13:31 +10:00
rpc_tests.cpp node: Use mempool from node context instead of global 2019-12-05 14:22:05 -05:00
sanity_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
scheduler_tests.cpp Merge #18289: refactor: Make scheduler methods type safe 2020-03-17 16:34:53 -04:00
script_p2sh_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
script_standard_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
script_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
scriptnum10.h scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
scriptnum_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
serialize_tests.cpp Get rid of VARINT default argument 2020-02-10 12:00:10 -08:00
settings_tests.cpp Replace std::to_string with locale-independent alternative 2020-03-14 12:23:01 -07:00
sighash_tests.cpp refactor: define a UINT256_ONE global constant 2020-01-23 16:35:08 -05:00
sigopcount_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
skiplist_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
streams_tests.cpp Merge #16978: test: Seed test RNG context for each test case, print seed 2019-11-07 10:18:40 -05:00
sync_tests.cpp scripted-diff: Bump copyright of files changed in 2020 2020-01-15 02:18:00 +07:00
timedata_tests.cpp Replace std::to_string with locale-independent alternative 2020-03-14 12:23:01 -07:00
torcontrol_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
transaction_tests.cpp Merge #17720: test: add unit test for non-standard "scriptsig-not-pushonly" txs 2020-03-24 11:12:33 -04:00
txindex_tests.cpp scheduler: don't rely on boost interrupt on shutdown 2020-03-06 23:13:31 +10:00
txvalidation_tests.cpp scripted-diff: Replace ::mempool with m_node.mempool in tests 2019-11-15 13:40:14 -05:00
txvalidationcache_tests.cpp test: rename test suite name "tx_validationcache_tests" to match filename 2020-01-27 22:44:02 +01:00
uint256_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
util_tests.cpp Merge #18270: util: Fail to parse whitespace-only strings in ParseMoney(...) (instead of parsing as zero) 2020-03-26 20:25:55 -04:00
util_threadnames_tests.cpp Replace std::to_string with locale-independent alternative 2020-03-14 12:23:01 -07:00
validation_block_tests.cpp Merge #17477: Remove the mempool's NotifyEntryAdded and NotifyEntryRemoved signals 2020-03-19 17:26:51 +01:00
validation_flush_tests.cpp test: Remove incorrect assumptions in validation_flush_tests 2020-02-19 11:52:25 -08:00
validation_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
versionbits_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00

Unit tests

The sources in this directory are unit test cases. Boost includes a unit testing framework, and since Bitcoin Core 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 set up to compile an executable called test_bitcoin that runs all of the unit tests. The main source file for the test library is found in util/setup_common.cpp.

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.

Adding test cases

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, see uint256_tests.cpp.

Logging and debugging in unit tests

To write to logs from unit tests you need to use specific message methods provided by Boost. The simplest is BOOST_TEST_MESSAGE.

For debugging you can launch the test_bitcoin executable with gdbor lldb and start debugging, just like you would with bitcoind:

gdb src/test/test_bitcoin