bitcoin/src/test
Wladimir J. van der Laan 224c19645f
Merge #17388: Add missing newline in util_ChainMerge test
3645e4ca00 Add missing newline in util_ChainMerge test (Russell Yanofsky)

Pull request description:

  This was causing a lot of test cases not not be very meaningful because
  multiple configuration options were combined into one line.

  The changes in test output with this fix make sense and look like:

  ```diff
  - testnet=1 regtest=1 || test
  + testnet=1 regtest=1 || error: Invalid combination of -regtest, -testnet and -chain. Can use at most one.
  ```

  Issue was reported and debugged by
  Wladimir J. van der Laan <laanwj@protonmail.com> in
  https://github.com/bitcoin/bitcoin/pull/17385#issuecomment-550033222

  <!--
  *** Please remove the following help text before submitting: ***

  Pull requests without a rationale and clear improvement may be closed
  immediately.
  -->

  <!--
  Please provide clear motivation for your patch and explain how it improves
  Bitcoin Core user experience or Bitcoin Core developer experience
  significantly:

  * Any test improvements or new tests that improve coverage are always welcome.
  * All other changes should have accompanying unit tests (see `src/test/`) or
    functional tests (see `test/`). Contributors should note which tests cover
    modified code. If no tests exist for a region of modified code, new tests
    should accompany the change.
  * Bug fixes are most welcome when they come with steps to reproduce or an
    explanation of the potential issue as well as reasoning for the way the bug
    was fixed.
  * Features are welcome, but might be rejected due to design or scope issues.
    If a feature is based on a lot of dependencies, contributors should first
    consider building the system outside of Bitcoin Core, if possible.
  * Refactoring changes are only accepted if they are required for a feature or
    bug fix or otherwise improve developer experience significantly. For example,
    most "code style" refactoring changes require a thorough explanation why they
    are useful, what downsides they have and why they *significantly* improve
    developer experience or avoid serious programming bugs. Note that code style
    is often a subjective matter. Unless they are explicitly mentioned to be
    preferred in the [developer notes](/doc/developer-notes.md), stylistic code
    changes are usually rejected.
  -->

  <!--
  Bitcoin Core has a thorough review process and even the most trivial change
  needs to pass a lot of eyes and requires non-zero or even substantial time
  effort to review. There is a huge lack of active reviewers on the project, so
  patches often sit for a long time.
  -->

ACKs for top commit:
  laanwj:
    ACK 3645e4ca00
  practicalswift:
    ACK 3645e4ca00 -- diff looks correct

