( )⚙ D1477 run-tests: mechanism to report exceptions during test execution

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D1477

run-tests: mechanism to report exceptions during test execution
ClosedPublic

Authored by indygreg on Nov 21 2017, 2:53 AM.

Details

Reviewers
yuja
Group Reviewers
hg-reviewers
Commits
rHGbd8875b6473c: run-tests: mechanism to report exceptions during test execution
Summary

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.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

indygreg created this revision.Nov 21 2017, 2:53 AM
yuja accepted this revision.Dec 1 2017, 9:26 PM
This revision is now accepted and ready to land.Dec 1 2017, 9:26 PM
yuja added a comment.Dec 1 2017, 9:30 PM

Queued, thanks.

tests/run-tests.py
2533

Nit: better to use _strpath() here because extra_config_opt is
a list of byte strings on Python 2.

Closed by commit rHGbd8875b6473c: run-tests: mechanism to report exceptions during test execution (authored by indygreg). · Explain WhyDec 1 2017, 10:11 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
M.hgignore (1 line)
AMtests/logexceptions.py (73 lines)
Mtests/run-tests.py (52 lines)

Diff 3717

.hgignore

*.zip *.zip
\#*\# \#*\#
.\#* .\#*
tests/.coverage* tests/.coverage*
tests/.testtimes* tests/.testtimes*
tests/.hypothesis tests/.hypothesis
tests/hypothesis-generated tests/hypothesis-generated
tests/annotated tests/annotated
tests/exceptions
tests/*.err tests/*.err
tests/htmlcov tests/htmlcov
build build
contrib/chg/chg contrib/chg/chg
contrib/hgsh/hgsh contrib/hgsh/hgsh
contrib/vagrant/.vagrant contrib/vagrant/.vagrant
contrib/docker/debian-* contrib/docker/debian-*
contrib/docker/ubuntu-* contrib/docker/ubuntu-*

tests/logexceptions.py

  • This file was added.
# logexceptions.py - Write files containing info about Mercurial exceptions
#
# Copyright 2017 Matt Mackall <mpm@selenic.com>
#
# This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version.
from __future__ import absolute_import
import inspect
import os
import sys
import traceback
import uuid
from mercurial import (
dispatch,
extensions,
)
def handleexception(orig, ui):
res = orig(ui)
if not ui.environ.get(b'HGEXCEPTIONSDIR'):
return res
dest = os.path.join(ui.environ[b'HGEXCEPTIONSDIR'],
str(uuid.uuid4()).encode('ascii'))
exc_type, exc_value, exc_tb = sys.exc_info()
stack = []
tb = exc_tb
while tb:
stack.append(tb)
tb = tb.tb_next
stack.reverse()
hgframe = 'unknown'
hgline = 'unknown'
# Find the first Mercurial frame in the stack.
for tb in stack:
mod = inspect.getmodule(tb)
if not mod.__name__.startswith(('hg', 'mercurial')):
continue
frame = tb.tb_frame
try:
with open(inspect.getsourcefile(tb), 'r') as fh:
hgline = fh.readlines()[frame.f_lineno - 1].strip()
except (IndexError, OSError):
pass
hgframe = '%s:%d' % (frame.f_code.co_filename, frame.f_lineno)
break
primary = traceback.extract_tb(exc_tb)[-1]
primaryframe = '%s:%d' % (primary.filename, primary.lineno)
with open(dest, 'wb') as fh:
parts = [
str(exc_value),
primaryframe,
hgframe,
hgline,
]
fh.write(b'\0'.join(p.encode('utf-8', 'replace') for p in parts))
def extsetup(ui):
extensions.wrapfunction(dispatch, 'handlecommandexception',
handleexception)

tests/run-tests.py

# (You could use any subset of the tests: test-s* happens to match # (You could use any subset of the tests: test-s* happens to match
# enough that it's worth doing parallel runs, few enough that it # enough that it's worth doing parallel runs, few enough that it
# completes fairly quickly, includes both shell and Python scripts, and # completes fairly quickly, includes both shell and Python scripts, and
# includes some scripts that run daemon processes.) # includes some scripts that run daemon processes.)
from __future__ import absolute_import, print_function from __future__ import absolute_import, print_function
import argparse import argparse
import collections
import difflib import difflib
import distutils.version as version import distutils.version as version
import errno import errno
import json import json
import os import os
import random import random
import re import re
import shutil import shutil
harness.add_argument("-v", "--verbose", action="store_true", harness.add_argument("-v", "--verbose", action="store_true",
help="output verbose messages") help="output verbose messages")
hgconf = parser.add_argument_group('Mercurial Configuration') hgconf = parser.add_argument_group('Mercurial Configuration')
hgconf.add_argument("--chg", action="store_true", hgconf.add_argument("--chg", action="store_true",
help="install and use chg wrapper in place of hg") help="install and use chg wrapper in place of hg")
hgconf.add_argument("--compiler", hgconf.add_argument("--compiler",
help="compiler to build with") 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') help='set the given config opt in the test hgrc')
hgconf.add_argument("-l", "--local", action="store_true", hgconf.add_argument("-l", "--local", action="store_true",
help="shortcut for --with-hg=<testdir>/../hg, " help="shortcut for --with-hg=<testdir>/../hg, "
"and --with-chg=<testdir>/../contrib/chg/chg if --chg is set") "and --with-chg=<testdir>/../contrib/chg/chg if --chg is set")
hgconf.add_argument("--ipv6", action="store_true", hgconf.add_argument("--ipv6", action="store_true",
help="prefer IPv6 to IPv4 for network related tests") help="prefer IPv6 to IPv4 for network related tests")
hgconf.add_argument("--pure", action="store_true", hgconf.add_argument("--pure", action="store_true",
help="use pure Python code instead of C extensions") help="use pure Python code instead of C extensions")
reporting = parser.add_argument_group('Results Reporting') reporting = parser.add_argument_group('Results Reporting')
reporting.add_argument("-C", "--annotate", action="store_true", reporting.add_argument("-C", "--annotate", action="store_true",
help="output files annotated with coverage") help="output files annotated with coverage")
reporting.add_argument("--color", choices=["always", "auto", "never"], reporting.add_argument("--color", choices=["always", "auto", "never"],
default=os.environ.get('HGRUNTESTSCOLOR', 'auto'), default=os.environ.get('HGRUNTESTSCOLOR', 'auto'),
help="colorisation: always|auto|never (default: auto)") help="colorisation: always|auto|never (default: auto)")
reporting.add_argument("-c", "--cover", action="store_true", reporting.add_argument("-c", "--cover", action="store_true",
help="print a test coverage report") 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", reporting.add_argument("-H", "--htmlcov", action="store_true",
help="create an HTML report of the coverage of the files") help="create an HTML report of the coverage of the files")
reporting.add_argument("--json", action="store_true", reporting.add_argument("--json", action="store_true",
help="store test result data in 'report.json' file") help="store test result data in 'report.json' file")
reporting.add_argument("--outputdir", reporting.add_argument("--outputdir",
help="directory to write error logs to (default=test directory)") help="directory to write error logs to (default=test directory)")
reporting.add_argument("-n", "--nodiff", action="store_true", reporting.add_argument("-n", "--nodiff", action="store_true",
help="skip showing test changes") help="skip showing test changes")
self.stream.writeln( self.stream.writeln(
'# Ran %d tests, %d skipped, %d failed.' '# Ran %d tests, %d skipped, %d failed.'
% (result.testsRun, skipped + ignored, failed)) % (result.testsRun, skipped + ignored, failed))
if failed: if failed:
self.stream.writeln('python hash seed: %s' % self.stream.writeln('python hash seed: %s' %
os.environ['PYTHONHASHSEED']) os.environ['PYTHONHASHSEED'])
if self._runner.options.time: if self._runner.options.time:
self.printtimes(result.times) 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() self.stream.flush()
return result return result
def _bisecttests(self, tests): def _bisecttests(self, tests):
bisectcmd = ['hg', 'bisect'] bisectcmd = ['hg', 'bisect']
bisectrepo = self._runner.options.bisect_repo bisectrepo = self._runner.options.bisect_repo
if bisectrepo: if bisectrepo:
if self.options.allow_slow_tests: if self.options.allow_slow_tests:
os.environ["HGTEST_SLOW"] = "slow" os.environ["HGTEST_SLOW"] = "slow"
elif 'HGTEST_SLOW' in os.environ: elif 'HGTEST_SLOW' in os.environ:
del os.environ['HGTEST_SLOW'] del os.environ['HGTEST_SLOW']
self._coveragefile = os.path.join(self._testdir, b'.coverage') 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'))
yujaUnsubmitted
Not Done

Nit: better to use _strpath() here because extra_config_opt is
a list of byte strings on Python 2.

yuja: Nit: better to use `_strpath()` here because extra_config_opt is a list of byte strings on…
vlog("# Using TESTDIR", self._testdir) vlog("# Using TESTDIR", self._testdir)
vlog("# Using RUNTESTDIR", osenvironb[b'RUNTESTDIR']) vlog("# Using RUNTESTDIR", osenvironb[b'RUNTESTDIR'])
vlog("# Using HGTMP", self._hgtmp) vlog("# Using HGTMP", self._hgtmp)
vlog("# Using PATH", os.environ["PATH"]) vlog("# Using PATH", os.environ["PATH"])
vlog("# Using", IMPL_PATH, osenvironb[IMPL_PATH]) vlog("# Using", IMPL_PATH, osenvironb[IMPL_PATH])
vlog("# Writing to directory", self._outputdir) vlog("# Writing to directory", self._outputdir)
try: try:
p += '.exe' p += '.exe'
found = self._findprogram(p) found = self._findprogram(p)
if found: if found:
vlog("# Found prerequisite", p, "at", found) vlog("# Found prerequisite", p, "at", found)
else: else:
print("WARNING: Did not find prerequisite tool: %s " % print("WARNING: Did not find prerequisite tool: %s " %
p.decode("utf-8")) 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__': if __name__ == '__main__':
runner = TestRunner() runner = TestRunner()
try: try:
import msvcrt import msvcrt
msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY) msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY)
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY) msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
msvcrt.setmode(sys.stderr.fileno(), os.O_BINARY) msvcrt.setmode(sys.stderr.fileno(), os.O_BINARY)
except ImportError: except ImportError:
pass pass
sys.exit(runner.run(sys.argv[1:])) sys.exit(runner.run(sys.argv[1:]))