History

Jack Grigg 0255964559 qa: Add RPC test testing Orchard note position persistence The test fails during the final `z_sendmany`, because it is selecting a note that was detected before restarting the node. Because we force the wallet to call `SetBestChain` on every block, the wallet doesn't need to rescan on restart, and thus doesn't repopulate the `position` field of the in-memory note. This issue went unnoticed in existing tests that exercise node restarts, because the RPC tests are fast enough that they never pass the 10-minute timeout for writing the wallet state. This commit adds a regtest-only config option that disables the lazy writing.		2022-03-30 23:23:27 +00:00
..
pull-tester	qa: Add RPC test testing Orchard note position persistence	2022-03-30 23:23:27 +00:00
rpc-tests	qa: Add RPC test testing Orchard note position persistence	2022-03-30 23:23:27 +00:00
zcash	qa: Exclude `native_libtinfo` from dependency update checks	2022-03-22 19:33:14 +00:00
README.md	…

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 python3-zmq library is required. On Ubuntu or Debian it can be installed via:

sudo apt-get install python3-zmq

OS X

pip3 install pyzmq

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

By default, tests will be run in parallel. To specify how many jobs to run, append --jobs=n (default n=4).

If you want to create a basic coverage report for the RPC test suite, append --coverage.

Possible options, which apply to each individual test run:

  -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.