Mercurial > hg
view tests/run-tests.py @ 21445:092b16448994
run-tests: fail tests by raising an exception
When in unittest mode, Test.run() will now raise for all non-success
cases. This makes it behave like TestCase.run().
| author | Gregory Szorc <gregory.szorc@gmail.com> |
|---|---|
| date | Sun, 20 Apr 2014 14:34:03 -0700 |
| parents | 2b7d364690d8 |
| children | 9a3b4f795f62 |
line wrap: on
line source
#!/usr/bin/env python # # run-tests.py - Run a set of tests on Mercurial # # Copyright 2006 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. # Modifying this script is tricky because it has many modes: # - serial (default) vs parallel (-jN, N > 1) # - no coverage (default) vs coverage (-c, -C, -s) # - temp install (default) vs specific hg script (--with-hg, --local) # - tests are a mix of shell scripts and Python scripts # # If you change this script, it is recommended that you ensure you # haven't broken it by running it in various modes with a representative # sample of test scripts. For example: # # 1) serial, no coverage, temp install: # ./run-tests.py test-s* # 2) serial, no coverage, local hg: # ./run-tests.py --local test-s* # 3) serial, coverage, temp install: # ./run-tests.py -c test-s* # 4) serial, coverage, local hg: # ./run-tests.py -c --local test-s* # unsupported # 5) parallel, no coverage, temp install: # ./run-tests.py -j2 test-s* # 6) parallel, no coverage, local hg: # ./run-tests.py -j2 --local test-s* # 7) parallel, coverage, temp install: # ./run-tests.py -j2 -c test-s* # currently broken # 8) parallel, coverage, local install: # ./run-tests.py -j2 -c --local test-s* # unsupported (and broken) # 9) parallel, custom tmp dir: # ./run-tests.py -j2 --tmpdir /tmp/myhgtests # # (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 # completes fairly quickly, includes both shell and Python scripts, and # includes some scripts that run daemon processes.) from distutils import version import difflib import errno import optparse import os import shutil import subprocess import signal import sys import tempfile import time import random import re import threading import killdaemons as killmod import Queue as queue import unittest processlock = threading.Lock() # subprocess._cleanup can race with any Popen.wait or Popen.poll on py24 # http://bugs.python.org/issue1731717 for details. We shouldn't be producing # zombies but it's pretty harmless even if we do. if sys.version_info < (2, 5): subprocess._cleanup = lambda: None closefds = os.name == 'posix' def Popen4(cmd, wd, timeout, env=None): processlock.acquire() p = subprocess.Popen(cmd, shell=True, bufsize=-1, cwd=wd, env=env, close_fds=closefds, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.STDOUT) processlock.release() p.fromchild = p.stdout p.tochild = p.stdin p.childerr = p.stderr p.timeout = False if timeout: def t(): start = time.time() while time.time() - start < timeout and p.returncode is None: time.sleep(.1) p.timeout = True if p.returncode is None: terminate(p) threading.Thread(target=t).start() return p PYTHON = sys.executable.replace('\\', '/') IMPL_PATH = 'PYTHONPATH' if 'java' in sys.platform: IMPL_PATH = 'JYTHONPATH' TESTDIR = HGTMP = INST = BINDIR = TMPBINDIR = PYTHONDIR = None defaults = { 'jobs': ('HGTEST_JOBS', 1), 'timeout': ('HGTEST_TIMEOUT', 180), 'port': ('HGTEST_PORT', 20059), 'shell': ('HGTEST_SHELL', 'sh'), } def parselistfiles(files, listtype, warn=True): entries = dict() for filename in files: try: path = os.path.expanduser(os.path.expandvars(filename)) f = open(path, "r") except IOError, err: if err.errno != errno.ENOENT: raise if warn: print "warning: no such %s file: %s" % (listtype, filename) continue for line in f.readlines(): line = line.split('#', 1)[0].strip() if line: entries[line] = filename f.close() return entries def getparser(): """Obtain the OptionParser used by the CLI.""" parser = optparse.OptionParser("%prog [options] [tests]") # keep these sorted parser.add_option("--blacklist", action="append", help="skip tests listed in the specified blacklist file") parser.add_option("--whitelist", action="append", help="always run tests listed in the specified whitelist file") parser.add_option("--changed", type="string", help="run tests that are changed in parent rev or working directory") parser.add_option("-C", "--annotate", action="store_true", help="output files annotated with coverage") parser.add_option("-c", "--cover", action="store_true", help="print a test coverage report") parser.add_option("-d", "--debug", action="store_true", help="debug mode: write output of test scripts to console" " rather than capturing and diffing it (disables timeout)") parser.add_option("-f", "--first", action="store_true", help="exit on the first test failure") parser.add_option("-H", "--htmlcov", action="store_true", help="create an HTML report of the coverage of the files") parser.add_option("-i", "--interactive", action="store_true", help="prompt to accept changed output") parser.add_option("-j", "--jobs", type="int", help="number of jobs to run in parallel" " (default: $%s or %d)" % defaults['jobs']) parser.add_option("--keep-tmpdir", action="store_true", help="keep temporary directory after running tests") parser.add_option("-k", "--keywords", help="run tests matching keywords") parser.add_option("-l", "--local", action="store_true", help="shortcut for --with-hg=<testdir>/../hg") parser.add_option("--loop", action="store_true", help="loop tests repeatedly") parser.add_option("-n", "--nodiff", action="store_true", help="skip showing test changes") parser.add_option("-p", "--port", type="int", help="port on which servers should listen" " (default: $%s or %d)" % defaults['port']) parser.add_option("--compiler", type="string", help="compiler to build with") parser.add_option("--pure", action="store_true", help="use pure Python code instead of C extensions") parser.add_option("-R", "--restart", action="store_true", help="restart at last error") parser.add_option("-r", "--retest", action="store_true", help="retest failed tests") parser.add_option("-S", "--noskips", action="store_true", help="don't report skip tests verbosely") parser.add_option("--shell", type="string", help="shell to use (default: $%s or %s)" % defaults['shell']) parser.add_option("-t", "--timeout", type="int", help="kill errant tests after TIMEOUT seconds" " (default: $%s or %d)" % defaults['timeout']) parser.add_option("--time", action="store_true", help="time how long each test takes") parser.add_option("--tmpdir", type="string", help="run tests in the given temporary directory" " (implies --keep-tmpdir)") parser.add_option("--unittest", action="store_true", help="run tests with Python's unittest package" " (this is an experimental feature)") parser.add_option("-v", "--verbose", action="store_true", help="output verbose messages") parser.add_option("--view", type="string", help="external diff viewer") parser.add_option("--with-hg", type="string", metavar="HG", help="test using specified hg script rather than a " "temporary installation") parser.add_option("-3", "--py3k-warnings", action="store_true", help="enable Py3k warnings on Python 2.6+") parser.add_option('--extra-config-opt', action="append", help='set the given config opt in the test hgrc') parser.add_option('--random', action="store_true", help='run tests in random order') for option, (envvar, default) in defaults.items(): defaults[option] = type(default)(os.environ.get(envvar, default)) parser.set_defaults(**defaults) return parser def parseargs(args, parser): """Parse arguments with our OptionParser and validate results.""" (options, args) = parser.parse_args(args) # jython is always pure if 'java' in sys.platform or '__pypy__' in sys.modules: options.pure = True if options.with_hg: options.with_hg = os.path.expanduser(options.with_hg) if not (os.path.isfile(options.with_hg) and os.access(options.with_hg, os.X_OK)): parser.error('--with-hg must specify an executable hg script') if not os.path.basename(options.with_hg) == 'hg': sys.stderr.write('warning: --with-hg should specify an hg script\n') if options.local: testdir = os.path.dirname(os.path.realpath(sys.argv[0])) hgbin = os.path.join(os.path.dirname(testdir), 'hg') if os.name != 'nt' and not os.access(hgbin, os.X_OK): parser.error('--local specified, but %r not found or not executable' % hgbin) options.with_hg = hgbin options.anycoverage = options.cover or options.annotate or options.htmlcov if options.anycoverage: try: import coverage covver = version.StrictVersion(coverage.__version__).version if covver < (3, 3): parser.error('coverage options require coverage 3.3 or later') except ImportError: parser.error('coverage options now require the coverage package') if options.anycoverage and options.local: # this needs some path mangling somewhere, I guess parser.error("sorry, coverage options do not work when --local " "is specified") global verbose if options.verbose: verbose = '' if options.tmpdir: options.tmpdir = os.path.expanduser(options.tmpdir) if options.jobs < 1: parser.error('--jobs must be positive') if options.interactive and options.debug: parser.error("-i/--interactive and -d/--debug are incompatible") if options.debug: if options.timeout != defaults['timeout']: sys.stderr.write( 'warning: --timeout option ignored with --debug\n') options.timeout = 0 if options.py3k_warnings: if sys.version_info[:2] < (2, 6) or sys.version_info[:2] >= (3, 0): parser.error('--py3k-warnings can only be used on Python 2.6+') if options.blacklist: options.blacklist = parselistfiles(options.blacklist, 'blacklist') if options.whitelist: options.whitelisted = parselistfiles(options.whitelist, 'whitelist') else: options.whitelisted = {} return (options, args) def rename(src, dst): """Like os.rename(), trade atomicity and opened files friendliness for existing destination support. """ shutil.copy(src, dst) os.remove(src) def showdiff(expected, output, ref, err): print servefail = False for line in difflib.unified_diff(expected, output, ref, err): sys.stdout.write(line) if not servefail and line.startswith( '+ abort: child process failed to start'): servefail = True return {'servefail': servefail} verbose = False def vlog(*msg): if verbose is not False: iolock.acquire() if verbose: print verbose, for m in msg: print m, print sys.stdout.flush() iolock.release() def log(*msg): iolock.acquire() if verbose: print verbose, for m in msg: print m, print sys.stdout.flush() iolock.release() def terminate(proc): """Terminate subprocess (with fallback for Python versions < 2.6)""" vlog('# Terminating process %d' % proc.pid) try: getattr(proc, 'terminate', lambda : os.kill(proc.pid, signal.SIGTERM))() except OSError: pass def killdaemons(pidfile): return killmod.killdaemons(pidfile, tryhard=False, remove=True, logfn=vlog) class Test(object): """Encapsulates a single, runnable test. Test instances can be run multiple times via run(). However, multiple runs cannot be run concurrently. """ # Status code reserved for skipped tests (used by hghave). SKIPPED_STATUS = 80 def __init__(self, runner, test, count, refpath, unittest=False): path = os.path.join(runner.testdir, test) errpath = os.path.join(runner.testdir, '%s.err' % test) self.name = test self._runner = runner self._testdir = runner.testdir self._path = path self._options = runner.options self._count = count self._daemonpids = [] self._refpath = refpath self._errpath = errpath self._unittest = unittest # If we're not in --debug mode and reference output file exists, # check test output against it. if runner.options.debug: self._refout = None # to match "out is None" elif os.path.exists(refpath): f = open(refpath, 'r') self._refout = f.read().splitlines(True) f.close() else: self._refout = [] self._threadtmp = os.path.join(runner.hgtmp, 'child%d' % count) os.mkdir(self._threadtmp) def cleanup(self): for entry in self._daemonpids: killdaemons(entry) if self._threadtmp and not self._options.keep_tmpdir: shutil.rmtree(self._threadtmp, True) def run(self): """Run this test instance. This will return a tuple describing the result of the test. """ if not os.path.exists(self._path): return self.skip("Doesn't exist") options = self._options if not (options.whitelisted and self.name in options.whitelisted): if options.blacklist and self.name in options.blacklist: return self.skip('blacklisted') if options.retest and not os.path.exists('%s.err' % self.name): return self.ignore('not retesting') if options.keywords: f = open(self.name) t = f.read().lower() + self.name.lower() f.close() for k in options.keywords.lower().split(): if k in t: break else: return self.ignore("doesn't match keyword") if not os.path.basename(self.name.lower()).startswith('test-'): return self.skip('not a test file') # Remove any previous output files. if os.path.exists(self._errpath): os.remove(self._errpath) testtmp = os.path.join(self._threadtmp, os.path.basename(self._path)) os.mkdir(testtmp) replacements, port = self._getreplacements(testtmp) env = self._getenv(testtmp, port) self._daemonpids.append(env['DAEMON_PIDS']) self._createhgrc(env['HGRCPATH']) vlog('# Test', self.name) starttime = time.time() try: ret, out = self._run(testtmp, replacements, env) duration = time.time() - starttime except KeyboardInterrupt: duration = time.time() - starttime log('INTERRUPTED: %s (after %d seconds)' % (self.name, duration)) raise except Exception, e: return self.fail('Exception during execution: %s' % e, 255) killdaemons(env['DAEMON_PIDS']) if not options.keep_tmpdir: shutil.rmtree(testtmp) def describe(ret): if ret < 0: return 'killed by signal: %d' % -ret return 'returned error code %d' % ret skipped = False if ret == self.SKIPPED_STATUS: if out is None: # Debug mode, nothing to parse. missing = ['unknown'] failed = None else: missing, failed = TTest.parsehghaveoutput(out) if not missing: missing = ['irrelevant'] if failed: res = self.fail('hg have failed checking for %s' % failed[-1], ret) else: skipped = True res = self.skip(missing[-1]) elif ret == 'timeout': res = self.fail('timed out', ret) elif out != self._refout: info = {} if not options.nodiff: iolock.acquire() if options.view: os.system("%s %s %s" % (options.view, self._refpath, self._errpath)) else: info = showdiff(self._refout, out, self._refpath, self._errpath) iolock.release() msg = '' if info.get('servefail'): msg += 'serve failed and ' if ret: msg += 'output changed and ' + describe(ret) else: msg += 'output changed' if (ret != 0 or out != self._refout) and not skipped \ and not options.debug: f = open(self._errpath, 'wb') for line in out: f.write(line) f.close() res = self.fail(msg, ret) elif ret: res = self.fail(describe(ret), ret) else: res = self.success() vlog("# Ret was:", ret) # Don't print progress in unittest mode because that is handled # by TestResult. if not options.verbose and not self._unittest: iolock.acquire() sys.stdout.write(res[0]) sys.stdout.flush() iolock.release() self._runner.times.append((self.name, duration)) return res def _run(self, testtmp, replacements, env): # This should be implemented in child classes to run tests. return self._skip('unknown test type') def _getreplacements(self, testtmp): port = self._options.port + self._count * 3 r = [ (r':%s\b' % port, ':$HGPORT'), (r':%s\b' % (port + 1), ':$HGPORT1'), (r':%s\b' % (port + 2), ':$HGPORT2'), ] if os.name == 'nt': r.append( (''.join(c.isalpha() and '[%s%s]' % (c.lower(), c.upper()) or c in '/\\' and r'[/\\]' or c.isdigit() and c or '\\' + c for c in testtmp), '$TESTTMP')) else: r.append((re.escape(testtmp), '$TESTTMP')) return r, port def _getenv(self, testtmp, port): env = os.environ.copy() env['TESTTMP'] = testtmp env['HOME'] = testtmp env["HGPORT"] = str(port) env["HGPORT1"] = str(port + 1) env["HGPORT2"] = str(port + 2) env["HGRCPATH"] = os.path.join(self._threadtmp, '.hgrc') env["DAEMON_PIDS"] = os.path.join(self._threadtmp, 'daemon.pids') env["HGEDITOR"] = sys.executable + ' -c "import sys; sys.exit(0)"' env["HGMERGE"] = "internal:merge" env["HGUSER"] = "test" env["HGENCODING"] = "ascii" env["HGENCODINGMODE"] = "strict" # Reset some environment variables to well-known values so that # the tests produce repeatable output. env['LANG'] = env['LC_ALL'] = env['LANGUAGE'] = 'C' env['TZ'] = 'GMT' env["EMAIL"] = "Foo Bar <foo.bar@example.com>" env['COLUMNS'] = '80' env['TERM'] = 'xterm' for k in ('HG HGPROF CDPATH GREP_OPTIONS http_proxy no_proxy ' + 'NO_PROXY').split(): if k in env: del env[k] # unset env related to hooks for k in env.keys(): if k.startswith('HG_'): del env[k] return env def _createhgrc(self, path): # create a fresh hgrc hgrc = open(path, 'w') hgrc.write('[ui]\n') hgrc.write('slash = True\n') hgrc.write('interactive = False\n') hgrc.write('[defaults]\n') hgrc.write('backout = -d "0 0"\n') hgrc.write('commit = -d "0 0"\n') hgrc.write('shelve = --date "0 0"\n') hgrc.write('tag = -d "0 0"\n') if self._options.extra_config_opt: for opt in self._options.extra_config_opt: section, key = opt.split('.', 1) assert '=' in key, ('extra config opt %s must ' 'have an = for assignment' % opt) hgrc.write('[%s]\n%s\n' % (section, key)) hgrc.close() def success(self): return '.', self.name, '' def fail(self, msg, ret): warned = ret is False if not self._options.nodiff: log("\n%s: %s %s" % (warned and 'Warning' or 'ERROR', self.name, msg)) if (not ret and self._options.interactive and os.path.exists(self._errpath)): iolock.acquire() print 'Accept this change? [n] ', answer = sys.stdin.readline().strip() iolock.release() if answer.lower() in ('y', 'yes'): if self.name.endswith('.t'): rename(self._errpath, self._path) else: rename(self._errpath, '%s.out' % self._path) return '.', self.name, '' if self._unittest: if warned: raise WarnTest(msg) else: # unittest differentiates between errored and failed. # Failed is denoted by AssertionError (by default at least). raise AssertionError(msg) return warned and '~' or '!', self.name, msg def skip(self, msg): if self._unittest: raise SkipTest(msg) if self._options.verbose: log("\nSkipping %s: %s" % (self._path, msg)) return 's', self.name, msg def ignore(self, msg): if self._unittest: raise IgnoreTest(msg) return 'i', self.name, msg class PythonTest(Test): """A Python-based test.""" def _run(self, testtmp, replacements, env): py3kswitch = self._options.py3k_warnings and ' -3' or '' cmd = '%s%s "%s"' % (PYTHON, py3kswitch, self._path) vlog("# Running", cmd) if os.name == 'nt': replacements.append((r'\r\n', '\n')) return run(cmd, testtmp, self._options, replacements, env, self._runner.abort) class TTest(Test): """A "t test" is a test backed by a .t file.""" SKIPPED_PREFIX = 'skipped: ' FAILED_PREFIX = 'hghave check failed: ' NEEDESCAPE = re.compile(r'[\x00-\x08\x0b-\x1f\x7f-\xff]').search ESCAPESUB = re.compile(r'[\x00-\x08\x0b-\x1f\\\x7f-\xff]').sub ESCAPEMAP = dict((chr(i), r'\x%02x' % i) for i in range(256)).update( {'\\': '\\\\', '\r': r'\r'}) def _run(self, testtmp, replacements, env): f = open(self._path) lines = f.readlines() f.close() salt, script, after, expected = self._parsetest(lines, testtmp) # Write out the generated script. fname = '%s.sh' % testtmp f = open(fname, 'w') for l in script: f.write(l) f.close() cmd = '%s "%s"' % (self._options.shell, fname) vlog("# Running", cmd) exitcode, output = run(cmd, testtmp, self._options, replacements, env, self._runner.abort) # Do not merge output if skipped. Return hghave message instead. # Similarly, with --debug, output is None. if exitcode == self.SKIPPED_STATUS or output is None: return exitcode, output return self._processoutput(exitcode, output, salt, after, expected) def _hghave(self, reqs, testtmp): # TODO do something smarter when all other uses of hghave are gone. tdir = self._testdir.replace('\\', '/') proc = Popen4('%s -c "%s/hghave %s"' % (self._options.shell, tdir, ' '.join(reqs)), testtmp, 0) stdout, stderr = proc.communicate() ret = proc.wait() if wifexited(ret): ret = os.WEXITSTATUS(ret) if ret == 2: print stdout sys.exit(1) return ret == 0 def _parsetest(self, lines, testtmp): # We generate a shell script which outputs unique markers to line # up script results with our source. These markers include input # line number and the last return code. salt = "SALT" + str(time.time()) def addsalt(line, inpython): if inpython: script.append('%s %d 0\n' % (salt, line)) else: script.append('echo %s %s $?\n' % (salt, line)) script = [] # After we run the shell script, we re-unify the script output # with non-active parts of the source, with synchronization by our # SALT line number markers. The after table contains the non-active # components, ordered by line number. after = {} # Expected shell script output. expected = {} pos = prepos = -1 # True or False when in a true or false conditional section skipping = None # We keep track of whether or not we're in a Python block so we # can generate the surrounding doctest magic. inpython = False if self._options.debug: script.append('set -x\n') if os.getenv('MSYSTEM'): script.append('alias pwd="pwd -W"\n') for n, l in enumerate(lines): if not l.endswith('\n'): l += '\n' if l.startswith('#if'): lsplit = l.split() if len(lsplit) < 2 or lsplit[0] != '#if': after.setdefault(pos, []).append(' !!! invalid #if\n') if skipping is not None: after.setdefault(pos, []).append(' !!! nested #if\n') skipping = not self._hghave(lsplit[1:], testtmp) after.setdefault(pos, []).append(l) elif l.startswith('#else'): if skipping is None: after.setdefault(pos, []).append(' !!! missing #if\n') skipping = not skipping after.setdefault(pos, []).append(l) elif l.startswith('#endif'): if skipping is None: after.setdefault(pos, []).append(' !!! missing #if\n') skipping = None after.setdefault(pos, []).append(l) elif skipping: after.setdefault(pos, []).append(l) elif l.startswith(' >>> '): # python inlines after.setdefault(pos, []).append(l) prepos = pos pos = n if not inpython: # We've just entered a Python block. Add the header. inpython = True addsalt(prepos, False) # Make sure we report the exit code. script.append('%s -m heredoctest <<EOF\n' % PYTHON) addsalt(n, True) script.append(l[2:]) elif l.startswith(' ... '): # python inlines after.setdefault(prepos, []).append(l) script.append(l[2:]) elif l.startswith(' $ '): # commands if inpython: script.append('EOF\n') inpython = False after.setdefault(pos, []).append(l) prepos = pos pos = n addsalt(n, False) cmd = l[4:].split() if len(cmd) == 2 and cmd[0] == 'cd': l = ' $ cd %s || exit 1\n' % cmd[1] script.append(l[4:]) elif l.startswith(' > '): # continuations after.setdefault(prepos, []).append(l) script.append(l[4:]) elif l.startswith(' '): # results # Queue up a list of expected results. expected.setdefault(pos, []).append(l[2:]) else: if inpython: script.append('EOF\n') inpython = False # Non-command/result. Queue up for merged output. after.setdefault(pos, []).append(l) if inpython: script.append('EOF\n') if skipping is not None: after.setdefault(pos, []).append(' !!! missing #endif\n') addsalt(n + 1, False) return salt, script, after, expected def _processoutput(self, exitcode, output, salt, after, expected): # Merge the script output back into a unified test. warnonly = 1 # 1: not yet; 2: yes; 3: for sure not if exitcode != 0: warnonly = 3 pos = -1 postout = [] for l in output: lout, lcmd = l, None if salt in l: lout, lcmd = l.split(salt, 1) if lout: if not lout.endswith('\n'): lout += ' (no-eol)\n' # Find the expected output at the current position. el = None if expected.get(pos, None): el = expected[pos].pop(0) r = TTest.linematch(el, lout) if isinstance(r, str): if r == '+glob': lout = el[:-1] + ' (glob)\n' r = '' # Warn only this line. elif r == '-glob': lout = ''.join(el.rsplit(' (glob)', 1)) r = '' # Warn only this line. else: log('\ninfo, unknown linematch result: %r\n' % r) r = False if r: postout.append(' ' + el) else: if self.NEEDESCAPE(lout): lout = TTest.stringescape('%s (esc)\n' % lout.rstrip('\n')) postout.append(' ' + lout) # Let diff deal with it. if r != '': # If line failed. warnonly = 3 # for sure not elif warnonly == 1: # Is "not yet" and line is warn only. warnonly = 2 # Yes do warn. if lcmd: # Add on last return code. ret = int(lcmd.split()[1]) if ret != 0: postout.append(' [%s]\n' % ret) if pos in after: # Merge in non-active test bits. postout += after.pop(pos) pos = int(lcmd.split()[0]) if pos in after: postout += after.pop(pos) if warnonly == 2: exitcode = False # Set exitcode to warned. return exitcode, postout @staticmethod def rematch(el, l): try: # use \Z to ensure that the regex matches to the end of the string if os.name == 'nt': return re.match(el + r'\r?\n\Z', l) return re.match(el + r'\n\Z', l) except re.error: # el is an invalid regex return False @staticmethod def globmatch(el, l): # The only supported special characters are * and ? plus / which also # matches \ on windows. Escaping of these characters is supported. if el + '\n' == l: if os.altsep: # matching on "/" is not needed for this line return '-glob' return True i, n = 0, len(el) res = '' while i < n: c = el[i] i += 1 if c == '\\' and el[i] in '*?\\/': res += el[i - 1:i + 1] i += 1 elif c == '*': res += '.*' elif c == '?': res += '.' elif c == '/' and os.altsep: res += '[/\\\\]' else: res += re.escape(c) return TTest.rematch(res, l) @staticmethod def linematch(el, l): if el == l: # perfect match (fast) return True if el: if el.endswith(" (esc)\n"): el = el[:-7].decode('string-escape') + '\n' if el == l or os.name == 'nt' and el[:-1] + '\r\n' == l: return True if el.endswith(" (re)\n"): return TTest.rematch(el[:-6], l) if el.endswith(" (glob)\n"): return TTest.globmatch(el[:-8], l) if os.altsep and l.replace('\\', '/') == el: return '+glob' return False @staticmethod def parsehghaveoutput(lines): '''Parse hghave log lines. Return tuple of lists (missing, failed): * the missing/unknown features * the features for which existence check failed''' missing = [] failed = [] for line in lines: if line.startswith(TTest.SKIPPED_PREFIX): line = line.splitlines()[0] missing.append(line[len(TTest.SKIPPED_PREFIX):]) elif line.startswith(TTest.FAILED_PREFIX): line = line.splitlines()[0] failed.append(line[len(TTest.FAILED_PREFIX):]) return missing, failed @staticmethod def _escapef(m): return TTest.ESCAPEMAP[m.group(0)] @staticmethod def _stringescape(s): return TTest.ESCAPESUB(TTest._escapef, s) wifexited = getattr(os, "WIFEXITED", lambda x: False) def run(cmd, wd, options, replacements, env, abort): """Run command in a sub-process, capturing the output (stdout and stderr). Return a tuple (exitcode, output). output is None in debug mode.""" # TODO: Use subprocess.Popen if we're running on Python 2.4 if options.debug: proc = subprocess.Popen(cmd, shell=True, cwd=wd, env=env) ret = proc.wait() return (ret, None) proc = Popen4(cmd, wd, options.timeout, env) def cleanup(): terminate(proc) ret = proc.wait() if ret == 0: ret = signal.SIGTERM << 8 killdaemons(env['DAEMON_PIDS']) return ret output = '' proc.tochild.close() try: output = proc.fromchild.read() except KeyboardInterrupt: vlog('# Handling keyboard interrupt') cleanup() raise ret = proc.wait() if wifexited(ret): ret = os.WEXITSTATUS(ret) if proc.timeout: ret = 'timeout' if ret: killdaemons(env['DAEMON_PIDS']) if abort[0]: raise KeyboardInterrupt() for s, r in replacements: output = re.sub(s, r, output) return ret, output.splitlines(True) iolock = threading.Lock() class SkipTest(Exception): """Raised to indicate that a test is to be skipped.""" class IgnoreTest(Exception): """Raised to indicate that a test is to be ignored.""" class WarnTest(Exception): """Raised to indicate that a test warned.""" class TestResult(unittest._TextTestResult): """Holds results when executing via unittest.""" # Don't worry too much about accessing the non-public _TextTestResult. # It is relatively common in Python testing tools. def __init__(self, *args, **kwargs): super(TestResult, self).__init__(*args, **kwargs) # unittest.TestResult didn't have skipped until 2.7. We need to # polyfill it. self.skipped = [] # We have a custom "ignored" result that isn't present in any Python # unittest implementation. It is very similar to skipped. It may make # sense to map it into skip some day. self.ignored = [] # We have a custom "warned" result that isn't present in any Python # unittest implementation. It is very similar to failed. It may make # sense to map it into fail some day. self.warned = [] # Polyfill. def addSkip(self, test, reason): self.skipped.append((test, reason)) if self.showAll: self.stream.writeln('skipped %s' % reason) else: self.stream.write('s') self.stream.flush() def addIgnore(self, test, reason): self.ignored.append((test, reason)) if self.showAll: self.stream.writeln('ignored %s' % reason) else: self.stream.write('i') self.stream.flush() def addWarn(self, test, reason): self.warned.append((test, reason)) if self.showAll: self.stream.writeln('warned %s' % reason) else: self.stream.write('~') self.stream.flush() class TestSuite(unittest.TestSuite): """Custom unitest TestSuite that knows how to execute concurrently.""" def __init__(self, runner, *args, **kwargs): super(TestSuite, self).__init__(*args, **kwargs) self._runner = runner def run(self, result): self._runner._executetests(self._tests, result=result) return result class TextTestRunner(unittest.TextTestRunner): """Custom unittest test runner that uses appropriate settings.""" def _makeResult(self): return TestResult(self.stream, self.descriptions, self.verbosity) class TestRunner(object): """Holds context for executing tests. Tests rely on a lot of state. This object holds it for them. """ REQUIREDTOOLS = [ os.path.basename(sys.executable), 'diff', 'grep', 'unzip', 'gunzip', 'bunzip2', 'sed', ] TESTTYPES = [ ('.py', PythonTest, '.out'), ('.t', TTest, ''), ] def __init__(self): self.options = None self.testdir = None self.hgtmp = None self.inst = None self.bindir = None self.tmpbinddir = None self.pythondir = None self.coveragefile = None self.times = [] # Holds execution times of tests. self.results = { '.': [], '!': [], '~': [], 's': [], 'i': [], 'u': [], } self.abort = [False] self._createdfiles = [] self._hgpath = None def run(self, args, parser=None): """Run the test suite.""" oldmask = os.umask(022) try: parser = parser or getparser() options, args = parseargs(args, parser) self.options = options self._checktools() tests = self.findtests(args) return self._run(tests) finally: os.umask(oldmask) def _run(self, tests): if self.options.random: random.shuffle(tests) else: # keywords for slow tests slow = 'svn gendoc check-code-hg'.split() def sortkey(f): # run largest tests first, as they tend to take the longest try: val = -os.stat(f).st_size except OSError, e: if e.errno != errno.ENOENT: raise return -1e9 # file does not exist, tell early for kw in slow: if kw in f: val *= 10 return val tests.sort(key=sortkey) self.testdir = os.environ['TESTDIR'] = os.getcwd() if 'PYTHONHASHSEED' not in os.environ: # use a random python hash seed all the time # we do the randomness ourself to know what seed is used os.environ['PYTHONHASHSEED'] = str(random.getrandbits(32)) if self.options.tmpdir: self.options.keep_tmpdir = True tmpdir = self.options.tmpdir if os.path.exists(tmpdir): # Meaning of tmpdir has changed since 1.3: we used to create # HGTMP inside tmpdir; now HGTMP is tmpdir. So fail if # tmpdir already exists. print "error: temp dir %r already exists" % tmpdir return 1 # Automatically removing tmpdir sounds convenient, but could # really annoy anyone in the habit of using "--tmpdir=/tmp" # or "--tmpdir=$HOME". #vlog("# Removing temp dir", tmpdir) #shutil.rmtree(tmpdir) os.makedirs(tmpdir) else: d = None if os.name == 'nt': # without this, we get the default temp dir location, but # in all lowercase, which causes troubles with paths (issue3490) d = os.getenv('TMP') tmpdir = tempfile.mkdtemp('', 'hgtests.', d) self.hgtmp = os.environ['HGTMP'] = os.path.realpath(tmpdir) if self.options.with_hg: self.inst = None self.bindir = os.path.dirname(os.path.realpath( self.options.with_hg)) self.tmpbindir = os.path.join(self.hgtmp, 'install', 'bin') os.makedirs(self.tmpbindir) # This looks redundant with how Python initializes sys.path from # the location of the script being executed. Needed because the # "hg" specified by --with-hg is not the only Python script # executed in the test suite that needs to import 'mercurial' # ... which means it's not really redundant at all. self.pythondir = self.bindir else: self.inst = os.path.join(self.hgtmp, "install") self.bindir = os.environ["BINDIR"] = os.path.join(self.inst, "bin") self.tmpbindir = self.bindir self.pythondir = os.path.join(self.inst, "lib", "python") os.environ["BINDIR"] = self.bindir os.environ["PYTHON"] = PYTHON path = [self.bindir] + os.environ["PATH"].split(os.pathsep) if self.tmpbindir != self.bindir: path = [self.tmpbindir] + path os.environ["PATH"] = os.pathsep.join(path) # Include TESTDIR in PYTHONPATH so that out-of-tree extensions # can run .../tests/run-tests.py test-foo where test-foo # adds an extension to HGRC. Also include run-test.py directory to # import modules like heredoctest. pypath = [self.pythondir, self.testdir, os.path.abspath(os.path.dirname(__file__))] # We have to augment PYTHONPATH, rather than simply replacing # it, in case external libraries are only available via current # PYTHONPATH. (In particular, the Subversion bindings on OS X # are in /opt/subversion.) oldpypath = os.environ.get(IMPL_PATH) if oldpypath: pypath.append(oldpypath) os.environ[IMPL_PATH] = os.pathsep.join(pypath) self.coveragefile = os.path.join(self.testdir, '.coverage') vlog("# Using TESTDIR", self.testdir) vlog("# Using HGTMP", self.hgtmp) vlog("# Using PATH", os.environ["PATH"]) vlog("# Using", IMPL_PATH, os.environ[IMPL_PATH]) try: return self._runtests(tests) or 0 finally: time.sleep(.1) self._cleanup() def findtests(self, args): """Finds possible test files from arguments. If you wish to inject custom tests into the test harness, this would be a good function to monkeypatch or override in a derived class. """ if not args: if self.options.changed: proc = Popen4('hg st --rev "%s" -man0 .' % self.options.changed, None, 0) stdout, stderr = proc.communicate() args = stdout.strip('\0').split('\0') else: args = os.listdir('.') return [t for t in args if os.path.basename(t).startswith('test-') and (t.endswith('.py') or t.endswith('.t'))] def _runtests(self, tests): try: if self.inst: self._installhg() self._checkhglib("Testing") else: self._usecorrectpython() if self.options.restart: orig = list(tests) while tests: if os.path.exists(tests[0] + ".err"): break tests.pop(0) if not tests: print "running all tests" tests = orig tests = [self._gettest(t, i, asunit=self.options.unittest) for i, t in enumerate(tests)] if self.options.unittest: suite = TestSuite(self, tests=tests) verbosity = 1 if self.options.verbose: verbosity = 2 runner = TextTestRunner(verbosity=verbosity) runner.run(suite) else: self._executetests(tests) failed = len(self.results['!']) warned = len(self.results['~']) tested = len(self.results['.']) + failed + warned skipped = len(self.results['s']) ignored = len(self.results['i']) print if not self.options.noskips: for s in self.results['s']: print "Skipped %s: %s" % s for s in self.results['~']: print "Warned %s: %s" % s for s in self.results['!']: print "Failed %s: %s" % s self._checkhglib("Tested") print "# Ran %d tests, %d skipped, %d warned, %d failed." % ( tested, skipped + ignored, warned, failed) if self.results['!']: print 'python hash seed:', os.environ['PYTHONHASHSEED'] if self.options.time: self._outputtimes() if self.options.anycoverage: self._outputcoverage() except KeyboardInterrupt: failed = True print "\ninterrupted!" if failed: return 1 if warned: return 80 def _gettest(self, test, count, asunit=False): """Obtain a Test by looking at its filename. Returns a Test instance. The Test may not be runnable if it doesn't map to a known type. """ lctest = test.lower() refpath = os.path.join(self.testdir, test) testcls = Test for ext, cls, out in self.TESTTYPES: if lctest.endswith(ext): testcls = cls refpath = os.path.join(self.testdir, test + out) break t = testcls(self, test, count, refpath, unittest=asunit) if not asunit: return t class MercurialTest(unittest.TestCase): def __init__(self, name, *args, **kwargs): super(MercurialTest, self).__init__(*args, **kwargs) self.name = name def shortDescription(self): return self.name # Need to stash away the TestResult since we do custom things # with it. def run(self, result): try: self.runTest() except KeyboardInterrupt: raise except SkipTest, e: result.addSkip(self, str(e)) except IgnoreTest, e: result.addIgnore(self, str(e)) except WarnTest, e: result.addWarn(self, str(e)) except self.failureException: result.addFailure(self, sys.exc_info()) except Exception: result.addError(self, sys.exc_info()) else: result.addSuccess(self) def runTest(self): code, tname, msg = t.run() # All non-success conditions should be exceptions and should # be caught in run(). assert code == '.' # We need this proxy until tearDown() is implemented. def cleanup(self): return t.cleanup() return MercurialTest(test) def _cleanup(self): """Clean up state from this test invocation.""" if self.options.keep_tmpdir: return vlog("# Cleaning up HGTMP", self.hgtmp) shutil.rmtree(self.hgtmp, True) for f in self._createdfiles: try: os.remove(f) except OSError: pass def _usecorrectpython(self): # Some tests run the Python interpreter. They must use the # same interpreter or bad things will happen. pyexename = sys.platform == 'win32' and 'python.exe' or 'python' if getattr(os, 'symlink', None): vlog("# Making python executable in test path a symlink to '%s'" % sys.executable) mypython = os.path.join(self.tmpbindir, pyexename) try: if os.readlink(mypython) == sys.executable: return os.unlink(mypython) except OSError, err: if err.errno != errno.ENOENT: raise if self._findprogram(pyexename) != sys.executable: try: os.symlink(sys.executable, mypython) self._createdfiles.append(mypython) except OSError, err: # child processes may race, which is harmless if err.errno != errno.EEXIST: raise else: exedir, exename = os.path.split(sys.executable) vlog("# Modifying search path to find %s as %s in '%s'" % (exename, pyexename, exedir)) path = os.environ['PATH'].split(os.pathsep) while exedir in path: path.remove(exedir) os.environ['PATH'] = os.pathsep.join([exedir] + path) if not self._findprogram(pyexename): print "WARNING: Cannot find %s in search path" % pyexename def _installhg(self): vlog("# Performing temporary installation of HG") installerrs = os.path.join("tests", "install.err") compiler = '' if self.options.compiler: compiler = '--compiler ' + self.options.compiler pure = self.options.pure and "--pure" or "" py3 = '' if sys.version_info[0] == 3: py3 = '--c2to3' # Run installer in hg root script = os.path.realpath(sys.argv[0]) hgroot = os.path.dirname(os.path.dirname(script)) os.chdir(hgroot) nohome = '--home=""' if os.name == 'nt': # The --home="" trick works only on OS where os.sep == '/' # because of a distutils convert_path() fast-path. Avoid it at # least on Windows for now, deal with .pydistutils.cfg bugs # when they happen. nohome = '' cmd = ('%(exe)s setup.py %(py3)s %(pure)s clean --all' ' build %(compiler)s --build-base="%(base)s"' ' install --force --prefix="%(prefix)s"' ' --install-lib="%(libdir)s"' ' --install-scripts="%(bindir)s" %(nohome)s >%(logfile)s 2>&1' % {'exe': sys.executable, 'py3': py3, 'pure': pure, 'compiler': compiler, 'base': os.path.join(self.hgtmp, "build"), 'prefix': self.inst, 'libdir': self.pythondir, 'bindir': self.bindir, 'nohome': nohome, 'logfile': installerrs}) vlog("# Running", cmd) if os.system(cmd) == 0: if not self.options.verbose: os.remove(installerrs) else: f = open(installerrs) for line in f: print line, f.close() sys.exit(1) os.chdir(self.testdir) self._usecorrectpython() if self.options.py3k_warnings and not self.options.anycoverage: vlog("# Updating hg command to enable Py3k Warnings switch") f = open(os.path.join(self.bindir, 'hg'), 'r') lines = [line.rstrip() for line in f] lines[0] += ' -3' f.close() f = open(os.path.join(self.bindir, 'hg'), 'w') for line in lines: f.write(line + '\n') f.close() hgbat = os.path.join(self.bindir, 'hg.bat') if os.path.isfile(hgbat): # hg.bat expects to be put in bin/scripts while run-tests.py # installation layout put it in bin/ directly. Fix it f = open(hgbat, 'rb') data = f.read() f.close() if '"%~dp0..\python" "%~dp0hg" %*' in data: data = data.replace('"%~dp0..\python" "%~dp0hg" %*', '"%~dp0python" "%~dp0hg" %*') f = open(hgbat, 'wb') f.write(data) f.close() else: print 'WARNING: cannot fix hg.bat reference to python.exe' if self.options.anycoverage: custom = os.path.join(self.testdir, 'sitecustomize.py') target = os.path.join(self.pythondir, 'sitecustomize.py') vlog('# Installing coverage trigger to %s' % target) shutil.copyfile(custom, target) rc = os.path.join(self.testdir, '.coveragerc') vlog('# Installing coverage rc to %s' % rc) os.environ['COVERAGE_PROCESS_START'] = rc fn = os.path.join(self.inst, '..', '.coverage') os.environ['COVERAGE_FILE'] = fn def _checkhglib(self, verb): """Ensure that the 'mercurial' package imported by python is the one we expect it to be. If not, print a warning to stderr.""" expecthg = os.path.join(self.pythondir, 'mercurial') actualhg = self._gethgpath() if os.path.abspath(actualhg) != os.path.abspath(expecthg): sys.stderr.write('warning: %s with unexpected mercurial lib: %s\n' ' (expected %s)\n' % (verb, actualhg, expecthg)) def _gethgpath(self): """Return the path to the mercurial package that is actually found by the current Python interpreter.""" if self._hgpath is not None: return self._hgpath cmd = '%s -c "import mercurial; print (mercurial.__path__[0])"' pipe = os.popen(cmd % PYTHON) try: self._hgpath = pipe.read().strip() finally: pipe.close() return self._hgpath def _outputtimes(self): vlog('# Producing time report') self.times.sort(key=lambda t: (t[1], t[0]), reverse=True) cols = '%7.3f %s' print '\n%-7s %s' % ('Time', 'Test') for test, timetaken in self.times: print cols % (timetaken, test) def _outputcoverage(self): vlog('# Producing coverage report') os.chdir(self.pythondir) def covrun(*args): cmd = 'coverage %s' % ' '.join(args) vlog('# Running: %s' % cmd) os.system(cmd) covrun('-c') omit = ','.join(os.path.join(x, '*') for x in [self.bindir, self.testdir]) covrun('-i', '-r', '"--omit=%s"' % omit) # report if self.options.htmlcov: htmldir = os.path.join(self.testdir, 'htmlcov') covrun('-i', '-b', '"--directory=%s"' % htmldir, '"--omit=%s"' % omit) if self.options.annotate: adir = os.path.join(self.testdir, 'annotated') if not os.path.isdir(adir): os.mkdir(adir) covrun('-i', '-a', '"--directory=%s"' % adir, '"--omit=%s"' % omit) def _executetests(self, tests, result=None): # We copy because we modify the list. tests = list(tests) jobs = self.options.jobs done = queue.Queue() running = 0 def job(test, result): try: # If in unittest mode. if result: test(result) # We need to put something here to make the logic happy. # This will get cleaned up later. done.put(('u', None, None)) else: done.put(test.run()) test.cleanup() except KeyboardInterrupt: pass except: # re-raises done.put(('!', test, 'run-test raised an error, see traceback')) raise try: while tests or running: if not done.empty() or running == jobs or not tests: try: code, test, msg = done.get(True, 1) self.results[code].append((test, msg)) if self.options.first and code not in '.si': break except queue.Empty: continue running -= 1 if tests and not running == jobs: test = tests.pop(0) if self.options.loop: tests.append(test) t = threading.Thread(target=job, name=test.name, args=(test, result)) t.start() running += 1 except KeyboardInterrupt: self.abort[0] = True def _findprogram(self, program): """Search PATH for a executable program""" for p in os.environ.get('PATH', os.defpath).split(os.pathsep): name = os.path.join(p, program) if os.name == 'nt' or os.access(name, os.X_OK): return name return None def _checktools(self): # Before we go any further, check for pre-requisite tools # stuff from coreutils (cat, rm, etc) are not tested for p in self.REQUIREDTOOLS: if os.name == 'nt' and not p.endswith('.exe'): p += '.exe' found = self._findprogram(p) if found: vlog("# Found prerequisite", p, "at", found) else: print "WARNING: Did not find prerequisite tool: %s " % p if __name__ == '__main__': runner = TestRunner() sys.exit(runner.run(sys.argv[1:]))