History

Jack Grigg 89b9bbaf33 wallet: Separate counters for external and internal transparent keys This fixes a potential bug with importing the mnemonic into a third party transparent wallet. Previously, if a user called `getnewaddress`, made a bunch of transactions that generated at least 20 change addresses, and then called `getnewaddress` again, the two external addresses would be separated by a gap of more than 20. If this mnemonic were imported into a third party transparent wallet, the wallet would not detect any funds in the second (or subsequent) transparent addresses because it would detect 20 unused addresses in a row (via the BIP 44 default gap limit). Now, we track external and internal keys separately; repeated calls to `getnewaddress` will return addresses for sequential keys. This has the added benefit that the sequence of `getnewaddress` outputs will be the same after restoring from a backup.		2022-02-10 21:26:29 +00:00
..
pull-tester	allow UA as z_shieldcoinbase destination	2022-02-03 08:31:26 -07:00
rpc-tests	wallet: Separate counters for external and internal transparent keys	2022-02-10 21:26:29 +00:00
zcash	Fix typos	2022-01-02 23:16:01 +02:00
README.md	[qa][doc] Correct rpc test options in readme	2020-11-21 03:03:55 +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 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.