History

Pieter Wuille 1088b02f0c Merge #10195 : Switch chainstate db and cache to per-txout model `589827975` scripted-diff: various renames for per-utxo consistency (Pieter Wuille) `a5e02bc7f` Increase travis unit test timeout (Pieter Wuille) `73de2c1ff` Rename CCoinsCacheEntry::coins to coin (Pieter Wuille) `119e552f7` Merge CCoinsViewCache's GetOutputFor and AccessCoin (Pieter Wuille) `580b02309` [MOVEONLY] Move old CCoins class to txdb.cpp (Pieter Wuille) `8b25d2c0c` Upgrade from per-tx database to per-txout (Pieter Wuille) `b2af357f3` Reduce reserved memory space for flushing (Pieter Wuille) `41aa5b79a` Pack Coin more tightly (Pieter Wuille) `97072d668` Remove unused CCoins methods (Pieter Wuille) `ce23efaa5` Extend coins_tests (Pieter Wuille) `508307968` Switch CCoinsView and chainstate db from per-txid to per-txout (Pieter Wuille) `4ec0d9e79` Refactor GetUTXOStats in preparation for per-COutPoint iteration (Pieter Wuille) `13870b56f` Replace CCoins-based CTxMemPool::pruneSpent with isSpent (Pieter Wuille) `05293f3cb` Remove ModifyCoins/ModifyNewCoins (Pieter Wuille) `961e48397` Switch tests from ModifyCoins to AddCoin/SpendCoin (Pieter Wuille) `8b3868c1b` Switch CScriptCheck to use Coin instead of CCoins (Pieter Wuille) `c87b957a3` Only pass things committed to by tx's witness hash to CScriptCheck (Matt Corallo) `f68cdfe92` Switch from per-tx to per-txout CCoinsViewCache methods in some places (Pieter Wuille) `000391132` Introduce new per-txout CCoinsViewCache functions (Pieter Wuille) `bd83111a0` Optimization: Coin&& to ApplyTxInUndo (Pieter Wuille) `cb2c7fdac` Replace CTxInUndo with Coin (Pieter Wuille) `422634e2f` Introduce Coin, a single unspent output (Pieter Wuille) `7d991b55d` Store/allow tx metadata in all undo records (Pieter Wuille) `c3aa0c119` Report on-disk size in gettxoutsetinfo (Pieter Wuille) `d34242430` Remove/ignore tx version in utxo and undo (Pieter Wuille) `7e0032290` Add specialization of SipHash for 256 + 32 bit data (Pieter Wuille) `e484652fc` Introduce CHashVerifier to hash read data (Pieter Wuille) `f54580e7e` error() in disconnect for disk corruption, not inconsistency (Pieter Wuille) `e66dbde6d` Add SizeEstimate to CDBBatch (Pieter Wuille) Tree-SHA512: ce1fb1e40c77d38915cd02189fab7a8b125c7f44d425c85579d872c3bede3a437760997907c99d7b3017ced1c2de54b2ac7223d99d83a6658fe5ef61edef1de3		2017-06-01 16:20:27 -07:00
..
functional	Merge #10195 : Switch chainstate db and cache to per-txout model	2017-06-01 16:20:27 -07:00
util	refactor TxToJSON() and ScriptPubKeyToJSON()	2017-04-28 10:01:56 -04:00
README.md	qa: Warn when specified test is not found	2017-05-14 12:39:02 +02:00

README.md

This directory contains integration tests that test bitcoind and its utilities in their entirety. It does not contain unit tests, which can be found in /src/test, /src/wallet/test, etc.

There are currently two sets of tests in this directory:

functional which test the functionality of bitcoind and bitcoin-qt by interacting with them through the RPC and P2P interfaces.
util which tests the bitcoin utilities, currently only bitcoin-tx.

The util tests are run as part of make check target. The functional tests are run by the travis continuous build process whenever a pull request is opened. Both sets of tests can also be run locally.

Functional Test dependencies

The ZMQ functional test requires a python ZMQ library. To install it:

on Unix, run sudo apt-get install python3-zmq
on mac OS, run pip3 install pyzmq

Running tests locally

Build for your system first. Be sure to enable wallet, utils and daemon when you configure. Tests will not run otherwise.

Functional tests

You can run any single test by calling

test/functional/test_runner.py <testname>

Or you can run any combination (incl. duplicates) of tests by calling

test/functional/test_runner.py <testname1> <testname2> <testname3> ...

Run the regression test suite with

test/functional/test_runner.py

Run all possible tests with

test/functional/test_runner.py --extended

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 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 test/functional/test_runner.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

Util tests

Util tests can be run locally by running test/util/bitcoin-util-test.py. Use the -v option for verbose output.

Writing functional tests

You are encouraged to write functional tests for new or existing features. Further information about the functional test framework and individual tests is found in test/functional.