Document how to build/run unit tests

This commit is contained in:
Gavin Andresen 2012-06-14 20:44:04 -04:00 committed by Luke Dashjr
parent b0e508a0c0
commit fa57170187

18
doc/unit-tests.txt Normal file
View File

@ -0,0 +1,18 @@
Compiling/runing bitcoind unit tests
------------------------------------
bitcoind unit tests are in the src/test/ directory; they
use the Boost::Test unit-testing framework.
To compile and run the tests:
cd src
make -f makefile.unix test_bitcoin # Replace makefile.unix if you're not on unix
./test_bitcoin # Runs the unit tests
If all tests succeed the last line of output will be:
*** No errors detected
To add more tests, add BOOST_AUTO_TEST_CASE's to the existing
.cpp files in the test/ directory or add new .cpp files that
implement new BOOST_AUTO_TEST_SUITE's (and add them to the
list of includes in test_bitcoin.cpp).