dash/test/functional
2021-07-16 20:20:26 +03:00
..
data tests: adapt PSBT RPC tests for Dash testnet 2021-07-13 22:00:18 +05:30
test_framework Merge pull request #4261 from PastaPastaPasta/backport-triv-pr16 2021-07-16 20:20:26 +03:00
.gitignore
combine_logs.py Merge #14051: [Tests] Make combine_logs.py handle multi-line logs 2021-07-01 16:33:23 -05:00
combined_log_template.html
create_cache.py Merge #11970: Add test coverage for bitcoin-cli multiwallet calls 2020-03-04 10:13:24 -06:00
example_test.py Merge pull request #4239 from Munkybooty/backports-0.18-pr7 2021-07-13 11:51:50 -05:00
feature_abortnode.py dashification 2021-07-12 20:16:37 -05:00
feature_addressindex.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
feature_asmap.py Merge #17812: asmap feature refinements and functional tests 2021-05-20 00:05:12 +05:30
feature_assumevalid.py Merge #21084: test: fix timeout decrease in feature_assumevalid 2021-07-16 10:04:09 -05:00
feature_bip68_sequence.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
feature_block_reward_reallocation.py Merge #13916: qa: wait_for_verack by default 2021-07-06 20:29:31 +03:00
feature_block.py Merge #18350: test: Fix mining to an invalid target + ensure that a new block has the correct hash internally 2021-07-13 21:19:47 -05:00
feature_blocksdir.py Merge #13985: [trivial] Fix slightly confusing mispelling in feature_blocksdir.py log message 2021-07-02 10:38:08 -04:00
feature_cltv.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
feature_config_args.py Merge #17893: qa: Fix double-negative arg test 2021-07-15 11:07:36 -05:00
feature_csv_activation.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
feature_dbcrash.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
feature_dersig.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
feature_dip3_deterministicmns.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
feature_dip4_coinbasemerkleroots.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
feature_dip0020_activation.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
feature_fee_estimation.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
feature_governance_objects.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
feature_help.py Merge #13867: qa: Make extended tests pass on native Windows 2021-07-06 20:29:31 +03:00
feature_includeconf.py Merge #13799: Ignore unknown config file options; warn instead of error 2021-07-02 12:59:28 +03:00
feature_llmq_chainlocks.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
feature_llmq_connections.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
feature_llmq_data_recovery.py tests: Use wait_for_chainlocked_block_all_nodes in more places (#4139) 2021-05-11 18:55:40 +02:00
feature_llmq_dkgerrors.py Harden DIP0008 activation (#3889) 2020-12-28 12:21:01 +01:00
feature_llmq_is_cl_conflicts.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
feature_llmq_is_retroactive.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
feature_llmq_signing.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
feature_llmq_simplepose.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
feature_logging.py Merge #12853: qa: Match full plain text by default 2021-05-23 01:19:32 +03:00
feature_maxuploadtarget.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
feature_minchainwork.py Backport 11796 + 11774 (#3612) 2020-07-17 02:44:20 +03:00
feature_multikeysporks.py Update copyright (#4115) 2021-04-20 22:33:02 +03:00
feature_new_quorum_type_activation.py Rename bit 6 from "v17" to "dip0020" (#4142) 2021-05-07 18:36:30 +02:00
feature_notifications.py Merge #12917: qa: Windows fixups for functional tests 2021-05-23 01:19:32 +03:00
feature_nulldummy.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
feature_proxy.py scripted-diff: Merge #13753: Remove trailing whitespaces 2020-07-28 20:23:12 -05:00
feature_pruning.py Merge pull request #4234 from UdjinM6/backports-0.17-pr35 2021-07-10 12:11:49 +03:00
feature_reindex.py Merge #13913: qa: Remove redundant checkmempool/checkblockindex extra_args 2021-06-28 21:31:44 -05:00
feature_shutdown.py Dashify few strings (#3214) 2019-11-22 21:13:19 +03:00
feature_spentindex.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
feature_sporks.py tests: Tweak sporks.py to work with any defaults (#3842) 2020-12-01 17:48:35 +00:00
feature_timestampindex.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
feature_txindex.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
feature_uacomment.py Merge #12853: qa: Match full plain text by default 2021-05-23 01:19:32 +03:00
feature_versionbits_warning.py Merge #13916: qa: wait_for_verack by default 2021-07-06 20:29:31 +03:00
interface_bitcoin_cli.py Merge #13725: Fix bitcoin-cli --version 2021-07-02 12:59:28 +03:00
interface_http.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
interface_rest.py Merge #14353: REST: add blockhash call, fetch blockhash by height 2021-06-28 13:40:57 -05:00
interface_zmq_dash.py Merge #13916: qa: wait_for_verack by default 2021-07-06 20:29:31 +03:00
interface_zmq.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
mempool_accept.py Merge #17532: test: add functional test for non-standard txs with too large scriptSig 2021-07-15 11:07:17 -05:00
mempool_expiry.py Merge #18172: test: Transaction expiry from mempool 2021-07-13 21:19:43 -05:00
mempool_limit.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
mempool_packages.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
mempool_persist.py Merge pull request #4234 from UdjinM6/backports-0.17-pr35 2021-07-10 12:11:49 +03:00
mempool_reorg.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
mempool_resurrect.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
mempool_spend_coinbase.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
mining_basic.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
mining_getblocktemplate_longpoll.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
mining_prioritisetransaction.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
p2p_addrv2_relay.py Merge #13916: qa: wait_for_verack by default 2021-07-06 20:29:31 +03:00
p2p_compactblocks.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
p2p_connect_to_devnet.py backport bitcoin#16509 and add devnet test (#3946) 2021-01-22 09:58:07 -05:00
p2p_disconnect_ban.py Backport 11796 + 11774 (#3612) 2020-07-17 02:44:20 +03:00
p2p_fingerprint.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
p2p_instantsend.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
p2p_invalid_block.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
p2p_invalid_locator.py Merge #13915: [qa] Add test for max number of entries in locator 2021-07-06 20:29:31 +03:00
p2p_invalid_tx.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
p2p_leak.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
p2p_mempool.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
p2p_node_network_limited.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
p2p_quorum_data.py Merge #13916: qa: wait_for_verack by default 2021-07-06 20:29:31 +03:00
p2p_sendheaders.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
p2p_timeouts.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
p2p_unrequested_blocks.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
README.md Merge #13517: qa: Remove need to handle the network thread in tests 2021-07-02 12:59:26 +03:00
rpc_bind.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
rpc_blockchain.py Merge #19722: test: Add test for getblockheader verboseness 2021-07-15 19:30:07 -05:00
rpc_coinjoin.py Update copyright (#4115) 2021-04-20 22:33:02 +03:00
rpc_decodescript.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
rpc_deprecated.py Merge #13130: [tests] Fix race in rpc_deprecated.py 2020-12-22 17:58:11 +01:00
rpc_fundrawtransaction_hd.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
rpc_fundrawtransaction.py Merge #12493: [wallet] Reopen CDBEnv after encryption instead of shutting down 2021-04-05 03:31:50 +02:00
rpc_getblockstats.py Merge #13918: rpc: Replace median fee rate with feerate percentiles in getblockstats 2021-07-06 20:29:32 +03:00
rpc_getchaintips.py Backport 11796 + 11774 (#3612) 2020-07-17 02:44:20 +03:00
rpc_help.py fix rpc_help.py 2021-07-01 16:33:23 -05:00
rpc_invalidateblock.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
rpc_masternode.py Update copyright (#4115) 2021-04-20 22:33:02 +03:00
rpc_mnauth.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
rpc_named_arguments.py Backport 11796 + 11774 (#3612) 2020-07-17 02:44:20 +03:00
rpc_net.py Backport 11796 + 11774 (#3612) 2020-07-17 02:44:20 +03:00
rpc_platform_filter.py Update copyright (#4115) 2021-04-20 22:33:02 +03:00
rpc_preciousblock.py Merge #12643: [qa] util: Remove unused sync_chain 2020-12-15 11:06:27 -06:00
rpc_psbt.py Merge #14356: fix converttopsbt permitsigdata arg, add basic test 2021-07-15 04:52:38 +03:00
rpc_rawtransaction.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
rpc_signmessage.py Backport 11796 + 11774 (#3612) 2020-07-17 02:44:20 +03:00
rpc_signrawtransaction.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
rpc_txoutproof.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
rpc_uptime.py Backport 11796 + 11774 (#3612) 2020-07-17 02:44:20 +03:00
rpc_users.py Merge #13867: qa: Make extended tests pass on native Windows 2021-07-06 20:29:31 +03:00
rpc_verifychainlock.py tests: Use wait_for_chainlocked_block_all_nodes in more places (#4139) 2021-05-11 18:55:40 +02:00
rpc_verifyislock.py Update copyright (#4115) 2021-04-20 22:33:02 +03:00
rpc_zmq.py Merge #13645: [tests] skip rpc_zmq functional test as necessary 2020-12-18 12:55:45 -06:00
test_runner.py Merge #18172: test: Transaction expiry from mempool 2021-07-13 21:19:43 -05:00
wallet_abandonconflict.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
wallet_backup.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
wallet_basic.py Merge #19887: test: Fix flaky wallet_basic test 2021-07-15 19:30:07 -05:00
wallet_disable.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
wallet_disableprivatekeys.py Merge #9662: Add createwallet "disableprivatekeys" option: a sane mode for watchonly-wallets 2021-07-02 12:59:27 +03:00
wallet_dump.py Merge #13837: qa: Extract rpc_timewait as test param 2021-07-02 12:59:29 +03:00
wallet_encryption.py Merge #12493: [wallet] Reopen CDBEnv after encryption instead of shutting down 2021-04-05 03:31:50 +02:00
wallet_groups.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
wallet_hd.py Merge #12755: [tests] Better stderr testing 2021-06-28 02:00:44 +03:00
wallet_import_rescan.py Merge #9332: Let wallet importmulti RPC accept labels for standard scriptPubKeys 2021-07-01 16:54:18 -05:00
wallet_importmulti.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
wallet_importprunedfunds.py Merge #13138: [tests] Remove accounts from wallet_importprunedfunds.py 2021-06-28 18:03:22 -05:00
wallet_keypool_hd.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
wallet_keypool_topup.py Merge #13441: Prevent shared conf files from failing with different available options in different binaries 2021-06-28 02:00:50 +03:00
wallet_keypool.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
wallet_labels.py Merge #13498: [wallet] Fixups from account API deprecation 2020-12-22 17:58:12 +01:00
wallet_listreceivedby.py Merge #13136: [tests] Fix flake8 warnings in several wallet functional tests 2021-05-25 14:09:35 +03:00
wallet_listsinceblock.py Merge #13136: [tests] Fix flake8 warnings in several wallet functional tests 2021-05-25 14:09:35 +03:00
wallet_listtransactions.py Merge #13054: tests: Enable automatic detection of undefined names in Python tests scripts. Remove wildcard imports. 2021-07-06 20:29:33 +03:00
wallet_multiwallet.py Merge #20101: rpc: change no wallet loaded message to be clearer 2021-07-15 19:30:07 -05:00
wallet_resendwallettransactions.py Backport 11796 + 11774 (#3612) 2020-07-17 02:44:20 +03:00
wallet_txn_clone.py Merge #13944: test: Port usage of deprecated optparse module to argparse module 2021-07-06 20:29:32 +03:00
wallet_txn_doublespend.py Merge #13944: test: Port usage of deprecated optparse module to argparse module 2021-07-06 20:29:32 +03:00
wallet_upgradetohd.py Merge #12755: [tests] Better stderr testing 2021-06-28 02:00:44 +03:00
wallet_zapwallettxes.py Backport 11796 + 11774 (#3612) 2020-07-17 02:44:20 +03: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
    • 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 (25x500=12500 DASH) 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 dashd(s) being tested in a callback-based event loop; the other implements the test logic.

  • P2PConnection is the class used to connect to a dashd. 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 dashd.

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.