zcash-hackworks
/
zcash-patched-for-explorer
mirror of https://github.com/zcash-hackworks/zcash-patched-for-explorer.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Auto merge of #1607 - daira:1530.update-unit-tests-doc, r=daira 

Update unit-tests documentation. closes #1530

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
This commit is contained in:
zkbot 2016-10-22 15:57:44 -04:00
parent 30d3d2dfd4 6316cc2b48
commit f39d176ebf
1 changed files with 11 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
doc/unit-tests.md
View File

@ -1,20 +1,17 @@
*** Warning: This document has not been updated for Zcash and may be inaccurate. ***
Compiling/running automated tests
---------------------------------
Compiling/running unit tests
------------------------------------
Unit tests will be automatically compiled if dependencies were met in configure
Automated 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'.
There are two scripts for running tests:
To run the bitcoind tests manually, launch src/test/test_bitcoin .
* ``qa/zcash/full-test-suite.sh``, to run the main test suite
* ``qa/pull-tester/rpc-tests.sh``, to run the RPC tests.
To add more bitcoind 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.
The main test suite uses two different testing frameworks. Tests using the Boost
framework are under ``src/test/``; tests using the Google Test/Google Mock
framework are under ``src/gtest/`` and ``src/wallet/gtest/``. The latter framework
is preferred for new Zcash unit tests.
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.
RPC tests are implemented in Python under the ``qa/rpc-tests/`` directory.