47ca06ab33
* Implement dip3 integration tests This tests the full upgrade path from legacy MNs to deterministic MNs * Invoke UpdatedBlockTip signal when invalidateblock RPC is called Currently, UpdatedBlockTip would only be called if the invalidation resulted in another chain becoming the longest one. This is inconsistent behavior and was spotted when running dip3 integration tests.
386 lines
13 KiB
Python
Executable File
386 lines
13 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
# Copyright (c) 2014-2016 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, other
|
|
than:
|
|
|
|
- `-extended`: run the "extended" test suite in addition to the basic one.
|
|
- `-win`: signal that this is running in a Windows environment, and we
|
|
should run the tests.
|
|
- `--coverage`: this generates a basic coverage report for the RPC
|
|
interface.
|
|
|
|
For a description of arguments recognized by test scripts, see
|
|
`qa/pull-tester/test_framework/test_framework.py:BitcoinTestFramework.main`.
|
|
|
|
"""
|
|
|
|
import os
|
|
import time
|
|
import shutil
|
|
import sys
|
|
import subprocess
|
|
import tempfile
|
|
import re
|
|
|
|
sys.path.append("qa/pull-tester/")
|
|
from tests_config import *
|
|
|
|
BOLD = ("","")
|
|
if os.name == 'posix':
|
|
# primitive formatting on supported
|
|
# terminal via ANSI escape sequences:
|
|
BOLD = ('\033[0m', '\033[1m')
|
|
|
|
RPC_TESTS_DIR = SRCDIR + '/qa/rpc-tests/'
|
|
|
|
#If imported values are not defined then set to zero (or disabled)
|
|
if 'ENABLE_WALLET' not in vars():
|
|
ENABLE_WALLET=0
|
|
if 'ENABLE_BITCOIND' not in vars():
|
|
ENABLE_BITCOIND=0
|
|
if 'ENABLE_UTILS' not in vars():
|
|
ENABLE_UTILS=0
|
|
if 'ENABLE_ZMQ' not in vars():
|
|
ENABLE_ZMQ=0
|
|
|
|
# python-zmq may not be installed. Handle this gracefully and with some helpful info
|
|
if ENABLE_ZMQ:
|
|
try:
|
|
import zmq
|
|
except ImportError:
|
|
print("WARNING: \"import zmq\" failed. Setting ENABLE_ZMQ=0. " \
|
|
"To run zmq tests, see dependency info in /qa/README.md.")
|
|
ENABLE_ZMQ=0
|
|
|
|
ENABLE_COVERAGE=0
|
|
|
|
#Create a set to store arguments and create the passon string
|
|
opts = set()
|
|
passon_args = []
|
|
PASSON_REGEX = re.compile("^--")
|
|
PARALLEL_REGEX = re.compile('^-parallel=')
|
|
|
|
print_help = False
|
|
run_parallel = 4
|
|
|
|
for arg in sys.argv[1:]:
|
|
if arg == "--help" or arg == "-h" or arg == "-?":
|
|
print_help = True
|
|
break
|
|
if arg == '--coverage':
|
|
ENABLE_COVERAGE = 1
|
|
elif PASSON_REGEX.match(arg):
|
|
passon_args.append(arg)
|
|
elif PARALLEL_REGEX.match(arg):
|
|
run_parallel = int(arg.split(sep='=', maxsplit=1)[1])
|
|
else:
|
|
opts.add(arg)
|
|
|
|
#Set env vars
|
|
if "DASHD" not in os.environ:
|
|
os.environ["DASHD"] = BUILDDIR + '/src/dashd' + EXEEXT
|
|
|
|
if EXEEXT == ".exe" and "-win" not in opts:
|
|
# https://github.com/bitcoin/bitcoin/commit/d52802551752140cf41f0d9a225a43e84404d3e9
|
|
# https://github.com/bitcoin/bitcoin/pull/5677#issuecomment-136646964
|
|
print("Win tests currently disabled by default. Use -win option to enable")
|
|
sys.exit(0)
|
|
|
|
if not (ENABLE_WALLET == 1 and ENABLE_UTILS == 1 and ENABLE_BITCOIND == 1):
|
|
print("No rpc tests to run. Wallet, utils, and bitcoind must all be enabled")
|
|
sys.exit(0)
|
|
|
|
# python3-zmq may not be installed. Handle this gracefully and with some helpful info
|
|
if ENABLE_ZMQ:
|
|
try:
|
|
import zmq
|
|
except ImportError:
|
|
print("ERROR: \"import zmq\" failed. Set ENABLE_ZMQ=0 or "
|
|
"to run zmq tests, see dependency info in /qa/README.md.")
|
|
# ENABLE_ZMQ=0
|
|
raise
|
|
|
|
testScripts = [
|
|
# longest test should go first, to favor running tests in parallel
|
|
'dip3-deterministicmns.py', # NOTE: needs dash_hash to pass
|
|
'wallet-hd.py',
|
|
'walletbackup.py',
|
|
# vv Tests less than 5m vv
|
|
'p2p-fullblocktest.py', # NOTE: needs dash_hash to pass
|
|
'fundrawtransaction.py',
|
|
'fundrawtransaction-hd.py',
|
|
# vv Tests less than 2m vv
|
|
'p2p-instantsend.py',
|
|
'wallet.py',
|
|
'wallet-accounts.py',
|
|
'wallet-dump.py',
|
|
'listtransactions.py',
|
|
# vv Tests less than 60s vv
|
|
'sendheaders.py', # NOTE: needs dash_hash to pass
|
|
'zapwallettxes.py',
|
|
'importmulti.py',
|
|
'mempool_limit.py',
|
|
'merkle_blocks.py',
|
|
'receivedby.py',
|
|
'abandonconflict.py',
|
|
'bip68-112-113-p2p.py',
|
|
'rawtransactions.py',
|
|
'reindex.py',
|
|
# vv Tests less than 30s vv
|
|
'mempool_resurrect_test.py',
|
|
'txn_doublespend.py --mineblock',
|
|
'txn_clone.py',
|
|
'getchaintips.py',
|
|
'rest.py',
|
|
'mempool_spendcoinbase.py',
|
|
'mempool_reorg.py',
|
|
'httpbasics.py',
|
|
'multi_rpc.py',
|
|
'proxy_test.py',
|
|
'signrawtransactions.py',
|
|
'nodehandling.py',
|
|
'addressindex.py',
|
|
'timestampindex.py',
|
|
'spentindex.py',
|
|
'decodescript.py',
|
|
'blockchain.py',
|
|
'disablewallet.py',
|
|
'keypool.py',
|
|
'keypool-hd.py',
|
|
'p2p-mempool.py',
|
|
'prioritise_transaction.py',
|
|
'invalidblockrequest.py', # NOTE: needs dash_hash to pass
|
|
'invalidtxrequest.py', # NOTE: needs dash_hash to pass
|
|
'p2p-versionbits-warning.py',
|
|
'preciousblock.py',
|
|
'importprunedfunds.py',
|
|
'signmessages.py',
|
|
'nulldummy.py',
|
|
'import-rescan.py',
|
|
'rpcnamedargs.py',
|
|
'listsinceblock.py',
|
|
'p2p-leaktests.py',
|
|
'p2p-compactblocks.py',
|
|
'sporks.py',
|
|
]
|
|
if ENABLE_ZMQ:
|
|
testScripts.append('zmq_test.py')
|
|
|
|
testScriptsExt = [
|
|
# 'pruning.py', # Prune mode is incompatible with -txindex.
|
|
# vv Tests less than 20m vv
|
|
'smartfees.py',
|
|
# vv Tests less than 5m vv
|
|
'maxuploadtarget.py',
|
|
'mempool_packages.py',
|
|
# vv Tests less than 2m vv
|
|
'bip68-sequence.py',
|
|
'getblocktemplate_longpoll.py', # FIXME: "socket.error: [Errno 54] Connection reset by peer" on my Mac, same as https://github.com/bitcoin/bitcoin/issues/6651
|
|
'p2p-timeouts.py',
|
|
# vv Tests less than 60s vv
|
|
'bip9-softforks.py',
|
|
'rpcbind_test.py',
|
|
# vv Tests less than 30s vv
|
|
'bip65-cltv.py',
|
|
'bip65-cltv-p2p.py', # NOTE: needs dash_hash to pass
|
|
'bipdersig-p2p.py', # NOTE: needs dash_hash to pass
|
|
'bipdersig.py',
|
|
'getblocktemplate_proposals.py',
|
|
'txn_doublespend.py',
|
|
'txn_clone.py --mineblock',
|
|
'forknotify.py',
|
|
'invalidateblock.py',
|
|
'maxblocksinflight.py',
|
|
'p2p-acceptblock.py', # NOTE: needs dash_hash to pass
|
|
# 'replace-by-fee.py', # RBF is disabled in Dash Core
|
|
]
|
|
|
|
|
|
def runtests():
|
|
test_list = []
|
|
if '-extended' in opts:
|
|
test_list = testScripts + testScriptsExt
|
|
elif len(opts) == 0 or (len(opts) == 1 and "-win" in opts):
|
|
test_list = testScripts
|
|
else:
|
|
for t in testScripts + testScriptsExt:
|
|
if t in opts or re.sub(".py$", "", t) in opts:
|
|
test_list.append(t)
|
|
|
|
if print_help:
|
|
# Only print help of the first script and exit
|
|
subprocess.check_call((RPC_TESTS_DIR + test_list[0]).split() + ['-h'])
|
|
sys.exit(0)
|
|
|
|
coverage = None
|
|
|
|
if ENABLE_COVERAGE:
|
|
coverage = RPCCoverage()
|
|
print("Initializing coverage directory at %s\n" % coverage.dir)
|
|
flags = ["--srcdir=%s/src" % BUILDDIR] + passon_args
|
|
flags.append("--cachedir=%s/qa/cache" % BUILDDIR)
|
|
if coverage:
|
|
flags.append(coverage.flag)
|
|
|
|
if len(test_list) > 1 and run_parallel > 1:
|
|
# Populate cache
|
|
subprocess.check_output([RPC_TESTS_DIR + 'create_cache.py'] + flags)
|
|
|
|
#Run Tests
|
|
max_len_name = len(max(test_list, key=len))
|
|
time_sum = 0
|
|
time0 = time.time()
|
|
job_queue = RPCTestHandler(run_parallel, test_list, flags)
|
|
results = BOLD[1] + "%s | %s | %s\n\n" % ("TEST".ljust(max_len_name), "PASSED", "DURATION") + BOLD[0]
|
|
all_passed = True
|
|
for _ in range(len(test_list)):
|
|
(name, stdout, stderr, passed, duration) = job_queue.get_next()
|
|
all_passed = all_passed and passed
|
|
time_sum += duration
|
|
|
|
print('\n' + BOLD[1] + name + BOLD[0] + ":")
|
|
print('' if passed else stdout + '\n', end='')
|
|
print('' if stderr == '' else 'stderr:\n' + stderr + '\n', end='')
|
|
results += "%s | %s | %s s\n" % (name.ljust(max_len_name), str(passed).ljust(6), duration)
|
|
print("Pass: %s%s%s, Duration: %s s\n" % (BOLD[1], passed, BOLD[0], duration))
|
|
results += BOLD[1] + "\n%s | %s | %s s (accumulated)" % ("ALL".ljust(max_len_name), str(all_passed).ljust(6), time_sum) + BOLD[0]
|
|
print(results)
|
|
print("\nRuntime: %s s" % (int(time.time() - time0)))
|
|
|
|
if coverage:
|
|
coverage.report_rpc_coverage()
|
|
|
|
print("Cleaning up coverage data")
|
|
coverage.cleanup()
|
|
|
|
sys.exit(not all_passed)
|
|
|
|
|
|
class RPCTestHandler:
|
|
"""
|
|
Trigger the testscrips passed in via the list.
|
|
"""
|
|
|
|
def __init__(self, num_tests_parallel, test_list=None, flags=None):
|
|
assert(num_tests_parallel >= 1)
|
|
self.num_jobs = num_tests_parallel
|
|
self.test_list = test_list
|
|
self.flags = flags
|
|
self.num_running = 0
|
|
# In case there is a graveyard of zombie bitcoinds, we can apply a
|
|
# pseudorandom offset to hopefully jump over them.
|
|
# (625 is PORT_RANGE/MAX_NODES)
|
|
self.portseed_offset = int(time.time() * 1000) % 625
|
|
self.jobs = []
|
|
|
|
def get_next(self):
|
|
while self.num_running < self.num_jobs and self.test_list:
|
|
# Add tests
|
|
self.num_running += 1
|
|
t = self.test_list.pop(0)
|
|
port_seed = ["--portseed={}".format(len(self.test_list) + self.portseed_offset)]
|
|
log_stdout = tempfile.SpooledTemporaryFile(max_size=2**16)
|
|
log_stderr = tempfile.SpooledTemporaryFile(max_size=2**16)
|
|
self.jobs.append((t,
|
|
time.time(),
|
|
subprocess.Popen((RPC_TESTS_DIR + t).split() + self.flags + port_seed,
|
|
universal_newlines=True,
|
|
stdout=log_stdout,
|
|
stderr=log_stderr),
|
|
log_stdout,
|
|
log_stderr))
|
|
if not self.jobs:
|
|
raise IndexError('pop from empty list')
|
|
while True:
|
|
# Return first proc that finishes
|
|
time.sleep(.5)
|
|
for j in self.jobs:
|
|
(name, time0, proc, log_out, log_err) = j
|
|
if proc.poll() is not None:
|
|
log_out.seek(0), log_err.seek(0)
|
|
[stdout, stderr] = [l.read().decode('utf-8') for l in (log_out, log_err)]
|
|
log_out.close(), log_err.close()
|
|
passed = stderr == "" and proc.returncode == 0
|
|
self.num_running -= 1
|
|
self.jobs.remove(j)
|
|
return name, stdout, stderr, passed, int(time.time() - time0)
|
|
print('.', end='', flush=True)
|
|
|
|
|
|
class RPCCoverage(object):
|
|
"""
|
|
Coverage reporting utilities for pull-tester.
|
|
|
|
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: qa/rpc-tests/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" % i) for i in sorted(uncovered)))
|
|
else:
|
|
print("All RPC commands covered.")
|
|
|
|
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 `qa/rpc-tests/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()
|
|
covered_cmds = set()
|
|
|
|
if not os.path.isfile(coverage_ref_filename):
|
|
raise RuntimeError("No coverage reference found")
|
|
|
|
with open(coverage_ref_filename, 'r') as f:
|
|
all_cmds.update([i.strip() for i in f.readlines()])
|
|
|
|
for root, dirs, 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') as f:
|
|
covered_cmds.update([i.strip() for i in f.readlines()])
|
|
|
|
return all_cmds - covered_cmds
|
|
|
|
|
|
if __name__ == '__main__':
|
|
runtests()
|