elements/src/test
Wladimir J. van der Laan bd924241e7
Merge #10758: Fix some chainstate-init-order bugs.
c0025d0 Fix segfault when shutting down before fully loading (Matt Corallo)
1385697 Order chainstate init more logically. (Matt Corallo)
ff3a219 Call RewindBlockIndex even if we're about to run -reindex-chainstate (Matt Corallo)
b0f3249 More user-friendly error message if UTXO DB runs ahead of block DB (Matt Corallo)
eda888e Fix some LoadChainTip-related init-order bugs. (Matt Corallo)

Pull request description:

  This does a number of things to clean up chainstate init order,
  fixing some issues as it goes:

  * Order chainstate init more logically - first all of the
    blocktree-related loading, then coinsdb, then
    pcoinsTip/chainActive. Only create objects as needed.

  * More clearly document exactly what is and isn't called in
    -reindex and -reindex-chainstate both with comments noting
    calls as no-ops and by adding if guards.

  * Move the writing of fTxIndex to LoadBlockIndex - this fixes a
    bug introduced in d6af06d68a where
    InitBlockIndex was writing to fTxIndex which had not yet been
    checked (because LoadChainTip hadn't yet initialized the
    chainActive, which would otherwise have resulted in
    InitBlockIndex being a NOP), allowing you to modify -txindex
    without reindex, potentially corrupting your chainstate!

  * Rename InitBlockIndex to LoadGenesisBlock, which is now a more
    natural name for it. Also check mapBlockIndex instead of
    chainActive, fixing a bug where we'd write the genesis block out
    on every start.

  * Move LoadGenesisBlock further down in init. This is a more logical
    location for it, as it is after all of the blockindex-related
    loading and checking, but before any of the UTXO-related loading
    and checking.

  * Give LoadChainTip a return value - allowing it to indicate that
    the UTXO DB ran ahead of the block DB. This just provides a nicer
    error message instead of the previous mysterious
    assert(!setBlockIndexCandidates.empty()) error.

  * Calls ActivateBestChain in case we just loaded the genesis
    block in LoadChainTip, avoiding relying on the ActivateBestChain
    in ThreadImport before continuing init process.

  * Move all of the VerifyDB()-related stuff into a -reindex +
    -reindex-chainstate if guard. It couldn't do anything useful
    as chainActive.Tip() would be null at this point anyway.

