Find file History
#573 Compare This branch is 196 commits ahead, 3254 commits behind bitcoin:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
data
DoS_tests.cpp
Makefile
README.md
addrman_tests.cpp
allocator_tests.cpp
amount_tests.cpp
arith_uint256_tests.cpp
base32_tests.cpp
base58_tests.cpp
base64_tests.cpp
bech32_tests.cpp
bip32_tests.cpp
blockchain_tests.cpp
blockencodings_tests.cpp
bloom_tests.cpp
bswap_tests.cpp
checkqueue_tests.cpp
coins_tests.cpp
compress_tests.cpp
crypto_tests.cpp
cuckoocache_tests.cpp
dbwrapper_tests.cpp
getarg_tests.cpp
hash_tests.cpp
key_tests.cpp
limitedmap_tests.cpp
main_tests.cpp
mempool_tests.cpp
merkle_tests.cpp
merkleblock_tests.cpp
miner_tests.cpp
multisig_tests.cpp
net_tests.cpp
netbase_tests.cpp
pmt_tests.cpp
policyestimator_tests.cpp
pow_tests.cpp
prevector_tests.cpp
raii_event_tests.cpp
random_tests.cpp
reverselock_tests.cpp
rpc_tests.cpp
sanity_tests.cpp
scheduler_tests.cpp
script_P2SH_tests.cpp
script_standard_tests.cpp
script_tests.cpp
scriptnum10.h
scriptnum_tests.cpp
scrypt_tests.cpp
serialize_tests.cpp
sighash_tests.cpp
sigopcount_tests.cpp
skiplist_tests.cpp
streams_tests.cpp
test_bitcoin.cpp
test_bitcoin.h
test_bitcoin_fuzzy.cpp
test_bitcoin_main.cpp
timedata_tests.cpp
torcontrol_tests.cpp
transaction_tests.cpp
txvalidation_tests.cpp
txvalidationcache_tests.cpp
uint256_tests.cpp
util_tests.cpp
validation_block_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 litecoind tests manually, launch src/test/test_litecoin. 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 litecoind tests.

To add more litecoind 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 litecoin-qt tests manually, launch src/qt/test/test_litecoin-qt

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

Running individual tests

test_litecoin has some built-in command-line arguments; for example, to run just the getarg_tests verbosely:

test_litecoin --log_level=all --run_test=getarg_tests

... or to run just the doubledash test:

test_litecoin --run_test=getarg_tests/doubledash

Run test_litecoin --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 litecoin 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_litecoin" that runs all of the unit tests. The main source file is called test_bitcoin.cpp, which simply includes other files that contain the actual unit tests (outside of a couple required preprocessor directives). 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 examples of this pattern, examine uint160_tests.cpp and uint256_tests.cpp.

Add the source files to /src/Makefile.test.include to add them to the build.

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/.