lbrycrd/test/functional
MarcoFalke a6d7026a45
Merge #15497: rpc: Consistent range arguments in scantxoutset/importmulti/deriveaddresses
ca253f6ebf Make deriveaddresses use stop/[start,stop] notation for ranges (Pieter Wuille)
1675b7ce55 Use stop/[start,stop] notation in importmulti desc range (Pieter Wuille)
4566011631 Add support for stop/[start,stop] ranges to scantxoutset (Pieter Wuille)
6b9f45e81b Support ranges arguments in RPC help (Pieter Wuille)
7aa6a8aefb Add ParseRange function to parse args of the form int/[int,int] (Pieter Wuille)

Pull request description:

  This introduces a consistent notation for RPC arguments in `scantxoutset`, `importmulti`, and `deriveaddresses`, either:
  * `"range" : int` to just specify the end of the range
  * `"range" : [int,int]` to specify both the begin and the end of the range.

  For `scantxoutset`, this is a backward compatible new feature. For the two other RPCs, it's an incompatible change, but neither of them has been in a release so far. Because of that non-released reason, this only makes sense in 0.18, in my opinion.

  I suggest this as an alternative to #15496, which only makes `deriveaddresses` compatible with `importmulti`, but not with the existing `scantxoutset` RPC. I also think `[int,int]` is more convenient than `{"start":int,"stop":int}`.

  I realize this is technically a feature added to `scantxoutset` after the feature freeze. If desired, I'll drop the `scantxoutset` changes.

