Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master
Fetching contributors…

Cannot retrieve contributors at this time

890 lines (781 sloc) 29.364 kb
#! /usr/bin/env python
##############################################################################
#
# Copyright (c) 2001, 2002 Zope Corporation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""
test.py [-aBbcdDfgGhLmprtTuv] [modfilter [testfilter]]
Test harness.
-a level
--all
Run the tests at the given level. Any test at a level at or below this is
run, any test at a level above this is not run. Level 0 runs all tests.
The default is to run tests at level 1. --all is a shortcut for -a 0.
-b
--build
Run "python setup.py build" before running tests, where "python"
is the version of python used to run test.py. Highly recommended.
Tests will be run from the build directory. (Note: In Python < 2.3
the -q flag is added to the setup.py command line.)
-B
Run "python setup.py build_ext -i" before running tests. Tests will be
run from the source directory.
-c use pychecker
-d
Instead of the normal test harness, run a debug version which
doesn't catch any exceptions. This is occasionally handy when the
unittest code catching the exception doesn't work right.
Unfortunately, the debug harness doesn't print the name of the
test, so Use With Care.
--dir directory
Option to limit where tests are searched for. This is
important when you *really* want to limit the code that gets run.
For example, if refactoring interfaces, you don't want to see the way
you have broken setups for tests in other packages. You *just* want to
run the interface tests.
-D
Works like -d, except that it loads pdb when an exception occurs.
-f
Run functional tests instead of unit tests.
-g threshold
Set the garbage collector generation0 threshold. This can be used to
stress memory and gc correctness. Some crashes are only reproducible when
the threshold is set to 1 (agressive garbage collection). Do "-g 0" to
disable garbage collection altogether.
-G gc_option
Set the garbage collection debugging flags. The argument must be one
of the DEBUG_ flags defined bythe Python gc module. Multiple options
can be specified by using "-G OPTION1 -G OPTION2."
--libdir test_root
Search for tests starting in the specified start directory
(useful for testing components being developed outside the main
"src" or "build" trees).
--keepbytecode
Do not delete all stale bytecode before running tests
-L
Keep running the selected tests in a loop. You may experience
memory leakage.
-t
Time the individual tests and print a list of the top 50, sorted from
longest to shortest.
-p
Show running progress. It can be combined with -v or -vv.
-r
Look for refcount problems.
This requires that Python was built --with-pydebug.
-T
Use the trace module from Python for code coverage. XXX This only works
if trace.py is explicitly added to PYTHONPATH. The current utility writes
coverage files to a directory named `coverage' that is parallel to
`build'. It also prints a summary to stdout.
-v
Verbose output. With one -v, unittest prints a dot (".") for each test
run. With -vv, unittest prints the name of each test (for some definition
of "name" ...). With no -v, unittest is silent until the end of the run,
except when errors occur.
When -p is also specified, the meaning of -v is sligtly changed. With
-p and no -v only the percent indicator is displayed. With -p and -v
the test name of the current test is shown to the right of the percent
indicator. With -p and -vv the test name is not truncated to fit into
80 columns and it is not cleared after the test finishes.
-u
-m
Use the PyUnit GUI instead of output to the command line. The GUI imports
tests on its own, taking care to reload all dependencies on each run. The
debug (-d), verbose (-v), progress (-p), and Loop (-L) options will be
ignored. The testfilter filter is also not applied.
-m starts the gui minimized. Double-clicking the progress bar will start
the import and run all tests.
modfilter
testfilter
Case-sensitive regexps to limit which tests are run, used in search
(not match) mode.
In an extension of Python regexp notation, a leading "!" is stripped
and causes the sense of the remaining regexp to be negated (so "!bc"
matches any string that does not match "bc", and vice versa).
By default these act like ".", i.e. nothing is excluded.
modfilter is applied to a test file's path, starting at "build" and
including (OS-dependent) path separators.
testfilter is applied to the (method) name of the unittest methods
contained in the test files whose paths modfilter matched.
Extreme (yet useful) examples:
test.py -vvb . "^testWriteClient$"
Builds the project silently, then runs unittest in verbose mode on all
tests whose names are precisely "testWriteClient". Useful when
debugging a specific test.
test.py -vvb . "!^testWriteClient$"
As before, but runs all tests whose names aren't precisely
"testWriteClient". Useful to avoid a specific failing test you don't
want to deal with just yet.
test.py -m . "!^testWriteClient$"
As before, but now opens up a minimized PyUnit GUI window (only showing
the progress bar). Useful for refactoring runs where you continually want
to make sure all tests still pass.
"""
import gc
import os
import re
import pdb
import sys
import threading # just to get at Thread objects created by tests
import time
import traceback
import unittest
import warnings
from distutils.util import get_platform
PLAT_SPEC = "%s-%s" % (get_platform(), sys.version[0:3])
class ImmediateTestResult(unittest._TextTestResult):
__super_init = unittest._TextTestResult.__init__
__super_startTest = unittest._TextTestResult.startTest
__super_printErrors = unittest._TextTestResult.printErrors
def __init__(self, stream, descriptions, verbosity, debug=0,
count=None, progress=0):
self.__super_init(stream, descriptions, verbosity)
self._debug = debug
self._progress = progress
self._progressWithNames = 0
self._count = count
self._testtimes = {}
# docstrings for tests don't override test-descriptions:
self.descriptions = False
if progress and verbosity == 1:
self.dots = 0
self._progressWithNames = 1
self._lastWidth = 0
self._maxWidth = 80
try:
import curses
except ImportError:
pass
else:
curses.setupterm()
self._maxWidth = curses.tigetnum('cols')
self._maxWidth -= len("xxxx/xxxx (xxx.x%): ") + 1
def stopTest(self, test):
self._testtimes[test] = time.time() - self._testtimes[test]
if gc.garbage:
print "The following test left garbage:"
print test
print gc.garbage
# eat the garbage here, so that the garbage isn't
# printed for every subsequent test.
gc.garbage[:] = []
# Did the test leave any new threads behind?
new_threads = [t for t in threading.enumerate()
if (t.isAlive()
and
t not in self._threads)]
if new_threads:
print "The following test left new threads behind:"
print test
print "New thread(s):", new_threads
def print_times(self, stream, count=None):
results = self._testtimes.items()
results.sort(lambda x, y: cmp(y[1], x[1]))
if count:
n = min(count, len(results))
if n:
print >>stream, "Top %d longest tests:" % n
else:
n = len(results)
if not n:
return
for i in range(n):
print >>stream, "%6dms" % int(results[i][1] * 1000), results[i][0]
def _print_traceback(self, msg, err, test, errlist):
if self.showAll or self.dots or self._progress:
self.stream.writeln("\n")
self._lastWidth = 0
tb = "".join(traceback.format_exception(*err))
self.stream.writeln(msg)
self.stream.writeln(tb)
errlist.append((test, tb))
def startTest(self, test):
if self._progress:
self.stream.write("\r%4d" % (self.testsRun + 1))
if self._count:
self.stream.write("/%d (%5.1f%%)" % (self._count,
(self.testsRun + 1) * 100.0 / self._count))
if self.showAll:
self.stream.write(": ")
elif self._progressWithNames:
# XXX will break with multibyte strings
name = self.getShortDescription(test)
width = len(name)
if width < self._lastWidth:
name += " " * (self._lastWidth - width)
self.stream.write(": %s" % name)
self._lastWidth = width
self.stream.flush()
self._threads = threading.enumerate()
self.__super_startTest(test)
self._testtimes[test] = time.time()
def getShortDescription(self, test):
s = self.getDescription(test)
if len(s) > self._maxWidth:
pos = s.find(" (")
if pos >= 0:
w = self._maxWidth - (pos + 5)
if w < 1:
# first portion (test method name) is too long
s = s[:self._maxWidth-3] + "..."
else:
pre = s[:pos+2]
post = s[-w:]
s = "%s...%s" % (pre, post)
return s[:self._maxWidth]
def addError(self, test, err):
if self._progress:
self.stream.write("\r")
if self._debug:
raise err[0], err[1], err[2]
self._print_traceback("Error in test %s" % test, err,
test, self.errors)
def addFailure(self, test, err):
if self._progress:
self.stream.write("\r")
if self._debug:
raise err[0], err[1], err[2]
self._print_traceback("Failure in test %s" % test, err,
test, self.failures)
def printErrors(self):
if self._progress and not (self.dots or self.showAll):
self.stream.writeln()
self.__super_printErrors()
def printErrorList(self, flavor, errors):
for test, err in errors:
self.stream.writeln(self.separator1)
self.stream.writeln("%s: %s" % (flavor, self.getDescription(test)))
self.stream.writeln(self.separator2)
self.stream.writeln(err)
class ImmediateTestRunner(unittest.TextTestRunner):
__super_init = unittest.TextTestRunner.__init__
def __init__(self, **kwarg):
debug = kwarg.get("debug")
if debug is not None:
del kwarg["debug"]
progress = kwarg.get("progress")
if progress is not None:
del kwarg["progress"]
self.__super_init(**kwarg)
self._debug = debug
self._progress = progress
def _makeResult(self):
return ImmediateTestResult(self.stream, self.descriptions,
self.verbosity, debug=self._debug,
count=self._count, progress=self._progress)
def run(self, test):
self._count = test.countTestCases()
return unittest.TextTestRunner.run(self, test)
# setup list of directories to put on the path
class PathInit:
def __init__(self, build, build_inplace, libdir=None):
self.inplace = None
# Figure out if we should test in-place or test in-build. If the -b
# or -B option was given, test in the place we were told to build in.
# Otherwise, we'll look for a build directory and if we find one,
# we'll test there, otherwise we'll test in-place.
if build:
self.inplace = build_inplace
if self.inplace is None:
# Need to figure it out
if os.path.isdir(os.path.join("build", "lib.%s" % PLAT_SPEC)):
self.inplace = 0
else:
self.inplace = 1
# Calculate which directories we're going to add to sys.path, and cd
# to the appropriate working directory
org_cwd = os.getcwd()
if self.inplace:
self.libdir = "src"
else:
self.libdir = "lib.%s" % PLAT_SPEC
os.chdir("build")
# Hack sys.path
self.cwd = os.getcwd()
sys.path.insert(0, os.path.join(self.cwd, self.libdir))
# Hack again for external products.
global functional
kind = functional and "functional" or "unit"
if libdir:
extra = os.path.join(org_cwd, libdir)
print "Running %s tests from %s" % (kind, extra)
self.libdir = extra
sys.path.insert(0, extra)
else:
print "Running %s tests from %s" % (kind, self.cwd)
# Make sure functional tests find ftesting.zcml
if functional:
config_file = 'ftesting.zcml'
if not self.inplace:
# We chdired into build, so ftesting.zcml is in the
# parent directory
config_file = os.path.join('..', 'ftesting.zcml')
print "Parsing %s" % config_file
from zope.testing.functional import FunctionalTestSetup
FunctionalTestSetup(config_file)
def match(rx, s):
if not rx:
return 1
if rx[0] == "!":
return re.search(rx[1:], s) is None
else:
return re.search(rx, s) is not None
class TestFileFinder:
def __init__(self, prefix):
self.files = []
self._plen = len(prefix)
if not prefix.endswith(os.sep):
self._plen += 1
global functional
if functional:
self.dirname = "ftest"
else:
self.dirname = "test"
def visit(self, rx, dir, files):
if os.path.split(dir)[1] != self.dirname:
return
# ignore tests that aren't in packages
if not "__init__.py" in files:
if not files or files == ["CVS"]:
return
print "not a package", dir
return
# Put matching files in matches. If matches is non-empty,
# then make sure that the package is importable.
matches = []
for file in files:
if file.startswith('test') and os.path.splitext(file)[-1] == '.py':
path = os.path.join(dir, file)
if match(rx, path):
matches.append(path)
# ignore tests when the package can't be imported, possibly due to
# dependency failures.
pkg = dir[self._plen:].replace(os.sep, '.')
try:
__import__(pkg)
# We specifically do not want to catch ImportError since that's useful
# information to know when running the tests.
except RuntimeError, e:
if VERBOSE:
print "skipping %s because: %s" % (pkg, e)
return
else:
self.files.extend(matches)
def module_from_path(self, path):
"""Return the Python package name indicated by the filesystem path."""
assert path.endswith(".py")
path = path[self._plen:-3]
mod = path.replace(os.sep, ".")
return mod
def walk_with_symlinks(top, func, arg):
"""Like os.path.walk, but follows symlinks on POSIX systems.
This could theoreticaly result in an infinite loop, if you create symlink
cycles in your Zope sandbox, so don't do that.
"""
try:
names = os.listdir(top)
except os.error:
return
func(arg, top, names)
exceptions = ('.', '..')
for name in names:
if name not in exceptions:
name = os.path.join(top, name)
if os.path.isdir(name):
walk_with_symlinks(name, func, arg)
def check_test_dir():
global test_dir
if test_dir and not os.path.exists(test_dir):
d = pathinit.libdir
d = os.path.join(d, test_dir)
if os.path.exists(d):
if not os.path.isdir(d):
raise ValueError(
"%s does not exist and %s is not a directory"
% (test_dir, d)
)
test_dir = d
else:
raise ValueError("%s does not exist!" % test_dir)
def find_tests(rx):
global finder
finder = TestFileFinder(pathinit.libdir)
check_test_dir()
walkdir = test_dir or pathinit.libdir
walk_with_symlinks(walkdir, finder.visit, rx)
return finder.files
def package_import(modname):
mod = __import__(modname)
for part in modname.split(".")[1:]:
mod = getattr(mod, part)
return mod
def get_suite(file):
modname = finder.module_from_path(file)
try:
mod = package_import(modname)
except ImportError, err:
# print traceback
print "Error importing %s\n%s" % (modname, err)
traceback.print_exc()
if debug:
raise
return None
try:
suite_func = mod.test_suite
except AttributeError:
print "No test_suite() in %s" % file
return None
return suite_func()
def filter_testcases(s, rx):
new = unittest.TestSuite()
for test in s._tests:
# See if the levels match
dolevel = (level == 0) or level >= getattr(test, "level", 0)
if not dolevel:
continue
if isinstance(test, unittest.TestCase):
name = test.id() # Full test name: package.module.class.method
name = name[1 + name.rfind("."):] # extract method name
if not rx or match(rx, name):
new.addTest(test)
else:
filtered = filter_testcases(test, rx)
if filtered:
new.addTest(filtered)
return new
def gui_runner(files, test_filter):
if build_inplace:
utildir = os.path.join(os.getcwd(), "utilities")
else:
utildir = os.path.join(os.getcwd(), "..", "utilities")
sys.path.append(utildir)
import unittestgui
suites = []
for file in files:
suites.append(finder.module_from_path(file) + ".test_suite")
suites = ", ".join(suites)
minimal = (GUI == "minimal")
# unittestgui apparently doesn't take the minimal flag anymore
unittestgui.main(suites)
class TrackRefs:
"""Object to track reference counts across test runs."""
def __init__(self):
self.type2count = {}
self.type2all = {}
def update(self):
obs = sys.getobjects(0)
type2count = {}
type2all = {}
for o in obs:
all = sys.getrefcount(o)
t = type(o)
if t in type2count:
type2count[t] += 1
type2all[t] += all
else:
type2count[t] = 1
type2all[t] = all
ct = [(type2count[t] - self.type2count.get(t, 0),
type2all[t] - self.type2all.get(t, 0),
t)
for t in type2count.iterkeys()]
ct.sort()
ct.reverse()
for delta1, delta2, t in ct:
if delta1 or delta2:
print "%-55s %8d %8d" % (t, delta1, delta2)
self.type2count = type2count
self.type2all = type2all
def runner(files, test_filter, debug):
runner = ImmediateTestRunner(verbosity=VERBOSE, debug=debug,
progress=progress)
suite = unittest.TestSuite()
for file in files:
s = get_suite(file)
# See if the levels match
dolevel = (level == 0) or level >= getattr(s, "level", 0)
if s is not None and dolevel:
s = filter_testcases(s, test_filter)
suite.addTest(s)
try:
r = runner.run(suite)
if timesfn:
r.print_times(open(timesfn, "w"))
if VERBOSE:
print "Wrote timing data to", timesfn
if timetests:
r.print_times(sys.stdout, timetests)
except:
if debugger:
print "%s:" % (sys.exc_info()[0], )
print sys.exc_info()[1]
pdb.post_mortem(sys.exc_info()[2])
else:
raise
def remove_stale_bytecode(arg, dirname, names):
names = map(os.path.normcase, names)
for name in names:
if name.endswith(".pyc") or name.endswith(".pyo"):
srcname = name[:-1]
if srcname not in names:
fullname = os.path.join(dirname, name)
print "Removing stale bytecode file", fullname
os.unlink(fullname)
def main(module_filter, test_filter, libdir):
if not keepStaleBytecode:
os.path.walk(os.curdir, remove_stale_bytecode, None)
# Get the log.ini file from the current directory instead of possibly
# buried in the build directory. XXX This isn't perfect because if
# log.ini specifies a log file, it'll be relative to the build directory.
# Hmm...
logini = os.path.abspath("log.ini")
from setup import check_manifest
check_manifest()
# Initialize the path and cwd
global pathinit
pathinit = PathInit(build, build_inplace, libdir)
# No logging module in py 2.1
# # Initialize the logging module.
# import logging.config
# logging.basicConfig()
# level = os.getenv("LOGGING")
# if level:
# level = int(level)
# else:
# level = logging.CRITICAL
# logging.root.setLevel(level)
# if os.path.exists(logini):
# logging.config.fileConfig(logini)
files = find_tests(module_filter)
files.sort()
if GUI:
gui_runner(files, test_filter)
elif LOOP:
if REFCOUNT:
rc = sys.gettotalrefcount()
track = TrackRefs()
while 1:
runner(files, test_filter, debug)
gc.collect()
if gc.garbage:
print "GARBAGE:", len(gc.garbage), gc.garbage
return
if REFCOUNT:
prev = rc
rc = sys.gettotalrefcount()
print "totalrefcount=%-8d change=%-6d" % (rc, rc - prev)
track.update()
else:
runner(files, test_filter, debug)
def process_args(argv=None):
import getopt
global module_filter
global test_filter
global VERBOSE
global LOOP
global GUI
global TRACE
global REFCOUNT
global debug
global debugger
global build
global level
global libdir
global timesfn
global timetests
global progress
global build_inplace
global keepStaleBytecode
global functional
global test_dir
if argv is None:
argv = sys.argv
module_filter = None
test_filter = None
VERBOSE = 2
LOOP = 0
GUI = 0
TRACE = 0
REFCOUNT = 0
debug = 0 # Don't collect test results; simply let tests crash
debugger = 0
build = 0
build_inplace = 0
gcthresh = None
gcdebug = 0
gcflags = []
level = 1
libdir = '.'
progress = 0
timesfn = None
timetests = 0
keepStaleBytecode = 0
functional = 0
test_dir = None
try:
opts, args = getopt.getopt(argv[1:], "a:bBcdDfg:G:hLmprtTuv",
["all", "help", "libdir=", "times=",
"keepbytecode", "dir=", "build"])
except getopt.error, msg:
print msg
print "Try `python %s -h' for more information." % argv[0]
sys.exit(2)
for k, v in opts:
if k == "-a":
level = int(v)
elif k == "--all":
level = 0
os.environ["COMPLAIN_IF_TESTS_MISSED"]='1'
elif k in ("-b", "--build"):
build = 1
elif k == "-B":
build = build_inplace = 1
elif k == "-c":
# make sure you have a recent version of pychecker
if not os.environ.get("PYCHECKER"):
os.environ["PYCHECKER"] = "-q"
import pychecker.checker
elif k == "-d":
debug = 1
elif k == "-D":
debug = 1
debugger = 1
elif k == "-f":
functional = 1
elif k in ("-h", "--help"):
print __doc__
sys.exit(0)
elif k == "-g":
gcthresh = int(v)
elif k == "-G":
if not v.startswith("DEBUG_"):
print "-G argument must be DEBUG_ flag, not", repr(v)
sys.exit(1)
gcflags.append(v)
elif k == '--keepbytecode':
keepStaleBytecode = 1
elif k == '--libdir':
libdir = v
elif k == "-L":
LOOP = 1
elif k == "-m":
GUI = "minimal"
elif k == "-p":
progress = 1
elif k == "-r":
if hasattr(sys, "gettotalrefcount"):
REFCOUNT = 1
else:
print "-r ignored, because it needs a debug build of Python"
elif k == "-T":
TRACE = 1
elif k == "-t":
if not timetests:
timetests = 50
elif k == "-u":
GUI = 1
elif k == "-v":
VERBOSE += 1
elif k == "--times":
try:
timetests = int(v)
except ValueError:
# must be a filename to write
timesfn = v
elif k == '--dir':
test_dir = v
if gcthresh is not None:
if gcthresh == 0:
gc.disable()
print "gc disabled"
else:
gc.set_threshold(gcthresh)
print "gc threshold:", gc.get_threshold()
if gcflags:
val = 0
for flag in gcflags:
v = getattr(gc, flag, None)
if v is None:
print "Unknown gc flag", repr(flag)
print gc.set_debug.__doc__
sys.exit(1)
val |= v
gcdebug |= v
if gcdebug:
gc.set_debug(gcdebug)
if build:
# Python 2.3 is more sane in its non -q output
if sys.hexversion >= 0x02030000:
qflag = ""
else:
qflag = "-q"
cmd = sys.executable + " setup.py " + qflag + " build"
if build_inplace:
cmd += "_ext -i"
if VERBOSE:
print cmd
sts = os.system(cmd)
if sts:
print "Build failed", hex(sts)
sys.exit(1)
if VERBOSE:
kind = functional and "functional" or "unit"
if level == 0:
print "Running %s tests at all levels" % kind
else:
print "Running %s tests at level %d" % (kind, level)
# XXX We want to change *visible* warnings into errors. The next
# line changes all warnings into errors, including warnings we
# normally never see. In particular, test_datetime does some
# short-integer arithmetic that overflows to long ints, and, by
# default, Python doesn't display the overflow warning that can
# be enabled when this happens. The next line turns that into an
# error instead. Guido suggests that a better to get what we're
# after is to replace warnings.showwarning() with our own thing
# that raises an error.
## warnings.filterwarnings("error")
warnings.filterwarnings("ignore", module="logging")
if args:
if len(args) > 1:
test_filter = args[1]
module_filter = args[0]
try:
if TRACE:
# if the trace module is used, then we don't exit with
# status if on a false return value from main.
coverdir = os.path.join(os.getcwd(), "coverage")
import trace
ignoremods = ["os", "posixpath", "stat"]
tracer = trace.Trace(ignoredirs=[sys.prefix, sys.exec_prefix],
ignoremods=ignoremods,
trace=0, count=1)
tracer.runctx("main(module_filter, test_filter, libdir)",
globals=globals(), locals=vars())
r = tracer.results()
path = "/tmp/trace.%s" % os.getpid()
import cPickle
f = open(path, "wb")
cPickle.dump(r, f)
f.close()
print path
r.write_results(show_missing=1, summary=1, coverdir=coverdir)
else:
bad = main(module_filter, test_filter, libdir)
if bad:
sys.exit(1)
except ImportError, err:
print err
print sys.path
raise
if __name__ == "__main__":
process_args()
Jump to Line
Something went wrong with that request. Please try again.