History

Wladimir J. van der Laan 1709cc5cb0 Merge pull request #7338 `f17b00b` release-notes: Combine NOP2->CLTV asm change into "RPC: Low-level API changes" section (Luke Dashjr) `e20704b` Replace some instances of formatWithUnit with formatHtmlWithUnit (fanquake) `6f8346d` qt5: Use the fixed font the system recommends (MarcoFalke) `605de4a` Rename OP_NOP2 to OP_CHECKLOCKTIMEVERIFY. (mb300sd) `6191a9b` [RPC-Tests] add option to run rpc test over QT clients (Jonas Schnelli) `6307beb` Note that reviewers should mention the commit hash of the commits they reviewed. (Patrick Strateman) `6092ff2` Set link from http:// to https:// (Suriyaa Kudo)		2016-01-18 10:36:57 +01:00
..
pull-tester	Add RPC call abandontransaction	2016-01-13 15:55:00 +01:00
rpc-tests	Merge pull request #7338	2016-01-18 10:36:57 +01:00
README.md	[qa] Extend README.md	2015-11-18 11:59:12 +01:00

README.md

The pull-tester folder contains a script to call multiple tests from the rpc-tests folder.

Every pull request to the bitcoin 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 <testname>.

Or you can run any combination of tests by calling qa/pull-tester/rpc-tests.py <testname1> <testname2> <testname3> ...

Run the regression test suite with qa/pull-tester/rpc-tests.py

Run all possible tests with qa/pull-tester/rpc-tests.py -extended

Possible options:

  -h, --help            show this help message and exit
  --nocleanup           Leave bitcoinds and test.* datadir on exit or error
  --noshutdown          Don't stop bitcoinds after the test execution
  --srcdir=SRCDIR       Source directory containing bitcoind/bitcoin-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 25 mature blocks (25*50=1250 BTC) 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 bitcoind

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.