0
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-03-08 14:34:53 -05:00
bitcoin-core/src/test
MarcoFalke 4490871ed7
Merge #12713: Track negated options in the option parser
f7683cba7b Track negated arguments in the argument paser. (Evan Klitzke)
4f872b2450 Add additional tests for GetBoolArg() (Evan Klitzke)

Pull request description:

  This change explicitly enable tracking negated options in the option parser. A negated option is one passed with a `-no` prefix. For example, `-nofoo` is the negated form of `-foo`. Negated options were originally added in the 0.6 release.

  The change here allows code to explicitly distinguish between cases like `-nofoo` and `-foo=0`, which was not possible previously. The option parser does not have any changed semantics as a result of this change, and existing code will parse options just as it did before.

  The motivation for this change is to provide a way to disable options that are otherwise not boolean options. For example, the `-debuglogfile` option is normally interpreted as a string, where the value is the log file name. With this change a user can pass in `-nodebuglogfile` and the code can see that it was explicitly negated, and use that to disable the log file.

  This change originally split out from #12689.

Tree-SHA512: cd5a7354eb03d2d402863c7b69e512cad382781d9b8f18c1ab104fc46d45a712530818d665203082da39572c8a42313c5be09306dc2a7227cdedb20ef7314823
2018-03-30 11:43:56 -04:00
..
data Merge #10742: scripted-diff: Use scoped enumerations (C++11, "enum class") 2018-03-27 16:38:14 +02:00
addrman_tests.cpp Fix typos 2018-03-21 08:34:44 +02:00
allocator_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +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] Adding unit tests for GetDifficulty in blockchain.cpp. 2017-11-22 15:48:14 -08: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 Split key_io (address/key encodings) off from base58 2018-02-19 18:55:21 -08: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: Plug memory leaks and stack-use-after-scope 2018-02-22 14:53:14 -05:00
coins_tests.cpp Fix typos 2018-03-21 08:34:44 +02:00
compress_tests.cpp Move compressor utility functions out of class 2018-03-21 14:17:18 -07:00
crypto_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
cuckoocache_tests.cpp Fix typos 2018-03-21 08:34:44 +02:00
dbwrapper_tests.cpp Fix typos 2018-03-21 08:34:44 +02: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 Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +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 Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
Makefile
mempool_tests.cpp Fix typos 2018-03-21 08:34:44 +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 scripted-diff: Replace #include "" with #include <> (ryanofsky) 2017-11-16 08:23:01 +13:00
miner_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +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 Add native support for serializing char arrays without FLATDATA 2018-03-21 14:14:04 -07: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 Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
prevector_tests.cpp Avoid unintentional unsigned integer wraparounds in tests 2018-02-23 08:10:42 +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 Make FastRandomContext support standard C++11 RNG interface 2018-03-20 21:24:49 -07: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 Merge #11872: [rpc] createrawtransaction: Accept sorted outputs 2018-03-13 18:00:06 +01: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 Implicitly know about P2WPKH redeemscripts 2018-01-09 15:35:27 -08: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 Add native support for serializing char arrays without FLATDATA 2018-03-21 14:14:04 -07: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 Reduce variable scopes 2018-03-26 12:08:08 +02:00
test_bitcoin.h Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
test_bitcoin_fuzzy.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
test_bitcoin_main.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09: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 scripted-diff: Replace #include "" with #include <> (ryanofsky) 2017-11-16 08:23:01 +13: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 #10742: scripted-diff: Use scoped enumerations (C++11, "enum class") 2018-03-27 16:38:14 +02:00
uint256_tests.cpp Increment MIT Licence copyright header year on files modified in 2017 2018-01-03 02:26:56 +09:00
util_tests.cpp Merge #12713: Track negated options in the option parser 2018-03-30 11:43:56 -04: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/.