lbrycrd/test/functional
MarcoFalke e4beef611a
Merge #14121: Index for BIP 157 block filters
c7efb652f3 blockfilter: Update BIP 158 test vectors. (Jim Posen)
19308c9e21 rpc: Add getblockfilter RPC method. (Jim Posen)
ff35105096 init: Add CLI option to enable block filter index. (Jim Posen)
accc8b8b18 index: Access functions for global block filter indexes. (Jim Posen)
2bc90e4e7b test: Unit test for block filter index reorg handling. (Jim Posen)
6bcf0998c0 test: Unit tests for block index filter. (Jim Posen)
b5e8200db7 index: Implement lookup methods on block filter index. (Jim Posen)
75a76e3619 index: Implement block filter index with write operations. (Jim Posen)
2ad2338ef9 serialize: Serialization support for big-endian 32-bit ints. (Jim Posen)
ba6ff9a6f7 blockfilter: Functions to translate filter types to/from names. (Jim Posen)
62b7a4f094 index: Ensure block locator is not stale after chain reorg. (Jim Posen)
4368384f1d index: Allow atomic commits of index state to be extended. (Jim Posen)

Pull request description:

  This introduces a new BlockFilterIndex class, which is required for BIP 157 support.

  The index is uses the asynchronous BaseIndex infrastructure driven by the ValidationInterface callbacks. Filters are stored sequentially in flat files and the disk location of each filter is indexed in LevelDB along with the filter hash and header. The index is designed to ensure persistence of filters reorganized out of the main chain to simplify the BIP 157 net implementation.

  Stats (block height = 565500):
  - Syncing the index from scratch takes 45m
  - Total index size is 3.8 GiB

ACKs for commit c7efb6:
  MarcoFalke:
    utACK c7efb652f3
  ryanofsky:
    Slightly tested ACK c7efb652f3 (I just rebuilt the index with the updated PR and tested the RPC). Changes since last review: rebase, fixed compile errors in internal commits, new comments, updated error messages, tweaked cache size logic, renamed commit method, renamed constants and globals, fixed whitespace, extra BlockFilterIndex::Init error check.

