bitcoin/src/test
fanquake a55904a80c
Merge bitcoin/bitcoin#21866: [Bundle 7/7] validation: Farewell, global Chainstate!
6f994882de validation: Farewell, global Chainstate! (Carl Dong)
972c5166ee qt/test: Reset chainman in ~ChainstateManager instead (Carl Dong)
6c3b5dc0c1 scripted-diff: tree-wide: Remove all review-only assertions (Carl Dong)
3e82abb8dd tree-wide: Remove stray review-only assertion (Carl Dong)
f323248aba qt/test: Use existing chainman in ::TestGUI (can be scripted-diff) (Carl Dong)
6c15de129c scripted-diff: wallet/test: Use existing chainman (Carl Dong)
ee0ab1e959 fuzz: Initialize a TestingSetup for test_one_input (Carl Dong)
0d61634c06 scripted-diff: test: Use existing chainman in unit tests (Carl Dong)
e197076219 test: Pass in CoinsTip to ValidateCheckInputsForAllFlags (Carl Dong)
4d99b61014 test/miner_tests: Pass in chain tip to CreateBlockIndex (Carl Dong)
f0dd5e6bb4 test/util: Use existing chainman in ::PrepareBlock (Carl Dong)
464c313e30 init: Use existing chainman (Carl Dong)

Pull request description:

  Based on:  #21767

  à la Mr. Sandman
  ```
  Mr. Chainman, bring me a tip (bung, bung, bung, bung)
  Make it the most work that I've ever seen (bung, bung, bung, bung)
  Rewind old tip till we're at the fork point (bung, bung, bung, bung)
  Then tell it that it's time to call Con-nectTip

  Chainman, I'm so alone (bung, bung, bung, bung)
  No local objects to call my own (bung, bung, bung, bung)
  Please make sure I have a ref
  Mr. Chainman, bring me a tip!
  ```

  This is the last bundle in the #20158 series. Thanks everyone for their diligent review.
  I would like to call attention to https://github.com/bitcoin/bitcoin/issues/21766, where a few leftover improvements were collated.

  - Remove globals:
    - `ChainstateManager g_chainman`
    - `CChainState& ChainstateActive()`
    - `CChain& ChainActive()`
  - Remove all review-only assertions.

ACKs for top commit:
  jamesob:
    reACK 6f994882de based on the contents of
  ariard:
    Code Review ACK 6f99488.
  jnewbery:
    utACK 6f994882de
  achow101:
    Code Review ACK 6f994882de
  ryanofsky:
    Code review ACK 6f994882de.

