BTCP-Rebase/src/test
Pieter Wuille 7dac1e5e9e
Merge #9107: Safer modify new coins
b50cd7a Fix dangerous condition in ModifyNewCoins. (Alex Morcos)
2017-01-04 11:56:17 -08:00
..
data Re-enable a blank v1 Tx JSON test 2016-12-21 13:41:47 -08:00
DoS_tests.cpp Merge #9283: A few more CTransactionRef optimizations 2017-01-04 12:23:10 +01:00
Makefile
README.md Merge `doc/unit-tests.md` into `src/test/README.md` 2016-11-02 18:19:43 +01:00
addrman_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
allocator_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
amount_tests.cpp [amount] tests: Fix off-by-one mistake 2016-04-09 15:28:22 +02:00
arith_uint256_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
base32_tests.cpp
base58_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
base64_tests.cpp
bctest.py [copyright] copyright header style uniform 2016-11-06 10:12:50 -07:00
bip32_tests.cpp add bip32 pubkey serialization 2016-04-14 20:56:33 +02:00
bitcoin-util-test.py Fix some typos 2016-11-28 16:16:37 +07:00
blockencodings_tests.cpp Merge #9283: A few more CTransactionRef optimizations 2017-01-04 12:23:10 +01:00
bloom_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
bswap_tests.cpp Uses built-in byte swap if available (Apple) and if bswap_XX is undefined. 2016-12-17 12:27:00 +09:00
buildenv.py.in Use portable #! in python scripts (/usr/bin/env) 2016-06-26 16:47:03 +03:00
coins_tests.cpp Merge #9107: Safer modify new coins 2017-01-04 11:56:17 -08:00
compress_tests.cpp
crypto_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
cuckoocache_tests.cpp Add unit tests for the CuckooCache 2016-12-14 16:02:22 -05:00
dbwrapper_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
getarg_tests.cpp
hash_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
key_tests.cpp
limitedmap_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
main_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
mempool_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
merkle_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
miner_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
multisig_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
net_tests.cpp Get rid of nType and nVersion 2016-11-07 13:56:27 -08:00
netbase_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
pmt_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
policyestimator_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
pow_tests.cpp
prevector_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
reverselock_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
rpc_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
sanity_tests.cpp
scheduler_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
script_P2SH_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
script_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
scriptnum10.h
scriptnum_tests.cpp
serialize_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
sighash_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
sigopcount_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
skiplist_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
streams_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
test_bitcoin.cpp Merge #9283: A few more CTransactionRef optimizations 2017-01-04 12:23:10 +01:00
test_bitcoin.h Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
test_bitcoin_fuzzy.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
test_random.h Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
testutil.cpp Move GetTempPath() to testutil. 2016-03-11 15:04:05 +00:00
testutil.h Move GetTempPath() to testutil. 2016-03-11 15:04:05 +00:00
timedata_tests.cpp
transaction_tests.cpp Move CTxInWitness inside CTxIn 2016-12-04 23:47:12 -08:00
txvalidationcache_tests.cpp Merge #9283: A few more CTransactionRef optimizations 2017-01-04 12:23:10 +01:00
uint256_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
univalue_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
util_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
versionbits_tests.cpp Rename the remaining main.{h,cpp} to validation.{h,cpp} 2016-12-02 09:42:51 -08:00

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

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]