dash/test/functional
Wladimir J. van der Laan d1200755f1 Merge #13448: Add linter: Make sure we explicitly open all text files using UTF-8 encoding in Python
c8176b3cc7556d7bcec39a55ae4d6ba16453baaa Add linter: Make sure we explicitly open all text files using UTF-8 or ASCII encoding in Python (practicalswift)
634bd970013eca90f4b4c1f9044eec8c97ba62c2 Explicitly specify encoding when opening text files in Python code (practicalswift)

Pull request description:

  Add linter: Make sure we explicitly open all text files using UTF-8 encoding in Python.

  As requested by @laanwj in #13440.

Tree-SHA512: 1651c00fe220ceb273324abd6703aee504029b96c7ef0e3029145901762c733c9b9d24927da281394fd4681a5bff774336c04eed01fafea997bb32192c334c06
Signed-off-by: pasta <pasta@dashboost.org>

# Conflicts:
#	contrib/devtools/circular-dependencies.py
#	contrib/linearize/linearize-data.py
#	contrib/linearize/linearize-hashes.py
#	contrib/seeds/generate-seeds.py
#	contrib/verify-commits/verify-commits.py
#	test/functional/multiwallet.py
#	test/functional/notifications.py
#	test/functional/test_runner.py
#	test/util/rpcauth-test.py
2020-07-07 11:50:56 -05:00
..
data
test_framework Merge #13448: Add linter: Make sure we explicitly open all text files using UTF-8 encoding in Python 2020-07-07 11:50:56 -05:00
.gitignore
abandonconflict.py Merge #12282: wallet: Disallow abandon of conflicted txes 2020-06-17 14:29:55 -05:00
addressindex.py fix lint-python.sh after 11835 and 12295 2020-06-17 14:29:55 -05:00
assumevalid.py Merge #11791: [tests] Rename NodeConn and NodeConnCB 2020-04-08 11:46:27 -05:00
bip65-cltv-p2p.py fix test after 12356 2020-06-11 00:47:56 -05:00
bip68-112-113-p2p.py Backport bitcoin#15773: test: Add BitcoinTestFramework::sync_* methods (incomplete backport) (#3409) 2020-04-14 13:00:16 +03:00
bip68-sequence.py Merge #12455: Fix bip68 sequence test to reflect updated rpc error message 2020-06-11 00:33:34 -05:00
bipdersig-p2p.py Merge pull request #3518 from PastaPastaPasta/backports-0.17-pr1 2020-06-11 20:51:58 +03:00
bitcoin_cli.py Merge #12652: bitcoin-cli: Provide a better error message when bitcoind is not running 2020-06-13 14:50:11 -05:00
blockchain.py Merge pull request #3527 from PastaPastaPasta/backports-0.17-pr4 2020-06-16 12:19:57 +03:00
combine_logs.py Merge #13440: qa: Log as utf-8 2020-07-07 11:29:31 -05:00
combined_log_template.html
conf_args.py Merge #11862: Network specific conf sections 2020-05-10 11:15:58 -05:00
create_cache.py Merge #11970: Add test coverage for bitcoin-cli multiwallet calls 2020-03-04 10:13:24 -06:00
dbcrash.py Some Dashification (#3513) 2020-06-11 11:39:04 +03:00
decodescript.py
deprecated_rpc.py Merge #12336: Remove deprecated rpc options 2020-06-10 18:32:43 -05:00
dip3-deterministicmns.py fix lint-python.sh after 11835 and 12295 2020-06-17 14:29:55 -05:00
dip4-coinbasemerkleroots.py fix lint-python.sh after 11835 and 12295 2020-06-17 14:29:55 -05:00
disablewallet.py scripted-diff: rename assert_raises_jsonrpc to assert_raises_rpc error 2019-09-29 12:42:13 +02:00
disconnect_ban.py Call set_node_times by default in bump_mocktime 2020-04-14 15:16:51 +02:00
example_test.py Partial Merge #11835: Add Travis check for unused Python imports 2020-06-17 14:29:55 -05:00
feature_help.py Apply suggestions from code review 2020-03-26 17:09:23 -05:00
feature_logging.py Merge #11781: Add -debuglogfile option 2020-01-30 07:32:32 -06:00
feature_shutdown.py Dashify few strings (#3214) 2019-11-22 21:13:19 +03:00
fundrawtransaction-hd.py Merge bitcoin#11415: [RPC] Disallow using addresses in createmultisig (#3482) 2020-05-15 12:34:41 +03:00
fundrawtransaction.py Merge #12265: [test] fundrawtransaction: lock watch-only shared address 2020-06-28 19:28:57 -05:00
getblocktemplate_longpoll.py fix lint-python.sh after 11835 and 12295 2020-06-17 14:29:55 -05:00
getchaintips.py Backport bitcoin#15773: test: Add BitcoinTestFramework::sync_* methods (incomplete backport) (#3409) 2020-04-14 13:00:16 +03:00
httpbasics.py Some Dashification (#3513) 2020-06-11 11:39:04 +03:00
import-rescan.py fix lint-python.sh after 11835 and 12295 2020-06-17 14:29:55 -05:00
importmulti.py Merge bitcoin#11415: [RPC] Disallow using addresses in createmultisig (#3482) 2020-05-15 12:34:41 +03:00
importprunedfunds.py Merge #10781: Python cleanups 2020-01-02 22:01:29 -06:00
invalidateblock.py Backport bitcoin#15773: test: Add BitcoinTestFramework::sync_* methods (incomplete backport) (#3409) 2020-04-14 13:00:16 +03:00
invalidblockrequest.py Fixes and refactorings related to using mnsync in tests (#3136) 2019-10-09 19:48:12 +03:00
invalidtxrequest.py Merge #13352: qa: Avoid checking reject code for now 2020-06-14 12:22:23 -05:00
keypool-hd.py
keypool-topup.py fix lint-python.sh after 11835 and 12295 2020-06-17 14:29:55 -05:00
keypool.py scripted-diff: rename assert_raises_jsonrpc to assert_raises_rpc error 2019-09-29 12:42:13 +02:00
listsinceblock.py Merge #12716: Fix typos and cleanup in various files 2020-06-11 23:20:48 -05:00
listtransactions.py fix lint-python.sh after 11835 and 12295 2020-06-17 14:29:55 -05:00
llmq-chainlocks.py Backport bitcoin#15773: test: Add BitcoinTestFramework::sync_* methods (incomplete backport) (#3409) 2020-04-14 13:00:16 +03:00
llmq-connections.py Bump mocktime by 60 secs after calling setnetworkactive(True) 2020-04-14 15:16:51 +02:00
llmq-dkgerrors.py fix lint-python.sh after 11835 and 12295 2020-06-17 14:29:55 -05:00
llmq-is-cl-conflicts.py fix lint-python.sh after 11835 and 12295 2020-06-17 14:29:55 -05:00
llmq-is-retroactive.py fix lint-python.sh after 11835 and 12295 2020-06-17 14:29:55 -05:00
llmq-signing.py Use exponential backoff timeouts for recovery (#3535) 2020-06-24 10:02:57 +02:00
llmq-simplepose.py Merge pull request #3422 from codablock/pr_speedups7 2020-04-17 07:52:34 +02:00
maxuploadtarget.py fix lint-python.sh after 11835 and 12295 2020-06-17 14:29:55 -05:00
mempool_limit.py Merge #12512: Don't test against the mempool min fee information in mempool_limit.py 2020-06-10 19:40:40 -05:00
mempool_packages.py Merge #12479: RPC: Add child transactions to getrawmempool verbose output 2020-06-13 14:50:11 -05:00
mempool_persist.py Merge #12627: qa: Fix some tests to work on native windows 2020-06-18 11:41:53 -05:00
mempool_reorg.py scripted-diff: rename assert_raises_jsonrpc to assert_raises_rpc error 2019-09-29 12:42:13 +02:00
mempool_resurrect_test.py
mempool_spendcoinbase.py scripted-diff: rename assert_raises_jsonrpc to assert_raises_rpc error 2019-09-29 12:42:13 +02:00
merkle_blocks.py scripted-diff: rename assert_raises_jsonrpc to assert_raises_rpc error 2019-09-29 12:42:13 +02:00
minchainwork.py Always pass current mocktime to started nodes (#3423) 2020-04-17 07:52:06 +02:00
mining.py Few assert_raises_jsonrpc -> assert_raises_rpc_error fixes 2019-09-29 12:48:49 +02:00
multi_rpc.py
multikeysporks.py Call set_node_times by default in bump_mocktime 2020-04-14 15:16:51 +02:00
multiwallet.py Merge #13448: Add linter: Make sure we explicitly open all text files using UTF-8 encoding in Python 2020-07-07 11:50:56 -05:00
net.py Also wait for node1 to close all sockets 2020-04-17 07:53:07 +02:00
node_network_limited.py fix lint-python.sh after 11835 and 12295 2020-06-17 14:29:55 -05:00
notifications.py Merge #13448: Add linter: Make sure we explicitly open all text files using UTF-8 encoding in Python 2020-07-07 11:50:56 -05:00
nulldummy.py Merge #12356: Fix 'mempool min fee not met' debug output 2020-06-10 18:32:43 -05:00
p2p-acceptblock.py fix lint-python.sh after 11835 and 12295 2020-06-17 14:29:55 -05:00
p2p-compactblocks.py fix lint-python.sh after 11835 and 12295 2020-06-17 14:29:55 -05:00
p2p-fingerprint.py Merge #12393: Fix a-vs-an typos 2020-06-17 14:29:55 -05:00
p2p-fullblocktest.py fix lint-python.sh after 11835 and 12295 2020-06-17 14:29:55 -05:00
p2p-instantsend.py fix lint-python.sh after 11835 and 12295 2020-06-17 14:29:55 -05:00
p2p-leaktests.py Merge #12716: Fix typos and cleanup in various files 2020-06-11 23:20:48 -05:00
p2p-mempool.py Merge #11791: [tests] Rename NodeConn and NodeConnCB 2020-04-08 11:46:27 -05:00
p2p-timeouts.py retain wait one additional second 2020-06-13 16:11:45 +00:00
p2p-versionbits-warning.py bitcoind -> dashd 2020-06-26 13:49:38 +00:00
preciousblock.py fix lint-python.sh after 11835 and 12295 2020-06-17 14:29:55 -05:00
prioritise_transaction.py Merge #12716: Fix typos and cleanup in various files 2020-06-11 23:20:48 -05:00
privatesend.py Add basic PrivateSend RPC Tests (#3254) 2019-12-31 17:22:43 +03:00
proxy_test.py Some Dashification (#3513) 2020-06-11 11:39:04 +03:00
pruning.py Change litemode to disablegovernance (#3577) 2020-06-29 00:00:00 +03:00
rawtransactions.py Merge #12393: Fix a-vs-an typos 2020-06-17 14:29:55 -05:00
README.md Merge #11791: [tests] Rename NodeConn and NodeConnCB 2020-04-08 11:46:27 -05:00
receivedby.py Merge #9991: listreceivedbyaddress Filter Address 2020-06-27 10:43:32 -05:00
reindex.py Some Dashification (#3513) 2020-06-11 11:39:04 +03:00
resendwallettransactions.py scripted-diff: rename assert_raises_jsonrpc to assert_raises_rpc error 2019-09-29 12:42:13 +02:00
rest.py Merge #12479: RPC: Add child transactions to getrawmempool verbose output 2020-06-13 14:50:11 -05:00
rpc_getblockstats.py Merge #13448: Add linter: Make sure we explicitly open all text files using UTF-8 encoding in Python 2020-07-07 11:50:56 -05:00
rpcbind_test.py Merge #12716: Fix typos and cleanup in various files 2020-06-11 23:20:48 -05:00
rpcnamedargs.py Merge #10838: (finally) remove getinfo 2020-02-27 09:21:43 -06:00
sendheaders.py Merge #13350: [tests] Add logging to provide anchor points when debugging p2p_sendheaders 2020-07-07 11:34:46 -05:00
signmessages.py Merge #11241: [tests] Improve signmessages functional test 2019-09-24 17:47:35 +02:00
signrawtransactions.py scripted-diff: rename assert_raises_jsonrpc to assert_raises_rpc error 2019-09-29 12:42:13 +02:00
smartfees.py fix lint-python.sh after 11835 and 12295 2020-06-17 14:29:55 -05:00
spentindex.py A couple of fixes for additional indexes (#3181) 2019-10-31 20:30:42 +03:00
sporks.py fix lint-python.sh after 11835 and 12295 2020-06-17 14:29:55 -05:00
test_runner.py Merge #13448: Add linter: Make sure we explicitly open all text files using UTF-8 encoding in Python 2020-07-07 11:50:56 -05:00
timestampindex.py A couple of fixes for additional indexes (#3181) 2019-10-31 20:30:42 +03:00
txindex.py fix lint-python.sh after 11835 and 12295 2020-06-17 14:29:55 -05:00
txn_clone.py Backport bitcoin#15773: test: Add BitcoinTestFramework::sync_* methods (incomplete backport) (#3409) 2020-04-14 13:00:16 +03:00
txn_doublespend.py Backport bitcoin#15773: test: Add BitcoinTestFramework::sync_* methods (incomplete backport) (#3409) 2020-04-14 13:00:16 +03:00
uacomment.py Merge #12302: test: Make ua_comment test pass on 0.16.0 2020-03-14 22:01:59 -05:00
uptime.py
wallet-accounts.py Merge bitcoin#11415: [RPC] Disallow using addresses in createmultisig (#3482) 2020-05-15 12:34:41 +03:00
wallet-dump.py remove extra import os 2020-06-26 08:52:38 -05:00
wallet-encryption.py Use mocktime in wallet-encryption.py 2020-03-04 10:14:11 -06:00
wallet-hd.py Apply suggestions from code review 2020-02-08 23:33:25 -06:00
wallet.py Merge #12716: Fix typos and cleanup in various files 2020-06-11 23:20:48 -05:00
walletbackup.py Backport bitcoin#15773: test: Add BitcoinTestFramework::sync_* methods (incomplete backport) (#3409) 2020-04-14 13:00:16 +03:00
zapwallettxes.py Merge #12217: qa: Add missing syncwithvalidationinterfacequeue to tests 2020-06-18 11:41:53 -05:00
zmq_test.py Fix 11452 2020-01-17 13:09:12 -06: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)
  • 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.

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 (using python's asyncore package); 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.

  • Call network_thread_start() after all P2PInterface 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-accept-block.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.