lbrycrd/test/functional
Wladimir J. van der Laan 0257062e50
Merge #14816: Add CScriptNum decode python implementation in functional suite
2012d4df2 Add CScriptNum decode python implementation in functional suite (Gregory Sanders)

Pull request description:

  I needed this for reasons and thought it'd be good to upsteam it.

Tree-SHA512: 6ea89fa2a5f5a7759ba722f2b4ed5cd6423ebfff4e83ac8b8b5c935e6aa479684e626c5f41fa020816d2a9079a99af5564e30808594d5c13e3b51ec9b474926d
2018-12-04 11:28:53 +01:00
..
data check that a separator is found for psbt inputs, outputs, and global map 2018-10-03 00:26:10 -04:00
test_framework Merge #14816: Add CScriptNum decode python implementation in functional suite 2018-12-04 11:28:53 +01:00
.gitignore Rename rpc-tests directory to functional 2017-03-20 10:40:31 -04:00
combine_logs.py tests: have combine_logs default to most recent test dir 2018-11-29 17:41:12 -05: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 Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
example_test.py example_test.py: fixup coinbase height argument, derive number clearly 2018-11-05 13:18:24 -05:00
feature_assumevalid.py Merge #13916: qa: wait_for_verack by default 2018-08-09 08:07:28 -04:00
feature_bip68_sequence.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
feature_block.py qa: Check specific reject reasons in feature_block 2018-11-13 11:05:24 -05:00
feature_blocksdir.py Changed functional tests which do not require wallets to run without 2018-09-17 08:25:10 -05:00
feature_cltv.py tests: Remove unused testing code 2018-11-07 18:07:49 +01:00
feature_config_args.py Warn unrecognized sections in the config file 2018-11-20 18:28:16 +09:00
feature_csv_activation.py Merge #14180: qa: Run all tests even if wallet is not compiled 2018-09-13 13:06:07 +02:00
feature_dbcrash.py [tests] Move deterministic address import to setup_nodes 2018-11-01 12:53:49 -04:00
feature_dersig.py tests: Remove unused testing code 2018-11-07 18:07:49 +01:00
feature_fee_estimation.py [tests] Move deterministic address import to setup_nodes 2018-11-01 12:53:49 -04:00
feature_filelock.py utils: Fix broken Windows filelock 2018-10-19 02:29:25 +08:00
feature_help.py qa: Raise feature_help timeout to 5s 2018-08-03 17:41:21 -04:00
feature_includeconf.py Ignore unknown config file options for now 2018-07-30 18:01:20 -07:00
feature_logging.py Changed functional tests which do not require wallets to run without 2018-09-17 08:25:10 -05:00
feature_maxuploadtarget.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
feature_minchainwork.py Changed functional tests which do not require wallets to run without 2018-09-17 08:25:10 -05:00
feature_notifications.py tests: Stop node before removing the notification file 2018-10-12 05:57:58 +08:00
feature_nulldummy.py [tests] Remove deprecated addwitnessaddress call from feature_nulldummy 2018-09-23 08:50:52 -04:00
feature_proxy.py Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
feature_pruning.py rpc: Correctly name arguments 2018-11-13 14:24:40 -05:00
feature_rbf.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
feature_reindex.py Changed functional tests which do not require wallets to run without 2018-09-17 08:25:10 -05:00
feature_segwit.py [test] Remove deprecated addwitnessaddress from feature_segwit.py 2018-09-23 08:53:14 -04:00
feature_uacomment.py utils: Convert Windows args to utf-8 string 2018-09-30 15:08:16 +08:00
feature_versionbits_warning.py Changed functional tests which do not require wallets to run without 2018-09-17 08:25:10 -05:00
interface_bitcoin_cli.py Fix typo 2018-10-20 02:55:41 +03:00
interface_http.py tests: Use explicit imports 2018-08-13 14:13:39 +02:00
interface_rest.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
interface_rpc.py Add regtest for JSON-RPC batch calls. 2018-11-21 19:43:06 +01:00
interface_zmq.py Merge #14060: ZMQ: add options to configure outbound message high water mark, aka SNDHWM 2018-11-05 13:45:41 +01:00
mempool_accept.py Merge #14819: Bugfix: test/functional/mempool_accept: Ensure oversize transaction is actually oversize 2018-11-28 10:40:33 -05:00
mempool_limit.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
mempool_packages.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
mempool_persist.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
mempool_reorg.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
mempool_resurrect.py Tests: Fix a comment 2018-11-01 17:26:42 +01:00
mempool_spend_coinbase.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
mining_basic.py Add CScriptNum decode python implementation in functional suite 2018-11-29 08:31:48 -05:00
mining_getblocktemplate_longpoll.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
mining_prioritisetransaction.py Merge #13424: Consistently validate txid / blockhash length and encoding in rpc calls 2018-09-24 15:09:11 -04:00
p2p_compactblocks.py Merge #14296: [wallet] Remove addwitnessaddress 2018-10-24 08:09:48 -04:00
p2p_disconnect_ban.py rpc: Correctly name arguments 2018-11-13 14:24:40 -05:00
p2p_feefilter.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
p2p_fingerprint.py Changed functional tests which do not require wallets to run without 2018-09-17 08:25:10 -05:00
p2p_invalid_block.py qa: Avoid race in p2p_invalid_block by waiting for the block request 2018-11-09 15:46:58 -05:00
p2p_invalid_locator.py Changed functional tests which do not require wallets to run without 2018-09-17 08:25:10 -05:00
p2p_invalid_messages.py Make test p2p_invalid_messages.py pass: Allow for expected Travis ASAN memory increase 2018-11-26 22:20:46 +01:00
p2p_invalid_tx.py Changed functional tests which do not require wallets to run without 2018-09-17 08:25:10 -05:00
p2p_leak.py Changed functional tests which do not require wallets to run without 2018-09-17 08:25:10 -05:00
p2p_leak_tx.py [tests] Test that nodes respond to getdata with notfound 2018-10-26 07:45:12 -04:00
p2p_mempool.py tests: Use explicit imports 2018-08-13 14:13:39 +02:00
p2p_node_network_limited.py [tests] Move deterministic address import to setup_nodes 2018-11-01 12:53:49 -04:00
p2p_segwit.py Check for specific tx acceptance failures based on script signature 2018-09-26 21:50:51 -05:00
p2p_sendheaders.py Merge #13424: Consistently validate txid / blockhash length and encoding in rpc calls 2018-09-24 15:09:11 -04:00
p2p_timeouts.py tests: Use explicit imports 2018-08-13 14:13:39 +02:00
p2p_unrequested_blocks.py Changed functional tests which do not require wallets to run without 2018-09-17 08:25:10 -05:00
README.md Document fixed attribute behavior in critical test framework classes. 2018-09-26 22:13:06 -05:00
rpc_bind.py tests: Use explicit imports 2018-08-13 14:13:39 +02:00
rpc_blockchain.py rpc: Correctly name arguments 2018-11-13 14:24:40 -05:00
rpc_createmultisig.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
rpc_decodescript.py tests: Use explicit imports 2018-08-13 14:13:39 +02:00
rpc_deprecated.py [wallet] Deprecate the generate RPC method 2018-10-18 17:46:48 -04:00
rpc_fundrawtransaction.py Merge #12493: [wallet] Reopen CDBEnv after encryption instead of shutting down 2018-09-14 10:43:35 +02:00
rpc_getblockstats.py rpc: Always throw in getblockstats if -txindex is required 2018-10-19 15:28:41 +01:00
rpc_getchaintips.py Changed functional tests which do not require wallets to run without 2018-09-17 08:25:10 -05:00
rpc_help.py qa: Add test to ensure node can generate all help texts at runtime 2018-11-05 11:13:32 -05:00
rpc_invalidateblock.py Changed functional tests which do not require wallets to run without 2018-09-17 08:25:10 -05:00
rpc_named_arguments.py Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
rpc_net.py rpc: Correctly name arguments 2018-11-13 14:24:40 -05:00
rpc_preciousblock.py Changed functional tests which do not require wallets to run without 2018-09-17 08:25:10 -05:00
rpc_psbt.py Merge #14380: fix assert crash when specified change output spend size is unknown 2018-11-30 10:49:49 -05:00
rpc_rawtransaction.py Merge #13424: Consistently validate txid / blockhash length and encoding in rpc calls 2018-09-24 15:09:11 -04:00
rpc_scantxoutset.py Add matching descriptors to scantxoutset output + tests 2018-11-14 14:21:42 -08:00
rpc_signmessage.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
rpc_signrawtransaction.py [wallet] remove redundand restart node 2018-09-25 07:00:19 +01:00
rpc_txoutproof.py Merge #13424: Consistently validate txid / blockhash length and encoding in rpc calls 2018-09-24 15:09:11 -04:00
rpc_uptime.py Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
rpc_users.py Merge #13867: qa: Make extended tests pass on native Windows 2018-08-11 07:01:37 -04:00
test_runner.py [tests] Add wallet_balance.py 2018-11-30 10:28:01 -05:00
wallet_abandonconflict.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
wallet_address_types.py Add descriptors to listunspent and getaddressinfo + tests 2018-11-14 14:21:42 -08:00
wallet_backup.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
wallet_balance.py [tests] Add wallet_balance.py 2018-11-30 10:28:01 -05:00
wallet_basic.py [tests] Add wallet_balance.py 2018-11-30 10:28:01 -05:00
wallet_bumpfee.py [test] Remove deprecated addwitnessaddress from wallet_bumpfee.py 2018-09-23 08:51:57 -04:00
wallet_disable.py tests: Use explicit imports 2018-08-13 14:13:39 +02:00
wallet_disableprivatekeys.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
wallet_dump.py [tests] Remove deprecated addwitnessaddress call from wallet_dump.py 2018-09-23 08:51:55 -04:00
wallet_encryption.py qa: Add wallet_encryption error tests 2018-11-26 16:12:13 -05:00
wallet_fallbackfee.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
wallet_groups.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
wallet_hd.py [wallet] Remove -usehd 2018-09-20 17:26:14 -04:00
wallet_import_rescan.py [wallet] Restore ability to list incoming transactions by label 2018-11-13 17:49:23 -04:00
wallet_import_with_label.py rpc: creates possibility to preserve labels on importprivkey 2018-10-05 13:33:21 +01:00
wallet_importmulti.py Merge #14720: rpc: Correctly name arguments 2018-11-13 16:49:23 -05:00
wallet_importprunedfunds.py rpc: Correctly name arguments 2018-11-13 14:24:40 -05:00
wallet_keypool.py [tests] Small fixups before deprecating generate 2018-10-16 11:27:13 -04:00
wallet_keypool_topup.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
wallet_labels.py [tests] Small fixups before deprecating generate 2018-10-16 11:27:13 -04:00
wallet_listreceivedby.py [tests] Move deterministic address import to setup_nodes 2018-11-01 12:53:49 -04:00
wallet_listsinceblock.py Merge #13424: Consistently validate txid / blockhash length and encoding in rpc calls 2018-09-24 15:09:11 -04:00
wallet_listtransactions.py [wallet] Restore ability to list incoming transactions by label 2018-11-13 17:49:23 -04:00
wallet_multiwallet.py wallet: Add trailing wallet.dat when detecting duplicate wallet if it's a directory. 2018-11-06 08:28:02 +08:00
wallet_resendwallettransactions.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
wallet_txn_clone.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
wallet_txn_doublespend.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04:00
wallet_zapwallettxes.py qa: Run all tests even if wallet is not compiled 2018-09-10 17:53:21 -04: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.
  • 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 (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.
  • 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

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