Tree-SHA512: f8ed7a9b6f76df45933aa5eba92b27b3af83f6df2ccb3728a5c89eec80f654344dc14f055f6f63eb9b3a7649dd8af6553fe14969889e7e2fd2f8461574d18f28
2019-04-18 09:48:25 -04:00
..
data test: add invalid tx templates for use in functional tests 2018-11-27 17:53:53 -05:00
test_framework Merge #15773: test: Add BitcoinTestFramework::sync_* methods 2019-04-11 13:23:05 -04:00
.gitignore Rename rpc-tests directory to functional 2017-03-20 10:40:31 -04:00
combine_logs.py tests: have combine_logs default to most recent test dir 2018-11-29 17:41:12 -05:00
combined_log_template.html Introduce combine_logs.py to combine log files from multiple bitcoinds. 2017-03-21 17:30:13 -04:00
create_cache.py Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
example_test.py test: Pass at most one node group to sync_all 2019-04-09 12:08:26 -04:00
feature_assumevalid.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
feature_bip68_sequence.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
feature_block.py scripted-diff: Rename sync_blocks to send_blocks to avoid name collisions and confusion 2019-04-08 19:40:00 -04:00
feature_blocksdir.py Improve blocksdir functional test. 2018-11-30 16:32:23 +02:00
feature_cltv.py wallet/rpc: add maxfeerate parameter to testmempoolaccept 2019-03-14 08:48:46 +09:00
feature_config_args.py qa: Add test for missing testnet section in conf file 2019-03-21 15:54:28 -04:00
feature_csv_activation.py scripted-diff: Rename sync_blocks to send_blocks to avoid name collisions and confusion 2019-04-08 19:40:00 -04:00
feature_dbcrash.py test: Remove python3.4 workaround in feature_dbcrash 2019-03-04 18:17:29 -05:00
feature_dersig.py wallet/rpc: add maxfeerate parameter to testmempoolaccept 2019-03-14 08:48:46 +09:00
feature_fee_estimation.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
feature_filelock.py utils: Fix broken Windows filelock 2018-10-19 02:29:25 +08:00
feature_help.py qa: Raise feature_help timeout to 5s 2018-08-03 17:41:21 -04:00
feature_includeconf.py Ignore unknown config file options for now 2018-07-30 18:01:20 -07:00
feature_logging.py Changed functional tests which do not require wallets to run without 2018-09-17 08:25:10 -05:00
feature_maxuploadtarget.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
feature_minchainwork.py Changed functional tests which do not require wallets to run without 2018-09-17 08:25:10 -05:00
feature_notifications.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
feature_nulldummy.py wallet/rpc: add maxfeerate parameter to sendrawtransaction 2019-03-14 08:48:46 +09:00
feature_proxy.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
feature_pruning.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
feature_rbf.py wallet/rpc: add maxfeerate parameter to sendrawtransaction 2019-03-14 08:48:46 +09:00
feature_reindex.py Changed functional tests which do not require wallets to run without 2018-09-17 08:25:10 -05:00
feature_segwit.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
feature_shutdown.py qa: Remove race between connecting and shutdown on separate connections 2019-01-16 12:01:42 +00:00
feature_uacomment.py utils: Convert Windows args to utf-8 string 2018-09-30 15:08:16 +08:00
feature_versionbits_warning.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
interface_bitcoin_cli.py Merge #15564: cli: remove duplicate wallet fields from -getinfo 2019-03-11 10:28:42 -04:00
interface_http.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
interface_rest.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
interface_rpc.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
interface_zmq.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
mempool_accept.py wallet/rpc: add maxfeerate parameter to sendrawtransaction 2019-03-14 08:48:46 +09:00
mempool_limit.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
mempool_packages.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
mempool_persist.py test: mempool_persist: Verify prioritization is dumped correctly 2018-12-11 20:47:36 -05:00
mempool_reorg.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
mempool_resurrect.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
mempool_spend_coinbase.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
mining_basic.py scripted-diff: test: Use py3.5 bytes::hex() method 2019-03-02 10:40:12 -05:00
mining_getblocktemplate_longpoll.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
mining_prioritisetransaction.py rpc: Rename size to vsize in mempool related calls 2019-03-24 12:01:43 +08:00
p2p_compactblocks.py [qa] Overhaul p2p_compactblocks.py 2019-04-01 17:08:54 -04:00
p2p_disconnect_ban.py rpc: Correctly name arguments 2018-11-13 14:24:40 -05:00
p2p_feefilter.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
p2p_fingerprint.py Changed functional tests which do not require wallets to run without 2018-09-17 08:25:10 -05:00
p2p_invalid_block.py qa: Avoid race in p2p_invalid_block by waiting for the block request 2018-11-09 15:46:58 -05:00
p2p_invalid_locator.py Update copyright headers to 2018 2018-12-29 10:15:01 +01:00
p2p_invalid_messages.py test: Fix race in p2p_invalid_messages 2019-02-02 17:45:20 -05:00
p2p_invalid_tx.py test: add invalid tx templates for use in functional tests 2018-11-27 17:53:53 -05:00
p2p_leak.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
p2p_leak_tx.py [tests] Test that nodes respond to getdata with notfound 2018-10-26 07:45:12 -04:00
p2p_mempool.py tests: Use explicit imports 2018-08-13 14:13:39 +02:00
p2p_node_network_limited.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
p2p_segwit.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
p2p_sendheaders.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
p2p_timeouts.py test: Avoid racy test p2p_timeouts 2018-12-21 02:00:32 +01:00
p2p_unrequested_blocks.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
README.md qa: Add tool-prefix to functional test readme 2019-02-08 08:33:07 -05:00
rpc_bind.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
rpc_blockchain.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
rpc_createmultisig.py test: Add test that addmultisigaddress fails for watchonly addresses 2019-04-17 07:43:34 -04:00
rpc_decodescript.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
rpc_deprecated.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
rpc_deriveaddresses.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
rpc_fundrawtransaction.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
rpc_getblockfilter.py rpc: Add getblockfilter RPC method. 2019-04-06 12:10:55 -07:00
rpc_getblockstats.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
rpc_getchaintips.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
rpc_help.py qa: Add test to ensure node can generate all help texts at runtime 2018-11-05 11:13:32 -05:00
rpc_invalidateblock.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
rpc_misc.py modify test for memory locked in case locking pages failed at some point 2019-03-01 10:20:57 -05:00
rpc_named_arguments.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
rpc_net.py test: Fix rpc_net.py "pong" race condition 2019-01-01 13:12:41 -08:00
rpc_preciousblock.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
rpc_psbt.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
rpc_rawtransaction.py rpc: Validate maxfeerate with AmountFromValue 2019-04-08 16:12:54 +01:00
rpc_scantxoutset.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
rpc_signmessage.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
rpc_signrawtransaction.py [rpc] Remove signrawtransaction warning 2019-03-22 10:30:25 -04:00
rpc_txoutproof.py Merge #13424: Consistently validate txid / blockhash length and encoding in rpc calls 2018-09-24 15:09:11 -04:00
rpc_uptime.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
rpc_users.py Merge #13867: qa: Make extended tests pass on native Windows 2018-08-11 07:01:37 -04:00
test_runner.py rpc: Add getblockfilter RPC method. 2019-04-06 12:10:55 -07:00
tool_wallet.py [tests] Add wallet-tool test 2019-01-30 16:26:56 -05:00
wallet_abandonconflict.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
wallet_address_types.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
wallet_backup.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
wallet_balance.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
wallet_basic.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
wallet_bumpfee.py Merge #15557: Enhance bumpfee to include inputs when targeting a feerate 2019-04-15 08:39:50 +12:00
wallet_coinbase_category.py Test coinbase category in wallet rpcs 2018-12-01 13:00:38 -05:00
wallet_create_tx.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
wallet_createwallet.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
wallet_disable.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
wallet_dump.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
wallet_encryption.py qa: Add wallet_encryption error tests 2018-11-26 16:12:13 -05:00
wallet_fallbackfee.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
wallet_groups.py scripted-diff: Rename rpc_timewait to rpc_timeout 2018-12-22 17:23:25 +01:00
wallet_hd.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
wallet_import_rescan.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
wallet_import_with_label.py [tests] move wallet util functions to wallet_util.py 2019-01-04 17:49:17 -08:00
wallet_importmulti.py Merge #15629: init: Throw error when network specific config is ignored 2019-04-09 21:14:49 -04:00
wallet_importprunedfunds.py rpc: Correctly name arguments 2018-11-13 14:24:40 -05:00
wallet_keypool.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
wallet_keypool_topup.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
wallet_labels.py [tests] Small fixups before deprecating generate 2018-10-16 11:27:13 -04:00
wallet_listreceivedby.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
wallet_listsinceblock.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
wallet_listtransactions.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
wallet_multiwallet.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
wallet_resendwallettransactions.py Merge #15773: test: Add BitcoinTestFramework::sync_* methods 2019-04-11 13:23:05 -04:00
wallet_txn_clone.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
wallet_txn_doublespend.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
wallet_zapwallettxes.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00

