2ab835ae6c
If ZMQ is enabled, check whether it's installed before running ZMQ tests. If it isn't, disable ZMQ and print a warning. Also add dependency info to test docs, so users know ZMQ is required before running tests, and so they know how to install it. When following the build instructions before this change then trying to run the RPC tests, a unix user would get an error when python tried to import zmq. There may be other dependencies that should be added to the docs, particularly ones for non-unix systems. This is the only unlisted dependency I encountered using linux.
271 lines
8 KiB
Python
Executable file
271 lines
8 KiB
Python
Executable file
#!/usr/bin/env python2
|
|
# Copyright (c) 2014-2015 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
|
|
|
|
from tests_config import *
|
|
|
|
#If imported values are not defined then set to zero (or disabled)
|
|
if not vars().has_key('ENABLE_WALLET'):
|
|
ENABLE_WALLET=0
|
|
if not vars().has_key('ENABLE_BITCOIND'):
|
|
ENABLE_BITCOIND=0
|
|
if not vars().has_key('ENABLE_UTILS'):
|
|
ENABLE_UTILS=0
|
|
if not vars().has_key('ENABLE_ZMQ'):
|
|
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 = ""
|
|
p = re.compile("^--")
|
|
|
|
bold = ("","")
|
|
if (os.name == 'posix'):
|
|
bold = ('\033[0m', '\033[1m')
|
|
|
|
for arg in sys.argv[1:]:
|
|
if arg == '--coverage':
|
|
ENABLE_COVERAGE = 1
|
|
elif (p.match(arg) or arg == "-h"):
|
|
passOn += " " + arg
|
|
else:
|
|
opts.add(arg)
|
|
|
|
#Set env vars
|
|
buildDir = BUILDDIR
|
|
if "BITCOIND" not in os.environ:
|
|
os.environ["BITCOIND"] = buildDir + '/src/bitcoind' + EXEEXT
|
|
if "BITCOINCLI" not in os.environ:
|
|
os.environ["BITCOINCLI"] = buildDir + '/src/bitcoin-cli' + EXEEXT
|
|
|
|
#Disable Windows tests by default
|
|
if EXEEXT == ".exe" and "-win" not in opts:
|
|
print "Win tests currently disabled. Use -win option to enable"
|
|
sys.exit(0)
|
|
|
|
#Tests
|
|
testScripts = [
|
|
'wallet.py',
|
|
'listtransactions.py',
|
|
'receivedby.py',
|
|
'mempool_resurrect_test.py',
|
|
'txn_doublespend.py --mineblock',
|
|
'txn_clone.py',
|
|
'getchaintips.py',
|
|
'rawtransactions.py',
|
|
'rest.py',
|
|
'mempool_spendcoinbase.py',
|
|
'mempool_reorg.py',
|
|
'mempool_limit.py',
|
|
'httpbasics.py',
|
|
'multi_rpc.py',
|
|
'zapwallettxes.py',
|
|
'proxy_test.py',
|
|
'merkle_blocks.py',
|
|
'fundrawtransaction.py',
|
|
'signrawtransactions.py',
|
|
'walletbackup.py',
|
|
'nodehandling.py',
|
|
'reindex.py',
|
|
'decodescript.py',
|
|
'p2p-fullblocktest.py',
|
|
'blockchain.py',
|
|
'disablewallet.py',
|
|
'sendheaders.py',
|
|
'keypool.py',
|
|
'prioritise_transaction.py',
|
|
'invalidblockrequest.py',
|
|
'invalidtxrequest.py',
|
|
'abandonconflict.py',
|
|
]
|
|
testScriptsExt = [
|
|
'bip65-cltv.py',
|
|
'bip65-cltv-p2p.py',
|
|
'bip68-sequence.py',
|
|
'bipdersig-p2p.py',
|
|
'bipdersig.py',
|
|
'getblocktemplate_longpoll.py',
|
|
'getblocktemplate_proposals.py',
|
|
'txn_doublespend.py',
|
|
'txn_clone.py --mineblock',
|
|
'pruning.py',
|
|
'forknotify.py',
|
|
'invalidateblock.py',
|
|
# 'rpcbind_test.py', #temporary, bug in libevent, see #6655
|
|
'smartfees.py',
|
|
'maxblocksinflight.py',
|
|
'p2p-acceptblock.py',
|
|
'mempool_packages.py',
|
|
'maxuploadtarget.py',
|
|
'replace-by-fee.py',
|
|
]
|
|
|
|
#Enable ZMQ tests
|
|
if ENABLE_ZMQ == 1:
|
|
testScripts.append('zmq_test.py')
|
|
|
|
|
|
def runtests():
|
|
coverage = None
|
|
|
|
if ENABLE_COVERAGE:
|
|
coverage = RPCCoverage()
|
|
print("Initializing coverage directory at %s\n" % coverage.dir)
|
|
|
|
if(ENABLE_WALLET == 1 and ENABLE_UTILS == 1 and ENABLE_BITCOIND == 1):
|
|
rpcTestDir = buildDir + '/qa/rpc-tests/'
|
|
run_extended = '-extended' in opts
|
|
cov_flag = coverage.flag if coverage else ''
|
|
flags = " --srcdir %s/src %s %s" % (buildDir, cov_flag, passOn)
|
|
|
|
#Run Tests
|
|
for i in range(len(testScripts)):
|
|
if (len(opts) == 0
|
|
or (len(opts) == 1 and "-win" in opts )
|
|
or run_extended
|
|
or testScripts[i] in opts
|
|
or re.sub(".py$", "", testScripts[i]) in opts ):
|
|
|
|
print("Running testscript %s%s%s ..." % (bold[1], testScripts[i], bold[0]))
|
|
time0 = time.time()
|
|
subprocess.check_call(
|
|
rpcTestDir + testScripts[i] + flags, shell=True)
|
|
print("Duration: %s s\n" % (int(time.time() - time0)))
|
|
|
|
# exit if help is called so we print just one set of
|
|
# instructions
|
|
p = re.compile(" -h| --help")
|
|
if p.match(passOn):
|
|
sys.exit(0)
|
|
|
|
# Run Extended Tests
|
|
for i in range(len(testScriptsExt)):
|
|
if (run_extended or testScriptsExt[i] in opts
|
|
or re.sub(".py$", "", testScriptsExt[i]) in opts):
|
|
|
|
print(
|
|
"Running 2nd level testscript "
|
|
+ "%s%s%s ..." % (bold[1], testScriptsExt[i], bold[0]))
|
|
time0 = time.time()
|
|
subprocess.check_call(
|
|
rpcTestDir + testScriptsExt[i] + flags, shell=True)
|
|
print("Duration: %s s\n" % (int(time.time() - time0)))
|
|
|
|
if coverage:
|
|
coverage.report_rpc_coverage()
|
|
|
|
print("Cleaning up coverage data")
|
|
coverage.cleanup()
|
|
|
|
else:
|
|
print "No rpc tests to run. Wallet, utils, and bitcoind must all be enabled"
|
|
|
|
|
|
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()
|