From 01c36295c489b18ae3f68281106e8d97bf232936 Mon Sep 17 00:00:00 2001 From: MarcoFalke Date: Wed, 18 Nov 2015 00:26:07 +0100 Subject: [PATCH] [qa] Extend README.md --- qa/README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/qa/README.md b/qa/README.md index 44ae40b3b..0e2b49cdd 100644 --- a/qa/README.md +++ b/qa/README.md @@ -1,5 +1,12 @@ -Notes -===== +The [pull-tester](/qa/pull-tester/) folder contains a script to call +multiple tests from the [rpc-tests](/qa/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. + +Running tests +============= You can run any single test by calling `qa/pull-tester/rpc-tests.py `. @@ -23,7 +30,8 @@ Possible options: 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`). +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 @@ -42,5 +50,8 @@ 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/README.md](/qa/rpc-tests/README.md). +tests is found in [qa/rpc-tests](/qa/rpc-tests).