Você não pode selecionar mais de 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.

test_runner.py 23KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575
  1. #!/usr/bin/env python3
  2. # Copyright (c) 2014-2017 The Bitcoin Core developers
  3. # Distributed under the MIT software license, see the accompanying
  4. # file COPYING or http://www.opensource.org/licenses/mit-license.php.
  5. """Run regression test suite.
  6. This module calls down into individual test cases via subprocess. It will
  7. forward all unrecognized arguments onto the individual test scripts.
  8. Functional tests are disabled on Windows by default. Use --force to run them anyway.
  9. For a description of arguments recognized by test scripts, see
  10. `test/functional/test_framework/test_framework.py:BitcoinTestFramework.main`.
  11. """
  12. import argparse
  13. from collections import deque
  14. import configparser
  15. import datetime
  16. import os
  17. import time
  18. import shutil
  19. import signal
  20. import sys
  21. import subprocess
  22. import tempfile
  23. import re
  24. import logging
  25. # Formatting. Default colors to empty strings.
  26. BOLD, BLUE, RED, GREY = ("", ""), ("", ""), ("", ""), ("", "")
  27. try:
  28. # Make sure python thinks it can write unicode to its stdout
  29. "\u2713".encode("utf_8").decode(sys.stdout.encoding)
  30. TICK = "✓ "
  31. CROSS = "✖ "
  32. CIRCLE = "○ "
  33. except UnicodeDecodeError:
  34. TICK = "P "
  35. CROSS = "x "
  36. CIRCLE = "o "
  37. if os.name == 'posix':
  38. # primitive formatting on supported
  39. # terminal via ANSI escape sequences:
  40. BOLD = ('\033[0m', '\033[1m')
  41. BLUE = ('\033[0m', '\033[0;34m')
  42. RED = ('\033[0m', '\033[0;31m')
  43. GREY = ('\033[0m', '\033[1;30m')
  44. TEST_EXIT_PASSED = 0
  45. TEST_EXIT_SKIPPED = 77
  46. BASE_SCRIPTS= [
  47. # Scripts that are run by the travis build process.
  48. # Longest test should go first, to favor running tests in parallel
  49. 'wallet_hd.py',
  50. 'wallet_backup.py',
  51. # vv Tests less than 5m vv
  52. 'feature_block.py',
  53. 'rpc_fundrawtransaction.py',
  54. 'p2p_compactblocks.py',
  55. 'feature_segwit.py',
  56. # vv Tests less than 2m vv
  57. 'wallet_basic.py',
  58. 'wallet_accounts.py',
  59. 'p2p_segwit.py',
  60. 'wallet_dump.py',
  61. 'rpc_listtransactions.py',
  62. # vv Tests less than 60s vv
  63. 'p2p_sendheaders.py',
  64. 'wallet_zapwallettxes.py',
  65. 'wallet_importmulti.py',
  66. 'mempool_limit.py',
  67. 'rpc_txoutproof.py',
  68. 'wallet_listreceivedby.py',
  69. 'wallet_abandonconflict.py',
  70. 'feature_csv_activation.py',
  71. 'rpc_rawtransaction.py',
  72. 'wallet_address_types.py',
  73. 'feature_reindex.py',
  74. # vv Tests less than 30s vv
  75. 'wallet_keypool_topup.py',
  76. 'interface_zmq.py',
  77. 'interface_bitcoin_cli.py',
  78. 'mempool_resurrect.py',
  79. 'wallet_txn_doublespend.py --mineblock',
  80. 'wallet_txn_clone.py',
  81. 'wallet_txn_clone.py --segwit',
  82. 'rpc_getchaintips.py',
  83. 'interface_rest.py',
  84. 'mempool_spend_coinbase.py',
  85. 'mempool_reorg.py',
  86. 'mempool_persist.py',
  87. 'wallet_multiwallet.py',
  88. 'wallet_multiwallet.py --usecli',
  89. 'interface_http.py',
  90. 'rpc_users.py',
  91. 'feature_proxy.py',
  92. 'rpc_signrawtransaction.py',
  93. 'p2p_disconnect_ban.py',
  94. 'rpc_decodescript.py',
  95. 'rpc_blockchain.py',
  96. 'rpc_deprecated.py',
  97. 'wallet_disable.py',
  98. 'rpc_net.py',
  99. 'wallet_keypool.py',
  100. 'p2p_mempool.py',
  101. 'mining_prioritisetransaction.py',
  102. 'p2p_invalid_block.py',
  103. 'p2p_invalid_tx.py',
  104. 'feature_versionbits_warning.py',
  105. 'rpc_preciousblock.py',
  106. 'wallet_importprunedfunds.py',
  107. 'rpc_signmessage.py',
  108. 'feature_nulldummy.py',
  109. 'wallet_import_rescan.py',
  110. 'mining_basic.py',
  111. 'wallet_bumpfee.py',
  112. 'rpc_named_arguments.py',
  113. 'wallet_listsinceblock.py',
  114. 'p2p_leak.py',
  115. 'wallet_encryption.py',
  116. 'feature_dersig.py',
  117. 'feature_cltv.py',
  118. 'rpc_uptime.py',
  119. 'wallet_resendwallettransactions.py',
  120. 'feature_minchainwork.py',
  121. 'p2p_fingerprint.py',
  122. 'feature_uacomment.py',
  123. 'p2p_unrequested_blocks.py',
  124. 'feature_logging.py',
  125. 'p2p_node_network_limited.py',
  126. 'feature_config_args.py',
  127. 'feature_help.py',
  128. # Don't append tests at the end to avoid merge conflicts
  129. # Put them in a random line within the section that fits their approximate run-time
  130. ]
  131. EXTENDED_SCRIPTS = [
  132. # These tests are not run by the travis build process.
  133. # Longest test should go first, to favor running tests in parallel
  134. 'feature_pruning.py',
  135. # vv Tests less than 20m vv
  136. 'feature_fee_estimation.py',
  137. # vv Tests less than 5m vv
  138. 'feature_maxuploadtarget.py',
  139. 'mempool_packages.py',
  140. 'feature_dbcrash.py',
  141. # vv Tests less than 2m vv
  142. 'feature_bip68_sequence.py',
  143. 'mining_getblocktemplate_longpoll.py',
  144. 'p2p_timeouts.py',
  145. # vv Tests less than 60s vv
  146. 'feature_bip9_softforks.py',
  147. 'p2p_feefilter.py',
  148. 'rpc_bind.py',
  149. # vv Tests less than 30s vv
  150. 'feature_assumevalid.py',
  151. 'example_test.py',
  152. 'wallet_txn_doublespend.py',
  153. 'wallet_txn_clone.py --mineblock',
  154. 'feature_notifications.py',
  155. 'rpc_invalidateblock.py',
  156. 'feature_rbf.py',
  157. ]
  158. # Place EXTENDED_SCRIPTS first since it has the 3 longest running tests
  159. ALL_SCRIPTS = EXTENDED_SCRIPTS + BASE_SCRIPTS
  160. NON_SCRIPTS = [
  161. # These are python files that live in the functional tests directory, but are not test scripts.
  162. "combine_logs.py",
  163. "create_cache.py",
  164. "test_runner.py",
  165. ]
  166. def main():
  167. # Parse arguments and pass through unrecognised args
  168. parser = argparse.ArgumentParser(add_help=False,
  169. usage='%(prog)s [test_runner.py options] [script options] [scripts]',
  170. description=__doc__,
  171. epilog='''
  172. Help text and arguments for individual test script:''',
  173. formatter_class=argparse.RawTextHelpFormatter)
  174. parser.add_argument('--combinedlogslen', '-c', type=int, default=0, help='print a combined log (of length n lines) from all test nodes and test framework to the console on failure.')
  175. parser.add_argument('--coverage', action='store_true', help='generate a basic coverage report for the RPC interface')
  176. parser.add_argument('--exclude', '-x', help='specify a comma-separated-list of scripts to exclude.')
  177. parser.add_argument('--extended', action='store_true', help='run the extended test suite in addition to the basic tests')
  178. parser.add_argument('--force', '-f', action='store_true', help='run tests even on platforms where they are disabled by default (e.g. windows).')
  179. parser.add_argument('--help', '-h', '-?', action='store_true', help='print help text and exit')
  180. parser.add_argument('--jobs', '-j', type=int, default=4, help='how many test scripts to run in parallel. Default=4.')
  181. 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.')
  182. parser.add_argument('--quiet', '-q', action='store_true', help='only print results summary and failure logs')
  183. parser.add_argument('--tmpdirprefix', '-t', default=tempfile.gettempdir(), help="Root directory for datadirs")
  184. args, unknown_args = parser.parse_known_args()
  185. # args to be passed on always start with two dashes; tests are the remaining unknown args
  186. tests = [arg for arg in unknown_args if arg[:2] != "--"]
  187. passon_args = [arg for arg in unknown_args if arg[:2] == "--"]
  188. # Read config generated by configure.
  189. config = configparser.ConfigParser()
  190. configfile = os.path.abspath(os.path.dirname(__file__)) + "/../config.ini"
  191. config.read_file(open(configfile))
  192. passon_args.append("--configfile=%s" % configfile)
  193. # Set up logging
  194. logging_level = logging.INFO if args.quiet else logging.DEBUG
  195. logging.basicConfig(format='%(message)s', level=logging_level)
  196. # Create base test directory
  197. tmpdir = "%s/bitcoin_test_runner_%s" % (args.tmpdirprefix, datetime.datetime.now().strftime("%Y%m%d_%H%M%S"))
  198. os.makedirs(tmpdir)
  199. logging.debug("Temporary test directory at %s" % tmpdir)
  200. enable_wallet = config["components"].getboolean("ENABLE_WALLET")
  201. enable_utils = config["components"].getboolean("ENABLE_UTILS")
  202. enable_bitcoind = config["components"].getboolean("ENABLE_BITCOIND")
  203. if config["environment"]["EXEEXT"] == ".exe" and not args.force:
  204. # https://github.com/bitcoin/bitcoin/commit/d52802551752140cf41f0d9a225a43e84404d3e9
  205. # https://github.com/bitcoin/bitcoin/pull/5677#issuecomment-136646964
  206. print("Tests currently disabled on Windows by default. Use --force option to enable")
  207. sys.exit(0)
  208. if not (enable_wallet and enable_utils and enable_bitcoind):
  209. print("No functional tests to run. Wallet, utils, and bitcoind must all be enabled")
  210. print("Rerun `configure` with -enable-wallet, -with-utils and -with-daemon and rerun make")
  211. sys.exit(0)
  212. # Build list of tests
  213. if tests:
  214. # Individual tests have been specified. Run specified tests that exist
  215. # in the ALL_SCRIPTS list. Accept the name with or without .py extension.
  216. tests = [re.sub("\.py$", "", t) + ".py" for t in tests]
  217. test_list = []
  218. for t in tests:
  219. if t in ALL_SCRIPTS:
  220. test_list.append(t)
  221. else:
  222. print("{}WARNING!{} Test '{}' not found in full test list.".format(BOLD[1], BOLD[0], t))
  223. else:
  224. # No individual tests have been specified.
  225. # Run all base tests, and optionally run extended tests.
  226. test_list = BASE_SCRIPTS
  227. if args.extended:
  228. # place the EXTENDED_SCRIPTS first since the three longest ones
  229. # are there and the list is shorter
  230. test_list = EXTENDED_SCRIPTS + test_list
  231. # Remove the test cases that the user has explicitly asked to exclude.
  232. if args.exclude:
  233. tests_excl = [re.sub("\.py$", "", t) + ".py" for t in args.exclude.split(',')]
  234. for exclude_test in tests_excl:
  235. if exclude_test in test_list:
  236. test_list.remove(exclude_test)
  237. else:
  238. print("{}WARNING!{} Test '{}' not found in current test list.".format(BOLD[1], BOLD[0], exclude_test))
  239. if not test_list:
  240. print("No valid test scripts specified. Check that your test is in one "
  241. "of the test lists in test_runner.py, or run test_runner.py with no arguments to run all tests")
  242. sys.exit(0)
  243. if args.help:
  244. # Print help for test_runner.py, then print help of the first script (with args removed) and exit.
  245. parser.print_help()
  246. subprocess.check_call([(config["environment"]["SRCDIR"] + '/test/functional/' + test_list[0].split()[0])] + ['-h'])
  247. sys.exit(0)
  248. check_script_list(config["environment"]["SRCDIR"])
  249. check_script_prefixes()
  250. if not args.keepcache:
  251. shutil.rmtree("%s/test/cache" % config["environment"]["BUILDDIR"], ignore_errors=True)
  252. run_tests(test_list, config["environment"]["SRCDIR"], config["environment"]["BUILDDIR"], config["environment"]["EXEEXT"], tmpdir, args.jobs, args.coverage, passon_args, args.combinedlogslen)
  253. def run_tests(test_list, src_dir, build_dir, exeext, tmpdir, jobs=1, enable_coverage=False, args=[], combined_logs_len=0):
  254. # Warn if bitcoind is already running (unix only)
  255. try:
  256. if subprocess.check_output(["pidof", "bitcoind"]) is not None:
  257. 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]))
  258. except (OSError, subprocess.SubprocessError):
  259. pass
  260. # Warn if there is a cache directory
  261. cache_dir = "%s/test/cache" % build_dir
  262. if os.path.isdir(cache_dir):
  263. 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))
  264. #Set env vars
  265. if "BITCOIND" not in os.environ:
  266. os.environ["BITCOIND"] = build_dir + '/src/bitcoind' + exeext
  267. os.environ["BITCOINCLI"] = build_dir + '/src/bitcoin-cli' + exeext
  268. tests_dir = src_dir + '/test/functional/'
  269. flags = ["--srcdir={}/src".format(build_dir)] + args
  270. flags.append("--cachedir=%s" % cache_dir)
  271. if enable_coverage:
  272. coverage = RPCCoverage()
  273. flags.append(coverage.flag)
  274. logging.debug("Initializing coverage directory at %s" % coverage.dir)
  275. else:
  276. coverage = None
  277. if len(test_list) > 1 and jobs > 1:
  278. # Populate cache
  279. try:
  280. subprocess.check_output([tests_dir + 'create_cache.py'] + flags + ["--tmpdir=%s/cache" % tmpdir])
  281. except subprocess.CalledProcessError as e:
  282. sys.stdout.buffer.write(e.output)
  283. raise
  284. #Run Tests
  285. job_queue = TestHandler(jobs, tests_dir, tmpdir, test_list, flags)
  286. time0 = time.time()
  287. test_results = []
  288. max_len_name = len(max(test_list, key=len))
  289. for _ in range(len(test_list)):
  290. test_result, testdir, stdout, stderr = job_queue.get_next()
  291. test_results.append(test_result)
  292. if test_result.status == "Passed":
  293. logging.debug("\n%s%s%s passed, Duration: %s s" % (BOLD[1], test_result.name, BOLD[0], test_result.time))
  294. elif test_result.status == "Skipped":
  295. logging.debug("\n%s%s%s skipped" % (BOLD[1], test_result.name, BOLD[0]))
  296. else:
  297. print("\n%s%s%s failed, Duration: %s s\n" % (BOLD[1], test_result.name, BOLD[0], test_result.time))
  298. print(BOLD[1] + 'stdout:\n' + BOLD[0] + stdout + '\n')
  299. print(BOLD[1] + 'stderr:\n' + BOLD[0] + stderr + '\n')
  300. if combined_logs_len and os.path.isdir(testdir):
  301. # Print the final `combinedlogslen` lines of the combined logs
  302. print('{}Combine the logs and print the last {} lines ...{}'.format(BOLD[1], combined_logs_len, BOLD[0]))
  303. print('\n============')
  304. print('{}Combined log for {}:{}'.format(BOLD[1], testdir, BOLD[0]))
  305. print('============\n')
  306. combined_logs, _ = subprocess.Popen([os.path.join(tests_dir, 'combine_logs.py'), '-c', testdir], universal_newlines=True, stdout=subprocess.PIPE).communicate()
  307. print("\n".join(deque(combined_logs.splitlines(), combined_logs_len)))
  308. print_results(test_results, max_len_name, (int(time.time() - time0)))
  309. if coverage:
  310. coverage.report_rpc_coverage()
  311. logging.debug("Cleaning up coverage data")
  312. coverage.cleanup()
  313. # Clear up the temp directory if all subdirectories are gone
  314. if not os.listdir(tmpdir):
  315. os.rmdir(tmpdir)
  316. all_passed = all(map(lambda test_result: test_result.was_successful, test_results))
  317. sys.exit(not all_passed)
  318. def print_results(test_results, max_len_name, runtime):
  319. results = "\n" + BOLD[1] + "%s | %s | %s\n\n" % ("TEST".ljust(max_len_name), "STATUS ", "DURATION") + BOLD[0]
  320. test_results.sort(key=lambda result: result.name.lower())
  321. all_passed = True
  322. time_sum = 0
  323. for test_result in test_results:
  324. all_passed = all_passed and test_result.was_successful
  325. time_sum += test_result.time
  326. test_result.padding = max_len_name
  327. results += str(test_result)
  328. status = TICK + "Passed" if all_passed else CROSS + "Failed"
  329. results += BOLD[1] + "\n%s | %s | %s s (accumulated) \n" % ("ALL".ljust(max_len_name), status.ljust(9), time_sum) + BOLD[0]
  330. results += "Runtime: %s s\n" % (runtime)
  331. print(results)
  332. class TestHandler:
  333. """
  334. Trigger the test scripts passed in via the list.
  335. """
  336. def __init__(self, num_tests_parallel, tests_dir, tmpdir, test_list=None, flags=None):
  337. assert(num_tests_parallel >= 1)
  338. self.num_jobs = num_tests_parallel
  339. self.tests_dir = tests_dir
  340. self.tmpdir = tmpdir
  341. self.test_list = test_list
  342. self.flags = flags
  343. self.num_running = 0
  344. # In case there is a graveyard of zombie bitcoinds, we can apply a
  345. # pseudorandom offset to hopefully jump over them.
  346. # (625 is PORT_RANGE/MAX_NODES)
  347. self.portseed_offset = int(time.time() * 1000) % 625
  348. self.jobs = []
  349. def get_next(self):
  350. while self.num_running < self.num_jobs and self.test_list:
  351. # Add tests
  352. self.num_running += 1
  353. t = self.test_list.pop(0)
  354. portseed = len(self.test_list) + self.portseed_offset
  355. portseed_arg = ["--portseed={}".format(portseed)]
  356. log_stdout = tempfile.SpooledTemporaryFile(max_size=2**16)
  357. log_stderr = tempfile.SpooledTemporaryFile(max_size=2**16)
  358. test_argv = t.split()
  359. testdir = "{}/{}_{}".format(self.tmpdir, re.sub(".py$", "", test_argv[0]), portseed)
  360. tmpdir_arg = ["--tmpdir={}".format(testdir)]
  361. self.jobs.append((t,
  362. time.time(),
  363. subprocess.Popen([self.tests_dir + test_argv[0]] + test_argv[1:] + self.flags + portseed_arg + tmpdir_arg,
  364. universal_newlines=True,
  365. stdout=log_stdout,
  366. stderr=log_stderr),
  367. testdir,
  368. log_stdout,
  369. log_stderr))
  370. if not self.jobs:
  371. raise IndexError('pop from empty list')
  372. while True:
  373. # Return first proc that finishes
  374. time.sleep(.5)
  375. for j in self.jobs:
  376. (name, time0, proc, testdir, log_out, log_err) = j
  377. if os.getenv('TRAVIS') == 'true' and int(time.time() - time0) > 20 * 60:
  378. # In travis, timeout individual tests after 20 minutes (to stop tests hanging and not
  379. # providing useful output.
  380. proc.send_signal(signal.SIGINT)
  381. if proc.poll() is not None:
  382. log_out.seek(0), log_err.seek(0)
  383. [stdout, stderr] = [l.read().decode('utf-8') for l in (log_out, log_err)]
  384. log_out.close(), log_err.close()
  385. if proc.returncode == TEST_EXIT_PASSED and stderr == "":
  386. status = "Passed"
  387. elif proc.returncode == TEST_EXIT_SKIPPED:
  388. status = "Skipped"
  389. else:
  390. status = "Failed"
  391. self.num_running -= 1
  392. self.jobs.remove(j)
  393. return TestResult(name, status, int(time.time() - time0)), testdir, stdout, stderr
  394. print('.', end='', flush=True)
  395. class TestResult():
  396. def __init__(self, name, status, time):
  397. self.name = name
  398. self.status = status
  399. self.time = time
  400. self.padding = 0
  401. def __repr__(self):
  402. if self.status == "Passed":
  403. color = BLUE
  404. glyph = TICK
  405. elif self.status == "Failed":
  406. color = RED
  407. glyph = CROSS
  408. elif self.status == "Skipped":
  409. color = GREY
  410. glyph = CIRCLE
  411. return color[1] + "%s | %s%s | %s s\n" % (self.name.ljust(self.padding), glyph, self.status.ljust(7), self.time) + color[0]
  412. @property
  413. def was_successful(self):
  414. return self.status != "Failed"
  415. def check_script_prefixes():
  416. """Check that at most a handful of the
  417. test scripts don't start with one of the allowed name prefixes."""
  418. # LEEWAY is provided as a transition measure, so that pull-requests
  419. # that introduce new tests that don't conform with the naming
  420. # convention don't immediately cause the tests to fail.
  421. LEEWAY = 10
  422. good_prefixes_re = re.compile("(example|feature|interface|mempool|mining|p2p|rpc|wallet)_")
  423. bad_script_names = [script for script in ALL_SCRIPTS if good_prefixes_re.match(script) is None]
  424. if len(bad_script_names) > 0:
  425. print("INFO: %d tests not meeting naming conventions:" % (len(bad_script_names)))
  426. print(" %s" % ("\n ".join(sorted(bad_script_names))))
  427. assert len(bad_script_names) <= LEEWAY, "Too many tests not following naming convention! (%d found, maximum: %d)" % (len(bad_script_names), LEEWAY)
  428. def check_script_list(src_dir):
  429. """Check scripts directory.
  430. Check that there are no scripts in the functional tests directory which are
  431. not being run by pull-tester.py."""
  432. script_dir = src_dir + '/test/functional/'
  433. python_files = set([t for t in os.listdir(script_dir) if t[-3:] == ".py"])
  434. missed_tests = list(python_files - set(map(lambda x: x.split()[0], ALL_SCRIPTS + NON_SCRIPTS)))
  435. if len(missed_tests) != 0:
  436. 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)))
  437. if os.getenv('TRAVIS') == 'true':
  438. # On travis this warning is an error to prevent merging incomplete commits into master
  439. sys.exit(1)
  440. class RPCCoverage():
  441. """
  442. Coverage reporting utilities for test_runner.
  443. Coverage calculation works by having each test script subprocess write
  444. coverage files into a particular directory. These files contain the RPC
  445. commands invoked during testing, as well as a complete listing of RPC
  446. commands per `bitcoin-cli help` (`rpc_interface.txt`).
  447. After all tests complete, the commands run are combined and diff'd against
  448. the complete list to calculate uncovered RPC commands.
  449. See also: test/functional/test_framework/coverage.py
  450. """
  451. def __init__(self):
  452. self.dir = tempfile.mkdtemp(prefix="coverage")
  453. self.flag = '--coveragedir=%s' % self.dir
  454. def report_rpc_coverage(self):
  455. """
  456. Print out RPC commands that were unexercised by tests.
  457. """
  458. uncovered = self._get_uncovered_rpc_commands()
  459. if uncovered:
  460. print("Uncovered RPC commands:")
  461. print("".join((" - %s\n" % i) for i in sorted(uncovered)))
  462. else:
  463. print("All RPC commands covered.")
  464. def cleanup(self):
  465. return shutil.rmtree(self.dir)
  466. def _get_uncovered_rpc_commands(self):
  467. """
  468. Return a set of currently untested RPC commands.
  469. """
  470. # This is shared from `test/functional/test-framework/coverage.py`
  471. reference_filename = 'rpc_interface.txt'
  472. coverage_file_prefix = 'coverage.'
  473. coverage_ref_filename = os.path.join(self.dir, reference_filename)
  474. coverage_filenames = set()
  475. all_cmds = set()
  476. covered_cmds = set()
  477. if not os.path.isfile(coverage_ref_filename):
  478. raise RuntimeError("No coverage reference found")
  479. with open(coverage_ref_filename, 'r') as f:
  480. all_cmds.update([i.strip() for i in f.readlines()])
  481. for root, dirs, files in os.walk(self.dir):
  482. for filename in files:
  483. if filename.startswith(coverage_file_prefix):
  484. coverage_filenames.add(os.path.join(root, filename))
  485. for filename in coverage_filenames:
  486. with open(filename, 'r') as f:
  487. covered_cmds.update([i.strip() for i in f.readlines()])
  488. return all_cmds - covered_cmds
  489. if __name__ == '__main__':
  490. main()