Tree-SHA512: 1cbebb90cf34f106786dbcec7afbf3f43fb8b7e46cc7e6763faf1bc1babf12375a1b3c3cf86ee83c21ed2171d99b5a2f60331850bc613db25538c38b6a056676
2019-03-01 09:13:18 -05:00
..
data test: add invalid tx templates for use in functional tests 2018-11-27 17:53:53 -05:00
test_framework Merge #15419: qa: Always refresh cache to be out of ibd 2019-02-25 11:44:21 -05: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 Docs: Update python docs to reflect that wildcard imports are disallowed 2019-01-24 16:57:41 -08:00
feature_assumevalid.py test: Bump timeout on tests that timeout on windows 2019-02-28 18:35:09 -05:00
feature_bip68_sequence.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
feature_block.py Merge #15059: test: Add basic test for BIP34 2019-01-08 15:53:39 +01:00
feature_blocksdir.py Improve blocksdir functional test. 2018-11-30 16:32:23 +02:00
feature_cltv.py test: Bump timeout on tests that timeout on windows 2019-02-28 18:35:09 -05:00
feature_config_args.py Error if rpcpassword contains hash in conf sections 2019-01-09 17:32:35 +13:00
feature_csv_activation.py Merge #14180: qa: Run all tests even if wallet is not compiled 2018-09-13 13:06:07 +02:00
feature_dbcrash.py scripted-diff: Rename rpc_timewait to rpc_timeout 2018-12-22 17:23:25 +01:00
feature_dersig.py test: Bump timeout on tests that timeout on windows 2019-02-28 18:35:09 -05:00
feature_fee_estimation.py [tests] Move deterministic address import to setup_nodes 2018-11-01 12:53:49 -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 rpc/gui: Remove 'Unknown block versions being mined' warning 2019-02-25 15:59:02 +01:00
feature_nulldummy.py [tests] Remove deprecated addwitnessaddress call from feature_nulldummy 2018-09-23 08:50:52 -04:00
feature_proxy.py qa: Fix wallet_txn_doublespend issue 2019-02-19 14:22:15 -05:00
feature_pruning.py Correct units for "-dbcache" and "-prune" 2019-01-30 07:17:22 +02:00
feature_rbf.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04: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 Address test todos by removing -txindex to nodes. 2019-02-17 21:42:08 -08: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 rpc/gui: Remove 'Unknown block versions being mined' warning 2019-02-25 15:59:02 +01:00
interface_bitcoin_cli.py Fix typo 2018-10-20 02:55:41 +03:00
interface_http.py Compare to None with is/is not 2018-12-10 15:11:37 -05:00
interface_rest.py Address test todos by removing -txindex to nodes. 2019-02-17 21:42:08 -08:00
interface_rpc.py qa: Add tests for getrpcinfo 2019-01-02 12:47:32 +00:00
interface_zmq.py Merge #14060: ZMQ: add options to configure outbound message high water mark, aka SNDHWM 2018-11-05 13:45:41 +01:00
mempool_accept.py qa: Always refresh stale cache to be out of ibd 2019-02-19 14:22:13 -05:00
mempool_limit.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
mempool_packages.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -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 Tests: Fix a comment 2018-11-01 17:26:42 +01: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 tests: remove byte.hex() to keep compatibility 2019-02-19 16:38:44 +09:00
mining_getblocktemplate_longpoll.py [mining] segwit option must be set in GBT 2018-12-10 16:42:14 -05:00
mining_prioritisetransaction.py Merge #14811: Mining: Enforce that segwit option must be set in GBT 2018-12-21 13:46:06 +01:00
p2p_compactblocks.py Merge #14296: [wallet] Remove addwitnessaddress 2018-10-24 08:09:48 -04:00
p2p_disconnect_ban.py rpc: Correctly name arguments 2018-11-13 14:24:40 -05:00
p2p_feefilter.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -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 Changed functional tests which do not require wallets to run without 2018-09-17 08:25:10 -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 [tests] Move deterministic address import to setup_nodes 2018-11-01 12:53:49 -04:00
p2p_segwit.py Default -whitelistforcerelay to off 2019-01-22 12:18:45 -05:00
p2p_sendheaders.py minor p2p_sendheaders fix of height in coinbase 2018-10-22 16:47:50 -04:00
p2p_timeouts.py test: Avoid racy test p2p_timeouts 2018-12-21 02:00:32 +01:00
p2p_unrequested_blocks.py Changed functional tests which do not require wallets to run without 2018-09-17 08:25:10 -05:00
README.md qa: Add tool-prefix to functional test readme 2019-02-08 08:33:07 -05:00
rpc_bind.py Merge #14790: Tests: Allow running rpc_bind.py --nonloopback test without IPv6 2019-01-02 14:16:12 +01:00
rpc_blockchain.py qa: Remove mocktime unless required 2019-02-19 10:43:58 -05:00
rpc_createmultisig.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
rpc_decodescript.py tests: Use explicit imports 2018-08-13 14:13:39 +02:00
rpc_deprecated.py [wallet] Deprecate the generate RPC method 2018-10-18 17:46:48 -04:00
rpc_deriveaddresses.py Make deriveaddresses use stop/[start,stop] notation for ranges 2019-02-28 21:40:09 -08:00
rpc_fundrawtransaction.py scripted-diff: Remove unused 'split' parameter to setup_network 2018-12-22 17:20:52 +01:00
rpc_getblockstats.py rpc: Actually throw help when passed invalid number of params 2019-02-20 13:34:16 -05:00
rpc_getchaintips.py Changed functional tests which do not require wallets to run without 2018-09-17 08:25:10 -05: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 [rpc] Correct reconsiderblock help text, add test 2019-01-01 18:02:12 +01:00
rpc_named_arguments.py Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
rpc_net.py test: Fix rpc_net.py "pong" race condition 2019-01-01 13:12:41 -08:00
rpc_preciousblock.py Changed functional tests which do not require wallets to run without 2018-09-17 08:25:10 -05:00
rpc_psbt.py Address test todos by removing -txindex to nodes. 2019-02-17 21:42:08 -08:00
rpc_rawtransaction.py Address test todos by removing -txindex to nodes. 2019-02-17 21:42:08 -08:00
rpc_scantxoutset.py Add support for stop/[start,stop] ranges to scantxoutset 2019-02-28 13:01:44 -08:00
rpc_signmessage.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
rpc_signrawtransaction.py Add test for P2SH-P2WSH in signrawtransactionwithkey and listunspent 2019-02-13 14:35:16 +13: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 Update copyright headers to 2018 2018-07-27 07:15:02 -04: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 tests: accept unicode characters on Windows 2019-02-12 05:17:15 +08:00
tool_wallet.py [tests] Add wallet-tool test 2019-01-30 16:26:56 -05:00
wallet_abandonconflict.py Address test todos by removing -txindex to nodes. 2019-02-17 21:42:08 -08:00
wallet_address_types.py Add getdescriptorinfo to compute checksum 2019-02-15 22:36:05 -08:00
wallet_backup.py scripted-diff: Remove unused 'split' parameter to setup_network 2018-12-22 17:20:52 +01:00
wallet_balance.py [tests] Add wallet_balance.py 2018-11-30 10:28:01 -05:00
wallet_basic.py Address test todos by removing -txindex to nodes. 2019-02-17 21:42:08 -08:00
wallet_bumpfee.py [test] Remove deprecated addwitnessaddress from wallet_bumpfee.py 2018-09-23 08:51:57 -04:00
wallet_coinbase_category.py Test coinbase category in wallet rpcs 2018-12-01 13:00:38 -05:00
wallet_create_tx.py qa: Remove mocktime unless required 2019-02-19 10:43:58 -05:00
wallet_createwallet.py Fetch keys from keypool when private keys are disabled 2019-02-14 18:14:00 -05:00
wallet_disable.py tests: Use explicit imports 2018-08-13 14:13:39 +02:00
wallet_dump.py scripted-diff: Remove unused 'split' parameter to setup_network 2018-12-22 17:20:52 +01: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 Remove hdmasterkeyid 2019-02-14 14:00:29 -05:00
wallet_import_rescan.py [wallet] Restore ability to list incoming transactions by label 2018-11-13 17:49:23 -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 Use stop/[start,stop] notation in importmulti desc range 2019-02-28 13:05:10 -08:00
wallet_importprunedfunds.py rpc: Correctly name arguments 2018-11-13 14:24:40 -05:00
wallet_keypool.py Remove hdmasterkeyid 2019-02-14 14:00:29 -05:00
wallet_keypool_topup.py wallet_keypool_topup.py: Test for all keypool address types 2018-12-03 18:12:31 +01:00
wallet_labels.py [tests] Small fixups before deprecating generate 2018-10-16 11:27:13 -04:00
wallet_listreceivedby.py [tests] Move deterministic address import to setup_nodes 2018-11-01 12:53:49 -04:00
wallet_listsinceblock.py Merge #13424: Consistently validate txid / blockhash length and encoding in rpc calls 2018-09-24 15:09:11 -04:00
wallet_listtransactions.py Fix running individually through test_runner.py, as suggested by @MarcoFalke (#14732) 2018-11-16 22:26:07 +02:00
wallet_multiwallet.py qa: Test .walletlock file is closed 2019-02-04 18:50:21 +00:00
wallet_resendwallettransactions.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
wallet_txn_clone.py tests: remove byte.hex() to keep compatibility 2019-02-19 16:38:44 +09:00
wallet_txn_doublespend.py qa: Fix wallet_txn_doublespend issue 2019-02-19 14:22:15 -05: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: