lbrycrd/test/functional
Wladimir J. van der Laan 9b3370d1c6
Merge #12892: [wallet] [rpc] introduce 'label' API for wallet
41ba061 [docs] Add release notes for wallet 'label' API. (John Newbery)
189e0ef [wallet] [rpc] introduce 'label' API for wallet (Wladimir J. van der Laan)

Pull request description:

  Add label API to wallet RPC.

  This is one step towards #3816 ("Remove bolt-on account system") although it doesn't
  actually remove anything yet.

  These initially mirror the account functions, with the following differences:

  - These functions aren't DEPRECATED in the help
  - Help mentions 'label' instead of accounts. In the language used, labels are
    associated with addresses, instead of addresses associated with labels. (unlike
    with accounts.)
  - Labels have no balance
    - No balances in `listlabels`
    - `listlabels` has no minconf or watchonly argument
  - Like in the GUI, labels can be set on any address, not just receiving addreses
  - Unlike accounts, labels can be deleted.
    Being unable to delete them is a common annoyance (see #1231).
    Currently only by reassigning all addresses using `setlabel`, but an explicit
    call `deletelabel` which assigns all address to the default label may make
    sense.

Tree-SHA512: 45cc313c68ad529ce3a15c02181d2ab0083a7e14fe824e2cde34972713fecce512e3d4b9aa46db5355f2baa857c44b234d4fe9709225bc23c7ebbc0e03febbf5
2018-04-11 11:41:20 +02:00
..
test_framework Merge #12902: [qa] Handle potential cookie race when starting node 2018-04-09 19:11:08 -04:00
.gitignore Rename rpc-tests directory to functional 2017-03-20 10:40:31 -04:00
combine_logs.py Format timestamps using ISO 8601 formatting (e.g. "2018-02-28T12:34:56Z") 2018-03-09 15:02:01 +01: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 [tests] allow tests to be run with --usecli 2018-01-08 17:35:27 -05:00
example_test.py Fix typos 2018-03-21 08:34:44 +02:00
feature_assumevalid.py [tests] Rename feature_* functional tests. 2018-01-25 09:44:29 +10:00
feature_bip68_sequence.py scripted-diff: change signrawtransaction to signrawtransactionwithwallet in tests 2018-02-17 11:42:01 -05:00
feature_block.py [tests] Change feature_block.py to use BitcoinTestFramework 2018-03-19 14:26:09 -04:00
feature_blocksdir.py qa: Match full plain text by default 2018-04-01 17:36:14 -04:00
feature_cltv.py scripted-diff: change signrawtransaction to signrawtransactionwithwallet in tests 2018-02-17 11:42:01 -05:00
feature_config_args.py qa: Match full plain text by default 2018-04-01 17:36:14 -04:00
feature_csv_activation.py [tests] Change feature_csv_activation.py to use BitcoinTestFramework 2018-03-22 09:38:31 -04:00
feature_dbcrash.py scripted-diff: change signrawtransaction to signrawtransactionwithwallet in tests 2018-02-17 11:42:01 -05:00
feature_dersig.py scripted-diff: change signrawtransaction to signrawtransactionwithwallet in tests 2018-02-17 11:42:01 -05:00
feature_fee_estimation.py [Tests] Use blockmaxweight where tests previously had blockmaxsize 2018-03-26 19:53:58 +04:00
feature_help.py [qa] Ensure bitcoind processes are cleaned up when tests end 2018-04-08 10:47:31 -04:00
feature_logging.py qa: Match full plain text by default 2018-04-01 17:36:14 -04:00
feature_maxuploadtarget.py [config] Remove blockmaxsize option 2018-03-22 10:28:56 -04:00
feature_minchainwork.py [tests] Rename feature_* functional tests. 2018-01-25 09:44:29 +10:00
feature_notifications.py qa: Windows fixups for functional tests 2018-04-08 12:44:43 -04:00
feature_nulldummy.py scripted-diff: change signrawtransaction to signrawtransactionwithwallet in tests 2018-02-17 11:42:01 -05:00
feature_proxy.py [tests] Rename feature_* functional tests. 2018-01-25 09:44:29 +10:00
feature_pruning.py [Tests] Use blockmaxweight where tests previously had blockmaxsize 2018-03-26 19:53:58 +04:00
feature_rbf.py scripted-diff: change signrawtransaction to signrawtransactionwithwallet in tests 2018-02-17 11:42:01 -05:00
feature_reindex.py test: Use wait_until in tests where time was used for polling 2018-03-15 23:43:53 -07:00
feature_segwit.py scripted-diff: change signrawtransaction to signrawtransactionwithwallet in tests 2018-02-17 11:42:01 -05:00
feature_uacomment.py qa: Match full plain text by default 2018-04-01 17:36:14 -04:00
feature_versionbits_warning.py Fix intermittent failure in p2p-versionbits-warning.py 2018-01-25 07:34:58 -05:00
interface_bitcoin_cli.py tests: Test connecting with non-existing RPC cookie file 2018-03-19 22:44:43 +01:00
interface_http.py [tests] Rename misc functional tests. 2018-01-25 09:44:30 +10:00
interface_rest.py [tests] simplify binary and hex response parsing in interface_rest.py 2018-04-03 10:53:59 +03:00
interface_zmq.py [tests] Rename misc functional tests. 2018-01-25 09:44:30 +10:00
mempool_accept.py rpc: Add testmempoolaccept 2018-03-24 11:17:08 -04:00
mempool_limit.py Don't test against the mempool min fee information in mempool_limit.py 2018-02-22 13:30:50 -08:00
mempool_packages.py [Tests] Check output of parent/child tx list from getrawmempool, getmempooldescendants, getmempoolancestors, and REST interface 2018-02-25 19:02:54 -05:00
mempool_persist.py qa: Windows fixups for functional tests 2018-04-08 12:44:43 -04:00
mempool_reorg.py scripted-diff: change signrawtransaction to signrawtransactionwithwallet in tests 2018-02-17 11:42:01 -05:00
mempool_resurrect.py [tests] Rename misc functional tests. 2018-01-25 09:44:30 +10:00
mempool_spend_coinbase.py [tests] Rename misc functional tests. 2018-01-25 09:44:30 +10:00
mining_basic.py [tests] Rename misc functional tests. 2018-01-25 09:44:30 +10:00
mining_getblocktemplate_longpoll.py [tests] Rename misc functional tests. 2018-01-25 09:44:30 +10:00
mining_prioritisetransaction.py Fix typos 2018-03-21 08:34:44 +02:00
p2p_compactblocks.py Merge #12716: Fix typos and cleanup in various files 2018-03-21 11:17:43 -04:00
p2p_disconnect_ban.py [tests] Rename p2p_* functional tests. 2018-01-25 09:44:29 +10:00
p2p_feefilter.py scripted-diff: rename TestNode to TestP2PConn in tests 2018-03-19 14:58:00 -04:00
p2p_fingerprint.py Fix a-vs-an typos 2018-02-11 10:48:15 +01:00
p2p_invalid_block.py [tests] Change invalidblockrequest to use BitcoinTestFramework 2018-02-13 19:04:35 -05:00
p2p_invalid_tx.py [test] Fix nits leftover from 11771 2018-02-13 19:03:47 -05:00
p2p_leak.py Fix typos 2018-03-21 08:34:44 +02:00
p2p_mempool.py [tests] Rename p2p_* functional tests. 2018-01-25 09:44:29 +10:00
p2p_node_network_limited.py Fix typos 2018-03-21 08:34:44 +02:00
p2p_segwit.py Remove assigned but never used local variables 2018-03-29 17:47:12 +02:00
p2p_sendheaders.py Adding logging for loop iteration level in p2p_sendheaders.py 2018-04-02 23:49:59 +01:00
p2p_timeouts.py scripted-diff: rename TestNode to TestP2PConn in tests 2018-03-19 14:58:00 -04:00
p2p_unrequested_blocks.py Fix typos 2018-03-21 08:34:44 +02:00
README.md [tests] Remove Comparison Test Framework 2018-04-02 14:04:07 -04:00
rpc_bind.py Merge #12076: qa: Use node.datadir instead of tmpdir in test framework 2018-03-22 11:10:56 +01:00
rpc_blockchain.py Merge #12431: Only call NotifyBlockTip when chainActive changes 2018-03-15 17:05:43 +01:00
rpc_decodescript.py [tests] Rename rpc_* functional tests. 2018-01-25 09:44:29 +10:00
rpc_deprecated.py Create getaddressinfo RPC and deprecate parts of validateaddress 2018-02-16 12:09:32 -05:00
rpc_fundrawtransaction.py scripted-diff: change signrawtransaction to signrawtransactionwithwallet in tests 2018-02-17 11:42:01 -05:00
rpc_getchaintips.py [tests] Rename rpc_* functional tests. 2018-01-25 09:44:29 +10:00
rpc_invalidateblock.py [tests] Rename rpc_* functional tests. 2018-01-25 09:44:29 +10:00
rpc_listtransactions.py scripted-diff: change signrawtransaction to signrawtransactionwithwallet in tests 2018-02-17 11:42:01 -05:00
rpc_named_arguments.py [tests] Rename rpc_* functional tests. 2018-01-25 09:44:29 +10:00
rpc_net.py [tests] Fix intermittent rpc_net.py failure. 2018-03-28 15:35:35 -04:00
rpc_preciousblock.py [qa] util: Remove unused sync_chain 2018-03-12 20:32:04 -04:00
rpc_rawtransaction.py test: Assert on correct variable 2018-04-09 08:51:02 +09:00
rpc_signmessage.py [tests] Rename rpc_* functional tests. 2018-01-25 09:44:29 +10:00
rpc_signrawtransaction.py Add test for signrawtransaction 2018-02-17 11:42:01 -05:00
rpc_txoutproof.py scripted-diff: change signrawtransaction to signrawtransactionwithwallet in tests 2018-02-17 11:42:01 -05:00
rpc_uptime.py [tests] Rename rpc_* functional tests. 2018-01-25 09:44:29 +10:00
rpc_users.py qa: Use node.datadir instead of tmpdir in test framework 2018-03-19 12:26:00 -04:00
test_runner.py [tests] Remove bip9-softforks.py 2018-04-02 13:45:58 -04:00
wallet_abandonconflict.py Fix typos 2018-03-21 08:34:44 +02:00
wallet_address_types.py Create getaddressinfo RPC and deprecate parts of validateaddress 2018-02-16 12:09:32 -05:00
wallet_backup.py qa: Use node.datadir instead of tmpdir in test framework 2018-03-19 12:26:00 -04:00
wallet_basic.py Merge #12716: Fix typos and cleanup in various files 2018-03-21 11:17:43 -04:00
wallet_bumpfee.py Merge #12749: [wallet] feebumper: discard change outputs below discard rate 2018-04-10 19:35:51 +02:00
wallet_disable.py [tests] Rename wallet_* functional tests. 2018-01-25 09:44:29 +10:00
wallet_dump.py Merge #12627: qa: Fix some tests to work on native windows 2018-03-07 10:30:04 -05:00
wallet_encryption.py [rpcwallet] Clamp walletpassphrase value at 100M seconds 2018-04-08 10:44:40 -04:00
wallet_fallbackfee.py [QA] add wallet-rbf test 2018-02-25 09:38:38 +08:00
wallet_hd.py Merge #12076: qa: Use node.datadir instead of tmpdir in test framework 2018-03-22 11:10:56 +01:00
wallet_import_rescan.py Rename account to label where appropriate 2018-03-19 12:05:35 -04:00
wallet_importmulti.py Remove assigned but never used local variables 2018-03-29 17:47:12 +02:00
wallet_importprunedfunds.py scripted-diff: validateaddress to getaddressinfo in tests 2018-02-16 12:09:36 -05:00
wallet_keypool.py scripted-diff: validateaddress to getaddressinfo in tests 2018-02-16 12:09:36 -05:00
wallet_keypool_topup.py qa: Use node.datadir instead of tmpdir in test framework 2018-03-19 12:26:00 -04:00
wallet_labels.py [wallet] [rpc] introduce 'label' API for wallet 2018-04-10 19:27:22 -04:00
wallet_listreceivedby.py [wallet] [rpc] introduce 'label' API for wallet 2018-04-10 19:27:22 -04:00
wallet_listsinceblock.py Fix typos 2018-03-21 08:34:44 +02:00
wallet_multiwallet.py scripted-diff: Rename wallet database classes 2018-04-07 11:48:27 -05:00
wallet_resendwallettransactions.py [tests] Rename wallet_* functional tests. 2018-01-25 09:44:29 +10:00
wallet_txn_clone.py Split signrawtransaction into wallet and non-wallet 2018-02-17 11:42:00 -05:00
wallet_txn_doublespend.py scripted-diff: change signrawtransaction to signrawtransactionwithwallet in tests 2018-02-17 11:42:01 -05:00
wallet_zapwallettxes.py qa: Add missing syncwithvalidationinterfacequeue to tests 2018-01-25 10:31:35 -05: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.

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.

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 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 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_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.