dash/src/test
MarcoFalke b87625d738 Merge #18901: fuzz: use std::optional for sep_pos_opt variable
420fa0770f37619bfa29898d59dac45b6a477abb fuzz: use std::optional for sep_pos variable (Harris)

Pull request description:

  This PR changes the original `size_t sep_pos` to `std::optional<size_t> sep_post_opt` to remove the warning when compiling fuzz tests.

  ```shell
  warning: variable 'sep_pos' may be uninitialized when used here [-Wconditional-uninitialized]
  ```

  Also, it adds `--enable-c++17` flag to CI fuzz scripts.

ACKs for top commit:
  practicalswift:
    ACK 420fa0770f37619bfa29898d59dac45b6a477abb
  MarcoFalke:
    ACK 420fa07

Tree-SHA512: e967d5d8ab8ee7394b243ff5b28bac72d30bd14774e4a206f8c87474fad22769da76e4ba4e03cbef83b8f60e5293e9d9293b613e2e2e59e187d4e59ae6b874ca
2023-01-23 11:21:05 -06:00
..
data merge bitcoin#18416: Limit decimal range of numbers ParseScript accepts 2022-11-01 00:28:53 -05:00
fuzz Merge #18901: fuzz: use std::optional for sep_pos_opt variable 2023-01-23 11:21:05 -06:00
util merge bitcoin#21016: remove boost::thread_group usage 2023-01-19 03:42:51 +00: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 #17511: Add bounds checks before base58 decoding 2022-06-08 12:33:00 +07: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
bip39_tests.cpp chore: bump copyrights (#4873) 2022-06-08 02:36:46 +03:00
block_reward_reallocation_tests.cpp feat!: BLS scheme upgrade (#5021) 2022-12-29 23:45:31 -06: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 refactor: remove the g_evoDb global; use NodeContext and locals (#5058) 2022-12-10 11:58:17 -06: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 feat!: BLS scheme upgrade (#5021) 2022-12-29 23:45:31 -06: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
compilerbug_tests.cpp
compress_tests.cpp
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 merge bitcoin#18134: Replace std::to_string with locale-independent alternative 2023-01-02 14:19:33 -06:00
descriptor_tests.cpp merge bitcoin#18204: improve descriptor cache and cache xpubs 2022-09-24 08:51:05 +05:30
dip0020opcodes_tests.cpp
dynamic_activation_thresholds_tests.cpp refactor: remove the g_evoDb global; use NodeContext and locals (#5058) 2022-12-10 11:58:17 -06:00
evo_deterministicmns_tests.cpp feat!: BLS scheme upgrade (#5021) 2022-12-29 23:45:31 -06: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 feat!: BLS scheme upgrade (#5021) 2022-12-29 23:45:31 -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 bitcoin#25027: Remove boost::split from getarg_tests.cpp 2023-01-19 03:42:51 +00: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
key_io_tests.cpp
key_tests.cpp merge bitcoin#18134: Replace std::to_string with locale-independent alternative 2023-01-02 14:19:33 -06:00
lcg.h
limitedmap_tests.cpp
llmq_dkg_tests.cpp refactor: create an enum for DKGError, instead of passing around potentially invalid strings (#4998) 2022-09-06 20:32:53 +03:00
logging_tests.cpp
main.cpp
Makefile
mempool_tests.cpp
merkle_tests.cpp
merkleblock_tests.cpp
miner_tests.cpp Merge #19069: refactor: replace pointers by references within tx_verify.{h,cpp} 2023-01-01 20:16:57 -06: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
rpc_tests.cpp merge bitcoin#25025: Remove boost::split from rpc_tests.cpp 2023-01-19 03:49:04 +00: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 Bitcoin backport #16227 refactoring CWallet (#4903) 2022-07-12 22:46:31 -05:00
script_standard_tests.cpp Merge #19114 TxoutType C++11 scoped enum class 2023-01-19 23:37:39 -06:00
script_tests.cpp merge bitcoin#20429: replace (sizeof(a)/sizeof(a[0])) with C++17 std::size 2022-11-01 00:28:53 -05: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 bitcoin#18134: Replace std::to_string with locale-independent alternative 2023-01-02 14:19:33 -06:00
sighash_tests.cpp merge bitcoin#20429: replace (sizeof(a)/sizeof(a[0])) with C++17 std::size 2022-11-01 00:28:53 -05:00
sigopcount_tests.cpp
skiplist_tests.cpp
sock_tests.cpp merge bitcoin#20788: add RAII socket and use it instead of bare SOCKET 2022-11-01 00:28:53 -05:00
specialtx_tests.cpp chore: run copyright_header.py update 2023-01-13 00:49:04 +03:00
streams_tests.cpp
subsidy_tests.cpp chore: bump copyrights (#4873) 2022-06-08 02:36:46 +03:00
sync_tests.cpp
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 #19114 TxoutType C++11 scoped enum class 2023-01-19 23:37:39 -06:00
txindex_tests.cpp
txvalidation_tests.cpp merge bitcoin#15141: Rewrite DoS interface between validation and net_processing 2022-06-21 19:11:26 +05:30
txvalidationcache_tests.cpp Merge #18675: tests: Don't initialize PrecomputedTransactionData in txvalidationcache tests 2023-01-11 21:42:32 -06:00
uint256_tests.cpp merge bitcoin#20016: 1 is a constant 2022-07-02 23:47:42 +05:30
util_tests.cpp merge bitcoin#25057: replace remaining boost::split with SplitString 2023-01-19 03:49:04 +00: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 refactor: remove the g_evoDb global; use NodeContext and locals (#5058) 2022-12-10 11:58:17 -06:00
util.h
validation_block_tests.cpp refactor: remove the g_evoDb global; use NodeContext and locals (#5058) 2022-12-10 11:58:17 -06:00
validation_chainstate_tests.cpp refactor: remove the g_evoDb global; use NodeContext and locals (#5058) 2022-12-10 11:58:17 -06:00
validation_chainstatemanager_tests.cpp refactor: remove the g_evoDb global; use NodeContext and locals (#5058) 2022-12-10 11:58:17 -06:00
validation_flush_tests.cpp refactor: remove the g_evoDb global; use NodeContext and locals (#5058) 2022-12-10 11:58:17 -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