90232f65ae
|
||
|---|---|---|
| .. | ||
| data | ||
| Checkpoints_tests.cpp | ||
| DoS_tests.cpp | ||
| Makefile | ||
| README.md | ||
| addrman_tests.cpp | ||
| alert_tests.cpp | ||
| allocator_tests.cpp | ||
| arith_uint256_tests.cpp | ||
| base32_tests.cpp | ||
| base58_tests.cpp | ||
| base64_tests.cpp | ||
| bctest.py | ||
| bech32_tests.cpp | ||
| bip32_tests.cpp | ||
| bitcoin-util-test.py | ||
| bloom_tests.cpp | ||
| buildenv.py.in | ||
| checkblock_tests.cpp | ||
| coins_tests.cpp | ||
| compress_tests.cpp | ||
| convertbits_tests.cpp | ||
| crypto_tests.cpp | ||
| dbwrapper_tests.cpp | ||
| equihash_tests.cpp | ||
| getarg_tests.cpp | ||
| hash_tests.cpp | ||
| key_tests.cpp | ||
| main_tests.cpp | ||
| mempool_tests.cpp | ||
| miner_tests.cpp | ||
| mruset_tests.cpp | ||
| multisig_tests.cpp | ||
| netbase_tests.cpp | ||
| pmt_tests.cpp | ||
| policyestimator_tests.cpp | ||
| pow_tests.cpp | ||
| prevector_tests.cpp | ||
| raii_event_tests.cpp | ||
| reverselock_tests.cpp | ||
| rpc_tests.cpp | ||
| sanity_tests.cpp | ||
| scheduler_tests.cpp | ||
| script_P2PKH_tests.cpp | ||
| script_P2SH_tests.cpp | ||
| script_standard_tests.cpp | ||
| script_tests.cpp | ||
| scriptnum10.h | ||
| scriptnum_tests.cpp | ||
| serialize_tests.cpp | ||
| sha256compress_tests.cpp | ||
| sighash_tests.cpp | ||
| sigopcount_tests.cpp | ||
| skiplist_tests.cpp | ||
| streams_tests.cpp | ||
| test_bitcoin.cpp | ||
| test_bitcoin.h | ||
| test_random.h | ||
| test_util.cpp | ||
| test_util.h | ||
| torcontrol_tests.cpp | ||
| transaction_tests.cpp | ||
| txvalidationcache_tests.cpp | ||
| uint256_tests.cpp | ||
| univalue_tests.cpp | ||
| util_tests.cpp | ||
README.md
Notes
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, which simply includes other files that contain the actual unit tests (outside of a couple required preprocessor directives). 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 examples of this pattern, examine uint160_tests.cpp and uint256_tests.cpp.
Add the source files to /src/Makefile.test.include to add them to the build.
For further reading, I found the following website to be helpful in explaining how the boost unit test framework works: https://web.archive.org/web/20160304091452/http://www.alittlemadness.com/2009/03/31/c-unit-testing-with-boosttest/.
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.
bitcoin-util-test.py
The test directory also contains the bitcoin-util-test.py tool, which tests bitcoin utils (currently just bitcoin-tx). This test gets run automatically during the make check build process. It is also possible to run the test manually from the src directory:
test/bitcoin-util-test.py --srcdir=[current directory]