mercurial-scm/hg: tests/run-tests.py comparison

comparison tests/run-tests.py @ 35190:bd8875b6473c

run-tests: mechanism to report exceptions during test execution Sometimes when running tests you introduce a ton of exceptions. The most extreme example of this is running Mercurial with Python 3, which currently spews thousands of exceptions when running the test harness. This commit adds an opt-in feature to run-tests.py to aggregate exceptions encountered by `hg` when running tests. When --exceptions is used, the test harness enables the "logexceptions" extension in the test environment. This extension wraps the Mercurial function to handle exceptions and writes information about the exception to a random filename in a directory defined by the test harness via an environment variable. At the end of the test harness, these files are parsed, aggregated, and a list of all unique Mercurial frames triggering exceptions is printed in order of frequency. This feature is intended to aid Python 3 development. I've only really tested it on Python 3. There is no shortage of improvements that could be made. e.g. we could write a separate file containing the exception report - maybe even an HTML report. We also don't capture which tests demonstrate the exceptions, so there's no turnkey way to test whether a code change made an exception disappear. Perfect is the enemy of good. I think the current patch is useful enough to land. Whoever uses it can send patches to imprve its usefulness. Differential Revision: https://phab.mercurial-scm.org/D1477

author	Gregory Szorc <gregory.szorc@gmail.com>
date	Mon, 20 Nov 2017 23:02:32 -0800
parents	073843b5e353
children	f12747de13ea

comparison

equal deleted inserted replaced

-:073843b5e353
+:bd8875b6473c
 # includes some scripts that run daemon processes.)
 from __future__ import absolute_import, print_function
 import argparse
+import collections
 import difflib
 import distutils.version as version
 import errno
 import json
 import os
 hgconf = parser.add_argument_group('Mercurial Configuration')
 hgconf.add_argument("--chg", action="store_true",
 help="install and use chg wrapper in place of hg")
 hgconf.add_argument("--compiler",
 help="compiler to build with")
-hgconf.add_argument('--extra-config-opt', action="append",
+hgconf.add_argument('--extra-config-opt', action="append", default=[],
 help='set the given config opt in the test hgrc')
 hgconf.add_argument("-l", "--local", action="store_true",
 help="shortcut for --with-hg=<testdir>/../hg, "
 "and --with-chg=<testdir>/../contrib/chg/chg if --chg is set")
 hgconf.add_argument("--ipv6", action="store_true",
 reporting.add_argument("--color", choices=["always", "auto", "never"],
 default=os.environ.get('HGRUNTESTSCOLOR', 'auto'),
 help="colorisation: always|auto|never (default: auto)")
 reporting.add_argument("-c", "--cover", action="store_true",
 help="print a test coverage report")
+reporting.add_argument('--exceptions', action='store_true',
+help='log all exceptions and generate an exception report')
 reporting.add_argument("-H", "--htmlcov", action="store_true",
 help="create an HTML report of the coverage of the files")
 reporting.add_argument("--json", action="store_true",
 help="store test result data in 'report.json' file")
 reporting.add_argument("--outputdir",
 if failed:
 self.stream.writeln('python hash seed: %s' %
 os.environ['PYTHONHASHSEED'])
 if self._runner.options.time:
 self.printtimes(result.times)
+if self._runner.options.exceptions:
+exceptions = aggregateexceptions(
+os.path.join(self._runner._outputdir, b'exceptions'))
+total = sum(exceptions.values())
+self.stream.writeln('Exceptions Report:')
+self.stream.writeln('%d total from %d frames' %
+(total, len(exceptions)))
+for (frame, line, exc), count in exceptions.most_common():
+self.stream.writeln('%d\t%s: %s' % (count, frame, exc))
 self.stream.flush()
 return result
 def _bisecttests(self, tests):
 elif 'HGTEST_SLOW' in os.environ:
 del os.environ['HGTEST_SLOW']
 self._coveragefile = os.path.join(self._testdir, b'.coverage')
+if self.options.exceptions:
+exceptionsdir = os.path.join(self._outputdir, b'exceptions')
+try:
+os.makedirs(exceptionsdir)
+except OSError as e:
+if e.errno != errno.EEXIST:
+raise
+# Remove all existing exception reports.
+for f in os.listdir(exceptionsdir):
+os.unlink(os.path.join(exceptionsdir, f))
+osenvironb[b'HGEXCEPTIONSDIR'] = exceptionsdir
+logexceptions = os.path.join(self._testdir, b'logexceptions.py')
+self.options.extra_config_opt.append(
+'extensions.logexceptions=%s' % logexceptions.decode('utf-8'))
 vlog("# Using TESTDIR", self._testdir)
 vlog("# Using RUNTESTDIR", osenvironb[b'RUNTESTDIR'])
 vlog("# Using HGTMP", self._hgtmp)
 vlog("# Using PATH", os.environ["PATH"])
 vlog("# Using", IMPL_PATH, osenvironb[IMPL_PATH])
 vlog("# Found prerequisite", p, "at", found)
 else:
 print("WARNING: Did not find prerequisite tool: %s " %
 p.decode("utf-8"))
+def aggregateexceptions(path):
+exceptions = collections.Counter()
+for f in os.listdir(path):
+with open(os.path.join(path, f), 'rb') as fh:
+data = fh.read().split(b'\0')
+if len(data) != 4:
+continue
+exc, mainframe, hgframe, hgline = data
+exc = exc.decode('utf-8')
+mainframe = mainframe.decode('utf-8')
+hgframe = hgframe.decode('utf-8')
+hgline = hgline.decode('utf-8')
+exceptions[(hgframe, hgline, exc)] += 1
+return exceptions
 if __name__ == '__main__':
 runner = TestRunner()
 try:
 import msvcrt

Mercurial > public > mercurial-scm > hg

comparison tests/run-tests.py @ 35190:bd8875b6473c