History

Alfredo Garcia b1ffc89454 feat(rpc): Cookie auth system for the RPC endpoint (#8900 ) * add a cookie auth system for the rpc endpoint * fix rand import * fixes based on cookie method research * add and use `cookie_dir` config, rpc client changes * add missing dependency * add a enable_cookie auth option to config and use it in all tests * get rid of the unauthenticated method * change config in qa python tests to run unauthenticated * change return types in cookie methods * change comment * fix(rpc): Refactor the cookie-based RPC authentication (#8940) * Refactor the cookie-based RPC authentication * Rephrase docs * Apply suggestions from code review Co-authored-by: Arya <aryasolhi@gmail.com> --------- Co-authored-by: Arya <aryasolhi@gmail.com> * clippy --------- Co-authored-by: Marek <mail@marek.onl> Co-authored-by: Arya <aryasolhi@gmail.com>		2024-10-22 09:45:26 +00:00
..
pull-tester	feat(regtest): Add regtest halving interval and port test (#8888 )	2024-10-10 18:26:54 +00:00
rpc-tests	feat(regtest): Add regtest halving interval and port test (#8888 )	2024-10-10 18:26:54 +00:00
README.md	feat(tests): Move the RPC tests framework from zcashd (#8866 )	2024-09-20 16:36:20 +00:00
base_config.toml	feat(rpc): Cookie auth system for the RPC endpoint (#8900 )	2024-10-22 09:45:26 +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 zebra 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 zmq, toml and base58 Python libraries are required. On Ubuntu or Debian-based distributions they can be installed via:

sudo apt-get install python3-zmq python3-base58

OS X

pip3 install pyzmq base58 toml

Running tests locally

Make sure zebrad binary exists in the ../target/debug/ folder or set the binary path with:

export CARGO_BIN_EXE_zebrad=/path/to/zebrad

You can run any single test by calling

./qa/pull-tester/rpc-tests.py <testname1>

Run the regression test suite with

./qa/pull-tester/rpc-tests.py

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