Every pull request to the bitcoin repository is built and run through the regression test suite. You can also run all or only individual tests locally.
Before running the tests, the following must be installed.
The python3-zmq library is required. On Ubuntu or Debian it can be installed via:
sudo apt-get install python3-zmq
pip3 install pyzmq
You can run any single test by calling
Or you can run any combination of tests by calling
test/pull-tester/rpc-tests.py <testname1> <testname2> <testname3> ...
Run the regression test suite with
Run all possible tests with
By default, tests will be run in parallel. To specify how many jobs to run,
--jobs=n (default n=4).
If you want to create a basic coverage report for the RPC test suite, append
Possible options, which apply to each individual test run:
-h, --help show this help message and exit --nocleanup Leave bitcoinds and test.* datadir on exit or error --noshutdown Don't stop bitcoinds after the test execution --srcdir=SRCDIR Source directory containing bitcoind/bitcoin-cli (default: ../../src) --tmpdir=TMPDIR Root directory for datadirs --tracerpc Print out all RPC calls as they are made --coveragedir=COVERAGEDIR Write tested RPC commands into this directory
If you set the environment variable
PYTHON_DEBUG=1 you will get some debug
PYTHON_DEBUG=1 test/pull-tester/rpc-tests.py wallet).
A 200-block -regtest blockchain and wallets for four nodes is created the first time a regression test is run and is stored in the cache/ directory. Each node has 25 mature blocks (25*50=1250 BTC) in its wallet.
After the first run, the cache/ blockchain and wallets are copied into a temporary directory and used as the initial test state.
If you get into a bad state, you should be able to recover with:
rm -rf cache killall bitcoind
You are encouraged to write tests for new or existing features. Further information about the test framework and individual functional tests is found in test/functional.