Skip to content

Commit cc97574

Browse files
author
MarcoFalke
committed
[qa] Split README.md to /qa and /qa/rpc-tests
+ Update with new -help message
1 parent e54ebbf commit cc97574

File tree

2 files changed

+46
-43
lines changed

2 files changed

+46
-43
lines changed

qa/README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
Notes
2+
=====
3+
4+
You can run any single test by calling `qa/pull-tester/rpc-tests.py <testname>`.
5+
6+
Or you can run any combination of tests by calling `qa/pull-tester/rpc-tests.py <testname1> <testname2> <testname3> ...`
7+
8+
Run the regression test suite with `qa/pull-tester/rpc-tests.py`
9+
10+
Run all possible tests with `qa/pull-tester/rpc-tests.py -extended`
11+
12+
Possible options:
13+
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+
```
25+
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`).
27+
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.
32+
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.
36+
37+
If you get into a bad state, you should be able
38+
to recover with:
39+
40+
```bash
41+
rm -rf cache
42+
killall bitcoind
43+
```
44+
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).

qa/rpc-tests/README.md

Lines changed: 0 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -33,49 +33,6 @@ Helpers for script.py
3333
### [test_framework/blocktools.py](test_framework/blocktools.py)
3434
Helper functions for creating blocks and transactions.
3535

36-
37-
Notes
38-
=====
39-
40-
You can run any single test by calling `qa/pull-tester/rpc-tests.py <testname>`.
41-
42-
Or you can run any combination of tests by calling `qa/pull-tester/rpc-tests.py <testname1> <testname2> <testname3> ...`
43-
44-
Run the regression test suite with `qa/pull-tester/rpc-tests.py`
45-
46-
Run all possible tests with `qa/pull-tester/rpc-tests.py -extended`
47-
48-
Possible options:
49-
50-
```
51-
-h, --help show this help message and exit
52-
--nocleanup Leave bitcoinds and test.* datadir on exit or error
53-
--noshutdown Don't stop bitcoinds after the test execution
54-
--srcdir=SRCDIR Source directory containing bitcoind/bitcoin-cli (default:
55-
../../src)
56-
--tmpdir=TMPDIR Root directory for datadirs
57-
--tracerpc Print out all RPC calls as they are made
58-
```
59-
60-
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`).
61-
62-
A 200-block -regtest blockchain and wallets for four nodes
63-
is created the first time a regression test is run and
64-
is stored in the cache/ directory. Each node has 25 mature
65-
blocks (25*50=1250 BTC) in its wallet.
66-
67-
After the first run, the cache/ blockchain and wallets are
68-
copied into a temporary directory and used as the initial
69-
test state.
70-
71-
If you get into a bad state, you should be able
72-
to recover with:
73-
74-
```bash
75-
rm -rf cache
76-
killall bitcoind
77-
```
78-
7936
P2P test design notes
8037
---------------------
8138

0 commit comments

Comments
 (0)