Running tests

If you make any changes to the DeFiChain code, you should always update and run tests in order to verify functionality and prevent regressions.

defid tests are located in the following locations

/src/test: defid unit tests
/src/wallet/test: wallet unit tests
/test/functional: test using RPC and P2P interfaces
/test/util: test the defi utilities
/test/lint: static analysis checks

Running tests in requires defid to be compiled locally. Click here to learn more about how to compile locally.

Unit tests (including wallet unit tests)

Unit tests are compiled unless disabled in ./configure. After configuring and compiling, tests can be run by running make check, or by running the test_defi executable in src/test.

make check              # run tests using make
./src/test/test_defi    # run tests using test_defi from project root

To run an unit test suite, you can pass the filename (without the path and extension) to the --run_test argument in test_defi.

./src/test/test_defi --run_test=blockchain_tests

You can also run an individual unit test (denoted by BOOST_AUTO_TEST_CASE in test .cpp files) by specifying the test name after a /. For example, running the get_difficulty_for_very_low_target in blockchain_tests.cpp with all log level.

./src/test/test_defi --run_test=blockchain_tests/get_difficulty_for_very_low_target --log_level=all

test_defi has multiple configuration options, which can be listed by running test_defi --help.

Functional tests

The ZMQ functional test requires a python ZMQ library. Install the pyzmq dependency through pip or your system's package manager.

pip install pyzmq

Once you have compiled defid, you can run tests by

directly running the test's .py file

e.g. to run the feature_block tests, we would run
```
python test/functional/feature_block.py
```
using test_runner.py

e.g. to run the feature_block tests, we would run
```
python test/functional/test_runner.py feature_block.py
```
Multiple tests can be run using the test runner.
```
python test/functional/test_runner.py <testname1> <testname2> <testname3> ...
```
Wildcard test names can be passed, if the paths are coherent and the test runner is called from a bash shell or similar that supports globbing. For example, to run all the wallet tests
```
python test/functional/test_runner.py test/functional/wallet*     # called from project root
python functional/test_runner.py functional/wallet*               # called from the test/ directory
python test_runner.py wallet*                                     # called from the test/functional/ directory
```
The paths must be consistent. The following does not work as wallet* is not defined at the project root.
```
test/functional/test_runner.py wallet*
```
Combinations of wildcards can be passed. For example,
```
test/functional/test_runner.py ./test/functional/tool* test/functional/mempool*
```
```
test_runner.py tool* mempool*
```
Run the regression test suite with
```
test/functional/test_runner.py
```
Run all possible tests with
```
test/functional/test_runner.py --extended
```
By default, up to 4 tests will be run in parallel by test_runner. To specify how many jobs to run, append --jobs=n

The individual tests and the test_runner harness have many command-line options.
- --ansi: use ANSI colors and dots in output (enabled by default when standard output is a TTY)
- --combinedlogslen: on failure, print a log (of length n lines) to the console, combined from the test framework and all test nodes
- --coverage: generate a basic coverage report
- --ci: run checks and code that are usually only enabled in a continuous integration environment
- --exclude: specify a comma separated list of tests to exclude
- --extended: run the extended test suite in addition to the basic tests
- --help: print help text
- --jobs: how many test scripts to run in parallel, defaults to 4
- --keepcache: retain the cache from the previous testrun
- --quiet: only prints dots, results summary and failure logs
- --tmpdirprefix: directory for datadirs
- --failfast: stop execution after the first test failure
- --filter: run scripts by filtering using regex

Util tests

Util tests can be run locally by running test/util/defi-util-test.py. Use the -v option for verbose output.

Lint tests

Lint tests requires codespell and flake8 dependencies, you can install them using pip or your system's package manager.

pip install codespell flake8

Individual tests can be run by directly calling the test script.

./test/lint/<filename>.sh

You can run all the shell-based lint tests by running lint-all.sh.

./test/lint/lint-all.sh

DeFiChain Handbook

Running tests

Unit tests (including wallet unit tests)

Functional tests

Util tests

Lint tests