blob: ba8a780fc9e9631eb164b55e2d6e8de97b6ee33c [file] [log] [blame]
Benjamin Peterson90f5ba52010-03-11 22:53:45 +00001#! /usr/bin/env python3
Guido van Rossum152494a1996-12-20 03:12:20 +00002
R. David Murray0ba81e02010-04-26 17:02:32 +00003"""
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -08004Script to run Python regression tests.
Guido van Rossum152494a1996-12-20 03:12:20 +00005
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -08006Run this script with -h or --help for documentation.
7"""
8
9USAGE = """\
Georg Brandlbe41a482011-01-05 21:47:47 +000010python -m test [options] [test_name1 [test_name2 ...]]
R. David Murray0ba81e02010-04-26 17:02:32 +000011python path/to/Lib/test/regrtest.py [options] [test_name1 [test_name2 ...]]
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -080012"""
Guido van Rossum152494a1996-12-20 03:12:20 +000013
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -080014DESCRIPTION = """\
15Run Python regression tests.
R. David Murray0ba81e02010-04-26 17:02:32 +000016
17If no arguments or options are provided, finds all files matching
18the pattern "test_*" in the Lib/test subdirectory and runs
19them in alphabetical order (but see -M and -u, below, for exceptions).
20
21For more rigorous testing, it is useful to use the following
22command line:
23
Georg Brandlbe41a482011-01-05 21:47:47 +000024python -E -Wd -m test [options] [test_name1 ...]
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -080025"""
R. David Murray0ba81e02010-04-26 17:02:32 +000026
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -080027EPILOG = """\
28Additional option details:
Guido van Rossumf58ed251997-03-07 21:04:33 +000029
Serhiy Storchakad65c9492015-11-02 14:10:23 +020030-r randomizes test execution order. You can use --randseed=int to provide an
Collin Winterfd12f492009-03-29 04:05:05 +000031int seed value for the randomizer; this is useful for reproducing troublesome
32test orders.
33
R. David Murray0ba81e02010-04-26 17:02:32 +000034-s On the first invocation of regrtest using -s, the first test file found
35or the first test file given on the command line is run, and the name of
36the next test is recorded in a file named pynexttest. If run from the
37Python build directory, pynexttest is located in the 'build' subdirectory,
38otherwise it is located in tempfile.gettempdir(). On subsequent runs,
39the test in pynexttest is run, and the next test is written to pynexttest.
40When the last test has been run, pynexttest is deleted. In this way it
41is possible to single step through the test files. This is useful when
42doing memory analysis on the Python interpreter, which process tends to
43consume too many resources to run the full regression test non-stop.
Barry Warsawe11e3de1999-01-28 19:51:51 +000044
Neal Norwitz94fa2ee2008-03-31 02:55:15 +000045-S is used to continue running tests after an aborted run. It will
46maintain the order a standard run (ie, this assumes -r is not used).
47This is useful after the tests have prematurely stopped for some external
48reason and you want to start running from where you left off rather
49than starting from the beginning.
50
Guido van Rossum9e9d4f82002-06-07 15:17:03 +000051-f reads the names of tests from the file given as f's argument, one
52or more test names per line. Whitespace is ignored. Blank lines and
53lines beginning with '#' are ignored. This is especially useful for
54whittling down failures involving interactions among tests.
Tim Petersc5000df2002-06-02 21:42:01 +000055
Skip Montanaro0179a182004-06-06 15:53:18 +000056-L causes the leaks(1) command to be run just before exit if it exists.
57leaks(1) is available on Mac OS X and presumably on some other
58FreeBSD-derived systems.
59
Michael W. Hudson61147f62004-08-03 11:33:28 +000060-R runs each test several times and examines sys.gettotalrefcount() to
61see if the test appears to be leaking references. The argument should
62be of the form stab:run:fname where 'stab' is the number of times the
63test is run to let gettotalrefcount settle down, 'run' is the number
64of times further it is run and 'fname' is the name of the file the
65reports are written to. These parameters all have defaults (5, 4 and
Neal Norwitz94fa2ee2008-03-31 02:55:15 +000066"reflog.txt" respectively), and the minimal invocation is '-R :'.
Michael W. Hudson61147f62004-08-03 11:33:28 +000067
Thomas Wouters477c8d52006-05-27 19:21:47 +000068-M runs tests that require an exorbitant amount of memory. These tests
69typically try to ascertain containers keep working when containing more than
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000702 billion objects, which only works on 64-bit systems. There are also some
71tests that try to exhaust the address space of the process, which only makes
72sense on 32-bit systems with at least 2Gb of memory. The passed-in memlimit,
Thomas Wouters477c8d52006-05-27 19:21:47 +000073which is a string in the form of '2.5Gb', determines howmuch memory the
74tests will limit themselves to (but they may go slightly over.) The number
75shouldn't be more memory than the machine has (including swap memory). You
76should also keep in mind that swap memory is generally much, much slower
77than RAM, and setting memlimit to all available RAM or higher will heavily
78tax the machine. On the other hand, it is no use running these tests with a
79limit of less than 2.5Gb, and many require more than 20Gb. Tests that expect
80to use more than memlimit memory will be skipped. The big-memory tests
81generally run very, very long.
82
Guido van Rossum9e9d4f82002-06-07 15:17:03 +000083-u is used to specify which special resource intensive tests to run,
84such as those requiring large file support or network connectivity.
85The argument is a comma-separated list of words indicating the
86resources to test. Currently only the following are defined:
Barry Warsaw08fca522001-08-20 22:33:46 +000087
Fred Drake3a15dac2002-04-11 16:39:16 +000088 all - Enable all special resources.
89
Nadeem Vawda3c01d162011-08-01 23:48:26 +020090 none - Disable all special resources (this is the default).
91
Guido van Rossum315aa362003-03-11 14:46:48 +000092 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. Kuchling2158df02001-10-22 15:26:09 +000096 curses - Tests that use curses and will modify the terminal's
97 state and output modes.
Tim Peters1633a2e2001-10-30 05:56:40 +000098
Guido van Rossum9e9d4f82002-06-07 15:17:03 +000099 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 Warsaw08fca522001-08-20 22:33:46 +0000102
Guido van Rossum9e9d4f82002-06-07 15:17:03 +0000103 network - It is okay to run tests that use external network
104 resource, e.g. testing SSL support for sockets.
Martin v. Löwis1c6b1a22002-11-19 17:47:07 +0000105
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000106 decimal - Test the decimal module against a large suite that
107 verifies compliance with standards.
108
Antoine Pitrou5bc4fa72010-10-14 15:34:31 +0000109 cpu - Used for certain CPU-heavy tests.
Jeremy Hylton4336eda2004-08-07 19:25:33 +0000110
Tim Peterseba28be2005-03-28 01:08:02 +0000111 subprocess Run all tests for the subprocess module.
Peter Astrandf7f1bb72005-03-03 20:47:37 +0000112
Hye-Shik Changaaa2f1d2005-12-10 17:44:27 +0000113 urlfetch - It is okay to download files required on testing.
114
Guilherme Polo9de29af2009-01-28 20:40:48 +0000115 gui - Run tests that require a running GUI.
116
Fred Drake4dd0f7e2002-11-26 21:44:56 +0000117To enable all resources except one, use '-uall,-<resource>'. For
Georg Brandl1158a332009-06-04 09:30:30 +0000118example, to run all the tests except for the gui tests, give the
119option '-uall,-gui'.
Guido van Rossum152494a1996-12-20 03:12:20 +0000120"""
121
Nick Coghlanbe7e49f2012-07-20 23:40:09 +1000122# We import importlib *ASAP* in order to test #15386
123import importlib
124
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800125import argparse
Brett Cannon45071902010-06-14 22:22:54 +0000126import builtins
Victor Stinner024e37a2011-03-31 01:31:06 +0200127import faulthandler
Victor Stinner8313d6a2011-06-29 15:22:26 +0200128import io
Antoine Pitrou88909542009-06-29 13:54:42 +0000129import json
Brett Cannon49e835b2013-04-01 14:11:37 -0400130import locale
Victor Stinner8313d6a2011-06-29 15:22:26 +0200131import logging
Christian Heimesb186d002008-03-18 15:15:01 +0000132import os
Victor Stinner8313d6a2011-06-29 15:22:26 +0200133import platform
Skip Montanaroab1c7912000-06-30 16:39:27 +0000134import random
Thomas Wouters9ada3d62006-04-21 09:47:09 +0000135import re
Éric Araujoff913062011-11-29 16:45:07 +0100136import shutil
Victor Stinnercb41cda2011-07-13 23:47:21 +0200137import signal
Christian Heimesb186d002008-03-18 15:15:01 +0000138import sys
Florent Xiclunada7bfd52010-03-06 11:43:55 +0000139import sysconfig
Victor Stinner8313d6a2011-06-29 15:22:26 +0200140import tempfile
141import time
142import traceback
143import unittest
144import warnings
145from inspect import isabstract
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000146
Antoine Pitrouc081c0c2011-07-15 22:12:24 +0200147try:
148 import threading
Brett Cannon260fbe82013-07-04 18:16:15 -0400149except ImportError:
Antoine Pitrouc081c0c2011-07-15 22:12:24 +0200150 threading = None
151try:
Richard Oudkerk84ed9a62013-08-14 15:35:41 +0100152 import _multiprocessing, multiprocessing.process
Brett Cannon260fbe82013-07-04 18:16:15 -0400153except ImportError:
Antoine Pitrouc081c0c2011-07-15 22:12:24 +0200154 multiprocessing = None
155
Florent Xicluna64fb18e2010-03-06 14:43:34 +0000156
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000157# 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.
167for 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 Rossumdc15c272002-08-12 21:55:51 +0000173
Guido van Rossumbb484652002-12-02 09:56:21 +0000174# 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.
180if sys.platform == 'darwin':
181 try:
182 import resource
Brett Cannon260fbe82013-07-04 18:16:15 -0400183 except ImportError:
Guido van Rossumbb484652002-12-02 09:56:21 +0000184 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 Petersona0dfa822009-11-13 02:25:08 +0000190# Test result constants.
191PASSED = 1
192FAILED = 0
193ENV_CHANGED = -1
194SKIPPED = -2
195RESOURCE_DENIED = -3
196INTERRUPTED = -4
Victor Stinner4b739882011-03-31 18:02:36 +0200197CHILD_ERROR = -5 # error in a child process
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000198
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000199from test import support
Fred Drake3a15dac2002-04-11 16:39:16 +0000200
Georg Brandl1158a332009-06-04 09:30:30 +0000201RESOURCE_NAMES = ('audio', 'curses', 'largefile', 'network',
Antoine Pitrou5bc4fa72010-10-14 15:34:31 +0000202 'decimal', 'cpu', 'subprocess', 'urlfetch', 'gui')
Fred Drake3a15dac2002-04-11 16:39:16 +0000203
Chris Jerdonek517e9252013-02-27 09:02:53 -0800204# 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.
207if sysconfig.is_python_build():
208 TEMPDIR = os.path.join(sysconfig.get_config_var('srcdir'), 'build')
209else:
210 TEMPDIR = tempfile.gettempdir()
211TEMPDIR = os.path.abspath(TEMPDIR)
Fred Drake3a15dac2002-04-11 16:39:16 +0000212
Chris Jerdonek15738422013-01-07 17:07:32 -0800213class _ArgParser(argparse.ArgumentParser):
214
215 def error(self, message):
216 super().error(message + "\nPass -h or --help for complete help.")
217
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800218def _create_parser():
219 # Set prog to prevent the uninformative "__main__.py" from displaying in
220 # error messages when using "python -m test ...".
Chris Jerdonek15738422013-01-07 17:07:32 -0800221 parser = _ArgParser(prog='regrtest.py',
222 usage=USAGE,
223 description=DESCRIPTION,
224 epilog=EPILOG,
225 add_help=False,
226 formatter_class=argparse.RawDescriptionHelpFormatter)
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800227
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')
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300236 group.add_argument('--timeout', metavar='TIMEOUT', type=float,
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800237 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')
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300240 group.add_argument('--wait', action='store_true',
241 help='wait for user input, e.g., allow a debugger '
242 'to be attached')
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800243 group.add_argument('--slaveargs', metavar='ARGS')
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300244 group.add_argument('-S', '--start', metavar='START',
245 help='the name of the test at which to start.' +
246 more_details)
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800247
248 group = parser.add_argument_group('Verbosity')
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300249 group.add_argument('-v', '--verbose', action='count',
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800250 help='run tests in verbose mode with output to stdout')
251 group.add_argument('-w', '--verbose2', action='store_true',
252 help='re-run failed tests in verbose mode')
253 group.add_argument('-W', '--verbose3', action='store_true',
254 help='display test output on failure')
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800255 group.add_argument('-q', '--quiet', action='store_true',
256 help='no output unless one or more tests fail')
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300257 group.add_argument('-o', '--slow', action='store_true', dest='print_slow',
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800258 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)
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300265 group.add_argument('--randseed', metavar='SEED',
266 dest='random_seed', type=int,
267 help='pass a random seed to reproduce a previous '
268 'random run')
269 group.add_argument('-f', '--fromfile', metavar='FILE',
270 help='read names of tests to run from a file.' +
271 more_details)
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800272 group.add_argument('-x', '--exclude', action='store_true',
273 help='arguments are tests to *exclude*')
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300274 group.add_argument('-s', '--single', action='store_true',
275 help='single step through a set of tests.' +
276 more_details)
277 group.add_argument('-m', '--match', metavar='PAT',
278 dest='match_tests',
279 help='match test cases and methods with glob pattern PAT')
280 group.add_argument('-G', '--failfast', action='store_true',
281 help='fail as soon as a test fails (only with -v or -W)')
282 group.add_argument('-u', '--use', metavar='RES1,RES2,...',
283 action='append', type=resources_list,
284 help='specify which special resource intensive tests '
285 'to run.' + more_details)
286 group.add_argument('-M', '--memlimit', metavar='LIMIT',
287 help='run very large memory-consuming tests.' +
288 more_details)
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800289 group.add_argument('--testdir', metavar='DIR',
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300290 type=relative_filename,
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800291 help='execute test files in the specified directory '
292 '(instead of the Python stdlib test suite)')
293
294 group = parser.add_argument_group('Special runs')
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300295 group.add_argument('-l', '--findleaks', action='store_true',
296 help='if GC is available detect tests that leak memory')
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800297 group.add_argument('-L', '--runleaks', action='store_true',
298 help='run the leaks(1) command just before exit.' +
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300299 more_details)
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800300 group.add_argument('-R', '--huntrleaks', metavar='RUNCOUNTS',
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300301 type=huntrleaks,
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800302 help='search for reference leaks (needs debug build, '
303 'very slow).' + more_details)
304 group.add_argument('-j', '--multiprocess', metavar='PROCESSES',
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300305 dest='use_mp', type=int,
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800306 help='run PROCESSES processes at once')
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300307 group.add_argument('-T', '--coverage', action='store_true',
308 dest='trace',
309 help='turn on code coverage tracing using the trace '
310 'module')
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800311 group.add_argument('-D', '--coverdir', metavar='DIR',
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300312 type=relative_filename,
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800313 help='directory where coverage files are put')
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300314 group.add_argument('-N', '--nocoverdir',
315 action='store_const', const=None, dest='coverdir',
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800316 help='put coverage files alongside modules')
317 group.add_argument('-t', '--threshold', metavar='THRESHOLD',
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300318 type=int,
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800319 help='call gc.set_threshold(THRESHOLD)')
320 group.add_argument('-n', '--nowindows', action='store_true',
321 help='suppress error message boxes on Windows')
322 group.add_argument('-F', '--forever', action='store_true',
323 help='run the specified tests in a loop, until an '
324 'error happens')
Brett Cannonbe7c1632015-10-02 16:16:44 -0700325 group.add_argument('-P', '--pgo', dest='pgo', action='store_true',
326 help='enable Profile Guided Optimization training')
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800327
328 parser.add_argument('args', nargs=argparse.REMAINDER,
329 help=argparse.SUPPRESS)
330
331 return parser
332
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300333def relative_filename(string):
334 # CWD is replaced with a temporary dir before calling main(), so we
335 # join it with the saved CWD so it ends up where the user expects.
336 return os.path.join(support.SAVEDCWD, string)
Chris Jerdonek15738422013-01-07 17:07:32 -0800337
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300338def huntrleaks(string):
339 args = string.split(':')
340 if len(args) not in (2, 3):
341 raise argparse.ArgumentTypeError(
342 'needs 2 or 3 colon-separated arguments')
343 nwarmup = int(args[0]) if args[0] else 5
344 ntracked = int(args[1]) if args[1] else 4
345 fname = args[2] if len(args) > 2 and args[2] else 'reflog.txt'
346 return nwarmup, ntracked, fname
347
348def resources_list(string):
349 u = [x.lower() for x in string.split(',')]
350 for r in u:
351 if r == 'all' or r == 'none':
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800352 continue
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300353 if r[0] == '-':
354 r = r[1:]
355 if r not in RESOURCE_NAMES:
356 raise argparse.ArgumentTypeError('invalid resource: ' + r)
357 return u
Barry Warsaw08fca522001-08-20 22:33:46 +0000358
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300359def _parse_args(args, **kwargs):
360 # Defaults
361 ns = argparse.Namespace(testdir=None, verbose=0, quiet=False,
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000362 exclude=False, single=False, randomize=False, fromfile=None,
Walter Dörwaldaee4da62004-11-12 18:51:27 +0000363 findleaks=False, use_resources=None, trace=False, coverdir='coverage',
Collin Winterfd12f492009-03-29 04:05:05 +0000364 runleaks=False, huntrleaks=False, verbose2=False, print_slow=False,
Antoine Pitrou3c4402f2011-01-03 20:38:52 +0000365 random_seed=None, use_mp=None, verbose3=False, forever=False,
Brett Cannonbe7c1632015-10-02 16:16:44 -0700366 header=False, failfast=False, match_tests=None, pgo=False)
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300367 for k, v in kwargs.items():
368 if not hasattr(ns, k):
369 raise TypeError('%r is an invalid keyword argument '
370 'for this function' % k)
371 setattr(ns, k, v)
372 if ns.use_resources is None:
373 ns.use_resources = []
374
375 parser = _create_parser()
376 parser.parse_args(args=args, namespace=ns)
377
378 if ns.single and ns.fromfile:
379 parser.error("-s and -f don't go together!")
380 if ns.use_mp and ns.trace:
381 parser.error("-T and -j don't go together!")
382 if ns.use_mp and ns.findleaks:
383 parser.error("-l and -j don't go together!")
384 if ns.use_mp and ns.memlimit:
385 parser.error("-M and -j don't go together!")
386 if ns.failfast and not (ns.verbose or ns.verbose3):
387 parser.error("-G/--failfast needs either -v or -W")
388
389 if ns.quiet:
390 ns.verbose = 0
391 if ns.timeout is not None:
392 if hasattr(faulthandler, 'dump_traceback_later'):
393 if ns.timeout <= 0:
394 ns.timeout = None
395 else:
396 print("Warning: The timeout option requires "
397 "faulthandler.dump_traceback_later")
398 ns.timeout = None
399 if ns.use_mp is not None:
400 if ns.use_mp <= 0:
401 # Use all cores + extras for tests that like to sleep
402 ns.use_mp = 2 + (os.cpu_count() or 1)
403 if ns.use_mp == 1:
404 ns.use_mp = None
405 if ns.use:
406 for a in ns.use:
407 for r in a:
408 if r == 'all':
409 ns.use_resources[:] = RESOURCE_NAMES
410 continue
411 if r == 'none':
412 del ns.use_resources[:]
413 continue
414 remove = False
415 if r[0] == '-':
416 remove = True
417 r = r[1:]
418 if remove:
419 if r in ns.use_resources:
420 ns.use_resources.remove(r)
421 elif r not in ns.use_resources:
422 ns.use_resources.append(r)
423 if ns.random_seed is not None:
424 ns.randomize = True
425
426 return ns
427
428
Eli Bendersky7f5c22c2013-09-02 08:57:21 -0700429def run_test_in_subprocess(testname, ns):
430 """Run the given test in a subprocess with --slaveargs.
431
432 ns is the option Namespace parsed from command-line arguments. regrtest
433 is invoked in a subprocess with the --slaveargs argument; when the
434 subprocess exits, its return code, stdout and stderr are returned as a
435 3-tuple.
436 """
437 from subprocess import Popen, PIPE
438 base_cmd = ([sys.executable] + support.args_from_interpreter_flags() +
439 ['-X', 'faulthandler', '-m', 'test.regrtest'])
Brett Cannonbe7c1632015-10-02 16:16:44 -0700440 # required to spawn a new process with PGO flag on/off
441 if ns.pgo:
442 base_cmd = base_cmd + ['--pgo']
Eli Bendersky7f5c22c2013-09-02 08:57:21 -0700443 slaveargs = (
444 (testname, ns.verbose, ns.quiet),
445 dict(huntrleaks=ns.huntrleaks,
446 use_resources=ns.use_resources,
Eli Benderskye8de2962013-09-02 17:01:10 -0700447 output_on_failure=ns.verbose3,
Eli Bendersky7f5c22c2013-09-02 08:57:21 -0700448 timeout=ns.timeout, failfast=ns.failfast,
Brett Cannonbe7c1632015-10-02 16:16:44 -0700449 match_tests=ns.match_tests, pgo=ns.pgo))
Eli Bendersky7f5c22c2013-09-02 08:57:21 -0700450 # Running the child from the same working directory as regrtest's original
451 # invocation ensures that TEMPDIR for the child is the same when
452 # sysconfig.is_python_build() is true. See issue 15300.
453 popen = Popen(base_cmd + ['--slaveargs', json.dumps(slaveargs)],
454 stdout=PIPE, stderr=PIPE,
455 universal_newlines=True,
456 close_fds=(os.name != 'nt'),
457 cwd=support.SAVEDCWD)
458 stdout, stderr = popen.communicate()
459 retcode = popen.wait()
460 return retcode, stdout, stderr
461
462
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300463def main(tests=None, **kwargs):
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000464 """Execute a test suite.
465
Thomas Wouters7e474022000-07-16 12:04:32 +0000466 This also parses command-line options and modifies its behavior
Fred Drake004d5e62000-10-23 17:22:08 +0000467 accordingly.
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000468
469 tests -- a list of strings containing test names (optional)
470 testdir -- the directory in which to look for tests (optional)
471
472 Users other than the Python test suite will certainly want to
473 specify testdir; if it's omitted, the directory containing the
Fred Drake004d5e62000-10-23 17:22:08 +0000474 Python test suite is searched for.
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000475
476 If the tests argument is omitted, the tests listed on the
477 command-line will be used. If that's empty, too, then all *.py
478 files beginning with test_ will be used.
Skip Montanaroab1c7912000-06-30 16:39:27 +0000479
Antoine Pitrou88909542009-06-29 13:54:42 +0000480 The other default arguments (verbose, quiet, exclude,
Collin Winterfd12f492009-03-29 04:05:05 +0000481 single, randomize, findleaks, use_resources, trace, coverdir,
482 print_slow, and random_seed) allow programmers calling main()
483 directly to set the values that would normally be set by flags
484 on the command line.
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000485 """
Victor Stinnercb41cda2011-07-13 23:47:21 +0200486 # Display the Python traceback on fatal errors (e.g. segfault)
Victor Stinner3c18f252011-05-22 15:27:14 +0200487 faulthandler.enable(all_threads=True)
488
Victor Stinnercb41cda2011-07-13 23:47:21 +0200489 # Display the Python traceback on SIGALRM or SIGUSR1 signal
490 signals = []
491 if hasattr(signal, 'SIGALRM'):
492 signals.append(signal.SIGALRM)
493 if hasattr(signal, 'SIGUSR1'):
494 signals.append(signal.SIGUSR1)
495 for signum in signals:
496 faulthandler.register(signum, chain=True)
497
Victor Stinner1802d3f2010-05-19 17:11:19 +0000498 replace_stdout()
499
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000500 support.record_original_stdout(sys.stdout)
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800501
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300502 ns = _parse_args(sys.argv[1:], **kwargs)
Barry Warsaw08fca522001-08-20 22:33:46 +0000503
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300504 if ns.huntrleaks:
505 # Avoid false positives due to various caches
506 # filling slowly with random data:
507 warm_caches()
508 if ns.memlimit is not None:
509 support.set_memlimit(ns.memlimit)
510 if ns.threshold is not None:
511 import gc
512 gc.set_threshold(ns.threshold)
513 if ns.nowindows:
Steve Dower12ee7442015-10-08 08:56:06 -0700514 print('The --nowindows (-n) option is deprecated. '
515 'Use -vv to display assertions in stderr.')
516 try:
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300517 import msvcrt
Steve Dower12ee7442015-10-08 08:56:06 -0700518 except ImportError:
519 pass
520 else:
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300521 msvcrt.SetErrorMode(msvcrt.SEM_FAILCRITICALERRORS|
522 msvcrt.SEM_NOALIGNMENTFAULTEXCEPT|
523 msvcrt.SEM_NOGPFAULTERRORBOX|
524 msvcrt.SEM_NOOPENFILEERRORBOX)
525 try:
526 msvcrt.CrtSetReportMode
527 except AttributeError:
528 # release build
529 pass
R. David Murray35768ad2009-11-15 00:23:21 +0000530 else:
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300531 for m in [msvcrt.CRT_WARN, msvcrt.CRT_ERROR, msvcrt.CRT_ASSERT]:
Steve Dower12ee7442015-10-08 08:56:06 -0700532 if ns.verbose and ns.verbose >= 2:
533 msvcrt.CrtSetReportMode(m, msvcrt.CRTDBG_MODE_FILE)
534 msvcrt.CrtSetReportFile(m, msvcrt.CRTDBG_FILE_STDERR)
535 else:
536 msvcrt.CrtSetReportMode(m, 0)
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300537 if ns.wait:
538 input("Press any key to continue...")
539
540 if ns.slaveargs is not None:
541 args, kwargs = json.loads(ns.slaveargs)
Andrew Svetlov8913a6c2013-09-01 07:58:41 +0300542 if kwargs.get('huntrleaks'):
543 unittest.BaseTestSuite._cleanup = False
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300544 try:
545 result = runtest(*args, **kwargs)
546 except KeyboardInterrupt:
547 result = INTERRUPTED, ''
548 except BaseException as e:
549 traceback.print_exc()
550 result = CHILD_ERROR, str(e)
551 sys.stdout.flush()
552 print() # Force a newline (just in case)
553 print(json.dumps(result))
554 sys.exit(0)
Barry Warsaw08fca522001-08-20 22:33:46 +0000555
Guido van Rossum152494a1996-12-20 03:12:20 +0000556 good = []
557 bad = []
558 skipped = []
Fred Drake9a0db072003-02-03 15:19:30 +0000559 resource_denieds = []
Nick Coghlan6ead5522009-10-18 13:19:33 +0000560 environment_changed = []
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000561 interrupted = False
Barry Warsawe11e3de1999-01-28 19:51:51 +0000562
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300563 if ns.findleaks:
Barry Warsawa873b032000-08-03 15:50:37 +0000564 try:
565 import gc
Brett Cannon260fbe82013-07-04 18:16:15 -0400566 except ImportError:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000567 print('No GC available, disabling findleaks.')
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300568 ns.findleaks = False
Barry Warsawa873b032000-08-03 15:50:37 +0000569 else:
Neil Schemenauer8a00abc2000-10-13 01:32:42 +0000570 # Uncomment the line below to report garbage that is not
571 # freeable by reference counting alone. By default only
572 # garbage that is not collectable by the GC is reported.
573 #gc.set_debug(gc.DEBUG_SAVEALL)
Neil Schemenauerd569f232000-09-22 15:29:28 +0000574 found_garbage = []
Barry Warsawa873b032000-08-03 15:50:37 +0000575
Andrew Svetlov8913a6c2013-09-01 07:58:41 +0300576 if ns.huntrleaks:
577 unittest.BaseTestSuite._cleanup = False
578
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300579 if ns.single:
Florent Xiclunaec882212010-08-09 16:56:43 +0000580 filename = os.path.join(TEMPDIR, 'pynexttest')
Barry Warsawe11e3de1999-01-28 19:51:51 +0000581 try:
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300582 with open(filename, 'r') as fp:
583 next_test = fp.read().strip()
584 tests = [next_test]
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200585 except OSError:
Barry Warsawe11e3de1999-01-28 19:51:51 +0000586 pass
Tim Petersc5000df2002-06-02 21:42:01 +0000587
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300588 if ns.fromfile:
Tim Petersc5000df2002-06-02 21:42:01 +0000589 tests = []
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300590 with open(os.path.join(support.SAVEDCWD, ns.fromfile)) as fp:
591 count_pat = re.compile(r'\[\s*\d+/\s*\d+\]')
592 for line in fp:
593 line = count_pat.sub('', line)
594 guts = line.split() # assuming no test has whitespace in its name
595 if guts and not guts[0].startswith('#'):
596 tests.extend(guts)
Tim Petersc5000df2002-06-02 21:42:01 +0000597
598 # Strip .py extensions.
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300599 removepy(ns.args)
Florent Xiclunada7bfd52010-03-06 11:43:55 +0000600 removepy(tests)
Tim Petersc5000df2002-06-02 21:42:01 +0000601
Guido van Rossum6c74fea1998-08-25 12:29:08 +0000602 stdtests = STDTESTS[:]
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000603 nottests = NOTTESTS.copy()
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300604 if ns.exclude:
605 for arg in ns.args:
Guido van Rossum6c74fea1998-08-25 12:29:08 +0000606 if arg in stdtests:
607 stdtests.remove(arg)
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000608 nottests.add(arg)
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300609 ns.args = []
Florent Xicluna0e62a142010-03-06 17:34:48 +0000610
611 # For a partial run, we do not need to clutter the output.
Brett Cannonbe7c1632015-10-02 16:16:44 -0700612 if (ns.verbose or ns.header or
613 not (ns.pgo or ns.quiet or ns.single or tests or ns.args)):
Florent Xicluna0e62a142010-03-06 17:34:48 +0000614 # Print basic platform information
615 print("==", platform.python_implementation(), *sys.version.split())
Florent Xiclunaec882212010-08-09 16:56:43 +0000616 print("== ", platform.platform(aliased=True),
Brett Cannonbe7c1632015-10-02 16:16:44 -0700617 "%s-endian" % sys.byteorder)
Christian Heimes985ecdc2013-11-20 11:46:18 +0100618 print("== ", "hash algorithm:", sys.hash_info.algorithm,
Brett Cannonbe7c1632015-10-02 16:16:44 -0700619 "64bit" if sys.maxsize > 2**32 else "32bit")
Florent Xicluna0e62a142010-03-06 17:34:48 +0000620 print("== ", os.getcwd())
Antoine Pitrou3c4402f2011-01-03 20:38:52 +0000621 print("Testing with flags:", sys.flags)
Florent Xicluna0e62a142010-03-06 17:34:48 +0000622
R David Murrayb588f8d2011-03-24 14:42:58 -0400623 # if testdir is set, then we are not running the python tests suite, so
624 # don't add default tests to be executed or skipped (pass empty values)
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300625 if ns.testdir:
626 alltests = findtests(ns.testdir, list(), set())
R David Murrayb588f8d2011-03-24 14:42:58 -0400627 else:
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300628 alltests = findtests(ns.testdir, stdtests, nottests)
R David Murrayb588f8d2011-03-24 14:42:58 -0400629
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300630 selected = tests or ns.args or alltests
631 if ns.single:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000632 selected = selected[:1]
R. David Murrayef1992b2009-12-16 15:19:27 +0000633 try:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000634 next_single_test = alltests[alltests.index(selected[0])+1]
R. David Murrayef1992b2009-12-16 15:19:27 +0000635 except IndexError:
636 next_single_test = None
R David Murrayc3bf78a2012-10-27 17:07:05 -0400637 # Remove all the selected tests that precede start if it's set.
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300638 if ns.start:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000639 try:
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300640 del selected[:selected.index(ns.start)]
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000641 except ValueError:
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300642 print("Couldn't find starting test (%s), using all tests" % ns.start)
643 if ns.randomize:
644 if ns.random_seed is None:
645 ns.random_seed = random.randrange(10000000)
646 random.seed(ns.random_seed)
647 print("Using random seed", ns.random_seed)
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000648 random.shuffle(selected)
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300649 if ns.trace:
Georg Brandl33c28812009-04-01 23:07:29 +0000650 import trace, tempfile
Vinay Sajip7ded1f02012-05-26 03:45:29 +0100651 tracer = trace.Trace(ignoredirs=[sys.base_prefix, sys.base_exec_prefix,
Georg Brandl33c28812009-04-01 23:07:29 +0000652 tempfile.gettempdir()],
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000653 trace=False, count=True)
R. David Murray7dc72cc2009-11-14 16:13:02 +0000654
Christian Heimesb186d002008-03-18 15:15:01 +0000655 test_times = []
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300656 support.verbose = ns.verbose # Tell tests to be moderately quiet
657 support.use_resources = ns.use_resources
Guido van Rossum5796d262000-04-21 21:35:06 +0000658 save_modules = sys.modules.keys()
Antoine Pitrou88909542009-06-29 13:54:42 +0000659
660 def accumulate_result(test, result):
661 ok, test_time = result
Victor Stinner0c886f72015-10-11 10:39:56 +0200662 if ok not in (CHILD_ERROR, INTERRUPTED):
663 test_times.append((test_time, test))
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000664 if ok == PASSED:
Antoine Pitrou88909542009-06-29 13:54:42 +0000665 good.append(test)
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000666 elif ok == FAILED:
Antoine Pitrou88909542009-06-29 13:54:42 +0000667 bad.append(test)
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000668 elif ok == ENV_CHANGED:
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000669 environment_changed.append(test)
670 elif ok == SKIPPED:
Antoine Pitrou88909542009-06-29 13:54:42 +0000671 skipped.append(test)
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000672 elif ok == RESOURCE_DENIED:
673 skipped.append(test)
674 resource_denieds.append(test)
Antoine Pitrou88909542009-06-29 13:54:42 +0000675
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300676 if ns.forever:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000677 def test_forever(tests=list(selected)):
R. David Murray7dc72cc2009-11-14 16:13:02 +0000678 while True:
679 for test in tests:
680 yield test
681 if bad:
682 return
683 tests = test_forever()
Georg Brandle8e02e32010-08-03 07:56:50 +0000684 test_count = ''
685 test_count_width = 3
R. David Murray7dc72cc2009-11-14 16:13:02 +0000686 else:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000687 tests = iter(selected)
Georg Brandle8e02e32010-08-03 07:56:50 +0000688 test_count = '/{}'.format(len(selected))
689 test_count_width = len(test_count) - 1
R. David Murray7dc72cc2009-11-14 16:13:02 +0000690
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300691 if ns.use_mp:
Victor Stinner45df8202010-04-28 22:31:17 +0000692 try:
693 from threading import Thread
Brett Cannon260fbe82013-07-04 18:16:15 -0400694 except ImportError:
Victor Stinner45df8202010-04-28 22:31:17 +0000695 print("Multiprocess option requires thread support")
696 sys.exit(2)
Georg Brandl1b37e872010-03-14 10:45:50 +0000697 from queue import Queue
Antoine Pitrouf9d0b122012-12-09 14:28:26 +0100698 debug_output_pat = re.compile(r"\[\d+ refs, \d+ blocks\]$")
Antoine Pitrou88909542009-06-29 13:54:42 +0000699 output = Queue()
Antoine Pitrou09f2e6f2012-07-26 00:45:19 +0200700 pending = MultiprocessTests(tests)
Antoine Pitrou88909542009-06-29 13:54:42 +0000701 def work():
702 # A worker thread.
Neal Norwitz14ca3272006-02-28 18:05:43 +0000703 try:
Antoine Pitrou88909542009-06-29 13:54:42 +0000704 while True:
705 try:
Antoine Pitrou09f2e6f2012-07-26 00:45:19 +0200706 test = next(pending)
R. David Murray7dc72cc2009-11-14 16:13:02 +0000707 except StopIteration:
R. David Murray27144602009-10-19 15:26:16 +0000708 output.put((None, None, None, None))
Antoine Pitrou88909542009-06-29 13:54:42 +0000709 return
Eli Bendersky7f5c22c2013-09-02 08:57:21 -0700710 retcode, stdout, stderr = run_test_in_subprocess(test, ns)
R. David Murray27144602009-10-19 15:26:16 +0000711 # Strip last refcount output line if it exists, since it
712 # comes from the shutdown of the interpreter in the subcommand.
713 stderr = debug_output_pat.sub("", stderr)
714 stdout, _, result = stdout.strip().rpartition("\n")
Victor Stinner4b739882011-03-31 18:02:36 +0200715 if retcode != 0:
716 result = (CHILD_ERROR, "Exit code %s" % retcode)
717 output.put((test, stdout.rstrip(), stderr.rstrip(), result))
718 return
R. David Murray7dc72cc2009-11-14 16:13:02 +0000719 if not result:
720 output.put((None, None, None, None))
721 return
Antoine Pitrou88909542009-06-29 13:54:42 +0000722 result = json.loads(result)
R. David Murray27144602009-10-19 15:26:16 +0000723 output.put((test, stdout.rstrip(), stderr.rstrip(), result))
Antoine Pitrou88909542009-06-29 13:54:42 +0000724 except BaseException:
R. David Murray27144602009-10-19 15:26:16 +0000725 output.put((None, None, None, None))
Neal Norwitz14ca3272006-02-28 18:05:43 +0000726 raise
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300727 workers = [Thread(target=work) for i in range(ns.use_mp)]
Antoine Pitrou88909542009-06-29 13:54:42 +0000728 for worker in workers:
729 worker.start()
730 finished = 0
Georg Brandldee7b852010-08-02 18:59:52 +0000731 test_index = 1
R. David Murray7dc72cc2009-11-14 16:13:02 +0000732 try:
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300733 while finished < ns.use_mp:
R. David Murray7dc72cc2009-11-14 16:13:02 +0000734 test, stdout, stderr, result = output.get()
735 if test is None:
736 finished += 1
737 continue
Victor Stinnera2a895c2011-05-23 23:14:05 +0200738 accumulate_result(test, result)
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300739 if not ns.quiet:
Brett Cannonbe7c1632015-10-02 16:16:44 -0700740 if bad and not ns.pgo:
741 fmt = "[{1:{0}}{2}/{3}] {4}"
742 else:
743 fmt = "[{1:{0}}{2}] {4}"
Ezio Melotti84f75c62011-05-24 01:00:10 +0300744 print(fmt.format(
Victor Stinnera2a895c2011-05-23 23:14:05 +0200745 test_count_width, test_index, test_count,
746 len(bad), test))
R. David Murray7dc72cc2009-11-14 16:13:02 +0000747 if stdout:
748 print(stdout)
Brett Cannonbe7c1632015-10-02 16:16:44 -0700749 if stderr and not ns.pgo:
R. David Murray7dc72cc2009-11-14 16:13:02 +0000750 print(stderr, file=sys.stderr)
Antoine Pitrou82372582012-06-27 17:41:07 +0200751 sys.stdout.flush()
752 sys.stderr.flush()
R. David Murray7dc72cc2009-11-14 16:13:02 +0000753 if result[0] == INTERRUPTED:
Victor Stinner29650112012-08-08 22:37:26 +0200754 raise KeyboardInterrupt
Victor Stinner4b739882011-03-31 18:02:36 +0200755 if result[0] == CHILD_ERROR:
Victor Stinner571e8fd2011-05-01 22:57:43 +0200756 raise Exception("Child error on {}: {}".format(test, result[1]))
Georg Brandldee7b852010-08-02 18:59:52 +0000757 test_index += 1
R. David Murray7dc72cc2009-11-14 16:13:02 +0000758 except KeyboardInterrupt:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000759 interrupted = True
Antoine Pitrou09f2e6f2012-07-26 00:45:19 +0200760 pending.interrupted = True
Antoine Pitrou88909542009-06-29 13:54:42 +0000761 for worker in workers:
762 worker.join()
763 else:
Georg Brandldee7b852010-08-02 18:59:52 +0000764 for test_index, test in enumerate(tests, 1):
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300765 if not ns.quiet:
Brett Cannonbe7c1632015-10-02 16:16:44 -0700766 if bad and not ns.pgo:
767 fmt = "[{1:{0}}{2}/{3}] {4}"
768 else:
769 fmt = "[{1:{0}}{2}] {4}"
Ezio Melotti84f75c62011-05-24 01:00:10 +0300770 print(fmt.format(
Victor Stinnera2a895c2011-05-23 23:14:05 +0200771 test_count_width, test_index, test_count, len(bad), test))
Antoine Pitrou88909542009-06-29 13:54:42 +0000772 sys.stdout.flush()
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300773 if ns.trace:
Antoine Pitrou88909542009-06-29 13:54:42 +0000774 # If we're tracing code coverage, then we don't exit with status
775 # if on a false return value from main.
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300776 tracer.runctx('runtest(test, ns.verbose, ns.quiet, timeout=ns.timeout)',
Antoine Pitrou88909542009-06-29 13:54:42 +0000777 globals=globals(), locals=vars())
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000778 else:
Antoine Pitrou88909542009-06-29 13:54:42 +0000779 try:
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300780 result = runtest(test, ns.verbose, ns.quiet,
Eli Benderskye8de2962013-09-02 17:01:10 -0700781 ns.huntrleaks,
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300782 output_on_failure=ns.verbose3,
783 timeout=ns.timeout, failfast=ns.failfast,
Brett Cannonbe7c1632015-10-02 16:16:44 -0700784 match_tests=ns.match_tests, pgo=ns.pgo)
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000785 accumulate_result(test, result)
Antoine Pitrou88909542009-06-29 13:54:42 +0000786 except KeyboardInterrupt:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000787 interrupted = True
Antoine Pitrou88909542009-06-29 13:54:42 +0000788 break
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300789 if ns.findleaks:
Antoine Pitrou88909542009-06-29 13:54:42 +0000790 gc.collect()
791 if gc.garbage:
792 print("Warning: test created", len(gc.garbage), end=' ')
793 print("uncollectable object(s).")
794 # move the uncollectable objects somewhere so we don't see
795 # them again
796 found_garbage.extend(gc.garbage)
797 del gc.garbage[:]
798 # Unload the newly imported modules (best effort finalization)
799 for module in sys.modules.keys():
800 if module not in save_modules and module.startswith("test."):
801 support.unload(module)
Jeremy Hylton7a1ea0e2001-10-17 13:45:28 +0000802
Brett Cannonbe7c1632015-10-02 16:16:44 -0700803 if interrupted and not ns.pgo:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000804 # print a newline after ^C
805 print()
806 print("Test suite interrupted by signal SIGINT.")
807 omitted = set(selected) - set(good) - set(bad) - set(skipped)
808 print(count(len(omitted), "test"), "omitted:")
809 printlist(omitted)
Brett Cannonbe7c1632015-10-02 16:16:44 -0700810 if good and not ns.quiet and not ns.pgo:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000811 if not bad and not skipped and not interrupted and len(good) > 1:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000812 print("All", end=' ')
813 print(count(len(good), "test"), "OK.")
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300814 if ns.print_slow:
Christian Heimesb186d002008-03-18 15:15:01 +0000815 test_times.sort(reverse=True)
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000816 print("10 slowest tests:")
Christian Heimesb186d002008-03-18 15:15:01 +0000817 for time, test in test_times[:10]:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000818 print("%s: %.1fs" % (test, time))
Brett Cannonbe7c1632015-10-02 16:16:44 -0700819 if bad and not ns.pgo:
Zachary Ware9a47ed82015-08-08 22:03:27 -0500820 print(count(len(bad), "test"), "failed:")
821 printlist(bad)
Brett Cannonbe7c1632015-10-02 16:16:44 -0700822 if environment_changed and not ns.pgo:
Vinay Sajipf9596182012-03-02 01:01:13 +0000823 print("{} altered the execution environment:".format(
824 count(len(environment_changed), "test")))
825 printlist(environment_changed)
Brett Cannonbe7c1632015-10-02 16:16:44 -0700826 if skipped and not ns.quiet and not ns.pgo:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000827 print(count(len(skipped), "test"), "skipped:")
Tim Petersa45da922001-08-12 03:45:50 +0000828 printlist(skipped)
Barry Warsawe11e3de1999-01-28 19:51:51 +0000829
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300830 if ns.verbose2 and bad:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000831 print("Re-running failed tests in verbose mode")
Zachary Ware920a3352015-08-04 21:54:54 -0500832 for test in bad[:]:
Brett Cannonbe7c1632015-10-02 16:16:44 -0700833 if not ns.pgo:
834 print("Re-running test %r in verbose mode" % test)
Tim Peters922dd7d2006-03-10 23:37:10 +0000835 sys.stdout.flush()
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000836 try:
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300837 ns.verbose = True
Eli Benderskye8de2962013-09-02 17:01:10 -0700838 ok = runtest(test, True, ns.quiet, ns.huntrleaks,
Brett Cannonbe7c1632015-10-02 16:16:44 -0700839 timeout=ns.timeout, pgo=ns.pgo)
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000840 except KeyboardInterrupt:
841 # print a newline separate from the ^C
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000842 print()
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000843 break
Zachary Ware920a3352015-08-04 21:54:54 -0500844 else:
845 if ok[0] in {PASSED, ENV_CHANGED, SKIPPED, RESOURCE_DENIED}:
846 bad.remove(test)
847 else:
848 if bad:
849 print(count(len(bad), 'test'), "failed again:")
850 printlist(bad)
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000851
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300852 if ns.single:
R. David Murrayef1992b2009-12-16 15:19:27 +0000853 if next_single_test:
854 with open(filename, 'w') as fp:
855 fp.write(next_single_test + '\n')
Barry Warsawe11e3de1999-01-28 19:51:51 +0000856 else:
857 os.unlink(filename)
858
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300859 if ns.trace:
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000860 r = tracer.results()
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300861 r.write_results(show_missing=True, summary=True, coverdir=ns.coverdir)
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000862
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300863 if ns.runleaks:
Skip Montanaro0179a182004-06-06 15:53:18 +0000864 os.system("leaks %d" % os.getpid())
865
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000866 sys.exit(len(bad) > 0 or interrupted)
Barry Warsaw08fca522001-08-20 22:33:46 +0000867
Guido van Rossum152494a1996-12-20 03:12:20 +0000868
R David Murrayb588f8d2011-03-24 14:42:58 -0400869# small set of tests to determine if we have a basically functioning interpreter
870# (i.e. if any of these fail, then anything else is likely to follow)
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000871STDTESTS = [
Guido van Rossum152494a1996-12-20 03:12:20 +0000872 'test_grammar',
873 'test_opcodes',
Guido van Rossumd8faa362007-04-27 19:54:29 +0000874 'test_dict',
Guido van Rossum152494a1996-12-20 03:12:20 +0000875 'test_builtin',
876 'test_exceptions',
877 'test_types',
Collin Winter7afaa882007-03-08 19:54:43 +0000878 'test_unittest',
879 'test_doctest',
880 'test_doctest2',
Eli Benderskyd18a0472011-07-27 20:21:45 +0300881 'test_support'
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000882]
Guido van Rossum152494a1996-12-20 03:12:20 +0000883
R David Murrayb588f8d2011-03-24 14:42:58 -0400884# set of tests that we don't want to be executed when using regrtest
R David Murray57648302011-03-24 14:57:05 -0400885NOTTESTS = set()
Guido van Rossum152494a1996-12-20 03:12:20 +0000886
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000887def findtests(testdir=None, stdtests=STDTESTS, nottests=NOTTESTS):
Guido van Rossum152494a1996-12-20 03:12:20 +0000888 """Return a list of all applicable test modules."""
Florent Xiclunada7bfd52010-03-06 11:43:55 +0000889 testdir = findtestdir(testdir)
Guido van Rossum152494a1996-12-20 03:12:20 +0000890 names = os.listdir(testdir)
891 tests = []
Florent Xiclunada7bfd52010-03-06 11:43:55 +0000892 others = set(stdtests) | nottests
Guido van Rossum152494a1996-12-20 03:12:20 +0000893 for name in names:
R David Murray661720e2011-03-21 15:14:34 -0400894 mod, ext = os.path.splitext(name)
895 if mod[:5] == "test_" and ext in (".py", "") and mod not in others:
896 tests.append(mod)
Florent Xiclunada7bfd52010-03-06 11:43:55 +0000897 return stdtests + sorted(tests)
Guido van Rossum152494a1996-12-20 03:12:20 +0000898
Antoine Pitrou09f2e6f2012-07-26 00:45:19 +0200899# We do not use a generator so multiple threads can call next().
900class MultiprocessTests(object):
901
902 """A thread-safe iterator over tests for multiprocess mode."""
903
904 def __init__(self, tests):
905 self.interrupted = False
906 self.lock = threading.Lock()
907 self.tests = tests
908
909 def __iter__(self):
910 return self
911
912 def __next__(self):
913 with self.lock:
914 if self.interrupted:
915 raise StopIteration('tests interrupted')
916 return next(self.tests)
917
Victor Stinnerf58087b2010-05-02 17:24:51 +0000918def replace_stdout():
919 """Set stdout encoder error handler to backslashreplace (as stderr error
920 handler) to avoid UnicodeEncodeError when printing a traceback"""
Victor Stinner4b2b43d2011-01-05 03:54:26 +0000921 import atexit
922
Victor Stinnerf58087b2010-05-02 17:24:51 +0000923 stdout = sys.stdout
924 sys.stdout = open(stdout.fileno(), 'w',
925 encoding=stdout.encoding,
Victor Stinner4b2b43d2011-01-05 03:54:26 +0000926 errors="backslashreplace",
Victor Stinnerbe621032011-05-25 02:01:55 +0200927 closefd=False,
928 newline='\n')
Victor Stinner4b2b43d2011-01-05 03:54:26 +0000929
930 def restore_stdout():
931 sys.stdout.close()
932 sys.stdout = stdout
933 atexit.register(restore_stdout)
Victor Stinnerf58087b2010-05-02 17:24:51 +0000934
Antoine Pitrou88909542009-06-29 13:54:42 +0000935def runtest(test, verbose, quiet,
Eli Benderskye8de2962013-09-02 17:01:10 -0700936 huntrleaks=False, use_resources=None,
Antoine Pitrouf83e4ac2011-07-29 23:57:10 +0200937 output_on_failure=False, failfast=False, match_tests=None,
Brett Cannonbe7c1632015-10-02 16:16:44 -0700938 timeout=None, *, pgo=False):
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000939 """Run a single test.
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000940
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000941 test -- the name of the test
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000942 verbose -- if true, print more messages
Trent Mickf29f47b2000-08-11 19:02:59 +0000943 quiet -- if true, don't print 'skipped' messages (probably redundant)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000944 huntrleaks -- run multiple times to test for leaks; requires a debug
945 build; a triple corresponding to -R's three arguments
Eli Benderskye5eebed2013-09-02 16:52:25 -0700946 use_resources -- list of extra resources to use
Victor Stinner8313d6a2011-06-29 15:22:26 +0200947 output_on_failure -- if true, display test output on failure
Victor Stinner0cc8d592011-03-31 18:10:13 +0200948 timeout -- dump the traceback and exit if a test takes more than
949 timeout seconds
Eli Benderskye5eebed2013-09-02 16:52:25 -0700950 failfast, match_tests -- See regrtest command-line flags for these.
Brett Cannonbe7c1632015-10-02 16:16:44 -0700951 pgo -- if true, do not print unnecessary info when running the test
952 for Profile Guided Optimization build
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000953
Eli Benderskye5eebed2013-09-02 16:52:25 -0700954 Returns the tuple result, test_time, where result is one of the constants:
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000955 INTERRUPTED KeyboardInterrupt when run under -j
956 RESOURCE_DENIED test skipped because resource denied
957 SKIPPED test skipped for some other reason
958 ENV_CHANGED test failed because it changed the execution environment
959 FAILED test failed
960 PASSED test passed
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000961 """
Antoine Pitrou88909542009-06-29 13:54:42 +0000962 if use_resources is not None:
963 support.use_resources = use_resources
Victor Stinner30196882011-06-03 12:53:26 +0200964 use_timeout = (timeout is not None)
Victor Stinner7d648a02011-03-31 18:27:50 +0200965 if use_timeout:
Victor Stinner4de701b2013-06-17 20:27:10 +0200966 faulthandler.dump_traceback_later(timeout, exit=True)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000967 try:
Antoine Pitroub9c73e82011-07-29 23:53:38 +0200968 support.match_tests = match_tests
Antoine Pitrou216a3bc2011-07-23 22:33:39 +0200969 if failfast:
970 support.failfast = True
Victor Stinner8313d6a2011-06-29 15:22:26 +0200971 if output_on_failure:
Victor Stinnerea95de72011-06-29 15:34:48 +0200972 support.verbose = True
973
974 # Reuse the same instance to all calls to runtest(). Some
975 # tests keep a reference to sys.stdout or sys.stderr
976 # (eg. test_argparse).
Victor Stinner8313d6a2011-06-29 15:22:26 +0200977 if runtest.stringio is None:
Victor Stinnerfcc2a212011-06-29 20:01:29 +0200978 stream = io.StringIO()
979 runtest.stringio = stream
980 else:
981 stream = runtest.stringio
982 stream.seek(0)
983 stream.truncate()
Victor Stinner8313d6a2011-06-29 15:22:26 +0200984
985 orig_stdout = sys.stdout
Victor Stinnera7c33e52011-06-29 13:00:54 +0200986 orig_stderr = sys.stderr
Victor Stinner8313d6a2011-06-29 15:22:26 +0200987 try:
Victor Stinnerea95de72011-06-29 15:34:48 +0200988 sys.stdout = stream
989 sys.stderr = stream
Victor Stinner8313d6a2011-06-29 15:22:26 +0200990 result = runtest_inner(test, verbose, quiet, huntrleaks,
Brett Cannonbe7c1632015-10-02 16:16:44 -0700991 display_failure=False, pgo=pgo)
992 if result[0] == FAILED and not pgo:
Victor Stinnerea95de72011-06-29 15:34:48 +0200993 output = stream.getvalue()
Victor Stinner8313d6a2011-06-29 15:22:26 +0200994 orig_stderr.write(output)
995 orig_stderr.flush()
996 finally:
997 sys.stdout = orig_stdout
998 sys.stderr = orig_stderr
Victor Stinnera7c33e52011-06-29 13:00:54 +0200999 else:
Victor Stinnerea95de72011-06-29 15:34:48 +02001000 support.verbose = verbose # Tell tests to be moderately quiet
Eli Benderskye8de2962013-09-02 17:01:10 -07001001 result = runtest_inner(test, verbose, quiet, huntrleaks,
Brett Cannonbe7c1632015-10-02 16:16:44 -07001002 display_failure=not verbose, pgo=pgo)
Antoine Pitrou293954d2011-03-23 23:01:49 +01001003 return result
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001004 finally:
Victor Stinner7d648a02011-03-31 18:27:50 +02001005 if use_timeout:
Victor Stinner934676a2013-06-17 20:35:08 +02001006 faulthandler.cancel_dump_traceback_later()
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001007 cleanup_test_droppings(test, verbose)
Victor Stinner8313d6a2011-06-29 15:22:26 +02001008runtest.stringio = None
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001009
Nick Coghlan6ead5522009-10-18 13:19:33 +00001010# Unit tests are supposed to leave the execution environment unchanged
1011# once they complete. But sometimes tests have bugs, especially when
1012# tests fail, and the changes to environment go on to mess up other
1013# tests. This can cause issues with buildbot stability, since tests
1014# are run in random order and so problems may appear to come and go.
1015# There are a few things we can save and restore to mitigate this, and
1016# the following context manager handles this task.
1017
1018class saved_test_environment:
1019 """Save bits of the test environment and restore them at block exit.
1020
1021 with saved_test_environment(testname, verbose, quiet):
1022 #stuff
1023
1024 Unless quiet is True, a warning is printed to stderr if any of
1025 the saved items was changed by the test. The attribute 'changed'
1026 is initially False, but is set to True if a change is detected.
1027
1028 If verbose is more than 1, the before and after state of changed
1029 items is also printed.
1030 """
1031
1032 changed = False
1033
Brett Cannonbe7c1632015-10-02 16:16:44 -07001034 def __init__(self, testname, verbose=0, quiet=False, *, pgo=False):
Nick Coghlan6ead5522009-10-18 13:19:33 +00001035 self.testname = testname
1036 self.verbose = verbose
1037 self.quiet = quiet
Brett Cannonbe7c1632015-10-02 16:16:44 -07001038 self.pgo = pgo
Nick Coghlan6ead5522009-10-18 13:19:33 +00001039
1040 # To add things to save and restore, add a name XXX to the resources list
1041 # and add corresponding get_XXX/restore_XXX functions. get_XXX should
1042 # return the value to be saved and compared against a second call to the
1043 # get function when test execution completes. restore_XXX should accept
1044 # the saved value and restore the resource using it. It will be called if
1045 # and only if a change in the value is detected.
1046 #
1047 # Note: XXX will have any '.' replaced with '_' characters when determining
1048 # the corresponding method names.
1049
1050 resources = ('sys.argv', 'cwd', 'sys.stdin', 'sys.stdout', 'sys.stderr',
Brett Cannon29c0e4f2010-03-20 22:22:57 +00001051 'os.environ', 'sys.path', 'sys.path_hooks', '__import__',
Nick Coghlan7bd5dbe2010-12-05 07:17:25 +00001052 'warnings.filters', 'asyncore.socket_map',
Ezio Melotti45763d02011-03-20 15:34:28 +02001053 'logging._handlers', 'logging._handlerList', 'sys.gettrace',
Richard Oudkerk83d7dea2013-08-29 12:51:11 +01001054 'sys.warnoptions',
1055 # multiprocessing.process._cleanup() may release ref
1056 # to a thread, so check processes first.
1057 'multiprocessing.process._dangling', 'threading._dangling',
Éric Araujoec177c12012-06-24 03:27:43 -04001058 'sysconfig._CONFIG_VARS', 'sysconfig._INSTALL_SCHEMES',
Serhiy Storchakaa3a100b2015-03-30 01:28:02 +03001059 'files', 'locale', 'warnings.showwarning',
Victor Stinner8ba20832016-03-29 13:33:35 +02001060 'shutil_archive_formats', 'shutil_unpack_formats',
Éric Araujo28df8de2011-09-19 05:10:45 +02001061 )
Nick Coghlan6ead5522009-10-18 13:19:33 +00001062
1063 def get_sys_argv(self):
1064 return id(sys.argv), sys.argv, sys.argv[:]
1065 def restore_sys_argv(self, saved_argv):
1066 sys.argv = saved_argv[1]
1067 sys.argv[:] = saved_argv[2]
1068
1069 def get_cwd(self):
1070 return os.getcwd()
1071 def restore_cwd(self, saved_cwd):
1072 os.chdir(saved_cwd)
1073
1074 def get_sys_stdout(self):
1075 return sys.stdout
1076 def restore_sys_stdout(self, saved_stdout):
1077 sys.stdout = saved_stdout
1078
1079 def get_sys_stderr(self):
1080 return sys.stderr
1081 def restore_sys_stderr(self, saved_stderr):
1082 sys.stderr = saved_stderr
1083
1084 def get_sys_stdin(self):
1085 return sys.stdin
1086 def restore_sys_stdin(self, saved_stdin):
1087 sys.stdin = saved_stdin
1088
1089 def get_os_environ(self):
1090 return id(os.environ), os.environ, dict(os.environ)
1091 def restore_os_environ(self, saved_environ):
1092 os.environ = saved_environ[1]
1093 os.environ.clear()
1094 os.environ.update(saved_environ[2])
1095
1096 def get_sys_path(self):
1097 return id(sys.path), sys.path, sys.path[:]
1098 def restore_sys_path(self, saved_path):
1099 sys.path = saved_path[1]
1100 sys.path[:] = saved_path[2]
1101
Brett Cannon055470a2010-02-19 15:57:10 +00001102 def get_sys_path_hooks(self):
1103 return id(sys.path_hooks), sys.path_hooks, sys.path_hooks[:]
1104 def restore_sys_path_hooks(self, saved_hooks):
1105 sys.path_hooks = saved_hooks[1]
1106 sys.path_hooks[:] = saved_hooks[2]
1107
Brett Cannon31f59292011-02-21 19:29:56 +00001108 def get_sys_gettrace(self):
1109 return sys.gettrace()
1110 def restore_sys_gettrace(self, trace_fxn):
1111 sys.settrace(trace_fxn)
1112
Brett Cannon055470a2010-02-19 15:57:10 +00001113 def get___import__(self):
Brett Cannon45071902010-06-14 22:22:54 +00001114 return builtins.__import__
Brett Cannon055470a2010-02-19 15:57:10 +00001115 def restore___import__(self, import_):
Brett Cannon45071902010-06-14 22:22:54 +00001116 builtins.__import__ = import_
Brett Cannon055470a2010-02-19 15:57:10 +00001117
Brett Cannon29c0e4f2010-03-20 22:22:57 +00001118 def get_warnings_filters(self):
1119 return id(warnings.filters), warnings.filters, warnings.filters[:]
1120 def restore_warnings_filters(self, saved_filters):
1121 warnings.filters = saved_filters[1]
1122 warnings.filters[:] = saved_filters[2]
1123
Antoine Pitroub14ac8c2010-08-16 00:28:05 +00001124 def get_asyncore_socket_map(self):
1125 asyncore = sys.modules.get('asyncore')
Antoine Pitrouaa879652010-10-29 11:54:38 +00001126 # XXX Making a copy keeps objects alive until __exit__ gets called.
1127 return asyncore and asyncore.socket_map.copy() or {}
Antoine Pitroub14ac8c2010-08-16 00:28:05 +00001128 def restore_asyncore_socket_map(self, saved_map):
1129 asyncore = sys.modules.get('asyncore')
1130 if asyncore is not None:
Antoine Pitrouaa879652010-10-29 11:54:38 +00001131 asyncore.close_all(ignore_all=True)
Antoine Pitroub14ac8c2010-08-16 00:28:05 +00001132 asyncore.socket_map.update(saved_map)
1133
Éric Araujoff913062011-11-29 16:45:07 +01001134 def get_shutil_archive_formats(self):
1135 # we could call get_archives_formats() but that only returns the
1136 # registry keys; we want to check the values too (the functions that
1137 # are registered)
1138 return shutil._ARCHIVE_FORMATS, shutil._ARCHIVE_FORMATS.copy()
1139 def restore_shutil_archive_formats(self, saved):
1140 shutil._ARCHIVE_FORMATS = saved[0]
1141 shutil._ARCHIVE_FORMATS.clear()
1142 shutil._ARCHIVE_FORMATS.update(saved[1])
1143
1144 def get_shutil_unpack_formats(self):
1145 return shutil._UNPACK_FORMATS, shutil._UNPACK_FORMATS.copy()
1146 def restore_shutil_unpack_formats(self, saved):
1147 shutil._UNPACK_FORMATS = saved[0]
1148 shutil._UNPACK_FORMATS.clear()
1149 shutil._UNPACK_FORMATS.update(saved[1])
1150
Nick Coghlan7d819752010-12-05 06:45:03 +00001151 def get_logging__handlers(self):
1152 # _handlers is a WeakValueDictionary
Nick Coghlan7bd5dbe2010-12-05 07:17:25 +00001153 return id(logging._handlers), logging._handlers, logging._handlers.copy()
Nick Coghlan7d819752010-12-05 06:45:03 +00001154 def restore_logging__handlers(self, saved_handlers):
1155 # Can't easily revert the logging state
1156 pass
1157
Nick Coghlan7bd5dbe2010-12-05 07:17:25 +00001158 def get_logging__handlerList(self):
1159 # _handlerList is a list of weakrefs to handlers
1160 return id(logging._handlerList), logging._handlerList, logging._handlerList[:]
1161 def restore_logging__handlerList(self, saved_handlerList):
1162 # Can't easily revert the logging state
1163 pass
1164
Ezio Melotti0123e052011-03-20 15:09:26 +02001165 def get_sys_warnoptions(self):
1166 return id(sys.warnoptions), sys.warnoptions, sys.warnoptions[:]
1167 def restore_sys_warnoptions(self, saved_options):
1168 sys.warnoptions = saved_options[1]
1169 sys.warnoptions[:] = saved_options[2]
1170
Antoine Pitrouc081c0c2011-07-15 22:12:24 +02001171 # Controlling dangling references to Thread objects can make it easier
1172 # to track reference leaks.
1173 def get_threading__dangling(self):
1174 if not threading:
1175 return None
1176 # This copies the weakrefs without making any strong reference
1177 return threading._dangling.copy()
1178 def restore_threading__dangling(self, saved):
1179 if not threading:
1180 return
1181 threading._dangling.clear()
1182 threading._dangling.update(saved)
1183
1184 # Same for Process objects
1185 def get_multiprocessing_process__dangling(self):
1186 if not multiprocessing:
1187 return None
Richard Oudkerk83d7dea2013-08-29 12:51:11 +01001188 # Unjoined process objects can survive after process exits
1189 multiprocessing.process._cleanup()
Antoine Pitrouc081c0c2011-07-15 22:12:24 +02001190 # This copies the weakrefs without making any strong reference
1191 return multiprocessing.process._dangling.copy()
1192 def restore_multiprocessing_process__dangling(self, saved):
1193 if not multiprocessing:
1194 return
1195 multiprocessing.process._dangling.clear()
1196 multiprocessing.process._dangling.update(saved)
1197
Éric Araujo28df8de2011-09-19 05:10:45 +02001198 def get_sysconfig__CONFIG_VARS(self):
1199 # make sure the dict is initialized
1200 sysconfig.get_config_var('prefix')
1201 return (id(sysconfig._CONFIG_VARS), sysconfig._CONFIG_VARS,
1202 dict(sysconfig._CONFIG_VARS))
1203 def restore_sysconfig__CONFIG_VARS(self, saved):
1204 sysconfig._CONFIG_VARS = saved[1]
1205 sysconfig._CONFIG_VARS.clear()
1206 sysconfig._CONFIG_VARS.update(saved[2])
1207
Éric Araujoec177c12012-06-24 03:27:43 -04001208 def get_sysconfig__INSTALL_SCHEMES(self):
1209 return (id(sysconfig._INSTALL_SCHEMES), sysconfig._INSTALL_SCHEMES,
1210 sysconfig._INSTALL_SCHEMES.copy())
1211 def restore_sysconfig__INSTALL_SCHEMES(self, saved):
1212 sysconfig._INSTALL_SCHEMES = saved[1]
1213 sysconfig._INSTALL_SCHEMES.clear()
1214 sysconfig._INSTALL_SCHEMES.update(saved[2])
Éric Araujo28df8de2011-09-19 05:10:45 +02001215
Serhiy Storchakaa3a100b2015-03-30 01:28:02 +03001216 def get_files(self):
1217 return sorted(fn + ('/' if os.path.isdir(fn) else '')
1218 for fn in os.listdir())
1219 def restore_files(self, saved_value):
1220 fn = support.TESTFN
1221 if fn not in saved_value and (fn + '/') not in saved_value:
1222 if os.path.isfile(fn):
1223 support.unlink(fn)
1224 elif os.path.isdir(fn):
1225 support.rmtree(fn)
Éric Araujo28df8de2011-09-19 05:10:45 +02001226
Victor Stinnerd9ccf7f2013-06-17 20:40:05 +02001227 _lc = [getattr(locale, lc) for lc in dir(locale)
Victor Stinner546ccf02013-06-17 21:28:14 +02001228 if lc.startswith('LC_')]
Brett Cannon49e835b2013-04-01 14:11:37 -04001229 def get_locale(self):
1230 pairings = []
1231 for lc in self._lc:
1232 try:
Victor Stinner546ccf02013-06-17 21:28:14 +02001233 pairings.append((lc, locale.setlocale(lc, None)))
Victor Stinnerd9ccf7f2013-06-17 20:40:05 +02001234 except (TypeError, ValueError):
Brett Cannon49e835b2013-04-01 14:11:37 -04001235 continue
1236 return pairings
1237 def restore_locale(self, saved):
1238 for lc, setting in saved:
1239 locale.setlocale(lc, setting)
1240
Brett Cannon6d26eba2013-06-16 15:20:48 -04001241 def get_warnings_showwarning(self):
1242 return warnings.showwarning
1243 def restore_warnings_showwarning(self, fxn):
1244 warnings.showwarning = fxn
1245
Nick Coghlan6ead5522009-10-18 13:19:33 +00001246 def resource_info(self):
1247 for name in self.resources:
1248 method_suffix = name.replace('.', '_')
1249 get_name = 'get_' + method_suffix
1250 restore_name = 'restore_' + method_suffix
1251 yield name, getattr(self, get_name), getattr(self, restore_name)
1252
1253 def __enter__(self):
1254 self.saved_values = dict((name, get()) for name, get, restore
1255 in self.resource_info())
1256 return self
1257
1258 def __exit__(self, exc_type, exc_val, exc_tb):
Antoine Pitrouaa879652010-10-29 11:54:38 +00001259 saved_values = self.saved_values
1260 del self.saved_values
Martin Panter68c1f1e2016-08-20 06:50:14 +00001261 support.gc_collect() # Some resources use weak references
Nick Coghlan6ead5522009-10-18 13:19:33 +00001262 for name, get, restore in self.resource_info():
1263 current = get()
Antoine Pitrouaa879652010-10-29 11:54:38 +00001264 original = saved_values.pop(name)
Nick Coghlan6ead5522009-10-18 13:19:33 +00001265 # Check for changes to the resource's value
1266 if current != original:
1267 self.changed = True
1268 restore(original)
Brett Cannonbe7c1632015-10-02 16:16:44 -07001269 if not self.quiet and not self.pgo:
Nick Coghlan6ead5522009-10-18 13:19:33 +00001270 print("Warning -- {} was modified by {}".format(
1271 name, self.testname),
1272 file=sys.stderr)
Brett Cannonbe7c1632015-10-02 16:16:44 -07001273 if self.verbose > 1 and not self.pgo:
Nick Coghlan6ead5522009-10-18 13:19:33 +00001274 print(" Before: {}\n After: {} ".format(
1275 original, current),
1276 file=sys.stderr)
1277 return False
1278
1279
Victor Stinnera7c33e52011-06-29 13:00:54 +02001280def runtest_inner(test, verbose, quiet,
Brett Cannonbe7c1632015-10-02 16:16:44 -07001281 huntrleaks=False, display_failure=True, pgo=False):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001282 support.unload(test)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001283
Antoine Pitrou88909542009-06-29 13:54:42 +00001284 test_time = 0.0
Collin Wintera5503d52009-05-15 01:20:21 +00001285 refleak = False # True if the test leaked references.
Guido van Rossum152494a1996-12-20 03:12:20 +00001286 try:
R. David Murray0bc11ae2009-10-18 22:18:17 +00001287 if test.startswith('test.'):
1288 abstest = test
1289 else:
1290 # Always import it from the test package
1291 abstest = 'test.' + test
Brett Cannonbe7c1632015-10-02 16:16:44 -07001292 with saved_test_environment(test, verbose, quiet, pgo=pgo) as environment:
R. David Murray0bc11ae2009-10-18 22:18:17 +00001293 start_time = time.time()
Brett Cannon613cf252012-11-14 13:42:51 -05001294 the_module = importlib.import_module(abstest)
R David Murray78fc25c2012-04-09 08:55:42 -04001295 # If the test has a test_main, that will run the appropriate
1296 # tests. If not, use normal unittest test loading.
1297 test_runner = getattr(the_module, "test_main", None)
1298 if test_runner is None:
Zachary Ware69fb6a42014-08-04 11:15:10 -05001299 def test_runner():
1300 loader = unittest.TestLoader()
1301 tests = loader.loadTestsFromModule(the_module)
Victor Stinner5d575392015-01-06 14:05:03 +01001302 for error in loader.errors:
1303 print(error, file=sys.stderr)
1304 if loader.errors:
1305 raise Exception("errors while loading tests")
Zachary Ware69fb6a42014-08-04 11:15:10 -05001306 support.run_unittest(tests)
R David Murray78fc25c2012-04-09 08:55:42 -04001307 test_runner()
R. David Murray0bc11ae2009-10-18 22:18:17 +00001308 if huntrleaks:
Eli Benderskye5eebed2013-09-02 16:52:25 -07001309 refleak = dash_R(the_module, test, test_runner, huntrleaks)
R. David Murray0bc11ae2009-10-18 22:18:17 +00001310 test_time = time.time() - start_time
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001311 except support.ResourceDenied as msg:
Brett Cannonbe7c1632015-10-02 16:16:44 -07001312 if not quiet and not pgo:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001313 print(test, "skipped --", msg)
Fred Drake9a0db072003-02-03 15:19:30 +00001314 sys.stdout.flush()
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001315 return RESOURCE_DENIED, test_time
R. David Murraya21e4ca2009-03-31 23:16:50 +00001316 except unittest.SkipTest as msg:
Brett Cannonbe7c1632015-10-02 16:16:44 -07001317 if not quiet and not pgo:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001318 print(test, "skipped --", msg)
Guido van Rossum3cda93e2002-09-13 21:28:03 +00001319 sys.stdout.flush()
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001320 return SKIPPED, test_time
Fred Drakefe5c22a2000-08-18 16:04:05 +00001321 except KeyboardInterrupt:
1322 raise
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001323 except support.TestFailed as msg:
Brett Cannonbe7c1632015-10-02 16:16:44 -07001324 if not pgo:
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 Murray11cabcf2010-09-29 01:08:05 +00001329 sys.stderr.flush()
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001330 return FAILED, test_time
Guido van Rossum9e48b271997-07-16 01:56:13 +00001331 except:
Antoine Pitrou779a5b02011-03-21 19:55:16 +01001332 msg = traceback.format_exc()
Brett Cannonbe7c1632015-10-02 16:16:44 -07001333 if not pgo:
1334 print("test", test, "crashed --", msg, file=sys.stderr)
R. David Murray11cabcf2010-09-29 01:08:05 +00001335 sys.stderr.flush()
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001336 return FAILED, test_time
Guido van Rossum152494a1996-12-20 03:12:20 +00001337 else:
Collin Wintera5503d52009-05-15 01:20:21 +00001338 if refleak:
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001339 return FAILED, test_time
Nick Coghlan6ead5522009-10-18 13:19:33 +00001340 if environment.changed:
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001341 return ENV_CHANGED, test_time
1342 return PASSED, test_time
Guido van Rossum0fcca4e2001-09-21 20:31:52 +00001343
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001344def cleanup_test_droppings(testname, verbose):
1345 import shutil
Benjamin Peterson25c95f12009-05-08 20:42:26 +00001346 import stat
Antoine Pitrouc14efc42010-10-29 19:34:45 +00001347 import gc
1348
1349 # First kill any dangling references to open files etc.
1350 # This can also issue some ResourceWarnings which would otherwise get
Antoine Pitrou2b40efd2010-10-29 19:36:37 +00001351 # triggered during the following test run, and possibly produce failures.
Antoine Pitrouc14efc42010-10-29 19:34:45 +00001352 gc.collect()
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001353
1354 # Try to clean up junk commonly left behind. While tests shouldn't leave
1355 # any files or directories behind, when a test fails that can be tedious
1356 # for it to arrange. The consequences can be especially nasty on Windows,
1357 # since if a test leaves a file open, it cannot be deleted by name (while
1358 # there's nothing we can do about that here either, we can display the
1359 # name of the offending test, which is a real help).
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001360 for name in (support.TESTFN,
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001361 "db_home",
1362 ):
1363 if not os.path.exists(name):
1364 continue
1365
1366 if os.path.isdir(name):
1367 kind, nuker = "directory", shutil.rmtree
1368 elif os.path.isfile(name):
1369 kind, nuker = "file", os.unlink
1370 else:
1371 raise SystemError("os.path says %r exists but is neither "
1372 "directory nor file" % name)
1373
1374 if verbose:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001375 print("%r left behind %s %r" % (testname, kind, name))
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001376 try:
Benjamin Peterson25c95f12009-05-08 20:42:26 +00001377 # if we have chmod, fix possible permissions problems
1378 # that might prevent cleanup
1379 if (hasattr(os, 'chmod')):
1380 os.chmod(name, stat.S_IRWXU | stat.S_IRWXG | stat.S_IRWXO)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001381 nuker(name)
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001382 except Exception as msg:
1383 print(("%r left behind %s %r and it couldn't be "
1384 "removed: %s" % (testname, kind, name, msg)), file=sys.stderr)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001385
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001386def dash_R(the_module, test, indirect_test, huntrleaks):
Collin Wintera5503d52009-05-15 01:20:21 +00001387 """Run a test multiple times, looking for reference leaks.
1388
1389 Returns:
1390 False if the test didn't leak references; True if we detected refleaks.
1391 """
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001392 # This code is hackish and inelegant, but it seems to do the job.
Raymond Hettinger158c9c22011-02-22 00:41:50 +00001393 import copyreg
1394 import collections.abc
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001395
1396 if not hasattr(sys, 'gettotalrefcount'):
1397 raise Exception("Tracking reference leaks requires a debug build "
1398 "of Python")
1399
1400 # Save current values for dash_R_cleanup() to restore.
1401 fs = warnings.filters[:]
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +00001402 ps = copyreg.dispatch_table.copy()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001403 pic = sys.path_importer_cache.copy()
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001404 try:
1405 import zipimport
Brett Cannon260fbe82013-07-04 18:16:15 -04001406 except ImportError:
Benjamin Petersoncf626032014-02-16 14:52:01 -05001407 zdc = None # Run unmodified on platforms without zipimport support
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001408 else:
1409 zdc = zipimport._zip_directory_cache.copy()
Christian Heimes93852662007-12-01 12:22:32 +00001410 abcs = {}
Raymond Hettinger158c9c22011-02-22 00:41:50 +00001411 for abc in [getattr(collections.abc, a) for a in collections.abc.__all__]:
Christian Heimesbe5b30b2008-03-03 19:18:51 +00001412 if not isabstract(abc):
Christian Heimes93852662007-12-01 12:22:32 +00001413 continue
1414 for obj in abc.__subclasses__() + [abc]:
1415 abcs[obj] = obj._abc_registry.copy()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001416
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001417 nwarmup, ntracked, fname = huntrleaks
Ezio Melotti184bdfb2010-02-18 09:37:05 +00001418 fname = os.path.join(support.SAVEDCWD, fname)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001419 repcount = nwarmup + ntracked
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001420 rc_deltas = [0] * repcount
1421 alloc_deltas = [0] * repcount
1422
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001423 print("beginning", repcount, "repetitions", file=sys.stderr)
1424 print(("1234567890"*(repcount//10 + 1))[:repcount], file=sys.stderr)
Antoine Pitrou88909542009-06-29 13:54:42 +00001425 sys.stderr.flush()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001426 for i in range(repcount):
R David Murray14d080e2013-01-12 11:34:38 -05001427 indirect_test()
Benjamin Petersonf617fa82014-02-16 14:53:55 -05001428 alloc_after, rc_after = dash_R_cleanup(fs, ps, pic, zdc, abcs)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001429 sys.stderr.write('.')
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001430 sys.stderr.flush()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001431 if i >= nwarmup:
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001432 rc_deltas[i] = rc_after - rc_before
1433 alloc_deltas[i] = alloc_after - alloc_before
1434 alloc_before, rc_before = alloc_after, rc_after
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001435 print(file=sys.stderr)
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001436 # These checkers return False on success, True on failure
1437 def check_rc_deltas(deltas):
1438 return any(deltas)
1439 def check_alloc_deltas(deltas):
1440 # At least 1/3rd of 0s
1441 if 3 * deltas.count(0) < len(deltas):
1442 return True
1443 # Nothing else than 1s, 0s and -1s
1444 if not set(deltas) <= {1,0,-1}:
1445 return True
1446 return False
1447 failed = False
1448 for deltas, item_name, checker in [
1449 (rc_deltas, 'references', check_rc_deltas),
1450 (alloc_deltas, 'memory blocks', check_alloc_deltas)]:
1451 if checker(deltas):
1452 msg = '%s leaked %s %s, sum=%s' % (
1453 test, deltas[nwarmup:], item_name, sum(deltas))
1454 print(msg, file=sys.stderr)
1455 sys.stderr.flush()
1456 with open(fname, "a") as refrep:
1457 print(msg, file=refrep)
1458 refrep.flush()
1459 failed = True
1460 return failed
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001461
Benjamin Petersoncf626032014-02-16 14:52:01 -05001462def dash_R_cleanup(fs, ps, pic, zdc, abcs):
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +00001463 import gc, copyreg
Brett Cannonf4fd9932008-05-10 21:11:46 +00001464 import _strptime, linecache
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001465 import urllib.parse, urllib.request, mimetypes, doctest
Raymond Hettinger158c9c22011-02-22 00:41:50 +00001466 import struct, filecmp, collections.abc
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001467 from distutils.dir_util import _path_created
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001468 from weakref import WeakSet
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001469
Christian Heimesdae2a892008-04-19 00:55:37 +00001470 # Clear the warnings registry, so they can be displayed again
1471 for mod in sys.modules.values():
1472 if hasattr(mod, '__warningregistry__'):
1473 del mod.__warningregistry__
1474
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001475 # Restore some original values.
1476 warnings.filters[:] = fs
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +00001477 copyreg.dispatch_table.clear()
1478 copyreg.dispatch_table.update(ps)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001479 sys.path_importer_cache.clear()
1480 sys.path_importer_cache.update(pic)
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001481 try:
1482 import zipimport
Brett Cannon260fbe82013-07-04 18:16:15 -04001483 except ImportError:
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001484 pass # Run unmodified on platforms without zipimport support
1485 else:
1486 zipimport._zip_directory_cache.clear()
1487 zipimport._zip_directory_cache.update(zdc)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001488
Christian Heimes26855632008-01-27 23:50:43 +00001489 # clear type cache
Christian Heimes15ebc882008-02-04 18:48:49 +00001490 sys._clear_type_cache()
Christian Heimes26855632008-01-27 23:50:43 +00001491
Guido van Rossum3de862d2007-08-18 00:10:33 +00001492 # Clear ABC registries, restoring previously saved ABC registries.
Raymond Hettinger158c9c22011-02-22 00:41:50 +00001493 for abc in [getattr(collections.abc, a) for a in collections.abc.__all__]:
Christian Heimesbe5b30b2008-03-03 19:18:51 +00001494 if not isabstract(abc):
Christian Heimes941973a2007-11-30 21:53:03 +00001495 continue
Guido van Rossum7eaf8222007-06-18 17:58:50 +00001496 for obj in abc.__subclasses__() + [abc]:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001497 obj._abc_registry = abcs.get(obj, WeakSet()).copy()
Guido van Rossumc1e315d2007-08-20 19:29:24 +00001498 obj._abc_cache.clear()
1499 obj._abc_negative_cache.clear()
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001500
Antoine Pitrou046467c2009-10-30 18:30:35 +00001501 # Flush standard output, so that buffered data is sent to the OS and
1502 # associated Python objects are reclaimed.
1503 for stream in (sys.stdout, sys.stderr, sys.__stdout__, sys.__stderr__):
1504 if stream is not None:
1505 stream.flush()
1506
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001507 # Clear assorted module caches.
1508 _path_created.clear()
1509 re.purge()
1510 _strptime._regex_cache.clear()
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001511 urllib.parse.clear_cache()
1512 urllib.request.urlcleanup()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001513 linecache.clearcache()
1514 mimetypes._default_mime_types()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001515 filecmp._cache.clear()
Christian Heimesa34706f2008-01-04 03:06:10 +00001516 struct._clearcache()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001517 doctest.master = None
Meador Inge11e38132011-11-25 22:33:32 -06001518 try:
1519 import ctypes
Brett Cannon260fbe82013-07-04 18:16:15 -04001520 except ImportError:
Meador Inge11e38132011-11-25 22:33:32 -06001521 # Don't worry about resetting the cache if ctypes is not supported
1522 pass
1523 else:
1524 ctypes._reset_cache()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001525
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001526 # Collect cyclic trash and read memory statistics immediately after.
1527 func1 = sys.getallocatedblocks
1528 func2 = sys.gettotalrefcount
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001529 gc.collect()
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001530 return func1(), func2()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001531
Stefan Krah5c3ddc82012-08-17 23:09:48 +02001532def warm_caches():
1533 # char cache
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001534 s = bytes(range(256))
1535 for i in range(256):
1536 s[i:i+1]
Stefan Krah5c3ddc82012-08-17 23:09:48 +02001537 # unicode cache
1538 x = [chr(i) for i in range(256)]
1539 # int cache
1540 x = list(range(-5, 257))
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001541
Florent Xiclunada7bfd52010-03-06 11:43:55 +00001542def findtestdir(path=None):
1543 return path or os.path.dirname(__file__) or os.curdir
Guido van Rossum152494a1996-12-20 03:12:20 +00001544
Florent Xiclunada7bfd52010-03-06 11:43:55 +00001545def removepy(names):
1546 if not names:
1547 return
1548 for idx, name in enumerate(names):
1549 basename, ext = os.path.splitext(name)
1550 if ext == '.py':
1551 names[idx] = basename
Tim Petersc5000df2002-06-02 21:42:01 +00001552
Guido van Rossum152494a1996-12-20 03:12:20 +00001553def count(n, word):
1554 if n == 1:
Guido van Rossum41360a41998-03-26 19:42:58 +00001555 return "%d %s" % (n, word)
Guido van Rossum152494a1996-12-20 03:12:20 +00001556 else:
Guido van Rossum41360a41998-03-26 19:42:58 +00001557 return "%d %ss" % (n, word)
Guido van Rossum152494a1996-12-20 03:12:20 +00001558
Tim Petersa45da922001-08-12 03:45:50 +00001559def printlist(x, width=70, indent=4):
Tim Peters7c7efe92002-08-23 17:55:54 +00001560 """Print the elements of iterable x to stdout.
Tim Petersa45da922001-08-12 03:45:50 +00001561
1562 Optional arg width (default 70) is the maximum line length.
1563 Optional arg indent (default 4) is the number of blanks with which to
1564 begin each line.
1565 """
1566
Tim Petersba78bc42002-07-04 19:45:06 +00001567 from textwrap import fill
1568 blanks = ' ' * indent
Florent Xiclunafd1b0932010-03-28 00:25:02 +00001569 # Print the sorted list: 'x' may be a '--random' list or a set()
1570 print(fill(' '.join(str(elt) for elt in sorted(x)), width,
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001571 initial_indent=blanks, subsequent_indent=blanks))
Tim Petersa45da922001-08-12 03:45:50 +00001572
Tim Petersb5b7b782001-08-12 01:20:39 +00001573
Chris Jerdonek517e9252013-02-27 09:02:53 -08001574def main_in_temp_cwd():
1575 """Run main() in a temporary working directory."""
Michael Foord3ab34cc2010-12-03 12:27:40 +00001576 if sysconfig.is_python_build():
Antoine Pitrouee429342011-04-16 18:53:59 +02001577 try:
Michael Foord3ab34cc2010-12-03 12:27:40 +00001578 os.mkdir(TEMPDIR)
Florent Xicluna68f71a32011-10-28 16:06:23 +02001579 except FileExistsError:
1580 pass
Michael Foord3ab34cc2010-12-03 12:27:40 +00001581
1582 # Define a writable temp dir that will be used as cwd while running
1583 # the tests. The name of the dir includes the pid to allow parallel
1584 # testing (see the -j option).
Chris Jerdonek517e9252013-02-27 09:02:53 -08001585 test_cwd = 'test_python_{}'.format(os.getpid())
1586 test_cwd = os.path.join(TEMPDIR, test_cwd)
Michael Foord3ab34cc2010-12-03 12:27:40 +00001587
Chris Jerdonek517e9252013-02-27 09:02:53 -08001588 # Run the tests in a context manager that temporarily changes the CWD to a
1589 # temporary and writable directory. If it's not possible to create or
1590 # change the CWD, the original CWD will be used. The original CWD is
1591 # available from support.SAVEDCWD.
1592 with support.temp_cwd(test_cwd, quiet=True):
1593 main()
1594
Nick Coghlan4c4c0f22010-12-03 07:44:33 +00001595
Guido van Rossum152494a1996-12-20 03:12:20 +00001596if __name__ == '__main__':
Nick Coghlan4c4c0f22010-12-03 07:44:33 +00001597 # Remove regrtest.py's own directory from the module search path. Despite
1598 # the elimination of implicit relative imports, this is still needed to
1599 # ensure that submodules of the test package do not inappropriately appear
1600 # as top-level modules even when people (or buildbots!) invoke regrtest.py
1601 # directly instead of using the -m switch
1602 mydir = os.path.abspath(os.path.normpath(os.path.dirname(sys.argv[0])))
1603 i = len(sys.path)
1604 while i >= 0:
1605 i -= 1
1606 if os.path.abspath(os.path.normpath(sys.path[i])) == mydir:
1607 del sys.path[i]
1608
Florent Xiclunadc69e722010-09-13 16:35:02 +00001609 # findtestdir() gets the dirname out of __file__, so we have to make it
1610 # absolute before changing the working directory.
1611 # For example __file__ may be relative when running trace or profile.
1612 # See issue #9323.
1613 __file__ = os.path.abspath(__file__)
1614
1615 # sanity check
Florent Xiclunada7bfd52010-03-06 11:43:55 +00001616 assert __file__ == os.path.abspath(sys.argv[0])
Ezio Melotti184bdfb2010-02-18 09:37:05 +00001617
Chris Jerdonek517e9252013-02-27 09:02:53 -08001618 main_in_temp_cwd()