Tree-SHA512: 3c96ee7ed44f4130bee3479a40c5cd99a619fda5e309c26d60b54feab9f6ec60fabab8cf47a049c9cf15e88999b2edb7f16cbe6819e97273560b201a89d90762
2017-08-01 12:58:38 +02:00
..
data Replace MAX_OPCODE for OP_NOP10. 2017-07-11 16:45:42 +09:00
addrman_tests.cpp Use the override specifier (C++11) where we expect to be overriding the virtual function of a base class 2017-06-28 02:12:06 +02:00
allocator_tests.cpp Use the override specifier (C++11) where we expect to be overriding the virtual function of a base class 2017-06-28 02:12:06 +02:00
amount_tests.cpp Consensus: Policy: MOVEONLY: Move CFeeRate out of the consensus module 2017-05-03 18:00:13 +02:00
arith_uint256_tests.cpp Fixed multiple typos 2017-06-22 19:18:10 +03:00
base32_tests.cpp Bump copyright headers to 2015 2015-12-13 18:08:39 +01:00
base58_tests.cpp Remove unused Boost includes 2017-06-09 10:25:26 +02:00
base64_tests.cpp Bump copyright headers to 2015 2015-12-13 18:08:39 +01:00
bip32_tests.cpp scripted-diff: Fully remove BOOST_FOREACH 2017-06-05 20:10:50 +02:00
blockencodings_tests.cpp scripted-diff: Use new naming style for insecure_rand* functions 2017-06-07 12:08:39 -07:00
bloom_tests.cpp Remove unused Boost includes 2017-06-09 10:25:26 +02: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
checkqueue_tests.cpp Merge #10521: Limit variable scope 2017-06-09 13:09:24 -07:00
coins_tests.cpp Simplify return values of GetCoin/HaveCoin(InCache) 2017-06-26 16:16:26 -07:00
compress_tests.cpp Bump copyright headers to 2015 2015-12-13 18:08:39 +01:00
crypto_tests.cpp Merge #10545: Use list initialization (C++11) for maps/vectors instead of boost::assign::map_list_of/list_of 2017-06-08 20:26:40 +02:00
cuckoocache_tests.cpp Remove unused Boost includes 2017-06-09 10:25:26 +02:00
dbwrapper_tests.cpp Use range based for loop 2017-07-16 17:03:33 +02:00
DoS_tests.cpp Remove unused Boost includes 2017-06-09 10:25:26 +02:00
getarg_tests.cpp scripted-diff: Remove #include <boost/foreach.hpp> 2017-06-22 03:48:52 +02:00
hash_tests.cpp scripted-diff: Use new naming style for insecure_rand* functions 2017-06-07 12:08:39 -07:00
key_tests.cpp Remove unused code 2017-03-17 04:37:43 +01:00
limitedmap_tests.cpp [Trivial] Grammar and typo correction 2017-01-22 13:18:51 +01:00
main_tests.cpp Chainparams: Get rid of CChainParams& Params(std::string) 2017-05-03 18:15:54 +02:00
Makefile build: add stub makefiles for easier subdir builds 2014-06-05 16:05:43 -04:00
mempool_tests.cpp Merge #9548: Remove min reasonable fee 2017-03-07 19:49:00 +01:00
merkle_tests.cpp scripted-diff: Use new naming style for insecure_rand* functions 2017-06-07 12:08:39 -07:00
miner_tests.cpp Simplify "bool x = y ? true : false" to "bool x = y" 2017-06-11 15:44:01 +02:00
multisig_tests.cpp scripted-diff: Remove #include <boost/foreach.hpp> 2017-06-22 03:48:52 +02:00
net_tests.cpp Use the override specifier (C++11) where we expect to be overriding the virtual function of a base class 2017-06-28 02:12:06 +02:00
netbase_tests.cpp [refactor] move SplitHostPort() into utilstrencodings 2017-07-12 17:06:15 -04:00
pmt_tests.cpp Merge #10545: Use list initialization (C++11) for maps/vectors instead of boost::assign::map_list_of/list_of 2017-06-08 20:26:40 +02:00
policyestimator_tests.cpp Remove checking of mempool min fee from estimateSmartFee. 2017-07-14 23:41:40 -04:00
pow_tests.cpp scripted-diff: Use new naming style for insecure_rand* functions 2017-06-07 12:08:39 -07:00
prevector_tests.cpp scripted-diff: Remove BOOST_REVERSE_FOREACH 2017-06-22 03:48:50 +02:00
raii_event_tests.cpp Skip RAII event tests if libevent is built without event_set_mem_functions 2017-01-28 08:04:57 +00:00
random_tests.cpp Add FastRandomContext::rand256() and ::randbytes() 2017-06-05 12:44:44 -07:00
README.md Move src/test/bitcoin-util-test.py to test/util/bitcoin-util-test.py 2017-03-20 10:40:31 -04: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 Use list initialization (C++11) for maps/vectors instead of boost::assign::map_list_of/list_of 2017-06-06 21:29:16 +02:00
sanity_tests.cpp Bump copyright headers to 2015 2015-12-13 18:08:39 +01:00
scheduler_tests.cpp [tests] Use FastRandomContext instead of boost::random::{mt19937,uniform_int_distribution} 2017-06-07 20:38:03 +02:00
script_P2SH_tests.cpp Only pass things committed to by tx's witness hash to CScriptCheck 2017-06-01 11:56:06 -07:00
script_tests.cpp Merge #10193: scripted-diff: Remove #include <boost/foreach.hpp> 2017-07-04 18:05:18 +02:00
scriptnum10.h Bump copyright headers to 2015 2015-12-13 18:08:39 +01:00
scriptnum_tests.cpp Avoid integer overflows in scriptnum tests 2017-01-12 11:52:53 -08:00
serialize_tests.cpp [trivial] Fix typos in comments 2017-01-27 21:22:35 +01:00
sighash_tests.cpp Merge #10524: [tests] Remove printf(...) 2017-06-08 09:43:09 +02:00
sigopcount_tests.cpp Remove confusing MAX_BLOCK_BASE_SIZE. 2017-07-14 19:24:17 +00:00
skiplist_tests.cpp Merge #10321: Use FastRandomContext for all tests 2017-06-07 15:12:14 -07:00
streams_tests.cpp Remove unused Boost includes 2017-06-09 10:25:26 +02:00
test_bitcoin.cpp Merge #10758: Fix some chainstate-init-order bugs. 2017-08-01 12:58:38 +02:00
test_bitcoin.h Give CMainSignals a reference to the global scheduler 2017-07-07 11:33:18 -04:00
test_bitcoin_fuzzy.cpp Switch CCoinsView and chainstate db from per-txid to per-txout 2017-06-01 12:59:38 -07:00
test_bitcoin_main.cpp Make test_bitcoin.cpp compatible with Qt Test framework 2017-03-10 15:47:41 -05:00
testutil.cpp Replace uses of boost::filesystem with fs 2017-04-03 12:32:32 +02:00
testutil.h Replace uses of boost::filesystem with fs 2017-04-03 12:32:32 +02:00
timedata_tests.cpp Refactoring: Removed using namespace <xxx> from bench/ and test/ source files. 2017-01-02 20:35:23 +09:00
torcontrol_tests.cpp torcontrol: Handle escapes in Tor QuotedStrings 2017-05-16 18:22:25 +12:00
transaction_tests.cpp Remove factor of 3 from definition of dust. 2017-07-17 07:10:03 -04:00
txvalidationcache_tests.cpp Do not shadow upper local variable state. 2017-07-08 09:30:35 +02: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 Merge #9281: Refactor: Remove using namespace <xxx> from bench/ & test/ sources 2017-01-05 11:32:05 +01:00
util_tests.cpp scripted-diff: Use new naming style for insecure_rand* functions 2017-06-07 12:08:39 -07:00
versionbits_tests.cpp Use the override specifier (C++11) where we expect to be overriding the virtual function of a base class 2017-06-28 02:12:06 +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 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/.