Functional tests

Writing Functional Tests

Example test

The example_test.py is a heavily commented example of a test case that uses both the RPC and P2P interfaces. If you are writing your first test, copy that file and modify to fit your needs.

Coverage

Running test_runner.py with the --coverage argument tracks which RPCs are called by the tests and prints a report of uncovered RPCs in the summary. This can be used (along with the --extended argument) to find out which RPCs we don't have test cases for.

Style guidelines

  • Where possible, try to adhere to PEP-8 guidelines
  • Use a python linter like flake8 before submitting PRs to catch common style nits (eg trailing whitespace, unused imports, etc)
  • The oldest supported Python version is specified in doc/dependencies.md. Consider using pyenv, which checks .python-version, to prevent accidentally introducing modern syntax from an unsupported Python version. The Travis linter also checks this, but possibly not in all cases.
  • See the python lint script that checks for violations that could lead to bugs and issues in the test code.
  • Avoid wildcard imports
  • Use a module-level docstring to describe what the test is testing, and how it is testing it.
  • When subclassing the BitcoinTestFramwork, place overrides for the set_test_params(), add_options() and setup_xxxx() methods at the top of the subclass, then locally-defined helper methods, then the run_test() method.
  • Use '{}'.format(x) for string formatting, not '%s' % x.

