This commit fixes flake8 warnings in the following functional tests: - wallet_listreceivedby.py - wallet_basic.py - wallet_txn_clone.py - wallet_listsinceblock.py - wallet_import_rescan.py - wallet_listtransactions.py - wallet_importprunedfunds.py - wallet_txn_doublspend.py |
||
---|---|---|
.. | ||
test_framework | ||
.gitignore | ||
combine_logs.py | ||
combined_log_template.html | ||
create_cache.py | ||
example_test.py | ||
feature_assumevalid.py | ||
feature_bip68_sequence.py | ||
feature_block.py | ||
feature_blocksdir.py | ||
feature_cltv.py | ||
feature_config_args.py | ||
feature_csv_activation.py | ||
feature_dbcrash.py | ||
feature_dersig.py | ||
feature_fee_estimation.py | ||
feature_help.py | ||
feature_logging.py | ||
feature_maxuploadtarget.py | ||
feature_minchainwork.py | ||
feature_notifications.py | ||
feature_nulldummy.py | ||
feature_proxy.py | ||
feature_pruning.py | ||
feature_rbf.py | ||
feature_reindex.py | ||
feature_segwit.py | ||
feature_uacomment.py | ||
feature_versionbits_warning.py | ||
interface_bitcoin_cli.py | ||
interface_http.py | ||
interface_rest.py | ||
interface_zmq.py | ||
mempool_accept.py | ||
mempool_limit.py | ||
mempool_packages.py | ||
mempool_persist.py | ||
mempool_reorg.py | ||
mempool_resurrect.py | ||
mempool_spend_coinbase.py | ||
mining_basic.py | ||
mining_getblocktemplate_longpoll.py | ||
mining_prioritisetransaction.py | ||
p2p_compactblocks.py | ||
p2p_disconnect_ban.py | ||
p2p_feefilter.py | ||
p2p_fingerprint.py | ||
p2p_invalid_block.py | ||
p2p_invalid_tx.py | ||
p2p_leak.py | ||
p2p_mempool.py | ||
p2p_node_network_limited.py | ||
p2p_segwit.py | ||
p2p_sendheaders.py | ||
p2p_timeouts.py | ||
p2p_unrequested_blocks.py | ||
README.md | ||
rpc_bind.py | ||
rpc_blockchain.py | ||
rpc_decodescript.py | ||
rpc_deprecated.py | ||
rpc_fundrawtransaction.py | ||
rpc_getchaintips.py | ||
rpc_invalidateblock.py | ||
rpc_named_arguments.py | ||
rpc_net.py | ||
rpc_preciousblock.py | ||
rpc_rawtransaction.py | ||
rpc_signmessage.py | ||
rpc_signrawtransaction.py | ||
rpc_txoutproof.py | ||
rpc_uptime.py | ||
rpc_users.py | ||
test_runner.py | ||
wallet_abandonconflict.py | ||
wallet_address_types.py | ||
wallet_backup.py | ||
wallet_basic.py | ||
wallet_bumpfee.py | ||
wallet_disable.py | ||
wallet_dump.py | ||
wallet_encryption.py | ||
wallet_fallbackfee.py | ||
wallet_hd.py | ||
wallet_import_rescan.py | ||
wallet_importmulti.py | ||
wallet_importprunedfunds.py | ||
wallet_keypool.py | ||
wallet_keypool_topup.py | ||
wallet_labels.py | ||
wallet_listreceivedby.py | ||
wallet_listsinceblock.py | ||
wallet_listtransactions.py | ||
wallet_multiwallet.py | ||
wallet_resendwallettransactions.py | ||
wallet_txn_clone.py | ||
wallet_txn_doublespend.py | ||
wallet_zapwallettxes.py |
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)
- 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()
andsetup_xxxx()
methods at the top of the subclass, then locally-defined helper methods, then therun_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, egfeature_rbf.py
interface
for tests for other interfaces (REST, ZMQ, etc), eginterface_rest.py
mempool
for tests for mempool behaviour, egmempool_reorg.py
mining
for tests for mining features, egmining_prioritisetransaction.py
p2p
for tests that explicitly test the p2p interface, egp2p_disconnect_ban.py
rpc
for tests for individual RPC methods or features, egrpc_listtransactions.py
wallet
for tests for wallet features, egwallet_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
, notrpc_decode_script.py
- 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
- Don't use the redundant word
test
in the name, eginterface_zmq.py
, notinterface_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 inset_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 RPCsProcessMessage()
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 (using python's asyncore package); 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. -
Call
network_thread_start()
after allP2PInterface
objects are created to start the networking thread. (Continue with the test logic in your existing thread.) -
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.