| #! /usr/bin/env python |
| |
| """Regression test. |
| |
| This will find all modules whose name is "test_*" in the test |
| directory, and run them. Various command line options provide |
| additional facilities. |
| |
| Command line options: |
| |
| -h/--help -- print this text and exit |
| |
| Verbosity |
| |
| -v/--verbose -- run tests in verbose mode with output to stdout |
| -w/--verbose2 -- re-run failed tests in verbose mode |
| -W/--verbose3 -- re-run failed tests in verbose mode immediately |
| -q/--quiet -- don't print anything except if a test fails |
| -S/--slow -- print the slowest 10 tests |
| |
| Selecting tests |
| |
| -r/--random -- randomize test execution order |
| -f/--fromfile -- read names of tests to run from a file (see below) |
| -x/--exclude -- arguments are tests to *exclude* |
| -s/--single -- run only a single test (see below) |
| -u/--use RES1,RES2,... |
| -- specify which special resource intensive tests to run |
| -M/--memlimit LIMIT |
| -- run very large memory-consuming tests |
| |
| Special runs |
| |
| -l/--findleaks -- if GC is available detect tests that leak memory |
| -L/--runleaks -- run the leaks(1) command just before exit |
| -R/--huntrleaks RUNCOUNTS |
| -- search for reference leaks (needs debug build, v. slow) |
| -j/--multiprocess PROCESSES |
| -- run PROCESSES processes at once |
| -T/--coverage -- turn on code coverage using the trace module |
| -D/--coverdir DIRECTORY |
| -- Directory where coverage files are put |
| -N/--nocoverdir -- Put coverage files alongside modules |
| -t/--threshold THRESHOLD |
| -- call gc.set_threshold(THRESHOLD) |
| -F/--forever -- run the selected tests in a loop, until an error happens |
| |
| If non-option arguments are present, they are names for tests to run, |
| unless -x is given, in which case they are names for tests not to run. |
| If no test names are given, all tests are run. |
| |
| -r randomizes test execution order. You can use --randseed=int to provide a |
| int seed value for the randomizer; this is useful for reproducing troublesome |
| test orders. |
| |
| -T turns on code coverage tracing with the trace module. |
| |
| -D specifies the directory where coverage files are put. |
| |
| -N Put coverage files alongside modules. |
| |
| -s means to run only a single test and exit. This is useful when |
| doing memory analysis on the Python interpreter (which tend to consume |
| too many resources to run the full regression test non-stop). The |
| file /tmp/pynexttest is read to find the next test to run. If this |
| file is missing, the first test_*.py file in testdir or on the command |
| line is used. (actually tempfile.gettempdir() is used instead of |
| /tmp). |
| |
| -f reads the names of tests from the file given as f's argument, one |
| or more test names per line. Whitespace is ignored. Blank lines and |
| lines beginning with '#' are ignored. This is especially useful for |
| whittling down failures involving interactions among tests. |
| |
| -L causes the leaks(1) command to be run just before exit if it exists. |
| leaks(1) is available on Mac OS X and presumably on some other |
| FreeBSD-derived systems. |
| |
| -R runs each test several times and examines sys.gettotalrefcount() to |
| see if the test appears to be leaking references. The argument should |
| be of the form stab:run:fname where 'stab' is the number of times the |
| test is run to let gettotalrefcount settle down, 'run' is the number |
| of times further it is run and 'fname' is the name of the file the |
| reports are written to. These parameters all have defaults (5, 4 and |
| "reflog.txt" respectively), so the minimal invocation is '-R ::'. |
| |
| -M runs tests that require an exorbitant amount of memory. These tests |
| typically try to ascertain containers keep working when containing more than |
| 2 billion objects, which only works on 64-bit systems. There are also some |
| tests that try to exhaust the address space of the process, which only makes |
| sense on 32-bit systems with at least 2Gb of memory. The passed-in memlimit, |
| which is a string in the form of '2.5Gb', determines howmuch memory the |
| tests will limit themselves to (but they may go slightly over.) The number |
| shouldn't be more memory than the machine has (including swap memory). You |
| should also keep in mind that swap memory is generally much, much slower |
| than RAM, and setting memlimit to all available RAM or higher will heavily |
| tax the machine. On the other hand, it is no use running these tests with a |
| limit of less than 2.5Gb, and many require more than 20Gb. Tests that expect |
| to use more than memlimit memory will be skipped. The big-memory tests |
| generally run very, very long. |
| |
| -u is used to specify which special resource intensive tests to run, |
| such as those requiring large file support or network connectivity. |
| The argument is a comma-separated list of words indicating the |
| resources to test. Currently only the following are defined: |
| |
| all - Enable all special resources. |
| |
| audio - Tests that use the audio device. (There are known |
| cases of broken audio drivers that can crash Python or |
| even the Linux kernel.) |
| |
| curses - Tests that use curses and will modify the terminal's |
| state and output modes. |
| |
| largefile - It is okay to run some test that may create huge |
| files. These tests can take a long time and may |
| consume >2GB of disk space temporarily. |
| |
| network - It is okay to run tests that use external network |
| resource, e.g. testing SSL support for sockets. |
| |
| bsddb - It is okay to run the bsddb testsuite, which takes |
| a long time to complete. |
| |
| decimal - Test the decimal module against a large suite that |
| verifies compliance with standards. |
| |
| compiler - Test the compiler package by compiling all the source |
| in the standard library and test suite. This takes |
| a long time. Enabling this resource also allows |
| test_tokenize to verify round-trip lexing on every |
| file in the test library. |
| |
| subprocess Run all tests for the subprocess module. |
| |
| urlfetch - It is okay to download files required on testing. |
| |
| gui - Run tests that require a running GUI. |
| |
| xpickle - Test pickle and cPickle against Python 2.4, 2.5 and 2.6 to |
| test backwards compatibility. These tests take a long time |
| to run. |
| |
| To enable all resources except one, use '-uall,-<resource>'. For |
| example, to run all the tests except for the bsddb tests, give the |
| option '-uall,-bsddb'. |
| """ |
| |
| import cStringIO |
| import getopt |
| import itertools |
| import json |
| import os |
| import random |
| import re |
| import sys |
| import time |
| import traceback |
| import warnings |
| import unittest |
| import imp |
| |
| |
| # Ignore ImportWarnings that only occur in the source tree, |
| # (because of modules with the same name as source-directories in Modules/) |
| for mod in ("ctypes", "gzip", "zipfile", "tarfile", "encodings.zlib_codec", |
| "test.test_zipimport", "test.test_zlib", "test.test_zipfile", |
| "test.test_codecs", "test.string_tests"): |
| warnings.filterwarnings(module=".*%s$" % (mod,), |
| action="ignore", category=ImportWarning) |
| |
| # MacOSX (a.k.a. Darwin) has a default stack size that is too small |
| # for deeply recursive regular expressions. We see this as crashes in |
| # the Python test suite when running test_re.py and test_sre.py. The |
| # fix is to set the stack limit to 2048. |
| # This approach may also be useful for other Unixy platforms that |
| # suffer from small default stack limits. |
| if sys.platform == 'darwin': |
| try: |
| import resource |
| except ImportError: |
| pass |
| else: |
| soft, hard = resource.getrlimit(resource.RLIMIT_STACK) |
| newsoft = min(hard, max(soft, 1024*2048)) |
| resource.setrlimit(resource.RLIMIT_STACK, (newsoft, hard)) |
| |
| # Test result constants. |
| PASSED = 1 |
| FAILED = 0 |
| ENV_CHANGED = -1 |
| SKIPPED = -2 |
| RESOURCE_DENIED = -3 |
| INTERRUPTED = -4 |
| |
| from test import test_support |
| |
| RESOURCE_NAMES = ('audio', 'curses', 'largefile', 'network', 'bsddb', |
| 'decimal', 'compiler', 'subprocess', 'urlfetch', 'gui', |
| 'xpickle') |
| |
| |
| def usage(code, msg=''): |
| print __doc__ |
| if msg: print msg |
| sys.exit(code) |
| |
| |
| def main(tests=None, testdir=None, verbose=0, quiet=False, |
| exclude=False, single=False, randomize=False, fromfile=None, |
| findleaks=False, use_resources=None, trace=False, coverdir='coverage', |
| runleaks=False, huntrleaks=False, verbose2=False, print_slow=False, |
| random_seed=None, use_mp=None, verbose3=False, forever=False): |
| """Execute a test suite. |
| |
| This also parses command-line options and modifies its behavior |
| accordingly. |
| |
| tests -- a list of strings containing test names (optional) |
| testdir -- the directory in which to look for tests (optional) |
| |
| Users other than the Python test suite will certainly want to |
| specify testdir; if it's omitted, the directory containing the |
| Python test suite is searched for. |
| |
| If the tests argument is omitted, the tests listed on the |
| command-line will be used. If that's empty, too, then all *.py |
| files beginning with test_ will be used. |
| |
| The other default arguments (verbose, quiet, exclude, |
| single, randomize, findleaks, use_resources, trace, coverdir, print_slow and |
| random_seed) allow programmers calling main() directly to set the |
| values that would normally be set by flags on the command line. |
| """ |
| |
| test_support.record_original_stdout(sys.stdout) |
| try: |
| opts, args = getopt.getopt(sys.argv[1:], 'hvqxsSrf:lu:t:TD:NLR:FwWM:j:', |
| ['help', 'verbose', 'verbose2', 'verbose3', 'quiet', |
| 'exclude', 'single', 'slow', 'random', 'fromfile', 'findleaks', |
| 'use=', 'threshold=', 'trace', 'coverdir=', 'nocoverdir', |
| 'runleaks', 'huntrleaks=', 'memlimit=', 'randseed=', |
| 'multiprocess=', 'slaveargs=', 'forever']) |
| except getopt.error, msg: |
| usage(2, msg) |
| |
| # Defaults |
| if random_seed is None: |
| random_seed = random.randrange(10000000) |
| if use_resources is None: |
| use_resources = [] |
| for o, a in opts: |
| if o in ('-h', '--help'): |
| usage(0) |
| elif o in ('-v', '--verbose'): |
| verbose += 1 |
| elif o in ('-w', '--verbose2'): |
| verbose2 = True |
| elif o in ('-W', '--verbose3'): |
| verbose3 = True |
| elif o in ('-q', '--quiet'): |
| quiet = True; |
| verbose = 0 |
| elif o in ('-x', '--exclude'): |
| exclude = True |
| elif o in ('-s', '--single'): |
| single = True |
| elif o in ('-S', '--slow'): |
| print_slow = True |
| elif o in ('-r', '--randomize'): |
| randomize = True |
| elif o == '--randseed': |
| random_seed = int(a) |
| elif o in ('-f', '--fromfile'): |
| fromfile = a |
| elif o in ('-l', '--findleaks'): |
| findleaks = True |
| elif o in ('-L', '--runleaks'): |
| runleaks = True |
| elif o in ('-t', '--threshold'): |
| import gc |
| gc.set_threshold(int(a)) |
| elif o in ('-T', '--coverage'): |
| trace = True |
| elif o in ('-D', '--coverdir'): |
| coverdir = os.path.join(os.getcwd(), a) |
| elif o in ('-N', '--nocoverdir'): |
| coverdir = None |
| elif o in ('-R', '--huntrleaks'): |
| huntrleaks = a.split(':') |
| if len(huntrleaks) != 3: |
| print a, huntrleaks |
| usage(2, '-R takes three colon-separated arguments') |
| if len(huntrleaks[0]) == 0: |
| huntrleaks[0] = 5 |
| else: |
| huntrleaks[0] = int(huntrleaks[0]) |
| if len(huntrleaks[1]) == 0: |
| huntrleaks[1] = 4 |
| else: |
| huntrleaks[1] = int(huntrleaks[1]) |
| if len(huntrleaks[2]) == 0: |
| huntrleaks[2] = "reflog.txt" |
| elif o in ('-M', '--memlimit'): |
| test_support.set_memlimit(a) |
| elif o in ('-u', '--use'): |
| u = [x.lower() for x in a.split(',')] |
| for r in u: |
| if r == 'all': |
| use_resources[:] = RESOURCE_NAMES |
| continue |
| remove = False |
| if r[0] == '-': |
| remove = True |
| r = r[1:] |
| if r not in RESOURCE_NAMES: |
| usage(1, 'Invalid -u/--use option: ' + a) |
| if remove: |
| if r in use_resources: |
| use_resources.remove(r) |
| elif r not in use_resources: |
| use_resources.append(r) |
| elif o in ('-F', '--forever'): |
| forever = True |
| elif o in ('-j', '--multiprocess'): |
| use_mp = int(a) |
| elif o == '--slaveargs': |
| args, kwargs = json.loads(a) |
| try: |
| result = runtest(*args, **kwargs) |
| except BaseException, e: |
| result = INTERRUPTED, e.__class__.__name__ |
| print # Force a newline (just in case) |
| print json.dumps(result) |
| sys.exit(0) |
| else: |
| print >>sys.stderr, ("No handler for option {}. Please " |
| "report this as a bug at http://bugs.python.org.").format(o) |
| sys.exit(1) |
| if single and fromfile: |
| usage(2, "-s and -f don't go together!") |
| if use_mp and trace: |
| usage(2, "-T and -j don't go together!") |
| if use_mp and findleaks: |
| usage(2, "-l and -j don't go together!") |
| |
| good = [] |
| bad = [] |
| skipped = [] |
| resource_denieds = [] |
| environment_changed = [] |
| |
| if findleaks: |
| try: |
| import gc |
| except ImportError: |
| print 'No GC available, disabling findleaks.' |
| findleaks = False |
| else: |
| # Uncomment the line below to report garbage that is not |
| # freeable by reference counting alone. By default only |
| # garbage that is not collectable by the GC is reported. |
| #gc.set_debug(gc.DEBUG_SAVEALL) |
| found_garbage = [] |
| |
| if single: |
| from tempfile import gettempdir |
| filename = os.path.join(gettempdir(), 'pynexttest') |
| try: |
| fp = open(filename, 'r') |
| next_test = fp.read().strip() |
| tests = [next_test] |
| fp.close() |
| except IOError: |
| pass |
| |
| if fromfile: |
| tests = [] |
| fp = open(fromfile) |
| for line in fp: |
| guts = line.split() # assuming no test has whitespace in its name |
| if guts and not guts[0].startswith('#'): |
| tests.extend(guts) |
| fp.close() |
| |
| # Strip .py extensions. |
| if args: |
| args = map(removepy, args) |
| if tests: |
| tests = map(removepy, tests) |
| |
| stdtests = STDTESTS[:] |
| nottests = NOTTESTS[:] |
| if exclude: |
| for arg in args: |
| if arg in stdtests: |
| stdtests.remove(arg) |
| nottests[:0] = args |
| args = [] |
| alltests = findtests(testdir, stdtests, nottests) |
| tests = tests or args or alltests |
| if single: |
| tests = tests[:1] |
| try: |
| next_single_test = alltests[alltests.index(tests[0])+1] |
| except IndexError: |
| next_single_test = None |
| if randomize: |
| random.seed(random_seed) |
| print "Using random seed", random_seed |
| random.shuffle(tests) |
| if trace: |
| import trace |
| tracer = trace.Trace(ignoredirs=[sys.prefix, sys.exec_prefix], |
| trace=False, count=True) |
| |
| test_times = [] |
| test_support.use_resources = use_resources |
| save_modules = sys.modules.keys() |
| |
| def accumulate_result(test, result): |
| ok, test_time = result |
| test_times.append((test_time, test)) |
| if ok == PASSED: |
| good.append(test) |
| elif ok == FAILED: |
| bad.append(test) |
| elif ok == ENV_CHANGED: |
| bad.append(test) |
| environment_changed.append(test) |
| elif ok == SKIPPED: |
| skipped.append(test) |
| elif ok == RESOURCE_DENIED: |
| skipped.append(test) |
| resource_denieds.append(test) |
| |
| if forever: |
| def test_forever(tests=list(tests)): |
| while True: |
| for test in tests: |
| yield test |
| if bad: |
| return |
| tests = test_forever() |
| else: |
| tests = iter(tests) |
| |
| if use_mp: |
| from threading import Thread |
| from Queue import Queue, Empty |
| from subprocess import Popen, PIPE, STDOUT |
| from collections import deque |
| debug_output_pat = re.compile(r"\[\d+ refs\]$") |
| pending = deque() |
| output = Queue() |
| def tests_and_args(): |
| for test in tests: |
| args_tuple = ( |
| (test, verbose, quiet, testdir), |
| dict(huntrleaks=huntrleaks, use_resources=use_resources) |
| ) |
| yield (test, args_tuple) |
| pending = tests_and_args() |
| def work(): |
| # A worker thread. |
| try: |
| while True: |
| try: |
| test, args_tuple = next(pending) |
| except StopIteration: |
| output.put((None, None, None, None)) |
| return |
| # -E is needed by some tests, e.g. test_import |
| popen = Popen([sys.executable, '-E', '-m', 'test.regrtest', |
| '--slaveargs', json.dumps(args_tuple)], |
| stdout=PIPE, stderr=PIPE, |
| universal_newlines=True, close_fds=True) |
| stdout, stderr = popen.communicate() |
| # Strip last refcount output line if it exists, since it |
| # comes from the shutdown of the interpreter in the subcommand. |
| stderr = debug_output_pat.sub("", stderr) |
| stdout, _, result = stdout.strip().rpartition("\n") |
| if not result: |
| output.put((None, None, None, None)) |
| return |
| result = json.loads(result) |
| if not quiet: |
| stdout = test+'\n'+stdout |
| output.put((test, stdout.rstrip(), stderr.rstrip(), result)) |
| except BaseException: |
| output.put((None, None, None, None)) |
| raise |
| workers = [Thread(target=work) for i in range(use_mp)] |
| for worker in workers: |
| worker.start() |
| finished = 0 |
| try: |
| while finished < use_mp: |
| test, stdout, stderr, result = output.get() |
| if test is None: |
| finished += 1 |
| continue |
| if stdout: |
| print stdout |
| if stderr: |
| print >>sys.stderr, stderr |
| if result[0] == INTERRUPTED: |
| assert result[1] == 'KeyboardInterrupt' |
| raise KeyboardInterrupt # What else? |
| accumulate_result(test, result) |
| except KeyboardInterrupt: |
| pending.close() |
| for worker in workers: |
| worker.join() |
| else: |
| for test in tests: |
| if not quiet: |
| print test |
| sys.stdout.flush() |
| if trace: |
| # If we're tracing code coverage, then we don't exit with status |
| # if on a false return value from main. |
| tracer.runctx('runtest(test, verbose, quiet, testdir)', |
| globals=globals(), locals=vars()) |
| else: |
| try: |
| result = runtest(test, verbose, quiet, |
| testdir, huntrleaks) |
| accumulate_result(test, result) |
| if verbose3 and result[0] == FAILED: |
| print "Re-running test %r in verbose mode" % test |
| runtest(test, True, quiet, testdir, huntrleaks) |
| except KeyboardInterrupt: |
| # print a newline separate from the ^C |
| print |
| break |
| except: |
| raise |
| if findleaks: |
| gc.collect() |
| if gc.garbage: |
| print "Warning: test created", len(gc.garbage), |
| print "uncollectable object(s)." |
| # move the uncollectable objects somewhere so we don't see |
| # them again |
| found_garbage.extend(gc.garbage) |
| del gc.garbage[:] |
| # Unload the newly imported modules (best effort finalization) |
| for module in sys.modules.keys(): |
| if module not in save_modules and module.startswith("test."): |
| test_support.unload(module) |
| |
| # The lists won't be sorted if running with -r |
| good.sort() |
| bad.sort() |
| skipped.sort() |
| environment_changed.sort() |
| |
| if good and not quiet: |
| if not bad and not skipped and len(good) > 1: |
| print "All", |
| print count(len(good), "test"), "OK." |
| if print_slow: |
| test_times.sort(reverse=True) |
| print "10 slowest tests:" |
| for time, test in test_times[:10]: |
| print "%s: %.1fs" % (test, time) |
| if bad: |
| bad = set(bad) - set(environment_changed) |
| if bad: |
| print count(len(bad), "test"), "failed:" |
| printlist(bad) |
| if environment_changed: |
| print "{} altered the execution environment:".format( |
| count(len(environment_changed), "test")) |
| printlist(environment_changed) |
| if skipped and not quiet: |
| print count(len(skipped), "test"), "skipped:" |
| printlist(skipped) |
| |
| e = _ExpectedSkips() |
| plat = sys.platform |
| if e.isvalid(): |
| surprise = set(skipped) - e.getexpected() - set(resource_denieds) |
| if surprise: |
| print count(len(surprise), "skip"), \ |
| "unexpected on", plat + ":" |
| printlist(surprise) |
| else: |
| print "Those skips are all expected on", plat + "." |
| else: |
| print "Ask someone to teach regrtest.py about which tests are" |
| print "expected to get skipped on", plat + "." |
| |
| if verbose2 and bad: |
| print "Re-running failed tests in verbose mode" |
| for test in bad: |
| print "Re-running test %r in verbose mode" % test |
| sys.stdout.flush() |
| try: |
| test_support.verbose = True |
| ok = runtest(test, True, quiet, testdir, |
| huntrleaks) |
| except KeyboardInterrupt: |
| # print a newline separate from the ^C |
| print |
| break |
| except: |
| raise |
| |
| if single: |
| if next_single_test: |
| with open(filename, 'w') as fp: |
| fp.write(next_single_test + '\n') |
| else: |
| os.unlink(filename) |
| |
| if trace: |
| r = tracer.results() |
| r.write_results(show_missing=True, summary=True, coverdir=coverdir) |
| |
| if runleaks: |
| os.system("leaks %d" % os.getpid()) |
| |
| sys.exit(len(bad) > 0) |
| |
| |
| STDTESTS = [ |
| 'test_grammar', |
| 'test_opcodes', |
| 'test_dict', |
| 'test_builtin', |
| 'test_exceptions', |
| 'test_types', |
| 'test_unittest', |
| 'test_doctest', |
| 'test_doctest2', |
| ] |
| |
| NOTTESTS = [ |
| 'test_support', |
| 'test_future1', |
| 'test_future2', |
| ] |
| |
| def findtests(testdir=None, stdtests=STDTESTS, nottests=NOTTESTS): |
| """Return a list of all applicable test modules.""" |
| if not testdir: testdir = findtestdir() |
| names = os.listdir(testdir) |
| tests = [] |
| for name in names: |
| if name[:5] == "test_" and name[-3:] == os.extsep+"py": |
| modname = name[:-3] |
| if modname not in stdtests and modname not in nottests: |
| tests.append(modname) |
| tests.sort() |
| return stdtests + tests |
| |
| def runtest(test, verbose, quiet, |
| testdir=None, huntrleaks=False, use_resources=None): |
| """Run a single test. |
| |
| test -- the name of the test |
| verbose -- if true, print more messages |
| quiet -- if true, don't print 'skipped' messages (probably redundant) |
| test_times -- a list of (time, test_name) pairs |
| testdir -- test directory |
| huntrleaks -- run multiple times to test for leaks; requires a debug |
| build; a triple corresponding to -R's three arguments |
| Returns one of the test result constants: |
| INTERRUPTED KeyboardInterrupt when run under -j |
| RESOURCE_DENIED test skipped because resource denied |
| SKIPPED test skipped for some other reason |
| ENV_CHANGED test failed because it changed the execution environment |
| FAILED test failed |
| PASSED test passed |
| """ |
| |
| test_support.verbose = verbose # Tell tests to be moderately quiet |
| if use_resources is not None: |
| test_support.use_resources = use_resources |
| try: |
| return runtest_inner(test, verbose, quiet, |
| testdir, huntrleaks) |
| finally: |
| cleanup_test_droppings(test, verbose) |
| |
| |
| # Unit tests are supposed to leave the execution environment unchanged |
| # once they complete. But sometimes tests have bugs, especially when |
| # tests fail, and the changes to environment go on to mess up other |
| # tests. This can cause issues with buildbot stability, since tests |
| # are run in random order and so problems may appear to come and go. |
| # There are a few things we can save and restore to mitigate this, and |
| # the following context manager handles this task. |
| |
| class saved_test_environment: |
| """Save bits of the test environment and restore them at block exit. |
| |
| with saved_test_environment(testname, verbose, quiet): |
| #stuff |
| |
| Unless quiet is True, a warning is printed to stderr if any of |
| the saved items was changed by the test. The attribute 'changed' |
| is initially False, but is set to True if a change is detected. |
| |
| If verbose is more than 1, the before and after state of changed |
| items is also printed. |
| """ |
| |
| changed = False |
| |
| def __init__(self, testname, verbose=0, quiet=False): |
| self.testname = testname |
| self.verbose = verbose |
| self.quiet = quiet |
| |
| # To add things to save and restore, add a name XXX to the resources list |
| # and add corresponding get_XXX/restore_XXX functions. get_XXX should |
| # return the value to be saved and compared against a second call to the |
| # get function when test execution completes. restore_XXX should accept |
| # the saved value and restore the resource using it. It will be called if |
| # and only if a change in the value is detected. |
| # |
| # Note: XXX will have any '.' replaced with '_' characters when determining |
| # the corresponding method names. |
| |
| resources = ('sys.argv', 'cwd', 'sys.stdin', 'sys.stdout', 'sys.stderr', |
| 'os.environ', 'sys.path') |
| |
| def get_sys_argv(self): |
| return id(sys.argv), sys.argv, sys.argv[:] |
| def restore_sys_argv(self, saved_argv): |
| sys.argv = saved_argv[1] |
| sys.argv[:] = saved_argv[2] |
| |
| def get_cwd(self): |
| return os.getcwd() |
| def restore_cwd(self, saved_cwd): |
| os.chdir(saved_cwd) |
| |
| def get_sys_stdout(self): |
| return sys.stdout |
| def restore_sys_stdout(self, saved_stdout): |
| sys.stdout = saved_stdout |
| |
| def get_sys_stderr(self): |
| return sys.stderr |
| def restore_sys_stderr(self, saved_stderr): |
| sys.stderr = saved_stderr |
| |
| def get_sys_stdin(self): |
| return sys.stdin |
| def restore_sys_stdin(self, saved_stdin): |
| sys.stdin = saved_stdin |
| |
| def get_os_environ(self): |
| return id(os.environ), os.environ, dict(os.environ) |
| def restore_os_environ(self, saved_environ): |
| os.environ = saved_environ[1] |
| os.environ.clear() |
| os.environ.update(saved_environ[2]) |
| |
| def get_sys_path(self): |
| return id(sys.path), sys.path, sys.path[:] |
| def restore_sys_path(self, saved_path): |
| sys.path = saved_path[1] |
| sys.path[:] = saved_path[2] |
| |
| def resource_info(self): |
| for name in self.resources: |
| method_suffix = name.replace('.', '_') |
| get_name = 'get_' + method_suffix |
| restore_name = 'restore_' + method_suffix |
| yield name, getattr(self, get_name), getattr(self, restore_name) |
| |
| def __enter__(self): |
| self.saved_values = dict((name, get()) for name, get, restore |
| in self.resource_info()) |
| return self |
| |
| def __exit__(self, exc_type, exc_val, exc_tb): |
| for name, get, restore in self.resource_info(): |
| current = get() |
| original = self.saved_values[name] |
| # Check for changes to the resource's value |
| if current != original: |
| self.changed = True |
| restore(original) |
| if not self.quiet: |
| print >>sys.stderr, ( |
| "Warning -- {} was modified by {}".format( |
| name, self.testname)) |
| if self.verbose > 1: |
| print >>sys.stderr, ( |
| " Before: {}\n After: {} ".format( |
| original, current)) |
| # XXX (ncoghlan): for most resources (e.g. sys.path) identity |
| # matters at least as much as value. For others (e.g. cwd), |
| # identity is irrelevant. Should we add a mechanism to check |
| # for substitution in the cases where it matters? |
| return False |
| |
| |
| def runtest_inner(test, verbose, quiet, |
| testdir=None, huntrleaks=False): |
| test_support.unload(test) |
| if not testdir: |
| testdir = findtestdir() |
| if verbose: |
| capture_stdout = None |
| else: |
| capture_stdout = cStringIO.StringIO() |
| |
| test_time = 0.0 |
| refleak = False # True if the test leaked references. |
| try: |
| save_stdout = sys.stdout |
| try: |
| if capture_stdout: |
| sys.stdout = capture_stdout |
| if test.startswith('test.'): |
| abstest = test |
| else: |
| # Always import it from the test package |
| abstest = 'test.' + test |
| with saved_test_environment(test, verbose, quiet) as environment: |
| start_time = time.time() |
| the_package = __import__(abstest, globals(), locals(), []) |
| the_module = getattr(the_package, test) |
| # Old tests run to completion simply as a side-effect of |
| # being imported. For tests based on unittest or doctest, |
| # explicitly invoke their test_main() function (if it exists). |
| indirect_test = getattr(the_module, "test_main", None) |
| if indirect_test is not None: |
| indirect_test() |
| if huntrleaks: |
| refleak = dash_R(the_module, test, indirect_test, |
| huntrleaks) |
| test_time = time.time() - start_time |
| finally: |
| sys.stdout = save_stdout |
| except test_support.ResourceDenied, msg: |
| if not quiet: |
| print test, "skipped --", msg |
| sys.stdout.flush() |
| return RESOURCE_DENIED, test_time |
| except unittest.SkipTest, msg: |
| if not quiet: |
| print test, "skipped --", msg |
| sys.stdout.flush() |
| return SKIPPED, test_time |
| except KeyboardInterrupt: |
| raise |
| except test_support.TestFailed, msg: |
| print "test", test, "failed --", msg |
| sys.stdout.flush() |
| return FAILED, test_time |
| except: |
| type, value = sys.exc_info()[:2] |
| print "test", test, "crashed --", str(type) + ":", value |
| sys.stdout.flush() |
| if verbose: |
| traceback.print_exc(file=sys.stdout) |
| sys.stdout.flush() |
| return FAILED, test_time |
| else: |
| if refleak: |
| return FAILED, test_time |
| if environment.changed: |
| return ENV_CHANGED, test_time |
| # Except in verbose mode, tests should not print anything |
| if verbose or huntrleaks: |
| return PASSED, test_time |
| output = capture_stdout.getvalue() |
| if not output: |
| return PASSED, test_time |
| print "test", test, "produced unexpected output:" |
| print "*" * 70 |
| print output |
| print "*" * 70 |
| sys.stdout.flush() |
| return FAILED, test_time |
| |
| def cleanup_test_droppings(testname, verbose): |
| import shutil |
| import stat |
| |
| # Try to clean up junk commonly left behind. While tests shouldn't leave |
| # any files or directories behind, when a test fails that can be tedious |
| # for it to arrange. The consequences can be especially nasty on Windows, |
| # since if a test leaves a file open, it cannot be deleted by name (while |
| # there's nothing we can do about that here either, we can display the |
| # name of the offending test, which is a real help). |
| for name in (test_support.TESTFN, |
| "db_home", |
| ): |
| if not os.path.exists(name): |
| continue |
| |
| if os.path.isdir(name): |
| kind, nuker = "directory", shutil.rmtree |
| elif os.path.isfile(name): |
| kind, nuker = "file", os.unlink |
| else: |
| raise SystemError("os.path says %r exists but is neither " |
| "directory nor file" % name) |
| |
| if verbose: |
| print "%r left behind %s %r" % (testname, kind, name) |
| try: |
| # if we have chmod, fix possible permissions problems |
| # that might prevent cleanup |
| if (hasattr(os, 'chmod')): |
| os.chmod(name, stat.S_IRWXU | stat.S_IRWXG | stat.S_IRWXO) |
| nuker(name) |
| except Exception, msg: |
| print >> sys.stderr, ("%r left behind %s %r and it couldn't be " |
| "removed: %s" % (testname, kind, name, msg)) |
| |
| def dash_R(the_module, test, indirect_test, huntrleaks): |
| """Run a test multiple times, looking for reference leaks. |
| |
| Returns: |
| False if the test didn't leak references; True if we detected refleaks. |
| """ |
| # This code is hackish and inelegant, but it seems to do the job. |
| import copy_reg, _abcoll, _pyio |
| |
| if not hasattr(sys, 'gettotalrefcount'): |
| raise Exception("Tracking reference leaks requires a debug build " |
| "of Python") |
| |
| # Save current values for dash_R_cleanup() to restore. |
| fs = warnings.filters[:] |
| ps = copy_reg.dispatch_table.copy() |
| pic = sys.path_importer_cache.copy() |
| try: |
| import zipimport |
| except ImportError: |
| zdc = None # Run unmodified on platforms without zipimport support |
| else: |
| zdc = zipimport._zip_directory_cache.copy() |
| abcs = {} |
| modules = _abcoll, _pyio |
| for abc in [getattr(mod, a) for mod in modules for a in mod.__all__]: |
| # XXX isinstance(abc, ABCMeta) leads to infinite recursion |
| if not hasattr(abc, '_abc_registry'): |
| continue |
| for obj in abc.__subclasses__() + [abc]: |
| abcs[obj] = obj._abc_registry.copy() |
| |
| if indirect_test: |
| def run_the_test(): |
| indirect_test() |
| else: |
| def run_the_test(): |
| imp.reload(the_module) |
| |
| deltas = [] |
| nwarmup, ntracked, fname = huntrleaks |
| repcount = nwarmup + ntracked |
| print >> sys.stderr, "beginning", repcount, "repetitions" |
| print >> sys.stderr, ("1234567890"*(repcount//10 + 1))[:repcount] |
| dash_R_cleanup(fs, ps, pic, zdc, abcs) |
| for i in range(repcount): |
| rc = sys.gettotalrefcount() |
| run_the_test() |
| sys.stderr.write('.') |
| dash_R_cleanup(fs, ps, pic, zdc, abcs) |
| if i >= nwarmup: |
| deltas.append(sys.gettotalrefcount() - rc - 2) |
| print >> sys.stderr |
| if any(deltas): |
| msg = '%s leaked %s references, sum=%s' % (test, deltas, sum(deltas)) |
| print >> sys.stderr, msg |
| with open(fname, "a") as refrep: |
| print >> refrep, msg |
| refrep.flush() |
| return True |
| return False |
| |
| def dash_R_cleanup(fs, ps, pic, zdc, abcs): |
| import gc, copy_reg |
| import _strptime, linecache |
| dircache = test_support.import_module('dircache', deprecated=True) |
| import urlparse, urllib, urllib2, mimetypes, doctest |
| import struct, filecmp |
| from distutils.dir_util import _path_created |
| |
| # Clear the warnings registry, so they can be displayed again |
| for mod in sys.modules.values(): |
| if hasattr(mod, '__warningregistry__'): |
| del mod.__warningregistry__ |
| |
| # Restore some original values. |
| warnings.filters[:] = fs |
| copy_reg.dispatch_table.clear() |
| copy_reg.dispatch_table.update(ps) |
| sys.path_importer_cache.clear() |
| sys.path_importer_cache.update(pic) |
| try: |
| import zipimport |
| except ImportError: |
| pass # Run unmodified on platforms without zipimport support |
| else: |
| zipimport._zip_directory_cache.clear() |
| zipimport._zip_directory_cache.update(zdc) |
| |
| # clear type cache |
| sys._clear_type_cache() |
| |
| # Clear ABC registries, restoring previously saved ABC registries. |
| for abc, registry in abcs.items(): |
| abc._abc_registry = registry.copy() |
| abc._abc_cache.clear() |
| abc._abc_negative_cache.clear() |
| |
| # Clear assorted module caches. |
| _path_created.clear() |
| re.purge() |
| _strptime._regex_cache.clear() |
| urlparse.clear_cache() |
| urllib.urlcleanup() |
| urllib2.install_opener(None) |
| dircache.reset() |
| linecache.clearcache() |
| mimetypes._default_mime_types() |
| filecmp._cache.clear() |
| struct._clearcache() |
| doctest.master = None |
| |
| # Collect cyclic trash. |
| gc.collect() |
| |
| def findtestdir(): |
| if __name__ == '__main__': |
| file = sys.argv[0] |
| else: |
| file = __file__ |
| testdir = os.path.dirname(file) or os.curdir |
| return testdir |
| |
| def removepy(name): |
| if name.endswith(os.extsep + "py"): |
| name = name[:-3] |
| return name |
| |
| def count(n, word): |
| if n == 1: |
| return "%d %s" % (n, word) |
| else: |
| return "%d %ss" % (n, word) |
| |
| def printlist(x, width=70, indent=4): |
| """Print the elements of iterable x to stdout. |
| |
| Optional arg width (default 70) is the maximum line length. |
| Optional arg indent (default 4) is the number of blanks with which to |
| begin each line. |
| """ |
| |
| from textwrap import fill |
| blanks = ' ' * indent |
| print fill(' '.join(map(str, x)), width, |
| initial_indent=blanks, subsequent_indent=blanks) |
| |
| # Map sys.platform to a string containing the basenames of tests |
| # expected to be skipped on that platform. |
| # |
| # Special cases: |
| # test_pep277 |
| # The _ExpectedSkips constructor adds this to the set of expected |
| # skips if not os.path.supports_unicode_filenames. |
| # test_timeout |
| # Controlled by test_timeout.skip_expected. Requires the network |
| # resource and a socket module. |
| # |
| # Tests that are expected to be skipped everywhere except on one platform |
| # are also handled separately. |
| |
| _expectations = { |
| 'win32': |
| """ |
| test__locale |
| test_bsddb185 |
| test_bsddb3 |
| test_commands |
| test_crypt |
| test_curses |
| test_dbm |
| test_dl |
| test_fcntl |
| test_fork1 |
| test_epoll |
| test_gdbm |
| test_grp |
| test_ioctl |
| test_largefile |
| test_kqueue |
| test_mhlib |
| test_openpty |
| test_ossaudiodev |
| test_pipes |
| test_poll |
| test_posix |
| test_pty |
| test_pwd |
| test_resource |
| test_signal |
| test_threadsignals |
| test_timing |
| test_wait3 |
| test_wait4 |
| """, |
| 'linux2': |
| """ |
| test_bsddb185 |
| test_curses |
| test_dl |
| test_largefile |
| test_kqueue |
| test_ossaudiodev |
| """, |
| 'mac': |
| """ |
| test_atexit |
| test_bsddb |
| test_bsddb185 |
| test_bsddb3 |
| test_bz2 |
| test_commands |
| test_crypt |
| test_curses |
| test_dbm |
| test_dl |
| test_fcntl |
| test_fork1 |
| test_epoll |
| test_grp |
| test_ioctl |
| test_largefile |
| test_locale |
| test_kqueue |
| test_mmap |
| test_openpty |
| test_ossaudiodev |
| test_poll |
| test_popen |
| test_popen2 |
| test_posix |
| test_pty |
| test_pwd |
| test_resource |
| test_signal |
| test_sundry |
| test_tarfile |
| test_timing |
| """, |
| 'unixware7': |
| """ |
| test_bsddb |
| test_bsddb185 |
| test_dl |
| test_epoll |
| test_largefile |
| test_kqueue |
| test_minidom |
| test_openpty |
| test_pyexpat |
| test_sax |
| test_sundry |
| """, |
| 'openunix8': |
| """ |
| test_bsddb |
| test_bsddb185 |
| test_dl |
| test_epoll |
| test_largefile |
| test_kqueue |
| test_minidom |
| test_openpty |
| test_pyexpat |
| test_sax |
| test_sundry |
| """, |
| 'sco_sv3': |
| """ |
| test_asynchat |
| test_bsddb |
| test_bsddb185 |
| test_dl |
| test_fork1 |
| test_epoll |
| test_gettext |
| test_largefile |
| test_locale |
| test_kqueue |
| test_minidom |
| test_openpty |
| test_pyexpat |
| test_queue |
| test_sax |
| test_sundry |
| test_thread |
| test_threaded_import |
| test_threadedtempfile |
| test_threading |
| """, |
| 'riscos': |
| """ |
| test_asynchat |
| test_atexit |
| test_bsddb |
| test_bsddb185 |
| test_bsddb3 |
| test_commands |
| test_crypt |
| test_dbm |
| test_dl |
| test_fcntl |
| test_fork1 |
| test_epoll |
| test_gdbm |
| test_grp |
| test_largefile |
| test_locale |
| test_kqueue |
| test_mmap |
| test_openpty |
| test_poll |
| test_popen2 |
| test_pty |
| test_pwd |
| test_strop |
| test_sundry |
| test_thread |
| test_threaded_import |
| test_threadedtempfile |
| test_threading |
| test_timing |
| """, |
| 'darwin': |
| """ |
| test__locale |
| test_bsddb |
| test_bsddb3 |
| test_curses |
| test_epoll |
| test_gdbm |
| test_largefile |
| test_locale |
| test_kqueue |
| test_minidom |
| test_ossaudiodev |
| test_poll |
| """, |
| 'sunos5': |
| """ |
| test_bsddb |
| test_bsddb185 |
| test_curses |
| test_dbm |
| test_epoll |
| test_kqueue |
| test_gdbm |
| test_gzip |
| test_openpty |
| test_zipfile |
| test_zlib |
| """, |
| 'hp-ux11': |
| """ |
| test_bsddb |
| test_bsddb185 |
| test_curses |
| test_dl |
| test_epoll |
| test_gdbm |
| test_gzip |
| test_largefile |
| test_locale |
| test_kqueue |
| test_minidom |
| test_openpty |
| test_pyexpat |
| test_sax |
| test_zipfile |
| test_zlib |
| """, |
| 'atheos': |
| """ |
| test_bsddb185 |
| test_curses |
| test_dl |
| test_gdbm |
| test_epoll |
| test_largefile |
| test_locale |
| test_kqueue |
| test_mhlib |
| test_mmap |
| test_poll |
| test_popen2 |
| test_resource |
| """, |
| 'cygwin': |
| """ |
| test_bsddb185 |
| test_bsddb3 |
| test_curses |
| test_dbm |
| test_epoll |
| test_ioctl |
| test_kqueue |
| test_largefile |
| test_locale |
| test_ossaudiodev |
| test_socketserver |
| """, |
| 'os2emx': |
| """ |
| test_audioop |
| test_bsddb185 |
| test_bsddb3 |
| test_commands |
| test_curses |
| test_dl |
| test_epoll |
| test_kqueue |
| test_largefile |
| test_mhlib |
| test_mmap |
| test_openpty |
| test_ossaudiodev |
| test_pty |
| test_resource |
| test_signal |
| """, |
| 'freebsd4': |
| """ |
| test_bsddb |
| test_bsddb3 |
| test_epoll |
| test_gdbm |
| test_locale |
| test_ossaudiodev |
| test_pep277 |
| test_pty |
| test_socketserver |
| test_tcl |
| test_tk |
| test_ttk_guionly |
| test_ttk_textonly |
| test_timeout |
| test_urllibnet |
| test_multiprocessing |
| """, |
| 'aix5': |
| """ |
| test_bsddb |
| test_bsddb185 |
| test_bsddb3 |
| test_bz2 |
| test_dl |
| test_epoll |
| test_gdbm |
| test_gzip |
| test_kqueue |
| test_ossaudiodev |
| test_tcl |
| test_tk |
| test_ttk_guionly |
| test_ttk_textonly |
| test_zipimport |
| test_zlib |
| """, |
| 'openbsd3': |
| """ |
| test_bsddb |
| test_bsddb3 |
| test_ctypes |
| test_dl |
| test_epoll |
| test_gdbm |
| test_locale |
| test_normalization |
| test_ossaudiodev |
| test_pep277 |
| test_tcl |
| test_tk |
| test_ttk_guionly |
| test_ttk_textonly |
| test_multiprocessing |
| """, |
| 'netbsd3': |
| """ |
| test_bsddb |
| test_bsddb185 |
| test_bsddb3 |
| test_ctypes |
| test_curses |
| test_dl |
| test_epoll |
| test_gdbm |
| test_locale |
| test_ossaudiodev |
| test_pep277 |
| test_tcl |
| test_tk |
| test_ttk_guionly |
| test_ttk_textonly |
| test_multiprocessing |
| """, |
| } |
| _expectations['freebsd5'] = _expectations['freebsd4'] |
| _expectations['freebsd6'] = _expectations['freebsd4'] |
| _expectations['freebsd7'] = _expectations['freebsd4'] |
| _expectations['freebsd8'] = _expectations['freebsd4'] |
| |
| class _ExpectedSkips: |
| def __init__(self): |
| import os.path |
| from test import test_timeout |
| |
| self.valid = False |
| if sys.platform in _expectations: |
| s = _expectations[sys.platform] |
| self.expected = set(s.split()) |
| |
| # expected to be skipped on every platform, even Linux |
| self.expected.add('test_linuxaudiodev') |
| |
| if not os.path.supports_unicode_filenames: |
| self.expected.add('test_pep277') |
| |
| if test_timeout.skip_expected: |
| self.expected.add('test_timeout') |
| |
| if sys.maxint == 9223372036854775807L: |
| self.expected.add('test_imageop') |
| |
| if not sys.platform in ("mac", "darwin"): |
| MAC_ONLY = ["test_macos", "test_macostools", "test_aepack", |
| "test_plistlib", "test_scriptpackages", |
| "test_applesingle"] |
| for skip in MAC_ONLY: |
| self.expected.add(skip) |
| elif len(u'\0'.encode('unicode-internal')) == 4: |
| self.expected.add("test_macostools") |
| |
| |
| if sys.platform != "win32": |
| # test_sqlite is only reliable on Windows where the library |
| # is distributed with Python |
| WIN_ONLY = ["test_unicode_file", "test_winreg", |
| "test_winsound", "test_startfile", |
| "test_sqlite"] |
| for skip in WIN_ONLY: |
| self.expected.add(skip) |
| |
| if sys.platform != 'irix': |
| IRIX_ONLY = ["test_imageop", "test_al", "test_cd", "test_cl", |
| "test_gl", "test_imgfile"] |
| for skip in IRIX_ONLY: |
| self.expected.add(skip) |
| |
| if sys.platform != 'sunos5': |
| self.expected.add('test_sunaudiodev') |
| self.expected.add('test_nis') |
| |
| if not sys.py3kwarning: |
| self.expected.add('test_py3kwarn') |
| |
| self.valid = True |
| |
| def isvalid(self): |
| "Return true iff _ExpectedSkips knows about the current platform." |
| return self.valid |
| |
| def getexpected(self): |
| """Return set of test names we expect to skip on current platform. |
| |
| self.isvalid() must be true. |
| """ |
| |
| assert self.isvalid() |
| return self.expected |
| |
| if __name__ == '__main__': |
| # Remove regrtest.py's own directory from the module search path. This |
| # prevents relative imports from working, and relative imports will screw |
| # up the testing framework. E.g. if both test.test_support and |
| # test_support are imported, they will not contain the same globals, and |
| # much of the testing framework relies on the globals in the |
| # test.test_support module. |
| mydir = os.path.abspath(os.path.normpath(os.path.dirname(sys.argv[0]))) |
| i = len(sys.path) |
| while i >= 0: |
| i -= 1 |
| if os.path.abspath(os.path.normpath(sys.path[i])) == mydir: |
| del sys.path[i] |
| main() |