bitcoin/src/test
Wladimir J. van der Laan 376638afcf
Merge #14047: Add HKDF_HMAC256_L32 and method to negate a private key
8794a4b3ae QA: add test for HKDF HMAC_SHA256 L32 (Jonas Schnelli)
551d489416 Add HKDF HMAC_SHA256 L=32 implementations (Jonas Schnelli)
3b64f852e4 QA: add test for CKey::Negate() (Jonas Schnelli)
463921bb64 CKey: add method to negate the key (Jonas Schnelli)

Pull request description:

  This adds a limited implementation of `HKDF` (defined by rfc5869) that supports only HMAC-SHA256  and length output of 32 bytes (will be required for v2 transport protocol).

  This PR also includes a method to negate a private key which is useful to enforce public keys starting with 0x02 (or 0x03) (a requirement for the v2 transport protocol). The new `CKey::Negate()` method is pretty much a wrapper around `secp256k1_ec_privkey_negate()`.

  Including tests.

  This is a subset of #14032 and a pre-requirement for the v2 transport protocol.

ACKs for commit 8794a4:

Tree-SHA512: 5341929dfa29f5da766ec3612784baec6a3ad69972f08b5a985a8aafdae4dae36f104a2b888d1f5d1f33561456bd111f960d7e32c2cc4fd18e48358468f26c1a
2019-05-16 19:24:52 +02:00
..
data blockfilter: Update BIP 158 test vectors. 2019-04-06 12:10:55 -07:00
fuzz scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
gen Integration of property based testing into Bitcoin Core 2018-08-27 08:51:51 -05:00
addrman_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
allocator_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
amount_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
arith_uint256_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
base32_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
base58_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
base64_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
bech32_tests.cpp scripted-diff: Rename test_bitcoin to test/setup_common 2019-04-11 10:12:36 -04:00
bip32_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
blockchain_tests.cpp scripted-diff: Rename test_bitcoin to test/setup_common 2019-04-11 10:12:36 -04:00
blockencodings_tests.cpp Merge #15352: tests: Reduce noise level in test_bitcoin output 2019-04-16 14:18:47 -04:00
blockfilter_index_tests.cpp Merge #15452: Replace CScriptID and CKeyID in CTxDestination with dedicated types 2019-05-09 18:54:43 +02:00
blockfilter_tests.cpp Merge #14121: Index for BIP 157 block filters 2019-04-18 09:48:25 -04:00
bloom_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
bswap_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
checkqueue_tests.cpp Merge #15352: tests: Reduce noise level in test_bitcoin output 2019-04-16 14:18:47 -04:00
coins_tests.cpp Replace CScriptID and CKeyID in CTxDestination with dedicated types 2019-04-29 10:15:23 -04:00
compress_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
crypto_tests.cpp Merge #14047: Add HKDF_HMAC256_L32 and method to negate a private key 2019-05-16 19:24:52 +02:00
cuckoocache_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
dbwrapper_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
denialofservice_tests.cpp Merge #15452: Replace CScriptID and CKeyID in CTxDestination with dedicated types 2019-05-09 18:54:43 +02:00
descriptor_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
flatfile_tests.cpp scripted-diff: Rename test_bitcoin to test/setup_common 2019-04-11 10:12:36 -04:00
fs_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
getarg_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
hash_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
key_io_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
key_properties.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
key_tests.cpp Merge #14047: Add HKDF_HMAC256_L32 and method to negate a private key 2019-05-16 19:24:52 +02:00
limitedmap_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
main.cpp test: Remove useless test_bitcoin_main.cpp 2019-02-28 15:44:02 -05:00
Makefile build: add stub makefiles for easier subdir builds 2014-06-05 16:05:43 -04:00
mempool_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
merkle_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
merkleblock_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
miner_tests.cpp [refactor] interfaces: Add missing LockAnnotation for cs_main 2019-05-13 14:46:01 -04:00
multisig_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
net_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
netbase_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
pmt_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
policyestimator_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
pow_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
prevector_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
raii_event_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
random_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
README.md scripted-diff: Rename test_bitcoin to test/setup_common 2019-04-11 10:12:36 -04:00
reverselock_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
rpc_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
sanity_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
scheduler_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
script_p2sh_tests.cpp Replace CScriptID and CKeyID in CTxDestination with dedicated types 2019-04-29 10:15:23 -04:00
script_standard_tests.cpp Replace CScriptID and CKeyID in CTxDestination with dedicated types 2019-04-29 10:15:23 -04:00
script_tests.cpp Replace CScriptID and CKeyID in CTxDestination with dedicated types 2019-04-29 10:15:23 -04:00
scriptnum10.h Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
scriptnum_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
serialize_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
setup_common.cpp scripted-diff: replace chainActive -> ::ChainActive() 2019-05-03 15:02:54 -04:00
setup_common.h scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
sighash_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
sigopcount_tests.cpp Replace CScriptID and CKeyID in CTxDestination with dedicated types 2019-04-29 10:15:23 -04:00
skiplist_tests.cpp Merge #15670: refactor: combine Chain::findFirstBlockWithTime/findFirstBlockWithTimeAndHeight 2019-04-19 12:03:12 -04:00
streams_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
sync_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
timedata_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
torcontrol_tests.cpp Merge #15352: tests: Reduce noise level in test_bitcoin output 2019-04-16 14:18:47 -04:00
transaction_tests.cpp Replace CScriptID and CKeyID in CTxDestination with dedicated types 2019-04-29 10:15:23 -04:00
txindex_tests.cpp Replace CScriptID and CKeyID in CTxDestination with dedicated types 2019-04-29 10:15:23 -04:00
txvalidation_tests.cpp Merge #15141: Rewrite DoS interface between validation and net_processing 2019-05-04 11:58:57 +02:00
txvalidationcache_tests.cpp [refactor] interfaces: Add missing LockAnnotation for cs_main 2019-05-13 14:46:01 -04:00
uint256_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -04:00
util.cpp [refactor] interfaces: Add missing LockAnnotation for cs_main 2019-05-13 14:46:01 -04:00
util.h Add unit test NextString, ForEachNoDup functions 2019-05-07 11:51:30 -04:00
util_tests.cpp Add test for ArgsManager::GetChainName 2019-05-07 11:51:30 -04:00
util_threadnames_tests.cpp tests: add threadutil tests 2019-04-29 13:43:01 -04:00
validation_block_tests.cpp [refactor] interfaces: Add missing LockAnnotation for cs_main 2019-05-13 14:46:01 -04:00
validation_tests.cpp scripted-diff: Rename test_bitcoin to test/setup_common 2019-04-11 10:12:36 -04:00
versionbits_tests.cpp scripted-diff: Bump copyright headers in test, bench 2019-04-11 13:34:43 -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 setup_common.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/.