dash/src/test
MarcoFalke ca7ee7c278 Merge #16658: validation: Rename CheckInputs to CheckInputScripts
3bd8db80d8d335ab63ece4f110b0fadd562e80b7 [validation] fix comments in CheckInputScripts() (John Newbery)
6f6465cefcd599c89c00f7b51f42a4b87a5ffb0b scripted-diff: [validation] Rename CheckInputs to CheckInputScripts (John Newbery)

Pull request description:

  CheckInputs() used to check no double spends, scripts & sigs and amounts. Since
  832e074, the double spend and amount checks
  have been moved to CheckTxInputs(), and CheckInputs() now just validates
  input scripts. Rename the function to CheckInputScripts().

  Also fix incorrect comments.

ACKs for top commit:
  MarcoFalke:
    re-ACK 3bd8db80d8d335ab63ece4f110b0fadd562e80b7, did the rebase myself, checked the scripted diff 👡
  promag:
    ACK 3bd8db80d8d335ab63ece4f110b0fadd562e80b7 :trollface:

Tree-SHA512: 7b3f8597d210492798fb784ee8ea47ea6377519111190161c7cc34a967509013f4337304f52e9bedc97b7710de7b0ff8880e08cd7f867754567f82e7b02c794c
2023-04-25 23:14:25 +03:00
..
data merge bitcoin#18416: Limit decimal range of numbers ParseScript accepts 2022-11-01 00:28:53 -05:00
fuzz Merge #17164: p2p: Avoid allocating memory for addrKnown where we don't need it 2023-04-17 19:34:02 +03:00
util Merge #15921: validation: Tidy up ValidationState interface 2023-04-17 10:42:25 -05:00
addrman_tests.cpp merge bitcoin#18134: Replace std::to_string with locale-independent alternative 2023-01-02 14:19:33 -06:00
allocator_tests.cpp merge bitcoin#21404: Remove MakeUnique<T>() 2022-10-20 16:08:45 -05:00
amount_tests.cpp
arith_uint256_tests.cpp
base32_tests.cpp merge bitcoin#20429: replace (sizeof(a)/sizeof(a[0])) with C++17 std::size 2022-11-01 00:28:53 -05:00
base58_tests.cpp Merge #19706: refactor: make EncodeBase58{Check} consume Spans 2023-04-19 01:12:28 +03:00
base64_tests.cpp merge bitcoin#20429: replace (sizeof(a)/sizeof(a[0])) with C++17 std::size 2022-11-01 00:28:53 -05:00
bech32_tests.cpp
bip32_tests.cpp partial Merge #17212: refactor: Remove unused CExt{Pub,}Key (de)serialization methods 2023-04-17 10:42:25 -05:00
bip39_tests.cpp chore: bump copyrights (#4873) 2022-06-08 02:36:46 +03:00
block_reward_reallocation_tests.cpp partial bitcoin#21270: Prune g_chainman usage in validation-adjacent modules 2023-04-04 12:41:45 -05:00
blockchain_tests.cpp merge bitcoin#18134: Replace std::to_string with locale-independent alternative 2023-01-02 14:19:33 -06:00
blockencodings_tests.cpp
blockfilter_index_tests.cpp Merge #15921: validation: Tidy up ValidationState interface 2023-04-17 10:42:25 -05:00
blockfilter_tests.cpp
bloom_tests.cpp Merge #18670: refactor: Remove unused methods CBloomFilter::reset()/clear() 2023-01-22 00:27:52 -06:00
bls_tests.cpp test: added threshold_signature_tests (#5279) 2023-04-06 00:13:59 -05:00
bswap_tests.cpp
cachemap_tests.cpp chore: bump copyrights (#4873) 2022-06-08 02:36:46 +03:00
cachemultimap_tests.cpp chore: bump copyrights (#4873) 2022-06-08 02:36:46 +03:00
checkdatasig_tests.cpp
checkqueue_tests.cpp merge bitcoin#21016: remove boost::thread_group usage 2023-01-19 03:42:51 +00:00
coins_tests.cpp Merge #15452: Replace CScriptID and CKeyID in CTxDestination with dedicated types 2023-02-10 23:34:57 +03:00
compilerbug_tests.cpp
compress_tests.cpp Merge bitcoin/bitcoin#18847: compressor: use a prevector in CompressScript serialization [ZAP1] 2023-04-14 23:34:13 -05:00
crypto_tests.cpp Partial Merge #17517: ci: Bump to clang-8 for asan build to avoid segfaults on ppc64le 2022-10-17 15:41:14 -05:00
cuckoocache_tests.cpp merge bitcoin#21016: remove boost::thread_group usage 2023-01-19 03:42:51 +00:00
dbwrapper_tests.cpp merge bitcoin#21404: Remove MakeUnique<T>() 2022-10-20 16:08:45 -05:00
denialofservice_tests.cpp partial bitcoin#20228: Make addrman a top-level component 2023-02-28 00:11:11 +03:00
descriptor_tests.cpp fix: dashification for rpc_createmultisig introduced in bitcoin#13072 2023-04-06 20:15:47 +03:00
dip0020opcodes_tests.cpp
dynamic_activation_thresholds_tests.cpp partial bitcoin#21270: Prune g_chainman usage in validation-adjacent modules 2023-04-04 12:41:45 -05:00
evo_deterministicmns_tests.cpp Merge #15921: validation: Tidy up ValidationState interface 2023-04-17 10:42:25 -05:00
evo_instantsend_tests.cpp
evo_simplifiedmns_tests.cpp test: bls scheme basic/legacy tests (#5027) 2022-09-30 10:29:51 -05:00
evo_trivialvalidation.cpp fix: get rid of [most] clang warnings during build on linux (#5186) 2023-02-10 20:25:11 -06:00
evo_utils_tests.cpp refactor: create context for LLMQ subsystem within NodeContext, alias entangled globals (#5030) 2022-11-07 21:09:44 +03:00
flatfile_tests.cpp
fs_tests.cpp
getarg_tests.cpp Merge #17473: refactor: Settings code cleanups 2023-04-25 23:14:25 +03:00
governance_validators_tests.cpp chore: bump copyrights (#4873) 2022-06-08 02:36:46 +03:00
hash_tests.cpp merge bitcoin#20429: replace (sizeof(a)/sizeof(a[0])) with C++17 std::size 2022-11-01 00:28:53 -05:00
interfaces_tests.cpp Merge #15921: validation: Tidy up ValidationState interface 2023-04-17 10:42:25 -05:00
key_io_tests.cpp
key_tests.cpp Merge #19237: wallet: Check size after unserializing a pubkey 2023-04-15 12:14:35 -05:00
lcg.h
limitedmap_tests.cpp
llmq_dkg_tests.cpp refactor: implement c++23 inspired ToUnderlying (#5210) 2023-02-20 13:12:12 +03:00
logging_tests.cpp
main.cpp
Makefile
mempool_tests.cpp
merkle_tests.cpp
merkleblock_tests.cpp
miner_tests.cpp Merge #15921: validation: Tidy up ValidationState interface 2023-04-17 10:42:25 -05:00
multisig_tests.cpp Merge #19114 TxoutType C++11 scoped enum class 2023-01-19 23:37:39 -06:00
net_tests.cpp merge bitcoin#18134: Replace std::to_string with locale-independent alternative 2023-01-02 14:19:33 -06:00
netbase_tests.cpp Merge #19474: doc: Use precise permission flags where possible 2023-01-19 23:37:39 -06:00
pmt_tests.cpp
policyestimator_tests.cpp
pow_tests.cpp fix: params cleanup in pow_tests/get_next_work (#5067) 2022-11-02 10:30:09 -05:00
prevector_tests.cpp
raii_event_tests.cpp
random_tests.cpp
ratecheck_tests.cpp chore: bump copyrights (#4873) 2022-06-08 02:36:46 +03:00
README.md
reverselock_tests.cpp Merge #19982: test: Fix inconsistent lock order in wallet_tests/CreateWallet 2023-03-19 11:08:31 -05:00
rpc_tests.cpp fix/tests: fix legacy param usage in bls generate and bls fromsecret, add tests (#5195) 2023-02-13 10:30:31 -06:00
sanity_tests.cpp merge bitcoin#21405: remove memcpy -> memmove backwards compatibility alias 2022-07-01 09:02:38 +05:30
scheduler_tests.cpp merge bitcoin#21016: remove boost::thread_group usage 2023-01-19 03:42:51 +00:00
script_p2pk_tests.cpp chore: bump copyrights (#4873) 2022-06-08 02:36:46 +03:00
script_p2pkh_tests.cpp
script_p2sh_tests.cpp Merge #15452: Replace CScriptID and CKeyID in CTxDestination with dedicated types 2023-02-10 23:34:57 +03:00
script_standard_tests.cpp Merge #15452: Replace CScriptID and CKeyID in CTxDestination with dedicated types 2023-02-10 23:34:57 +03:00
script_tests.cpp Merge #15452: Replace CScriptID and CKeyID in CTxDestination with dedicated types 2023-02-10 23:34:57 +03:00
scriptnum10.h
scriptnum_tests.cpp merge bitcoin#20429: replace (sizeof(a)/sizeof(a[0])) with C++17 std::size 2022-11-01 00:28:53 -05:00
serialize_tests.cpp
settings_tests.cpp Merge #17473: refactor: Settings code cleanups 2023-04-25 23:14:25 +03:00
sighash_tests.cpp Merge #15921: validation: Tidy up ValidationState interface 2023-04-17 10:42:25 -05:00
sigopcount_tests.cpp Merge #15452: Replace CScriptID and CKeyID in CTxDestination with dedicated types 2023-02-10 23:34:57 +03:00
skiplist_tests.cpp
sock_tests.cpp Merge #21159: test: fix sign comparison warning in socket tests 2023-04-09 00:06:56 -05:00
specialtx_tests.cpp Merge #15921: validation: Tidy up ValidationState interface 2023-04-17 10:42:25 -05:00
streams_tests.cpp
subsidy_tests.cpp chore: bump copyrights (#4873) 2022-06-08 02:36:46 +03:00
sync_tests.cpp Merge #19982: test: Fix inconsistent lock order in wallet_tests/CreateWallet 2023-03-19 11:08:31 -05:00
timedata_tests.cpp merge bitcoin#18134: Replace std::to_string with locale-independent alternative 2023-01-02 14:19:33 -06:00
torcontrol_tests.cpp
transaction_tests.cpp Merge #15921: validation: Tidy up ValidationState interface 2023-04-17 10:42:25 -05:00
txindex_tests.cpp Merge #15452: Replace CScriptID and CKeyID in CTxDestination with dedicated types 2023-02-10 23:34:57 +03:00
txvalidation_tests.cpp Merge #15921: validation: Tidy up ValidationState interface 2023-04-17 10:42:25 -05:00
txvalidationcache_tests.cpp Merge #16658: validation: Rename CheckInputs to CheckInputScripts 2023-04-25 23:14:25 +03:00
uint256_tests.cpp merge bitcoin#20016: 1 is a constant 2022-07-02 23:47:42 +05:30
util_tests.cpp Merge #17473: refactor: Settings code cleanups 2023-04-25 23:14:25 +03:00
util_threadnames_tests.cpp merge bitcoin#18134: Replace std::to_string with locale-independent alternative 2023-01-02 14:19:33 -06:00
util.cpp partial bitcoin#21270: Prune g_chainman usage in validation-adjacent modules 2023-04-04 12:41:45 -05:00
util.h
validation_block_tests.cpp Merge #15921: validation: Tidy up ValidationState interface 2023-04-17 10:42:25 -05:00
validation_chainstate_tests.cpp Merge #19826: Pass mempool reference to chainstate constructor 2023-02-15 00:07:39 -06:00
validation_chainstatemanager_tests.cpp Merge #15921: validation: Tidy up ValidationState interface 2023-04-17 10:42:25 -05:00
validation_flush_tests.cpp Merge #19826: Pass mempool reference to chainstate constructor 2023-02-15 00:07:39 -06:00
validation_tests.cpp
versionbits_tests.cpp

Unit tests

The sources in this directory are unit test cases. Boost includes a unit testing framework, and since Dash 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_dash that runs all of the unit tests. The main source file for the test library is found in util/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 unit tests manually, launch src/test/test_dash. 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 unit tests.

To add more unit 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 GUI unit tests manually, launch src/qt/test/test_dash-qt

To add more GUI unit tests, add them to the src/qt/test/ directory and the src/qt/test/test_main.cpp file.

Running individual tests

test_dash has some built-in command-line arguments; for example, to run just the getarg_tests verbosely:

test_dash --log_level=all --run_test=getarg_tests -- DEBUG_LOG_OUT

log_level controls the verbosity of the test framework, which logs when a test case is entered, for example. The DEBUG_LOG_OUT after the two dashes redirects the debug log, which would normally go to a file in the test datadir (BasicTestingSetup::m_path_root), to the standard terminal output.

... or to run just the doubledash test:

test_dash --run_test=getarg_tests/doubledash

Run test_dash --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

make check will write to a log file foo_tests.cpp.log and display this file on failure. For running individual tests verbosely, refer to the section above.

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_dash executable with gdbor lldb and start debugging, just like you would with any other program:

gdb src/test/test_dash