lbrycrd/src/test
Wladimir J. van der Laan 11e7bdfd90
Merge #13023: Fix some concurrency issues in ActivateBestChain()
dd435ad Add unit tests for signals generated by ProcessNewBlock() (Jesse Cohen)
a3ae8e6 Fix concurrency-related bugs in ActivateBestChain (Jesse Cohen)
ecc3c4a Do not unlock cs_main in ABC unless we've actually made progress. (Matt Corallo)

Pull request description:

  Originally this PR was just to add tests around concurrency in block validation - those tests seem to have uncovered another bug in ActivateBestChain - this now fixes that bug and adds tests.

  ActivateBestChain (invoked after a new block is validated) proceeds in steps - acquiring and releasing cs_main while incrementally disconnecting and connecting blocks to sync to the most work chain known (FindMostWorkChain()). Every time cs_main is released the result of FindMostWorkChain() can change - but currently that value is cached across acquisitions of cs_main and only refreshed when an invalid chain is explored. It needs to be refreshed every time cs_main is reacquired. The test added in 6094ce7304 will occasionally fail without the commit fixing this issue 26bfdbaddb

  Original description below
  --

  After a bug discovered where UpdatedBlockTip() notifications could be triggered out of order (#12978), these unit tests check certain invariants about these signals.

  The scheduler test asserts that a SingleThreadedSchedulerClient processes callbacks fully and sequentially.

  The block validation test generates a random chain and calls ProcessNewBlock from multiple threads at random and in parallel. ValidationInterface callbacks verify that the ordering of BlockConnected BlockDisconnected and UpdatedBlockTip events occur as expected.

Tree-SHA512: 4102423a03d2ea28580c7a70add8a6bdb22ef9e33b107c3aadef80d5af02644cdfaae516c44933924717599c81701e0b96fbf9cf38696e9e41372401a5ee1f3c
2018-05-16 18:30:35 +02:00
..
data Add transaction tests for constant scriptCode 2018-05-05 04:26:13 +08:00
addrman_tests.cpp test: Fix sign for expected values 2018-04-11 13:39:41 +09:00
allocator_tests.cpp test: Fix sign for expected values 2018-04-11 13:39:41 +09:00
amount_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
arith_uint256_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
base32_tests.cpp Simplify Base32 and Base64 conversions 2018-03-07 07:04:07 -08:00
base58_tests.cpp Split off key_io_tests from base58_tests 2018-02-19 18:55:21 -08:00
base64_tests.cpp Simplify Base32 and Base64 conversions 2018-03-07 07:04:07 -08:00
bech32_tests.cpp Merge #12881: Minor optimizations to bech32::Decode(); add tests. 2018-05-15 12:10:34 +02:00
bip32_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
blockchain_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
blockencodings_tests.cpp Break circular dependency: chain -> pow -> chain 2018-05-14 18:36:39 -07:00
bloom_tests.cpp test: Fix sign for expected values 2018-04-11 13:39:41 +09:00
bswap_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
checkqueue_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
coins_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
compress_tests.cpp Move compressor utility functions out of class 2018-03-21 14:17:18 -07:00
crypto_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
cuckoocache_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
dbwrapper_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
DoS_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
getarg_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
hash_tests.cpp test: Fix sign for expected values 2018-04-11 13:39:41 +09:00
key_io_tests.cpp Split off key_io_tests from base58_tests 2018-02-19 18:55:21 -08:00
key_tests.cpp Split key_io (address/key encodings) off from base58 2018-02-19 18:55:21 -08:00
limitedmap_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
main_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
Makefile build: add stub makefiles for easier subdir builds 2014-06-05 16:05:43 -04:00
mempool_tests.cpp Add Clang thread safety analysis annotations 2018-05-05 16:51:22 +02:00
merkle_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
merkleblock_tests.cpp test: Fix sign for expected values 2018-04-11 13:39:41 +09:00
miner_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
multisig_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
net_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
netbase_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
pmt_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
policyestimator_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
pow_tests.cpp test: Fix sign for expected values 2018-04-11 13:39:41 +09:00
prevector_tests.cpp tests: Rename test suits not following the test suite naming convention 2018-03-19 08:54:07 +01:00
raii_event_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
random_tests.cpp test: Fix sign for expected values 2018-04-11 13:39:41 +09:00
README.md [docs] Fixed outdated link with archive.is 2017-12-01 15:26:53 +01:00
reverselock_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
rpc_tests.cpp Make tests pass after 2020 2018-04-23 23:57:21 +02:00
sanity_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
scheduler_tests.cpp Avoid unintentional unsigned integer wraparounds in tests 2018-02-23 08:10:42 +01:00
script_P2SH_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
script_standard_tests.cpp Do not treat bare multisig as IsMine 2018-04-19 21:05:14 -07:00
script_tests.cpp Merge #11423: [Policy] Several transaction standardness rules 2018-05-12 17:39:46 +02:00
scriptnum10.h Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
scriptnum_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
serialize_tests.cpp tests: Avoid copies of CTransaction 2018-04-11 14:59:53 -04:00
sighash_tests.cpp [MOVEONLY] Move CSCript::FindAndDelete to interpreter 2018-04-13 09:07:27 -07:00
sigopcount_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
skiplist_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
streams_tests.cpp Add native support for serializing char arrays without FLATDATA 2018-03-21 14:14:04 -07:00
test_bitcoin.cpp Merge #13023: Fix some concurrency issues in ActivateBestChain() 2018-05-16 18:30:35 +02:00
test_bitcoin.h Add unit tests for signals generated by ProcessNewBlock() 2018-05-16 08:28:15 -04:00
test_bitcoin_fuzzy.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
test_bitcoin_main.cpp Bugfix: Include <memory> for std::unique_ptr 2018-04-02 18:31:52 +00:00
timedata_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
torcontrol_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
transaction_tests.cpp Merge #11423: [Policy] Several transaction standardness rules 2018-05-12 17:39:46 +02:00
txindex_tests.cpp [test] Simple unit test for TxIndex. 2018-04-25 11:25:18 -07:00
txvalidation_tests.cpp trivial: Fix unsuccessful typo 2017-11-21 19:14:35 +01:00
txvalidationcache_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
uint256_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02:00
util_tests.cpp Merge #12963: Fix Clang Static Analyzer warnings 2018-05-14 10:45:24 -04:00
validation_block_tests.cpp Add unit tests for signals generated by ProcessNewBlock() 2018-05-16 08:28:15 -04:00
versionbits_tests.cpp Make it clear which functions that are intended to be translation unit local 2018-05-03 21:47:40 +02: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/.