History

Wladimir J. van der Laan 93c85d458a Merge #7524 : BIP-112: Mempool-only CHECKSEQUENCEVERIFY `a381076` Code style fix. (BtcDrak) `c3c3752` Separate CheckLockTime() and CheckSequence() logic (BtcDrak) `53e53a3` BIP112: Implement CHECKSEQUENCEVERIFY (Mark Friedenbach)		2016-02-16 10:46:34 +01:00
..
data	BIP112: Implement CHECKSEQUENCEVERIFY	2016-02-14 11:29:38 +00:00
accounting_tests.cpp
addrman_tests.cpp	Increase test coverage for addrman and addrinfo	2016-01-27 10:50:58 -05:00
alert_tests.cpp
allocator_tests.cpp
arith_uint256_tests.cpp
base32_tests.cpp
base58_tests.cpp
base64_tests.cpp
bctest.py
bip32_tests.cpp
bitcoin-util-test.py
bloom_tests.cpp
buildenv.py.in
Checkpoints_tests.cpp
coins_tests.cpp
compress_tests.cpp
crypto_tests.cpp
dbwrapper_tests.cpp
DoS_tests.cpp	Merge pull request #7205	2016-01-05 14:11:40 +01:00
getarg_tests.cpp
hash_tests.cpp
key_tests.cpp
limitedmap_tests.cpp
main_tests.cpp
Makefile
mempool_tests.cpp
merkle_tests.cpp	Typo fixes in comments	2016-01-17 11:03:56 +00:00
miner_tests.cpp	Merge #7184 : Implement SequenceLocks functions for BIP 68	2016-02-12 17:03:46 +01:00
multisig_tests.cpp	Bump copyright headers to 2014	2016-01-05 21:01:39 +01:00
netbase_tests.cpp
pmt_tests.cpp
policyestimator_tests.cpp
pow_tests.cpp
prevector_tests.cpp
README.md
reverselock_tests.cpp	c++11: don't throw from the reverselock destructor	2016-01-05 17:17:29 -05:00
rpc_tests.cpp	move rpc* to rpc/	2016-01-21 08:36:55 +11:00
rpc_wallet_tests.cpp	move rpc* to rpc/	2016-01-21 08:36:55 +11:00
sanity_tests.cpp
scheduler_tests.cpp
script_P2SH_tests.cpp	Get rid of inaccurate ScriptSigArgsExpected	2016-02-01 15:28:25 +01:00
script_tests.cpp	Merge #7184 : Implement SequenceLocks functions for BIP 68	2016-02-12 17:03:46 +01:00
scriptnum10.h
scriptnum_tests.cpp
serialize_tests.cpp
sighash_tests.cpp
sigopcount_tests.cpp
skiplist_tests.cpp
streams_tests.cpp
test_bitcoin.cpp	[RPC, Wallet] Move RPC dispatch table registration to wallet/ code	2016-01-20 15:03:25 +01:00
test_bitcoin.h	Add missing copyright headers	2016-01-05 21:34:15 +01:00
timedata_tests.cpp
transaction_tests.cpp	BIP112: Implement CHECKSEQUENCEVERIFY	2016-02-14 11:29:38 +00:00
txvalidationcache_tests.cpp	Move maxTxFee out of mempool	2016-02-02 20:08:51 +01:00
uint256_tests.cpp
univalue_tests.cpp	Add missing copyright headers	2016-01-05 21:34:15 +01:00
util_tests.cpp	test: test leading space for ParseHex	2016-02-15 17:14:30 +01:00

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: 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.