Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
61 lines (41 sloc) 2.45 KB

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

To add more neond 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 neon-qt tests manually, launch src/qt/test/test_neon-qt

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

Running individual tests

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

test_neon --log_level=all --run_test=getarg_tests

... or to run just the doubleneon test:

test_neon --run_test=getarg_tests/doubleneon

Run test_neon --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 Nucleon Core 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_neon that runs all of the unit tests. The main source file is called test_neon.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:

The test directory also contains the tool, which tests bitcoin utils (currently just neon-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/ --srcdir=[current directory]