bitcoin/src/test
MarcoFalke f87d0a9d75
Merge #13534: Don't assert(foo()) where foo() has side effects
6ad0328f1c Don't assert(foo()) where foo has side effects (practicalswift)

Pull request description:

  Don't `assert(foo())` where `foo` has side effects.

  From `assert(3)`:

  > If the macro `NDEBUG` is defined at the moment `<assert.h>` was last included, the macro `assert()` generates no code, and hence does nothing at all.

  Bitcoin currently cannot be compiled without assertions, but we shouldn't rely on that.

Tree-SHA512: 28cff0c6d1c2fb612ca58c9c94142ed01c5cfd0a2fecb8e59cdb6c270374b215d952ed3491d921d84dc1b439fa49da4f0e75e080f6adcbc6b0e08be14e54c170
2018-08-13 10:02:50 -04:00
..
data trivial: correct typos 2018-08-02 21:27:17 +08:00
addrman_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
allocator_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
amount_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
arith_uint256_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
base32_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
base58_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
base64_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
bech32_tests.cpp Merge #12881: Minor optimizations to bech32::Decode(); add tests. 2018-05-15 12:10:34 +02:00
bip32_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
blockchain_tests.cpp Use bracket syntax includes ("#include <foo.h>") 2018-06-06 11:09:05 +02:00
blockencodings_tests.cpp Merge #13780: 0.17: Pre-branch maintenance 2018-08-08 13:55:27 +02:00
bloom_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
bswap_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
checkqueue_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
coins_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
compress_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
crypto_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
cuckoocache_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
dbwrapper_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
denialofservice_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
descriptor_tests.cpp Support h instead of ' in hardened descriptor paths 2018-07-27 12:21:12 -07:00
getarg_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
hash_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
key_io_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
key_tests.cpp Merge #13666: Always create signatures with Low R values 2018-08-13 12:07:20 +02:00
limitedmap_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
main_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
Makefile build: add stub makefiles for easier subdir builds 2014-06-05 16:05:43 -04:00
mempool_tests.cpp Merge #13780: 0.17: Pre-branch maintenance 2018-08-08 13:55:27 +02:00
merkle_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
merkleblock_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
miner_tests.cpp Merge #13780: 0.17: Pre-branch maintenance 2018-08-08 13:55:27 +02:00
multisig_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
net_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
netbase_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
pmt_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
policyestimator_tests.cpp Merge #13780: 0.17: Pre-branch maintenance 2018-08-08 13:55:27 +02:00
pow_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
prevector_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
raii_event_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
random_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
README.md scripted-diff: Remove trailing whitespaces 2018-07-24 20:46:23 +01:00
reverselock_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
rpc_tests.cpp Replace median fee rate with feerate percentiles 2018-08-11 15:00:17 -04:00
sanity_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
scheduler_tests.cpp Merge #13780: 0.17: Pre-branch maintenance 2018-08-08 13:55:27 +02:00
script_p2sh_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
script_standard_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
script_tests.cpp Merge #13666: Always create signatures with Low R values 2018-08-13 12:07:20 +02:00
scriptnum10.h Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
scriptnum_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
serialize_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
sighash_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
sigopcount_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
skiplist_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
streams_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
test_bitcoin.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
test_bitcoin.h Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
test_bitcoin_fuzzy.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
test_bitcoin_main.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
timedata_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
torcontrol_tests.cpp Declare TorReply parsing functions in torcontrol_tests 2018-05-21 10:53:18 -07:00
transaction_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
txindex_tests.cpp index: Remove TxIndexDB from public interface of TxIndex. 2018-06-04 19:22:28 -07:00
txvalidation_tests.cpp Don't assert(foo()) where foo has side effects 2018-07-07 10:08:49 +02:00
txvalidationcache_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
uint256_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
util_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
validation_block_tests.cpp trivial: Mark overrides as such. 2018-05-20 09:15:39 +02:00
versionbits_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00

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