bitcoin/test/functional
Ava Chow 85bcfeea23
Merge bitcoin/bitcoin#30666: validation: fix m_best_header tracking and BLOCK_FAILED_CHILD assignment
0bd53d913c test: add test for getchaintips behavior with invalid chains (Martin Zumsande)
ccd98ea4c8 test: cleanup rpc_getchaintips.py (Martin Zumsande)
f5149ddb9b validation: mark blocks building on an invalid block as BLOCK_FAILED_CHILD (Martin Zumsande)
783cb7337f validation: call RecalculateBestHeader in InvalidChainFound (Martin Zumsande)
9275e9689a rpc: call RecalculateBestHeader as part of reconsiderblock (Martin Zumsande)
a51e91783a validation: add RecalculateBestHeader() function (Martin Zumsande)

Pull request description:

  `m_best_header` (the most-work header not known to be on an invalid chain) can be wrong in the context of invalidation / reconsideration of blocks. This can happen naturally (a valid header is received and stored in our block tree db; when the full block arrives, it is found to be invalid) or triggered by the user with the `invalidateblock` / `reconsiderblock` rpc.

  We don't currently use `m_best_header` for any critical things (see OP of #16974 for a list that still seems up-to-date), so it being wrong affects mostly rpcs.

  This PR proposes to recalculate it if necessary by looping over the block index and finding the best header. It also suggest to mark headers between an invalidatetd block and the previous `m_best_header` as invalid, so they won't be considered in the recalculation.
  It adds tests to `rpc_invalidateblock.py` and `rpc_getchaintips.py` that fail on master.

  One alternative to this suggested in the past would be to introduce a continuous tracking of header tips (#12138).
  While this might be more performant, it is also more complicated, and situations where we need this data are only be remotely triggerable by paying the cost of creating a valid PoW header for an invalid block.
  Therefore I think it isn't necessary to optimise for performance here, plus the solution in this PR doesn't perform any extra steps in the normal node operation where no invalidated blocks are encountered.

  Fixes  #26245

ACKs for top commit:
  fjahr:
    reACK 0bd53d913c
  achow101:
    ACK 0bd53d913c
  TheCharlatan:
    Re-ACK 0bd53d913c

Tree-SHA512: 23c2fc42d7c7bb4f9b4ba4949646b3d0031dd29ed15484e436afd66cd821ed48e0f16a1d02f45477b5d0d73a006f6e81a56b82d9721e0dee2e924219f528b445
2024-11-14 16:54:41 -05:00
..
data [test] A non-standard transaction which is also consensus-invalid should return the consensus error 2024-10-17 10:58:42 +01:00
mocks wallet: return and display signer error 2024-04-16 17:47:43 +02:00
test_framework functional test: Add ephemeral dust tests 2024-11-12 09:24:54 -05:00
.gitignore build: Remove Autotools-based build system 2024-08-30 21:31:39 +01:00
combine_logs.py
combined_log_template.html
create_cache.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
example_test.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_abortnode.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_addrman.py scripted-diff: Rename PACKAGE_* variables to CLIENT_* 2024-10-28 12:36:19 +00:00
feature_anchors.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_asmap.py qa: Do not assume running feature_asmap.py from source directory 2024-07-16 22:06:47 +01:00
feature_assumeutxo.py rpc: Improve getblock / getblockstats error when only header is available. 2024-09-13 10:50:49 -04:00
feature_assumevalid.py node: use uint256::FromUserHex for -assumevalid parsing 2024-08-23 13:53:40 +01:00
feature_bind_extra.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_bind_port_discover.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_bind_port_externalip.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_bip68_sequence.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_block.py [test] A non-standard transaction which is also consensus-invalid should return the consensus error 2024-10-17 10:58:42 +01:00
feature_blocksdir.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_blocksxor.py test: switch MiniWallet padding unit from weight to vsize 2024-09-28 22:49:41 +02:00
feature_cltv.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_coinstatsindex.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_config_args.py init: fix fatal error on '-wallet' negated option value 2024-08-26 18:30:35 -03:00
feature_csv_activation.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_dbcrash.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_dersig.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_dirsymlinks.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_discover.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_fastprune.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_fee_estimation.py test: add missing sync to feature_fee_estimation.py 2024-10-01 18:10:31 -04:00
feature_filelock.py scripted-diff: Rename PACKAGE_* variables to CLIENT_* 2024-10-28 12:36:19 +00:00
feature_framework_miniwallet.py test: switch MiniWallet padding unit from weight to vsize 2024-09-28 22:49:41 +02:00
feature_framework_unit_tests.py test: add unit test for keys_to_multisig_script 2024-06-05 16:18:31 +02:00
feature_help.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_includeconf.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_index_prune.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_init.py Merge bitcoin/bitcoin#31046: init: Some small chainstate load improvements 2024-10-23 18:33:31 -04:00
feature_loadblock.py contrib: support reading XORed blocks in linearize-data.py script 2024-08-07 23:53:39 +02:00
feature_logging.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_maxtipage.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_maxuploadtarget.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_minchainwork.py node: use uint256::FromUserHex for -minimumchainwork parsing 2024-08-23 13:53:40 +01:00
feature_notifications.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_nulldummy.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_posix_fs_permissions.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_presegwit_node_upgrade.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_proxy.py test: fix intermittent failures in feature_proxy.py 2024-07-30 10:52:53 -04:00
feature_pruning.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_rbf.py Remove -mempoolfullrbf option 2024-10-28 11:53:20 -04:00
feature_reindex_readonly.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_reindex.py refactor: move read_xor_key() to TestNode 2024-08-25 08:42:38 -04:00
feature_remove_pruned_files_on_startup.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_segwit.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_settings.py scripted-diff: Rename PACKAGE_* variables to CLIENT_* 2024-10-28 12:36:19 +00:00
feature_shutdown.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_signet.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_startupnotify.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_taproot.py test: Make leaf_script mandatory when scriptpath is set in TaprootSignatureMsg 2024-07-31 09:57:42 +02:00
feature_uacomment.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_unsupported_utxo_db.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_utxo_set_hash.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
feature_versionbits_warning.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
interface_bitcoin_cli.py scripted-diff: Rename PACKAGE_* variables to CLIENT_* 2024-10-28 12:36:19 +00:00
interface_http.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
interface_rest.py rest: Reject truncated hex txid early in getutxos parsing 2024-07-24 17:40:13 +02:00
interface_rpc.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
interface_usdt_coinselection.py test: [refactor] Fix F841 flake8 2024-08-29 07:01:54 +02:00
interface_usdt_mempool.py test: Disable known broken USDT test for now 2024-08-02 14:02:42 +02:00
interface_usdt_net.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
interface_usdt_utxocache.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
interface_usdt_validation.py tracing: cast block_connected duration to nanoseconds 2024-09-03 14:15:37 +02:00
interface_zmq.py test: Remove dead code from interface_zmq 2024-09-29 21:46:15 +02:00
mempool_accept_wtxid.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
mempool_accept.py Remove -mempoolfullrbf option 2024-10-28 11:53:20 -04:00
mempool_compatibility.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
mempool_datacarrier.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
mempool_dust.py functional test: Add new -dustrelayfee=0 test case 2024-11-12 09:24:54 -05:00
mempool_ephemeral_dust.py functional test: Add ephemeral dust tests 2024-11-12 09:24:54 -05:00
mempool_expiry.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
mempool_limit.py functional test: Additional package evaluation coverage 2024-10-25 09:22:57 -04:00
mempool_package_limits.py test: switch MiniWallet padding unit from weight to vsize 2024-09-28 22:49:41 +02:00
mempool_package_onemore.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
mempool_package_rbf.py test: Add missing sync_mempools() to fill_mempool() 2024-09-24 10:13:21 +02:00
mempool_packages.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
mempool_persist.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
mempool_reorg.py scripted-diff: Rename lazily initialized bloom filters 2024-07-31 13:23:46 +01:00
mempool_resurrect.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
mempool_sigoplimit.py test: [refactor] Fix F841 flake8 2024-08-29 07:01:54 +02:00
mempool_spend_coinbase.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
mempool_truc.py Remove -mempoolfullrbf option 2024-10-28 11:53:20 -04:00
mempool_unbroadcast.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
mempool_updatefromblock.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
mining_basic.py test: Don't enforce BIP94 on regtest unless specified by arg 2024-10-28 11:38:38 -04:00
mining_getblocktemplate_longpoll.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
mining_prioritisetransaction.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_1p1c_network.py test: Add missing sync_mempools() to fill_mempool() 2024-09-24 10:13:21 +02:00
p2p_add_connections.py Merge bitcoin/bitcoin#30463: qa: Functional test improvements 2024-07-22 12:08:32 +01:00
p2p_addr_relay.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_addrfetch.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_addrv2_relay.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_block_sync.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_blockfilters.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_blocksonly.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_compactblocks_blocksonly.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_compactblocks_hb.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_compactblocks.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_disconnect_ban.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_dns_seeds.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_dos_header_tree.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_eviction.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_feefilter.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_filter.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_fingerprint.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_getaddr_caching.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_getdata.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_handshake.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_headers_sync_with_minchainwork.py test: Avoid intermittent timeout in p2p_headers_sync_with_minchainwork.py 2024-08-30 12:01:18 +02:00
p2p_i2p_ports.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_i2p_sessions.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_ibd_stalling.py test: Avoid intermittent block download timeout in p2p_ibd_stalling 2024-08-23 17:49:13 +02:00
p2p_ibd_txrelay.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_initial_headers_sync.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_invalid_block.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_invalid_locator.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_invalid_messages.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_invalid_tx.py [test] A non-standard transaction which is also consensus-invalid should return the consensus error 2024-10-17 10:58:42 +01:00
p2p_leak_tx.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_leak.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_message_capture.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_mutated_blocks.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_net_deadlock.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_nobloomfilter_messages.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_node_network_limited.py rpc: Improve getblock / getblockstats error when only header is available. 2024-09-13 10:50:49 -04:00
p2p_opportunistic_1p1c.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_orphan_handling.py test: enhance p2p_orphan_handling 2024-10-25 20:46:00 -04:00
p2p_outbound_eviction.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_permissions.py test: Add explicit onion bind to p2p_permissions 2024-09-10 16:32:08 -04:00
p2p_ping.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_seednode.py test: Prevent connection attempts to random IPs in p2p_seednodes.py 2024-10-23 15:39:48 -04:00
p2p_segwit.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_sendheaders.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_sendtxrcncl.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_timeouts.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_tx_download.py test: Add missing sync_mempools() to fill_mempool() 2024-09-24 10:13:21 +02:00
p2p_tx_privacy.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_unrequested_blocks.py rpc: Improve getblock / getblockstats error when only header is available. 2024-09-13 10:50:49 -04:00
p2p_v2_encrypted.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
p2p_v2_misbehaving.py test: Fix intermittent issue in p2p_v2_misbehaving.py 2024-07-23 19:48:40 +02:00
p2p_v2_transport.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
README.md doc: cmake: prepend and explain "build/" where needed 2024-10-11 11:24:21 -06:00
rpc_bind.py fix: handle invalid rpcbind port earlier 2024-09-17 21:47:29 -04:00
rpc_blockchain.py rpc: add test for waitforblock and waitfornewblock 2024-09-17 09:27:43 +02:00
rpc_createmultisig.py test: Add combinerawtransaction test to rpc_createmultisig 2024-11-08 11:49:27 -05:00
rpc_decodescript.py test: add P2A coverage for decodescript 2024-07-30 14:06:58 -04:00
rpc_deprecated.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
rpc_deriveaddresses.py Merge bitcoin/bitcoin#22838: descriptors: Be able to specify change and receiving in a single descriptor string 2024-08-28 15:56:15 +01:00
rpc_dumptxoutset.py test: Check that network stays suspended after dumptxoutset if it was off before 2024-09-12 23:21:58 +02:00
rpc_estimatefee.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
rpc_generate.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
rpc_getblockfilter.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
rpc_getblockfrompeer.py rpc: Improve getblock / getblockstats error when only header is available. 2024-09-13 10:50:49 -04:00
rpc_getblockstats.py test: add coverage to getblock and getblockstats 2024-09-13 10:50:49 -04:00
rpc_getchaintips.py test: add test for getchaintips behavior with invalid chains 2024-09-17 11:40:36 -04:00
rpc_getdescriptorinfo.py Merge bitcoin/bitcoin#22838: descriptors: Be able to specify change and receiving in a single descriptor string 2024-08-28 15:56:15 +01:00
rpc_help.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
rpc_invalid_address_message.py Merge bitcoin/bitcoin#30463: qa: Functional test improvements 2024-07-22 12:08:32 +01:00
rpc_invalidateblock.py validation: mark blocks building on an invalid block as BLOCK_FAILED_CHILD 2024-09-17 11:40:36 -04:00
rpc_mempool_info.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
rpc_misc.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
rpc_named_arguments.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
rpc_net.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
rpc_orphans.py test: explicitly check boolean verbosity is disallowed 2024-10-25 17:54:05 -04:00
rpc_packages.py test: added test to assert TX decode rpc error on submitpackage rpc 2024-10-27 15:17:23 -04:00
rpc_preciousblock.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
rpc_psbt.py Merge bitcoin/bitcoin#30463: qa: Functional test improvements 2024-07-22 12:08:32 +01:00
rpc_rawtransaction.py rpc: clarify ALREADY_IN_CHAIN rpc errors 2024-08-05 15:45:58 +01:00
rpc_scanblocks.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
rpc_scantxoutset.py Merge bitcoin/bitcoin#22838: descriptors: Be able to specify change and receiving in a single descriptor string 2024-08-28 15:56:15 +01:00
rpc_setban.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
rpc_signer.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
rpc_signmessagewithprivkey.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
rpc_signrawtransactionwithkey.py Remove second node since only 1 is needed for the test 2024-08-27 19:00:37 -03:00
rpc_txoutproof.py rpc: Improve gettxoutproof error when only header is available. 2024-09-13 10:50:49 -04:00
rpc_uptime.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
rpc_users.py fix: increase consistency of rpcauth parsing 2024-08-12 20:28:11 -04:00
rpc_validateaddress.py test: P2A is a destination type with an address 2024-08-02 13:03:06 -04:00
rpc_whitelist.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
test_runner.py functional test: Add ephemeral dust tests 2024-11-12 09:24:54 -05:00
test-shell.md net: require P2P binds to succeed 2024-07-02 14:17:51 +02:00
tool_signet_miner.py Merge bitcoin/bitcoin#28417: contrib/signet/miner updates 2024-09-04 13:16:26 -04:00
tool_wallet.py scripted-diff: Rename PACKAGE_* variables to CLIENT_* 2024-10-28 12:36:19 +00:00
wallet_abandonconflict.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_address_types.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_assumeutxo.py test: Add basic balance coverage to wallet_assumeutxo.py 2024-09-22 19:19:12 +02:00
wallet_avoid_mixing_output_types.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_avoidreuse.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_backup.py test: Add coverage for best block locator write in wallet_backup 2024-09-20 17:20:15 +02:00
wallet_backwards_compatibility.py test: Remove 0.16.3 test from wallet_backwards_compatibility.py 2024-09-18 12:08:28 +02:00
wallet_balance.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_basic.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_blank.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_bumpfee.py Fix lint-spelling warnings 2024-07-22 13:59:42 +02:00
wallet_change_address.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_coinbase_category.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_conflicts.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_create_tx.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_createwallet.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_createwalletdescriptor.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_crosschain.py testnet: Introduce Testnet4 2024-08-06 01:38:10 +02:00
wallet_descriptor.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_disable.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_dump.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_encryption.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_fallbackfee.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_fast_rescan.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_fundrawtransaction.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_gethdkeys.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_groups.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_hd.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_implicitsegwit.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_import_rescan.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_import_with_label.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_importdescriptors.py Merge bitcoin/bitcoin#22838: descriptors: Be able to specify change and receiving in a single descriptor string 2024-08-28 15:56:15 +01:00
wallet_importmulti.py Merge bitcoin/bitcoin#22838: descriptors: Be able to specify change and receiving in a single descriptor string 2024-08-28 15:56:15 +01:00
wallet_importprunedfunds.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_inactive_hdchains.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_keypool_topup.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_keypool.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_labels.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_listdescriptors.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_listreceivedby.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_listsinceblock.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_listtransactions.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_migration.py Merge bitcoin/bitcoin#30265: wallet: Fix listwalletdir listing of migrated default wallets and generated backup files 2024-08-12 15:58:07 +01:00
wallet_miniscript.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_multisig_descriptor_psbt.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_multiwallet.py scripted-diff: Rename PACKAGE_* variables to CLIENT_* 2024-10-28 12:36:19 +00:00
wallet_orphanedreward.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_pruning.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_reindex.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_reorgsrestore.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_rescan_unconfirmed.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_resendwallettransactions.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_send.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_sendall.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_sendmany.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_signer.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_signmessagewithaddress.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_signrawtransactionwithwallet.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_simulaterawtx.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_spend_unconfirmed.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_startup.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_taproot.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_timelock.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_transactiontime_rescan.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_txn_clone.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_txn_doublespend.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00
wallet_upgradewallet.py test: Remove 0.16.3 test from wallet_backwards_compatibility.py 2024-09-18 12:08:28 +02:00
wallet_watchonly.py scripted-diff: Add __file__ argument to BitcoinTestFramework.init() 2024-07-16 22:06:47 +01:00

Functional tests

Writing Functional Tests

Example test

The file test/functional/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

Assuming the build directory is build, running build/test/functional/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 CI linter job 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.
  • Use type hints in your code to improve code readability and to detect possible bugs earlier.
  • Avoid wildcard imports.
  • If more than one name from a module is needed, use lexicographically sorted multi-line imports in order to reduce the possibility of potential merge conflicts.
  • Use a module-level docstring to describe what the test is testing, and how it is testing it.
  • When subclassing the BitcoinTestFramework, 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 f'{x}' for string formatting in preference to '{}'.format(x) or '%s' % x.
  • Use platform.system() for detecting the running operating system and os.name to check whether it's a POSIX system (see also the skip_if_platform_not_{linux,posix} methods in the BitcoinTestFramework class, which can be used to skip a whole test depending on the platform).

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

  • Instead of inline comments or no test documentation at all, log the comments to the test log, e.g. self.log.info('Create enough transactions to fill a block'). Logs make the test code easier to read and the test logic easier to debug.
  • 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).
  • 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 True to initialize an empty blockchain and start from the Genesis block, rather than load a premined blockchain from cache with the default value of False. The cached data directories contain a 200-block pre-mined blockchain with the spendable mining rewards being split between four nodes. Each node has 25 mature block subsidies (25x50=1250 BTC) in its wallet. Using them is much more efficient than mining blocks in your test.
  • 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

  • P2Ps can be used to test specific P2P protocol behavior. p2p.py contains test framework p2p objects and messages.py contains all the definitions for objects passed 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.

P2PConnections can be used as such:

p2p_conn = node.add_p2p_connection(P2PInterface())
p2p_conn.send_and_ping(msg)

They can also be referenced by indexing into a TestNode's p2ps list, which contains the list of test framework p2p objects connected to itself (it does not include any TestNodes):

node.p2ps[0].sync_with_ping()

More examples can be found in p2p_unrequested_blocks.py, p2p_compactblocks.py.

Prototyping tests

The TestShell class exposes the BitcoinTestFramework functionality to interactive Python3 environments and can be used to prototype tests. This may be especially useful in a REPL environment with session logging utilities, such as IPython. The logs of such interactive sessions can later be adapted into permanent test cases.

Test framework modules

The following are useful modules for test developers. They are located in test/functional/test_framework/.

authproxy.py

Taken from the python-bitcoinrpc repository.

test_framework.py

Base class for functional tests.

util.py

Generally useful functions.

p2p.py

Test objects for interacting with a bitcoind node over the p2p interface.

script.py

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

key.py

Test-only secp256k1 elliptic curve implementation

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.p2ps[0].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: