mirror of https://github.com/bitcoin/bitcoin
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
871 lines
34 KiB
871 lines
34 KiB
#!/usr/bin/env python3
|
|
# Copyright (c) 2014-2022 The Bitcoin Core developers
|
|
# Distributed under the MIT software license, see the accompanying
|
|
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
"""Run regression test suite.
|
|
|
|
This module calls down into individual test cases via subprocess. It will
|
|
forward all unrecognized arguments onto the individual test scripts.
|
|
|
|
For a description of arguments recognized by test scripts, see
|
|
`test/functional/test_framework/test_framework.py:BitcoinTestFramework.main`.
|
|
|
|
"""
|
|
|
|
import argparse
|
|
from collections import deque
|
|
import configparser
|
|
import datetime
|
|
import os
|
|
import time
|
|
import shutil
|
|
import signal
|
|
import subprocess
|
|
import sys
|
|
import tempfile
|
|
import re
|
|
import logging
|
|
import unittest
|
|
|
|
os.environ["REQUIRE_WALLET_TYPE_SET"] = "1"
|
|
|
|
# Formatting. Default colors to empty strings.
|
|
DEFAULT, BOLD, GREEN, RED = ("", ""), ("", ""), ("", ""), ("", "")
|
|
try:
|
|
# Make sure python thinks it can write unicode to its stdout
|
|
"\u2713".encode("utf_8").decode(sys.stdout.encoding)
|
|
TICK = "✓ "
|
|
CROSS = "✖ "
|
|
CIRCLE = "○ "
|
|
except UnicodeDecodeError:
|
|
TICK = "P "
|
|
CROSS = "x "
|
|
CIRCLE = "o "
|
|
|
|
if os.name != 'nt' or sys.getwindowsversion() >= (10, 0, 14393): #type:ignore
|
|
if os.name == 'nt':
|
|
import ctypes
|
|
kernel32 = ctypes.windll.kernel32 # type: ignore
|
|
ENABLE_VIRTUAL_TERMINAL_PROCESSING = 4
|
|
STD_OUTPUT_HANDLE = -11
|
|
STD_ERROR_HANDLE = -12
|
|
# Enable ascii color control to stdout
|
|
stdout = kernel32.GetStdHandle(STD_OUTPUT_HANDLE)
|
|
stdout_mode = ctypes.c_int32()
|
|
kernel32.GetConsoleMode(stdout, ctypes.byref(stdout_mode))
|
|
kernel32.SetConsoleMode(stdout, stdout_mode.value | ENABLE_VIRTUAL_TERMINAL_PROCESSING)
|
|
# Enable ascii color control to stderr
|
|
stderr = kernel32.GetStdHandle(STD_ERROR_HANDLE)
|
|
stderr_mode = ctypes.c_int32()
|
|
kernel32.GetConsoleMode(stderr, ctypes.byref(stderr_mode))
|
|
kernel32.SetConsoleMode(stderr, stderr_mode.value | ENABLE_VIRTUAL_TERMINAL_PROCESSING)
|
|
# primitive formatting on supported
|
|
# terminal via ANSI escape sequences:
|
|
DEFAULT = ('\033[0m', '\033[0m')
|
|
BOLD = ('\033[0m', '\033[1m')
|
|
GREEN = ('\033[0m', '\033[0;32m')
|
|
RED = ('\033[0m', '\033[0;31m')
|
|
|
|
TEST_EXIT_PASSED = 0
|
|
TEST_EXIT_SKIPPED = 77
|
|
|
|
# List of framework modules containing unit tests. Should be kept in sync with
|
|
# the output of `git grep unittest.TestCase ./test/functional/test_framework`
|
|
TEST_FRAMEWORK_MODULES = [
|
|
"address",
|
|
"blocktools",
|
|
"ellswift",
|
|
"key",
|
|
"muhash",
|
|
"ripemd160",
|
|
"script",
|
|
"segwit_addr",
|
|
]
|
|
|
|
EXTENDED_SCRIPTS = [
|
|
# These tests are not run by default.
|
|
# Longest test should go first, to favor running tests in parallel
|
|
'feature_pruning.py',
|
|
'feature_dbcrash.py',
|
|
'feature_index_prune.py',
|
|
'wallet_pruning.py --legacy-wallet',
|
|
]
|
|
|
|
BASE_SCRIPTS = [
|
|
# Scripts that are run by default.
|
|
# Longest test should go first, to favor running tests in parallel
|
|
# vv Tests less than 5m vv
|
|
'feature_fee_estimation.py',
|
|
'feature_taproot.py',
|
|
'feature_block.py',
|
|
# vv Tests less than 2m vv
|
|
'mining_getblocktemplate_longpoll.py',
|
|
'p2p_segwit.py',
|
|
'feature_maxuploadtarget.py',
|
|
'mempool_updatefromblock.py',
|
|
'mempool_persist.py --descriptors',
|
|
# vv Tests less than 60s vv
|
|
'rpc_psbt.py --legacy-wallet',
|
|
'rpc_psbt.py --descriptors',
|
|
'wallet_fundrawtransaction.py --legacy-wallet',
|
|
'wallet_fundrawtransaction.py --descriptors',
|
|
'wallet_bumpfee.py --legacy-wallet',
|
|
'wallet_bumpfee.py --descriptors',
|
|
'wallet_import_rescan.py --legacy-wallet',
|
|
'wallet_backup.py --legacy-wallet',
|
|
'wallet_backup.py --descriptors',
|
|
'feature_segwit.py --legacy-wallet',
|
|
'feature_segwit.py --descriptors',
|
|
'p2p_tx_download.py',
|
|
'wallet_avoidreuse.py --legacy-wallet',
|
|
'wallet_avoidreuse.py --descriptors',
|
|
'feature_abortnode.py',
|
|
'wallet_address_types.py --legacy-wallet',
|
|
'wallet_address_types.py --descriptors',
|
|
'wallet_basic.py --legacy-wallet',
|
|
'wallet_basic.py --descriptors',
|
|
'feature_maxtipage.py',
|
|
'wallet_multiwallet.py --legacy-wallet',
|
|
'wallet_multiwallet.py --descriptors',
|
|
'wallet_multiwallet.py --usecli',
|
|
'p2p_dns_seeds.py',
|
|
'wallet_groups.py --legacy-wallet',
|
|
'wallet_groups.py --descriptors',
|
|
'p2p_blockfilters.py',
|
|
'feature_assumevalid.py',
|
|
'wallet_taproot.py --descriptors',
|
|
'feature_bip68_sequence.py',
|
|
'rpc_packages.py',
|
|
'rpc_bind.py --ipv4',
|
|
'rpc_bind.py --ipv6',
|
|
'rpc_bind.py --nonloopback',
|
|
'p2p_headers_sync_with_minchainwork.py',
|
|
'p2p_feefilter.py',
|
|
'feature_csv_activation.py',
|
|
'p2p_sendheaders.py',
|
|
'wallet_listtransactions.py --legacy-wallet',
|
|
'wallet_listtransactions.py --descriptors',
|
|
# vv Tests less than 30s vv
|
|
'p2p_invalid_messages.py',
|
|
'rpc_createmultisig.py',
|
|
'p2p_timeouts.py',
|
|
'wallet_dump.py --legacy-wallet',
|
|
'rpc_signer.py',
|
|
'wallet_signer.py --descriptors',
|
|
'wallet_importmulti.py --legacy-wallet',
|
|
'mempool_limit.py',
|
|
'rpc_txoutproof.py',
|
|
'wallet_listreceivedby.py --legacy-wallet',
|
|
'wallet_listreceivedby.py --descriptors',
|
|
'wallet_abandonconflict.py --legacy-wallet',
|
|
'wallet_abandonconflict.py --descriptors',
|
|
'feature_reindex.py',
|
|
'wallet_labels.py --legacy-wallet',
|
|
'wallet_labels.py --descriptors',
|
|
'p2p_compactblocks.py',
|
|
'p2p_compactblocks_blocksonly.py',
|
|
'wallet_hd.py --legacy-wallet',
|
|
'wallet_hd.py --descriptors',
|
|
'wallet_blank.py --legacy-wallet',
|
|
'wallet_blank.py --descriptors',
|
|
'wallet_keypool_topup.py --legacy-wallet',
|
|
'wallet_keypool_topup.py --descriptors',
|
|
'wallet_fast_rescan.py --descriptors',
|
|
'interface_zmq.py',
|
|
'rpc_invalid_address_message.py',
|
|
'rpc_validateaddress.py',
|
|
'interface_bitcoin_cli.py --legacy-wallet',
|
|
'interface_bitcoin_cli.py --descriptors',
|
|
'feature_bind_extra.py',
|
|
'mempool_resurrect.py',
|
|
'wallet_txn_doublespend.py --mineblock',
|
|
'tool_wallet.py --legacy-wallet',
|
|
'tool_wallet.py --descriptors',
|
|
'tool_signet_miner.py --legacy-wallet',
|
|
'tool_signet_miner.py --descriptors',
|
|
'wallet_txn_clone.py',
|
|
'wallet_txn_clone.py --segwit',
|
|
'rpc_getchaintips.py',
|
|
'rpc_misc.py',
|
|
'interface_rest.py',
|
|
'mempool_spend_coinbase.py',
|
|
'wallet_avoid_mixing_output_types.py --descriptors',
|
|
'mempool_reorg.py',
|
|
'p2p_block_sync.py',
|
|
'wallet_createwallet.py --legacy-wallet',
|
|
'wallet_createwallet.py --usecli',
|
|
'wallet_createwallet.py --descriptors',
|
|
'wallet_watchonly.py --legacy-wallet',
|
|
'wallet_watchonly.py --usecli --legacy-wallet',
|
|
'wallet_reorgsrestore.py',
|
|
'wallet_conflicts.py --legacy-wallet',
|
|
'wallet_conflicts.py --descriptors',
|
|
'interface_http.py',
|
|
'interface_rpc.py',
|
|
'interface_usdt_coinselection.py',
|
|
'interface_usdt_mempool.py',
|
|
'interface_usdt_net.py',
|
|
'interface_usdt_utxocache.py',
|
|
'interface_usdt_validation.py',
|
|
'rpc_users.py',
|
|
'rpc_whitelist.py',
|
|
'feature_proxy.py',
|
|
'wallet_signrawtransactionwithwallet.py --legacy-wallet',
|
|
'wallet_signrawtransactionwithwallet.py --descriptors',
|
|
'rpc_signrawtransactionwithkey.py',
|
|
'rpc_rawtransaction.py --legacy-wallet',
|
|
'wallet_transactiontime_rescan.py --descriptors',
|
|
'wallet_transactiontime_rescan.py --legacy-wallet',
|
|
'p2p_addrv2_relay.py',
|
|
'p2p_compactblocks_hb.py',
|
|
'p2p_disconnect_ban.py',
|
|
'feature_posix_fs_permissions.py',
|
|
'rpc_decodescript.py',
|
|
'rpc_blockchain.py',
|
|
'rpc_deprecated.py',
|
|
'wallet_disable.py',
|
|
'wallet_change_address.py --legacy-wallet',
|
|
'wallet_change_address.py --descriptors',
|
|
'p2p_addr_relay.py',
|
|
'p2p_getaddr_caching.py',
|
|
'p2p_getdata.py',
|
|
'p2p_addrfetch.py',
|
|
'rpc_net.py',
|
|
'wallet_keypool.py --legacy-wallet',
|
|
'wallet_keypool.py --descriptors',
|
|
'wallet_descriptor.py --descriptors',
|
|
'wallet_miniscript.py --descriptors',
|
|
'p2p_nobloomfilter_messages.py',
|
|
'p2p_filter.py',
|
|
'rpc_setban.py',
|
|
'p2p_blocksonly.py',
|
|
'mining_prioritisetransaction.py',
|
|
'p2p_invalid_locator.py',
|
|
'p2p_invalid_block.py',
|
|
'p2p_invalid_tx.py',
|
|
'example_test.py',
|
|
'wallet_txn_doublespend.py --legacy-wallet',
|
|
'wallet_multisig_descriptor_psbt.py --descriptors',
|
|
'wallet_txn_doublespend.py --descriptors',
|
|
'wallet_backwards_compatibility.py --legacy-wallet',
|
|
'wallet_backwards_compatibility.py --descriptors',
|
|
'wallet_txn_clone.py --mineblock',
|
|
'feature_notifications.py',
|
|
'rpc_getblockfilter.py',
|
|
'rpc_getblockfrompeer.py',
|
|
'rpc_invalidateblock.py',
|
|
'feature_utxo_set_hash.py',
|
|
'feature_rbf.py',
|
|
'mempool_packages.py',
|
|
'mempool_package_onemore.py',
|
|
'mempool_package_limits.py',
|
|
'feature_versionbits_warning.py',
|
|
'rpc_preciousblock.py',
|
|
'wallet_importprunedfunds.py --legacy-wallet',
|
|
'wallet_importprunedfunds.py --descriptors',
|
|
'p2p_leak_tx.py',
|
|
'p2p_eviction.py',
|
|
'p2p_ibd_stalling.py',
|
|
'wallet_signmessagewithaddress.py',
|
|
'rpc_signmessagewithprivkey.py',
|
|
'rpc_generate.py',
|
|
'wallet_balance.py --legacy-wallet',
|
|
'wallet_balance.py --descriptors',
|
|
'p2p_initial_headers_sync.py',
|
|
'feature_nulldummy.py',
|
|
'mempool_accept.py',
|
|
'mempool_expiry.py',
|
|
'wallet_import_with_label.py --legacy-wallet',
|
|
'wallet_importdescriptors.py --descriptors',
|
|
'wallet_upgradewallet.py --legacy-wallet',
|
|
'wallet_crosschain.py',
|
|
'mining_basic.py',
|
|
'feature_signet.py',
|
|
'wallet_implicitsegwit.py --legacy-wallet',
|
|
'rpc_named_arguments.py',
|
|
'feature_startupnotify.py',
|
|
'wallet_simulaterawtx.py --legacy-wallet',
|
|
'wallet_simulaterawtx.py --descriptors',
|
|
'wallet_listsinceblock.py --legacy-wallet',
|
|
'wallet_listsinceblock.py --descriptors',
|
|
'wallet_listdescriptors.py --descriptors',
|
|
'p2p_leak.py',
|
|
'wallet_encryption.py --legacy-wallet',
|
|
'wallet_encryption.py --descriptors',
|
|
'feature_dersig.py',
|
|
'feature_cltv.py',
|
|
'rpc_uptime.py',
|
|
'feature_discover.py',
|
|
'wallet_resendwallettransactions.py --legacy-wallet',
|
|
'wallet_resendwallettransactions.py --descriptors',
|
|
'wallet_fallbackfee.py --legacy-wallet',
|
|
'wallet_fallbackfee.py --descriptors',
|
|
'rpc_dumptxoutset.py',
|
|
'feature_minchainwork.py',
|
|
'rpc_estimatefee.py',
|
|
'rpc_getblockstats.py',
|
|
'feature_bind_port_externalip.py',
|
|
'wallet_create_tx.py --legacy-wallet',
|
|
'wallet_send.py --legacy-wallet',
|
|
'wallet_send.py --descriptors',
|
|
'wallet_sendall.py --legacy-wallet',
|
|
'wallet_sendall.py --descriptors',
|
|
'wallet_create_tx.py --descriptors',
|
|
'wallet_inactive_hdchains.py --legacy-wallet',
|
|
'p2p_fingerprint.py',
|
|
'feature_uacomment.py',
|
|
'feature_init.py',
|
|
'wallet_coinbase_category.py --legacy-wallet',
|
|
'wallet_coinbase_category.py --descriptors',
|
|
'feature_filelock.py',
|
|
'feature_loadblock.py',
|
|
'p2p_dos_header_tree.py',
|
|
'p2p_add_connections.py',
|
|
'feature_bind_port_discover.py',
|
|
'p2p_unrequested_blocks.py',
|
|
'p2p_message_capture.py',
|
|
'feature_includeconf.py',
|
|
'feature_addrman.py',
|
|
'feature_asmap.py',
|
|
'feature_fastprune.py',
|
|
'mempool_unbroadcast.py',
|
|
'mempool_compatibility.py',
|
|
'mempool_accept_wtxid.py',
|
|
'mempool_dust.py',
|
|
'mempool_sigoplimit.py',
|
|
'rpc_deriveaddresses.py',
|
|
'rpc_deriveaddresses.py --usecli',
|
|
'p2p_ping.py',
|
|
'p2p_tx_privacy.py',
|
|
'rpc_scanblocks.py',
|
|
'p2p_sendtxrcncl.py',
|
|
'rpc_scantxoutset.py',
|
|
'feature_txindex_compatibility.py',
|
|
'feature_unsupported_utxo_db.py',
|
|
'feature_logging.py',
|
|
'feature_anchors.py',
|
|
'mempool_datacarrier.py',
|
|
'feature_coinstatsindex.py',
|
|
'wallet_orphanedreward.py',
|
|
'wallet_timelock.py',
|
|
'p2p_node_network_limited.py',
|
|
'p2p_permissions.py',
|
|
'feature_blocksdir.py',
|
|
'wallet_startup.py',
|
|
'feature_remove_pruned_files_on_startup.py',
|
|
'p2p_i2p_ports.py',
|
|
'p2p_i2p_sessions.py',
|
|
'feature_config_args.py',
|
|
'feature_presegwit_node_upgrade.py',
|
|
'feature_settings.py',
|
|
'rpc_getdescriptorinfo.py',
|
|
'rpc_mempool_info.py',
|
|
'rpc_help.py',
|
|
'feature_dirsymlinks.py',
|
|
'feature_help.py',
|
|
'feature_shutdown.py',
|
|
'wallet_migration.py',
|
|
'p2p_ibd_txrelay.py',
|
|
# Don't append tests at the end to avoid merge conflicts
|
|
# Put them in a random line within the section that fits their approximate run-time
|
|
]
|
|
|
|
# Place EXTENDED_SCRIPTS first since it has the 3 longest running tests
|
|
ALL_SCRIPTS = EXTENDED_SCRIPTS + BASE_SCRIPTS
|
|
|
|
NON_SCRIPTS = [
|
|
# These are python files that live in the functional tests directory, but are not test scripts.
|
|
"combine_logs.py",
|
|
"create_cache.py",
|
|
"test_runner.py",
|
|
]
|
|
|
|
def main():
|
|
# Parse arguments and pass through unrecognised args
|
|
parser = argparse.ArgumentParser(add_help=False,
|
|
usage='%(prog)s [test_runner.py options] [script options] [scripts]',
|
|
description=__doc__,
|
|
epilog='''
|
|
Help text and arguments for individual test script:''',
|
|
formatter_class=argparse.RawTextHelpFormatter)
|
|
parser.add_argument('--ansi', action='store_true', default=sys.stdout.isatty(), help="Use ANSI colors and dots in output (enabled by default when standard output is a TTY)")
|
|
parser.add_argument('--combinedlogslen', '-c', type=int, default=0, metavar='n', help='On failure, print a log (of length n lines) to the console, combined from the test framework and all test nodes.')
|
|
parser.add_argument('--coverage', action='store_true', help='generate a basic coverage report for the RPC interface')
|
|
parser.add_argument('--ci', action='store_true', help='Run checks and code that are usually only enabled in a continuous integration environment')
|
|
parser.add_argument('--exclude', '-x', help='specify a comma-separated-list of scripts to exclude.')
|
|
parser.add_argument('--extended', action='store_true', help='run the extended test suite in addition to the basic tests')
|
|
parser.add_argument('--help', '-h', '-?', action='store_true', help='print help text and exit')
|
|
parser.add_argument('--jobs', '-j', type=int, default=4, help='how many test scripts to run in parallel. Default=4.')
|
|
parser.add_argument('--keepcache', '-k', action='store_true', help='the default behavior is to flush the cache directory on startup. --keepcache retains the cache from the previous testrun.')
|
|
parser.add_argument('--quiet', '-q', action='store_true', help='only print dots, results summary and failure logs')
|
|
parser.add_argument('--tmpdirprefix', '-t', default=tempfile.gettempdir(), help="Root directory for datadirs")
|
|
parser.add_argument('--failfast', '-F', action='store_true', help='stop execution after the first test failure')
|
|
parser.add_argument('--filter', help='filter scripts to run by regular expression')
|
|
|
|
args, unknown_args = parser.parse_known_args()
|
|
if not args.ansi:
|
|
global DEFAULT, BOLD, GREEN, RED
|
|
DEFAULT = ("", "")
|
|
BOLD = ("", "")
|
|
GREEN = ("", "")
|
|
RED = ("", "")
|
|
|
|
# args to be passed on always start with two dashes; tests are the remaining unknown args
|
|
tests = [arg for arg in unknown_args if arg[:2] != "--"]
|
|
passon_args = [arg for arg in unknown_args if arg[:2] == "--"]
|
|
|
|
# Read config generated by configure.
|
|
config = configparser.ConfigParser()
|
|
configfile = os.path.abspath(os.path.dirname(__file__)) + "/../config.ini"
|
|
config.read_file(open(configfile, encoding="utf8"))
|
|
|
|
passon_args.append("--configfile=%s" % configfile)
|
|
|
|
# Set up logging
|
|
logging_level = logging.INFO if args.quiet else logging.DEBUG
|
|
logging.basicConfig(format='%(message)s', level=logging_level)
|
|
|
|
# Create base test directory
|
|
tmpdir = "%s/test_runner_₿_🏃_%s" % (args.tmpdirprefix, datetime.datetime.now().strftime("%Y%m%d_%H%M%S"))
|
|
|
|
os.makedirs(tmpdir)
|
|
|
|
logging.debug("Temporary test directory at %s" % tmpdir)
|
|
|
|
enable_bitcoind = config["components"].getboolean("ENABLE_BITCOIND")
|
|
|
|
if not enable_bitcoind:
|
|
print("No functional tests to run.")
|
|
print("Rerun ./configure with --with-daemon and then make")
|
|
sys.exit(0)
|
|
|
|
# Build list of tests
|
|
test_list = []
|
|
if tests:
|
|
# Individual tests have been specified. Run specified tests that exist
|
|
# in the ALL_SCRIPTS list. Accept names with or without a .py extension.
|
|
# Specified tests can contain wildcards, but in that case the supplied
|
|
# paths should be coherent, e.g. the same path as that provided to call
|
|
# test_runner.py. Examples:
|
|
# `test/functional/test_runner.py test/functional/wallet*`
|
|
# `test/functional/test_runner.py ./test/functional/wallet*`
|
|
# `test_runner.py wallet*`
|
|
# but not:
|
|
# `test/functional/test_runner.py wallet*`
|
|
# Multiple wildcards can be passed:
|
|
# `test_runner.py tool* mempool*`
|
|
for test in tests:
|
|
script = test.split("/")[-1]
|
|
script = script + ".py" if ".py" not in script else script
|
|
matching_scripts = [s for s in ALL_SCRIPTS if s.startswith(script)]
|
|
if matching_scripts:
|
|
test_list.extend(matching_scripts)
|
|
else:
|
|
print("{}WARNING!{} Test '{}' not found in full test list.".format(BOLD[1], BOLD[0], test))
|
|
elif args.extended:
|
|
# Include extended tests
|
|
test_list += ALL_SCRIPTS
|
|
else:
|
|
# Run base tests only
|
|
test_list += BASE_SCRIPTS
|
|
|
|
# Remove the test cases that the user has explicitly asked to exclude.
|
|
if args.exclude:
|
|
exclude_tests = [test.split('.py')[0] for test in args.exclude.split(',')]
|
|
for exclude_test in exclude_tests:
|
|
# Remove <test_name>.py and <test_name>.py --arg from the test list
|
|
exclude_list = [test for test in test_list if test.split('.py')[0] == exclude_test]
|
|
for exclude_item in exclude_list:
|
|
test_list.remove(exclude_item)
|
|
if not exclude_list:
|
|
print("{}WARNING!{} Test '{}' not found in current test list.".format(BOLD[1], BOLD[0], exclude_test))
|
|
|
|
if args.filter:
|
|
test_list = list(filter(re.compile(args.filter).search, test_list))
|
|
|
|
if not test_list:
|
|
print("No valid test scripts specified. Check that your test is in one "
|
|
"of the test lists in test_runner.py, or run test_runner.py with no arguments to run all tests")
|
|
sys.exit(0)
|
|
|
|
if args.help:
|
|
# Print help for test_runner.py, then print help of the first script (with args removed) and exit.
|
|
parser.print_help()
|
|
subprocess.check_call([sys.executable, os.path.join(config["environment"]["SRCDIR"], 'test', 'functional', test_list[0].split()[0]), '-h'])
|
|
sys.exit(0)
|
|
|
|
check_script_list(src_dir=config["environment"]["SRCDIR"], fail_on_warn=args.ci)
|
|
check_script_prefixes()
|
|
|
|
if not args.keepcache:
|
|
shutil.rmtree("%s/test/cache" % config["environment"]["BUILDDIR"], ignore_errors=True)
|
|
|
|
run_tests(
|
|
test_list=test_list,
|
|
src_dir=config["environment"]["SRCDIR"],
|
|
build_dir=config["environment"]["BUILDDIR"],
|
|
tmpdir=tmpdir,
|
|
jobs=args.jobs,
|
|
enable_coverage=args.coverage,
|
|
args=passon_args,
|
|
combined_logs_len=args.combinedlogslen,
|
|
failfast=args.failfast,
|
|
use_term_control=args.ansi,
|
|
)
|
|
|
|
def run_tests(*, test_list, src_dir, build_dir, tmpdir, jobs=1, enable_coverage=False, args=None, combined_logs_len=0, failfast=False, use_term_control):
|
|
args = args or []
|
|
|
|
# Warn if bitcoind is already running
|
|
try:
|
|
# pgrep exits with code zero when one or more matching processes found
|
|
if subprocess.run(["pgrep", "-x", "bitcoind"], stdout=subprocess.DEVNULL).returncode == 0:
|
|
print("%sWARNING!%s There is already a bitcoind process running on this system. Tests may fail unexpectedly due to resource contention!" % (BOLD[1], BOLD[0]))
|
|
except OSError:
|
|
# pgrep not supported
|
|
pass
|
|
|
|
# Warn if there is a cache directory
|
|
cache_dir = "%s/test/cache" % build_dir
|
|
if os.path.isdir(cache_dir):
|
|
print("%sWARNING!%s There is a cache directory here: %s. If tests fail unexpectedly, try deleting the cache directory." % (BOLD[1], BOLD[0], cache_dir))
|
|
|
|
# Test Framework Tests
|
|
print("Running Unit Tests for Test Framework Modules")
|
|
|
|
tests_dir = src_dir + '/test/functional/'
|
|
# This allows `test_runner.py` to work from an out-of-source build directory using a symlink,
|
|
# a hard link or a copy on any platform. See https://github.com/bitcoin/bitcoin/pull/27561.
|
|
sys.path.append(tests_dir)
|
|
|
|
test_framework_tests = unittest.TestSuite()
|
|
for module in TEST_FRAMEWORK_MODULES:
|
|
test_framework_tests.addTest(unittest.TestLoader().loadTestsFromName("test_framework.{}".format(module)))
|
|
result = unittest.TextTestRunner(verbosity=1, failfast=True).run(test_framework_tests)
|
|
if not result.wasSuccessful():
|
|
logging.debug("Early exiting after failure in TestFramework unit tests")
|
|
sys.exit(False)
|
|
|
|
flags = ['--cachedir={}'.format(cache_dir)] + args
|
|
|
|
if enable_coverage:
|
|
coverage = RPCCoverage()
|
|
flags.append(coverage.flag)
|
|
logging.debug("Initializing coverage directory at %s" % coverage.dir)
|
|
else:
|
|
coverage = None
|
|
|
|
if len(test_list) > 1 and jobs > 1:
|
|
# Populate cache
|
|
try:
|
|
subprocess.check_output([sys.executable, tests_dir + 'create_cache.py'] + flags + ["--tmpdir=%s/cache" % tmpdir])
|
|
except subprocess.CalledProcessError as e:
|
|
sys.stdout.buffer.write(e.output)
|
|
raise
|
|
|
|
#Run Tests
|
|
job_queue = TestHandler(
|
|
num_tests_parallel=jobs,
|
|
tests_dir=tests_dir,
|
|
tmpdir=tmpdir,
|
|
test_list=test_list,
|
|
flags=flags,
|
|
use_term_control=use_term_control,
|
|
)
|
|
start_time = time.time()
|
|
test_results = []
|
|
|
|
max_len_name = len(max(test_list, key=len))
|
|
test_count = len(test_list)
|
|
all_passed = True
|
|
i = 0
|
|
while i < test_count:
|
|
if failfast and not all_passed:
|
|
break
|
|
for test_result, testdir, stdout, stderr, skip_reason in job_queue.get_next():
|
|
test_results.append(test_result)
|
|
i += 1
|
|
done_str = "{}/{} - {}{}{}".format(i, test_count, BOLD[1], test_result.name, BOLD[0])
|
|
if test_result.status == "Passed":
|
|
logging.debug("%s passed, Duration: %s s" % (done_str, test_result.time))
|
|
elif test_result.status == "Skipped":
|
|
logging.debug(f"{done_str} skipped ({skip_reason})")
|
|
else:
|
|
all_passed = False
|
|
print("%s failed, Duration: %s s\n" % (done_str, test_result.time))
|
|
print(BOLD[1] + 'stdout:\n' + BOLD[0] + stdout + '\n')
|
|
print(BOLD[1] + 'stderr:\n' + BOLD[0] + stderr + '\n')
|
|
if combined_logs_len and os.path.isdir(testdir):
|
|
# Print the final `combinedlogslen` lines of the combined logs
|
|
print('{}Combine the logs and print the last {} lines ...{}'.format(BOLD[1], combined_logs_len, BOLD[0]))
|
|
print('\n============')
|
|
print('{}Combined log for {}:{}'.format(BOLD[1], testdir, BOLD[0]))
|
|
print('============\n')
|
|
combined_logs_args = [sys.executable, os.path.join(tests_dir, 'combine_logs.py'), testdir]
|
|
if BOLD[0]:
|
|
combined_logs_args += ['--color']
|
|
combined_logs, _ = subprocess.Popen(combined_logs_args, text=True, stdout=subprocess.PIPE).communicate()
|
|
print("\n".join(deque(combined_logs.splitlines(), combined_logs_len)))
|
|
|
|
if failfast:
|
|
logging.debug("Early exiting after test failure")
|
|
break
|
|
|
|
print_results(test_results, max_len_name, (int(time.time() - start_time)))
|
|
|
|
if coverage:
|
|
coverage_passed = coverage.report_rpc_coverage()
|
|
|
|
logging.debug("Cleaning up coverage data")
|
|
coverage.cleanup()
|
|
else:
|
|
coverage_passed = True
|
|
|
|
# Clear up the temp directory if all subdirectories are gone
|
|
if not os.listdir(tmpdir):
|
|
os.rmdir(tmpdir)
|
|
|
|
all_passed = all_passed and coverage_passed
|
|
|
|
# Clean up dangling processes if any. This may only happen with --failfast option.
|
|
# Killing the process group will also terminate the current process but that is
|
|
# not an issue
|
|
if not os.getenv("CI_FAILFAST_TEST_LEAVE_DANGLING") and len(job_queue.jobs):
|
|
os.killpg(os.getpgid(0), signal.SIGKILL)
|
|
|
|
sys.exit(not all_passed)
|
|
|
|
|
|
def print_results(test_results, max_len_name, runtime):
|
|
results = "\n" + BOLD[1] + "%s | %s | %s\n\n" % ("TEST".ljust(max_len_name), "STATUS ", "DURATION") + BOLD[0]
|
|
|
|
test_results.sort(key=TestResult.sort_key)
|
|
all_passed = True
|
|
time_sum = 0
|
|
|
|
for test_result in test_results:
|
|
all_passed = all_passed and test_result.was_successful
|
|
time_sum += test_result.time
|
|
test_result.padding = max_len_name
|
|
results += str(test_result)
|
|
|
|
status = TICK + "Passed" if all_passed else CROSS + "Failed"
|
|
if not all_passed:
|
|
results += RED[1]
|
|
results += BOLD[1] + "\n%s | %s | %s s (accumulated) \n" % ("ALL".ljust(max_len_name), status.ljust(9), time_sum) + BOLD[0]
|
|
if not all_passed:
|
|
results += RED[0]
|
|
results += "Runtime: %s s\n" % (runtime)
|
|
print(results)
|
|
|
|
class TestHandler:
|
|
"""
|
|
Trigger the test scripts passed in via the list.
|
|
"""
|
|
|
|
def __init__(self, *, num_tests_parallel, tests_dir, tmpdir, test_list, flags, use_term_control):
|
|
assert num_tests_parallel >= 1
|
|
self.num_jobs = num_tests_parallel
|
|
self.tests_dir = tests_dir
|
|
self.tmpdir = tmpdir
|
|
self.test_list = test_list
|
|
self.flags = flags
|
|
self.num_running = 0
|
|
self.jobs = []
|
|
self.use_term_control = use_term_control
|
|
|
|
def get_next(self):
|
|
while self.num_running < self.num_jobs and self.test_list:
|
|
# Add tests
|
|
self.num_running += 1
|
|
test = self.test_list.pop(0)
|
|
portseed = len(self.test_list)
|
|
portseed_arg = ["--portseed={}".format(portseed)]
|
|
log_stdout = tempfile.SpooledTemporaryFile(max_size=2**16)
|
|
log_stderr = tempfile.SpooledTemporaryFile(max_size=2**16)
|
|
test_argv = test.split()
|
|
testdir = "{}/{}_{}".format(self.tmpdir, re.sub(".py$", "", test_argv[0]), portseed)
|
|
tmpdir_arg = ["--tmpdir={}".format(testdir)]
|
|
self.jobs.append((test,
|
|
time.time(),
|
|
subprocess.Popen([sys.executable, self.tests_dir + test_argv[0]] + test_argv[1:] + self.flags + portseed_arg + tmpdir_arg,
|
|
text=True,
|
|
stdout=log_stdout,
|
|
stderr=log_stderr),
|
|
testdir,
|
|
log_stdout,
|
|
log_stderr))
|
|
if not self.jobs:
|
|
raise IndexError('pop from empty list')
|
|
|
|
# Print remaining running jobs when all jobs have been started.
|
|
if not self.test_list:
|
|
print("Remaining jobs: [{}]".format(", ".join(j[0] for j in self.jobs)))
|
|
|
|
dot_count = 0
|
|
while True:
|
|
# Return all procs that have finished, if any. Otherwise sleep until there is one.
|
|
time.sleep(.5)
|
|
ret = []
|
|
for job in self.jobs:
|
|
(name, start_time, proc, testdir, log_out, log_err) = job
|
|
if proc.poll() is not None:
|
|
log_out.seek(0), log_err.seek(0)
|
|
[stdout, stderr] = [log_file.read().decode('utf-8') for log_file in (log_out, log_err)]
|
|
log_out.close(), log_err.close()
|
|
skip_reason = None
|
|
if proc.returncode == TEST_EXIT_PASSED and stderr == "":
|
|
status = "Passed"
|
|
elif proc.returncode == TEST_EXIT_SKIPPED:
|
|
status = "Skipped"
|
|
skip_reason = re.search(r"Test Skipped: (.*)", stdout).group(1)
|
|
else:
|
|
status = "Failed"
|
|
self.num_running -= 1
|
|
self.jobs.remove(job)
|
|
if self.use_term_control:
|
|
clearline = '\r' + (' ' * dot_count) + '\r'
|
|
print(clearline, end='', flush=True)
|
|
dot_count = 0
|
|
ret.append((TestResult(name, status, int(time.time() - start_time)), testdir, stdout, stderr, skip_reason))
|
|
if ret:
|
|
return ret
|
|
if self.use_term_control:
|
|
print('.', end='', flush=True)
|
|
dot_count += 1
|
|
|
|
|
|
class TestResult():
|
|
def __init__(self, name, status, time):
|
|
self.name = name
|
|
self.status = status
|
|
self.time = time
|
|
self.padding = 0
|
|
|
|
def sort_key(self):
|
|
if self.status == "Passed":
|
|
return 0, self.name.lower()
|
|
elif self.status == "Failed":
|
|
return 2, self.name.lower()
|
|
elif self.status == "Skipped":
|
|
return 1, self.name.lower()
|
|
|
|
def __repr__(self):
|
|
if self.status == "Passed":
|
|
color = GREEN
|
|
glyph = TICK
|
|
elif self.status == "Failed":
|
|
color = RED
|
|
glyph = CROSS
|
|
elif self.status == "Skipped":
|
|
color = DEFAULT
|
|
glyph = CIRCLE
|
|
|
|
return color[1] + "%s | %s%s | %s s\n" % (self.name.ljust(self.padding), glyph, self.status.ljust(7), self.time) + color[0]
|
|
|
|
@property
|
|
def was_successful(self):
|
|
return self.status != "Failed"
|
|
|
|
|
|
def check_script_prefixes():
|
|
"""Check that test scripts start with one of the allowed name prefixes."""
|
|
|
|
good_prefixes_re = re.compile("^(example|feature|interface|mempool|mining|p2p|rpc|wallet|tool)_")
|
|
bad_script_names = [script for script in ALL_SCRIPTS if good_prefixes_re.match(script) is None]
|
|
|
|
if bad_script_names:
|
|
print("%sERROR:%s %d tests not meeting naming conventions:" % (BOLD[1], BOLD[0], len(bad_script_names)))
|
|
print(" %s" % ("\n ".join(sorted(bad_script_names))))
|
|
raise AssertionError("Some tests are not following naming convention!")
|
|
|
|
|
|
def check_script_list(*, src_dir, fail_on_warn):
|
|
"""Check scripts directory.
|
|
|
|
Check that there are no scripts in the functional tests directory which are
|
|
not being run by pull-tester.py."""
|
|
script_dir = src_dir + '/test/functional/'
|
|
python_files = set([test_file for test_file in os.listdir(script_dir) if test_file.endswith(".py")])
|
|
missed_tests = list(python_files - set(map(lambda x: x.split()[0], ALL_SCRIPTS + NON_SCRIPTS)))
|
|
if len(missed_tests) != 0:
|
|
print("%sWARNING!%s The following scripts are not being run: %s. Check the test lists in test_runner.py." % (BOLD[1], BOLD[0], str(missed_tests)))
|
|
if fail_on_warn:
|
|
# On CI this warning is an error to prevent merging incomplete commits into master
|
|
sys.exit(1)
|
|
|
|
|
|
class RPCCoverage():
|
|
"""
|
|
Coverage reporting utilities for test_runner.
|
|
|
|
Coverage calculation works by having each test script subprocess write
|
|
coverage files into a particular directory. These files contain the RPC
|
|
commands invoked during testing, as well as a complete listing of RPC
|
|
commands per `bitcoin-cli help` (`rpc_interface.txt`).
|
|
|
|
After all tests complete, the commands run are combined and diff'd against
|
|
the complete list to calculate uncovered RPC commands.
|
|
|
|
See also: test/functional/test_framework/coverage.py
|
|
|
|
"""
|
|
def __init__(self):
|
|
self.dir = tempfile.mkdtemp(prefix="coverage")
|
|
self.flag = '--coveragedir=%s' % self.dir
|
|
|
|
def report_rpc_coverage(self):
|
|
"""
|
|
Print out RPC commands that were unexercised by tests.
|
|
|
|
"""
|
|
uncovered = self._get_uncovered_rpc_commands()
|
|
|
|
if uncovered:
|
|
print("Uncovered RPC commands:")
|
|
print("".join((" - %s\n" % command) for command in sorted(uncovered)))
|
|
return False
|
|
else:
|
|
print("All RPC commands covered.")
|
|
return True
|
|
|
|
def cleanup(self):
|
|
return shutil.rmtree(self.dir)
|
|
|
|
def _get_uncovered_rpc_commands(self):
|
|
"""
|
|
Return a set of currently untested RPC commands.
|
|
|
|
"""
|
|
# This is shared from `test/functional/test_framework/coverage.py`
|
|
reference_filename = 'rpc_interface.txt'
|
|
coverage_file_prefix = 'coverage.'
|
|
|
|
coverage_ref_filename = os.path.join(self.dir, reference_filename)
|
|
coverage_filenames = set()
|
|
all_cmds = set()
|
|
# Consider RPC generate covered, because it is overloaded in
|
|
# test_framework/test_node.py and not seen by the coverage check.
|
|
covered_cmds = set({'generate'})
|
|
|
|
if not os.path.isfile(coverage_ref_filename):
|
|
raise RuntimeError("No coverage reference found")
|
|
|
|
with open(coverage_ref_filename, 'r', encoding="utf8") as coverage_ref_file:
|
|
all_cmds.update([line.strip() for line in coverage_ref_file.readlines()])
|
|
|
|
for root, _, files in os.walk(self.dir):
|
|
for filename in files:
|
|
if filename.startswith(coverage_file_prefix):
|
|
coverage_filenames.add(os.path.join(root, filename))
|
|
|
|
for filename in coverage_filenames:
|
|
with open(filename, 'r', encoding="utf8") as coverage_file:
|
|
covered_cmds.update([line.strip() for line in coverage_file.readlines()])
|
|
|
|
return all_cmds - covered_cmds
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|