lbrycrd/test/functional
Wladimir J. van der Laan 67be6d7a17
Merge #16248: Make whitebind/whitelist permissions more flexible
c5b404e8f1 Add functional tests for flexible whitebind/list (nicolas.dorier)
d541fa3918 Replace the use of fWhitelisted by permission checks (nicolas.dorier)
ecd5cf7ea4 Do not disconnect peer for asking mempool if it has NO_BAN permission (nicolas.dorier)
e5b26deaaa Make whitebind/whitelist permissions more flexible (nicolas.dorier)

Pull request description:

  # Motivation

  In 0.19, bloom filter will be disabled by default. I tried to make [a PR](https://github.com/bitcoin/bitcoin/pull/16176) to enable bloom filter for whitelisted peers regardless of `-peerbloomfilters`.

  Bloom filter have non existent privacy and server can omit filter's matches. However, both problems are completely irrelevant when you connect to your own node. If you connect to your own node, bloom filters are the most bandwidth efficient way to synchronize your light client without the need of some middleware like Electrum.

  It is also a superior alternative to BIP157 as it does not require to maintain an additional index and it would work well on pruned nodes.

  When I attempted to allow bloom filters for whitelisted peer, my proposal has been NACKed in favor of [a more flexible approach](https://github.com/bitcoin/bitcoin/pull/16176#issuecomment-500762907) which should allow node operator to set fine grained permissions instead of a global `whitelisted` attribute.

  Doing so will also make follow up idea very easy to implement in a backward compatible way.

  # Implementation details

  The PR propose a new format for `--white{list,bind}`. I added a way to specify permissions granted to inbound connection matching `white{list,bind}`.

  The following permissions exists:
  * ForceRelay
  * Relay
  * NoBan
  * BloomFilter
  * Mempool

  Example:
  * `-whitelist=bloomfilter@127.0.0.1/32`.
  * `-whitebind=bloomfilter,relay,noban@127.0.0.1:10020`.

  If no permissions are specified, `NoBan | Mempool` is assumed. (making this PR backward compatible)

  When we receive an inbound connection, we calculate the effective permissions for this peer by fetching the permissions granted from `whitelist`  and add to it the permissions granted from `whitebind`.

  To keep backward compatibility, if no permissions are specified in `white{list,bind}` (e.g. `--whitelist=127.0.0.1`) then parameters `-whitelistforcerelay` and `-whiterelay` will add the permissions `ForceRelay` and `Relay` to the inbound node.

  `-whitelistforcerelay` and `-whiterelay` are ignored if the permissions flags are explicitly set in `white{bind,list}`.

  # Follow up idea

  Based on this PR, other changes become quite easy to code in a trivially review-able, backward compatible way:

  * Changing `connect` at rpc and config file level to understand the permissions flags.
  * Changing the permissions of a peer at RPC level.

ACKs for top commit:
  laanwj:
    re-ACK c5b404e8f1

Tree-SHA512: adfefb373d09e68cae401247c8fc64034e305694cdef104bdcdacb9f1704277bd53b18f52a2427a5cffdbc77bda410d221aed252bc2ece698ffbb9cf1b830577
2019-08-14 17:07:12 +02:00
..
data Merge #14802: rpc: faster getblockstats using BlockUndo data 2019-05-10 13:20:48 -04:00
test_framework Merge #16248: Make whitebind/whitelist permissions more flexible 2019-08-14 17:07:12 +02:00
.gitignore Rename rpc-tests directory to functional 2017-03-20 10:40:31 -04:00
combine_logs.py test: Avoid hardcoding the chain name in combine_logs 2019-08-02 09:04:21 -04: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 [qa] Fix race condition in example_test.py 2019-07-25 10:32:07 -04:00
feature_abortnode.py [qa] Test disconnect block failure -> shutdown 2019-06-05 05:05:49 -04:00
feature_assumevalid.py test: Fix “local variable 'e' is assigned to but never used” 2019-07-31 16:12:12 -04:00
feature_bip68_sequence.py test: Require standard txs in regtest 2019-06-21 16:45:16 -04:00
feature_block.py Merge #16363: test: Add test for BIP30 duplicate tx 2019-08-05 08:16:18 -04:00
feature_blocksdir.py test: Adapt test framework for chains other than "regtest" 2019-07-31 17:00:25 -04:00
feature_cltv.py Merge #15891: test: Require standard txs in regtest by default 2019-07-16 16:10:17 -04:00
feature_config_args.py Use ArgsManager::NETWORK_ONLY flag 2019-07-27 22:51:58 +03: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 Merge #16493: test: Fix test failures 2019-08-02 08:17:39 -04:00
feature_dersig.py test: Add tests for getblockchaininfo.softforks 2019-07-02 15:25:13 -04:00
feature_fee_estimation.py test: Explain why -whitelist is used in feature_fee_estimation 2019-08-02 11:16:24 -04:00
feature_filelock.py QA: feature_filelock, interface_bitcoin_cli: Use PACKAGE_NAME in messages rather than hardcoding Bitcoin Core 2019-04-25 20:43:04 +00:00
feature_help.py qa: Raise feature_help timeout to 5s 2018-08-03 17:41:21 -04:00
feature_includeconf.py init: Use InitError for all errors in bitcoind/qt 2019-07-11 19:39:25 -04: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 test: Require standard txs in regtest 2019-06-21 16:45:16 -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 test: Remove True argument to CBlock::serialize 2019-05-08 10:06:21 -04:00
feature_proxy.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
feature_pruning.py test: Add missing sync_blocks to feature_pruning 2019-08-02 15:36:06 -04:00
feature_rbf.py test: Require standard txs in regtest 2019-06-21 16:45:16 -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 test: Require standard txs in regtest 2019-06-21 16:45:16 -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 test: Adapt test framework for chains other than "regtest" 2019-07-31 17:00:25 -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 Add a 'logpath' field to getrpcinfo 2019-05-16 23:01:00 +02:00
interface_zmq.py Moved and renamed hash256 from util.py to zmq_interface.py 2019-08-13 15:39:46 -04:00
mempool_accept.py test: Require standard txs in regtest 2019-06-21 16:45:16 -04:00
mempool_limit.py test: Require standard txs in regtest 2019-06-21 16:45:16 -04:00
mempool_package_onemore.py [mempool] log correct messages when CPFP fails 2019-07-26 16:21:26 -04:00
mempool_packages.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
mempool_persist.py rpc: Expose g_is_mempool_loaded via getmempoolinfo and /rest/mempool/info.json 2019-03-22 02:31:20 -07: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 test: Require standard txs in regtest 2019-06-21 16:45:16 -04:00
p2p_blocksonly.py test: Add test for p2p_blocksonly 2019-05-13 10:44:42 -04:00
p2p_compactblocks.py test: Require standard txs in regtest 2019-06-21 16:45:16 -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: Skip flaky p2p_invalid_messages test on macOS 2019-07-23 15:59:27 -04:00
p2p_invalid_tx.py test: Require standard txs in regtest 2019-06-21 16:45:16 -04: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 Disable bloom filtering by default. 2019-06-06 10:01:13 -04:00
p2p_permissions.py Add functional tests for flexible whitebind/list 2019-08-11 11:33:29 +09:00
p2p_segwit.py test: Require standard txs in regtest 2019-06-21 16:45:16 -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_tx_download.py [qa] Test that getdata requests work as expected 2019-06-19 12:50:14 -04: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 test: Adapt test framework for chains other than "regtest" 2019-07-31 17:00:25 -04:00
rpc_blockchain.py scripted-diff: Update copyright in ./test 2019-03-02 10:58:35 -05:00
rpc_createmultisig.py Merge #16250: signrawtransactionwithkey: report error when missing redeemScript/witnessScript 2019-07-02 17:21:02 -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 test: Split fundrawtx test into subtests 2019-07-02 17:19:18 -04:00
rpc_getblockfilter.py rpc: Add getblockfilter RPC method. 2019-04-06 12:10:55 -07:00
rpc_getblockstats.py rpc: faster getblockstats using BlockUndo data 2019-05-10 08:33:14 -04: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 tests: Fail if RPC has been added without tests 2019-05-15 14:27:18 -04: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] walletcreatefundedpsbt: check RBF is disabled when -walletrbf=0 2019-07-27 19:35:07 +02:00
rpc_rawtransaction.py remove parameters -addresstype=legacy in rpc_rawtransaction test 2019-05-24 16:44:37 +08:00
rpc_scantxoutset.py Extract ParseDescriptorRange 2019-04-13 18:52:11 -07: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 test: rpc_users: Make variable names more clear. 2019-07-08 16:13:35 -04:00
test_runner.py Add functional tests for flexible whitebind/list 2019-08-11 11:33:29 +09:00
tool_wallet.py test: Tool wallet test coverage for unexpected writes to wallet 2019-07-08 13:02:28 +02: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_avoidreuse.py wallet/rpc/getbalances: add entry for 'mine.used' balance in results 2019-06-22 02:45:40 +09:00
wallet_backup.py test: Remove unused imports 2019-04-09 12:10:35 -04:00
wallet_balance.py test: Add missing sync_all to wallet_balance test 2019-06-28 11:19:37 -04:00
wallet_basic.py test: Require standard txs in regtest 2019-06-21 16:45:16 -04:00
wallet_bumpfee.py deprecate totalFee argument in bumpfee RPC call 2019-07-26 14:09:03 -04:00
wallet_bumpfee_totalfee_deprecation.py Add RPC bumpfee totalFee deprecation test 2019-07-26 14:09:03 -04:00
wallet_coinbase_category.py Test coinbase category in wallet rpcs 2018-12-01 13:00:38 -05:00
wallet_create_tx.py test: Add test for maxtxfee option 2019-07-10 11:58:46 +01:00
wallet_createwallet.py Allow createwallet to take empty passwords to make unencrypted wallets 2019-07-29 11:50:24 -04: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: Fix race condition in wallet_encryption test 2019-07-18 22:31:24 +02: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 wallet: Only fail rescan when blocks have actually been pruned 2019-05-06 14:03:56 -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 Add test for dumping the private key imported from descriptor 2019-06-08 01:34:58 +12: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 rpc: Clarify that block count means height excl genesis 2019-07-02 12:28:21 -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: