bitcoin

mirror of https://github.com/bitcoin/bitcoin.git synced 2025-02-27 11:56:50 +01:00

History

practicalswift 5fd864fe8a tests: Rename test suits not following the test suite naming convention The name of the fixture test suite in `src/test/foo_tests.cpp` should be `foo_tests`.		2018-03-19 08:54:07 +01:00
..
data
addrman_tests.cpp
allocator_tests.cpp
amount_tests.cpp
arith_uint256_tests.cpp
base32_tests.cpp
base58_tests.cpp
base64_tests.cpp
bech32_tests.cpp
bip32_tests.cpp
blockchain_tests.cpp	tests: Rename test suits not following the test suite naming convention	2018-03-19 08:54:07 +01:00
blockencodings_tests.cpp
bloom_tests.cpp
bswap_tests.cpp
checkqueue_tests.cpp
coins_tests.cpp
compress_tests.cpp
crypto_tests.cpp
cuckoocache_tests.cpp
dbwrapper_tests.cpp
DoS_tests.cpp
getarg_tests.cpp
hash_tests.cpp
key_io_tests.cpp
key_tests.cpp
limitedmap_tests.cpp
main_tests.cpp
Makefile
mempool_tests.cpp
merkle_tests.cpp
merkleblock_tests.cpp
miner_tests.cpp
multisig_tests.cpp
net_tests.cpp
netbase_tests.cpp
pmt_tests.cpp
policyestimator_tests.cpp
pow_tests.cpp
prevector_tests.cpp	tests: Rename test suits not following the test suite naming convention	2018-03-19 08:54:07 +01:00
raii_event_tests.cpp
random_tests.cpp
README.md
reverselock_tests.cpp
rpc_tests.cpp
sanity_tests.cpp
scheduler_tests.cpp
script_P2SH_tests.cpp
script_standard_tests.cpp
script_tests.cpp
scriptnum10.h
scriptnum_tests.cpp
serialize_tests.cpp
sighash_tests.cpp
sigopcount_tests.cpp
skiplist_tests.cpp
streams_tests.cpp
test_bitcoin.cpp
test_bitcoin.h
test_bitcoin_fuzzy.cpp
test_bitcoin_main.cpp
timedata_tests.cpp
torcontrol_tests.cpp
transaction_tests.cpp
txvalidation_tests.cpp
txvalidationcache_tests.cpp
uint256_tests.cpp
util_tests.cpp
versionbits_tests.cpp

README.md

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.

Note on adding test cases

The sources in this directory are unit test cases. Boost includes a unit testing framework, and since bitcoin 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 setup to compile an executable called test_bitcoin that runs all of the unit tests. The main source file is called test_bitcoin.cpp. 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, examine uint256_tests.cpp.

For further reading, I found the following website to be helpful in explaining how the boost unit test framework works: http://www.alittlemadness.com/2009/03/31/c-unit-testing-with-boosttest/.