0
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-02-05 10:17:30 -05:00
bitcoin-bitcoin-core/src/test
Wladimir J. van der Laan 6e6b3b944d
Merge #14955: Switch all RNG code to the built-in PRNG
223de8d94d Document RNG design in random.h (Pieter Wuille)
f2e60ca985 Use secure allocator for RNG state (Pieter Wuille)
cddb31bb0a Encapsulate RNGState better (Pieter Wuille)
152146e782 DRY: Implement GetRand using FastRandomContext::randrange (Pieter Wuille)
a1f252eda8 Sprinkle some sweet noexcepts over the RNG code (Pieter Wuille)
4ea8e50837 Remove hwrand_initialized. (Pieter Wuille)
9d7032e4f0 Switch all RNG code to the built-in PRNG. (Pieter Wuille)
16e40a8b56 Integrate util/system's CInit into RNGState (Pieter Wuille)
2ccc3d3aa3 Abstract out seeding/extracting entropy into RNGState::MixExtract (Pieter Wuille)
aae8b9bf0f Add thread safety annotations to RNG state (Pieter Wuille)
d3f54d1c82 Rename some hardware RNG related functions (Pieter Wuille)
05fde14e3a Automatically initialize RNG on first use. (Pieter Wuille)
2d1cc50939 Don't log RandAddSeedPerfmon details (Pieter Wuille)
6a57ca91da Use FRC::randbytes instead of reading >32 bytes from RNG (Pieter Wuille)

Pull request description:

  This does not remove OpenSSL, but makes our own PRNG the 'main' one; for GetStrongRandBytes, the OpenSSL RNG is still used (indirectly, by feeding its output into our PRNG state).

  It includes a few policy changes (regarding what entropy is seeded when).

  Before this PR:
  * GetRand*:
    * OpenSSL
  * GetStrongRand*:
    * CPU cycle counter
    * Perfmon data (on Windows, once 10 min)
    * /dev/urandom (or equivalent)
    * rdrand (if available)
  * From scheduler when idle:
    * CPU cycle counter before and after 1ms sleep
  * At startup:
    * CPU cycle counter before and after 1ms sleep

  After this PR:
  * GetRand*:
    * Stack pointer (which indirectly identifies thread and some call stack information)
    * rdrand (if available)
    * CPU cycle counter
  * GetStrongRand*:
    * Stack pointer (which indirectly identifies thread and some call stack information)
    * rdrand (if available)
    * CPU cycle counter
    * /dev/urandom (or equivalent)
    * OpenSSL
    * CPU cycle counter again
  * From scheduler when idle:
    * Stack pointer (which indirectly identifies thread and some call stack information)
    * rdrand (if available)
    * CPU cycle counter before and after 1ms sleep
    * Perfmon data (on Windows, once every 10 min)
  * At startup:
    * Stack pointer (which indirectly identifies thread and some call stack information)
    * rdrand (if available)
    * CPU cycle counter
    * /dev/urandom (or equivalent)
    * OpenSSL
    * CPU cycle counter again
    * Perfmon data (on Windows, once every 10 min)

  The interface of random.h is also simplified, and documentation is added.

  This implements most of #14623.