Naming guidelines

  • Name the test <area>_test.py, where area can be one of the following:
    • feature for tests for full features that aren't wallet/mining/mempool, eg feature_rbf.py
    • interface for tests for other interfaces (REST, ZMQ, etc), eg interface_rest.py
    • mempool for tests for mempool behaviour, eg mempool_reorg.py
    • mining for tests for mining features, eg mining_prioritisetransaction.py
    • p2p for tests that explicitly test the p2p interface, eg p2p_disconnect_ban.py
    • rpc for tests for individual RPC methods or features, eg rpc_listtransactions.py
    • tool for tests for tools, eg tool_wallet.py
    • wallet for tests for wallet features, eg wallet_keypool.py
  • use an underscore to separate words
    • exception: for tests for specific RPCs or command line options which don't include underscores, name the test after the exact RPC or argument name, eg rpc_decodescript.py, not rpc_decode_script.py
  • Don't use the redundant word test in the name, eg interface_zmq.py, not interface_zmq_test.py

General test-writing advice

  • Set self.num_nodes to the minimum number of nodes necessary for the test. Having additional unrequired nodes adds to the execution time of the test as well as memory/CPU/disk requirements (which is important when running tests in parallel or on Travis).
  • Avoid stop-starting the nodes multiple times during the test if possible. A stop-start takes several seconds, so doing it several times blows up the runtime of the test.
  • Set the self.setup_clean_chain variable in set_test_params() to control whether or not to use the cached data directories. The cached data directories contain a 200-block pre-mined blockchain and wallets for four nodes. Each node has 25 mature blocks (25x50=1250 BTC) in its wallet.
  • When calling RPCs with lots of arguments, consider using named keyword arguments instead of positional arguments to make the intent of the call clear to readers.
  • Many of the core test framework classes such as CBlock and CTransaction don't allow new attributes to be added to their objects at runtime like typical Python objects allow. This helps prevent unpredictable side effects from typographical errors or usage of the objects outside of their intended purpose.

RPC and P2P definitions

Test writers may find it helpful to refer to the definitions for the RPC and P2P messages. These can be found in the following source files:

  • /src/rpc/* for RPCs
  • /src/wallet/rpc* for wallet RPCs
  • ProcessMessage() in /src/net_processing.cpp for parsing P2P messages

Using the P2P interface

  • messages.py contains all the definitions for objects that pass over the network (CBlock, CTransaction, etc, along with the network-level wrappers for them, msg_block, msg_tx, etc).

  • P2P tests have two threads. One thread handles all network communication with the bitcoind(s) being tested in a callback-based event loop; the other implements the test logic.

  • P2PConnection is the class used to connect to a bitcoind. P2PInterface contains the higher level logic for processing P2P payloads and connecting to the Bitcoin Core node application logic. For custom behaviour, subclass the P2PInterface object and override the callback methods.

  • Can be used to write tests where specific P2P protocol behavior is tested. Examples tests are p2p_unrequested_blocks.py, p2p_compactblocks.py.

test-framework modules

test_framework/authproxy.py

Taken from the python-bitcoinrpc repository.

test_framework/test_framework.py

Base class for functional tests.

test_framework/util.py

Generally useful functions.

test_framework/mininode.py

Basic code to support P2P connectivity to a bitcoind.

test_framework/script.py

Utilities for manipulating transaction scripts (originally from python-bitcoinlib)

test_framework/key.py

Wrapper around OpenSSL EC_Key (originally from python-bitcoinlib)

test_framework/bignum.py

Helpers for script.py

test_framework/blocktools.py

Helper functions for creating blocks and transactions.

Benchmarking with perf

An easy way to profile node performance during functional tests is provided for Linux platforms using perf.

Perf will sample the running node and will generate profile data in the node's datadir. The profile data can then be presented using perf report or a graphical tool like hotspot.

There are two ways of invoking perf: one is to use the --perf flag when running tests, which will profile each node during the entire test run: perf begins to profile when the node starts and ends when it shuts down. The other way is the use the profile_with_perf context manager, e.g.

with node.profile_with_perf("send-big-msgs"):
    # Perform activity on the node you're interested in profiling, e.g.:
    for _ in range(10000):
        node.p2p.send_message(some_large_message)

To see useful textual output, run

perf report -i /path/to/datadir/send-big-msgs.perf.data.xxxx --stdio | c++filt | less

See also: