bitcoin/src/test
Wladimir J. van der Laan 4366f61cc9
Merge #11862: Network specific conf sections
c25321f Add config changes to release notes (Anthony Towns)
5e3cbe0 [tests] Unit tests for -testnet/-regtest in [test]/[regtest] sections (Anthony Towns)
005ad26 ArgsManager: special handling for -regtest and -testnet (Anthony Towns)
608415d [tests] Unit tests for network-specific config entries (Anthony Towns)
68797e2 ArgsManager: Warn when ignoring network-specific config setting (Anthony Towns)
d1fc4d9 ArgsManager: limit some options to only apply on mainnet when in default section (Anthony Towns)
8a9817d [tests] Use regtest section in functional tests configs (Anthony Towns)
30f9407 [tests] Unit tests for config file sections (Anthony Towns)
95eb66d ArgsManager: support config file sections (Anthony Towns)
4d34fcc ArgsManager: drop m_negated_args (Anthony Towns)
3673ca3 ArgsManager: keep command line and config file arguments separate (Anthony Towns)

Pull request description:

  The weekly meeting on [2017-12-07](http://www.erisian.com.au/meetbot/bitcoin-core-dev/2017/bitcoin-core-dev.2017-12-07-19.00.log.html) discussed allowing options to bitcoin to have some sensitivity to what network is in use. @theuni suggested having sections in the config file:

      <cfields> an alternative to that would be sections in a config file. and on the
                cmdline they'd look like namespaces. so, [testnet] port=5. or -testnet::port=5.

  This approach is (more or less) supported by `boost::program_options::detail::config_file_iterator` -- when it sees a `[testnet]` section with `port=5`, it will treat that the same as "testnet.port=5". So `[testnet] port=5` (or `testnet.port=5` without the section header) in bitcoin.conf and `-testnet.port=5` on the command line.

  The other aspect to this question is possibly limiting some options so that there is no possibility of accidental cross-contamination across networks. For example, if you're using a particular wallet.dat on mainnet, you may not want to accidentally use the same wallet on testnet and risk reusing keys.

  I've set this up so that the `-addnode` and `-wallet` options are `NETWORK_ONLY`, so that if you have a bitcoin.conf:

      wallet=/secret/wallet.dat
      upnp=1

  and you run `bitcoind -testnet` or `bitcoind -regtest`, then the `wallet=` setting will be ignored, and should behave as if your bitcoin.conf had specified:

      upnp=1

      [main]
      wallet=/secret/wallet.dat

  For any `NETWORK_ONLY` options, if you're using `-testnet` or `-regtest`, you'll have to add the prefix to any command line options. This was necessary for `multiwallet.py` for instance.

  I've left the "default" options as taking precedence over network specific ones, which might be backwards. So if you have:

      maxmempool=200
      [regtest]
      maxmempool=100

  your maxmempool will still be 200 on regtest. The advantage of doing it this way is that if you have `[regtest] maxmempool=100` in bitcoin.conf, and then say `bitcoind -regtest -maxmempool=200`, the same result is probably in line with what you expect...

  The other thing to note is that I'm using the chain names from `chainparamsbase.cpp` / `ChainNameFromCommandLine`, so the sections are `[main]`, `[test]` and `[regtest]`; not `[mainnet]` or `[testnet]` as might be expected.

  Thoughts? Ping @MeshCollider @laanwj @jonasschnelli @morcos

Tree-SHA512: f00b5eb75f006189987e5c15e154a42b66ee251777768c1e185d764279070fcb7c41947d8794092b912a03d985843c82e5189871416995436a6260520fb7a4db
2018-04-16 20:52:38 +02:00
..
data Merge #12167: Make segwit failure due to CLEANSTACK violation return a SCRIPT_ERR_CLEANSTACK error code 2018-04-04 17:30:24 -07: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 Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09: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 scripted-diff: Replace #include "" with #include <> (ryanofsky) 2017-11-16 08:23:01 +13:00
bip32_tests.cpp Split key_io (address/key encodings) off from base58 2018-02-19 18:55:21 -08:00
blockchain_tests.cpp tests: Rename test suits not following the test suite naming convention 2018-03-19 08:54:07 +01:00
blockencodings_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09: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 test: Fix sign for expected values 2018-04-11 13:39:41 +09:00
coins_tests.cpp test: Fix sign for expected values 2018-04-11 13:39:41 +09:00
compress_tests.cpp Move compressor utility functions out of class 2018-03-21 14:17:18 -07:00
crypto_tests.cpp test: Fix sign for expected values 2018-04-11 13:39:41 +09:00
cuckoocache_tests.cpp Fix typos 2018-03-21 08:34:44 +02:00
dbwrapper_tests.cpp test: Fix sign for expected values 2018-04-11 13:39:41 +09:00
DoS_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09: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 test: Fix sign for expected values 2018-04-11 13:39:41 +09:00
Makefile build: add stub makefiles for easier subdir builds 2014-06-05 16:05:43 -04:00
mempool_tests.cpp test: Fix sign for expected values 2018-04-11 13:39:41 +09: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 test: Fix sign for expected values 2018-04-11 13:39:41 +09:00
multisig_tests.cpp scripted-diff: Convert 11 enums into scoped enums (C++11) 2018-03-09 15:03:40 +01:00
net_tests.cpp Merge #12859: Bugfix: Include <memory> for std::unique_ptr 2018-04-05 09:31:53 +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 test: Fix sign for expected values 2018-04-11 13:39:41 +09: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 test: Fix sign for expected values 2018-04-11 13:39:41 +09:00
script_tests.cpp scripted-diff: Convert 11 enums into scoped enums (C++11) 2018-03-09 15:03:40 +01: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 test: Fix sign for expected values 2018-04-11 13:39:41 +09:00
sighash_tests.cpp scripted-diff: Convert 11 enums into scoped enums (C++11) 2018-03-09 15:03:40 +01:00
sigopcount_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09: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 #12926: Run unit tests in parallel 2018-04-10 14:27:18 +02:00
test_bitcoin.h Bugfix: Include <memory> for std::unique_ptr 2018-04-02 18:31:52 +00:00
test_bitcoin_fuzzy.cpp Bugfix: Include <memory> for std::unique_ptr 2018-04-02 18:31:52 +00: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 test: Fix sign for expected values 2018-04-11 13:39:41 +09:00
transaction_tests.cpp scripted-diff: Convert 11 enums into scoped enums (C++11) 2018-03-09 15:03:40 +01:00
txvalidation_tests.cpp trivial: Fix unsuccessful typo 2017-11-21 19:14:35 +01:00
txvalidationcache_tests.cpp Merge #12803: Make BaseSignatureCreator a pure interface 2018-04-12 22:55:56 +02:00
uint256_tests.cpp [test] Add tests for self usage in arith_uint256 2018-03-01 11:49:36 +09:00
util_tests.cpp Merge #11862: Network specific conf sections 2018-04-16 20:52:38 +02:00
versionbits_tests.cpp scripted-diff: Convert 11 enums into scoped enums (C++11) 2018-03-09 15:03:40 +01: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/.