forked from ZcashFoundation/zebra
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(tests): Move the RPC tests framework from zcashd (ZcashFoundatio…
…n#8866) * move the rpc-tests framework from zcashd * ignore pycache * remove all tests from the list except getmininginfo * iimprove a bit the readme * change some env variable names * add cache, add reindex test * fix the paralell framework * fix env variables * change tests order * update docs with env variable name change * fix binary location * reduce base config * restore env var * ignore stderr in the output
- Loading branch information
1 parent
0c23cca
commit 845009a
Showing
27 changed files
with
7,377 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -158,3 +158,9 @@ $RECYCLE.BIN/ | |
|
||
# Windows shortcuts | ||
*.lnk | ||
|
||
# Python pycache | ||
__pycache__/ | ||
|
||
# RPC tests cache | ||
zebra-rpc/qa/cache/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
The [pull-tester](/pull-tester/) folder contains a script to call | ||
multiple tests from the [rpc-tests](/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: | ||
|
||
```bash | ||
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](rpc-tests). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
[mining] | ||
miner_address = "t27eWDgjFYJGVXmzrXeVjnb5J3uXDM9xH9v" | ||
|
||
[network] | ||
listen_addr = "127.0.0.1:0" | ||
network = "Regtest" | ||
|
||
[rpc] | ||
listen_addr = "127.0.0.1:0" | ||
|
||
[state] | ||
cache_dir = "" |
Oops, something went wrong.