History

Elliot Olds 845b31a760 Check if zmq is installed in tests, update docs If ZMQ is enabled, check whether it's installed before running ZMQ tests. If it isn't, disable ZMQ and print a warning. Also add dependency info to test docs, so users know ZMQ is required before running tests, and so they know how to install it. When following the build instructions before this change then trying to run the RPC tests, a unix user would get an error when python tried to import zmq. There may be other dependencies that should be added to the docs, particularly ones for non-unix systems. This is the only unlisted dependency I encountered using linux.		2020-11-21 02:33:27 +00:00
..
pull-tester	Check if zmq is installed in tests, update docs	2020-11-21 02:33:27 +00:00
rpc-tests	[qa] keypool: DRY: Use test framework	2020-11-21 02:33:27 +00:00
zcash	Update expected fails for Sprout txns flows on Canopy	2020-11-16 15:57:49 -08:00
README.md	Check if zmq is installed in tests, update docs	2020-11-21 02:33:27 +00:00

README.md

The pull-tester folder contains a script to call multiple tests from the rpc-tests folder.

Every pull request to the zcash repository is built and run through the regression test suite. You can also run all or only individual tests locally.

Test dependencies

Before running the tests, the following must be installed.

Unix

The python-zmq library is required. On Ubuntu or Debian it can be installed via:

sudo apt-get install python-zmq

Running tests

You can run any single test by calling qa/pull-tester/rpc-tests.py <testname>.

Or you can run any combination of tests by calling qa/pull-tester/rpc-tests.py <testname1> <testname2> <testname3> ...

Run the regression test suite with qa/pull-tester/rpc-tests.py

Run all possible tests with qa/pull-tester/rpc-tests.py -extended

Possible options:

  -h, --help            show this help message and exit
  --nocleanup           Leave zcashds and test.* datadir on exit or error
  --noshutdown          Don't stop zcashds after the test execution
  --srcdir=SRCDIR       Source directory containing zcashd/zcash-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 output (example: PYTHON_DEBUG=1 qa/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 the miner subsidy from 25 mature blocks (25*10=250 ZEC) 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 zcashd

Writing tests

You are encouraged to write tests for new or existing features. Further information about the test framework and individual rpc tests is found in qa/rpc-tests.