Benjamin Peterson | 90f5ba5 | 2010-03-11 22:53:45 +0000 | [diff] [blame] | 1 | #! /usr/bin/env python3 |
Guido van Rossum | 152494a | 1996-12-20 03:12:20 +0000 | [diff] [blame] | 2 | |
R. David Murray | 0ba81e0 | 2010-04-26 17:02:32 +0000 | [diff] [blame] | 3 | """ |
Chris Jerdonek | d6c18dc | 2012-12-27 18:53:12 -0800 | [diff] [blame] | 4 | Script to run Python regression tests. |
Guido van Rossum | 152494a | 1996-12-20 03:12:20 +0000 | [diff] [blame] | 5 | |
Chris Jerdonek | d6c18dc | 2012-12-27 18:53:12 -0800 | [diff] [blame] | 6 | Run this script with -h or --help for documentation. |
| 7 | """ |
| 8 | |
| 9 | USAGE = """\ |
Georg Brandl | be41a48 | 2011-01-05 21:47:47 +0000 | [diff] [blame] | 10 | python -m test [options] [test_name1 [test_name2 ...]] |
R. David Murray | 0ba81e0 | 2010-04-26 17:02:32 +0000 | [diff] [blame] | 11 | python path/to/Lib/test/regrtest.py [options] [test_name1 [test_name2 ...]] |
Chris Jerdonek | d6c18dc | 2012-12-27 18:53:12 -0800 | [diff] [blame] | 12 | """ |
Guido van Rossum | 152494a | 1996-12-20 03:12:20 +0000 | [diff] [blame] | 13 | |
Chris Jerdonek | d6c18dc | 2012-12-27 18:53:12 -0800 | [diff] [blame] | 14 | DESCRIPTION = """\ |
| 15 | Run Python regression tests. |
R. David Murray | 0ba81e0 | 2010-04-26 17:02:32 +0000 | [diff] [blame] | 16 | |
| 17 | If no arguments or options are provided, finds all files matching |
| 18 | the pattern "test_*" in the Lib/test subdirectory and runs |
| 19 | them in alphabetical order (but see -M and -u, below, for exceptions). |
| 20 | |
| 21 | For more rigorous testing, it is useful to use the following |
| 22 | command line: |
| 23 | |
Georg Brandl | be41a48 | 2011-01-05 21:47:47 +0000 | [diff] [blame] | 24 | python -E -Wd -m test [options] [test_name1 ...] |
Chris Jerdonek | d6c18dc | 2012-12-27 18:53:12 -0800 | [diff] [blame] | 25 | """ |
R. David Murray | 0ba81e0 | 2010-04-26 17:02:32 +0000 | [diff] [blame] | 26 | |
Chris Jerdonek | d6c18dc | 2012-12-27 18:53:12 -0800 | [diff] [blame] | 27 | EPILOG = """\ |
| 28 | Additional option details: |
Guido van Rossum | f58ed25 | 1997-03-07 21:04:33 +0000 | [diff] [blame] | 29 | |
Collin Winter | fd12f49 | 2009-03-29 04:05:05 +0000 | [diff] [blame] | 30 | -r randomizes test execution order. You can use --randseed=int to provide a |
| 31 | int seed value for the randomizer; this is useful for reproducing troublesome |
| 32 | test orders. |
| 33 | |
R. David Murray | 0ba81e0 | 2010-04-26 17:02:32 +0000 | [diff] [blame] | 34 | -s On the first invocation of regrtest using -s, the first test file found |
| 35 | or the first test file given on the command line is run, and the name of |
| 36 | the next test is recorded in a file named pynexttest. If run from the |
| 37 | Python build directory, pynexttest is located in the 'build' subdirectory, |
| 38 | otherwise it is located in tempfile.gettempdir(). On subsequent runs, |
| 39 | the test in pynexttest is run, and the next test is written to pynexttest. |
| 40 | When the last test has been run, pynexttest is deleted. In this way it |
| 41 | is possible to single step through the test files. This is useful when |
| 42 | doing memory analysis on the Python interpreter, which process tends to |
| 43 | consume too many resources to run the full regression test non-stop. |
Barry Warsaw | e11e3de | 1999-01-28 19:51:51 +0000 | [diff] [blame] | 44 | |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 45 | -S is used to continue running tests after an aborted run. It will |
| 46 | maintain the order a standard run (ie, this assumes -r is not used). |
| 47 | This is useful after the tests have prematurely stopped for some external |
| 48 | reason and you want to start running from where you left off rather |
| 49 | than starting from the beginning. |
| 50 | |
Guido van Rossum | 9e9d4f8 | 2002-06-07 15:17:03 +0000 | [diff] [blame] | 51 | -f reads the names of tests from the file given as f's argument, one |
| 52 | or more test names per line. Whitespace is ignored. Blank lines and |
| 53 | lines beginning with '#' are ignored. This is especially useful for |
| 54 | whittling down failures involving interactions among tests. |
Tim Peters | c5000df | 2002-06-02 21:42:01 +0000 | [diff] [blame] | 55 | |
Skip Montanaro | 0179a18 | 2004-06-06 15:53:18 +0000 | [diff] [blame] | 56 | -L causes the leaks(1) command to be run just before exit if it exists. |
| 57 | leaks(1) is available on Mac OS X and presumably on some other |
| 58 | FreeBSD-derived systems. |
| 59 | |
Michael W. Hudson | 61147f6 | 2004-08-03 11:33:28 +0000 | [diff] [blame] | 60 | -R runs each test several times and examines sys.gettotalrefcount() to |
| 61 | see if the test appears to be leaking references. The argument should |
| 62 | be of the form stab:run:fname where 'stab' is the number of times the |
| 63 | test is run to let gettotalrefcount settle down, 'run' is the number |
| 64 | of times further it is run and 'fname' is the name of the file the |
| 65 | reports are written to. These parameters all have defaults (5, 4 and |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 66 | "reflog.txt" respectively), and the minimal invocation is '-R :'. |
Michael W. Hudson | 61147f6 | 2004-08-03 11:33:28 +0000 | [diff] [blame] | 67 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 68 | -M runs tests that require an exorbitant amount of memory. These tests |
| 69 | typically try to ascertain containers keep working when containing more than |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 70 | 2 billion objects, which only works on 64-bit systems. There are also some |
| 71 | tests that try to exhaust the address space of the process, which only makes |
| 72 | sense on 32-bit systems with at least 2Gb of memory. The passed-in memlimit, |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 73 | which is a string in the form of '2.5Gb', determines howmuch memory the |
| 74 | tests will limit themselves to (but they may go slightly over.) The number |
| 75 | shouldn't be more memory than the machine has (including swap memory). You |
| 76 | should also keep in mind that swap memory is generally much, much slower |
| 77 | than RAM, and setting memlimit to all available RAM or higher will heavily |
| 78 | tax the machine. On the other hand, it is no use running these tests with a |
| 79 | limit of less than 2.5Gb, and many require more than 20Gb. Tests that expect |
| 80 | to use more than memlimit memory will be skipped. The big-memory tests |
| 81 | generally run very, very long. |
| 82 | |
Guido van Rossum | 9e9d4f8 | 2002-06-07 15:17:03 +0000 | [diff] [blame] | 83 | -u is used to specify which special resource intensive tests to run, |
| 84 | such as those requiring large file support or network connectivity. |
| 85 | The argument is a comma-separated list of words indicating the |
| 86 | resources to test. Currently only the following are defined: |
Barry Warsaw | 08fca52 | 2001-08-20 22:33:46 +0000 | [diff] [blame] | 87 | |
Fred Drake | 3a15dac | 2002-04-11 16:39:16 +0000 | [diff] [blame] | 88 | all - Enable all special resources. |
| 89 | |
Nadeem Vawda | 3c01d16 | 2011-08-01 23:48:26 +0200 | [diff] [blame] | 90 | none - Disable all special resources (this is the default). |
| 91 | |
Guido van Rossum | 315aa36 | 2003-03-11 14:46:48 +0000 | [diff] [blame] | 92 | audio - Tests that use the audio device. (There are known |
| 93 | cases of broken audio drivers that can crash Python or |
| 94 | even the Linux kernel.) |
| 95 | |
Andrew M. Kuchling | 2158df0 | 2001-10-22 15:26:09 +0000 | [diff] [blame] | 96 | curses - Tests that use curses and will modify the terminal's |
| 97 | state and output modes. |
Tim Peters | 1633a2e | 2001-10-30 05:56:40 +0000 | [diff] [blame] | 98 | |
Guido van Rossum | 9e9d4f8 | 2002-06-07 15:17:03 +0000 | [diff] [blame] | 99 | largefile - It is okay to run some test that may create huge |
| 100 | files. These tests can take a long time and may |
| 101 | consume >2GB of disk space temporarily. |
Barry Warsaw | 08fca52 | 2001-08-20 22:33:46 +0000 | [diff] [blame] | 102 | |
Guido van Rossum | 9e9d4f8 | 2002-06-07 15:17:03 +0000 | [diff] [blame] | 103 | network - It is okay to run tests that use external network |
| 104 | resource, e.g. testing SSL support for sockets. |
Martin v. Löwis | 1c6b1a2 | 2002-11-19 17:47:07 +0000 | [diff] [blame] | 105 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 106 | decimal - Test the decimal module against a large suite that |
| 107 | verifies compliance with standards. |
| 108 | |
Antoine Pitrou | 5bc4fa7 | 2010-10-14 15:34:31 +0000 | [diff] [blame] | 109 | cpu - Used for certain CPU-heavy tests. |
Jeremy Hylton | 4336eda | 2004-08-07 19:25:33 +0000 | [diff] [blame] | 110 | |
Tim Peters | eba28be | 2005-03-28 01:08:02 +0000 | [diff] [blame] | 111 | subprocess Run all tests for the subprocess module. |
Peter Astrand | f7f1bb7 | 2005-03-03 20:47:37 +0000 | [diff] [blame] | 112 | |
Hye-Shik Chang | aaa2f1d | 2005-12-10 17:44:27 +0000 | [diff] [blame] | 113 | urlfetch - It is okay to download files required on testing. |
| 114 | |
Guilherme Polo | 9de29af | 2009-01-28 20:40:48 +0000 | [diff] [blame] | 115 | gui - Run tests that require a running GUI. |
| 116 | |
Fred Drake | 4dd0f7e | 2002-11-26 21:44:56 +0000 | [diff] [blame] | 117 | To enable all resources except one, use '-uall,-<resource>'. For |
Georg Brandl | 1158a33 | 2009-06-04 09:30:30 +0000 | [diff] [blame] | 118 | example, to run all the tests except for the gui tests, give the |
| 119 | option '-uall,-gui'. |
Guido van Rossum | 152494a | 1996-12-20 03:12:20 +0000 | [diff] [blame] | 120 | """ |
| 121 | |
Nick Coghlan | be7e49f | 2012-07-20 23:40:09 +1000 | [diff] [blame] | 122 | # We import importlib *ASAP* in order to test #15386 |
| 123 | import importlib |
| 124 | |
Chris Jerdonek | d6c18dc | 2012-12-27 18:53:12 -0800 | [diff] [blame] | 125 | import argparse |
Brett Cannon | 4507190 | 2010-06-14 22:22:54 +0000 | [diff] [blame] | 126 | import builtins |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 127 | import faulthandler |
Victor Stinner | 8313d6a | 2011-06-29 15:22:26 +0200 | [diff] [blame] | 128 | import io |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 129 | import json |
Brett Cannon | 49e835b | 2013-04-01 14:11:37 -0400 | [diff] [blame] | 130 | import locale |
Victor Stinner | 8313d6a | 2011-06-29 15:22:26 +0200 | [diff] [blame] | 131 | import logging |
Christian Heimes | b186d00 | 2008-03-18 15:15:01 +0000 | [diff] [blame] | 132 | import os |
Victor Stinner | 8313d6a | 2011-06-29 15:22:26 +0200 | [diff] [blame] | 133 | import platform |
Skip Montanaro | ab1c791 | 2000-06-30 16:39:27 +0000 | [diff] [blame] | 134 | import random |
Thomas Wouters | 9ada3d6 | 2006-04-21 09:47:09 +0000 | [diff] [blame] | 135 | import re |
Éric Araujo | ff91306 | 2011-11-29 16:45:07 +0100 | [diff] [blame] | 136 | import shutil |
Victor Stinner | cb41cda | 2011-07-13 23:47:21 +0200 | [diff] [blame] | 137 | import signal |
Christian Heimes | b186d00 | 2008-03-18 15:15:01 +0000 | [diff] [blame] | 138 | import sys |
Florent Xicluna | da7bfd5 | 2010-03-06 11:43:55 +0000 | [diff] [blame] | 139 | import sysconfig |
Victor Stinner | 8313d6a | 2011-06-29 15:22:26 +0200 | [diff] [blame] | 140 | import tempfile |
| 141 | import time |
| 142 | import traceback |
| 143 | import unittest |
| 144 | import warnings |
| 145 | from inspect import isabstract |
Ezio Melotti | 184bdfb | 2010-02-18 09:37:05 +0000 | [diff] [blame] | 146 | |
Antoine Pitrou | c081c0c | 2011-07-15 22:12:24 +0200 | [diff] [blame] | 147 | try: |
| 148 | import threading |
Brett Cannon | c9a1bfe | 2013-06-12 20:12:30 -0400 | [diff] [blame] | 149 | except ModuleNotFoundError: |
Antoine Pitrou | c081c0c | 2011-07-15 22:12:24 +0200 | [diff] [blame] | 150 | threading = None |
| 151 | try: |
| 152 | import multiprocessing.process |
Brett Cannon | c9a1bfe | 2013-06-12 20:12:30 -0400 | [diff] [blame] | 153 | except ModuleNotFoundError: |
Antoine Pitrou | c081c0c | 2011-07-15 22:12:24 +0200 | [diff] [blame] | 154 | multiprocessing = None |
| 155 | |
Florent Xicluna | 64fb18e | 2010-03-06 14:43:34 +0000 | [diff] [blame] | 156 | |
Ezio Melotti | 184bdfb | 2010-02-18 09:37:05 +0000 | [diff] [blame] | 157 | # Some times __path__ and __file__ are not absolute (e.g. while running from |
| 158 | # Lib/) and, if we change the CWD to run the tests in a temporary dir, some |
| 159 | # imports might fail. This affects only the modules imported before os.chdir(). |
| 160 | # These modules are searched first in sys.path[0] (so '' -- the CWD) and if |
| 161 | # they are found in the CWD their __file__ and __path__ will be relative (this |
| 162 | # happens before the chdir). All the modules imported after the chdir, are |
| 163 | # not found in the CWD, and since the other paths in sys.path[1:] are absolute |
| 164 | # (site.py absolutize them), the __file__ and __path__ will be absolute too. |
| 165 | # Therefore it is necessary to absolutize manually the __file__ and __path__ of |
| 166 | # the packages to prevent later imports to fail when the CWD is different. |
| 167 | for module in sys.modules.values(): |
| 168 | if hasattr(module, '__path__'): |
| 169 | module.__path__ = [os.path.abspath(path) for path in module.__path__] |
| 170 | if hasattr(module, '__file__'): |
| 171 | module.__file__ = os.path.abspath(module.__file__) |
| 172 | |
Guido van Rossum | dc15c27 | 2002-08-12 21:55:51 +0000 | [diff] [blame] | 173 | |
Guido van Rossum | bb48465 | 2002-12-02 09:56:21 +0000 | [diff] [blame] | 174 | # MacOSX (a.k.a. Darwin) has a default stack size that is too small |
| 175 | # for deeply recursive regular expressions. We see this as crashes in |
| 176 | # the Python test suite when running test_re.py and test_sre.py. The |
| 177 | # fix is to set the stack limit to 2048. |
| 178 | # This approach may also be useful for other Unixy platforms that |
| 179 | # suffer from small default stack limits. |
| 180 | if sys.platform == 'darwin': |
| 181 | try: |
| 182 | import resource |
Brett Cannon | c9a1bfe | 2013-06-12 20:12:30 -0400 | [diff] [blame] | 183 | except ModuleNotFoundError: |
Guido van Rossum | bb48465 | 2002-12-02 09:56:21 +0000 | [diff] [blame] | 184 | pass |
| 185 | else: |
| 186 | soft, hard = resource.getrlimit(resource.RLIMIT_STACK) |
| 187 | newsoft = min(hard, max(soft, 1024*2048)) |
| 188 | resource.setrlimit(resource.RLIMIT_STACK, (newsoft, hard)) |
| 189 | |
Benjamin Peterson | a0dfa82 | 2009-11-13 02:25:08 +0000 | [diff] [blame] | 190 | # Test result constants. |
| 191 | PASSED = 1 |
| 192 | FAILED = 0 |
| 193 | ENV_CHANGED = -1 |
| 194 | SKIPPED = -2 |
| 195 | RESOURCE_DENIED = -3 |
| 196 | INTERRUPTED = -4 |
Victor Stinner | 4b73988 | 2011-03-31 18:02:36 +0200 | [diff] [blame] | 197 | CHILD_ERROR = -5 # error in a child process |
Benjamin Peterson | a0dfa82 | 2009-11-13 02:25:08 +0000 | [diff] [blame] | 198 | |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 199 | from test import support |
Fred Drake | 3a15dac | 2002-04-11 16:39:16 +0000 | [diff] [blame] | 200 | |
Georg Brandl | 1158a33 | 2009-06-04 09:30:30 +0000 | [diff] [blame] | 201 | RESOURCE_NAMES = ('audio', 'curses', 'largefile', 'network', |
Antoine Pitrou | 5bc4fa7 | 2010-10-14 15:34:31 +0000 | [diff] [blame] | 202 | 'decimal', 'cpu', 'subprocess', 'urlfetch', 'gui') |
Fred Drake | 3a15dac | 2002-04-11 16:39:16 +0000 | [diff] [blame] | 203 | |
Chris Jerdonek | 517e925 | 2013-02-27 09:02:53 -0800 | [diff] [blame] | 204 | # When tests are run from the Python build directory, it is best practice |
| 205 | # to keep the test files in a subfolder. This eases the cleanup of leftover |
| 206 | # files using the "make distclean" command. |
| 207 | if sysconfig.is_python_build(): |
| 208 | TEMPDIR = os.path.join(sysconfig.get_config_var('srcdir'), 'build') |
| 209 | else: |
| 210 | TEMPDIR = tempfile.gettempdir() |
| 211 | TEMPDIR = os.path.abspath(TEMPDIR) |
Fred Drake | 3a15dac | 2002-04-11 16:39:16 +0000 | [diff] [blame] | 212 | |
Chris Jerdonek | 1573842 | 2013-01-07 17:07:32 -0800 | [diff] [blame] | 213 | class _ArgParser(argparse.ArgumentParser): |
| 214 | |
| 215 | def error(self, message): |
| 216 | super().error(message + "\nPass -h or --help for complete help.") |
| 217 | |
Chris Jerdonek | d6c18dc | 2012-12-27 18:53:12 -0800 | [diff] [blame] | 218 | def _create_parser(): |
| 219 | # Set prog to prevent the uninformative "__main__.py" from displaying in |
| 220 | # error messages when using "python -m test ...". |
Chris Jerdonek | 1573842 | 2013-01-07 17:07:32 -0800 | [diff] [blame] | 221 | parser = _ArgParser(prog='regrtest.py', |
| 222 | usage=USAGE, |
| 223 | description=DESCRIPTION, |
| 224 | epilog=EPILOG, |
| 225 | add_help=False, |
| 226 | formatter_class=argparse.RawDescriptionHelpFormatter) |
Chris Jerdonek | d6c18dc | 2012-12-27 18:53:12 -0800 | [diff] [blame] | 227 | |
| 228 | # Arguments with this clause added to its help are described further in |
| 229 | # the epilog's "Additional option details" section. |
| 230 | more_details = ' See the section at bottom for more details.' |
| 231 | |
| 232 | group = parser.add_argument_group('General options') |
| 233 | # We add help explicitly to control what argument group it renders under. |
| 234 | group.add_argument('-h', '--help', action='help', |
| 235 | help='show this help message and exit') |
| 236 | group.add_argument('--timeout', metavar='TIMEOUT', |
| 237 | help='dump the traceback and exit if a test takes ' |
| 238 | 'more than TIMEOUT seconds; disabled if TIMEOUT ' |
| 239 | 'is negative or equals to zero') |
| 240 | group.add_argument('--wait', action='store_true', help='wait for user ' |
| 241 | 'input, e.g., allow a debugger to be attached') |
| 242 | group.add_argument('--slaveargs', metavar='ARGS') |
| 243 | group.add_argument('-S', '--start', metavar='START', help='the name of ' |
| 244 | 'the test at which to start.' + more_details) |
| 245 | |
| 246 | group = parser.add_argument_group('Verbosity') |
| 247 | group.add_argument('-v', '--verbose', action='store_true', |
| 248 | help='run tests in verbose mode with output to stdout') |
| 249 | group.add_argument('-w', '--verbose2', action='store_true', |
| 250 | help='re-run failed tests in verbose mode') |
| 251 | group.add_argument('-W', '--verbose3', action='store_true', |
| 252 | help='display test output on failure') |
| 253 | group.add_argument('-d', '--debug', action='store_true', |
| 254 | help='print traceback for failed tests') |
| 255 | group.add_argument('-q', '--quiet', action='store_true', |
| 256 | help='no output unless one or more tests fail') |
| 257 | group.add_argument('-o', '--slow', action='store_true', |
| 258 | help='print the slowest 10 tests') |
| 259 | group.add_argument('--header', action='store_true', |
| 260 | help='print header with interpreter info') |
| 261 | |
| 262 | group = parser.add_argument_group('Selecting tests') |
| 263 | group.add_argument('-r', '--randomize', action='store_true', |
| 264 | help='randomize test execution order.' + more_details) |
| 265 | group.add_argument('--randseed', metavar='SEED', help='pass a random seed ' |
| 266 | 'to reproduce a previous random run') |
| 267 | group.add_argument('-f', '--fromfile', metavar='FILE', help='read names ' |
| 268 | 'of tests to run from a file.' + more_details) |
| 269 | group.add_argument('-x', '--exclude', action='store_true', |
| 270 | help='arguments are tests to *exclude*') |
| 271 | group.add_argument('-s', '--single', action='store_true', help='single ' |
| 272 | 'step through a set of tests.' + more_details) |
| 273 | group.add_argument('-m', '--match', metavar='PAT', help='match test cases ' |
| 274 | 'and methods with glob pattern PAT') |
| 275 | group.add_argument('-G', '--failfast', action='store_true', help='fail as ' |
| 276 | 'soon as a test fails (only with -v or -W)') |
| 277 | group.add_argument('-u', '--use', metavar='RES1,RES2,...', help='specify ' |
| 278 | 'which special resource intensive tests to run.' + |
| 279 | more_details) |
| 280 | group.add_argument('-M', '--memlimit', metavar='LIMIT', help='run very ' |
| 281 | 'large memory-consuming tests.' + more_details) |
| 282 | group.add_argument('--testdir', metavar='DIR', |
| 283 | help='execute test files in the specified directory ' |
| 284 | '(instead of the Python stdlib test suite)') |
| 285 | |
| 286 | group = parser.add_argument_group('Special runs') |
| 287 | group.add_argument('-l', '--findleaks', action='store_true', help='if GC ' |
| 288 | 'is available detect tests that leak memory') |
| 289 | group.add_argument('-L', '--runleaks', action='store_true', |
| 290 | help='run the leaks(1) command just before exit.' + |
| 291 | more_details) |
| 292 | group.add_argument('-R', '--huntrleaks', metavar='RUNCOUNTS', |
| 293 | help='search for reference leaks (needs debug build, ' |
| 294 | 'very slow).' + more_details) |
| 295 | group.add_argument('-j', '--multiprocess', metavar='PROCESSES', |
| 296 | help='run PROCESSES processes at once') |
| 297 | group.add_argument('-T', '--coverage', action='store_true', help='turn on ' |
| 298 | 'code coverage tracing using the trace module') |
| 299 | group.add_argument('-D', '--coverdir', metavar='DIR', |
| 300 | help='directory where coverage files are put') |
| 301 | group.add_argument('-N', '--nocoverdir', action='store_true', |
| 302 | help='put coverage files alongside modules') |
| 303 | group.add_argument('-t', '--threshold', metavar='THRESHOLD', |
| 304 | help='call gc.set_threshold(THRESHOLD)') |
| 305 | group.add_argument('-n', '--nowindows', action='store_true', |
| 306 | help='suppress error message boxes on Windows') |
| 307 | group.add_argument('-F', '--forever', action='store_true', |
| 308 | help='run the specified tests in a loop, until an ' |
| 309 | 'error happens') |
| 310 | |
| 311 | parser.add_argument('args', nargs=argparse.REMAINDER, |
| 312 | help=argparse.SUPPRESS) |
| 313 | |
| 314 | return parser |
| 315 | |
Chris Jerdonek | 1573842 | 2013-01-07 17:07:32 -0800 | [diff] [blame] | 316 | # TODO: remove this function as described in issue #16799, for example. |
| 317 | # We use this function since regrtest.main() was originally written to use |
| 318 | # getopt for parsing. |
Chris Jerdonek | d6c18dc | 2012-12-27 18:53:12 -0800 | [diff] [blame] | 319 | def _convert_namespace_to_getopt(ns): |
Chris Jerdonek | 1573842 | 2013-01-07 17:07:32 -0800 | [diff] [blame] | 320 | """Convert an argparse.Namespace object to a getopt-style opts list. |
| 321 | |
| 322 | The return value of this function mimics the first element of |
| 323 | getopt.getopt()'s (opts, args) return value. In addition, the (option, |
| 324 | value) pairs in the opts list are sorted by option and use the long |
| 325 | option string. The args part of (opts, args) can be mimicked by the |
| 326 | args attribute of the Namespace object we are using in regrtest. |
| 327 | """ |
Chris Jerdonek | d6c18dc | 2012-12-27 18:53:12 -0800 | [diff] [blame] | 328 | opts = [] |
| 329 | args_dict = vars(ns) |
| 330 | for key in sorted(args_dict.keys()): |
| 331 | if key == 'args': |
| 332 | continue |
| 333 | val = args_dict[key] |
| 334 | # Don't continue if val equals '' because this means an option |
| 335 | # accepting a value was provided the empty string. Such values should |
| 336 | # show up in the returned opts list. |
| 337 | if val is None or val is False: |
| 338 | continue |
| 339 | if val is True: |
| 340 | # Then an option with action store_true was passed. getopt |
| 341 | # includes these with value '' in the opts list. |
| 342 | val = '' |
| 343 | opts.append(('--' + key, val)) |
Chris Jerdonek | 1573842 | 2013-01-07 17:07:32 -0800 | [diff] [blame] | 344 | return opts |
Barry Warsaw | 08fca52 | 2001-08-20 22:33:46 +0000 | [diff] [blame] | 345 | |
| 346 | |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 347 | def main(tests=None, testdir=None, verbose=0, quiet=False, |
Barry Warsaw | 3b6d025 | 2004-02-07 22:43:03 +0000 | [diff] [blame] | 348 | exclude=False, single=False, randomize=False, fromfile=None, |
Walter Dörwald | aee4da6 | 2004-11-12 18:51:27 +0000 | [diff] [blame] | 349 | findleaks=False, use_resources=None, trace=False, coverdir='coverage', |
Collin Winter | fd12f49 | 2009-03-29 04:05:05 +0000 | [diff] [blame] | 350 | runleaks=False, huntrleaks=False, verbose2=False, print_slow=False, |
Antoine Pitrou | 3c4402f | 2011-01-03 20:38:52 +0000 | [diff] [blame] | 351 | random_seed=None, use_mp=None, verbose3=False, forever=False, |
Antoine Pitrou | b9c73e8 | 2011-07-29 23:53:38 +0200 | [diff] [blame] | 352 | header=False, failfast=False, match_tests=None): |
Guido van Rossum | 6fd83b7 | 1998-08-01 17:04:08 +0000 | [diff] [blame] | 353 | """Execute a test suite. |
| 354 | |
Thomas Wouters | 7e47402 | 2000-07-16 12:04:32 +0000 | [diff] [blame] | 355 | This also parses command-line options and modifies its behavior |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 356 | accordingly. |
Guido van Rossum | 6fd83b7 | 1998-08-01 17:04:08 +0000 | [diff] [blame] | 357 | |
| 358 | tests -- a list of strings containing test names (optional) |
| 359 | testdir -- the directory in which to look for tests (optional) |
| 360 | |
| 361 | Users other than the Python test suite will certainly want to |
| 362 | specify testdir; if it's omitted, the directory containing the |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 363 | Python test suite is searched for. |
Guido van Rossum | 6fd83b7 | 1998-08-01 17:04:08 +0000 | [diff] [blame] | 364 | |
| 365 | If the tests argument is omitted, the tests listed on the |
| 366 | command-line will be used. If that's empty, too, then all *.py |
| 367 | files beginning with test_ will be used. |
Skip Montanaro | ab1c791 | 2000-06-30 16:39:27 +0000 | [diff] [blame] | 368 | |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 369 | The other default arguments (verbose, quiet, exclude, |
Collin Winter | fd12f49 | 2009-03-29 04:05:05 +0000 | [diff] [blame] | 370 | single, randomize, findleaks, use_resources, trace, coverdir, |
| 371 | print_slow, and random_seed) allow programmers calling main() |
| 372 | directly to set the values that would normally be set by flags |
| 373 | on the command line. |
Guido van Rossum | 6fd83b7 | 1998-08-01 17:04:08 +0000 | [diff] [blame] | 374 | """ |
Victor Stinner | 3c18f25 | 2011-05-22 15:27:14 +0200 | [diff] [blame] | 375 | |
Victor Stinner | cb41cda | 2011-07-13 23:47:21 +0200 | [diff] [blame] | 376 | # Display the Python traceback on fatal errors (e.g. segfault) |
Victor Stinner | 3c18f25 | 2011-05-22 15:27:14 +0200 | [diff] [blame] | 377 | faulthandler.enable(all_threads=True) |
| 378 | |
Victor Stinner | cb41cda | 2011-07-13 23:47:21 +0200 | [diff] [blame] | 379 | # Display the Python traceback on SIGALRM or SIGUSR1 signal |
| 380 | signals = [] |
| 381 | if hasattr(signal, 'SIGALRM'): |
| 382 | signals.append(signal.SIGALRM) |
| 383 | if hasattr(signal, 'SIGUSR1'): |
| 384 | signals.append(signal.SIGUSR1) |
| 385 | for signum in signals: |
| 386 | faulthandler.register(signum, chain=True) |
| 387 | |
Victor Stinner | 1802d3f | 2010-05-19 17:11:19 +0000 | [diff] [blame] | 388 | replace_stdout() |
| 389 | |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 390 | support.record_original_stdout(sys.stdout) |
Chris Jerdonek | d6c18dc | 2012-12-27 18:53:12 -0800 | [diff] [blame] | 391 | |
Chris Jerdonek | 1573842 | 2013-01-07 17:07:32 -0800 | [diff] [blame] | 392 | parser = _create_parser() |
| 393 | ns = parser.parse_args() |
| 394 | opts = _convert_namespace_to_getopt(ns) |
| 395 | args = ns.args |
| 396 | usage = parser.error |
Barry Warsaw | 08fca52 | 2001-08-20 22:33:46 +0000 | [diff] [blame] | 397 | |
| 398 | # Defaults |
Collin Winter | fd12f49 | 2009-03-29 04:05:05 +0000 | [diff] [blame] | 399 | if random_seed is None: |
| 400 | random_seed = random.randrange(10000000) |
Barry Warsaw | 08fca52 | 2001-08-20 22:33:46 +0000 | [diff] [blame] | 401 | if use_resources is None: |
| 402 | use_resources = [] |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 403 | debug = False |
| 404 | start = None |
Victor Stinner | 3019688 | 2011-06-03 12:53:26 +0200 | [diff] [blame] | 405 | timeout = None |
Guido van Rossum | 152494a | 1996-12-20 03:12:20 +0000 | [diff] [blame] | 406 | for o, a in opts: |
Chris Jerdonek | d6c18dc | 2012-12-27 18:53:12 -0800 | [diff] [blame] | 407 | if o in ('-v', '--verbose'): |
Barry Warsaw | 08fca52 | 2001-08-20 22:33:46 +0000 | [diff] [blame] | 408 | verbose += 1 |
Martin v. Löwis | 04824ce | 2006-03-10 21:26:16 +0000 | [diff] [blame] | 409 | elif o in ('-w', '--verbose2'): |
| 410 | verbose2 = True |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 411 | elif o in ('-d', '--debug'): |
| 412 | debug = True |
Georg Brandl | 96f7897 | 2009-10-27 21:02:11 +0000 | [diff] [blame] | 413 | elif o in ('-W', '--verbose3'): |
| 414 | verbose3 = True |
Antoine Pitrou | 216a3bc | 2011-07-23 22:33:39 +0200 | [diff] [blame] | 415 | elif o in ('-G', '--failfast'): |
| 416 | failfast = True |
Barry Warsaw | 08fca52 | 2001-08-20 22:33:46 +0000 | [diff] [blame] | 417 | elif o in ('-q', '--quiet'): |
Barry Warsaw | 3b6d025 | 2004-02-07 22:43:03 +0000 | [diff] [blame] | 418 | quiet = True; |
Barry Warsaw | 08fca52 | 2001-08-20 22:33:46 +0000 | [diff] [blame] | 419 | verbose = 0 |
Barry Warsaw | 08fca52 | 2001-08-20 22:33:46 +0000 | [diff] [blame] | 420 | elif o in ('-x', '--exclude'): |
Barry Warsaw | 3b6d025 | 2004-02-07 22:43:03 +0000 | [diff] [blame] | 421 | exclude = True |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 422 | elif o in ('-S', '--start'): |
| 423 | start = a |
Barry Warsaw | 08fca52 | 2001-08-20 22:33:46 +0000 | [diff] [blame] | 424 | elif o in ('-s', '--single'): |
Barry Warsaw | 3b6d025 | 2004-02-07 22:43:03 +0000 | [diff] [blame] | 425 | single = True |
Senthil Kumaran | bcfe56d | 2012-01-14 18:26:27 +0800 | [diff] [blame] | 426 | elif o in ('-o', '--slow'): |
Christian Heimes | b186d00 | 2008-03-18 15:15:01 +0000 | [diff] [blame] | 427 | print_slow = True |
Barry Warsaw | 08fca52 | 2001-08-20 22:33:46 +0000 | [diff] [blame] | 428 | elif o in ('-r', '--randomize'): |
Barry Warsaw | 3b6d025 | 2004-02-07 22:43:03 +0000 | [diff] [blame] | 429 | randomize = True |
Collin Winter | fd12f49 | 2009-03-29 04:05:05 +0000 | [diff] [blame] | 430 | elif o == '--randseed': |
| 431 | random_seed = int(a) |
Tim Peters | c5000df | 2002-06-02 21:42:01 +0000 | [diff] [blame] | 432 | elif o in ('-f', '--fromfile'): |
| 433 | fromfile = a |
Antoine Pitrou | b9c73e8 | 2011-07-29 23:53:38 +0200 | [diff] [blame] | 434 | elif o in ('-m', '--match'): |
| 435 | match_tests = a |
Barry Warsaw | 08fca52 | 2001-08-20 22:33:46 +0000 | [diff] [blame] | 436 | elif o in ('-l', '--findleaks'): |
Barry Warsaw | 3b6d025 | 2004-02-07 22:43:03 +0000 | [diff] [blame] | 437 | findleaks = True |
Skip Montanaro | 0179a18 | 2004-06-06 15:53:18 +0000 | [diff] [blame] | 438 | elif o in ('-L', '--runleaks'): |
| 439 | runleaks = True |
Guido van Rossum | 9e9d4f8 | 2002-06-07 15:17:03 +0000 | [diff] [blame] | 440 | elif o in ('-t', '--threshold'): |
| 441 | import gc |
| 442 | gc.set_threshold(int(a)) |
Barry Warsaw | 3b6d025 | 2004-02-07 22:43:03 +0000 | [diff] [blame] | 443 | elif o in ('-T', '--coverage'): |
| 444 | trace = True |
Walter Dörwald | aee4da6 | 2004-11-12 18:51:27 +0000 | [diff] [blame] | 445 | elif o in ('-D', '--coverdir'): |
R David Murray | 03504fc | 2011-03-24 14:35:30 -0400 | [diff] [blame] | 446 | # CWD is replaced with a temporary dir before calling main(), so we |
| 447 | # need join it with the saved CWD so it goes where the user expects. |
| 448 | coverdir = os.path.join(support.SAVEDCWD, a) |
Walter Dörwald | aee4da6 | 2004-11-12 18:51:27 +0000 | [diff] [blame] | 449 | elif o in ('-N', '--nocoverdir'): |
| 450 | coverdir = None |
Michael W. Hudson | 61147f6 | 2004-08-03 11:33:28 +0000 | [diff] [blame] | 451 | elif o in ('-R', '--huntrleaks'): |
| 452 | huntrleaks = a.split(':') |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 453 | if len(huntrleaks) not in (2, 3): |
| 454 | print(a, huntrleaks) |
| 455 | usage('-R takes 2 or 3 colon-separated arguments') |
| 456 | if not huntrleaks[0]: |
Michael W. Hudson | 61147f6 | 2004-08-03 11:33:28 +0000 | [diff] [blame] | 457 | huntrleaks[0] = 5 |
| 458 | else: |
| 459 | huntrleaks[0] = int(huntrleaks[0]) |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 460 | if not huntrleaks[1]: |
Michael W. Hudson | 61147f6 | 2004-08-03 11:33:28 +0000 | [diff] [blame] | 461 | huntrleaks[1] = 4 |
| 462 | else: |
| 463 | huntrleaks[1] = int(huntrleaks[1]) |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 464 | if len(huntrleaks) == 2 or not huntrleaks[2]: |
| 465 | huntrleaks[2:] = ["reflog.txt"] |
Stefan Krah | 5c3ddc8 | 2012-08-17 23:09:48 +0200 | [diff] [blame] | 466 | # Avoid false positives due to various caches |
| 467 | # filling slowly with random data: |
| 468 | warm_caches() |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 469 | elif o in ('-M', '--memlimit'): |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 470 | support.set_memlimit(a) |
Barry Warsaw | 08fca52 | 2001-08-20 22:33:46 +0000 | [diff] [blame] | 471 | elif o in ('-u', '--use'): |
Guido van Rossum | fe3f696 | 2001-09-06 16:09:41 +0000 | [diff] [blame] | 472 | u = [x.lower() for x in a.split(',')] |
| 473 | for r in u: |
Fred Drake | 3a15dac | 2002-04-11 16:39:16 +0000 | [diff] [blame] | 474 | if r == 'all': |
Fred Drake | 4dd0f7e | 2002-11-26 21:44:56 +0000 | [diff] [blame] | 475 | use_resources[:] = RESOURCE_NAMES |
| 476 | continue |
Nadeem Vawda | 3c01d16 | 2011-08-01 23:48:26 +0200 | [diff] [blame] | 477 | if r == 'none': |
| 478 | del use_resources[:] |
| 479 | continue |
Fred Drake | 4dd0f7e | 2002-11-26 21:44:56 +0000 | [diff] [blame] | 480 | remove = False |
| 481 | if r[0] == '-': |
| 482 | remove = True |
| 483 | r = r[1:] |
Fred Drake | 3a15dac | 2002-04-11 16:39:16 +0000 | [diff] [blame] | 484 | if r not in RESOURCE_NAMES: |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 485 | usage('Invalid -u/--use option: ' + a) |
Fred Drake | 4dd0f7e | 2002-11-26 21:44:56 +0000 | [diff] [blame] | 486 | if remove: |
| 487 | if r in use_resources: |
| 488 | use_resources.remove(r) |
| 489 | elif r not in use_resources: |
Andrew MacIntyre | e41abab | 2002-04-30 12:11:04 +0000 | [diff] [blame] | 490 | use_resources.append(r) |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 491 | elif o in ('-n', '--nowindows'): |
| 492 | import msvcrt |
| 493 | msvcrt.SetErrorMode(msvcrt.SEM_FAILCRITICALERRORS| |
| 494 | msvcrt.SEM_NOALIGNMENTFAULTEXCEPT| |
| 495 | msvcrt.SEM_NOGPFAULTERRORBOX| |
| 496 | msvcrt.SEM_NOOPENFILEERRORBOX) |
| 497 | try: |
| 498 | msvcrt.CrtSetReportMode |
| 499 | except AttributeError: |
| 500 | # release build |
| 501 | pass |
| 502 | else: |
| 503 | for m in [msvcrt.CRT_WARN, msvcrt.CRT_ERROR, msvcrt.CRT_ASSERT]: |
| 504 | msvcrt.CrtSetReportMode(m, msvcrt.CRTDBG_MODE_FILE) |
| 505 | msvcrt.CrtSetReportFile(m, msvcrt.CRTDBG_FILE_STDERR) |
R. David Murray | 7dc72cc | 2009-11-14 16:13:02 +0000 | [diff] [blame] | 506 | elif o in ('-F', '--forever'): |
| 507 | forever = True |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 508 | elif o in ('-j', '--multiprocess'): |
| 509 | use_mp = int(a) |
Antoine Pitrou | 6ab79d9 | 2011-03-23 20:17:45 +0100 | [diff] [blame] | 510 | if use_mp <= 0: |
| 511 | try: |
| 512 | import multiprocessing |
| 513 | # Use all cores + extras for tests that like to sleep |
| 514 | use_mp = 2 + multiprocessing.cpu_count() |
| 515 | except (ImportError, NotImplementedError): |
| 516 | use_mp = 3 |
Nadeem Vawda | 3c01d16 | 2011-08-01 23:48:26 +0200 | [diff] [blame] | 517 | if use_mp == 1: |
| 518 | use_mp = None |
Antoine Pitrou | 3c4402f | 2011-01-03 20:38:52 +0000 | [diff] [blame] | 519 | elif o == '--header': |
| 520 | header = True |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 521 | elif o == '--slaveargs': |
| 522 | args, kwargs = json.loads(a) |
| 523 | try: |
| 524 | result = runtest(*args, **kwargs) |
Victor Stinner | 2965011 | 2012-08-08 22:37:26 +0200 | [diff] [blame] | 525 | except KeyboardInterrupt: |
| 526 | result = INTERRUPTED, '' |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 527 | except BaseException as e: |
Victor Stinner | 2965011 | 2012-08-08 22:37:26 +0200 | [diff] [blame] | 528 | traceback.print_exc() |
| 529 | result = CHILD_ERROR, str(e) |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 530 | sys.stdout.flush() |
| 531 | print() # Force a newline (just in case) |
| 532 | print(json.dumps(result)) |
| 533 | sys.exit(0) |
R David Murray | b588f8d | 2011-03-24 14:42:58 -0400 | [diff] [blame] | 534 | elif o == '--testdir': |
| 535 | # CWD is replaced with a temporary dir before calling main(), so we |
| 536 | # join it with the saved CWD so it ends up where the user expects. |
| 537 | testdir = os.path.join(support.SAVEDCWD, a) |
Victor Stinner | 0cc8d59 | 2011-03-31 18:10:13 +0200 | [diff] [blame] | 538 | elif o == '--timeout': |
Victor Stinner | 4de701b | 2013-06-17 20:27:10 +0200 | [diff] [blame] | 539 | if hasattr(faulthandler, 'dump_traceback_later'): |
Victor Stinner | 8834568 | 2011-06-06 12:14:23 +0200 | [diff] [blame] | 540 | timeout = float(a) |
| 541 | if timeout <= 0: |
| 542 | timeout = None |
| 543 | else: |
| 544 | print("Warning: The timeout option requires " |
Victor Stinner | 4de701b | 2013-06-17 20:27:10 +0200 | [diff] [blame] | 545 | "faulthandler.dump_traceback_later") |
Victor Stinner | 9e586c2 | 2011-06-06 12:04:36 +0200 | [diff] [blame] | 546 | timeout = None |
Brian Curtin | f664345 | 2011-04-28 17:45:17 -0500 | [diff] [blame] | 547 | elif o == '--wait': |
| 548 | input("Press any key to continue...") |
R. David Murray | 35768ad | 2009-11-15 00:23:21 +0000 | [diff] [blame] | 549 | else: |
| 550 | print(("No handler for option {}. Please report this as a bug " |
Georg Brandl | dee7b85 | 2010-08-02 18:59:52 +0000 | [diff] [blame] | 551 | "at http://bugs.python.org.").format(o), file=sys.stderr) |
R. David Murray | 35768ad | 2009-11-15 00:23:21 +0000 | [diff] [blame] | 552 | sys.exit(1) |
Tim Peters | c5000df | 2002-06-02 21:42:01 +0000 | [diff] [blame] | 553 | if single and fromfile: |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 554 | usage("-s and -f don't go together!") |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 555 | if use_mp and trace: |
Florent Xicluna | 64fb18e | 2010-03-06 14:43:34 +0000 | [diff] [blame] | 556 | usage("-T and -j don't go together!") |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 557 | if use_mp and findleaks: |
Florent Xicluna | 64fb18e | 2010-03-06 14:43:34 +0000 | [diff] [blame] | 558 | usage("-l and -j don't go together!") |
Nadeem Vawda | c1fba3e | 2011-08-27 15:22:05 +0200 | [diff] [blame] | 559 | if use_mp and support.max_memuse: |
| 560 | usage("-M and -j don't go together!") |
Antoine Pitrou | 216a3bc | 2011-07-23 22:33:39 +0200 | [diff] [blame] | 561 | if failfast and not (verbose or verbose3): |
| 562 | usage("-G/--failfast needs either -v or -W") |
Barry Warsaw | 08fca52 | 2001-08-20 22:33:46 +0000 | [diff] [blame] | 563 | |
Guido van Rossum | 152494a | 1996-12-20 03:12:20 +0000 | [diff] [blame] | 564 | good = [] |
| 565 | bad = [] |
| 566 | skipped = [] |
Fred Drake | 9a0db07 | 2003-02-03 15:19:30 +0000 | [diff] [blame] | 567 | resource_denieds = [] |
Nick Coghlan | 6ead552 | 2009-10-18 13:19:33 +0000 | [diff] [blame] | 568 | environment_changed = [] |
Florent Xicluna | d6995eb | 2010-03-30 19:43:09 +0000 | [diff] [blame] | 569 | interrupted = False |
Barry Warsaw | e11e3de | 1999-01-28 19:51:51 +0000 | [diff] [blame] | 570 | |
Neil Schemenauer | d569f23 | 2000-09-22 15:29:28 +0000 | [diff] [blame] | 571 | if findleaks: |
Barry Warsaw | a873b03 | 2000-08-03 15:50:37 +0000 | [diff] [blame] | 572 | try: |
| 573 | import gc |
Brett Cannon | c9a1bfe | 2013-06-12 20:12:30 -0400 | [diff] [blame] | 574 | except ModuleNotFoundError: |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 575 | print('No GC available, disabling findleaks.') |
Barry Warsaw | 3b6d025 | 2004-02-07 22:43:03 +0000 | [diff] [blame] | 576 | findleaks = False |
Barry Warsaw | a873b03 | 2000-08-03 15:50:37 +0000 | [diff] [blame] | 577 | else: |
Neil Schemenauer | 8a00abc | 2000-10-13 01:32:42 +0000 | [diff] [blame] | 578 | # Uncomment the line below to report garbage that is not |
| 579 | # freeable by reference counting alone. By default only |
| 580 | # garbage that is not collectable by the GC is reported. |
| 581 | #gc.set_debug(gc.DEBUG_SAVEALL) |
Neil Schemenauer | d569f23 | 2000-09-22 15:29:28 +0000 | [diff] [blame] | 582 | found_garbage = [] |
Barry Warsaw | a873b03 | 2000-08-03 15:50:37 +0000 | [diff] [blame] | 583 | |
Barry Warsaw | e11e3de | 1999-01-28 19:51:51 +0000 | [diff] [blame] | 584 | if single: |
Florent Xicluna | ec88221 | 2010-08-09 16:56:43 +0000 | [diff] [blame] | 585 | filename = os.path.join(TEMPDIR, 'pynexttest') |
Barry Warsaw | e11e3de | 1999-01-28 19:51:51 +0000 | [diff] [blame] | 586 | try: |
| 587 | fp = open(filename, 'r') |
R. David Murray | 7dc72cc | 2009-11-14 16:13:02 +0000 | [diff] [blame] | 588 | next_test = fp.read().strip() |
| 589 | tests = [next_test] |
Barry Warsaw | e11e3de | 1999-01-28 19:51:51 +0000 | [diff] [blame] | 590 | fp.close() |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 591 | except OSError: |
Barry Warsaw | e11e3de | 1999-01-28 19:51:51 +0000 | [diff] [blame] | 592 | pass |
Tim Peters | c5000df | 2002-06-02 21:42:01 +0000 | [diff] [blame] | 593 | |
| 594 | if fromfile: |
| 595 | tests = [] |
Ezio Melotti | 184bdfb | 2010-02-18 09:37:05 +0000 | [diff] [blame] | 596 | fp = open(os.path.join(support.SAVEDCWD, fromfile)) |
Antoine Pitrou | d95c7b5 | 2010-11-07 20:50:51 +0000 | [diff] [blame] | 597 | count_pat = re.compile(r'\[\s*\d+/\s*\d+\]') |
Tim Peters | c5000df | 2002-06-02 21:42:01 +0000 | [diff] [blame] | 598 | for line in fp: |
Antoine Pitrou | d95c7b5 | 2010-11-07 20:50:51 +0000 | [diff] [blame] | 599 | line = count_pat.sub('', line) |
Tim Peters | c5000df | 2002-06-02 21:42:01 +0000 | [diff] [blame] | 600 | guts = line.split() # assuming no test has whitespace in its name |
| 601 | if guts and not guts[0].startswith('#'): |
| 602 | tests.extend(guts) |
| 603 | fp.close() |
| 604 | |
| 605 | # Strip .py extensions. |
Florent Xicluna | da7bfd5 | 2010-03-06 11:43:55 +0000 | [diff] [blame] | 606 | removepy(args) |
| 607 | removepy(tests) |
Tim Peters | c5000df | 2002-06-02 21:42:01 +0000 | [diff] [blame] | 608 | |
Guido van Rossum | 6c74fea | 1998-08-25 12:29:08 +0000 | [diff] [blame] | 609 | stdtests = STDTESTS[:] |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 610 | nottests = NOTTESTS.copy() |
Guido van Rossum | 152494a | 1996-12-20 03:12:20 +0000 | [diff] [blame] | 611 | if exclude: |
Guido van Rossum | 6c74fea | 1998-08-25 12:29:08 +0000 | [diff] [blame] | 612 | for arg in args: |
| 613 | if arg in stdtests: |
| 614 | stdtests.remove(arg) |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 615 | nottests.add(arg) |
Guido van Rossum | 41360a4 | 1998-03-26 19:42:58 +0000 | [diff] [blame] | 616 | args = [] |
Florent Xicluna | 0e62a14 | 2010-03-06 17:34:48 +0000 | [diff] [blame] | 617 | |
| 618 | # For a partial run, we do not need to clutter the output. |
Antoine Pitrou | 3c4402f | 2011-01-03 20:38:52 +0000 | [diff] [blame] | 619 | if verbose or header or not (quiet or single or tests or args): |
Florent Xicluna | 0e62a14 | 2010-03-06 17:34:48 +0000 | [diff] [blame] | 620 | # Print basic platform information |
| 621 | print("==", platform.python_implementation(), *sys.version.split()) |
Florent Xicluna | ec88221 | 2010-08-09 16:56:43 +0000 | [diff] [blame] | 622 | print("== ", platform.platform(aliased=True), |
| 623 | "%s-endian" % sys.byteorder) |
Florent Xicluna | 0e62a14 | 2010-03-06 17:34:48 +0000 | [diff] [blame] | 624 | print("== ", os.getcwd()) |
Antoine Pitrou | 3c4402f | 2011-01-03 20:38:52 +0000 | [diff] [blame] | 625 | print("Testing with flags:", sys.flags) |
Florent Xicluna | 0e62a14 | 2010-03-06 17:34:48 +0000 | [diff] [blame] | 626 | |
R David Murray | b588f8d | 2011-03-24 14:42:58 -0400 | [diff] [blame] | 627 | # if testdir is set, then we are not running the python tests suite, so |
| 628 | # don't add default tests to be executed or skipped (pass empty values) |
| 629 | if testdir: |
| 630 | alltests = findtests(testdir, list(), set()) |
| 631 | else: |
| 632 | alltests = findtests(testdir, stdtests, nottests) |
| 633 | |
Florent Xicluna | d6995eb | 2010-03-30 19:43:09 +0000 | [diff] [blame] | 634 | selected = tests or args or alltests |
Barry Warsaw | e11e3de | 1999-01-28 19:51:51 +0000 | [diff] [blame] | 635 | if single: |
Florent Xicluna | d6995eb | 2010-03-30 19:43:09 +0000 | [diff] [blame] | 636 | selected = selected[:1] |
R. David Murray | ef1992b | 2009-12-16 15:19:27 +0000 | [diff] [blame] | 637 | try: |
Florent Xicluna | d6995eb | 2010-03-30 19:43:09 +0000 | [diff] [blame] | 638 | next_single_test = alltests[alltests.index(selected[0])+1] |
R. David Murray | ef1992b | 2009-12-16 15:19:27 +0000 | [diff] [blame] | 639 | except IndexError: |
| 640 | next_single_test = None |
R David Murray | c3bf78a | 2012-10-27 17:07:05 -0400 | [diff] [blame] | 641 | # Remove all the selected tests that precede start if it's set. |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 642 | if start: |
| 643 | try: |
R David Murray | c3bf78a | 2012-10-27 17:07:05 -0400 | [diff] [blame] | 644 | del selected[:selected.index(start)] |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 645 | except ValueError: |
| 646 | print("Couldn't find starting test (%s), using all tests" % start) |
Skip Montanaro | ab1c791 | 2000-06-30 16:39:27 +0000 | [diff] [blame] | 647 | if randomize: |
Collin Winter | fd12f49 | 2009-03-29 04:05:05 +0000 | [diff] [blame] | 648 | random.seed(random_seed) |
| 649 | print("Using random seed", random_seed) |
Florent Xicluna | d6995eb | 2010-03-30 19:43:09 +0000 | [diff] [blame] | 650 | random.shuffle(selected) |
Barry Warsaw | 3b6d025 | 2004-02-07 22:43:03 +0000 | [diff] [blame] | 651 | if trace: |
Georg Brandl | 33c2881 | 2009-04-01 23:07:29 +0000 | [diff] [blame] | 652 | import trace, tempfile |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 653 | tracer = trace.Trace(ignoredirs=[sys.base_prefix, sys.base_exec_prefix, |
Georg Brandl | 33c2881 | 2009-04-01 23:07:29 +0000 | [diff] [blame] | 654 | tempfile.gettempdir()], |
Barry Warsaw | 3b6d025 | 2004-02-07 22:43:03 +0000 | [diff] [blame] | 655 | trace=False, count=True) |
R. David Murray | 7dc72cc | 2009-11-14 16:13:02 +0000 | [diff] [blame] | 656 | |
Christian Heimes | b186d00 | 2008-03-18 15:15:01 +0000 | [diff] [blame] | 657 | test_times = [] |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 658 | support.verbose = verbose # Tell tests to be moderately quiet |
| 659 | support.use_resources = use_resources |
Guido van Rossum | 5796d26 | 2000-04-21 21:35:06 +0000 | [diff] [blame] | 660 | save_modules = sys.modules.keys() |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 661 | |
| 662 | def accumulate_result(test, result): |
| 663 | ok, test_time = result |
| 664 | test_times.append((test_time, test)) |
Benjamin Peterson | a0dfa82 | 2009-11-13 02:25:08 +0000 | [diff] [blame] | 665 | if ok == PASSED: |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 666 | good.append(test) |
Benjamin Peterson | a0dfa82 | 2009-11-13 02:25:08 +0000 | [diff] [blame] | 667 | elif ok == FAILED: |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 668 | bad.append(test) |
Benjamin Peterson | a0dfa82 | 2009-11-13 02:25:08 +0000 | [diff] [blame] | 669 | elif ok == ENV_CHANGED: |
Benjamin Peterson | a0dfa82 | 2009-11-13 02:25:08 +0000 | [diff] [blame] | 670 | environment_changed.append(test) |
| 671 | elif ok == SKIPPED: |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 672 | skipped.append(test) |
Benjamin Peterson | a0dfa82 | 2009-11-13 02:25:08 +0000 | [diff] [blame] | 673 | elif ok == RESOURCE_DENIED: |
| 674 | skipped.append(test) |
| 675 | resource_denieds.append(test) |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 676 | |
R. David Murray | 7dc72cc | 2009-11-14 16:13:02 +0000 | [diff] [blame] | 677 | if forever: |
Florent Xicluna | d6995eb | 2010-03-30 19:43:09 +0000 | [diff] [blame] | 678 | def test_forever(tests=list(selected)): |
R. David Murray | 7dc72cc | 2009-11-14 16:13:02 +0000 | [diff] [blame] | 679 | while True: |
| 680 | for test in tests: |
| 681 | yield test |
| 682 | if bad: |
| 683 | return |
| 684 | tests = test_forever() |
Georg Brandl | e8e02e3 | 2010-08-03 07:56:50 +0000 | [diff] [blame] | 685 | test_count = '' |
| 686 | test_count_width = 3 |
R. David Murray | 7dc72cc | 2009-11-14 16:13:02 +0000 | [diff] [blame] | 687 | else: |
Florent Xicluna | d6995eb | 2010-03-30 19:43:09 +0000 | [diff] [blame] | 688 | tests = iter(selected) |
Georg Brandl | e8e02e3 | 2010-08-03 07:56:50 +0000 | [diff] [blame] | 689 | test_count = '/{}'.format(len(selected)) |
| 690 | test_count_width = len(test_count) - 1 |
R. David Murray | 7dc72cc | 2009-11-14 16:13:02 +0000 | [diff] [blame] | 691 | |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 692 | if use_mp: |
Victor Stinner | 45df820 | 2010-04-28 22:31:17 +0000 | [diff] [blame] | 693 | try: |
| 694 | from threading import Thread |
Brett Cannon | c9a1bfe | 2013-06-12 20:12:30 -0400 | [diff] [blame] | 695 | except ModuleNotFoundError: |
Victor Stinner | 45df820 | 2010-04-28 22:31:17 +0000 | [diff] [blame] | 696 | print("Multiprocess option requires thread support") |
| 697 | sys.exit(2) |
Georg Brandl | 1b37e87 | 2010-03-14 10:45:50 +0000 | [diff] [blame] | 698 | from queue import Queue |
| 699 | from subprocess import Popen, PIPE |
Antoine Pitrou | f9d0b12 | 2012-12-09 14:28:26 +0100 | [diff] [blame] | 700 | debug_output_pat = re.compile(r"\[\d+ refs, \d+ blocks\]$") |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 701 | output = Queue() |
Antoine Pitrou | 09f2e6f | 2012-07-26 00:45:19 +0200 | [diff] [blame] | 702 | pending = MultiprocessTests(tests) |
Antoine Pitrou | 1b03f2c | 2010-10-14 11:12:00 +0000 | [diff] [blame] | 703 | opt_args = support.args_from_interpreter_flags() |
| 704 | base_cmd = [sys.executable] + opt_args + ['-m', 'test.regrtest'] |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 705 | def work(): |
| 706 | # A worker thread. |
Neal Norwitz | 14ca327 | 2006-02-28 18:05:43 +0000 | [diff] [blame] | 707 | try: |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 708 | while True: |
| 709 | try: |
Antoine Pitrou | 09f2e6f | 2012-07-26 00:45:19 +0200 | [diff] [blame] | 710 | test = next(pending) |
R. David Murray | 7dc72cc | 2009-11-14 16:13:02 +0000 | [diff] [blame] | 711 | except StopIteration: |
R. David Murray | 2714460 | 2009-10-19 15:26:16 +0000 | [diff] [blame] | 712 | output.put((None, None, None, None)) |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 713 | return |
Antoine Pitrou | 09f2e6f | 2012-07-26 00:45:19 +0200 | [diff] [blame] | 714 | args_tuple = ( |
| 715 | (test, verbose, quiet), |
| 716 | dict(huntrleaks=huntrleaks, use_resources=use_resources, |
| 717 | debug=debug, output_on_failure=verbose3, |
Antoine Pitrou | 0b9e7b9 | 2012-07-26 00:47:15 +0200 | [diff] [blame] | 718 | timeout=timeout, failfast=failfast, |
| 719 | match_tests=match_tests) |
Antoine Pitrou | 09f2e6f | 2012-07-26 00:45:19 +0200 | [diff] [blame] | 720 | ) |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 721 | # -E is needed by some tests, e.g. test_import |
Antoine Pitrou | 282083d | 2012-07-11 19:19:14 +0200 | [diff] [blame] | 722 | # Running the child from the same working directory ensures |
| 723 | # that TEMPDIR for the child is the same when |
| 724 | # sysconfig.is_python_build() is true. See issue 15300. |
Antoine Pitrou | 1b03f2c | 2010-10-14 11:12:00 +0000 | [diff] [blame] | 725 | popen = Popen(base_cmd + ['--slaveargs', json.dumps(args_tuple)], |
R. David Murray | 2714460 | 2009-10-19 15:26:16 +0000 | [diff] [blame] | 726 | stdout=PIPE, stderr=PIPE, |
Antoine Pitrou | 36e778e | 2010-08-18 20:44:14 +0000 | [diff] [blame] | 727 | universal_newlines=True, |
Antoine Pitrou | 282083d | 2012-07-11 19:19:14 +0200 | [diff] [blame] | 728 | close_fds=(os.name != 'nt'), |
| 729 | cwd=support.SAVEDCWD) |
R. David Murray | 2714460 | 2009-10-19 15:26:16 +0000 | [diff] [blame] | 730 | stdout, stderr = popen.communicate() |
Victor Stinner | 4b73988 | 2011-03-31 18:02:36 +0200 | [diff] [blame] | 731 | retcode = popen.wait() |
R. David Murray | 2714460 | 2009-10-19 15:26:16 +0000 | [diff] [blame] | 732 | # Strip last refcount output line if it exists, since it |
| 733 | # comes from the shutdown of the interpreter in the subcommand. |
| 734 | stderr = debug_output_pat.sub("", stderr) |
| 735 | stdout, _, result = stdout.strip().rpartition("\n") |
Victor Stinner | 4b73988 | 2011-03-31 18:02:36 +0200 | [diff] [blame] | 736 | if retcode != 0: |
| 737 | result = (CHILD_ERROR, "Exit code %s" % retcode) |
| 738 | output.put((test, stdout.rstrip(), stderr.rstrip(), result)) |
| 739 | return |
R. David Murray | 7dc72cc | 2009-11-14 16:13:02 +0000 | [diff] [blame] | 740 | if not result: |
| 741 | output.put((None, None, None, None)) |
| 742 | return |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 743 | result = json.loads(result) |
R. David Murray | 2714460 | 2009-10-19 15:26:16 +0000 | [diff] [blame] | 744 | output.put((test, stdout.rstrip(), stderr.rstrip(), result)) |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 745 | except BaseException: |
R. David Murray | 2714460 | 2009-10-19 15:26:16 +0000 | [diff] [blame] | 746 | output.put((None, None, None, None)) |
Neal Norwitz | 14ca327 | 2006-02-28 18:05:43 +0000 | [diff] [blame] | 747 | raise |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 748 | workers = [Thread(target=work) for i in range(use_mp)] |
| 749 | for worker in workers: |
| 750 | worker.start() |
| 751 | finished = 0 |
Georg Brandl | dee7b85 | 2010-08-02 18:59:52 +0000 | [diff] [blame] | 752 | test_index = 1 |
R. David Murray | 7dc72cc | 2009-11-14 16:13:02 +0000 | [diff] [blame] | 753 | try: |
| 754 | while finished < use_mp: |
| 755 | test, stdout, stderr, result = output.get() |
| 756 | if test is None: |
| 757 | finished += 1 |
| 758 | continue |
Victor Stinner | a2a895c | 2011-05-23 23:14:05 +0200 | [diff] [blame] | 759 | accumulate_result(test, result) |
Georg Brandl | dee7b85 | 2010-08-02 18:59:52 +0000 | [diff] [blame] | 760 | if not quiet: |
Ezio Melotti | 84f75c6 | 2011-05-24 01:00:10 +0300 | [diff] [blame] | 761 | fmt = "[{1:{0}}{2}/{3}] {4}" if bad else "[{1:{0}}{2}] {4}" |
| 762 | print(fmt.format( |
Victor Stinner | a2a895c | 2011-05-23 23:14:05 +0200 | [diff] [blame] | 763 | test_count_width, test_index, test_count, |
| 764 | len(bad), test)) |
R. David Murray | 7dc72cc | 2009-11-14 16:13:02 +0000 | [diff] [blame] | 765 | if stdout: |
| 766 | print(stdout) |
| 767 | if stderr: |
| 768 | print(stderr, file=sys.stderr) |
Antoine Pitrou | 8237258 | 2012-06-27 17:41:07 +0200 | [diff] [blame] | 769 | sys.stdout.flush() |
| 770 | sys.stderr.flush() |
R. David Murray | 7dc72cc | 2009-11-14 16:13:02 +0000 | [diff] [blame] | 771 | if result[0] == INTERRUPTED: |
Victor Stinner | 2965011 | 2012-08-08 22:37:26 +0200 | [diff] [blame] | 772 | raise KeyboardInterrupt |
Victor Stinner | 4b73988 | 2011-03-31 18:02:36 +0200 | [diff] [blame] | 773 | if result[0] == CHILD_ERROR: |
Victor Stinner | 571e8fd | 2011-05-01 22:57:43 +0200 | [diff] [blame] | 774 | raise Exception("Child error on {}: {}".format(test, result[1])) |
Georg Brandl | dee7b85 | 2010-08-02 18:59:52 +0000 | [diff] [blame] | 775 | test_index += 1 |
R. David Murray | 7dc72cc | 2009-11-14 16:13:02 +0000 | [diff] [blame] | 776 | except KeyboardInterrupt: |
Florent Xicluna | d6995eb | 2010-03-30 19:43:09 +0000 | [diff] [blame] | 777 | interrupted = True |
Antoine Pitrou | 09f2e6f | 2012-07-26 00:45:19 +0200 | [diff] [blame] | 778 | pending.interrupted = True |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 779 | for worker in workers: |
| 780 | worker.join() |
| 781 | else: |
Georg Brandl | dee7b85 | 2010-08-02 18:59:52 +0000 | [diff] [blame] | 782 | for test_index, test in enumerate(tests, 1): |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 783 | if not quiet: |
Ezio Melotti | 84f75c6 | 2011-05-24 01:00:10 +0300 | [diff] [blame] | 784 | fmt = "[{1:{0}}{2}/{3}] {4}" if bad else "[{1:{0}}{2}] {4}" |
| 785 | print(fmt.format( |
Victor Stinner | a2a895c | 2011-05-23 23:14:05 +0200 | [diff] [blame] | 786 | test_count_width, test_index, test_count, len(bad), test)) |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 787 | sys.stdout.flush() |
| 788 | if trace: |
| 789 | # If we're tracing code coverage, then we don't exit with status |
| 790 | # if on a false return value from main. |
Victor Stinner | 0cc8d59 | 2011-03-31 18:10:13 +0200 | [diff] [blame] | 791 | tracer.runctx('runtest(test, verbose, quiet, timeout=timeout)', |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 792 | globals=globals(), locals=vars()) |
Barry Warsaw | 3b6d025 | 2004-02-07 22:43:03 +0000 | [diff] [blame] | 793 | else: |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 794 | try: |
Antoine Pitrou | 293954d | 2011-03-23 23:01:49 +0100 | [diff] [blame] | 795 | result = runtest(test, verbose, quiet, huntrleaks, debug, |
Antoine Pitrou | 216a3bc | 2011-07-23 22:33:39 +0200 | [diff] [blame] | 796 | output_on_failure=verbose3, |
Antoine Pitrou | f83e4ac | 2011-07-29 23:57:10 +0200 | [diff] [blame] | 797 | timeout=timeout, failfast=failfast, |
| 798 | match_tests=match_tests) |
Benjamin Peterson | a0dfa82 | 2009-11-13 02:25:08 +0000 | [diff] [blame] | 799 | accumulate_result(test, result) |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 800 | except KeyboardInterrupt: |
Florent Xicluna | d6995eb | 2010-03-30 19:43:09 +0000 | [diff] [blame] | 801 | interrupted = True |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 802 | break |
| 803 | except: |
| 804 | raise |
| 805 | if findleaks: |
| 806 | gc.collect() |
| 807 | if gc.garbage: |
| 808 | print("Warning: test created", len(gc.garbage), end=' ') |
| 809 | print("uncollectable object(s).") |
| 810 | # move the uncollectable objects somewhere so we don't see |
| 811 | # them again |
| 812 | found_garbage.extend(gc.garbage) |
| 813 | del gc.garbage[:] |
| 814 | # Unload the newly imported modules (best effort finalization) |
| 815 | for module in sys.modules.keys(): |
| 816 | if module not in save_modules and module.startswith("test."): |
| 817 | support.unload(module) |
Jeremy Hylton | 7a1ea0e | 2001-10-17 13:45:28 +0000 | [diff] [blame] | 818 | |
Florent Xicluna | d6995eb | 2010-03-30 19:43:09 +0000 | [diff] [blame] | 819 | if interrupted: |
| 820 | # print a newline after ^C |
| 821 | print() |
| 822 | print("Test suite interrupted by signal SIGINT.") |
| 823 | omitted = set(selected) - set(good) - set(bad) - set(skipped) |
| 824 | print(count(len(omitted), "test"), "omitted:") |
| 825 | printlist(omitted) |
Guido van Rossum | 152494a | 1996-12-20 03:12:20 +0000 | [diff] [blame] | 826 | if good and not quiet: |
Florent Xicluna | d6995eb | 2010-03-30 19:43:09 +0000 | [diff] [blame] | 827 | if not bad and not skipped and not interrupted and len(good) > 1: |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 828 | print("All", end=' ') |
| 829 | print(count(len(good), "test"), "OK.") |
Christian Heimes | b186d00 | 2008-03-18 15:15:01 +0000 | [diff] [blame] | 830 | if print_slow: |
| 831 | test_times.sort(reverse=True) |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 832 | print("10 slowest tests:") |
Christian Heimes | b186d00 | 2008-03-18 15:15:01 +0000 | [diff] [blame] | 833 | for time, test in test_times[:10]: |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 834 | print("%s: %.1fs" % (test, time)) |
Guido van Rossum | 152494a | 1996-12-20 03:12:20 +0000 | [diff] [blame] | 835 | if bad: |
Nick Coghlan | 6ead552 | 2009-10-18 13:19:33 +0000 | [diff] [blame] | 836 | bad = sorted(set(bad) - set(environment_changed)) |
| 837 | if bad: |
| 838 | print(count(len(bad), "test"), "failed:") |
| 839 | printlist(bad) |
Vinay Sajip | f959618 | 2012-03-02 01:01:13 +0000 | [diff] [blame] | 840 | if environment_changed: |
| 841 | print("{} altered the execution environment:".format( |
| 842 | count(len(environment_changed), "test"))) |
| 843 | printlist(environment_changed) |
Guido van Rossum | 152494a | 1996-12-20 03:12:20 +0000 | [diff] [blame] | 844 | if skipped and not quiet: |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 845 | print(count(len(skipped), "test"), "skipped:") |
Tim Peters | a45da92 | 2001-08-12 03:45:50 +0000 | [diff] [blame] | 846 | printlist(skipped) |
Barry Warsaw | e11e3de | 1999-01-28 19:51:51 +0000 | [diff] [blame] | 847 | |
Martin v. Löwis | 04824ce | 2006-03-10 21:26:16 +0000 | [diff] [blame] | 848 | if verbose2 and bad: |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 849 | print("Re-running failed tests in verbose mode") |
Martin v. Löwis | 04824ce | 2006-03-10 21:26:16 +0000 | [diff] [blame] | 850 | for test in bad: |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 851 | print("Re-running test %r in verbose mode" % test) |
Tim Peters | 922dd7d | 2006-03-10 23:37:10 +0000 | [diff] [blame] | 852 | sys.stdout.flush() |
Martin v. Löwis | 04824ce | 2006-03-10 21:26:16 +0000 | [diff] [blame] | 853 | try: |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 854 | verbose = True |
Victor Stinner | 0cc8d59 | 2011-03-31 18:10:13 +0200 | [diff] [blame] | 855 | ok = runtest(test, True, quiet, huntrleaks, debug, timeout=timeout) |
Martin v. Löwis | 04824ce | 2006-03-10 21:26:16 +0000 | [diff] [blame] | 856 | except KeyboardInterrupt: |
| 857 | # print a newline separate from the ^C |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 858 | print() |
Martin v. Löwis | 04824ce | 2006-03-10 21:26:16 +0000 | [diff] [blame] | 859 | break |
| 860 | except: |
| 861 | raise |
| 862 | |
Barry Warsaw | e11e3de | 1999-01-28 19:51:51 +0000 | [diff] [blame] | 863 | if single: |
R. David Murray | ef1992b | 2009-12-16 15:19:27 +0000 | [diff] [blame] | 864 | if next_single_test: |
| 865 | with open(filename, 'w') as fp: |
| 866 | fp.write(next_single_test + '\n') |
Barry Warsaw | e11e3de | 1999-01-28 19:51:51 +0000 | [diff] [blame] | 867 | else: |
| 868 | os.unlink(filename) |
| 869 | |
Barry Warsaw | 3b6d025 | 2004-02-07 22:43:03 +0000 | [diff] [blame] | 870 | if trace: |
| 871 | r = tracer.results() |
| 872 | r.write_results(show_missing=True, summary=True, coverdir=coverdir) |
| 873 | |
Skip Montanaro | 0179a18 | 2004-06-06 15:53:18 +0000 | [diff] [blame] | 874 | if runleaks: |
| 875 | os.system("leaks %d" % os.getpid()) |
| 876 | |
Florent Xicluna | d6995eb | 2010-03-30 19:43:09 +0000 | [diff] [blame] | 877 | sys.exit(len(bad) > 0 or interrupted) |
Barry Warsaw | 08fca52 | 2001-08-20 22:33:46 +0000 | [diff] [blame] | 878 | |
Guido van Rossum | 152494a | 1996-12-20 03:12:20 +0000 | [diff] [blame] | 879 | |
R David Murray | b588f8d | 2011-03-24 14:42:58 -0400 | [diff] [blame] | 880 | # small set of tests to determine if we have a basically functioning interpreter |
| 881 | # (i.e. if any of these fail, then anything else is likely to follow) |
Guido van Rossum | 6fd83b7 | 1998-08-01 17:04:08 +0000 | [diff] [blame] | 882 | STDTESTS = [ |
Guido van Rossum | 152494a | 1996-12-20 03:12:20 +0000 | [diff] [blame] | 883 | 'test_grammar', |
| 884 | 'test_opcodes', |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 885 | 'test_dict', |
Guido van Rossum | 152494a | 1996-12-20 03:12:20 +0000 | [diff] [blame] | 886 | 'test_builtin', |
| 887 | 'test_exceptions', |
| 888 | 'test_types', |
Collin Winter | 7afaa88 | 2007-03-08 19:54:43 +0000 | [diff] [blame] | 889 | 'test_unittest', |
| 890 | 'test_doctest', |
| 891 | 'test_doctest2', |
Eli Bendersky | d18a047 | 2011-07-27 20:21:45 +0300 | [diff] [blame] | 892 | 'test_support' |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 893 | ] |
Guido van Rossum | 152494a | 1996-12-20 03:12:20 +0000 | [diff] [blame] | 894 | |
R David Murray | b588f8d | 2011-03-24 14:42:58 -0400 | [diff] [blame] | 895 | # set of tests that we don't want to be executed when using regrtest |
R David Murray | 5764830 | 2011-03-24 14:57:05 -0400 | [diff] [blame] | 896 | NOTTESTS = set() |
Guido van Rossum | 152494a | 1996-12-20 03:12:20 +0000 | [diff] [blame] | 897 | |
Guido van Rossum | 6fd83b7 | 1998-08-01 17:04:08 +0000 | [diff] [blame] | 898 | def findtests(testdir=None, stdtests=STDTESTS, nottests=NOTTESTS): |
Guido van Rossum | 152494a | 1996-12-20 03:12:20 +0000 | [diff] [blame] | 899 | """Return a list of all applicable test modules.""" |
Florent Xicluna | da7bfd5 | 2010-03-06 11:43:55 +0000 | [diff] [blame] | 900 | testdir = findtestdir(testdir) |
Guido van Rossum | 152494a | 1996-12-20 03:12:20 +0000 | [diff] [blame] | 901 | names = os.listdir(testdir) |
| 902 | tests = [] |
Florent Xicluna | da7bfd5 | 2010-03-06 11:43:55 +0000 | [diff] [blame] | 903 | others = set(stdtests) | nottests |
Guido van Rossum | 152494a | 1996-12-20 03:12:20 +0000 | [diff] [blame] | 904 | for name in names: |
R David Murray | 661720e | 2011-03-21 15:14:34 -0400 | [diff] [blame] | 905 | mod, ext = os.path.splitext(name) |
| 906 | if mod[:5] == "test_" and ext in (".py", "") and mod not in others: |
| 907 | tests.append(mod) |
Florent Xicluna | da7bfd5 | 2010-03-06 11:43:55 +0000 | [diff] [blame] | 908 | return stdtests + sorted(tests) |
Guido van Rossum | 152494a | 1996-12-20 03:12:20 +0000 | [diff] [blame] | 909 | |
Antoine Pitrou | 09f2e6f | 2012-07-26 00:45:19 +0200 | [diff] [blame] | 910 | # We do not use a generator so multiple threads can call next(). |
| 911 | class MultiprocessTests(object): |
| 912 | |
| 913 | """A thread-safe iterator over tests for multiprocess mode.""" |
| 914 | |
| 915 | def __init__(self, tests): |
| 916 | self.interrupted = False |
| 917 | self.lock = threading.Lock() |
| 918 | self.tests = tests |
| 919 | |
| 920 | def __iter__(self): |
| 921 | return self |
| 922 | |
| 923 | def __next__(self): |
| 924 | with self.lock: |
| 925 | if self.interrupted: |
| 926 | raise StopIteration('tests interrupted') |
| 927 | return next(self.tests) |
| 928 | |
Victor Stinner | f58087b | 2010-05-02 17:24:51 +0000 | [diff] [blame] | 929 | def replace_stdout(): |
| 930 | """Set stdout encoder error handler to backslashreplace (as stderr error |
| 931 | handler) to avoid UnicodeEncodeError when printing a traceback""" |
Victor Stinner | 4b2b43d | 2011-01-05 03:54:26 +0000 | [diff] [blame] | 932 | import atexit |
| 933 | |
Victor Stinner | f58087b | 2010-05-02 17:24:51 +0000 | [diff] [blame] | 934 | stdout = sys.stdout |
| 935 | sys.stdout = open(stdout.fileno(), 'w', |
| 936 | encoding=stdout.encoding, |
Victor Stinner | 4b2b43d | 2011-01-05 03:54:26 +0000 | [diff] [blame] | 937 | errors="backslashreplace", |
Victor Stinner | be62103 | 2011-05-25 02:01:55 +0200 | [diff] [blame] | 938 | closefd=False, |
| 939 | newline='\n') |
Victor Stinner | 4b2b43d | 2011-01-05 03:54:26 +0000 | [diff] [blame] | 940 | |
| 941 | def restore_stdout(): |
| 942 | sys.stdout.close() |
| 943 | sys.stdout = stdout |
| 944 | atexit.register(restore_stdout) |
Victor Stinner | f58087b | 2010-05-02 17:24:51 +0000 | [diff] [blame] | 945 | |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 946 | def runtest(test, verbose, quiet, |
Antoine Pitrou | 293954d | 2011-03-23 23:01:49 +0100 | [diff] [blame] | 947 | huntrleaks=False, debug=False, use_resources=None, |
Antoine Pitrou | f83e4ac | 2011-07-29 23:57:10 +0200 | [diff] [blame] | 948 | output_on_failure=False, failfast=False, match_tests=None, |
| 949 | timeout=None): |
Guido van Rossum | 6fd83b7 | 1998-08-01 17:04:08 +0000 | [diff] [blame] | 950 | """Run a single test. |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 951 | |
Guido van Rossum | 6fd83b7 | 1998-08-01 17:04:08 +0000 | [diff] [blame] | 952 | test -- the name of the test |
Guido van Rossum | 6fd83b7 | 1998-08-01 17:04:08 +0000 | [diff] [blame] | 953 | verbose -- if true, print more messages |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 954 | quiet -- if true, don't print 'skipped' messages (probably redundant) |
Christian Heimes | b186d00 | 2008-03-18 15:15:01 +0000 | [diff] [blame] | 955 | test_times -- a list of (time, test_name) pairs |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 956 | huntrleaks -- run multiple times to test for leaks; requires a debug |
| 957 | build; a triple corresponding to -R's three arguments |
Victor Stinner | 8313d6a | 2011-06-29 15:22:26 +0200 | [diff] [blame] | 958 | output_on_failure -- if true, display test output on failure |
Victor Stinner | 0cc8d59 | 2011-03-31 18:10:13 +0200 | [diff] [blame] | 959 | timeout -- dump the traceback and exit if a test takes more than |
| 960 | timeout seconds |
Benjamin Peterson | a0dfa82 | 2009-11-13 02:25:08 +0000 | [diff] [blame] | 961 | |
| 962 | Returns one of the test result constants: |
| 963 | INTERRUPTED KeyboardInterrupt when run under -j |
| 964 | RESOURCE_DENIED test skipped because resource denied |
| 965 | SKIPPED test skipped for some other reason |
| 966 | ENV_CHANGED test failed because it changed the execution environment |
| 967 | FAILED test failed |
| 968 | PASSED test passed |
Guido van Rossum | 6fd83b7 | 1998-08-01 17:04:08 +0000 | [diff] [blame] | 969 | """ |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 970 | |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 971 | if use_resources is not None: |
| 972 | support.use_resources = use_resources |
Victor Stinner | 3019688 | 2011-06-03 12:53:26 +0200 | [diff] [blame] | 973 | use_timeout = (timeout is not None) |
Victor Stinner | 7d648a0 | 2011-03-31 18:27:50 +0200 | [diff] [blame] | 974 | if use_timeout: |
Victor Stinner | 4de701b | 2013-06-17 20:27:10 +0200 | [diff] [blame] | 975 | faulthandler.dump_traceback_later(timeout, exit=True) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 976 | try: |
Antoine Pitrou | b9c73e8 | 2011-07-29 23:53:38 +0200 | [diff] [blame] | 977 | support.match_tests = match_tests |
Antoine Pitrou | 216a3bc | 2011-07-23 22:33:39 +0200 | [diff] [blame] | 978 | if failfast: |
| 979 | support.failfast = True |
Victor Stinner | 8313d6a | 2011-06-29 15:22:26 +0200 | [diff] [blame] | 980 | if output_on_failure: |
Victor Stinner | ea95de7 | 2011-06-29 15:34:48 +0200 | [diff] [blame] | 981 | support.verbose = True |
| 982 | |
| 983 | # Reuse the same instance to all calls to runtest(). Some |
| 984 | # tests keep a reference to sys.stdout or sys.stderr |
| 985 | # (eg. test_argparse). |
Victor Stinner | 8313d6a | 2011-06-29 15:22:26 +0200 | [diff] [blame] | 986 | if runtest.stringio is None: |
Victor Stinner | fcc2a21 | 2011-06-29 20:01:29 +0200 | [diff] [blame] | 987 | stream = io.StringIO() |
| 988 | runtest.stringio = stream |
| 989 | else: |
| 990 | stream = runtest.stringio |
| 991 | stream.seek(0) |
| 992 | stream.truncate() |
Victor Stinner | 8313d6a | 2011-06-29 15:22:26 +0200 | [diff] [blame] | 993 | |
| 994 | orig_stdout = sys.stdout |
Victor Stinner | a7c33e5 | 2011-06-29 13:00:54 +0200 | [diff] [blame] | 995 | orig_stderr = sys.stderr |
Victor Stinner | 8313d6a | 2011-06-29 15:22:26 +0200 | [diff] [blame] | 996 | try: |
Victor Stinner | ea95de7 | 2011-06-29 15:34:48 +0200 | [diff] [blame] | 997 | sys.stdout = stream |
| 998 | sys.stderr = stream |
Victor Stinner | 8313d6a | 2011-06-29 15:22:26 +0200 | [diff] [blame] | 999 | result = runtest_inner(test, verbose, quiet, huntrleaks, |
| 1000 | debug, display_failure=False) |
| 1001 | if result[0] == FAILED: |
Victor Stinner | ea95de7 | 2011-06-29 15:34:48 +0200 | [diff] [blame] | 1002 | output = stream.getvalue() |
Victor Stinner | 8313d6a | 2011-06-29 15:22:26 +0200 | [diff] [blame] | 1003 | orig_stderr.write(output) |
| 1004 | orig_stderr.flush() |
| 1005 | finally: |
| 1006 | sys.stdout = orig_stdout |
| 1007 | sys.stderr = orig_stderr |
Victor Stinner | a7c33e5 | 2011-06-29 13:00:54 +0200 | [diff] [blame] | 1008 | else: |
Victor Stinner | ea95de7 | 2011-06-29 15:34:48 +0200 | [diff] [blame] | 1009 | support.verbose = verbose # Tell tests to be moderately quiet |
Victor Stinner | a7c33e5 | 2011-06-29 13:00:54 +0200 | [diff] [blame] | 1010 | result = runtest_inner(test, verbose, quiet, huntrleaks, debug, |
| 1011 | display_failure=not verbose) |
Antoine Pitrou | 293954d | 2011-03-23 23:01:49 +0100 | [diff] [blame] | 1012 | return result |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1013 | finally: |
Victor Stinner | 7d648a0 | 2011-03-31 18:27:50 +0200 | [diff] [blame] | 1014 | if use_timeout: |
Victor Stinner | 934676a | 2013-06-17 20:35:08 +0200 | [diff] [blame] | 1015 | faulthandler.cancel_dump_traceback_later() |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1016 | cleanup_test_droppings(test, verbose) |
Victor Stinner | 8313d6a | 2011-06-29 15:22:26 +0200 | [diff] [blame] | 1017 | runtest.stringio = None |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1018 | |
Nick Coghlan | 6ead552 | 2009-10-18 13:19:33 +0000 | [diff] [blame] | 1019 | # Unit tests are supposed to leave the execution environment unchanged |
| 1020 | # once they complete. But sometimes tests have bugs, especially when |
| 1021 | # tests fail, and the changes to environment go on to mess up other |
| 1022 | # tests. This can cause issues with buildbot stability, since tests |
| 1023 | # are run in random order and so problems may appear to come and go. |
| 1024 | # There are a few things we can save and restore to mitigate this, and |
| 1025 | # the following context manager handles this task. |
| 1026 | |
| 1027 | class saved_test_environment: |
| 1028 | """Save bits of the test environment and restore them at block exit. |
| 1029 | |
| 1030 | with saved_test_environment(testname, verbose, quiet): |
| 1031 | #stuff |
| 1032 | |
| 1033 | Unless quiet is True, a warning is printed to stderr if any of |
| 1034 | the saved items was changed by the test. The attribute 'changed' |
| 1035 | is initially False, but is set to True if a change is detected. |
| 1036 | |
| 1037 | If verbose is more than 1, the before and after state of changed |
| 1038 | items is also printed. |
| 1039 | """ |
| 1040 | |
| 1041 | changed = False |
| 1042 | |
| 1043 | def __init__(self, testname, verbose=0, quiet=False): |
| 1044 | self.testname = testname |
| 1045 | self.verbose = verbose |
| 1046 | self.quiet = quiet |
| 1047 | |
| 1048 | # To add things to save and restore, add a name XXX to the resources list |
| 1049 | # and add corresponding get_XXX/restore_XXX functions. get_XXX should |
| 1050 | # return the value to be saved and compared against a second call to the |
| 1051 | # get function when test execution completes. restore_XXX should accept |
| 1052 | # the saved value and restore the resource using it. It will be called if |
| 1053 | # and only if a change in the value is detected. |
| 1054 | # |
| 1055 | # Note: XXX will have any '.' replaced with '_' characters when determining |
| 1056 | # the corresponding method names. |
| 1057 | |
| 1058 | resources = ('sys.argv', 'cwd', 'sys.stdin', 'sys.stdout', 'sys.stderr', |
Brett Cannon | 29c0e4f | 2010-03-20 22:22:57 +0000 | [diff] [blame] | 1059 | 'os.environ', 'sys.path', 'sys.path_hooks', '__import__', |
Nick Coghlan | 7bd5dbe | 2010-12-05 07:17:25 +0000 | [diff] [blame] | 1060 | 'warnings.filters', 'asyncore.socket_map', |
Ezio Melotti | 45763d0 | 2011-03-20 15:34:28 +0200 | [diff] [blame] | 1061 | 'logging._handlers', 'logging._handlerList', 'sys.gettrace', |
Antoine Pitrou | c081c0c | 2011-07-15 22:12:24 +0200 | [diff] [blame] | 1062 | 'sys.warnoptions', 'threading._dangling', |
Éric Araujo | 28df8de | 2011-09-19 05:10:45 +0200 | [diff] [blame] | 1063 | 'multiprocessing.process._dangling', |
Éric Araujo | ec177c1 | 2012-06-24 03:27:43 -0400 | [diff] [blame] | 1064 | 'sysconfig._CONFIG_VARS', 'sysconfig._INSTALL_SCHEMES', |
Brett Cannon | 6d26eba | 2013-06-16 15:20:48 -0400 | [diff] [blame] | 1065 | 'support.TESTFN', 'locale', 'warnings.showwarning', |
Éric Araujo | 28df8de | 2011-09-19 05:10:45 +0200 | [diff] [blame] | 1066 | ) |
Nick Coghlan | 6ead552 | 2009-10-18 13:19:33 +0000 | [diff] [blame] | 1067 | |
| 1068 | def get_sys_argv(self): |
| 1069 | return id(sys.argv), sys.argv, sys.argv[:] |
| 1070 | def restore_sys_argv(self, saved_argv): |
| 1071 | sys.argv = saved_argv[1] |
| 1072 | sys.argv[:] = saved_argv[2] |
| 1073 | |
| 1074 | def get_cwd(self): |
| 1075 | return os.getcwd() |
| 1076 | def restore_cwd(self, saved_cwd): |
| 1077 | os.chdir(saved_cwd) |
| 1078 | |
| 1079 | def get_sys_stdout(self): |
| 1080 | return sys.stdout |
| 1081 | def restore_sys_stdout(self, saved_stdout): |
| 1082 | sys.stdout = saved_stdout |
| 1083 | |
| 1084 | def get_sys_stderr(self): |
| 1085 | return sys.stderr |
| 1086 | def restore_sys_stderr(self, saved_stderr): |
| 1087 | sys.stderr = saved_stderr |
| 1088 | |
| 1089 | def get_sys_stdin(self): |
| 1090 | return sys.stdin |
| 1091 | def restore_sys_stdin(self, saved_stdin): |
| 1092 | sys.stdin = saved_stdin |
| 1093 | |
| 1094 | def get_os_environ(self): |
| 1095 | return id(os.environ), os.environ, dict(os.environ) |
| 1096 | def restore_os_environ(self, saved_environ): |
| 1097 | os.environ = saved_environ[1] |
| 1098 | os.environ.clear() |
| 1099 | os.environ.update(saved_environ[2]) |
| 1100 | |
| 1101 | def get_sys_path(self): |
| 1102 | return id(sys.path), sys.path, sys.path[:] |
| 1103 | def restore_sys_path(self, saved_path): |
| 1104 | sys.path = saved_path[1] |
| 1105 | sys.path[:] = saved_path[2] |
| 1106 | |
Brett Cannon | 055470a | 2010-02-19 15:57:10 +0000 | [diff] [blame] | 1107 | def get_sys_path_hooks(self): |
| 1108 | return id(sys.path_hooks), sys.path_hooks, sys.path_hooks[:] |
| 1109 | def restore_sys_path_hooks(self, saved_hooks): |
| 1110 | sys.path_hooks = saved_hooks[1] |
| 1111 | sys.path_hooks[:] = saved_hooks[2] |
| 1112 | |
Brett Cannon | 31f5929 | 2011-02-21 19:29:56 +0000 | [diff] [blame] | 1113 | def get_sys_gettrace(self): |
| 1114 | return sys.gettrace() |
| 1115 | def restore_sys_gettrace(self, trace_fxn): |
| 1116 | sys.settrace(trace_fxn) |
| 1117 | |
Brett Cannon | 055470a | 2010-02-19 15:57:10 +0000 | [diff] [blame] | 1118 | def get___import__(self): |
Brett Cannon | 4507190 | 2010-06-14 22:22:54 +0000 | [diff] [blame] | 1119 | return builtins.__import__ |
Brett Cannon | 055470a | 2010-02-19 15:57:10 +0000 | [diff] [blame] | 1120 | def restore___import__(self, import_): |
Brett Cannon | 4507190 | 2010-06-14 22:22:54 +0000 | [diff] [blame] | 1121 | builtins.__import__ = import_ |
Brett Cannon | 055470a | 2010-02-19 15:57:10 +0000 | [diff] [blame] | 1122 | |
Brett Cannon | 29c0e4f | 2010-03-20 22:22:57 +0000 | [diff] [blame] | 1123 | def get_warnings_filters(self): |
| 1124 | return id(warnings.filters), warnings.filters, warnings.filters[:] |
| 1125 | def restore_warnings_filters(self, saved_filters): |
| 1126 | warnings.filters = saved_filters[1] |
| 1127 | warnings.filters[:] = saved_filters[2] |
| 1128 | |
Antoine Pitrou | b14ac8c | 2010-08-16 00:28:05 +0000 | [diff] [blame] | 1129 | def get_asyncore_socket_map(self): |
| 1130 | asyncore = sys.modules.get('asyncore') |
Antoine Pitrou | aa87965 | 2010-10-29 11:54:38 +0000 | [diff] [blame] | 1131 | # XXX Making a copy keeps objects alive until __exit__ gets called. |
| 1132 | return asyncore and asyncore.socket_map.copy() or {} |
Antoine Pitrou | b14ac8c | 2010-08-16 00:28:05 +0000 | [diff] [blame] | 1133 | def restore_asyncore_socket_map(self, saved_map): |
| 1134 | asyncore = sys.modules.get('asyncore') |
| 1135 | if asyncore is not None: |
Antoine Pitrou | aa87965 | 2010-10-29 11:54:38 +0000 | [diff] [blame] | 1136 | asyncore.close_all(ignore_all=True) |
Antoine Pitrou | b14ac8c | 2010-08-16 00:28:05 +0000 | [diff] [blame] | 1137 | asyncore.socket_map.update(saved_map) |
| 1138 | |
Éric Araujo | ff91306 | 2011-11-29 16:45:07 +0100 | [diff] [blame] | 1139 | def get_shutil_archive_formats(self): |
| 1140 | # we could call get_archives_formats() but that only returns the |
| 1141 | # registry keys; we want to check the values too (the functions that |
| 1142 | # are registered) |
| 1143 | return shutil._ARCHIVE_FORMATS, shutil._ARCHIVE_FORMATS.copy() |
| 1144 | def restore_shutil_archive_formats(self, saved): |
| 1145 | shutil._ARCHIVE_FORMATS = saved[0] |
| 1146 | shutil._ARCHIVE_FORMATS.clear() |
| 1147 | shutil._ARCHIVE_FORMATS.update(saved[1]) |
| 1148 | |
| 1149 | def get_shutil_unpack_formats(self): |
| 1150 | return shutil._UNPACK_FORMATS, shutil._UNPACK_FORMATS.copy() |
| 1151 | def restore_shutil_unpack_formats(self, saved): |
| 1152 | shutil._UNPACK_FORMATS = saved[0] |
| 1153 | shutil._UNPACK_FORMATS.clear() |
| 1154 | shutil._UNPACK_FORMATS.update(saved[1]) |
| 1155 | |
Nick Coghlan | 7d81975 | 2010-12-05 06:45:03 +0000 | [diff] [blame] | 1156 | def get_logging__handlers(self): |
| 1157 | # _handlers is a WeakValueDictionary |
Nick Coghlan | 7bd5dbe | 2010-12-05 07:17:25 +0000 | [diff] [blame] | 1158 | return id(logging._handlers), logging._handlers, logging._handlers.copy() |
Nick Coghlan | 7d81975 | 2010-12-05 06:45:03 +0000 | [diff] [blame] | 1159 | def restore_logging__handlers(self, saved_handlers): |
| 1160 | # Can't easily revert the logging state |
| 1161 | pass |
| 1162 | |
Nick Coghlan | 7bd5dbe | 2010-12-05 07:17:25 +0000 | [diff] [blame] | 1163 | def get_logging__handlerList(self): |
| 1164 | # _handlerList is a list of weakrefs to handlers |
| 1165 | return id(logging._handlerList), logging._handlerList, logging._handlerList[:] |
| 1166 | def restore_logging__handlerList(self, saved_handlerList): |
| 1167 | # Can't easily revert the logging state |
| 1168 | pass |
| 1169 | |
Ezio Melotti | 0123e05 | 2011-03-20 15:09:26 +0200 | [diff] [blame] | 1170 | def get_sys_warnoptions(self): |
| 1171 | return id(sys.warnoptions), sys.warnoptions, sys.warnoptions[:] |
| 1172 | def restore_sys_warnoptions(self, saved_options): |
| 1173 | sys.warnoptions = saved_options[1] |
| 1174 | sys.warnoptions[:] = saved_options[2] |
| 1175 | |
Antoine Pitrou | c081c0c | 2011-07-15 22:12:24 +0200 | [diff] [blame] | 1176 | # Controlling dangling references to Thread objects can make it easier |
| 1177 | # to track reference leaks. |
| 1178 | def get_threading__dangling(self): |
| 1179 | if not threading: |
| 1180 | return None |
| 1181 | # This copies the weakrefs without making any strong reference |
| 1182 | return threading._dangling.copy() |
| 1183 | def restore_threading__dangling(self, saved): |
| 1184 | if not threading: |
| 1185 | return |
| 1186 | threading._dangling.clear() |
| 1187 | threading._dangling.update(saved) |
| 1188 | |
| 1189 | # Same for Process objects |
| 1190 | def get_multiprocessing_process__dangling(self): |
| 1191 | if not multiprocessing: |
| 1192 | return None |
| 1193 | # This copies the weakrefs without making any strong reference |
| 1194 | return multiprocessing.process._dangling.copy() |
| 1195 | def restore_multiprocessing_process__dangling(self, saved): |
| 1196 | if not multiprocessing: |
| 1197 | return |
| 1198 | multiprocessing.process._dangling.clear() |
| 1199 | multiprocessing.process._dangling.update(saved) |
| 1200 | |
Éric Araujo | 28df8de | 2011-09-19 05:10:45 +0200 | [diff] [blame] | 1201 | def get_sysconfig__CONFIG_VARS(self): |
| 1202 | # make sure the dict is initialized |
| 1203 | sysconfig.get_config_var('prefix') |
| 1204 | return (id(sysconfig._CONFIG_VARS), sysconfig._CONFIG_VARS, |
| 1205 | dict(sysconfig._CONFIG_VARS)) |
| 1206 | def restore_sysconfig__CONFIG_VARS(self, saved): |
| 1207 | sysconfig._CONFIG_VARS = saved[1] |
| 1208 | sysconfig._CONFIG_VARS.clear() |
| 1209 | sysconfig._CONFIG_VARS.update(saved[2]) |
| 1210 | |
Éric Araujo | ec177c1 | 2012-06-24 03:27:43 -0400 | [diff] [blame] | 1211 | def get_sysconfig__INSTALL_SCHEMES(self): |
| 1212 | return (id(sysconfig._INSTALL_SCHEMES), sysconfig._INSTALL_SCHEMES, |
| 1213 | sysconfig._INSTALL_SCHEMES.copy()) |
| 1214 | def restore_sysconfig__INSTALL_SCHEMES(self, saved): |
| 1215 | sysconfig._INSTALL_SCHEMES = saved[1] |
| 1216 | sysconfig._INSTALL_SCHEMES.clear() |
| 1217 | sysconfig._INSTALL_SCHEMES.update(saved[2]) |
Éric Araujo | 28df8de | 2011-09-19 05:10:45 +0200 | [diff] [blame] | 1218 | |
Vinay Sajip | f959618 | 2012-03-02 01:01:13 +0000 | [diff] [blame] | 1219 | def get_support_TESTFN(self): |
| 1220 | if os.path.isfile(support.TESTFN): |
| 1221 | result = 'f' |
| 1222 | elif os.path.isdir(support.TESTFN): |
| 1223 | result = 'd' |
| 1224 | else: |
| 1225 | result = None |
| 1226 | return result |
| 1227 | def restore_support_TESTFN(self, saved_value): |
| 1228 | if saved_value is None: |
| 1229 | if os.path.isfile(support.TESTFN): |
| 1230 | os.unlink(support.TESTFN) |
| 1231 | elif os.path.isdir(support.TESTFN): |
| 1232 | shutil.rmtree(support.TESTFN) |
Éric Araujo | 28df8de | 2011-09-19 05:10:45 +0200 | [diff] [blame] | 1233 | |
Victor Stinner | d9ccf7f | 2013-06-17 20:40:05 +0200 | [diff] [blame] | 1234 | _lc = [getattr(locale, lc) for lc in dir(locale) |
Victor Stinner | 546ccf0 | 2013-06-17 21:28:14 +0200 | [diff] [blame] | 1235 | if lc.startswith('LC_')] |
Brett Cannon | 49e835b | 2013-04-01 14:11:37 -0400 | [diff] [blame] | 1236 | def get_locale(self): |
| 1237 | pairings = [] |
| 1238 | for lc in self._lc: |
| 1239 | try: |
Victor Stinner | 546ccf0 | 2013-06-17 21:28:14 +0200 | [diff] [blame] | 1240 | pairings.append((lc, locale.setlocale(lc, None))) |
Victor Stinner | d9ccf7f | 2013-06-17 20:40:05 +0200 | [diff] [blame] | 1241 | except (TypeError, ValueError): |
Brett Cannon | 49e835b | 2013-04-01 14:11:37 -0400 | [diff] [blame] | 1242 | continue |
| 1243 | return pairings |
| 1244 | def restore_locale(self, saved): |
| 1245 | for lc, setting in saved: |
| 1246 | locale.setlocale(lc, setting) |
| 1247 | |
Brett Cannon | 6d26eba | 2013-06-16 15:20:48 -0400 | [diff] [blame] | 1248 | def get_warnings_showwarning(self): |
| 1249 | return warnings.showwarning |
| 1250 | def restore_warnings_showwarning(self, fxn): |
| 1251 | warnings.showwarning = fxn |
| 1252 | |
Nick Coghlan | 6ead552 | 2009-10-18 13:19:33 +0000 | [diff] [blame] | 1253 | def resource_info(self): |
| 1254 | for name in self.resources: |
| 1255 | method_suffix = name.replace('.', '_') |
| 1256 | get_name = 'get_' + method_suffix |
| 1257 | restore_name = 'restore_' + method_suffix |
| 1258 | yield name, getattr(self, get_name), getattr(self, restore_name) |
| 1259 | |
| 1260 | def __enter__(self): |
| 1261 | self.saved_values = dict((name, get()) for name, get, restore |
| 1262 | in self.resource_info()) |
| 1263 | return self |
| 1264 | |
| 1265 | def __exit__(self, exc_type, exc_val, exc_tb): |
Antoine Pitrou | aa87965 | 2010-10-29 11:54:38 +0000 | [diff] [blame] | 1266 | saved_values = self.saved_values |
| 1267 | del self.saved_values |
Nick Coghlan | 6ead552 | 2009-10-18 13:19:33 +0000 | [diff] [blame] | 1268 | for name, get, restore in self.resource_info(): |
| 1269 | current = get() |
Antoine Pitrou | aa87965 | 2010-10-29 11:54:38 +0000 | [diff] [blame] | 1270 | original = saved_values.pop(name) |
Nick Coghlan | 6ead552 | 2009-10-18 13:19:33 +0000 | [diff] [blame] | 1271 | # Check for changes to the resource's value |
| 1272 | if current != original: |
| 1273 | self.changed = True |
| 1274 | restore(original) |
| 1275 | if not self.quiet: |
| 1276 | print("Warning -- {} was modified by {}".format( |
| 1277 | name, self.testname), |
| 1278 | file=sys.stderr) |
| 1279 | if self.verbose > 1: |
| 1280 | print(" Before: {}\n After: {} ".format( |
| 1281 | original, current), |
| 1282 | file=sys.stderr) |
| 1283 | return False |
| 1284 | |
| 1285 | |
Victor Stinner | a7c33e5 | 2011-06-29 13:00:54 +0200 | [diff] [blame] | 1286 | def runtest_inner(test, verbose, quiet, |
| 1287 | huntrleaks=False, debug=False, display_failure=True): |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 1288 | support.unload(test) |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1289 | |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 1290 | test_time = 0.0 |
Collin Winter | a5503d5 | 2009-05-15 01:20:21 +0000 | [diff] [blame] | 1291 | refleak = False # True if the test leaked references. |
Guido van Rossum | 152494a | 1996-12-20 03:12:20 +0000 | [diff] [blame] | 1292 | try: |
R. David Murray | 0bc11ae | 2009-10-18 22:18:17 +0000 | [diff] [blame] | 1293 | if test.startswith('test.'): |
| 1294 | abstest = test |
| 1295 | else: |
| 1296 | # Always import it from the test package |
| 1297 | abstest = 'test.' + test |
| 1298 | with saved_test_environment(test, verbose, quiet) as environment: |
| 1299 | start_time = time.time() |
Brett Cannon | 613cf25 | 2012-11-14 13:42:51 -0500 | [diff] [blame] | 1300 | the_module = importlib.import_module(abstest) |
R David Murray | 78fc25c | 2012-04-09 08:55:42 -0400 | [diff] [blame] | 1301 | # If the test has a test_main, that will run the appropriate |
| 1302 | # tests. If not, use normal unittest test loading. |
| 1303 | test_runner = getattr(the_module, "test_main", None) |
| 1304 | if test_runner is None: |
| 1305 | tests = unittest.TestLoader().loadTestsFromModule(the_module) |
| 1306 | test_runner = lambda: support.run_unittest(tests) |
| 1307 | test_runner() |
R. David Murray | 0bc11ae | 2009-10-18 22:18:17 +0000 | [diff] [blame] | 1308 | if huntrleaks: |
R David Murray | 78fc25c | 2012-04-09 08:55:42 -0400 | [diff] [blame] | 1309 | refleak = dash_R(the_module, test, test_runner, |
R. David Murray | 0bc11ae | 2009-10-18 22:18:17 +0000 | [diff] [blame] | 1310 | huntrleaks) |
| 1311 | test_time = time.time() - start_time |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 1312 | except support.ResourceDenied as msg: |
Fred Drake | 9a0db07 | 2003-02-03 15:19:30 +0000 | [diff] [blame] | 1313 | if not quiet: |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 1314 | print(test, "skipped --", msg) |
Fred Drake | 9a0db07 | 2003-02-03 15:19:30 +0000 | [diff] [blame] | 1315 | sys.stdout.flush() |
Benjamin Peterson | a0dfa82 | 2009-11-13 02:25:08 +0000 | [diff] [blame] | 1316 | return RESOURCE_DENIED, test_time |
R. David Murray | a21e4ca | 2009-03-31 23:16:50 +0000 | [diff] [blame] | 1317 | except unittest.SkipTest as msg: |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 1318 | if not quiet: |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 1319 | print(test, "skipped --", msg) |
Guido van Rossum | 3cda93e | 2002-09-13 21:28:03 +0000 | [diff] [blame] | 1320 | sys.stdout.flush() |
Benjamin Peterson | a0dfa82 | 2009-11-13 02:25:08 +0000 | [diff] [blame] | 1321 | return SKIPPED, test_time |
Fred Drake | fe5c22a | 2000-08-18 16:04:05 +0000 | [diff] [blame] | 1322 | except KeyboardInterrupt: |
| 1323 | raise |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 1324 | except support.TestFailed as msg: |
Victor Stinner | a7c33e5 | 2011-06-29 13:00:54 +0200 | [diff] [blame] | 1325 | if display_failure: |
| 1326 | print("test", test, "failed --", msg, file=sys.stderr) |
| 1327 | else: |
| 1328 | print("test", test, "failed", file=sys.stderr) |
R. David Murray | 11cabcf | 2010-09-29 01:08:05 +0000 | [diff] [blame] | 1329 | sys.stderr.flush() |
Benjamin Peterson | a0dfa82 | 2009-11-13 02:25:08 +0000 | [diff] [blame] | 1330 | return FAILED, test_time |
Guido van Rossum | 9e48b27 | 1997-07-16 01:56:13 +0000 | [diff] [blame] | 1331 | except: |
Antoine Pitrou | 779a5b0 | 2011-03-21 19:55:16 +0100 | [diff] [blame] | 1332 | msg = traceback.format_exc() |
| 1333 | print("test", test, "crashed --", msg, file=sys.stderr) |
R. David Murray | 11cabcf | 2010-09-29 01:08:05 +0000 | [diff] [blame] | 1334 | sys.stderr.flush() |
Benjamin Peterson | a0dfa82 | 2009-11-13 02:25:08 +0000 | [diff] [blame] | 1335 | return FAILED, test_time |
Guido van Rossum | 152494a | 1996-12-20 03:12:20 +0000 | [diff] [blame] | 1336 | else: |
Collin Winter | a5503d5 | 2009-05-15 01:20:21 +0000 | [diff] [blame] | 1337 | if refleak: |
Benjamin Peterson | a0dfa82 | 2009-11-13 02:25:08 +0000 | [diff] [blame] | 1338 | return FAILED, test_time |
Nick Coghlan | 6ead552 | 2009-10-18 13:19:33 +0000 | [diff] [blame] | 1339 | if environment.changed: |
Benjamin Peterson | a0dfa82 | 2009-11-13 02:25:08 +0000 | [diff] [blame] | 1340 | return ENV_CHANGED, test_time |
| 1341 | return PASSED, test_time |
Guido van Rossum | 0fcca4e | 2001-09-21 20:31:52 +0000 | [diff] [blame] | 1342 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1343 | def cleanup_test_droppings(testname, verbose): |
| 1344 | import shutil |
Benjamin Peterson | 25c95f1 | 2009-05-08 20:42:26 +0000 | [diff] [blame] | 1345 | import stat |
Antoine Pitrou | c14efc4 | 2010-10-29 19:34:45 +0000 | [diff] [blame] | 1346 | import gc |
| 1347 | |
| 1348 | # First kill any dangling references to open files etc. |
| 1349 | # This can also issue some ResourceWarnings which would otherwise get |
Antoine Pitrou | 2b40efd | 2010-10-29 19:36:37 +0000 | [diff] [blame] | 1350 | # triggered during the following test run, and possibly produce failures. |
Antoine Pitrou | c14efc4 | 2010-10-29 19:34:45 +0000 | [diff] [blame] | 1351 | gc.collect() |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1352 | |
| 1353 | # Try to clean up junk commonly left behind. While tests shouldn't leave |
| 1354 | # any files or directories behind, when a test fails that can be tedious |
| 1355 | # for it to arrange. The consequences can be especially nasty on Windows, |
| 1356 | # since if a test leaves a file open, it cannot be deleted by name (while |
| 1357 | # there's nothing we can do about that here either, we can display the |
| 1358 | # name of the offending test, which is a real help). |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 1359 | for name in (support.TESTFN, |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1360 | "db_home", |
| 1361 | ): |
| 1362 | if not os.path.exists(name): |
| 1363 | continue |
| 1364 | |
| 1365 | if os.path.isdir(name): |
| 1366 | kind, nuker = "directory", shutil.rmtree |
| 1367 | elif os.path.isfile(name): |
| 1368 | kind, nuker = "file", os.unlink |
| 1369 | else: |
| 1370 | raise SystemError("os.path says %r exists but is neither " |
| 1371 | "directory nor file" % name) |
| 1372 | |
| 1373 | if verbose: |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 1374 | print("%r left behind %s %r" % (testname, kind, name)) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1375 | try: |
Benjamin Peterson | 25c95f1 | 2009-05-08 20:42:26 +0000 | [diff] [blame] | 1376 | # if we have chmod, fix possible permissions problems |
| 1377 | # that might prevent cleanup |
| 1378 | if (hasattr(os, 'chmod')): |
| 1379 | os.chmod(name, stat.S_IRWXU | stat.S_IRWXG | stat.S_IRWXO) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1380 | nuker(name) |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 1381 | except Exception as msg: |
| 1382 | print(("%r left behind %s %r and it couldn't be " |
| 1383 | "removed: %s" % (testname, kind, name, msg)), file=sys.stderr) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1384 | |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1385 | def dash_R(the_module, test, indirect_test, huntrleaks): |
Collin Winter | a5503d5 | 2009-05-15 01:20:21 +0000 | [diff] [blame] | 1386 | """Run a test multiple times, looking for reference leaks. |
| 1387 | |
| 1388 | Returns: |
| 1389 | False if the test didn't leak references; True if we detected refleaks. |
| 1390 | """ |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1391 | # This code is hackish and inelegant, but it seems to do the job. |
Raymond Hettinger | 158c9c2 | 2011-02-22 00:41:50 +0000 | [diff] [blame] | 1392 | import copyreg |
| 1393 | import collections.abc |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1394 | |
| 1395 | if not hasattr(sys, 'gettotalrefcount'): |
| 1396 | raise Exception("Tracking reference leaks requires a debug build " |
| 1397 | "of Python") |
| 1398 | |
| 1399 | # Save current values for dash_R_cleanup() to restore. |
| 1400 | fs = warnings.filters[:] |
Alexandre Vassalotti | f7fa63d | 2008-05-11 08:55:36 +0000 | [diff] [blame] | 1401 | ps = copyreg.dispatch_table.copy() |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1402 | pic = sys.path_importer_cache.copy() |
Nick Coghlan | 260bd3e | 2009-11-16 06:49:25 +0000 | [diff] [blame] | 1403 | try: |
| 1404 | import zipimport |
Brett Cannon | c9a1bfe | 2013-06-12 20:12:30 -0400 | [diff] [blame] | 1405 | except ModuleNotFoundError: |
Nick Coghlan | 260bd3e | 2009-11-16 06:49:25 +0000 | [diff] [blame] | 1406 | zdc = None # Run unmodified on platforms without zipimport support |
| 1407 | else: |
| 1408 | zdc = zipimport._zip_directory_cache.copy() |
Christian Heimes | 9385266 | 2007-12-01 12:22:32 +0000 | [diff] [blame] | 1409 | abcs = {} |
Raymond Hettinger | 158c9c2 | 2011-02-22 00:41:50 +0000 | [diff] [blame] | 1410 | for abc in [getattr(collections.abc, a) for a in collections.abc.__all__]: |
Christian Heimes | be5b30b | 2008-03-03 19:18:51 +0000 | [diff] [blame] | 1411 | if not isabstract(abc): |
Christian Heimes | 9385266 | 2007-12-01 12:22:32 +0000 | [diff] [blame] | 1412 | continue |
| 1413 | for obj in abc.__subclasses__() + [abc]: |
| 1414 | abcs[obj] = obj._abc_registry.copy() |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1415 | |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1416 | nwarmup, ntracked, fname = huntrleaks |
Ezio Melotti | 184bdfb | 2010-02-18 09:37:05 +0000 | [diff] [blame] | 1417 | fname = os.path.join(support.SAVEDCWD, fname) |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1418 | repcount = nwarmup + ntracked |
Antoine Pitrou | f9d0b12 | 2012-12-09 14:28:26 +0100 | [diff] [blame] | 1419 | rc_deltas = [0] * repcount |
| 1420 | alloc_deltas = [0] * repcount |
| 1421 | |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 1422 | print("beginning", repcount, "repetitions", file=sys.stderr) |
| 1423 | print(("1234567890"*(repcount//10 + 1))[:repcount], file=sys.stderr) |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 1424 | sys.stderr.flush() |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1425 | for i in range(repcount): |
R David Murray | 14d080e | 2013-01-12 11:34:38 -0500 | [diff] [blame] | 1426 | indirect_test() |
Antoine Pitrou | f9d0b12 | 2012-12-09 14:28:26 +0100 | [diff] [blame] | 1427 | alloc_after, rc_after = dash_R_cleanup(fs, ps, pic, zdc, abcs) |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1428 | sys.stderr.write('.') |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 1429 | sys.stderr.flush() |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1430 | if i >= nwarmup: |
Antoine Pitrou | f9d0b12 | 2012-12-09 14:28:26 +0100 | [diff] [blame] | 1431 | rc_deltas[i] = rc_after - rc_before |
| 1432 | alloc_deltas[i] = alloc_after - alloc_before |
| 1433 | alloc_before, rc_before = alloc_after, rc_after |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 1434 | print(file=sys.stderr) |
Antoine Pitrou | f9d0b12 | 2012-12-09 14:28:26 +0100 | [diff] [blame] | 1435 | # These checkers return False on success, True on failure |
| 1436 | def check_rc_deltas(deltas): |
| 1437 | return any(deltas) |
| 1438 | def check_alloc_deltas(deltas): |
| 1439 | # At least 1/3rd of 0s |
| 1440 | if 3 * deltas.count(0) < len(deltas): |
| 1441 | return True |
| 1442 | # Nothing else than 1s, 0s and -1s |
| 1443 | if not set(deltas) <= {1,0,-1}: |
| 1444 | return True |
| 1445 | return False |
| 1446 | failed = False |
| 1447 | for deltas, item_name, checker in [ |
| 1448 | (rc_deltas, 'references', check_rc_deltas), |
| 1449 | (alloc_deltas, 'memory blocks', check_alloc_deltas)]: |
| 1450 | if checker(deltas): |
| 1451 | msg = '%s leaked %s %s, sum=%s' % ( |
| 1452 | test, deltas[nwarmup:], item_name, sum(deltas)) |
| 1453 | print(msg, file=sys.stderr) |
| 1454 | sys.stderr.flush() |
| 1455 | with open(fname, "a") as refrep: |
| 1456 | print(msg, file=refrep) |
| 1457 | refrep.flush() |
| 1458 | failed = True |
| 1459 | return failed |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1460 | |
Nick Coghlan | 260bd3e | 2009-11-16 06:49:25 +0000 | [diff] [blame] | 1461 | def dash_R_cleanup(fs, ps, pic, zdc, abcs): |
Alexandre Vassalotti | f7fa63d | 2008-05-11 08:55:36 +0000 | [diff] [blame] | 1462 | import gc, copyreg |
Brett Cannon | f4fd993 | 2008-05-10 21:11:46 +0000 | [diff] [blame] | 1463 | import _strptime, linecache |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1464 | import urllib.parse, urllib.request, mimetypes, doctest |
Raymond Hettinger | 158c9c2 | 2011-02-22 00:41:50 +0000 | [diff] [blame] | 1465 | import struct, filecmp, collections.abc |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1466 | from distutils.dir_util import _path_created |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 1467 | from weakref import WeakSet |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1468 | |
Christian Heimes | dae2a89 | 2008-04-19 00:55:37 +0000 | [diff] [blame] | 1469 | # Clear the warnings registry, so they can be displayed again |
| 1470 | for mod in sys.modules.values(): |
| 1471 | if hasattr(mod, '__warningregistry__'): |
| 1472 | del mod.__warningregistry__ |
| 1473 | |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1474 | # Restore some original values. |
| 1475 | warnings.filters[:] = fs |
Alexandre Vassalotti | f7fa63d | 2008-05-11 08:55:36 +0000 | [diff] [blame] | 1476 | copyreg.dispatch_table.clear() |
| 1477 | copyreg.dispatch_table.update(ps) |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1478 | sys.path_importer_cache.clear() |
| 1479 | sys.path_importer_cache.update(pic) |
Nick Coghlan | 260bd3e | 2009-11-16 06:49:25 +0000 | [diff] [blame] | 1480 | try: |
| 1481 | import zipimport |
Brett Cannon | c9a1bfe | 2013-06-12 20:12:30 -0400 | [diff] [blame] | 1482 | except ModuleNotFoundError: |
Nick Coghlan | 260bd3e | 2009-11-16 06:49:25 +0000 | [diff] [blame] | 1483 | pass # Run unmodified on platforms without zipimport support |
| 1484 | else: |
| 1485 | zipimport._zip_directory_cache.clear() |
| 1486 | zipimport._zip_directory_cache.update(zdc) |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1487 | |
Christian Heimes | 2685563 | 2008-01-27 23:50:43 +0000 | [diff] [blame] | 1488 | # clear type cache |
Christian Heimes | 15ebc88 | 2008-02-04 18:48:49 +0000 | [diff] [blame] | 1489 | sys._clear_type_cache() |
Christian Heimes | 2685563 | 2008-01-27 23:50:43 +0000 | [diff] [blame] | 1490 | |
Guido van Rossum | 3de862d | 2007-08-18 00:10:33 +0000 | [diff] [blame] | 1491 | # Clear ABC registries, restoring previously saved ABC registries. |
Raymond Hettinger | 158c9c2 | 2011-02-22 00:41:50 +0000 | [diff] [blame] | 1492 | for abc in [getattr(collections.abc, a) for a in collections.abc.__all__]: |
Christian Heimes | be5b30b | 2008-03-03 19:18:51 +0000 | [diff] [blame] | 1493 | if not isabstract(abc): |
Christian Heimes | 941973a | 2007-11-30 21:53:03 +0000 | [diff] [blame] | 1494 | continue |
Guido van Rossum | 7eaf822 | 2007-06-18 17:58:50 +0000 | [diff] [blame] | 1495 | for obj in abc.__subclasses__() + [abc]: |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 1496 | obj._abc_registry = abcs.get(obj, WeakSet()).copy() |
Guido van Rossum | c1e315d | 2007-08-20 19:29:24 +0000 | [diff] [blame] | 1497 | obj._abc_cache.clear() |
| 1498 | obj._abc_negative_cache.clear() |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 1499 | |
Antoine Pitrou | 046467c | 2009-10-30 18:30:35 +0000 | [diff] [blame] | 1500 | # Flush standard output, so that buffered data is sent to the OS and |
| 1501 | # associated Python objects are reclaimed. |
| 1502 | for stream in (sys.stdout, sys.stderr, sys.__stdout__, sys.__stderr__): |
| 1503 | if stream is not None: |
| 1504 | stream.flush() |
| 1505 | |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1506 | # Clear assorted module caches. |
| 1507 | _path_created.clear() |
| 1508 | re.purge() |
| 1509 | _strptime._regex_cache.clear() |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1510 | urllib.parse.clear_cache() |
| 1511 | urllib.request.urlcleanup() |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1512 | linecache.clearcache() |
| 1513 | mimetypes._default_mime_types() |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1514 | filecmp._cache.clear() |
Christian Heimes | a34706f | 2008-01-04 03:06:10 +0000 | [diff] [blame] | 1515 | struct._clearcache() |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1516 | doctest.master = None |
Meador Inge | 11e3813 | 2011-11-25 22:33:32 -0600 | [diff] [blame] | 1517 | try: |
| 1518 | import ctypes |
Brett Cannon | c9a1bfe | 2013-06-12 20:12:30 -0400 | [diff] [blame] | 1519 | except ModuleNotFoundError: |
Meador Inge | 11e3813 | 2011-11-25 22:33:32 -0600 | [diff] [blame] | 1520 | # Don't worry about resetting the cache if ctypes is not supported |
| 1521 | pass |
| 1522 | else: |
| 1523 | ctypes._reset_cache() |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1524 | |
Antoine Pitrou | f9d0b12 | 2012-12-09 14:28:26 +0100 | [diff] [blame] | 1525 | # Collect cyclic trash and read memory statistics immediately after. |
| 1526 | func1 = sys.getallocatedblocks |
| 1527 | func2 = sys.gettotalrefcount |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1528 | gc.collect() |
Antoine Pitrou | f9d0b12 | 2012-12-09 14:28:26 +0100 | [diff] [blame] | 1529 | return func1(), func2() |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1530 | |
Stefan Krah | 5c3ddc8 | 2012-08-17 23:09:48 +0200 | [diff] [blame] | 1531 | def warm_caches(): |
| 1532 | # char cache |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 1533 | s = bytes(range(256)) |
| 1534 | for i in range(256): |
| 1535 | s[i:i+1] |
Stefan Krah | 5c3ddc8 | 2012-08-17 23:09:48 +0200 | [diff] [blame] | 1536 | # unicode cache |
| 1537 | x = [chr(i) for i in range(256)] |
| 1538 | # int cache |
| 1539 | x = list(range(-5, 257)) |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 1540 | |
Florent Xicluna | da7bfd5 | 2010-03-06 11:43:55 +0000 | [diff] [blame] | 1541 | def findtestdir(path=None): |
| 1542 | return path or os.path.dirname(__file__) or os.curdir |
Guido van Rossum | 152494a | 1996-12-20 03:12:20 +0000 | [diff] [blame] | 1543 | |
Florent Xicluna | da7bfd5 | 2010-03-06 11:43:55 +0000 | [diff] [blame] | 1544 | def removepy(names): |
| 1545 | if not names: |
| 1546 | return |
| 1547 | for idx, name in enumerate(names): |
| 1548 | basename, ext = os.path.splitext(name) |
| 1549 | if ext == '.py': |
| 1550 | names[idx] = basename |
Tim Peters | c5000df | 2002-06-02 21:42:01 +0000 | [diff] [blame] | 1551 | |
Guido van Rossum | 152494a | 1996-12-20 03:12:20 +0000 | [diff] [blame] | 1552 | def count(n, word): |
| 1553 | if n == 1: |
Guido van Rossum | 41360a4 | 1998-03-26 19:42:58 +0000 | [diff] [blame] | 1554 | return "%d %s" % (n, word) |
Guido van Rossum | 152494a | 1996-12-20 03:12:20 +0000 | [diff] [blame] | 1555 | else: |
Guido van Rossum | 41360a4 | 1998-03-26 19:42:58 +0000 | [diff] [blame] | 1556 | return "%d %ss" % (n, word) |
Guido van Rossum | 152494a | 1996-12-20 03:12:20 +0000 | [diff] [blame] | 1557 | |
Tim Peters | a45da92 | 2001-08-12 03:45:50 +0000 | [diff] [blame] | 1558 | def printlist(x, width=70, indent=4): |
Tim Peters | 7c7efe9 | 2002-08-23 17:55:54 +0000 | [diff] [blame] | 1559 | """Print the elements of iterable x to stdout. |
Tim Peters | a45da92 | 2001-08-12 03:45:50 +0000 | [diff] [blame] | 1560 | |
| 1561 | Optional arg width (default 70) is the maximum line length. |
| 1562 | Optional arg indent (default 4) is the number of blanks with which to |
| 1563 | begin each line. |
| 1564 | """ |
| 1565 | |
Tim Peters | ba78bc4 | 2002-07-04 19:45:06 +0000 | [diff] [blame] | 1566 | from textwrap import fill |
| 1567 | blanks = ' ' * indent |
Florent Xicluna | fd1b093 | 2010-03-28 00:25:02 +0000 | [diff] [blame] | 1568 | # Print the sorted list: 'x' may be a '--random' list or a set() |
| 1569 | print(fill(' '.join(str(elt) for elt in sorted(x)), width, |
Neal Norwitz | 94fa2ee | 2008-03-31 02:55:15 +0000 | [diff] [blame] | 1570 | initial_indent=blanks, subsequent_indent=blanks)) |
Tim Peters | a45da92 | 2001-08-12 03:45:50 +0000 | [diff] [blame] | 1571 | |
Tim Peters | b5b7b78 | 2001-08-12 01:20:39 +0000 | [diff] [blame] | 1572 | |
Chris Jerdonek | 517e925 | 2013-02-27 09:02:53 -0800 | [diff] [blame] | 1573 | def main_in_temp_cwd(): |
| 1574 | """Run main() in a temporary working directory.""" |
Michael Foord | 3ab34cc | 2010-12-03 12:27:40 +0000 | [diff] [blame] | 1575 | if sysconfig.is_python_build(): |
Antoine Pitrou | ee42934 | 2011-04-16 18:53:59 +0200 | [diff] [blame] | 1576 | try: |
Michael Foord | 3ab34cc | 2010-12-03 12:27:40 +0000 | [diff] [blame] | 1577 | os.mkdir(TEMPDIR) |
Florent Xicluna | 68f71a3 | 2011-10-28 16:06:23 +0200 | [diff] [blame] | 1578 | except FileExistsError: |
| 1579 | pass |
Michael Foord | 3ab34cc | 2010-12-03 12:27:40 +0000 | [diff] [blame] | 1580 | |
| 1581 | # Define a writable temp dir that will be used as cwd while running |
| 1582 | # the tests. The name of the dir includes the pid to allow parallel |
| 1583 | # testing (see the -j option). |
Chris Jerdonek | 517e925 | 2013-02-27 09:02:53 -0800 | [diff] [blame] | 1584 | test_cwd = 'test_python_{}'.format(os.getpid()) |
| 1585 | test_cwd = os.path.join(TEMPDIR, test_cwd) |
Michael Foord | 3ab34cc | 2010-12-03 12:27:40 +0000 | [diff] [blame] | 1586 | |
Chris Jerdonek | 517e925 | 2013-02-27 09:02:53 -0800 | [diff] [blame] | 1587 | # Run the tests in a context manager that temporarily changes the CWD to a |
| 1588 | # temporary and writable directory. If it's not possible to create or |
| 1589 | # change the CWD, the original CWD will be used. The original CWD is |
| 1590 | # available from support.SAVEDCWD. |
| 1591 | with support.temp_cwd(test_cwd, quiet=True): |
| 1592 | main() |
| 1593 | |
Nick Coghlan | 4c4c0f2 | 2010-12-03 07:44:33 +0000 | [diff] [blame] | 1594 | |
Guido van Rossum | 152494a | 1996-12-20 03:12:20 +0000 | [diff] [blame] | 1595 | if __name__ == '__main__': |
Nick Coghlan | 4c4c0f2 | 2010-12-03 07:44:33 +0000 | [diff] [blame] | 1596 | # Remove regrtest.py's own directory from the module search path. Despite |
| 1597 | # the elimination of implicit relative imports, this is still needed to |
| 1598 | # ensure that submodules of the test package do not inappropriately appear |
| 1599 | # as top-level modules even when people (or buildbots!) invoke regrtest.py |
| 1600 | # directly instead of using the -m switch |
| 1601 | mydir = os.path.abspath(os.path.normpath(os.path.dirname(sys.argv[0]))) |
| 1602 | i = len(sys.path) |
| 1603 | while i >= 0: |
| 1604 | i -= 1 |
| 1605 | if os.path.abspath(os.path.normpath(sys.path[i])) == mydir: |
| 1606 | del sys.path[i] |
| 1607 | |
Florent Xicluna | dc69e72 | 2010-09-13 16:35:02 +0000 | [diff] [blame] | 1608 | # findtestdir() gets the dirname out of __file__, so we have to make it |
| 1609 | # absolute before changing the working directory. |
| 1610 | # For example __file__ may be relative when running trace or profile. |
| 1611 | # See issue #9323. |
| 1612 | __file__ = os.path.abspath(__file__) |
| 1613 | |
| 1614 | # sanity check |
Florent Xicluna | da7bfd5 | 2010-03-06 11:43:55 +0000 | [diff] [blame] | 1615 | assert __file__ == os.path.abspath(sys.argv[0]) |
Ezio Melotti | 184bdfb | 2010-02-18 09:37:05 +0000 | [diff] [blame] | 1616 | |
Chris Jerdonek | 517e925 | 2013-02-27 09:02:53 -0800 | [diff] [blame] | 1617 | main_in_temp_cwd() |