bitcoin/src/test
MarcoFalke fa9819695a
test: Remove unused scheduler.h include from the common setup
The common setup is included in virtually all tests, so it should be
as slim as possible.
2020-05-28 09:00:56 -04:00
..
data Limit decimal range of numbers ParseScript accepts 2020-03-27 15:51:05 +09:00
fuzz Merge #19032: Serialization improvements: final step 2020-05-26 15:45:50 +02:00
util test: Remove unused scheduler.h include from the common setup 2020-05-28 09:00:56 -04:00
addrman_tests.cpp test: Move boost/stdlib includes last 2020-04-17 06:36:04 -04: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 test: Move boost/stdlib includes last 2020-04-17 06:36:04 -04:00
base32_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04: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 scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04: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: Bump copyright headers 2020-04-16 13:33:09 -04:00
blockchain_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
blockencodings_tests.cpp Convert blockencodings_tests to new serialization 2020-03-30 16:10:30 -07:00
blockfilter_index_tests.cpp validation: Make ProcessNewBlock*() members of ChainstateManager 2020-05-21 09:56:16 -04:00
blockfilter_tests.cpp test: Fix outstanding -Wsign-compare errors 2020-05-08 11:18:43 -07:00
bloom_tests.cpp test: Fix outstanding -Wsign-compare errors 2020-05-08 11:18:43 -07:00
bswap_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
checkqueue_tests.cpp test/checkqueue_tests: thread safety annotations 2020-05-19 16:33:10 +10:00
coins_tests.cpp Merge #18410: Docs: Improve commenting for coins.cpp|h 2020-04-22 14:23:56 +02:00
compilerbug_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
compress_tests.cpp test: Fix outstanding -Wsign-compare errors 2020-05-08 11:18:43 -07:00
crypto_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
cuckoocache_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
dbwrapper_tests.cpp Merge #18317: Serialization improvements step 6 (all except wallet/gui) 2020-05-20 07:30:29 -04:00
denialofservice_tests.cpp net: Pass chainman into PeerLogicValidation 2020-05-21 09:55:58 -04:00
descriptor_tests.cpp test: Fix outstanding -Wsign-compare errors 2020-05-08 11:18:43 -07:00
flatfile_tests.cpp test: Fix outstanding -Wsign-compare errors 2020-05-08 11:18:43 -07:00
fs_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
getarg_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
hash_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
interfaces_tests.cpp test: Verify findCommonAncestor always initializes outputs 2020-04-15 17:07:44 -04:00
key_io_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
key_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04: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 scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04: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: Bump copyright headers 2020-04-16 13:33:09 -04:00
miner_tests.cpp validation: Make ProcessNewBlock*() members of ChainstateManager 2020-05-21 09:56:16 -04:00
multisig_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
net_tests.cpp test: Move boost/stdlib includes last 2020-04-17 06:36:04 -04:00
netbase_tests.cpp test: Fix outstanding -Wsign-compare errors 2020-05-08 11:18:43 -07:00
pmt_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
policyestimator_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04: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: Bump copyright headers 2020-04-16 13:33:09 -04: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 Merge #18781: Add templated GetRandDuration<> 2020-05-15 08:58:49 -04:00
README.md doc: Explain new test logging 2020-03-31 17:11:47 -04:00
ref_tests.cpp Add util::Ref class as temporary alternative for c++17 std::any 2020-05-13 16:20:13 -04:00
reverselock_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
rpc_tests.cpp refactor: Pass NodeContext to RPC and REST methods through util::Ref 2020-05-13 16:20:13 -04:00
sanity_tests.cpp test: fix message for ECC_InitSanityCheck test 2020-04-30 16:57:46 +08:00
scheduler_tests.cpp test: Replace boost::mutex with std::mutex 2020-04-18 01:51:05 +03:00
script_p2sh_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
script_standard_tests.cpp wallet: Fix typo in assert that is compile-time true 2020-05-04 10:40:48 -04:00
script_tests.cpp refactor: Replace const char* to std::string 2020-05-22 01:40:31 +09:00
scriptnum10.h scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
scriptnum_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
serialize_tests.cpp Merge #18317: Serialization improvements step 6 (all except wallet/gui) 2020-05-20 07:30:29 -04:00
settings_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
sighash_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
sigopcount_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
skiplist_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
streams_tests.cpp test: Fix outstanding -Wsign-compare errors 2020-05-08 11:18:43 -07:00
sync_tests.cpp scripted-diff: Bump copyright of files changed in 2020 2020-01-15 02:18:00 +07:00
timedata_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
torcontrol_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
transaction_tests.cpp Remove CCoinsViewCache::GetValueIn(...) 2020-05-03 18:42:14 +00:00
txindex_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
txvalidation_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
txvalidationcache_tests.cpp Merge #18675: tests: Don't initialize PrecomputedTransactionData in txvalidationcache tests 2020-04-19 06:18:21 -04:00
uint256_tests.cpp test: Move boost/stdlib includes last 2020-04-17 06:36:04 -04:00
util_tests.cpp test: Fix outstanding -Wsign-compare errors 2020-05-08 11:18:43 -07:00
util_threadnames_tests.cpp test: Fix outstanding -Wsign-compare errors 2020-05-08 11:18:43 -07:00
validation_block_tests.cpp validation: Make ProcessNewBlock*() members of ChainstateManager 2020-05-21 09:56:16 -04:00
validation_chainstatemanager_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
validation_flush_tests.cpp test: Fix outstanding -Wsign-compare errors 2020-05-08 11:18:43 -07:00
validation_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
validationinterface_tests.cpp test: Remove const to work around compiler error on xenial 2020-05-14 18:40:57 +02:00
versionbits_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04: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 unit 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 unit tests.

To add more unit 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 GUI unit tests manually, launch src/qt/test/test_bitcoin-qt

To add more GUI unit 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 -- DEBUG_LOG_OUT

log_level controls the verbosity of the test framework, which logs when a test case is entered, for example. The DEBUG_LOG_OUT after the two dashes redirects the debug log, which would normally go to a file in the test datadir (BasicTestingSetup::m_path_root), to the standard terminal output.

... 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

make check will write to a log file foo_tests.cpp.log and display this file on failure. For running individual tests verbosely, refer to the section above.

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 any other program:

gdb src/test/test_bitcoin