blob: 028f3b496b5a103ac4cc363e444cd91539d43cee [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
Collin Winterfd12f492009-03-29 04:05:05 +000030-r randomizes test execution order. You can use --randseed=int to provide a
31int 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 Cannonc9a1bfe2013-06-12 20:12:30 -0400149except ModuleNotFoundError:
Antoine Pitrouc081c0c2011-07-15 22:12:24 +0200150 threading = None
151try:
152 import multiprocessing.process
Brett Cannonc9a1bfe2013-06-12 20:12:30 -0400153except ModuleNotFoundError:
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 Cannonc9a1bfe2013-06-12 20:12:30 -0400183 except ModuleNotFoundError:
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')
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 Jerdonek15738422013-01-07 17:07:32 -0800316# 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 Jerdonekd6c18dc2012-12-27 18:53:12 -0800319def _convert_namespace_to_getopt(ns):
Chris Jerdonek15738422013-01-07 17:07:32 -0800320 """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 Jerdonekd6c18dc2012-12-27 18:53:12 -0800328 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 Jerdonek15738422013-01-07 17:07:32 -0800344 return opts
Barry Warsaw08fca522001-08-20 22:33:46 +0000345
346
Antoine Pitrou88909542009-06-29 13:54:42 +0000347def main(tests=None, testdir=None, verbose=0, quiet=False,
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000348 exclude=False, single=False, randomize=False, fromfile=None,
Walter Dörwaldaee4da62004-11-12 18:51:27 +0000349 findleaks=False, use_resources=None, trace=False, coverdir='coverage',
Collin Winterfd12f492009-03-29 04:05:05 +0000350 runleaks=False, huntrleaks=False, verbose2=False, print_slow=False,
Antoine Pitrou3c4402f2011-01-03 20:38:52 +0000351 random_seed=None, use_mp=None, verbose3=False, forever=False,
Antoine Pitroub9c73e82011-07-29 23:53:38 +0200352 header=False, failfast=False, match_tests=None):
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000353 """Execute a test suite.
354
Thomas Wouters7e474022000-07-16 12:04:32 +0000355 This also parses command-line options and modifies its behavior
Fred Drake004d5e62000-10-23 17:22:08 +0000356 accordingly.
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000357
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 Drake004d5e62000-10-23 17:22:08 +0000363 Python test suite is searched for.
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000364
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 Montanaroab1c7912000-06-30 16:39:27 +0000368
Antoine Pitrou88909542009-06-29 13:54:42 +0000369 The other default arguments (verbose, quiet, exclude,
Collin Winterfd12f492009-03-29 04:05:05 +0000370 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 Rossum6fd83b71998-08-01 17:04:08 +0000374 """
Victor Stinner3c18f252011-05-22 15:27:14 +0200375
Victor Stinnercb41cda2011-07-13 23:47:21 +0200376 # Display the Python traceback on fatal errors (e.g. segfault)
Victor Stinner3c18f252011-05-22 15:27:14 +0200377 faulthandler.enable(all_threads=True)
378
Victor Stinnercb41cda2011-07-13 23:47:21 +0200379 # 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 Stinner1802d3f2010-05-19 17:11:19 +0000388 replace_stdout()
389
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000390 support.record_original_stdout(sys.stdout)
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800391
Chris Jerdonek15738422013-01-07 17:07:32 -0800392 parser = _create_parser()
393 ns = parser.parse_args()
394 opts = _convert_namespace_to_getopt(ns)
395 args = ns.args
396 usage = parser.error
Barry Warsaw08fca522001-08-20 22:33:46 +0000397
398 # Defaults
Collin Winterfd12f492009-03-29 04:05:05 +0000399 if random_seed is None:
400 random_seed = random.randrange(10000000)
Barry Warsaw08fca522001-08-20 22:33:46 +0000401 if use_resources is None:
402 use_resources = []
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000403 debug = False
404 start = None
Victor Stinner30196882011-06-03 12:53:26 +0200405 timeout = None
Guido van Rossum152494a1996-12-20 03:12:20 +0000406 for o, a in opts:
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800407 if o in ('-v', '--verbose'):
Barry Warsaw08fca522001-08-20 22:33:46 +0000408 verbose += 1
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000409 elif o in ('-w', '--verbose2'):
410 verbose2 = True
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000411 elif o in ('-d', '--debug'):
412 debug = True
Georg Brandl96f78972009-10-27 21:02:11 +0000413 elif o in ('-W', '--verbose3'):
414 verbose3 = True
Antoine Pitrou216a3bc2011-07-23 22:33:39 +0200415 elif o in ('-G', '--failfast'):
416 failfast = True
Barry Warsaw08fca522001-08-20 22:33:46 +0000417 elif o in ('-q', '--quiet'):
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000418 quiet = True;
Barry Warsaw08fca522001-08-20 22:33:46 +0000419 verbose = 0
Barry Warsaw08fca522001-08-20 22:33:46 +0000420 elif o in ('-x', '--exclude'):
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000421 exclude = True
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000422 elif o in ('-S', '--start'):
423 start = a
Barry Warsaw08fca522001-08-20 22:33:46 +0000424 elif o in ('-s', '--single'):
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000425 single = True
Senthil Kumaranbcfe56d2012-01-14 18:26:27 +0800426 elif o in ('-o', '--slow'):
Christian Heimesb186d002008-03-18 15:15:01 +0000427 print_slow = True
Barry Warsaw08fca522001-08-20 22:33:46 +0000428 elif o in ('-r', '--randomize'):
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000429 randomize = True
Collin Winterfd12f492009-03-29 04:05:05 +0000430 elif o == '--randseed':
431 random_seed = int(a)
Tim Petersc5000df2002-06-02 21:42:01 +0000432 elif o in ('-f', '--fromfile'):
433 fromfile = a
Antoine Pitroub9c73e82011-07-29 23:53:38 +0200434 elif o in ('-m', '--match'):
435 match_tests = a
Barry Warsaw08fca522001-08-20 22:33:46 +0000436 elif o in ('-l', '--findleaks'):
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000437 findleaks = True
Skip Montanaro0179a182004-06-06 15:53:18 +0000438 elif o in ('-L', '--runleaks'):
439 runleaks = True
Guido van Rossum9e9d4f82002-06-07 15:17:03 +0000440 elif o in ('-t', '--threshold'):
441 import gc
442 gc.set_threshold(int(a))
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000443 elif o in ('-T', '--coverage'):
444 trace = True
Walter Dörwaldaee4da62004-11-12 18:51:27 +0000445 elif o in ('-D', '--coverdir'):
R David Murray03504fc2011-03-24 14:35:30 -0400446 # 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örwaldaee4da62004-11-12 18:51:27 +0000449 elif o in ('-N', '--nocoverdir'):
450 coverdir = None
Michael W. Hudson61147f62004-08-03 11:33:28 +0000451 elif o in ('-R', '--huntrleaks'):
452 huntrleaks = a.split(':')
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000453 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. Hudson61147f62004-08-03 11:33:28 +0000457 huntrleaks[0] = 5
458 else:
459 huntrleaks[0] = int(huntrleaks[0])
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000460 if not huntrleaks[1]:
Michael W. Hudson61147f62004-08-03 11:33:28 +0000461 huntrleaks[1] = 4
462 else:
463 huntrleaks[1] = int(huntrleaks[1])
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000464 if len(huntrleaks) == 2 or not huntrleaks[2]:
465 huntrleaks[2:] = ["reflog.txt"]
Stefan Krah5c3ddc82012-08-17 23:09:48 +0200466 # Avoid false positives due to various caches
467 # filling slowly with random data:
468 warm_caches()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000469 elif o in ('-M', '--memlimit'):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000470 support.set_memlimit(a)
Barry Warsaw08fca522001-08-20 22:33:46 +0000471 elif o in ('-u', '--use'):
Guido van Rossumfe3f6962001-09-06 16:09:41 +0000472 u = [x.lower() for x in a.split(',')]
473 for r in u:
Fred Drake3a15dac2002-04-11 16:39:16 +0000474 if r == 'all':
Fred Drake4dd0f7e2002-11-26 21:44:56 +0000475 use_resources[:] = RESOURCE_NAMES
476 continue
Nadeem Vawda3c01d162011-08-01 23:48:26 +0200477 if r == 'none':
478 del use_resources[:]
479 continue
Fred Drake4dd0f7e2002-11-26 21:44:56 +0000480 remove = False
481 if r[0] == '-':
482 remove = True
483 r = r[1:]
Fred Drake3a15dac2002-04-11 16:39:16 +0000484 if r not in RESOURCE_NAMES:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000485 usage('Invalid -u/--use option: ' + a)
Fred Drake4dd0f7e2002-11-26 21:44:56 +0000486 if remove:
487 if r in use_resources:
488 use_resources.remove(r)
489 elif r not in use_resources:
Andrew MacIntyree41abab2002-04-30 12:11:04 +0000490 use_resources.append(r)
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000491 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 Murray7dc72cc2009-11-14 16:13:02 +0000506 elif o in ('-F', '--forever'):
507 forever = True
Antoine Pitrou88909542009-06-29 13:54:42 +0000508 elif o in ('-j', '--multiprocess'):
509 use_mp = int(a)
Antoine Pitrou6ab79d92011-03-23 20:17:45 +0100510 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 Vawda3c01d162011-08-01 23:48:26 +0200517 if use_mp == 1:
518 use_mp = None
Antoine Pitrou3c4402f2011-01-03 20:38:52 +0000519 elif o == '--header':
520 header = True
Antoine Pitrou88909542009-06-29 13:54:42 +0000521 elif o == '--slaveargs':
522 args, kwargs = json.loads(a)
523 try:
524 result = runtest(*args, **kwargs)
Victor Stinner29650112012-08-08 22:37:26 +0200525 except KeyboardInterrupt:
526 result = INTERRUPTED, ''
Antoine Pitrou88909542009-06-29 13:54:42 +0000527 except BaseException as e:
Victor Stinner29650112012-08-08 22:37:26 +0200528 traceback.print_exc()
529 result = CHILD_ERROR, str(e)
Antoine Pitrou88909542009-06-29 13:54:42 +0000530 sys.stdout.flush()
531 print() # Force a newline (just in case)
532 print(json.dumps(result))
533 sys.exit(0)
R David Murrayb588f8d2011-03-24 14:42:58 -0400534 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 Stinner0cc8d592011-03-31 18:10:13 +0200538 elif o == '--timeout':
Victor Stinner4de701b2013-06-17 20:27:10 +0200539 if hasattr(faulthandler, 'dump_traceback_later'):
Victor Stinner88345682011-06-06 12:14:23 +0200540 timeout = float(a)
541 if timeout <= 0:
542 timeout = None
543 else:
544 print("Warning: The timeout option requires "
Victor Stinner4de701b2013-06-17 20:27:10 +0200545 "faulthandler.dump_traceback_later")
Victor Stinner9e586c22011-06-06 12:04:36 +0200546 timeout = None
Brian Curtinf6643452011-04-28 17:45:17 -0500547 elif o == '--wait':
548 input("Press any key to continue...")
R. David Murray35768ad2009-11-15 00:23:21 +0000549 else:
550 print(("No handler for option {}. Please report this as a bug "
Georg Brandldee7b852010-08-02 18:59:52 +0000551 "at http://bugs.python.org.").format(o), file=sys.stderr)
R. David Murray35768ad2009-11-15 00:23:21 +0000552 sys.exit(1)
Tim Petersc5000df2002-06-02 21:42:01 +0000553 if single and fromfile:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000554 usage("-s and -f don't go together!")
Antoine Pitrou88909542009-06-29 13:54:42 +0000555 if use_mp and trace:
Florent Xicluna64fb18e2010-03-06 14:43:34 +0000556 usage("-T and -j don't go together!")
Antoine Pitrou88909542009-06-29 13:54:42 +0000557 if use_mp and findleaks:
Florent Xicluna64fb18e2010-03-06 14:43:34 +0000558 usage("-l and -j don't go together!")
Nadeem Vawdac1fba3e2011-08-27 15:22:05 +0200559 if use_mp and support.max_memuse:
560 usage("-M and -j don't go together!")
Antoine Pitrou216a3bc2011-07-23 22:33:39 +0200561 if failfast and not (verbose or verbose3):
562 usage("-G/--failfast needs either -v or -W")
Barry Warsaw08fca522001-08-20 22:33:46 +0000563
Guido van Rossum152494a1996-12-20 03:12:20 +0000564 good = []
565 bad = []
566 skipped = []
Fred Drake9a0db072003-02-03 15:19:30 +0000567 resource_denieds = []
Nick Coghlan6ead5522009-10-18 13:19:33 +0000568 environment_changed = []
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000569 interrupted = False
Barry Warsawe11e3de1999-01-28 19:51:51 +0000570
Neil Schemenauerd569f232000-09-22 15:29:28 +0000571 if findleaks:
Barry Warsawa873b032000-08-03 15:50:37 +0000572 try:
573 import gc
Brett Cannonc9a1bfe2013-06-12 20:12:30 -0400574 except ModuleNotFoundError:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000575 print('No GC available, disabling findleaks.')
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000576 findleaks = False
Barry Warsawa873b032000-08-03 15:50:37 +0000577 else:
Neil Schemenauer8a00abc2000-10-13 01:32:42 +0000578 # 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 Schemenauerd569f232000-09-22 15:29:28 +0000582 found_garbage = []
Barry Warsawa873b032000-08-03 15:50:37 +0000583
Barry Warsawe11e3de1999-01-28 19:51:51 +0000584 if single:
Florent Xiclunaec882212010-08-09 16:56:43 +0000585 filename = os.path.join(TEMPDIR, 'pynexttest')
Barry Warsawe11e3de1999-01-28 19:51:51 +0000586 try:
587 fp = open(filename, 'r')
R. David Murray7dc72cc2009-11-14 16:13:02 +0000588 next_test = fp.read().strip()
589 tests = [next_test]
Barry Warsawe11e3de1999-01-28 19:51:51 +0000590 fp.close()
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200591 except OSError:
Barry Warsawe11e3de1999-01-28 19:51:51 +0000592 pass
Tim Petersc5000df2002-06-02 21:42:01 +0000593
594 if fromfile:
595 tests = []
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000596 fp = open(os.path.join(support.SAVEDCWD, fromfile))
Antoine Pitroud95c7b52010-11-07 20:50:51 +0000597 count_pat = re.compile(r'\[\s*\d+/\s*\d+\]')
Tim Petersc5000df2002-06-02 21:42:01 +0000598 for line in fp:
Antoine Pitroud95c7b52010-11-07 20:50:51 +0000599 line = count_pat.sub('', line)
Tim Petersc5000df2002-06-02 21:42:01 +0000600 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 Xiclunada7bfd52010-03-06 11:43:55 +0000606 removepy(args)
607 removepy(tests)
Tim Petersc5000df2002-06-02 21:42:01 +0000608
Guido van Rossum6c74fea1998-08-25 12:29:08 +0000609 stdtests = STDTESTS[:]
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000610 nottests = NOTTESTS.copy()
Guido van Rossum152494a1996-12-20 03:12:20 +0000611 if exclude:
Guido van Rossum6c74fea1998-08-25 12:29:08 +0000612 for arg in args:
613 if arg in stdtests:
614 stdtests.remove(arg)
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000615 nottests.add(arg)
Guido van Rossum41360a41998-03-26 19:42:58 +0000616 args = []
Florent Xicluna0e62a142010-03-06 17:34:48 +0000617
618 # For a partial run, we do not need to clutter the output.
Antoine Pitrou3c4402f2011-01-03 20:38:52 +0000619 if verbose or header or not (quiet or single or tests or args):
Florent Xicluna0e62a142010-03-06 17:34:48 +0000620 # Print basic platform information
621 print("==", platform.python_implementation(), *sys.version.split())
Florent Xiclunaec882212010-08-09 16:56:43 +0000622 print("== ", platform.platform(aliased=True),
623 "%s-endian" % sys.byteorder)
Florent Xicluna0e62a142010-03-06 17:34:48 +0000624 print("== ", os.getcwd())
Antoine Pitrou3c4402f2011-01-03 20:38:52 +0000625 print("Testing with flags:", sys.flags)
Florent Xicluna0e62a142010-03-06 17:34:48 +0000626
R David Murrayb588f8d2011-03-24 14:42:58 -0400627 # 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 Xiclunad6995eb2010-03-30 19:43:09 +0000634 selected = tests or args or alltests
Barry Warsawe11e3de1999-01-28 19:51:51 +0000635 if single:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000636 selected = selected[:1]
R. David Murrayef1992b2009-12-16 15:19:27 +0000637 try:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000638 next_single_test = alltests[alltests.index(selected[0])+1]
R. David Murrayef1992b2009-12-16 15:19:27 +0000639 except IndexError:
640 next_single_test = None
R David Murrayc3bf78a2012-10-27 17:07:05 -0400641 # Remove all the selected tests that precede start if it's set.
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000642 if start:
643 try:
R David Murrayc3bf78a2012-10-27 17:07:05 -0400644 del selected[:selected.index(start)]
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000645 except ValueError:
646 print("Couldn't find starting test (%s), using all tests" % start)
Skip Montanaroab1c7912000-06-30 16:39:27 +0000647 if randomize:
Collin Winterfd12f492009-03-29 04:05:05 +0000648 random.seed(random_seed)
649 print("Using random seed", random_seed)
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000650 random.shuffle(selected)
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000651 if trace:
Georg Brandl33c28812009-04-01 23:07:29 +0000652 import trace, tempfile
Vinay Sajip7ded1f02012-05-26 03:45:29 +0100653 tracer = trace.Trace(ignoredirs=[sys.base_prefix, sys.base_exec_prefix,
Georg Brandl33c28812009-04-01 23:07:29 +0000654 tempfile.gettempdir()],
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000655 trace=False, count=True)
R. David Murray7dc72cc2009-11-14 16:13:02 +0000656
Christian Heimesb186d002008-03-18 15:15:01 +0000657 test_times = []
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000658 support.verbose = verbose # Tell tests to be moderately quiet
659 support.use_resources = use_resources
Guido van Rossum5796d262000-04-21 21:35:06 +0000660 save_modules = sys.modules.keys()
Antoine Pitrou88909542009-06-29 13:54:42 +0000661
662 def accumulate_result(test, result):
663 ok, test_time = result
664 test_times.append((test_time, test))
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000665 if ok == PASSED:
Antoine Pitrou88909542009-06-29 13:54:42 +0000666 good.append(test)
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000667 elif ok == FAILED:
Antoine Pitrou88909542009-06-29 13:54:42 +0000668 bad.append(test)
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000669 elif ok == ENV_CHANGED:
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000670 environment_changed.append(test)
671 elif ok == SKIPPED:
Antoine Pitrou88909542009-06-29 13:54:42 +0000672 skipped.append(test)
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000673 elif ok == RESOURCE_DENIED:
674 skipped.append(test)
675 resource_denieds.append(test)
Antoine Pitrou88909542009-06-29 13:54:42 +0000676
R. David Murray7dc72cc2009-11-14 16:13:02 +0000677 if forever:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000678 def test_forever(tests=list(selected)):
R. David Murray7dc72cc2009-11-14 16:13:02 +0000679 while True:
680 for test in tests:
681 yield test
682 if bad:
683 return
684 tests = test_forever()
Georg Brandle8e02e32010-08-03 07:56:50 +0000685 test_count = ''
686 test_count_width = 3
R. David Murray7dc72cc2009-11-14 16:13:02 +0000687 else:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000688 tests = iter(selected)
Georg Brandle8e02e32010-08-03 07:56:50 +0000689 test_count = '/{}'.format(len(selected))
690 test_count_width = len(test_count) - 1
R. David Murray7dc72cc2009-11-14 16:13:02 +0000691
Antoine Pitrou88909542009-06-29 13:54:42 +0000692 if use_mp:
Victor Stinner45df8202010-04-28 22:31:17 +0000693 try:
694 from threading import Thread
Brett Cannonc9a1bfe2013-06-12 20:12:30 -0400695 except ModuleNotFoundError:
Victor Stinner45df8202010-04-28 22:31:17 +0000696 print("Multiprocess option requires thread support")
697 sys.exit(2)
Georg Brandl1b37e872010-03-14 10:45:50 +0000698 from queue import Queue
699 from subprocess import Popen, PIPE
Antoine Pitrouf9d0b122012-12-09 14:28:26 +0100700 debug_output_pat = re.compile(r"\[\d+ refs, \d+ blocks\]$")
Antoine Pitrou88909542009-06-29 13:54:42 +0000701 output = Queue()
Antoine Pitrou09f2e6f2012-07-26 00:45:19 +0200702 pending = MultiprocessTests(tests)
Antoine Pitrou1b03f2c2010-10-14 11:12:00 +0000703 opt_args = support.args_from_interpreter_flags()
704 base_cmd = [sys.executable] + opt_args + ['-m', 'test.regrtest']
Antoine Pitrou88909542009-06-29 13:54:42 +0000705 def work():
706 # A worker thread.
Neal Norwitz14ca3272006-02-28 18:05:43 +0000707 try:
Antoine Pitrou88909542009-06-29 13:54:42 +0000708 while True:
709 try:
Antoine Pitrou09f2e6f2012-07-26 00:45:19 +0200710 test = next(pending)
R. David Murray7dc72cc2009-11-14 16:13:02 +0000711 except StopIteration:
R. David Murray27144602009-10-19 15:26:16 +0000712 output.put((None, None, None, None))
Antoine Pitrou88909542009-06-29 13:54:42 +0000713 return
Antoine Pitrou09f2e6f2012-07-26 00:45:19 +0200714 args_tuple = (
715 (test, verbose, quiet),
716 dict(huntrleaks=huntrleaks, use_resources=use_resources,
717 debug=debug, output_on_failure=verbose3,
Antoine Pitrou0b9e7b92012-07-26 00:47:15 +0200718 timeout=timeout, failfast=failfast,
719 match_tests=match_tests)
Antoine Pitrou09f2e6f2012-07-26 00:45:19 +0200720 )
Antoine Pitrou88909542009-06-29 13:54:42 +0000721 # -E is needed by some tests, e.g. test_import
Antoine Pitrou282083d2012-07-11 19:19:14 +0200722 # 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 Pitrou1b03f2c2010-10-14 11:12:00 +0000725 popen = Popen(base_cmd + ['--slaveargs', json.dumps(args_tuple)],
R. David Murray27144602009-10-19 15:26:16 +0000726 stdout=PIPE, stderr=PIPE,
Antoine Pitrou36e778e2010-08-18 20:44:14 +0000727 universal_newlines=True,
Antoine Pitrou282083d2012-07-11 19:19:14 +0200728 close_fds=(os.name != 'nt'),
729 cwd=support.SAVEDCWD)
R. David Murray27144602009-10-19 15:26:16 +0000730 stdout, stderr = popen.communicate()
Victor Stinner4b739882011-03-31 18:02:36 +0200731 retcode = popen.wait()
R. David Murray27144602009-10-19 15:26:16 +0000732 # 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 Stinner4b739882011-03-31 18:02:36 +0200736 if retcode != 0:
737 result = (CHILD_ERROR, "Exit code %s" % retcode)
738 output.put((test, stdout.rstrip(), stderr.rstrip(), result))
739 return
R. David Murray7dc72cc2009-11-14 16:13:02 +0000740 if not result:
741 output.put((None, None, None, None))
742 return
Antoine Pitrou88909542009-06-29 13:54:42 +0000743 result = json.loads(result)
R. David Murray27144602009-10-19 15:26:16 +0000744 output.put((test, stdout.rstrip(), stderr.rstrip(), result))
Antoine Pitrou88909542009-06-29 13:54:42 +0000745 except BaseException:
R. David Murray27144602009-10-19 15:26:16 +0000746 output.put((None, None, None, None))
Neal Norwitz14ca3272006-02-28 18:05:43 +0000747 raise
Antoine Pitrou88909542009-06-29 13:54:42 +0000748 workers = [Thread(target=work) for i in range(use_mp)]
749 for worker in workers:
750 worker.start()
751 finished = 0
Georg Brandldee7b852010-08-02 18:59:52 +0000752 test_index = 1
R. David Murray7dc72cc2009-11-14 16:13:02 +0000753 try:
754 while finished < use_mp:
755 test, stdout, stderr, result = output.get()
756 if test is None:
757 finished += 1
758 continue
Victor Stinnera2a895c2011-05-23 23:14:05 +0200759 accumulate_result(test, result)
Georg Brandldee7b852010-08-02 18:59:52 +0000760 if not quiet:
Ezio Melotti84f75c62011-05-24 01:00:10 +0300761 fmt = "[{1:{0}}{2}/{3}] {4}" if bad else "[{1:{0}}{2}] {4}"
762 print(fmt.format(
Victor Stinnera2a895c2011-05-23 23:14:05 +0200763 test_count_width, test_index, test_count,
764 len(bad), test))
R. David Murray7dc72cc2009-11-14 16:13:02 +0000765 if stdout:
766 print(stdout)
767 if stderr:
768 print(stderr, file=sys.stderr)
Antoine Pitrou82372582012-06-27 17:41:07 +0200769 sys.stdout.flush()
770 sys.stderr.flush()
R. David Murray7dc72cc2009-11-14 16:13:02 +0000771 if result[0] == INTERRUPTED:
Victor Stinner29650112012-08-08 22:37:26 +0200772 raise KeyboardInterrupt
Victor Stinner4b739882011-03-31 18:02:36 +0200773 if result[0] == CHILD_ERROR:
Victor Stinner571e8fd2011-05-01 22:57:43 +0200774 raise Exception("Child error on {}: {}".format(test, result[1]))
Georg Brandldee7b852010-08-02 18:59:52 +0000775 test_index += 1
R. David Murray7dc72cc2009-11-14 16:13:02 +0000776 except KeyboardInterrupt:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000777 interrupted = True
Antoine Pitrou09f2e6f2012-07-26 00:45:19 +0200778 pending.interrupted = True
Antoine Pitrou88909542009-06-29 13:54:42 +0000779 for worker in workers:
780 worker.join()
781 else:
Georg Brandldee7b852010-08-02 18:59:52 +0000782 for test_index, test in enumerate(tests, 1):
Antoine Pitrou88909542009-06-29 13:54:42 +0000783 if not quiet:
Ezio Melotti84f75c62011-05-24 01:00:10 +0300784 fmt = "[{1:{0}}{2}/{3}] {4}" if bad else "[{1:{0}}{2}] {4}"
785 print(fmt.format(
Victor Stinnera2a895c2011-05-23 23:14:05 +0200786 test_count_width, test_index, test_count, len(bad), test))
Antoine Pitrou88909542009-06-29 13:54:42 +0000787 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 Stinner0cc8d592011-03-31 18:10:13 +0200791 tracer.runctx('runtest(test, verbose, quiet, timeout=timeout)',
Antoine Pitrou88909542009-06-29 13:54:42 +0000792 globals=globals(), locals=vars())
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000793 else:
Antoine Pitrou88909542009-06-29 13:54:42 +0000794 try:
Antoine Pitrou293954d2011-03-23 23:01:49 +0100795 result = runtest(test, verbose, quiet, huntrleaks, debug,
Antoine Pitrou216a3bc2011-07-23 22:33:39 +0200796 output_on_failure=verbose3,
Antoine Pitrouf83e4ac2011-07-29 23:57:10 +0200797 timeout=timeout, failfast=failfast,
798 match_tests=match_tests)
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000799 accumulate_result(test, result)
Antoine Pitrou88909542009-06-29 13:54:42 +0000800 except KeyboardInterrupt:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000801 interrupted = True
Antoine Pitrou88909542009-06-29 13:54:42 +0000802 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 Hylton7a1ea0e2001-10-17 13:45:28 +0000818
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000819 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 Rossum152494a1996-12-20 03:12:20 +0000826 if good and not quiet:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000827 if not bad and not skipped and not interrupted and len(good) > 1:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000828 print("All", end=' ')
829 print(count(len(good), "test"), "OK.")
Christian Heimesb186d002008-03-18 15:15:01 +0000830 if print_slow:
831 test_times.sort(reverse=True)
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000832 print("10 slowest tests:")
Christian Heimesb186d002008-03-18 15:15:01 +0000833 for time, test in test_times[:10]:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000834 print("%s: %.1fs" % (test, time))
Guido van Rossum152494a1996-12-20 03:12:20 +0000835 if bad:
Nick Coghlan6ead5522009-10-18 13:19:33 +0000836 bad = sorted(set(bad) - set(environment_changed))
837 if bad:
838 print(count(len(bad), "test"), "failed:")
839 printlist(bad)
Vinay Sajipf9596182012-03-02 01:01:13 +0000840 if environment_changed:
841 print("{} altered the execution environment:".format(
842 count(len(environment_changed), "test")))
843 printlist(environment_changed)
Guido van Rossum152494a1996-12-20 03:12:20 +0000844 if skipped and not quiet:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000845 print(count(len(skipped), "test"), "skipped:")
Tim Petersa45da922001-08-12 03:45:50 +0000846 printlist(skipped)
Barry Warsawe11e3de1999-01-28 19:51:51 +0000847
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000848 if verbose2 and bad:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000849 print("Re-running failed tests in verbose mode")
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000850 for test in bad:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000851 print("Re-running test %r in verbose mode" % test)
Tim Peters922dd7d2006-03-10 23:37:10 +0000852 sys.stdout.flush()
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000853 try:
Antoine Pitrou88909542009-06-29 13:54:42 +0000854 verbose = True
Victor Stinner0cc8d592011-03-31 18:10:13 +0200855 ok = runtest(test, True, quiet, huntrleaks, debug, timeout=timeout)
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000856 except KeyboardInterrupt:
857 # print a newline separate from the ^C
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000858 print()
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000859 break
860 except:
861 raise
862
Barry Warsawe11e3de1999-01-28 19:51:51 +0000863 if single:
R. David Murrayef1992b2009-12-16 15:19:27 +0000864 if next_single_test:
865 with open(filename, 'w') as fp:
866 fp.write(next_single_test + '\n')
Barry Warsawe11e3de1999-01-28 19:51:51 +0000867 else:
868 os.unlink(filename)
869
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000870 if trace:
871 r = tracer.results()
872 r.write_results(show_missing=True, summary=True, coverdir=coverdir)
873
Skip Montanaro0179a182004-06-06 15:53:18 +0000874 if runleaks:
875 os.system("leaks %d" % os.getpid())
876
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000877 sys.exit(len(bad) > 0 or interrupted)
Barry Warsaw08fca522001-08-20 22:33:46 +0000878
Guido van Rossum152494a1996-12-20 03:12:20 +0000879
R David Murrayb588f8d2011-03-24 14:42:58 -0400880# 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 Rossum6fd83b71998-08-01 17:04:08 +0000882STDTESTS = [
Guido van Rossum152494a1996-12-20 03:12:20 +0000883 'test_grammar',
884 'test_opcodes',
Guido van Rossumd8faa362007-04-27 19:54:29 +0000885 'test_dict',
Guido van Rossum152494a1996-12-20 03:12:20 +0000886 'test_builtin',
887 'test_exceptions',
888 'test_types',
Collin Winter7afaa882007-03-08 19:54:43 +0000889 'test_unittest',
890 'test_doctest',
891 'test_doctest2',
Eli Benderskyd18a0472011-07-27 20:21:45 +0300892 'test_support'
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000893]
Guido van Rossum152494a1996-12-20 03:12:20 +0000894
R David Murrayb588f8d2011-03-24 14:42:58 -0400895# set of tests that we don't want to be executed when using regrtest
R David Murray57648302011-03-24 14:57:05 -0400896NOTTESTS = set()
Guido van Rossum152494a1996-12-20 03:12:20 +0000897
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000898def findtests(testdir=None, stdtests=STDTESTS, nottests=NOTTESTS):
Guido van Rossum152494a1996-12-20 03:12:20 +0000899 """Return a list of all applicable test modules."""
Florent Xiclunada7bfd52010-03-06 11:43:55 +0000900 testdir = findtestdir(testdir)
Guido van Rossum152494a1996-12-20 03:12:20 +0000901 names = os.listdir(testdir)
902 tests = []
Florent Xiclunada7bfd52010-03-06 11:43:55 +0000903 others = set(stdtests) | nottests
Guido van Rossum152494a1996-12-20 03:12:20 +0000904 for name in names:
R David Murray661720e2011-03-21 15:14:34 -0400905 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 Xiclunada7bfd52010-03-06 11:43:55 +0000908 return stdtests + sorted(tests)
Guido van Rossum152494a1996-12-20 03:12:20 +0000909
Antoine Pitrou09f2e6f2012-07-26 00:45:19 +0200910# We do not use a generator so multiple threads can call next().
911class 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 Stinnerf58087b2010-05-02 17:24:51 +0000929def replace_stdout():
930 """Set stdout encoder error handler to backslashreplace (as stderr error
931 handler) to avoid UnicodeEncodeError when printing a traceback"""
Victor Stinner4b2b43d2011-01-05 03:54:26 +0000932 import atexit
933
Victor Stinnerf58087b2010-05-02 17:24:51 +0000934 stdout = sys.stdout
935 sys.stdout = open(stdout.fileno(), 'w',
936 encoding=stdout.encoding,
Victor Stinner4b2b43d2011-01-05 03:54:26 +0000937 errors="backslashreplace",
Victor Stinnerbe621032011-05-25 02:01:55 +0200938 closefd=False,
939 newline='\n')
Victor Stinner4b2b43d2011-01-05 03:54:26 +0000940
941 def restore_stdout():
942 sys.stdout.close()
943 sys.stdout = stdout
944 atexit.register(restore_stdout)
Victor Stinnerf58087b2010-05-02 17:24:51 +0000945
Antoine Pitrou88909542009-06-29 13:54:42 +0000946def runtest(test, verbose, quiet,
Antoine Pitrou293954d2011-03-23 23:01:49 +0100947 huntrleaks=False, debug=False, use_resources=None,
Antoine Pitrouf83e4ac2011-07-29 23:57:10 +0200948 output_on_failure=False, failfast=False, match_tests=None,
949 timeout=None):
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000950 """Run a single test.
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000951
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000952 test -- the name of the test
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000953 verbose -- if true, print more messages
Trent Mickf29f47b2000-08-11 19:02:59 +0000954 quiet -- if true, don't print 'skipped' messages (probably redundant)
Christian Heimesb186d002008-03-18 15:15:01 +0000955 test_times -- a list of (time, test_name) pairs
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000956 huntrleaks -- run multiple times to test for leaks; requires a debug
957 build; a triple corresponding to -R's three arguments
Victor Stinner8313d6a2011-06-29 15:22:26 +0200958 output_on_failure -- if true, display test output on failure
Victor Stinner0cc8d592011-03-31 18:10:13 +0200959 timeout -- dump the traceback and exit if a test takes more than
960 timeout seconds
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000961
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 Rossum6fd83b71998-08-01 17:04:08 +0000969 """
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000970
Antoine Pitrou88909542009-06-29 13:54:42 +0000971 if use_resources is not None:
972 support.use_resources = use_resources
Victor Stinner30196882011-06-03 12:53:26 +0200973 use_timeout = (timeout is not None)
Victor Stinner7d648a02011-03-31 18:27:50 +0200974 if use_timeout:
Victor Stinner4de701b2013-06-17 20:27:10 +0200975 faulthandler.dump_traceback_later(timeout, exit=True)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000976 try:
Antoine Pitroub9c73e82011-07-29 23:53:38 +0200977 support.match_tests = match_tests
Antoine Pitrou216a3bc2011-07-23 22:33:39 +0200978 if failfast:
979 support.failfast = True
Victor Stinner8313d6a2011-06-29 15:22:26 +0200980 if output_on_failure:
Victor Stinnerea95de72011-06-29 15:34:48 +0200981 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 Stinner8313d6a2011-06-29 15:22:26 +0200986 if runtest.stringio is None:
Victor Stinnerfcc2a212011-06-29 20:01:29 +0200987 stream = io.StringIO()
988 runtest.stringio = stream
989 else:
990 stream = runtest.stringio
991 stream.seek(0)
992 stream.truncate()
Victor Stinner8313d6a2011-06-29 15:22:26 +0200993
994 orig_stdout = sys.stdout
Victor Stinnera7c33e52011-06-29 13:00:54 +0200995 orig_stderr = sys.stderr
Victor Stinner8313d6a2011-06-29 15:22:26 +0200996 try:
Victor Stinnerea95de72011-06-29 15:34:48 +0200997 sys.stdout = stream
998 sys.stderr = stream
Victor Stinner8313d6a2011-06-29 15:22:26 +0200999 result = runtest_inner(test, verbose, quiet, huntrleaks,
1000 debug, display_failure=False)
1001 if result[0] == FAILED:
Victor Stinnerea95de72011-06-29 15:34:48 +02001002 output = stream.getvalue()
Victor Stinner8313d6a2011-06-29 15:22:26 +02001003 orig_stderr.write(output)
1004 orig_stderr.flush()
1005 finally:
1006 sys.stdout = orig_stdout
1007 sys.stderr = orig_stderr
Victor Stinnera7c33e52011-06-29 13:00:54 +02001008 else:
Victor Stinnerea95de72011-06-29 15:34:48 +02001009 support.verbose = verbose # Tell tests to be moderately quiet
Victor Stinnera7c33e52011-06-29 13:00:54 +02001010 result = runtest_inner(test, verbose, quiet, huntrleaks, debug,
1011 display_failure=not verbose)
Antoine Pitrou293954d2011-03-23 23:01:49 +01001012 return result
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001013 finally:
Victor Stinner7d648a02011-03-31 18:27:50 +02001014 if use_timeout:
Victor Stinner934676a2013-06-17 20:35:08 +02001015 faulthandler.cancel_dump_traceback_later()
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001016 cleanup_test_droppings(test, verbose)
Victor Stinner8313d6a2011-06-29 15:22:26 +02001017runtest.stringio = None
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001018
Nick Coghlan6ead5522009-10-18 13:19:33 +00001019# 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
1027class 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 Cannon29c0e4f2010-03-20 22:22:57 +00001059 'os.environ', 'sys.path', 'sys.path_hooks', '__import__',
Nick Coghlan7bd5dbe2010-12-05 07:17:25 +00001060 'warnings.filters', 'asyncore.socket_map',
Ezio Melotti45763d02011-03-20 15:34:28 +02001061 'logging._handlers', 'logging._handlerList', 'sys.gettrace',
Antoine Pitrouc081c0c2011-07-15 22:12:24 +02001062 'sys.warnoptions', 'threading._dangling',
Éric Araujo28df8de2011-09-19 05:10:45 +02001063 'multiprocessing.process._dangling',
Éric Araujoec177c12012-06-24 03:27:43 -04001064 'sysconfig._CONFIG_VARS', 'sysconfig._INSTALL_SCHEMES',
Brett Cannon6d26eba2013-06-16 15:20:48 -04001065 'support.TESTFN', 'locale', 'warnings.showwarning',
Éric Araujo28df8de2011-09-19 05:10:45 +02001066 )
Nick Coghlan6ead5522009-10-18 13:19:33 +00001067
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 Cannon055470a2010-02-19 15:57:10 +00001107 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 Cannon31f59292011-02-21 19:29:56 +00001113 def get_sys_gettrace(self):
1114 return sys.gettrace()
1115 def restore_sys_gettrace(self, trace_fxn):
1116 sys.settrace(trace_fxn)
1117
Brett Cannon055470a2010-02-19 15:57:10 +00001118 def get___import__(self):
Brett Cannon45071902010-06-14 22:22:54 +00001119 return builtins.__import__
Brett Cannon055470a2010-02-19 15:57:10 +00001120 def restore___import__(self, import_):
Brett Cannon45071902010-06-14 22:22:54 +00001121 builtins.__import__ = import_
Brett Cannon055470a2010-02-19 15:57:10 +00001122
Brett Cannon29c0e4f2010-03-20 22:22:57 +00001123 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 Pitroub14ac8c2010-08-16 00:28:05 +00001129 def get_asyncore_socket_map(self):
1130 asyncore = sys.modules.get('asyncore')
Antoine Pitrouaa879652010-10-29 11:54:38 +00001131 # XXX Making a copy keeps objects alive until __exit__ gets called.
1132 return asyncore and asyncore.socket_map.copy() or {}
Antoine Pitroub14ac8c2010-08-16 00:28:05 +00001133 def restore_asyncore_socket_map(self, saved_map):
1134 asyncore = sys.modules.get('asyncore')
1135 if asyncore is not None:
Antoine Pitrouaa879652010-10-29 11:54:38 +00001136 asyncore.close_all(ignore_all=True)
Antoine Pitroub14ac8c2010-08-16 00:28:05 +00001137 asyncore.socket_map.update(saved_map)
1138
Éric Araujoff913062011-11-29 16:45:07 +01001139 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 Coghlan7d819752010-12-05 06:45:03 +00001156 def get_logging__handlers(self):
1157 # _handlers is a WeakValueDictionary
Nick Coghlan7bd5dbe2010-12-05 07:17:25 +00001158 return id(logging._handlers), logging._handlers, logging._handlers.copy()
Nick Coghlan7d819752010-12-05 06:45:03 +00001159 def restore_logging__handlers(self, saved_handlers):
1160 # Can't easily revert the logging state
1161 pass
1162
Nick Coghlan7bd5dbe2010-12-05 07:17:25 +00001163 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 Melotti0123e052011-03-20 15:09:26 +02001170 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 Pitrouc081c0c2011-07-15 22:12:24 +02001176 # 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 Araujo28df8de2011-09-19 05:10:45 +02001201 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 Araujoec177c12012-06-24 03:27:43 -04001211 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 Araujo28df8de2011-09-19 05:10:45 +02001218
Vinay Sajipf9596182012-03-02 01:01:13 +00001219 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 Araujo28df8de2011-09-19 05:10:45 +02001233
Victor Stinnerd9ccf7f2013-06-17 20:40:05 +02001234 _lc = [getattr(locale, lc) for lc in dir(locale)
Victor Stinner546ccf02013-06-17 21:28:14 +02001235 if lc.startswith('LC_')]
Brett Cannon49e835b2013-04-01 14:11:37 -04001236 def get_locale(self):
1237 pairings = []
1238 for lc in self._lc:
1239 try:
Victor Stinner546ccf02013-06-17 21:28:14 +02001240 pairings.append((lc, locale.setlocale(lc, None)))
Victor Stinnerd9ccf7f2013-06-17 20:40:05 +02001241 except (TypeError, ValueError):
Brett Cannon49e835b2013-04-01 14:11:37 -04001242 continue
1243 return pairings
1244 def restore_locale(self, saved):
1245 for lc, setting in saved:
1246 locale.setlocale(lc, setting)
1247
Brett Cannon6d26eba2013-06-16 15:20:48 -04001248 def get_warnings_showwarning(self):
1249 return warnings.showwarning
1250 def restore_warnings_showwarning(self, fxn):
1251 warnings.showwarning = fxn
1252
Nick Coghlan6ead5522009-10-18 13:19:33 +00001253 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 Pitrouaa879652010-10-29 11:54:38 +00001266 saved_values = self.saved_values
1267 del self.saved_values
Nick Coghlan6ead5522009-10-18 13:19:33 +00001268 for name, get, restore in self.resource_info():
1269 current = get()
Antoine Pitrouaa879652010-10-29 11:54:38 +00001270 original = saved_values.pop(name)
Nick Coghlan6ead5522009-10-18 13:19:33 +00001271 # 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 Stinnera7c33e52011-06-29 13:00:54 +02001286def runtest_inner(test, verbose, quiet,
1287 huntrleaks=False, debug=False, display_failure=True):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001288 support.unload(test)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001289
Antoine Pitrou88909542009-06-29 13:54:42 +00001290 test_time = 0.0
Collin Wintera5503d52009-05-15 01:20:21 +00001291 refleak = False # True if the test leaked references.
Guido van Rossum152494a1996-12-20 03:12:20 +00001292 try:
R. David Murray0bc11ae2009-10-18 22:18:17 +00001293 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 Cannon613cf252012-11-14 13:42:51 -05001300 the_module = importlib.import_module(abstest)
R David Murray78fc25c2012-04-09 08:55:42 -04001301 # 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 Murray0bc11ae2009-10-18 22:18:17 +00001308 if huntrleaks:
R David Murray78fc25c2012-04-09 08:55:42 -04001309 refleak = dash_R(the_module, test, test_runner,
R. David Murray0bc11ae2009-10-18 22:18:17 +00001310 huntrleaks)
1311 test_time = time.time() - start_time
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001312 except support.ResourceDenied as msg:
Fred Drake9a0db072003-02-03 15:19:30 +00001313 if not quiet:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001314 print(test, "skipped --", msg)
Fred Drake9a0db072003-02-03 15:19:30 +00001315 sys.stdout.flush()
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001316 return RESOURCE_DENIED, test_time
R. David Murraya21e4ca2009-03-31 23:16:50 +00001317 except unittest.SkipTest as msg:
Trent Mickf29f47b2000-08-11 19:02:59 +00001318 if not quiet:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001319 print(test, "skipped --", msg)
Guido van Rossum3cda93e2002-09-13 21:28:03 +00001320 sys.stdout.flush()
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001321 return SKIPPED, test_time
Fred Drakefe5c22a2000-08-18 16:04:05 +00001322 except KeyboardInterrupt:
1323 raise
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001324 except support.TestFailed as msg:
Victor Stinnera7c33e52011-06-29 13:00:54 +02001325 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()
1333 print("test", test, "crashed --", msg, file=sys.stderr)
R. David Murray11cabcf2010-09-29 01:08:05 +00001334 sys.stderr.flush()
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001335 return FAILED, test_time
Guido van Rossum152494a1996-12-20 03:12:20 +00001336 else:
Collin Wintera5503d52009-05-15 01:20:21 +00001337 if refleak:
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001338 return FAILED, test_time
Nick Coghlan6ead5522009-10-18 13:19:33 +00001339 if environment.changed:
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001340 return ENV_CHANGED, test_time
1341 return PASSED, test_time
Guido van Rossum0fcca4e2001-09-21 20:31:52 +00001342
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001343def cleanup_test_droppings(testname, verbose):
1344 import shutil
Benjamin Peterson25c95f12009-05-08 20:42:26 +00001345 import stat
Antoine Pitrouc14efc42010-10-29 19:34:45 +00001346 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 Pitrou2b40efd2010-10-29 19:36:37 +00001350 # triggered during the following test run, and possibly produce failures.
Antoine Pitrouc14efc42010-10-29 19:34:45 +00001351 gc.collect()
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001352
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 Petersonee8712c2008-05-20 21:35:26 +00001359 for name in (support.TESTFN,
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001360 "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 Norwitz94fa2ee2008-03-31 02:55:15 +00001374 print("%r left behind %s %r" % (testname, kind, name))
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001375 try:
Benjamin Peterson25c95f12009-05-08 20:42:26 +00001376 # 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 Wouters0e3f5912006-08-11 14:57:12 +00001380 nuker(name)
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001381 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 Wouters0e3f5912006-08-11 14:57:12 +00001384
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001385def dash_R(the_module, test, indirect_test, huntrleaks):
Collin Wintera5503d52009-05-15 01:20:21 +00001386 """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 Wouters73e5a5b2006-06-08 15:35:45 +00001391 # This code is hackish and inelegant, but it seems to do the job.
Raymond Hettinger158c9c22011-02-22 00:41:50 +00001392 import copyreg
1393 import collections.abc
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001394
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 Vassalottif7fa63d2008-05-11 08:55:36 +00001401 ps = copyreg.dispatch_table.copy()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001402 pic = sys.path_importer_cache.copy()
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001403 try:
1404 import zipimport
Brett Cannonc9a1bfe2013-06-12 20:12:30 -04001405 except ModuleNotFoundError:
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001406 zdc = None # Run unmodified on platforms without zipimport support
1407 else:
1408 zdc = zipimport._zip_directory_cache.copy()
Christian Heimes93852662007-12-01 12:22:32 +00001409 abcs = {}
Raymond Hettinger158c9c22011-02-22 00:41:50 +00001410 for abc in [getattr(collections.abc, a) for a in collections.abc.__all__]:
Christian Heimesbe5b30b2008-03-03 19:18:51 +00001411 if not isabstract(abc):
Christian Heimes93852662007-12-01 12:22:32 +00001412 continue
1413 for obj in abc.__subclasses__() + [abc]:
1414 abcs[obj] = obj._abc_registry.copy()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001415
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001416 nwarmup, ntracked, fname = huntrleaks
Ezio Melotti184bdfb2010-02-18 09:37:05 +00001417 fname = os.path.join(support.SAVEDCWD, fname)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001418 repcount = nwarmup + ntracked
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001419 rc_deltas = [0] * repcount
1420 alloc_deltas = [0] * repcount
1421
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001422 print("beginning", repcount, "repetitions", file=sys.stderr)
1423 print(("1234567890"*(repcount//10 + 1))[:repcount], file=sys.stderr)
Antoine Pitrou88909542009-06-29 13:54:42 +00001424 sys.stderr.flush()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001425 for i in range(repcount):
R David Murray14d080e2013-01-12 11:34:38 -05001426 indirect_test()
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001427 alloc_after, rc_after = dash_R_cleanup(fs, ps, pic, zdc, abcs)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001428 sys.stderr.write('.')
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001429 sys.stderr.flush()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001430 if i >= nwarmup:
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001431 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 Norwitz94fa2ee2008-03-31 02:55:15 +00001434 print(file=sys.stderr)
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001435 # 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 Wouters73e5a5b2006-06-08 15:35:45 +00001460
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001461def dash_R_cleanup(fs, ps, pic, zdc, abcs):
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +00001462 import gc, copyreg
Brett Cannonf4fd9932008-05-10 21:11:46 +00001463 import _strptime, linecache
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001464 import urllib.parse, urllib.request, mimetypes, doctest
Raymond Hettinger158c9c22011-02-22 00:41:50 +00001465 import struct, filecmp, collections.abc
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001466 from distutils.dir_util import _path_created
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001467 from weakref import WeakSet
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001468
Christian Heimesdae2a892008-04-19 00:55:37 +00001469 # 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 Wouters73e5a5b2006-06-08 15:35:45 +00001474 # Restore some original values.
1475 warnings.filters[:] = fs
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +00001476 copyreg.dispatch_table.clear()
1477 copyreg.dispatch_table.update(ps)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001478 sys.path_importer_cache.clear()
1479 sys.path_importer_cache.update(pic)
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001480 try:
1481 import zipimport
Brett Cannonc9a1bfe2013-06-12 20:12:30 -04001482 except ModuleNotFoundError:
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001483 pass # Run unmodified on platforms without zipimport support
1484 else:
1485 zipimport._zip_directory_cache.clear()
1486 zipimport._zip_directory_cache.update(zdc)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001487
Christian Heimes26855632008-01-27 23:50:43 +00001488 # clear type cache
Christian Heimes15ebc882008-02-04 18:48:49 +00001489 sys._clear_type_cache()
Christian Heimes26855632008-01-27 23:50:43 +00001490
Guido van Rossum3de862d2007-08-18 00:10:33 +00001491 # Clear ABC registries, restoring previously saved ABC registries.
Raymond Hettinger158c9c22011-02-22 00:41:50 +00001492 for abc in [getattr(collections.abc, a) for a in collections.abc.__all__]:
Christian Heimesbe5b30b2008-03-03 19:18:51 +00001493 if not isabstract(abc):
Christian Heimes941973a2007-11-30 21:53:03 +00001494 continue
Guido van Rossum7eaf8222007-06-18 17:58:50 +00001495 for obj in abc.__subclasses__() + [abc]:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001496 obj._abc_registry = abcs.get(obj, WeakSet()).copy()
Guido van Rossumc1e315d2007-08-20 19:29:24 +00001497 obj._abc_cache.clear()
1498 obj._abc_negative_cache.clear()
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001499
Antoine Pitrou046467c2009-10-30 18:30:35 +00001500 # 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 Wouters73e5a5b2006-06-08 15:35:45 +00001506 # Clear assorted module caches.
1507 _path_created.clear()
1508 re.purge()
1509 _strptime._regex_cache.clear()
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001510 urllib.parse.clear_cache()
1511 urllib.request.urlcleanup()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001512 linecache.clearcache()
1513 mimetypes._default_mime_types()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001514 filecmp._cache.clear()
Christian Heimesa34706f2008-01-04 03:06:10 +00001515 struct._clearcache()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001516 doctest.master = None
Meador Inge11e38132011-11-25 22:33:32 -06001517 try:
1518 import ctypes
Brett Cannonc9a1bfe2013-06-12 20:12:30 -04001519 except ModuleNotFoundError:
Meador Inge11e38132011-11-25 22:33:32 -06001520 # Don't worry about resetting the cache if ctypes is not supported
1521 pass
1522 else:
1523 ctypes._reset_cache()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001524
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001525 # Collect cyclic trash and read memory statistics immediately after.
1526 func1 = sys.getallocatedblocks
1527 func2 = sys.gettotalrefcount
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001528 gc.collect()
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001529 return func1(), func2()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001530
Stefan Krah5c3ddc82012-08-17 23:09:48 +02001531def warm_caches():
1532 # char cache
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001533 s = bytes(range(256))
1534 for i in range(256):
1535 s[i:i+1]
Stefan Krah5c3ddc82012-08-17 23:09:48 +02001536 # unicode cache
1537 x = [chr(i) for i in range(256)]
1538 # int cache
1539 x = list(range(-5, 257))
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001540
Florent Xiclunada7bfd52010-03-06 11:43:55 +00001541def findtestdir(path=None):
1542 return path or os.path.dirname(__file__) or os.curdir
Guido van Rossum152494a1996-12-20 03:12:20 +00001543
Florent Xiclunada7bfd52010-03-06 11:43:55 +00001544def 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 Petersc5000df2002-06-02 21:42:01 +00001551
Guido van Rossum152494a1996-12-20 03:12:20 +00001552def count(n, word):
1553 if n == 1:
Guido van Rossum41360a41998-03-26 19:42:58 +00001554 return "%d %s" % (n, word)
Guido van Rossum152494a1996-12-20 03:12:20 +00001555 else:
Guido van Rossum41360a41998-03-26 19:42:58 +00001556 return "%d %ss" % (n, word)
Guido van Rossum152494a1996-12-20 03:12:20 +00001557
Tim Petersa45da922001-08-12 03:45:50 +00001558def printlist(x, width=70, indent=4):
Tim Peters7c7efe92002-08-23 17:55:54 +00001559 """Print the elements of iterable x to stdout.
Tim Petersa45da922001-08-12 03:45:50 +00001560
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 Petersba78bc42002-07-04 19:45:06 +00001566 from textwrap import fill
1567 blanks = ' ' * indent
Florent Xiclunafd1b0932010-03-28 00:25:02 +00001568 # 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 Norwitz94fa2ee2008-03-31 02:55:15 +00001570 initial_indent=blanks, subsequent_indent=blanks))
Tim Petersa45da922001-08-12 03:45:50 +00001571
Tim Petersb5b7b782001-08-12 01:20:39 +00001572
Chris Jerdonek517e9252013-02-27 09:02:53 -08001573def main_in_temp_cwd():
1574 """Run main() in a temporary working directory."""
Michael Foord3ab34cc2010-12-03 12:27:40 +00001575 if sysconfig.is_python_build():
Antoine Pitrouee429342011-04-16 18:53:59 +02001576 try:
Michael Foord3ab34cc2010-12-03 12:27:40 +00001577 os.mkdir(TEMPDIR)
Florent Xicluna68f71a32011-10-28 16:06:23 +02001578 except FileExistsError:
1579 pass
Michael Foord3ab34cc2010-12-03 12:27:40 +00001580
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 Jerdonek517e9252013-02-27 09:02:53 -08001584 test_cwd = 'test_python_{}'.format(os.getpid())
1585 test_cwd = os.path.join(TEMPDIR, test_cwd)
Michael Foord3ab34cc2010-12-03 12:27:40 +00001586
Chris Jerdonek517e9252013-02-27 09:02:53 -08001587 # 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 Coghlan4c4c0f22010-12-03 07:44:33 +00001594
Guido van Rossum152494a1996-12-20 03:12:20 +00001595if __name__ == '__main__':
Nick Coghlan4c4c0f22010-12-03 07:44:33 +00001596 # 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 Xiclunadc69e722010-09-13 16:35:02 +00001608 # 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 Xiclunada7bfd52010-03-06 11:43:55 +00001615 assert __file__ == os.path.abspath(sys.argv[0])
Ezio Melotti184bdfb2010-02-18 09:37:05 +00001616
Chris Jerdonek517e9252013-02-27 09:02:53 -08001617 main_in_temp_cwd()