mirror of
https://github.com/dashpay/dash.git
synced 2024-12-29 05:49:11 +01:00
4789d90589
478d4fb79 [docs] explain how to recompile only what bitcoind tests need (Sjors Provoost)
Pull request description:
It was not obvious to me to run `make` inside the test directory, especially because `make src/test` and `make src/test/test_bitcoin` result in `make: Nothing to be done for ...`.
Tree-SHA512: 5fe66c45c50af42d4fed42e3008b1dc4de7ea448f5265a34f4b2f355aa4a48a8187918a49fc9f82e8dd9706bc72c59d0fd67d86057fd816eb317832e46ada7ba
56 lines
2.3 KiB
Markdown
56 lines
2.3 KiB
Markdown
### 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 dashd tests manually, launch `src/test/test_dash`. 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 dashd tests.
|
|
|
|
To add more dashd 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 dash-qt tests manually, launch `src/qt/test/test_dash-qt`
|
|
|
|
To add more dash-qt tests, add them to the `src/qt/test/` directory and
|
|
the `src/qt/test/test_main.cpp` file.
|
|
|
|
### Running individual tests
|
|
|
|
test_dash has some built-in command-line arguments; for
|
|
example, to run just the getarg_tests verbosely:
|
|
|
|
test_dash --log_level=all --run_test=getarg_tests
|
|
|
|
... or to run just the doubledash test:
|
|
|
|
test_dash --run_test=getarg_tests/doubledash
|
|
|
|
Run `test_dash --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 Dash 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_dash`
|
|
that runs all of the unit tests. The main source file is called
|
|
test_dash.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/](http://www.alittlemadness.com/2009/03/31/c-unit-testing-with-boosttest/).
|