Tree-SHA512: 4052ea79360cf0efd81ad0ee3f982e1d93aab1837dcec75f875a56ceda085de078bb3099a2137935d7cc2222004ad88da94b605ef5efef35cb6bc733725debe6
2021-06-12 11:29:31 +08:00
..
data test: Add missing test for empty P2WSH redeem 2021-05-01 10:12:11 +02:00
fuzz fuzz: Initialize a TestingSetup for test_one_input 2021-06-10 15:04:39 -04:00
util Merge bitcoin/bitcoin#21866: [Bundle 7/7] validation: Farewell, global Chainstate! 2021-06-12 11:29:31 +08:00
addrman_tests.cpp p2p: allow CAddrMan::GetAddr() by network, add doxygen 2021-05-19 13:04:11 +02:00
allocator_tests.cpp test: remove BasicTestingSetup from allocator unit tests 2021-05-28 19:14:07 +08:00
amount_tests.cpp test: remove BasicTestingSetup from amount unit tests 2021-05-28 19:14:07 +08:00
arith_uint256_tests.cpp test: remove BasicTestingSetup from arith_uint256 unit tests 2021-05-28 19:14:07 +08:00
base32_tests.cpp test: remove BasicTestingSetup from base32 unit tests 2021-05-28 19:14:07 +08:00
base58_tests.cpp refactor: Remove useless extern keyword 2021-05-10 09:09:24 +02:00
base64_tests.cpp test: remove BasicTestingSetup from base64 unit tests 2021-05-28 19:14:08 +08:00
bech32_tests.cpp test: remove BasicTestingSetup from bech32 unit tests 2021-05-28 19:14:08 +08:00
bip32_tests.cpp Additional test vector for hardened derivation with leading zeros 2021-05-28 17:22:01 +03:00
blockchain_tests.cpp
blockencodings_tests.cpp scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
blockfilter_index_tests.cpp scripted-diff: test: Use existing chainman in unit tests 2021-06-10 15:04:39 -04: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 test: remove BasicTestingSetup from bswap unit tests 2021-05-28 19:14:08 +08:00
checkqueue_tests.cpp scripted-diff: remove MakeUnique<T>() 2021-03-11 13:45:14 +08:00
coins_tests.cpp scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
coinstatsindex_tests.cpp scripted-diff: test: Use existing chainman in unit tests 2021-06-10 15:04:39 -04:00
compilerbug_tests.cpp test: remove BasicTestingSetup from compilerbug unit tests 2021-05-28 19:14:08 +08:00
compress_tests.cpp refactor: Replace &foo[0] with foo.data() 2021-05-04 06:55:31 +02:00
crypto_tests.cpp refactor: Replace &foo[0] with foo.data() 2021-05-04 06:55:31 +02: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 refactor: Switch serialize to uint8_t (1/n) 2021-05-31 14:56:17 +02:00
denialofservice_tests.cpp Merge bitcoin/bitcoin#21866: [Bundle 7/7] validation: Farewell, global Chainstate! 2021-06-12 11:29:31 +08:00
descriptor_tests.cpp script: allow up to 20 keys in wsh() descriptors 2021-04-28 10:00:29 +02:00
flatfile_tests.cpp scripted-diff: Change ArgsManager.GetDataDirPath() to ArgsManager.GetDataDirBase() in tests 2021-05-24 10:29:57 +02:00
fs_tests.cpp scripted-diff: Change ArgsManager.GetDataDirPath() to ArgsManager.GetDataDirBase() in tests 2021-05-24 10:29:57 +02:00
getarg_tests.cpp scripted-diff: Replace m_args with m_local_args in getarg_tests.cpp 2021-04-18 11:59:28 +02:00
hash_tests.cpp test: remove BasicTestingSetup from hash unit tests 2021-05-28 19:14:08 +08:00
i2p_tests.cpp scripted-diff: Replace GetDataDir() calls with gArgs.GetDataDirNet() calls 2021-05-24 10:29:58 +02:00
interfaces_tests.cpp scripted-diff: test: Use existing chainman in unit tests 2021-06-10 15:04:39 -04:00
key_io_tests.cpp refactor: Remove useless extern keyword 2021-05-10 09:09:24 +02: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 test: Reset mocktime in the common setup 2021-04-14 17:38:07 +02:00
main.cpp
Makefile
mempool_tests.cpp test: Reset mocktime in the common setup 2021-04-14 17:38:07 +02:00
merkle_tests.cpp scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
merkleblock_tests.cpp test: remove BasicTestingSetup from merkleblock tests 2021-05-28 19:14:08 +08:00
miner_tests.cpp scripted-diff: test: Use existing chainman in unit tests 2021-06-10 15:04:39 -04:00
multisig_tests.cpp Make all SignatureChecker explicit about missing data 2021-03-15 17:29:39 -07:00
net_peer_eviction_tests.cpp Add unit test coverage for our onion peer eviction protection 2021-03-19 20:13:11 +01:00
net_tests.cpp p2p: remove torv2 from SetNetFromBIP155Network() 2021-05-28 01:46:29 +02:00
netbase_tests.cpp p2p: ignore torv2-in-ipv6 addresses in SetLegacyIPv6() 2021-06-03 13:36:42 +02:00
pmt_tests.cpp
policy_fee_tests.cpp test: remove BasicTestingSetup from policy_fee unit tests 2021-05-28 19:14:09 +08:00
policyestimator_tests.cpp
pow_tests.cpp scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
prevector_tests.cpp
raii_event_tests.cpp scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
random_tests.cpp
README.md
reverselock_tests.cpp test: remove BasicTestingSetup from reverse_lock unit tests 2021-05-28 19:14:09 +08:00
rpc_tests.cpp test: Reset mocktime in the common setup 2021-04-14 17:38:07 +02:00
sanity_tests.cpp compat: remove memcpy -> memmove backwards compatibility alias 2021-03-10 14:31:10 +08:00
scheduler_tests.cpp refactor: remove boost::thread_group usage 2021-01-29 15:39:44 +08:00
script_p2sh_tests.cpp Make all SignatureChecker explicit about missing data 2021-03-15 17:29:39 -07:00
script_standard_tests.cpp Add TaprootBuilder class 2021-05-24 12:14:16 -07:00
script_tests.cpp refactor: Remove useless extern keyword 2021-05-10 09:09:24 +02:00
scriptnum10.h
scriptnum_tests.cpp refactor: replace sizeof(a)/sizeof(a[0]) by std::size (C++17) 2021-01-31 17:35:16 +01:00
serfloat_tests.cpp Convert existing float encoding tests 2021-05-24 16:15:02 -07:00
serialize_tests.cpp refactor: Switch serialize to uint8_t (1/n) 2021-05-31 14:56:17 +02:00
settings_tests.cpp scripted-diff: Change ArgsManager.GetDataDirPath() to ArgsManager.GetDataDirBase() in tests 2021-05-24 10:29:57 +02:00
sighash_tests.cpp refactor: Remove useless extern keyword 2021-05-10 09:09:24 +02:00
sigopcount_tests.cpp Make all SignatureChecker explicit about missing data 2021-03-15 17:29:39 -07:00
skiplist_tests.cpp
sock_tests.cpp net: flag relevant Sock methods with [[nodiscard]] 2021-04-13 17:26:20 +02:00
streams_tests.cpp streams: Accept URef obj for VectorReader unserialize 2021-05-05 20:19:03 +02:00
sync_tests.cpp test: remove BasicTestingSetup from sync unit tests 2021-05-28 19:14:09 +08:00
system_tests.cpp configure: add --enable-external-signer 2021-02-21 16:27:10 +01:00
timedata_tests.cpp
torcontrol_tests.cpp test: remove BasicTestingSetup from torcontrol unit tests 2021-05-28 19:14:09 +08:00
transaction_tests.cpp refactor: Remove useless extern keyword 2021-05-10 09:09:24 +02:00
txindex_tests.cpp scripted-diff: test: Use existing chainman in unit tests 2021-06-10 15:04:39 -04:00
txrequest_tests.cpp Report and verify expirations 2020-10-12 12:14:53 -07:00
txvalidation_tests.cpp scripted-diff: test: Use existing chainman in unit tests 2021-06-10 15:04:39 -04:00
txvalidationcache_tests.cpp scripted-diff: test: Use existing chainman in unit tests 2021-06-10 15:04:39 -04:00
uint256_tests.cpp test: remove BasicTestingSetup from uint256 unit tests 2021-05-28 19:14:09 +08:00
util_tests.cpp util: Properly handle -noincludeconf on command line 2021-06-04 11:08:00 +02:00
util_threadnames_tests.cpp test: remove BasicTestingSetup from util_threadnames unit tests 2021-05-28 19:14:09 +08:00
validation_block_tests.cpp scripted-diff: test: Use existing chainman in unit tests 2021-06-10 15:04:39 -04: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 refactor: Avoid magic value of all-zeros in assumeutxo base_blockhash 2021-05-11 11:21:05 +02:00
validation_flush_tests.cpp Pass mempool reference to chainstate constructor 2020-08-28 10:42:04 +02:00
validation_tests.cpp fuzz: Add utxo_snapshot target 2021-05-16 11:34:27 +02:00
validationinterface_tests.cpp
versionbits_tests.cpp test: Run versionbits_sanity for all chains 2021-04-17 11:29:50 +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