[qa] Split README.md to /qa and /qa/rpc-tests
[bitcoinplatinum.git] / qa / README.md
blob93157f4f1f93ceadfe4b05bd64ea74b3d0b26f1e
1 Notes
2 =====
4 You can run any single test by calling `qa/pull-tester/rpc-tests.py <testname>`.
6 Or you can run any combination of tests by calling `qa/pull-tester/rpc-tests.py <testname1> <testname2> <testname3> ...`
8 Run the regression test suite with `qa/pull-tester/rpc-tests.py`
10 Run all possible tests with `qa/pull-tester/rpc-tests.py -extended`
12 Possible options:
14 ```
15   -h, --help            show this help message and exit
16   --nocleanup           Leave bitcoinds and test.* datadir on exit or error
17   --noshutdown          Don't stop bitcoinds after the test execution
18   --srcdir=SRCDIR       Source directory containing bitcoind/bitcoin-cli
19                         (default: ../../src)
20   --tmpdir=TMPDIR       Root directory for datadirs
21   --tracerpc            Print out all RPC calls as they are made
22   --coveragedir=COVERAGEDIR
23                         Write tested RPC commands into this directory
24 ```
26 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`). 
28 A 200-block -regtest blockchain and wallets for four nodes
29 is created the first time a regression test is run and
30 is stored in the cache/ directory. Each node has 25 mature
31 blocks (25*50=1250 BTC) in its wallet.
33 After the first run, the cache/ blockchain and wallets are
34 copied into a temporary directory and used as the initial
35 test state.
37 If you get into a bad state, you should be able
38 to recover with:
40 ```bash
41 rm -rf cache
42 killall bitcoind
43 ```
45 Further information about the test framework and individual rpc
46 tests is found in [qa/rpc-tests/README.md](/qa/rpc-tests/README.md).