Tree-SHA512: ca5bde9b9f553811d4827113f4880d15d7b8f4f1455b95bbf34c9a1512fdd53062f1a2133c50d9b54f94160a1ee77a54bc82681a5f3bf25d2b0d01f8a8e95165
2019-11-06 09:53:38 +01:00
..
data Added comments referencing multiple CVEs in tests and production code. 2019-06-02 10:25:03 -07:00
fuzz tests: Add fuzzing harness for Bech32 encoding/decoding 2019-11-05 09:23:44 +00:00
gen Integration of property based testing into Bitcoin Core 2018-08-27 08:51:51 -05:00
lib test: Add ASSERT_DEBUG_LOG to unit test framework 2019-11-04 10:42:33 -05:00
util tests: Move CaseInsensitiveEqual to test/util/str 2019-11-05 09:23:44 +00:00
addrman_tests.cpp test: remove redundant setup in addrman_tests 2019-07-18 17:31:46 -07: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 tests: Move CaseInsensitiveEqual to test/util/str 2019-11-05 09:23:44 +00:00
bip32_tests.cpp refactor: Remove unused CExt{Pub,}Key (de)serialization methods 2019-10-22 00:07:31 +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 test: Add RegTestingSetup to setup_common 2019-10-30 14:12:45 -04:00
blockfilter_index_tests.cpp Merge #17228: test: Add RegTestingSetup to setup_common 2019-11-04 08:16:54 -05: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 Add unit testing for the CompressScript functions 2019-10-23 13:50:18 -04:00
crypto_tests.cpp Add ChaCha20Poly1305@Bitcoin tests 2019-07-03 11:48:48 +02:00
cuckoocache_tests.cpp doc: Doxygen-friendly CuckooCache comments 2019-10-10 15:47:39 -04:00
dbwrapper_tests.cpp Add testcase to simulate bitcoin schema in leveldb 2019-10-21 11:15:57 -04:00
denialofservice_tests.cpp p2p: Remove BIP61 reject messages 2019-10-02 10:39:14 -04:00
descriptor_tests.cpp Add sortedmulti descriptor and unit tests 2019-10-08 13:56:56 -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: Fix fs_tests for unknown locales 2019-10-15 09:21:41 +00:00
getarg_tests.cpp test: Make tests arg type specific 2019-07-31 21:58:14 +03: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 Remove unused includes 2019-10-15 22:56:43 +00: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
logging_tests.cpp logs: add BCLog::Timer and related macros 2019-11-04 14:13:52 -05:00
main.cpp test: Remove useless test_bitcoin_main.cpp 2019-02-28 15:44:02 -05:00
Makefile build: add stub makefiles for easier subdir builds 2014-06-05 16:05:43 -04:00
mempool_tests.cpp test: add "diamond" unit test to MempoolAncestryTests 2019-11-04 15:05:47 +01:00
merkle_tests.cpp test: add some unit tests for merkle.cpp 2019-09-16 23:36:43 +04:30
merkleblock_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
miner_tests.cpp refactor: pcoinsTip -> CChainState::CoinsTip() 2019-08-06 13:13:06 -04:00
multisig_tests.cpp Move various SigningProviders to signingprovider.{cpp,h} 2019-07-09 16:20:18 -04:00
net_tests.cpp Merge #17243: p2p: add PoissonNextSend method that returns mockable time 2019-11-05 12:38:28 -05:00
netbase_tests.cpp Make whitebind/whitelist permissions more flexible 2019-08-11 11:33:27 +09:00
pmt_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
policyestimator_tests.cpp Remove unused includes 2019-10-15 22:56:43 +00:00
pow_tests.cpp Remove unused includes 2019-10-15 22:56:43 +00: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 doc: Improve test READMEs 2019-09-26 19:04:58 +02:00
reverselock_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
rpc_tests.cpp Pass NodeContext, ConnMan, BanMan references more places 2019-10-28 10:30:51 -04: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 test: fix script_p2sh_tests OP_PUSHBACK2/4 missing 2019-10-25 12:13:19 -04:00
script_standard_tests.cpp Move various SigningProviders to signingprovider.{cpp,h} 2019-07-09 16:20:18 -04:00
script_tests.cpp refactor: test/bench: dedup Build{Crediting,Spending}Transaction() 2019-10-23 01:59:32 +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 Support serialization of std::vector<bool> 2019-08-26 11:36:33 -07:00
setup_common.cpp test: Reset global args between test suites 2019-11-04 10:59:55 -05:00
setup_common.h test: Add RegTestingSetup to setup_common 2019-10-30 14:12:45 -04:00
sighash_tests.cpp [validation] Add CValidationState subclasses 2019-10-29 15:46:45 -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 Remove unused includes 2019-10-15 22:56:43 +00:00
streams_tests.cpp Remove unused includes 2019-10-15 22:56:43 +00:00
sync_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
timedata_tests.cpp test: Add ASSERT_DEBUG_LOG to unit test framework 2019-11-04 10:42:33 -05: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 Merge #15921: validation: Tidy up ValidationState interface 2019-10-30 15:37:34 +01:00
txindex_tests.cpp Remove unused includes 2019-10-15 22:56:43 +00:00
txvalidation_tests.cpp [validation] Remove fMissingInputs from AcceptToMemoryPool() 2019-10-29 15:46:45 -04:00
txvalidationcache_tests.cpp [validation] Remove fMissingInputs from AcceptToMemoryPool() 2019-10-29 15:46:45 -04: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 Refactor: Split up CWallet and LegacyScriptPubKeyMan and classes 2019-10-25 19:20:24 -04:00
util.h Add unit test NextString, ForEachNoDup functions 2019-05-07 11:51:30 -04:00
util_tests.cpp Add missing newline in util_ChainMerge test 2019-11-05 17:25:16 -05:00
util_threadnames_tests.cpp tests: add threadutil tests 2019-04-29 13:43:01 -04:00
validation_block_tests.cpp Merge #17228: test: Add RegTestingSetup to setup_common 2019-11-04 08:16:54 -05: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

Unit tests

The sources in this directory are unit test cases. Boost includes a unit testing framework, and since Bitcoin Core 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 set up to compile an executable called test_bitcoin that runs all of the unit tests. The main source file is called setup_common.cpp.

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.

Adding test cases

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, see uint256_tests.cpp.

Logging and debugging in unit tests

To write to logs from unit tests you need to use specific message methods provided by Boost. The simplest is BOOST_TEST_MESSAGE.

For debugging you can launch the test_bitcoin executable with gdbor lldb and start debugging, just like you would with bitcoind:

gdb src/test/test_bitcoin