bitcoin/src/test
Carl Dong 3704433c4f scripted-diff: Invoke ::AcceptToMemoryPool with chainstate
-BEGIN VERIFY SCRIPT-
find_regex='\bAcceptToMemoryPool\(' \
    && git grep -l -E "$find_regex" -- src \
        | grep -v '^src/validation\.\(cpp\|h\)$' \
        | xargs sed -i -E 's@'"$find_regex"'@\0::ChainstateActive(), @g'
-END VERIFY SCRIPT-
2021-02-18 14:49:06 -05:00
..
data wallet: Fix typo in comments; Simplify assert 2020-07-11 14:24:36 +02:00
fuzz Merge #19809: log: Prefix log messages with function name and source code location if -logsourcelocations is set 2021-02-18 14:37:51 +01:00
util scripted-diff: Invoke ::AcceptToMemoryPool with chainstate 2021-02-18 14:49:06 -05:00
addrman_tests.cpp Don't make "in" parameters look like "out"/"in-out" parameters: pass by ref to const instead of ref to non-const 2020-12-06 00:22:40 +00: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: Bump copyright headers 2020-12-31 09:45:41 +01:00
arith_uint256_tests.cpp test: Move boost/stdlib includes last 2020-04-17 06:36:04 -04:00
base32_tests.cpp refactor: replace sizeof(a)/sizeof(a[0]) by std::size (C++17) 2021-01-31 17:35:16 +01:00
base58_tests.cpp scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
base64_tests.cpp refactor: replace sizeof(a)/sizeof(a[0]) by std::size (C++17) 2021-01-31 17:35:16 +01: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 scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
blockfilter_index_tests.cpp scripted-diff: Use BlockManager::LookupBlockIndex 2021-01-28 14:15:26 -05:00
blockfilter_tests.cpp scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
bloom_tests.cpp Treat CDataStream bytes as uint8_t 2020-11-23 21:19:50 +01:00
bswap_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
checkqueue_tests.cpp refactor: remove boost::thread_group usage 2021-01-29 15:39:44 +08:00
coins_tests.cpp scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01: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 test: Add MuHash3072 unit tests 2020-12-21 19:57:28 +01:00
cuckoocache_tests.cpp refactor: replace Boost shared_mutex with std shared_mutex in cuckoocache tests 2021-02-02 12:35:40 +08: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: remove CNode::m_inbound_onion defaults for explicitness 2021-02-12 22:32:08 +01:00
descriptor_tests.cpp descriptors: Add ToNormalizedString and tests 2020-10-09 09:04:13 -04:00
flatfile_tests.cpp scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
fs_tests.cpp Introduce GetUniquePath(base) helper method to replace boost::filesystem::unique_path() which is not available in std::filesystem. 2021-02-04 11:38:09 +01:00
getarg_tests.cpp scripted-diff: replace gArgs with argsman 2020-05-28 06:22:19 -07:00
hash_tests.cpp refactor: replace sizeof(a)/sizeof(a[0]) by std::size (C++17) 2021-01-31 17:35:16 +01:00
interfaces_tests.cpp test: Remove no longer needed MakeChain calls 2020-12-07 20:46:03 -05:00
key_io_tests.cpp test: signet network selection tests 2020-09-18 10:19:42 +09:00
key_tests.cpp Fix length of R check in test/key_tests.cpp:key_signature_tests 2020-11-25 18:07:37 +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
mempool_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
merkle_tests.cpp scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
merkleblock_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
miner_tests.cpp validation: Pass in chainstate to ::CheckSequenceLocks 2021-02-18 14:43:28 -05: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 ping members 2021-02-15 16:15:51 +00:00
netbase_tests.cpp net: allow CSubNet of non-IP networks 2021-01-10 15:51:15 +01:00
pmt_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
policy_fee_tests.cpp test: Add FeeFilterRounder test 2020-06-19 09:26:59 -04:00
policyestimator_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
pow_tests.cpp scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
prevector_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
raii_event_tests.cpp scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01: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 sync: Improve CheckLastCritical() 2020-12-10 20:46:29 +02: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 time: add runtime sanity check 2021-02-17 12:26:04 +08:00
scheduler_tests.cpp refactor: remove boost::thread_group usage 2021-01-29 15:39:44 +08:00
script_p2sh_tests.cpp Only relay Taproot spends if next block has it active 2020-10-30 15:52:19 -07:00
script_standard_tests.cpp Merge #20211: Use -Wswitch for TxoutType where possible 2021-02-11 11:48:12 +01:00
script_tests.cpp test: Replace ARRAYLEN with C++11 ranged for loop 2020-10-26 14:27:33 +01:00
scriptnum10.h scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
scriptnum_tests.cpp refactor: replace sizeof(a)/sizeof(a[0]) by std::size (C++17) 2021-01-31 17:35:16 +01:00
serialize_tests.cpp Treat CDataStream bytes as uint8_t 2020-11-23 21:19:50 +01:00
settings_tests.cpp refactor: Make HexStr take a span 2020-08-06 19:41:43 +02:00
sighash_tests.cpp refactor: replace sizeof(a)/sizeof(a[0]) by std::size (C++17) 2021-01-31 17:35:16 +01:00
sigopcount_tests.cpp Replace usage of GetScriptForWitness with GetScriptForDestination 2020-08-14 08:44:42 +12:00
skiplist_tests.cpp scripted-diff: test: Move setup_common to test library 2019-11-06 11:56:41 -05:00
sock_tests.cpp test: fix sign comparison warning in socket tests 2021-02-12 10:12:00 +08:00
streams_tests.cpp Merge #20464: refactor: Treat CDataStream bytes as uint8_t 2021-02-01 15:17:28 +01:00
sync_tests.cpp refactor: remove straggling boost::mutex usage 2021-01-26 15:57:28 +08:00
system_tests.cpp scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
timedata_tests.cpp Make GetWarnings() return bilingual_str 2020-06-10 15:01:20 +03: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 bitcoin-core/gui#183: Add include for std::bind. 2021-01-26 11:14:27 +01:00
txindex_tests.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
txrequest_tests.cpp Report and verify expirations 2020-10-12 12:14:53 -07:00
txvalidation_tests.cpp scripted-diff: Invoke ::AcceptToMemoryPool with chainstate 2021-02-18 14:49:06 -05:00
txvalidationcache_tests.cpp scripted-diff: Invoke ::AcceptToMemoryPool with chainstate 2021-02-18 14:49:06 -05:00
uint256_tests.cpp uint256: Update constructors to c++11, make ONE static 2020-09-28 12:14:19 +10:00
util_tests.cpp Merge #19809: log: Prefix log messages with function name and source code location if -logsourcelocations is set 2021-02-18 14:37:51 +01: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: Invoke ::AcceptToMemoryPool with chainstate 2021-02-18 14:49:06 -05:00
validation_chainstate_tests.cpp sync: Use decltype(auto) return type for WITH_LOCK 2020-12-04 12:23:05 -05:00
validation_chainstatemanager_tests.cpp test: Add tests with maleated snapshot data 2021-02-12 07:53:40 -06:00
validation_flush_tests.cpp Pass mempool reference to chainstate constructor 2020-08-28 10:42:04 +02:00
validation_tests.cpp chainparams: add allowed assumeutxo values 2021-02-12 07:53:22 -06: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 Remove gArgs global from CreateChainParams to aid testing 2020-09-29 10:20:05 +02: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