lbrycrd/src/test
Wladimir J. van der Laan 224e6eb089 util: Specific GetOSRandom for Linux/FreeBSD/OpenBSD
These are available in sandboxes without access to files or
devices. Also [they are safer and more straightforward](https://en.wikipedia.org/wiki/Entropy-supplying_system_calls)
to use than `/dev/urandom` as reading from a file has quite a few edge
cases:

- Linux: `getrandom(buf, buflen, 0)`. [getrandom(2)](http://man7.org/linux/man-pages/man2/getrandom.2.html)
  was introduced in version 3.17 of the Linux kernel.
- OpenBSD: `getentropy(buf, buflen)`. The [getentropy(2)](http://man.openbsd.org/cgi-bin/man.cgi/OpenBSD-current/man2/getentropy.2)
  function appeared in OpenBSD 5.6.
- FreeBSD and NetBSD: `sysctl(KERN_ARND)`. Not sure when this was added
  but it has existed for quite a while.

Alternatives:

- Linux has sysctl `CTL_KERN` / `KERN_RANDOM` / `RANDOM_UUID`
  which gives 16 bytes of randomness. This may be available
  on older kernels, however [sysctl is deprecated on Linux](https://lwn.net/Articles/605392/)
  and even removed in some distros so we shouldn't use it.

Add tests for `GetOSRand()`:

- Test that no error happens (otherwise `RandFailure()` which aborts)
- Test that all 32 bytes are overwritten (initialize with zeros, try multiple times)

Discussion:

- When to use these? Currently they are always used when available.
  Another option would be to use them only when `/dev/urandom` is not
  available. But this would mean these code paths receive less testing,
  and I'm not sure there is any reason to prefer `/dev/urandom`.

Closes: #9676
2017-02-21 20:57:34 +01:00
..
data testcases: explicitly specify transaction version 1 2017-01-09 16:42:45 -05:00
addrman_tests.cpp [test] Avoid potential NULL pointer dereference in addrman_tests.cpp 2017-01-14 20:18:20 +01:00
allocator_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
amount_tests.cpp [amount] tests: Fix off-by-one mistake 2016-04-09 15:28:22 +02:00
arith_uint256_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
base32_tests.cpp Bump copyright headers to 2015 2015-12-13 18:08:39 +01:00
base58_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
base64_tests.cpp Bump copyright headers to 2015 2015-12-13 18:08:39 +01:00
bctest.py [copyright] copyright header style uniform 2016-11-06 10:12:50 -07:00
bip32_tests.cpp add bip32 pubkey serialization 2016-04-14 20:56:33 +02:00
bitcoin-util-test.py Remove unused Python imports 2017-01-13 19:03:20 +01:00
blockencodings_tests.cpp Use replaced transactions in compact block reconstruction 2017-01-10 14:48:42 -05:00
bloom_tests.cpp Merge #9281: Refactor: Remove using namespace <xxx> from bench/ & test/ sources 2017-01-05 11:32:05 +01:00
bswap_tests.cpp Uses built-in byte swap if available (Apple) and if bswap_XX is undefined. 2016-12-17 12:27:00 +09:00
buildenv.py.in Use portable #! in python scripts (/usr/bin/env) 2016-06-26 16:47:03 +03:00
coins_tests.cpp Check FRESH validity in CCoinsViewCache::BatchWrite 2017-01-04 14:56:17 -05:00
compress_tests.cpp Bump copyright headers to 2015 2015-12-13 18:08:39 +01:00
crypto_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
cuckoocache_tests.cpp [Trivial] Grammar and typo correction 2017-01-22 13:18:51 +01:00
dbwrapper_tests.cpp [Trivial] Grammar and typo correction 2017-01-22 13:18:51 +01:00
DoS_tests.cpp [Trivial] Update comments referencing main.cpp 2017-02-16 13:52:38 +01:00
getarg_tests.cpp Bump copyright headers to 2015 2015-12-13 18:08:39 +01:00
hash_tests.cpp Merge #9281: Refactor: Remove using namespace <xxx> from bench/ & test/ sources 2017-01-05 11:32:05 +01:00
key_tests.cpp Refactoring: Removed using namespace <xxx> from bench/ and test/ source files. 2017-01-02 20:35:23 +09:00
limitedmap_tests.cpp [Trivial] Grammar and typo correction 2017-01-22 13:18:51 +01:00
main_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
Makefile build: add stub makefiles for easier subdir builds 2014-06-05 16:05:43 -04:00
mempool_tests.cpp Remove member variable hadNoDependencies from CTxMemPoolEntry 2017-01-04 12:09:33 -05:00
merkle_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
miner_tests.cpp Fix to have miner test aware of new separate block min tx fee 2017-01-19 21:35:39 -05:00
multisig_tests.cpp Merge #9281: Refactor: Remove using namespace <xxx> from bench/ & test/ sources 2017-01-05 11:32:05 +01:00
net_tests.cpp Fix memory leak in net_tests 2017-01-12 11:52:53 -08:00
netbase_tests.cpp Merge #9281: Refactor: Remove using namespace <xxx> from bench/ & test/ sources 2017-01-05 11:32:05 +01:00
pmt_tests.cpp Merge #9281: Refactor: Remove using namespace <xxx> from bench/ & test/ sources 2017-01-05 11:32:05 +01:00
policyestimator_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
pow_tests.cpp Refactoring: Removed using namespace <xxx> from bench/ and test/ source files. 2017-01-02 20:35:23 +09:00
prevector_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
raii_event_tests.cpp Skip RAII event tests if libevent is built without event_set_mem_functions 2017-01-28 08:04:57 +00:00
random_tests.cpp util: Specific GetOSRandom for Linux/FreeBSD/OpenBSD 2017-02-21 20:57:34 +01:00
README.md Merge doc/unit-tests.md into src/test/README.md 2016-11-02 18:19:43 +01:00
reverselock_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
rpc_tests.cpp Merge #9281: Refactor: Remove using namespace <xxx> from bench/ & test/ sources 2017-01-05 11:32:05 +01:00
sanity_tests.cpp Bump copyright headers to 2015 2015-12-13 18:08:39 +01:00
scheduler_tests.cpp [Trivial] Grammar and typo correction 2017-01-22 13:18:51 +01:00
script_P2SH_tests.cpp Merge #9281: Refactor: Remove using namespace <xxx> from bench/ & test/ sources 2017-01-05 11:32:05 +01:00
script_tests.cpp [Trivial] Grammar and typo correction 2017-01-22 13:18:51 +01:00
scriptnum10.h Bump copyright headers to 2015 2015-12-13 18:08:39 +01:00
scriptnum_tests.cpp Avoid integer overflows in scriptnum tests 2017-01-12 11:52:53 -08:00
serialize_tests.cpp [trivial] Fix typos in comments 2017-01-27 21:22:35 +01:00
sighash_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
sigopcount_tests.cpp Merge #9281: Refactor: Remove using namespace <xxx> from bench/ & test/ sources 2017-01-05 11:32:05 +01:00
skiplist_tests.cpp Add unit test for FindEarliestAtLeast 2017-01-12 14:22:15 +00:00
streams_tests.cpp Merge #9281: Refactor: Remove using namespace <xxx> from bench/ & test/ sources 2017-01-05 11:32:05 +01:00
test_bitcoin.cpp [Trivial] Grammar and typo correction 2017-01-22 13:18:51 +01:00
test_bitcoin.h Remove member variable hadNoDependencies from CTxMemPoolEntry 2017-01-04 12:09:33 -05:00
test_bitcoin_fuzzy.cpp Init ECC context for test_bitcoin_fuzzy. 2017-02-05 17:37:13 +00:00
test_random.h Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
testutil.cpp Remove fallbacks for boost_filesystem < v3 2017-02-10 12:32:52 +01:00
testutil.h Move GetTempPath() to testutil. 2016-03-11 15:04:05 +00:00
timedata_tests.cpp Refactoring: Removed using namespace <xxx> from bench/ and test/ source files. 2017-01-02 20:35:23 +09:00
transaction_tests.cpp Merge #9380: Separate different uses of minimum fees 2017-01-16 19:33:08 +01:00
txvalidationcache_tests.cpp Make ATMP optionally return the CTransactionRefs it replaced 2017-01-09 14:15:18 -05:00
uint256_tests.cpp Increment MIT Licence copyright header year on files modified in 2016 2016-12-31 11:01:21 -07:00
univalue_tests.cpp Merge #9281: Refactor: Remove using namespace <xxx> from bench/ & test/ sources 2017-01-05 11:32:05 +01:00
util_tests.cpp Merge #9281: Refactor: Remove using namespace <xxx> from bench/ & test/ sources 2017-01-05 11:32:05 +01:00
versionbits_tests.cpp Remove redundant semicolons 2017-01-14 21:45:32 +01: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 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/.

bitcoin-util-test.py

The test directory also contains the bitcoin-util-test.py tool, which tests bitcoin utils (currently just bitcoin-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]