bitcoin/src/test
MarcoFalke 6d0a14703e
Merge #14908: test: Removed implicit CTransaction constructor calls from tests and benchmarks.
8db0c3d42b Removed implicit CTransaction conversion from benchmaks (lucash-dev)
ed61abedb2 Removed implicit CTransaction constructor from tests (lucash-dev)

Pull request description:

  This PR was split from #14906 and is a prerequisite for it.
  It updates tests and benchmarks, removing all implicit calls to `CTransaction(CMutableTransaction&)` constructors. This will make possible making the constructor explicit in the next PR.
  The original rationale for making the constructor explicit:

   - Conversion constructors should not be explicit unless there's a strong reason for it (in the opinion of, for example, https://google.github.io/styleguide/cppguide.html, and https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Ro-conversion. Let me know your take on this).
   - This particular conversion is very costly -- it implies a serialization plus hash of the transaction.
   - Even though `CTransaction` and `CMutableTransaction` represent the same data, they have very different use cases and performance properties.
   - Making it explicit allows for easier reasoning of performance trade-offs.
   - There has been previous performance issues caused by unneeded use of this implicit conversion.
   - This PR creates a map for places to look for possible refactoring and performance gains (this benefit still holds if the PR is not merged).

Tree-SHA512: de8073aa6ff8a3153bcbe10818616677ecf9598e4978d8a0b4c39a262e71c36be5679cec08554c760d1f011ba6d37350318248eef15f6d9b86f9e4462b2de0d2
2018-12-12 14:30:24 -05:00
..
data blockfilter: Omit empty scripts from filter contents. 2018-08-28 12:12:32 -07:00
gen Integration of property based testing into Bitcoin Core 2018-08-27 08:51:51 -05:00
addrman_tests.cpp Merge #13258: uint256: Remove unnecessary crypto/common.h dependency 2018-11-30 18:48:58 +01:00
allocator_tests.cpp scripted-diff: Move util files to separate directory. 2018-11-04 22:46:07 -08:00
amount_tests.cpp Improve CAmount tests 2018-10-10 23:27:51 +03:00
arith_uint256_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
base32_tests.cpp scripted-diff: Move util files to separate directory. 2018-11-04 22:46:07 -08:00
base58_tests.cpp scripted-diff: Move util files to separate directory. 2018-11-04 22:46:07 -08:00
base64_tests.cpp scripted-diff: Move util files to separate directory. 2018-11-04 22:46:07 -08:00
bech32_tests.cpp Merge #12881: Minor optimizations to bech32::Decode(); add tests. 2018-05-15 12:10:34 +02:00
bip32_tests.cpp scripted-diff: Move util files to separate directory. 2018-11-04 22:46:07 -08:00
blockchain_tests.cpp Use bracket syntax includes ("#include <foo.h>") 2018-06-06 11:09:05 +02:00
blockencodings_tests.cpp add a test demonstrating an overflow in a deserialization edge case 2018-11-13 12:14:08 -08:00
blockfilter_tests.cpp scripted-diff: Move util files to separate directory. 2018-11-04 22:46:07 -08:00
bloom_tests.cpp scripted-diff: Move util files to separate directory. 2018-11-04 22:46:07 -08:00
bswap_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
checkqueue_tests.cpp scripted-diff: Move util files to separate directory. 2018-11-04 22:46:07 -08:00
coins_tests.cpp Removed implicit CTransaction constructor from tests 2018-12-11 19:43:35 -08:00
compress_tests.cpp scripted-diff: Move util files to separate directory. 2018-11-04 22:46:07 -08:00
crypto_tests.cpp scripted-diff: Move util files to separate directory. 2018-11-04 22:46:07 -08:00
cuckoocache_tests.cpp Make objects in range declarations immutable by default. Avoid unnecessary copying of objects in range declarations. 2018-08-27 18:19:33 +02:00
dbwrapper_tests.cpp test: Add BOOST_REQUIRE to getters returning optional 2018-11-20 19:51:49 -05:00
denialofservice_tests.cpp scripted-diff: Move util files to separate directory. 2018-11-04 22:46:07 -08:00
descriptor_tests.cpp Add comments to descriptor tests 2018-11-28 15:24:49 -08:00
fs_tests.cpp tests: Add test case for std::ios_base::ate 2018-09-26 08:47:42 +08:00
getarg_tests.cpp tests: Check return value of ParseParameters(...) 2018-11-05 16:52:59 +01:00
hash_tests.cpp Extract CSipHasher to it's own file in crypto/ directory. 2018-11-05 09:25:15 -08:00
key_io_tests.cpp scripted-diff: Move util files to separate directory. 2018-11-04 22:46:07 -08:00
key_properties.cpp scripted-diff: Move util files to separate directory. 2018-11-04 22:46:07 -08:00
key_tests.cpp scripted-diff: Move util files to separate directory. 2018-11-04 22:46:07 -08:00
limitedmap_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
main_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
Makefile build: add stub makefiles for easier subdir builds 2014-06-05 16:05:43 -04:00
mempool_tests.cpp Removed implicit CTransaction constructor from tests 2018-12-11 19:43:35 -08:00
merkle_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
merkleblock_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
miner_tests.cpp Removed implicit CTransaction constructor from tests 2018-12-11 19:43:35 -08:00
multisig_tests.cpp Removed implicit CTransaction constructor from tests 2018-12-11 19:43:35 -08:00
net_tests.cpp add test demonstrating addrLocal UB 2018-11-15 13:47:53 -08:00
netbase_tests.cpp scripted-diff: Move util files to separate directory. 2018-11-04 22:46:07 -08:00
pmt_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
policyestimator_tests.cpp Removed implicit CTransaction constructor from tests 2018-12-11 19:43:35 -08:00
pow_tests.cpp [doc] conf: Remove deprecated options from docs, Other cleanup 2018-11-07 13:30:03 -05:00
prevector_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
raii_event_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
random_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
README.md scripted-diff: Remove trailing whitespaces 2018-07-24 20:46:23 +01:00
reverselock_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
rpc_tests.cpp rpc: Avoid creating non-standard raw transactions 2018-12-06 16:56:58 -05:00
sanity_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
scheduler_tests.cpp Merge #14088: tests: Don't assert(...) with side effects 2018-08-31 15:00:15 +02:00
script_p2sh_tests.cpp Removed implicit CTransaction constructor from tests 2018-12-11 19:43:35 -08:00
script_standard_tests.cpp Merge #13429: Return the script type from Solver 2018-08-25 17:41:00 +02:00
script_tests.cpp Removed implicit CTransaction constructor from tests 2018-12-11 19:43:35 -08:00
scriptnum10.h Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
scriptnum_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
serialize_tests.cpp Use std::numeric_limits<UNSIGNED>::max()) instead of (UNSIGNED)-1 2018-12-04 19:55:04 +02:00
sighash_tests.cpp Removed implicit CTransaction constructor from tests 2018-12-11 19:43:35 -08:00
sigopcount_tests.cpp Removed implicit CTransaction constructor from tests 2018-12-11 19:43:35 -08:00
skiplist_tests.cpp Merge #14636: Avoid using numeric_limits for sequence numbers and lock times 2018-11-07 11:15:22 -05:00
streams_tests.cpp streams: Unit tests for BitStreamReader and BitStreamWriter. 2018-08-25 10:02:37 -07:00
sync_tests.cpp scripted-diff: Small locking rename 2018-08-31 10:00:38 -04:00
test_bitcoin.cpp Don't edit Chainparams after initialization 2018-09-23 22:58:54 +02:00
test_bitcoin.h Return a status enum from ScanForWalletTransactions 2018-11-13 00:04:13 -05:00
test_bitcoin_fuzzy.cpp tests: Use MakeUnique to construct objects owned by unique_ptrs 2018-09-21 11:03:21 +02:00
test_bitcoin_main.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
timedata_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
torcontrol_tests.cpp Declare TorReply parsing functions in torcontrol_tests 2018-05-21 10:53:18 -07:00
transaction_tests.cpp Removed implicit CTransaction constructor from tests 2018-12-11 19:43:35 -08:00
txindex_tests.cpp scripted-diff: Move util files to separate directory. 2018-11-04 22:46:07 -08:00
txvalidation_tests.cpp Don't assert(foo()) where foo has side effects 2018-07-07 10:08:49 +02:00
txvalidationcache_tests.cpp Removed implicit CTransaction constructor from tests 2018-12-11 19:43:35 -08:00
uint256_tests.cpp Drop unused GetType() from CSizeComputer 2018-09-11 00:58:05 -04:00
util_tests.cpp test: Add BOOST_REQUIRE to getters returning optional 2018-11-20 19:51:49 -05:00
validation_block_tests.cpp Mark single-argument constructors "explicit" 2018-07-26 17:15:32 +02:00
versionbits_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04: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/.