bitcoin/src/test
Amiti Uttarwar 8d6ff46f55 scripted-diff: Rename OUTBOUND ConnectionType to OUTBOUND_FULL_RELAY
-BEGIN VERIFY SCRIPT-
sed -i 's/OUTBOUND, /OUTBOUND_FULL_RELAY, /g' src/net.h
sed -i 's/ConnectionType::OUTBOUND/ConnectionType::OUTBOUND_FULL_RELAY/g' src/test/net_tests.cpp src/test/fuzz/process_message.cpp src/test/fuzz/process_messages.cpp src/net.cpp src/test/denialofservice_tests.cpp src/net.h src/test/fuzz/net.cpp
-END VERIFY SCRIPT-
2020-09-02 13:34:58 -07:00
..
data wallet: Fix typo in comments; Simplify assert 2020-07-11 14:24:36 +02:00
fuzz scripted-diff: Rename OUTBOUND ConnectionType to OUTBOUND_FULL_RELAY 2020-09-02 13:34:58 -07:00
util Pass mempool reference to chainstate constructor 2020-08-28 10:42:04 +02:00
addrman_tests.cpp [addrman] Specify max addresses and pct when calling GetAddresses() 2020-08-12 09:22:07 +01:00
allocator_tests.cpp
amount_tests.cpp
arith_uint256_tests.cpp
base32_tests.cpp
base58_tests.cpp util: make EncodeBase58 consume Spans 2020-08-12 16:25:50 +02:00
base64_tests.cpp
bech32_tests.cpp
bip32_tests.cpp
blockchain_tests.cpp
blockencodings_tests.cpp
blockfilter_index_tests.cpp scripted-diff: Replace EnsureChainman with Assert in unit tests 2020-06-15 07:39:26 -04:00
blockfilter_tests.cpp
bloom_tests.cpp
bswap_tests.cpp
checkqueue_tests.cpp refactor: Specify boost/thread/thread.hpp explicitly 2020-06-04 10:05:54 -04:00
coins_tests.cpp refactor: Replace HexStr(o.begin(), o.end()) with HexStr(o) 2020-06-24 18:41:45 +02:00
compilerbug_tests.cpp
compress_tests.cpp
crypto_tests.cpp refactor: Make HexStr take a span 2020-08-06 19:41:43 +02:00
cuckoocache_tests.cpp
dbwrapper_tests.cpp Merge #18317: Serialization improvements step 6 (all except wallet/gui) 2020-05-20 07:30:29 -04:00
denialofservice_tests.cpp scripted-diff: Rename OUTBOUND ConnectionType to OUTBOUND_FULL_RELAY 2020-09-02 13:34:58 -07:00
descriptor_tests.cpp wallet: Fix typo in comments; Simplify assert 2020-07-11 14:24:36 +02:00
flatfile_tests.cpp
fs_tests.cpp
getarg_tests.cpp scripted-diff: replace gArgs with argsman 2020-05-28 06:22:19 -07:00
hash_tests.cpp
interfaces_tests.cpp
key_io_tests.cpp
key_tests.cpp Make Hash[160] consume range-like objects 2020-07-30 13:57:54 -07:00
limitedmap_tests.cpp
logging_tests.cpp
main.cpp
Makefile
mempool_tests.cpp
merkle_tests.cpp Make Hash[160] consume range-like objects 2020-07-30 13:57:54 -07:00
merkleblock_tests.cpp
miner_tests.cpp scripted-diff: Replace EnsureChainman with Assert in unit tests 2020-06-15 07:39:26 -04:00
multisig_tests.cpp scripted-diff: TxoutType C++11 scoped enum class 2020-06-21 06:41:55 -04:00
net_tests.cpp scripted-diff: Rename OUTBOUND ConnectionType to OUTBOUND_FULL_RELAY 2020-09-02 13:34:58 -07:00
netbase_tests.cpp net: change CNetAddr::ip to have flexible size 2020-08-24 21:50:59 +02:00
pmt_tests.cpp
policy_fee_tests.cpp test: Add FeeFilterRounder test 2020-06-19 09:26:59 -04:00
policyestimator_tests.cpp
pow_tests.cpp
prevector_tests.cpp
raii_event_tests.cpp Merge #16564: test: Always define the raii_event_tests test suite 2020-05-31 17:55:55 -04:00
random_tests.cpp Merge #18781: Add templated GetRandDuration<> 2020-05-15 08:58:49 -04:00
README.md
ref_tests.cpp
reverselock_tests.cpp
rpc_tests.cpp
sanity_tests.cpp
scheduler_tests.cpp Merge #19090: refactor: Misc scheduler cleanups 2020-06-25 09:24:58 -04:00
script_p2sh_tests.cpp
script_standard_tests.cpp Replace usage of GetScriptForWitness with GetScriptForDestination 2020-08-14 08:44:42 +12:00
script_tests.cpp Make CHash256/CHash160 output to Span 2020-07-30 13:57:54 -07:00
scriptnum10.h
scriptnum_tests.cpp
serialize_tests.cpp Make Hash[160] consume range-like objects 2020-07-30 13:57:54 -07:00
settings_tests.cpp refactor: Make HexStr take a span 2020-08-06 19:41:43 +02:00
sighash_tests.cpp refactor: Replace HexStr(o.begin(), o.end()) with HexStr(o) 2020-06-24 18:41:45 +02:00
sigopcount_tests.cpp Replace usage of GetScriptForWitness with GetScriptForDestination 2020-08-14 08:44:42 +12:00
skiplist_tests.cpp
streams_tests.cpp
sync_tests.cpp test: Add LockStackEmpty() 2020-08-02 16:42:39 +03:00
system_tests.cpp [util] add RunCommandParseJSON 2020-07-31 13:38:10 +02:00
timedata_tests.cpp Make GetWarnings() return bilingual_str 2020-06-10 15:01:20 +03:00
torcontrol_tests.cpp
transaction_tests.cpp Merge #16841: Replace GetScriptForWitness with GetScriptForDestination 2020-08-15 08:54:45 +08:00
txindex_tests.cpp
txvalidation_tests.cpp
txvalidationcache_tests.cpp Replace usage of GetScriptForWitness with GetScriptForDestination 2020-08-14 08:44:42 +12:00
uint256_tests.cpp
util_tests.cpp test: Fix 'make cov' with clang 2020-08-14 12:18:47 +03:00
util_threadnames_tests.cpp test: Set -logthreadnames in unit tests 2020-05-21 08:13:23 -04:00
validation_block_tests.cpp scripted-diff: Replace EnsureChainman with Assert in unit tests 2020-06-15 07:39:26 -04:00
validation_chainstate_tests.cpp Pass mempool reference to chainstate constructor 2020-08-28 10:42:04 +02:00
validation_chainstatemanager_tests.cpp Pass mempool reference to chainstate constructor 2020-08-28 10:42:04 +02:00
validation_flush_tests.cpp Pass mempool reference to chainstate constructor 2020-08-28 10:42:04 +02:00
validation_tests.cpp
validationinterface_tests.cpp test: Remove const to work around compiler error on xenial 2020-05-14 18:40:57 +02:00
versionbits_tests.cpp

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