lbrycrd/test/functional
Wladimir J. van der Laan 7e74c54fed
Merge #13452: rpc: have verifytxoutproof check the number of txns in proof structure
d280617bf5 [qa] Add a test for merkle proof malleation (Suhas Daftuar)
ed82f17000 have verifytxoutproof check the number of txns in proof structure (Gregory Sanders)

Pull request description:

  Recent publication of a weakness in Bitcoin's merkle tree construction demonstrates many SPV applications vulnerable to an expensive to pull off yet still plausible attack: https://bitslog.wordpress.com/2018/06/09/leaf-node-weakness-in-bitcoin-merkle-tree-design/

  This change would at least allow `verifytxoutproof` to properly validate that the proof matches a known block, with known number of transactions any time after the full block is processed. This should neuter the attack entirely.

  The negative is that a header-only processed block/future syncing mode would cause this to fail until the node has imported the data required.

  related: #13451

  `importprunedfunds` needs this check as well. Can expand it to cover this if people like the idea.

Tree-SHA512: 0682ec2b622a38b29f3f635323e0a8b6fc071e8a6fd134c954579926ee7b516e642966bafa667016744ce49c16e19b24dbc8801f982a36ad0a6a4aff6d93f82b
2018-07-09 20:25:50 +02:00
..
data Tests: Add data file 2018-05-22 23:26:34 +02:00
test_framework Merge #13452: rpc: have verifytxoutproof check the number of txns in proof structure 2018-07-09 20:25:50 +02:00
.gitignore Rename rpc-tests directory to functional 2017-03-20 10:40:31 -04:00
combine_logs.py qa: Log as utf-8 2018-06-11 16:22:46 -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 [tests] allow tests to be run with --usecli 2018-01-08 17:35:27 -05:00
example_test.py qa: Avoid start/stop of the network thread mid-test 2018-06-25 14:06:41 -04:00
feature_assumevalid.py qa: Avoid start/stop of the network thread mid-test 2018-06-25 14:06:41 -04:00
feature_bip68_sequence.py Merge #11423: [Policy] Several transaction standardness rules 2018-05-12 17:39:46 +02:00
feature_block.py qa: Avoid start/stop of the network thread mid-test 2018-06-25 14:06:41 -04:00
feature_blocksdir.py qa: Match full plain text by default 2018-04-01 17:36:14 -04:00
feature_cltv.py qa: Avoid start/stop of the network thread mid-test 2018-06-25 14:06:41 -04:00
feature_config_args.py [tests] Use regtest section in functional tests configs 2018-04-11 23:15:28 +10:00
feature_csv_activation.py qa: Avoid start/stop of the network thread mid-test 2018-06-25 14:06:41 -04:00
feature_dbcrash.py scripted-diff: change signrawtransaction to signrawtransactionwithwallet in tests 2018-02-17 11:42:01 -05:00
feature_dersig.py qa: Avoid start/stop of the network thread mid-test 2018-06-25 14:06:41 -04:00
feature_fee_estimation.py [Tests] Use blockmaxweight where tests previously had blockmaxsize 2018-03-26 19:53:58 +04:00
feature_help.py Test gArgs erroring on unknown args 2018-05-30 11:27:50 -04:00
feature_includeconf.py qa: Increase includeconf test coverage 2018-06-01 13:24:50 -04:00
feature_logging.py Print to console by default when not run with -daemon 2018-04-17 09:58:05 +02:00
feature_maxuploadtarget.py qa: Avoid start/stop of the network thread mid-test 2018-06-25 14:06:41 -04:00
feature_minchainwork.py [tests] Rename feature_* functional tests. 2018-01-25 09:44:29 +10:00
feature_notifications.py Explicitly specify encoding when opening text files in Python code 2018-06-12 21:34:52 +02:00
feature_nulldummy.py qa: Avoid start/stop of the network thread mid-test 2018-06-25 14:06:41 -04:00
feature_proxy.py Enable W191 and W291 flake8 checks. 2018-05-11 07:59:05 +10:00
feature_pruning.py expose CBlockIndex::nTx in getblock(header) 2018-06-13 10:20:50 -04:00
feature_rbf.py qa: Pad scriptPubKeys to get minimum sized txs 2018-05-05 04:59:55 +08:00
feature_reindex.py test: Use wait_until in tests where time was used for polling 2018-03-15 23:43:53 -07:00
feature_segwit.py policy: Treat segwit as always active 2018-05-29 16:49:52 -04:00
feature_uacomment.py qa: Match full plain text by default 2018-04-01 17:36:14 -04:00
feature_versionbits_warning.py qa: Avoid start/stop of the network thread mid-test 2018-06-25 14:06:41 -04:00
interface_bitcoin_cli.py tests: Test connecting with non-existing RPC cookie file 2018-03-19 22:44:43 +01:00
interface_http.py [tests] Rename misc functional tests. 2018-01-25 09:44:30 +10:00
interface_rest.py Minor Python cleanups to make flake8 pass with the new rules enabled 2018-04-16 17:25:11 +02:00
interface_zmq.py qa: Normalize executable location 2018-04-21 16:55:42 -04:00
mempool_accept.py rpc: Add testmempoolaccept 2018-03-24 11:17:08 -04:00
mempool_limit.py Don't test against the mempool min fee information in mempool_limit.py 2018-02-22 13:30:50 -08:00
mempool_packages.py Add new fee structure with all sub-fields denominated in BTC 2018-04-18 13:28:45 +10:00
mempool_persist.py qa: Windows fixups for functional tests 2018-04-08 12:44:43 -04:00
mempool_reorg.py scripted-diff: change signrawtransaction to signrawtransactionwithwallet in tests 2018-02-17 11:42:01 -05:00
mempool_resurrect.py [tests] Rename misc functional tests. 2018-01-25 09:44:30 +10:00
mempool_spend_coinbase.py [tests] Rename misc functional tests. 2018-01-25 09:44:30 +10:00
mining_basic.py [tests] Rename misc functional tests. 2018-01-25 09:44:30 +10:00
mining_getblocktemplate_longpoll.py [tests] Rename misc functional tests. 2018-01-25 09:44:30 +10:00
mining_prioritisetransaction.py Don't test against min relay fee information in mining_prioritisetransaction.py 2018-04-26 00:30:38 +03:00
p2p_compactblocks.py qa: Avoid start/stop of the network thread mid-test 2018-06-25 14:06:41 -04:00
p2p_disconnect_ban.py [tests] Rename p2p_* functional tests. 2018-01-25 09:44:29 +10:00
p2p_feefilter.py qa: Avoid start/stop of the network thread mid-test 2018-06-25 14:06:41 -04:00
p2p_fingerprint.py qa: Avoid start/stop of the network thread mid-test 2018-06-25 14:06:41 -04:00
p2p_invalid_block.py qa: Avoid start/stop of the network thread mid-test 2018-06-25 14:06:41 -04:00
p2p_invalid_tx.py qa: Avoid start/stop of the network thread mid-test 2018-06-25 14:06:41 -04:00
p2p_leak.py qa: Avoid start/stop of the network thread mid-test 2018-06-25 14:06:41 -04:00
p2p_mempool.py qa: Avoid start/stop of the network thread mid-test 2018-06-25 14:06:41 -04:00
p2p_node_network_limited.py qa: Avoid start/stop of the network thread mid-test 2018-06-25 14:06:41 -04:00
p2p_segwit.py [tests] p2p_segwit: sync_blocks in subtest wrapper. 2018-06-29 15:35:07 -04:00
p2p_sendheaders.py Merge #13522: [tests] Fix p2p_sendheaders race 2018-06-30 22:09:11 -11:00
p2p_timeouts.py qa: Avoid start/stop of the network thread mid-test 2018-06-25 14:06:41 -04:00
p2p_unrequested_blocks.py qa: Avoid start/stop of the network thread mid-test 2018-06-25 14:06:41 -04:00
README.md qa: Avoid start/stop of the network thread mid-test 2018-06-25 14:06:41 -04:00
rpc_bind.py test: Add rpc_bind test to default-run tests 2018-04-13 14:40:05 +02:00
rpc_blockchain.py qa: Avoid start/stop of the network thread mid-test 2018-06-25 14:06:41 -04:00
rpc_decodescript.py p2wpkh, p2wsh and p2sh-nested scripts in decodescript 2018-03-06 23:10:18 +02:00
rpc_deprecated.py [wallet] [rpc] Remove getlabeladdress RPC 2018-05-16 17:45:19 -04:00
rpc_fundrawtransaction.py Merge #12265: [test] fundrawtransaction: lock watch-only shared address 2018-05-09 10:13:16 +02:00
rpc_getblockstats.py Explicitly specify encoding when opening text files in Python code 2018-06-12 21:34:52 +02:00
rpc_getchaintips.py [tests] Rename rpc_* functional tests. 2018-01-25 09:44:29 +10:00
rpc_invalidateblock.py [tests] Rename rpc_* functional tests. 2018-01-25 09:44:29 +10:00
rpc_named_arguments.py [tests] Rename rpc_* functional tests. 2018-01-25 09:44:29 +10:00
rpc_net.py [tests] Fix intermittent rpc_net.py failure. 2018-03-28 15:35:35 -04:00
rpc_preciousblock.py [qa] util: Remove unused sync_chain 2018-03-12 20:32:04 -04:00
rpc_rawtransaction.py Merge #12436: [rpc] Adds a functional test to validate the transaction version number in the RPC output 2018-04-24 11:57:36 +02:00
rpc_signmessage.py [tests] Rename rpc_* functional tests. 2018-01-25 09:44:29 +10:00
rpc_signrawtransaction.py Add test for signrawtransaction 2018-02-17 11:42:01 -05:00
rpc_txoutproof.py [qa] Add a test for merkle proof malleation 2018-06-22 10:41:39 -04:00
rpc_uptime.py [tests] Rename rpc_* functional tests. 2018-01-25 09:44:29 +10:00
rpc_users.py test: Add rpcauth pair that generated by rpcauth 2018-04-23 06:32:58 +08:00
rpc_zmq.py RPC: Add new getzmqnotifications method. 2018-07-05 08:02:22 +02:00
test_runner.py RPC: Add new getzmqnotifications method. 2018-07-05 08:02:22 +02:00
wallet_abandonconflict.py Fix typos 2018-03-21 08:34:44 +02:00
wallet_address_types.py Get rid of ambiguous OutputType::NONE value 2018-04-05 12:19:35 -04:00
wallet_backup.py qa: Use node.datadir instead of tmpdir in test framework 2018-03-19 12:26:00 -04:00
wallet_basic.py [qa] wallet_basic: Specify minimum required amount for listunspent 2018-06-25 13:21:59 -04:00
wallet_bumpfee.py policy: Treat segwit as always active 2018-05-29 16:49:52 -04:00
wallet_disable.py [tests] Rename wallet_* functional tests. 2018-01-25 09:44:29 +10:00
wallet_dump.py [refactor] manually change remaining instances of master key to seed. 2018-05-19 11:21:15 -04:00
wallet_encryption.py [rpcwallet] Clamp walletpassphrase value at 100M seconds 2018-04-08 10:44:40 -04:00
wallet_fallbackfee.py [wallet] deprecate sendfrom RPC method. 2018-06-18 12:33:15 -04:00
wallet_hd.py [rpc] [wallet] Add 'hdmasterkeyid' alias return values. 2018-05-19 11:21:20 -04:00
wallet_import_rescan.py [tests] Remove 'account' API from wallet functional tests 2018-05-02 17:53:23 -04:00
wallet_importmulti.py Remove assigned but never used local variables 2018-03-29 17:47:12 +02:00
wallet_importprunedfunds.py [tests] Fix flake8 warnings in several wallet functional tests 2018-05-01 11:30:03 -04:00
wallet_keypool.py [rpc] [wallet] Add 'hdmasterkeyid' alias return values. 2018-05-19 11:21:20 -04:00
wallet_keypool_topup.py [tests] Remove 'account' API from wallet functional tests 2018-05-02 17:53:23 -04:00
wallet_labels.py [wallet] deprecate sendfrom RPC method. 2018-06-18 12:33:15 -04:00
wallet_listreceivedby.py qa: Fix wallet_listreceivedby race 2018-05-23 09:52:14 -04:00
wallet_listsinceblock.py [tests] Remove 'account' API from wallet functional tests 2018-05-02 17:53:23 -04:00
wallet_listtransactions.py [tests] Remove 'account' API from wallet functional tests 2018-05-02 17:53:23 -04:00
wallet_multiwallet.py [wallet] loadwallet shouldn't create new wallets. 2018-06-28 13:37:44 -04:00
wallet_resendwallettransactions.py [tests] Rename wallet_* functional tests. 2018-01-25 09:44:29 +10:00
wallet_txn_clone.py [tests] Remove 'account' API from wallet functional tests 2018-05-02 17:53:23 -04:00
wallet_txn_doublespend.py [tests] Remove 'account' API from wallet functional tests 2018-05-02 17:53:23 -04:00
wallet_zapwallettxes.py qa: Add missing syncwithvalidationinterfacequeue to tests 2018-01-25 10:31:35 -05: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)
  • See the python lint script that checks for violations that could lead to bugs and issues in the test code.
  • Avoid wildcard imports where possible
  • 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.

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
    • 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.

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

  • mininode.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.