lbrycrd/src/test
Wladimir J. van der Laan 38fbb575e2
Merge #16294: qt: test: Create at most one testing setup
faa1e0fb17 qt: test: Create at most one testing setup (MarcoFalke)

Pull request description:

  It is assumed that ideally only one BasicTestingSetup exists at any point in time for each process (due to use of globals).

  This assumption is violated in the GUI tests, as a testing setup is created as the first step of the `main` function and then (sometimes) another one for the following test cases.

  So, the gui tests create two testing setups:
  * `BasicTestingSetup` in `main` (added in fa4a04a5a9)
  * a testing setup for individual test cases

  Avoid that by destructing the testing setup in main after creation and then move the explicit `ECC_Stop` to the only places where it is needed (before and after `apptests`).

ACKs for top commit:
  laanwj:
    code review ACK faa1e0fb17

Tree-SHA512: b8edceb7e2a8749e1de3ea80bc20b6fb7d4390bf366bb9817206ada3dc8669a91416f4803c22a0e6c636c514e0c858dcfe04523221f8851b10deaf472f107d82
2019-07-03 13:50:08 +02:00
..
data blockfilter: Update BIP 158 test vectors. 2019-04-06 12:10:55 -07:00
fuzz tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
gen Integration of property based testing into Bitcoin Core 2018-08-27 08:51:51 -05:00
addrman_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
allocator_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
amount_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
arith_uint256_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
base32_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
base58_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
base64_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
bech32_tests.cpp scripted-diff: Rename test_bitcoin to test/setup_common 2019-04-11 10:12:36 -04:00
bip32_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
blockchain_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
blockencodings_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
blockfilter_index_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
blockfilter_tests.cpp Merge #14121: Index for BIP 157 block filters 2019-04-18 09:48:25 -04:00
bloom_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
bswap_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
checkqueue_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
coins_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
compilerbug_tests.cpp Add test for GCC bug 90348 2019-06-02 10:19:30 +02:00
compress_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
crypto_tests.cpp Fix spelling errors identified by codespell 1.15.0 2019-06-11 17:18:16 +02:00
cuckoocache_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
dbwrapper_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
denialofservice_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
descriptor_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
flatfile_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
fs_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
getarg_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
hash_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
key_io_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
key_properties.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
key_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
limitedmap_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
main.cpp test: Remove useless test_bitcoin_main.cpp 2019-02-28 15:44:02 -05:00
Makefile
mempool_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
merkle_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
merkleblock_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
miner_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
multisig_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
net_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
netbase_tests.cpp netaddress: Update CNetAddr for ORCHIDv2 2019-05-15 14:21:48 -04:00
pmt_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
policyestimator_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
pow_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
prevector_tests.cpp Merge #12324: speed up Unserialize_impl for prevector 2019-06-18 17:12:02 +02:00
raii_event_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
random_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
README.md scripted-diff: Rename test_bitcoin to test/setup_common 2019-04-11 10:12:36 -04:00
reverselock_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
rpc_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
sanity_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
scheduler_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
script_p2sh_tests.cpp Move ismine to wallet module 2019-06-19 18:06:30 -04:00
script_standard_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
script_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
scriptnum10.h tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
scriptnum_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
serialize_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
setup_common.cpp qt: test: Create at most one testing setup 2019-06-27 16:47:23 -04:00
setup_common.h tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
sighash_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
sigopcount_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
skiplist_tests.cpp Merge #15670: refactor: combine Chain::findFirstBlockWithTime/findFirstBlockWithTimeAndHeight 2019-04-19 12:03:12 -04:00
streams_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
sync_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
timedata_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
torcontrol_tests.cpp Make reasoning about dependencies easier by not including unused dependencies 2019-06-02 17:15:23 +02:00
transaction_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
txindex_tests.cpp Make reasoning about dependencies easier by not including unused dependencies 2019-06-02 17:15:23 +02:00
txvalidation_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
txvalidationcache_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
uint256_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
util.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
util.h Add unit test NextString, ForEachNoDup functions 2019-05-07 11:51:30 -04:00
util_tests.cpp tests: Reduce compilation time and unneccessary recompiles by removing unused includes in tests 2019-06-26 20:37:48 +02:00
util_threadnames_tests.cpp tests: add threadutil tests 2019-04-29 13:43:01 -04:00
validation_block_tests.cpp Merge #14193: validation: Add missing mempool locks 2019-07-02 16:29:08 +02:00
validation_tests.cpp scripted-diff: Rename test_bitcoin to test/setup_common 2019-04-11 10:12:36 -04:00
versionbits_tests.cpp Merge #13555: Tests: parameterize adjustment period in versionbits_computeblockversion 2019-05-21 08:04:11 -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 setup_common.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/.