Skip to content

Latest commit

 

History

History
 
 

test

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
assets
assets
 
 
data
data
 
 
DoS_tests.cpp
DoS_tests.cpp
 
 
README.md
README.md
 
 
addrman_tests.cpp
addrman_tests.cpp
 
 
allocator_tests.cpp
allocator_tests.cpp
 
 
amount_tests.cpp
amount_tests.cpp
 
 
arith_uint256_tests.cpp
arith_uint256_tests.cpp
 
 
base32_tests.cpp
base32_tests.cpp
 
 
base58_tests.cpp
base58_tests.cpp
 
 
base64_tests.cpp
base64_tests.cpp
 
 
bech32_tests.cpp
bech32_tests.cpp
 
 
bip32_tests.cpp
bip32_tests.cpp
 
 
blockencodings_tests.cpp
blockencodings_tests.cpp
 
 
bloom_tests.cpp
bloom_tests.cpp
 
 
bswap_tests.cpp
bswap_tests.cpp
 
 
checkqueue_tests.cpp
checkqueue_tests.cpp
 
 
coins_tests.cpp
coins_tests.cpp
 
 
compress_tests.cpp
compress_tests.cpp
 
 
crypto_tests.cpp
crypto_tests.cpp
 
 
cuckoocache_tests.cpp
cuckoocache_tests.cpp
 
 
dbwrapper_tests.cpp
dbwrapper_tests.cpp
 
 
getarg_tests.cpp
getarg_tests.cpp
 
 
hash_tests.cpp
hash_tests.cpp
 
 
key_tests.cpp
key_tests.cpp
 
 
limitedmap_tests.cpp
limitedmap_tests.cpp
 
 
main_tests.cpp
main_tests.cpp
 
 
mempool_tests.cpp
mempool_tests.cpp
 
 
merkle_tests.cpp
merkle_tests.cpp
 
 
merkleblock_tests.cpp
merkleblock_tests.cpp
 
 
miner_tests.cpp
miner_tests.cpp
 
 
multisig_tests.cpp
multisig_tests.cpp
 
 
net_tests.cpp
net_tests.cpp
 
 
netbase_tests.cpp
netbase_tests.cpp
 
 
pmt_tests.cpp
pmt_tests.cpp
 
 
policyestimator_tests.cpp
policyestimator_tests.cpp
 
 
pow_tests.cpp
pow_tests.cpp
 
 
prevector_tests.cpp
prevector_tests.cpp
 
 
raii_event_tests.cpp
raii_event_tests.cpp
 
 
random_tests.cpp
random_tests.cpp
 
 
reverselock_tests.cpp
reverselock_tests.cpp
 
 
rpc_tests.cpp
rpc_tests.cpp
 
 
sanity_tests.cpp
sanity_tests.cpp
 
 
scheduler_tests.cpp
scheduler_tests.cpp
 
 
script_P2PKH_tests.cpp
script_P2PKH_tests.cpp
 
 
script_P2PK_tests.cpp
script_P2PK_tests.cpp
 
 
script_P2SH_tests.cpp
script_P2SH_tests.cpp
 
 
script_standard_tests.cpp
script_standard_tests.cpp
 
 
script_tests.cpp
script_tests.cpp
 
 
scriptnum10.h
scriptnum10.h
 
 
scriptnum_tests.cpp
scriptnum_tests.cpp
 
 
serialize_tests.cpp
serialize_tests.cpp
 
 
sighash_tests.cpp
sighash_tests.cpp
 
 
sigopcount_tests.cpp
sigopcount_tests.cpp
 
 
skiplist_tests.cpp
skiplist_tests.cpp
 
 
streams_tests.cpp
streams_tests.cpp
 
 
test_rito.cpp
test_rito.cpp
 
 
test_rito.h
test_rito.h
 
 
test_rito_fuzzy.cpp
test_rito_fuzzy.cpp
 
 
test_rito_hash.cpp
test_rito_hash.cpp
 
 
test_rito_main.cpp
test_rito_main.cpp
 
 
timedata_tests.cpp
timedata_tests.cpp
 
 
torcontrol_tests.cpp
torcontrol_tests.cpp
 
 
transaction_tests.cpp
transaction_tests.cpp
 
 
txvalidationcache_tests.cpp
txvalidationcache_tests.cpp
 
 
uint256_tests.cpp
uint256_tests.cpp
 
 
univalue_tests.cpp
univalue_tests.cpp
 
 
util_tests.cpp
util_tests.cpp
 
 
versionbits_tests.cpp
versionbits_tests.cpp
 
 

README.md

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 ritod tests manually, launch src/test/test_rito. 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 ritod tests.

To add more ritod 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 rito-qt tests manually, launch src/qt/test/test_rito-qt

To add more rito-qt tests, add them to the src/qt/test/ directory and the src/qt/test/test_main.cpp file.

To display progress information the unit tests should be run as follows:

test_runner --show_progress=true --colour_output=true

Additional optional parameters are available. To display all optional parameters run:

test_runner --help

Debugging unit tests

To display what individual tests are running (as they are running) use the --log_level=message parameter.

By default the log messages from the Rito Core application are not echoed when running the unit tests. If it is desired to print this log data change the following from 'false' to 'true' in the test_rito.cpp file and uncomment three lines in the script\interpreter.cpp\ VerifyScript method and recompile:

src\test\test_rito.cpp:
fPrintToConsole = false;  <-to->  fPrintToConsole = true;

script\interpreter.cpp\ VerifyScript method, uncomment:
//std::string str;
//str.assign(ScriptErrorString(*serror));
//std::cout << str << std::endl;

Previously several individual tests had the 'fPrintToConsole' parameter defaulted to 'true' causingthe unit test log window to be filled with superfluous log-data making it appear that the tests were failing.

Running individual tests

Run test_rito --list_content to get a full list of available unit tests.

To run just the 'getarg_tests' (verbosely):

test_rito --run_test=getarg_tests

... or to run just the doubledash test:

test_rito --run_test=getarg_tests/doubledash_test

Note on adding test cases

The sources in this directory are unit test cases. Boost includes a unit testing framework, and since rito 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_rito that runs all of the unit tests. The main source file is called test_rito.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/.