diff --git a/doc/unit-tests.md b/doc/unit-tests.md index 1eef71c37..651d41818 100644 --- a/doc/unit-tests.md +++ b/doc/unit-tests.md @@ -1,67 +1,67 @@ ### 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 `src/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 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 `_tests.cpp` and such files should wrap their tests in a test suite called `_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/](http://www.alittlemadness.com/2009/03/31/c-unit-testing-with-boosttest/). +[https://legalizeadulthood.wordpress.com/2009/07/04/c-unit-tests-with-boost-test-part-1/](https://legalizeadulthood.wordpress.com/2009/07/04/c-unit-tests-with-boost-test-part-1/) ### Debugging unit tests Simple example of debugging unit tests with GDB on Linux: ``` cd /build/src/test gdb test_bitcoin break interpreter.cpp:295 # No path is necessary, just the file name and line number run # GDB hits the breakpoint p/x opcode # print the value of the variable (in this case, opcode) in hex c # continue ``` Simple example of debugging unit tests with LLDB (OSX or Linux): ``` cd /build/src/test lldb -- test_bitcoin break set --file interpreter.cpp --line 295 run ```