Tree-SHA512: 0120e19bd4ce80a509b5c180a4f29497d299ce8242e25755880851344b825bc2d64a222bc245e659562fb5463fb7c70fbfcf003616be4dc59d0ed6534f93dd20
2019-01-21 19:46:45 +01: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 Use C++11 default member initializers 2019-01-05 16:16:37 +01:00
allocator_tests.cpp Merge #14151: windows: Fix remaining compiler warnings (MSVC) 2019-01-16 13:50:37 +01: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 rpc: Specify chain tip instead of chain in GetDifficulty 2018-09-09 18:02:22 +01:00
blockencodings_tests.cpp test: Add missing validation locks 2018-12-17 14:27:29 -05:00
blockfilter_tests.cpp blockfilter: Additional constructors for BlockFilter. 2018-11-06 09:12:54 -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 Fix cuckoocache_tests TSAN failure introduced in #14935. Fixes #14967. 2018-12-15 16:14:36 +01:00
coins_tests.cpp tests: Test for expected return values when calling functions returning a success code 2018-12-13 09:37:23 +01:00
compress_tests.cpp scripted-diff: Move util files to separate directory. 2018-11-04 22:46:07 -08:00
crypto_tests.cpp Fix remaining compiler warnings (MSVC). Move disabling of specific warnings from /nowarn to project file. 2019-01-15 20:15:26 +01:00
cuckoocache_tests.cpp Fix cuckoocache_tests TSAN failure introduced in #14935. Fixes #14967. 2018-12-15 16:14:36 +01:00
dbwrapper_tests.cpp tests: Test for expected return values when calling functions returning a success code 2018-12-13 09:37:23 +01:00
denialofservice_tests.cpp net: move BanMan to its own files 2019-01-16 13:54:18 -05: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 Merge #14599: Use functions guaranteed to be locale independent (IsDigit, ToLower) in {Format,Parse}Money(...), uint256::SetHex(...), etc. Remove the use of locale dependent boost::is_space(...) 2019-01-09 18:17:17 +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 Update copyright headers to 2018 2018-12-29 10:15:01 +01:00
key_properties.cpp scripted-diff: Move util files to separate directory. 2018-11-04 22:46:07 -08:00
key_tests.cpp tests: Test for expected return values when calling functions returning a success code 2018-12-13 09:37:23 +01: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 test: Add missing validation locks 2018-12-17 14:27:29 -05:00
merkle_tests.cpp Replace use of BEGIN and END macros on uint256 2019-01-10 01:58:33 +01:00
merkleblock_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
miner_tests.cpp test: Add missing validation locks 2018-12-17 14:27:29 -05:00
multisig_tests.cpp tests: Test for expected return values when calling functions returning a success code 2018-12-13 09:37:23 +01:00
net_tests.cpp Drop IsLimited in favor of IsReachable 2019-01-13 22:50:36 -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 test: Add missing validation locks 2018-12-17 14:27:29 -05:00
pow_tests.cpp [doc] conf: Remove deprecated options from docs, Other cleanup 2018-11-07 13:30:03 -05:00
prevector_tests.cpp Simplify testing RNG code 2018-12-12 14:28:15 -08:00
raii_event_tests.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
random_tests.cpp Bugfix: randbytes should seed when needed (non reachable issue) 2018-12-12 14:22:12 -08: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 scripted-diff: Replace boost::bind with std::bind 2018-10-20 02:29:59 +08:00
script_p2sh_tests.cpp Use std::vector API for construction of test data. 2019-01-04 08:11:44 +01:00
script_standard_tests.cpp tests: Test for expected return values when calling functions returning a success code 2018-12-13 09:37:23 +01:00
script_tests.cpp Fix remaining compiler warnings (MSVC). Move disabling of specific warnings from /nowarn to project file. 2019-01-15 20:15:26 +01: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: Remove unused seek(size_t) 2018-11-23 16:58:44 +01:00
sync_tests.cpp scripted-diff: Small locking rename 2018-08-31 10:00:38 -04:00
test_bitcoin.cpp Merge #14955: Switch all RNG code to the built-in PRNG 2019-01-21 19:46:45 +01:00
test_bitcoin.h tests: remove member connman/peerLogic in TestingSetup 2019-01-16 11:04:14 -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 net: move BanMan to its own files 2019-01-16 13:54:18 -05: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 Merge #14855: test: Correct ineffectual WithOrVersion from transactions_tests 2019-01-04 12:20:35 +01:00
txindex_tests.cpp Merge #14085: index: Fix for indexers skipping genesis block. 2019-01-09 14:48:11 +01:00
txvalidation_tests.cpp Update copyright headers to 2018 2018-12-29 10:15:01 +01:00
txvalidationcache_tests.cpp tests: Test for expected return values when calling functions returning a success code 2018-12-13 09:37:23 +01:00
uint256_tests.cpp Drop unused GetType() from CSizeComputer 2018-09-11 00:58:05 -04:00
util_tests.cpp util: Make ToLower and ToUpper take a char 2019-01-10 02:51:14 +01:00
validation_block_tests.cpp Merge #14811: Mining: Enforce that segwit option must be set in GBT 2018-12-21 13:46:06 +01: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/.