dash/src/test
Alexander Block 241f76f9bf Collection of minor performance optimizations (#2855)
* Merge #13176: Improve CRollingBloomFilter performance: replace modulus with FastMod

9aac9f90d5e56752cc6cbfac48063ad29a01143c replace modulus with FastMod (Martin Ankerl)

Pull request description:

  Not sure if this is optimization is necessary, but anyway I have some spare time so here it is. This replaces the slow modulo operation with a much faster 64bit multiplication & shift. This works when the hash is uniformly distributed between 0 and 2^32-1. This speeds up the benchmark by a factor of about 1.3:

  ```
  RollingBloom, 5, 1500000, 3.73733, 4.97569e-07, 4.99002e-07, 4.98372e-07 # before
  RollingBloom, 5, 1500000, 2.86842, 3.81630e-07, 3.83730e-07, 3.82473e-07 # FastMod
  ```

  Be aware that this changes the internal data of the filter, so this should probably
  not be used for CBloomFilter because of interoperability problems.

Tree-SHA512: 04104f3fb09f56c9d14458a6aad919aeb0a5af944e8ee6a31f00e93c753e22004648c1cd65bf36752b6addec528d19fb665c27b955ce1666a85a928e17afa47a

* Use unordered_map in CSporkManager

In one of my profiling sessions with many InstantSend transactions
happening, calls into CSporkManager added up to about 1% of total CPU time.
This is easily avoidable by using unordered maps.

* Use std::unordered_map instead of std::map in limitedmap

* Use unordered_set for CNode::setAskFor

* Add serialization support for unordered maps and sets

* Use unordered_map for mapArgs and mapMultiArgs

* Let limitedmap prune in batches and use unordered_multimap

Due to the batched pruning, there is no need to maintain an ordered map
of values anymore. Only when nPruneAfterSize, there is a need to create
a temporary ordered vector of values to figure out what can be removed.

* Instead of using a multimap for mapAskFor, use a vector which we sort on demand

CNode::AskFor will now push entries into an initially unordered vector
instead of an ordered multimap. Only when we later want to use vecAskFor in
SendMessages, we sort the vector.

The vector will actually be mostly sorted in most cases as insertion order
usually mimics the desired ordering. Only the last few entries might need
some shuffling around. Doing the sort on-demand should be less wasteful
then trying to maintain correct order all the time.

* Fix compilation of tests

* Fix limitedmap tests

* Rename limitedmap to unordered_limitedmap to ensure backports conflict

This ensures that future backports that depends on limitedmap's ordering
conflict so that we are made aware of needed action.

* Fix compilation error on Travis
2019-04-11 15:42:14 +03:00
..
data Merge #9350: [Trivial] Adding label for amount inside of tx_valid/tx_invalid.json 2019-01-22 22:55:43 -06:00
addrman_tests.cpp A few devnet related fixes (#2168) 2018-07-08 00:19:33 +03:00
alert_tests.cpp Drop BOOST_FOREACH and use references in loops (const ref where applicable, Dash code only) (#1899) 2018-02-06 14:09:33 +03:00
allocator_tests.cpp
amount_tests.cpp
arith_uint256_tests.cpp
base32_tests.cpp
base58_tests.cpp Merge #9305: Refactor: Removed begin/end_ptr functions. 2018-01-17 17:31:12 +01:00
base64_tests.cpp
bctest.py Merge #9945: Improve logging in bctest.py if there is a formatting mismatch 2019-02-05 13:40:33 -06:00
bip32_tests.cpp Backports 0.15 pr2 (#2597) 2019-01-07 12:55:35 +03:00
bip39_tests.cpp update copyright (#2648) 2019-01-29 15:53:14 +01:00
bitcoin-util-test.py Merge #9508: Remove unused Python imports 2018-01-21 12:48:33 +01:00
blockencodings_tests.cpp Merge #9548: Remove min reasonable fee 2019-02-05 13:40:31 -06:00
bloom_tests.cpp Apply Bloom filters to DIP2 transactions extra payload (#2786) 2019-03-21 23:45:27 +03:00
bls_tests.cpp CBLSWrapper::SetHexStr() should not accept non-hex strings (#2843) 2019-04-08 08:07:26 +03:00
bswap_tests.cpp
buildenv.py.in
cachemap_tests.cpp update copyright (#2648) 2019-01-29 15:53:14 +01:00
cachemultimap_tests.cpp update copyright (#2648) 2019-01-29 15:53:14 +01:00
checkqueue_tests.cpp Include test_dash.h instead of test_bitcoin.h 2018-01-26 12:59:29 +01:00
coins_tests.cpp Merge #8808: Do not shadow variables (gcc set) 2019-02-01 00:41:12 -06:00
compress_tests.cpp
crypto_tests.cpp
cuckoocache_tests.cpp Merge #9610: [Trivial] Grammar and typo correction (laudaa) 2018-01-21 12:48:33 +01:00
dbwrapper_tests.cpp Merge #9867: Replace remaining sprintf with snprintf 2019-01-22 22:55:48 -06:00
DoS_tests.cpp Merge #9763: [Trivial] Update comments referencing main.cpp 2018-01-23 09:24:29 +01:00
evo_deterministicmns_tests.cpp Fix confusion between dip3 activation and enforcement (#2651) 2019-01-29 15:54:38 +01:00
evo_simplifiedmns_tests.cpp Use proTxHash instead of outpoint when calculating masternode scores (#2440) 2018-11-13 15:24:14 +03:00
getarg_tests.cpp
governance_validators_tests.cpp Disallow new proposals using legacy serialization (#2722) 2019-02-26 13:44:43 +03:00
hash_tests.cpp Backport compact blocks functionality from bitcoin (#1966) 2018-04-11 14:06:01 +03:00
key_tests.cpp Merge #9281: Refactor: Remove using namespace <xxx> from bench/ & test/ sources 2018-01-18 07:33:44 +01:00
limitedmap_tests.cpp Collection of minor performance optimizations (#2855) 2019-04-11 15:42:14 +03:00
main_tests.cpp Some cleanup (mostly trivial) (#2038) 2018-04-20 13:53:23 +03:00
Makefile
mempool_tests.cpp Merge bitcoin#9602: Remove coin age priority and free transactions - implementation (#2768) 2019-03-14 17:44:42 +03:00
merkle_tests.cpp Merge #9125: Make CBlock a vector of shared_ptr of CTransactions 2018-01-15 06:14:16 +01:00
miner_tests.cpp Merge bitcoin#9602: Remove coin age priority and free transactions - implementation (#2768) 2019-03-14 17:44:42 +03:00
multisig_tests.cpp Merge #9281: Refactor: Remove using namespace <xxx> from bench/ & test/ sources 2018-01-18 07:33:44 +01:00
net_tests.cpp Use override keyword for overriden class member functions (#1644) 2018-02-15 10:29:15 +03:00
netbase_tests.cpp Merge #9281: Refactor: Remove using namespace <xxx> from bench/ & test/ sources 2018-01-18 07:33:44 +01:00
pmt_tests.cpp Merge #9281: Refactor: Remove using namespace <xxx> from bench/ & test/ sources 2018-01-18 07:33:44 +01:00
policyestimator_tests.cpp Merge bitcoin#9602: Remove coin age priority and free transactions - implementation (#2768) 2019-03-14 17:44:42 +03:00
pow_tests.cpp Add tests for special rules for slow blocks on devnet/testnet (#2176) 2018-07-09 12:42:11 +03:00
prevector_tests.cpp Merge #9349: Make CScript (and prevector) c++11 movable. 2018-01-18 07:31:23 +01:00
raii_event_tests.cpp Merge #9647: Skip RAII event tests if libevent is built without event_set_mem_functions 2018-01-23 09:24:26 +01:00
random_tests.cpp fix merge error from #9821 2019-01-22 22:57:13 -06:00
ratecheck_tests.cpp update copyright (#2648) 2019-01-29 15:53:14 +01:00
README.md
reverselock_tests.cpp
rpc_tests.cpp Disable in-wallet miner for win/macos Travis/Gitian builds (#2778) 2019-03-19 10:43:37 +03:00
sanity_tests.cpp
scheduler_tests.cpp Merge #9610: [Trivial] Grammar and typo correction (laudaa) 2018-01-21 12:48:33 +01:00
script_P2PK_tests.cpp Remove remaining using namespace std 2018-02-21 22:32:13 +03:00
script_P2PKH_tests.cpp Fix p2pkh tests asserts (#2153) 2018-06-29 01:23:25 +03:00
script_P2SH_tests.cpp Merge #9281: Refactor: Remove using namespace <xxx> from bench/ & test/ sources 2018-01-18 07:33:44 +01:00
script_tests.cpp Merge #8976: libconsensus: Add input validation of flags (#1891) 2018-02-05 18:42:05 +03:00
scriptnum10.h
scriptnum_tests.cpp Merge #9512: Fix various things -fsanitize complains about 2018-01-21 12:48:33 +01:00
serialize_tests.cpp Merge #9510: [trivial] Fix typos in comments 2018-01-21 12:48:34 +01:00
sighash_tests.cpp Only use version 1 and 2 transactions for sighash_tests (#2219) 2018-08-11 01:36:36 +03:00
sigopcount_tests.cpp Merge #9281: Refactor: Remove using namespace <xxx> from bench/ & test/ sources 2018-01-18 07:33:44 +01:00
skiplist_tests.cpp Merge #9490: Replace FindLatestBefore used by importmuti with FindEarliestAtLeast. 2018-01-21 12:48:32 +01:00
streams_tests.cpp Merge #9281: Refactor: Remove using namespace <xxx> from bench/ & test/ sources 2018-01-18 07:33:44 +01:00
subsidy_tests.cpp Add tests for GetBlockSubsidy algorithm (#2022) 2018-04-11 14:06:27 +03:00
test_dash.cpp Implement and enforce quorum commitment merkle roots in coinbases 2019-04-04 12:27:35 +02:00
test_dash.h Merge bitcoin#9602: Remove coin age priority and free transactions - implementation (#2768) 2019-03-14 17:44:42 +03:00
test_random.h
testutil.cpp Backports 0.15 pr1 (#2590) 2019-01-03 12:18:47 +03:00
testutil.h
timedata_tests.cpp Merge #9281: Refactor: Remove using namespace <xxx> from bench/ & test/ sources 2018-01-18 07:33:44 +01:00
transaction_tests.cpp Merge #9555: [test] Avoid reading a potentially uninitialized variable in tx_invalid-test (transaction_tests.cpp) 2019-02-04 19:58:13 -06:00
txvalidationcache_tests.cpp Remove leftover RBF code from BTC (#2297) 2018-09-20 15:39:34 +03:00
uint256_tests.cpp
univalue_tests.cpp Add univalue test for real numbers (#2460) 2018-11-22 06:09:58 +01:00
util_tests.cpp Collection of minor performance optimizations (#2855) 2019-04-11 15:42:14 +03:00
versionbits_tests.cpp Use override keyword for overriden class member functions (#1644) 2018-02-15 10:29:15 +03: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 dashd tests manually, launch src/test/test_dash.

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

To add more dash-qt 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

... or to run just the doubledash test:

test_dash --run_test=getarg_tests/doubledash

Run test_dash --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 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 setup to compile an executable called test_dash that runs all of the unit tests. The main source file is called test_dash.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/.

bitcoin-util-test.py

The test directory also contains the bitcoin-util-test.py tool, which tests bitcoin utils (currently just dash-tx). This test gets run automatically during the make check build process. It is also possible to run the test manually from the src directory:

test/bitcoin-util-test.py --srcdir=[current directory]