blob: bd816dd2d0dc36051842bdd7d9ef4b5c5f7ee343 [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:
Charles-François Natali37cfb0a2013-06-28 19:25:45 +0200511 # Use all cores + extras for tests that like to sleep
512 use_mp = 2 + (os.cpu_count() or 1)
Nadeem Vawda3c01d162011-08-01 23:48:26 +0200513 if use_mp == 1:
514 use_mp = None
Antoine Pitrou3c4402f2011-01-03 20:38:52 +0000515 elif o == '--header':
516 header = True
Antoine Pitrou88909542009-06-29 13:54:42 +0000517 elif o == '--slaveargs':
518 args, kwargs = json.loads(a)
519 try:
520 result = runtest(*args, **kwargs)
Victor Stinner29650112012-08-08 22:37:26 +0200521 except KeyboardInterrupt:
522 result = INTERRUPTED, ''
Antoine Pitrou88909542009-06-29 13:54:42 +0000523 except BaseException as e:
Victor Stinner29650112012-08-08 22:37:26 +0200524 traceback.print_exc()
525 result = CHILD_ERROR, str(e)
Antoine Pitrou88909542009-06-29 13:54:42 +0000526 sys.stdout.flush()
527 print() # Force a newline (just in case)
528 print(json.dumps(result))
529 sys.exit(0)
R David Murrayb588f8d2011-03-24 14:42:58 -0400530 elif o == '--testdir':
531 # CWD is replaced with a temporary dir before calling main(), so we
532 # join it with the saved CWD so it ends up where the user expects.
533 testdir = os.path.join(support.SAVEDCWD, a)
Victor Stinner0cc8d592011-03-31 18:10:13 +0200534 elif o == '--timeout':
Victor Stinner4de701b2013-06-17 20:27:10 +0200535 if hasattr(faulthandler, 'dump_traceback_later'):
Victor Stinner88345682011-06-06 12:14:23 +0200536 timeout = float(a)
537 if timeout <= 0:
538 timeout = None
539 else:
540 print("Warning: The timeout option requires "
Victor Stinner4de701b2013-06-17 20:27:10 +0200541 "faulthandler.dump_traceback_later")
Victor Stinner9e586c22011-06-06 12:04:36 +0200542 timeout = None
Brian Curtinf6643452011-04-28 17:45:17 -0500543 elif o == '--wait':
544 input("Press any key to continue...")
R. David Murray35768ad2009-11-15 00:23:21 +0000545 else:
546 print(("No handler for option {}. Please report this as a bug "
Georg Brandldee7b852010-08-02 18:59:52 +0000547 "at http://bugs.python.org.").format(o), file=sys.stderr)
R. David Murray35768ad2009-11-15 00:23:21 +0000548 sys.exit(1)
Tim Petersc5000df2002-06-02 21:42:01 +0000549 if single and fromfile:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000550 usage("-s and -f don't go together!")
Antoine Pitrou88909542009-06-29 13:54:42 +0000551 if use_mp and trace:
Florent Xicluna64fb18e2010-03-06 14:43:34 +0000552 usage("-T and -j don't go together!")
Antoine Pitrou88909542009-06-29 13:54:42 +0000553 if use_mp and findleaks:
Florent Xicluna64fb18e2010-03-06 14:43:34 +0000554 usage("-l and -j don't go together!")
Nadeem Vawdac1fba3e2011-08-27 15:22:05 +0200555 if use_mp and support.max_memuse:
556 usage("-M and -j don't go together!")
Antoine Pitrou216a3bc2011-07-23 22:33:39 +0200557 if failfast and not (verbose or verbose3):
558 usage("-G/--failfast needs either -v or -W")
Barry Warsaw08fca522001-08-20 22:33:46 +0000559
Guido van Rossum152494a1996-12-20 03:12:20 +0000560 good = []
561 bad = []
562 skipped = []
Fred Drake9a0db072003-02-03 15:19:30 +0000563 resource_denieds = []
Nick Coghlan6ead5522009-10-18 13:19:33 +0000564 environment_changed = []
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000565 interrupted = False
Barry Warsawe11e3de1999-01-28 19:51:51 +0000566
Neil Schemenauerd569f232000-09-22 15:29:28 +0000567 if findleaks:
Barry Warsawa873b032000-08-03 15:50:37 +0000568 try:
569 import gc
Brett Cannonc9a1bfe2013-06-12 20:12:30 -0400570 except ModuleNotFoundError:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000571 print('No GC available, disabling findleaks.')
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000572 findleaks = False
Barry Warsawa873b032000-08-03 15:50:37 +0000573 else:
Neil Schemenauer8a00abc2000-10-13 01:32:42 +0000574 # Uncomment the line below to report garbage that is not
575 # freeable by reference counting alone. By default only
576 # garbage that is not collectable by the GC is reported.
577 #gc.set_debug(gc.DEBUG_SAVEALL)
Neil Schemenauerd569f232000-09-22 15:29:28 +0000578 found_garbage = []
Barry Warsawa873b032000-08-03 15:50:37 +0000579
Barry Warsawe11e3de1999-01-28 19:51:51 +0000580 if single:
Florent Xiclunaec882212010-08-09 16:56:43 +0000581 filename = os.path.join(TEMPDIR, 'pynexttest')
Barry Warsawe11e3de1999-01-28 19:51:51 +0000582 try:
583 fp = open(filename, 'r')
R. David Murray7dc72cc2009-11-14 16:13:02 +0000584 next_test = fp.read().strip()
585 tests = [next_test]
Barry Warsawe11e3de1999-01-28 19:51:51 +0000586 fp.close()
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200587 except OSError:
Barry Warsawe11e3de1999-01-28 19:51:51 +0000588 pass
Tim Petersc5000df2002-06-02 21:42:01 +0000589
590 if fromfile:
591 tests = []
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000592 fp = open(os.path.join(support.SAVEDCWD, fromfile))
Antoine Pitroud95c7b52010-11-07 20:50:51 +0000593 count_pat = re.compile(r'\[\s*\d+/\s*\d+\]')
Tim Petersc5000df2002-06-02 21:42:01 +0000594 for line in fp:
Antoine Pitroud95c7b52010-11-07 20:50:51 +0000595 line = count_pat.sub('', line)
Tim Petersc5000df2002-06-02 21:42:01 +0000596 guts = line.split() # assuming no test has whitespace in its name
597 if guts and not guts[0].startswith('#'):
598 tests.extend(guts)
599 fp.close()
600
601 # Strip .py extensions.
Florent Xiclunada7bfd52010-03-06 11:43:55 +0000602 removepy(args)
603 removepy(tests)
Tim Petersc5000df2002-06-02 21:42:01 +0000604
Guido van Rossum6c74fea1998-08-25 12:29:08 +0000605 stdtests = STDTESTS[:]
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000606 nottests = NOTTESTS.copy()
Guido van Rossum152494a1996-12-20 03:12:20 +0000607 if exclude:
Guido van Rossum6c74fea1998-08-25 12:29:08 +0000608 for arg in args:
609 if arg in stdtests:
610 stdtests.remove(arg)
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000611 nottests.add(arg)
Guido van Rossum41360a41998-03-26 19:42:58 +0000612 args = []
Florent Xicluna0e62a142010-03-06 17:34:48 +0000613
614 # For a partial run, we do not need to clutter the output.
Antoine Pitrou3c4402f2011-01-03 20:38:52 +0000615 if verbose or header or not (quiet or single or tests or args):
Florent Xicluna0e62a142010-03-06 17:34:48 +0000616 # Print basic platform information
617 print("==", platform.python_implementation(), *sys.version.split())
Florent Xiclunaec882212010-08-09 16:56:43 +0000618 print("== ", platform.platform(aliased=True),
619 "%s-endian" % sys.byteorder)
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)
625 if testdir:
626 alltests = findtests(testdir, list(), set())
627 else:
628 alltests = findtests(testdir, stdtests, nottests)
629
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000630 selected = tests or args or alltests
Barry Warsawe11e3de1999-01-28 19:51:51 +0000631 if 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.
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000638 if start:
639 try:
R David Murrayc3bf78a2012-10-27 17:07:05 -0400640 del selected[:selected.index(start)]
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000641 except ValueError:
642 print("Couldn't find starting test (%s), using all tests" % start)
Skip Montanaroab1c7912000-06-30 16:39:27 +0000643 if randomize:
Collin Winterfd12f492009-03-29 04:05:05 +0000644 random.seed(random_seed)
645 print("Using random seed", random_seed)
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000646 random.shuffle(selected)
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000647 if trace:
Georg Brandl33c28812009-04-01 23:07:29 +0000648 import trace, tempfile
Vinay Sajip7ded1f02012-05-26 03:45:29 +0100649 tracer = trace.Trace(ignoredirs=[sys.base_prefix, sys.base_exec_prefix,
Georg Brandl33c28812009-04-01 23:07:29 +0000650 tempfile.gettempdir()],
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000651 trace=False, count=True)
R. David Murray7dc72cc2009-11-14 16:13:02 +0000652
Christian Heimesb186d002008-03-18 15:15:01 +0000653 test_times = []
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000654 support.verbose = verbose # Tell tests to be moderately quiet
655 support.use_resources = use_resources
Guido van Rossum5796d262000-04-21 21:35:06 +0000656 save_modules = sys.modules.keys()
Antoine Pitrou88909542009-06-29 13:54:42 +0000657
658 def accumulate_result(test, result):
659 ok, test_time = result
660 test_times.append((test_time, test))
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000661 if ok == PASSED:
Antoine Pitrou88909542009-06-29 13:54:42 +0000662 good.append(test)
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000663 elif ok == FAILED:
Antoine Pitrou88909542009-06-29 13:54:42 +0000664 bad.append(test)
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000665 elif ok == ENV_CHANGED:
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000666 environment_changed.append(test)
667 elif ok == SKIPPED:
Antoine Pitrou88909542009-06-29 13:54:42 +0000668 skipped.append(test)
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000669 elif ok == RESOURCE_DENIED:
670 skipped.append(test)
671 resource_denieds.append(test)
Antoine Pitrou88909542009-06-29 13:54:42 +0000672
R. David Murray7dc72cc2009-11-14 16:13:02 +0000673 if forever:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000674 def test_forever(tests=list(selected)):
R. David Murray7dc72cc2009-11-14 16:13:02 +0000675 while True:
676 for test in tests:
677 yield test
678 if bad:
679 return
680 tests = test_forever()
Georg Brandle8e02e32010-08-03 07:56:50 +0000681 test_count = ''
682 test_count_width = 3
R. David Murray7dc72cc2009-11-14 16:13:02 +0000683 else:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000684 tests = iter(selected)
Georg Brandle8e02e32010-08-03 07:56:50 +0000685 test_count = '/{}'.format(len(selected))
686 test_count_width = len(test_count) - 1
R. David Murray7dc72cc2009-11-14 16:13:02 +0000687
Antoine Pitrou88909542009-06-29 13:54:42 +0000688 if use_mp:
Victor Stinner45df8202010-04-28 22:31:17 +0000689 try:
690 from threading import Thread
Brett Cannonc9a1bfe2013-06-12 20:12:30 -0400691 except ModuleNotFoundError:
Victor Stinner45df8202010-04-28 22:31:17 +0000692 print("Multiprocess option requires thread support")
693 sys.exit(2)
Georg Brandl1b37e872010-03-14 10:45:50 +0000694 from queue import Queue
695 from subprocess import Popen, PIPE
Antoine Pitrouf9d0b122012-12-09 14:28:26 +0100696 debug_output_pat = re.compile(r"\[\d+ refs, \d+ blocks\]$")
Antoine Pitrou88909542009-06-29 13:54:42 +0000697 output = Queue()
Antoine Pitrou09f2e6f2012-07-26 00:45:19 +0200698 pending = MultiprocessTests(tests)
Antoine Pitrou1b03f2c2010-10-14 11:12:00 +0000699 opt_args = support.args_from_interpreter_flags()
Victor Stinner383a8202013-06-25 21:24:36 +0200700 base_cmd = [sys.executable] + opt_args
701 base_cmd += ['-X', 'faulthandler', '-m', 'test.regrtest']
Antoine Pitrou88909542009-06-29 13:54:42 +0000702 def work():
703 # A worker thread.
Neal Norwitz14ca3272006-02-28 18:05:43 +0000704 try:
Antoine Pitrou88909542009-06-29 13:54:42 +0000705 while True:
706 try:
Antoine Pitrou09f2e6f2012-07-26 00:45:19 +0200707 test = next(pending)
R. David Murray7dc72cc2009-11-14 16:13:02 +0000708 except StopIteration:
R. David Murray27144602009-10-19 15:26:16 +0000709 output.put((None, None, None, None))
Antoine Pitrou88909542009-06-29 13:54:42 +0000710 return
Antoine Pitrou09f2e6f2012-07-26 00:45:19 +0200711 args_tuple = (
712 (test, verbose, quiet),
713 dict(huntrleaks=huntrleaks, use_resources=use_resources,
714 debug=debug, output_on_failure=verbose3,
Antoine Pitrou0b9e7b92012-07-26 00:47:15 +0200715 timeout=timeout, failfast=failfast,
716 match_tests=match_tests)
Antoine Pitrou09f2e6f2012-07-26 00:45:19 +0200717 )
Antoine Pitrou88909542009-06-29 13:54:42 +0000718 # -E is needed by some tests, e.g. test_import
Antoine Pitrou282083d2012-07-11 19:19:14 +0200719 # Running the child from the same working directory ensures
720 # that TEMPDIR for the child is the same when
721 # sysconfig.is_python_build() is true. See issue 15300.
Antoine Pitrou1b03f2c2010-10-14 11:12:00 +0000722 popen = Popen(base_cmd + ['--slaveargs', json.dumps(args_tuple)],
R. David Murray27144602009-10-19 15:26:16 +0000723 stdout=PIPE, stderr=PIPE,
Antoine Pitrou36e778e2010-08-18 20:44:14 +0000724 universal_newlines=True,
Antoine Pitrou282083d2012-07-11 19:19:14 +0200725 close_fds=(os.name != 'nt'),
726 cwd=support.SAVEDCWD)
R. David Murray27144602009-10-19 15:26:16 +0000727 stdout, stderr = popen.communicate()
Victor Stinner4b739882011-03-31 18:02:36 +0200728 retcode = popen.wait()
R. David Murray27144602009-10-19 15:26:16 +0000729 # Strip last refcount output line if it exists, since it
730 # comes from the shutdown of the interpreter in the subcommand.
731 stderr = debug_output_pat.sub("", stderr)
732 stdout, _, result = stdout.strip().rpartition("\n")
Victor Stinner4b739882011-03-31 18:02:36 +0200733 if retcode != 0:
734 result = (CHILD_ERROR, "Exit code %s" % retcode)
735 output.put((test, stdout.rstrip(), stderr.rstrip(), result))
736 return
R. David Murray7dc72cc2009-11-14 16:13:02 +0000737 if not result:
738 output.put((None, None, None, None))
739 return
Antoine Pitrou88909542009-06-29 13:54:42 +0000740 result = json.loads(result)
R. David Murray27144602009-10-19 15:26:16 +0000741 output.put((test, stdout.rstrip(), stderr.rstrip(), result))
Antoine Pitrou88909542009-06-29 13:54:42 +0000742 except BaseException:
R. David Murray27144602009-10-19 15:26:16 +0000743 output.put((None, None, None, None))
Neal Norwitz14ca3272006-02-28 18:05:43 +0000744 raise
Antoine Pitrou88909542009-06-29 13:54:42 +0000745 workers = [Thread(target=work) for i in range(use_mp)]
746 for worker in workers:
747 worker.start()
748 finished = 0
Georg Brandldee7b852010-08-02 18:59:52 +0000749 test_index = 1
R. David Murray7dc72cc2009-11-14 16:13:02 +0000750 try:
751 while finished < use_mp:
752 test, stdout, stderr, result = output.get()
753 if test is None:
754 finished += 1
755 continue
Victor Stinnera2a895c2011-05-23 23:14:05 +0200756 accumulate_result(test, result)
Georg Brandldee7b852010-08-02 18:59:52 +0000757 if not quiet:
Ezio Melotti84f75c62011-05-24 01:00:10 +0300758 fmt = "[{1:{0}}{2}/{3}] {4}" if bad else "[{1:{0}}{2}] {4}"
759 print(fmt.format(
Victor Stinnera2a895c2011-05-23 23:14:05 +0200760 test_count_width, test_index, test_count,
761 len(bad), test))
R. David Murray7dc72cc2009-11-14 16:13:02 +0000762 if stdout:
763 print(stdout)
764 if stderr:
765 print(stderr, file=sys.stderr)
Antoine Pitrou82372582012-06-27 17:41:07 +0200766 sys.stdout.flush()
767 sys.stderr.flush()
R. David Murray7dc72cc2009-11-14 16:13:02 +0000768 if result[0] == INTERRUPTED:
Victor Stinner29650112012-08-08 22:37:26 +0200769 raise KeyboardInterrupt
Victor Stinner4b739882011-03-31 18:02:36 +0200770 if result[0] == CHILD_ERROR:
Victor Stinner571e8fd2011-05-01 22:57:43 +0200771 raise Exception("Child error on {}: {}".format(test, result[1]))
Georg Brandldee7b852010-08-02 18:59:52 +0000772 test_index += 1
R. David Murray7dc72cc2009-11-14 16:13:02 +0000773 except KeyboardInterrupt:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000774 interrupted = True
Antoine Pitrou09f2e6f2012-07-26 00:45:19 +0200775 pending.interrupted = True
Antoine Pitrou88909542009-06-29 13:54:42 +0000776 for worker in workers:
777 worker.join()
778 else:
Georg Brandldee7b852010-08-02 18:59:52 +0000779 for test_index, test in enumerate(tests, 1):
Antoine Pitrou88909542009-06-29 13:54:42 +0000780 if not quiet:
Ezio Melotti84f75c62011-05-24 01:00:10 +0300781 fmt = "[{1:{0}}{2}/{3}] {4}" if bad else "[{1:{0}}{2}] {4}"
782 print(fmt.format(
Victor Stinnera2a895c2011-05-23 23:14:05 +0200783 test_count_width, test_index, test_count, len(bad), test))
Antoine Pitrou88909542009-06-29 13:54:42 +0000784 sys.stdout.flush()
785 if trace:
786 # If we're tracing code coverage, then we don't exit with status
787 # if on a false return value from main.
Victor Stinner0cc8d592011-03-31 18:10:13 +0200788 tracer.runctx('runtest(test, verbose, quiet, timeout=timeout)',
Antoine Pitrou88909542009-06-29 13:54:42 +0000789 globals=globals(), locals=vars())
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000790 else:
Antoine Pitrou88909542009-06-29 13:54:42 +0000791 try:
Antoine Pitrou293954d2011-03-23 23:01:49 +0100792 result = runtest(test, verbose, quiet, huntrleaks, debug,
Antoine Pitrou216a3bc2011-07-23 22:33:39 +0200793 output_on_failure=verbose3,
Antoine Pitrouf83e4ac2011-07-29 23:57:10 +0200794 timeout=timeout, failfast=failfast,
795 match_tests=match_tests)
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000796 accumulate_result(test, result)
Antoine Pitrou88909542009-06-29 13:54:42 +0000797 except KeyboardInterrupt:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000798 interrupted = True
Antoine Pitrou88909542009-06-29 13:54:42 +0000799 break
800 except:
801 raise
802 if findleaks:
803 gc.collect()
804 if gc.garbage:
805 print("Warning: test created", len(gc.garbage), end=' ')
806 print("uncollectable object(s).")
807 # move the uncollectable objects somewhere so we don't see
808 # them again
809 found_garbage.extend(gc.garbage)
810 del gc.garbage[:]
811 # Unload the newly imported modules (best effort finalization)
812 for module in sys.modules.keys():
813 if module not in save_modules and module.startswith("test."):
814 support.unload(module)
Jeremy Hylton7a1ea0e2001-10-17 13:45:28 +0000815
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000816 if interrupted:
817 # print a newline after ^C
818 print()
819 print("Test suite interrupted by signal SIGINT.")
820 omitted = set(selected) - set(good) - set(bad) - set(skipped)
821 print(count(len(omitted), "test"), "omitted:")
822 printlist(omitted)
Guido van Rossum152494a1996-12-20 03:12:20 +0000823 if good and not quiet:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000824 if not bad and not skipped and not interrupted and len(good) > 1:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000825 print("All", end=' ')
826 print(count(len(good), "test"), "OK.")
Christian Heimesb186d002008-03-18 15:15:01 +0000827 if print_slow:
828 test_times.sort(reverse=True)
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000829 print("10 slowest tests:")
Christian Heimesb186d002008-03-18 15:15:01 +0000830 for time, test in test_times[:10]:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000831 print("%s: %.1fs" % (test, time))
Guido van Rossum152494a1996-12-20 03:12:20 +0000832 if bad:
Nick Coghlan6ead5522009-10-18 13:19:33 +0000833 bad = sorted(set(bad) - set(environment_changed))
834 if bad:
835 print(count(len(bad), "test"), "failed:")
836 printlist(bad)
Vinay Sajipf9596182012-03-02 01:01:13 +0000837 if environment_changed:
838 print("{} altered the execution environment:".format(
839 count(len(environment_changed), "test")))
840 printlist(environment_changed)
Guido van Rossum152494a1996-12-20 03:12:20 +0000841 if skipped and not quiet:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000842 print(count(len(skipped), "test"), "skipped:")
Tim Petersa45da922001-08-12 03:45:50 +0000843 printlist(skipped)
Barry Warsawe11e3de1999-01-28 19:51:51 +0000844
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000845 if verbose2 and bad:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000846 print("Re-running failed tests in verbose mode")
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000847 for test in bad:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000848 print("Re-running test %r in verbose mode" % test)
Tim Peters922dd7d2006-03-10 23:37:10 +0000849 sys.stdout.flush()
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000850 try:
Antoine Pitrou88909542009-06-29 13:54:42 +0000851 verbose = True
Victor Stinner0cc8d592011-03-31 18:10:13 +0200852 ok = runtest(test, True, quiet, huntrleaks, debug, timeout=timeout)
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000853 except KeyboardInterrupt:
854 # print a newline separate from the ^C
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000855 print()
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000856 break
857 except:
858 raise
859
Barry Warsawe11e3de1999-01-28 19:51:51 +0000860 if single:
R. David Murrayef1992b2009-12-16 15:19:27 +0000861 if next_single_test:
862 with open(filename, 'w') as fp:
863 fp.write(next_single_test + '\n')
Barry Warsawe11e3de1999-01-28 19:51:51 +0000864 else:
865 os.unlink(filename)
866
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000867 if trace:
868 r = tracer.results()
869 r.write_results(show_missing=True, summary=True, coverdir=coverdir)
870
Skip Montanaro0179a182004-06-06 15:53:18 +0000871 if runleaks:
872 os.system("leaks %d" % os.getpid())
873
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000874 sys.exit(len(bad) > 0 or interrupted)
Barry Warsaw08fca522001-08-20 22:33:46 +0000875
Guido van Rossum152494a1996-12-20 03:12:20 +0000876
R David Murrayb588f8d2011-03-24 14:42:58 -0400877# small set of tests to determine if we have a basically functioning interpreter
878# (i.e. if any of these fail, then anything else is likely to follow)
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000879STDTESTS = [
Guido van Rossum152494a1996-12-20 03:12:20 +0000880 'test_grammar',
881 'test_opcodes',
Guido van Rossumd8faa362007-04-27 19:54:29 +0000882 'test_dict',
Guido van Rossum152494a1996-12-20 03:12:20 +0000883 'test_builtin',
884 'test_exceptions',
885 'test_types',
Collin Winter7afaa882007-03-08 19:54:43 +0000886 'test_unittest',
887 'test_doctest',
888 'test_doctest2',
Eli Benderskyd18a0472011-07-27 20:21:45 +0300889 'test_support'
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000890]
Guido van Rossum152494a1996-12-20 03:12:20 +0000891
R David Murrayb588f8d2011-03-24 14:42:58 -0400892# set of tests that we don't want to be executed when using regrtest
R David Murray57648302011-03-24 14:57:05 -0400893NOTTESTS = set()
Guido van Rossum152494a1996-12-20 03:12:20 +0000894
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000895def findtests(testdir=None, stdtests=STDTESTS, nottests=NOTTESTS):
Guido van Rossum152494a1996-12-20 03:12:20 +0000896 """Return a list of all applicable test modules."""
Florent Xiclunada7bfd52010-03-06 11:43:55 +0000897 testdir = findtestdir(testdir)
Guido van Rossum152494a1996-12-20 03:12:20 +0000898 names = os.listdir(testdir)
899 tests = []
Florent Xiclunada7bfd52010-03-06 11:43:55 +0000900 others = set(stdtests) | nottests
Guido van Rossum152494a1996-12-20 03:12:20 +0000901 for name in names:
R David Murray661720e2011-03-21 15:14:34 -0400902 mod, ext = os.path.splitext(name)
903 if mod[:5] == "test_" and ext in (".py", "") and mod not in others:
904 tests.append(mod)
Florent Xiclunada7bfd52010-03-06 11:43:55 +0000905 return stdtests + sorted(tests)
Guido van Rossum152494a1996-12-20 03:12:20 +0000906
Antoine Pitrou09f2e6f2012-07-26 00:45:19 +0200907# We do not use a generator so multiple threads can call next().
908class MultiprocessTests(object):
909
910 """A thread-safe iterator over tests for multiprocess mode."""
911
912 def __init__(self, tests):
913 self.interrupted = False
914 self.lock = threading.Lock()
915 self.tests = tests
916
917 def __iter__(self):
918 return self
919
920 def __next__(self):
921 with self.lock:
922 if self.interrupted:
923 raise StopIteration('tests interrupted')
924 return next(self.tests)
925
Victor Stinnerf58087b2010-05-02 17:24:51 +0000926def replace_stdout():
927 """Set stdout encoder error handler to backslashreplace (as stderr error
928 handler) to avoid UnicodeEncodeError when printing a traceback"""
Victor Stinner4b2b43d2011-01-05 03:54:26 +0000929 import atexit
930
Victor Stinnerf58087b2010-05-02 17:24:51 +0000931 stdout = sys.stdout
932 sys.stdout = open(stdout.fileno(), 'w',
933 encoding=stdout.encoding,
Victor Stinner4b2b43d2011-01-05 03:54:26 +0000934 errors="backslashreplace",
Victor Stinnerbe621032011-05-25 02:01:55 +0200935 closefd=False,
936 newline='\n')
Victor Stinner4b2b43d2011-01-05 03:54:26 +0000937
938 def restore_stdout():
939 sys.stdout.close()
940 sys.stdout = stdout
941 atexit.register(restore_stdout)
Victor Stinnerf58087b2010-05-02 17:24:51 +0000942
Antoine Pitrou88909542009-06-29 13:54:42 +0000943def runtest(test, verbose, quiet,
Antoine Pitrou293954d2011-03-23 23:01:49 +0100944 huntrleaks=False, debug=False, use_resources=None,
Antoine Pitrouf83e4ac2011-07-29 23:57:10 +0200945 output_on_failure=False, failfast=False, match_tests=None,
946 timeout=None):
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000947 """Run a single test.
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000948
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000949 test -- the name of the test
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000950 verbose -- if true, print more messages
Trent Mickf29f47b2000-08-11 19:02:59 +0000951 quiet -- if true, don't print 'skipped' messages (probably redundant)
Christian Heimesb186d002008-03-18 15:15:01 +0000952 test_times -- a list of (time, test_name) pairs
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000953 huntrleaks -- run multiple times to test for leaks; requires a debug
954 build; a triple corresponding to -R's three arguments
Victor Stinner8313d6a2011-06-29 15:22:26 +0200955 output_on_failure -- if true, display test output on failure
Victor Stinner0cc8d592011-03-31 18:10:13 +0200956 timeout -- dump the traceback and exit if a test takes more than
957 timeout seconds
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000958
959 Returns one of the test result constants:
960 INTERRUPTED KeyboardInterrupt when run under -j
961 RESOURCE_DENIED test skipped because resource denied
962 SKIPPED test skipped for some other reason
963 ENV_CHANGED test failed because it changed the execution environment
964 FAILED test failed
965 PASSED test passed
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000966 """
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000967
Antoine Pitrou88909542009-06-29 13:54:42 +0000968 if use_resources is not None:
969 support.use_resources = use_resources
Victor Stinner30196882011-06-03 12:53:26 +0200970 use_timeout = (timeout is not None)
Victor Stinner7d648a02011-03-31 18:27:50 +0200971 if use_timeout:
Victor Stinner4de701b2013-06-17 20:27:10 +0200972 faulthandler.dump_traceback_later(timeout, exit=True)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000973 try:
Antoine Pitroub9c73e82011-07-29 23:53:38 +0200974 support.match_tests = match_tests
Antoine Pitrou216a3bc2011-07-23 22:33:39 +0200975 if failfast:
976 support.failfast = True
Victor Stinner8313d6a2011-06-29 15:22:26 +0200977 if output_on_failure:
Victor Stinnerea95de72011-06-29 15:34:48 +0200978 support.verbose = True
979
980 # Reuse the same instance to all calls to runtest(). Some
981 # tests keep a reference to sys.stdout or sys.stderr
982 # (eg. test_argparse).
Victor Stinner8313d6a2011-06-29 15:22:26 +0200983 if runtest.stringio is None:
Victor Stinnerfcc2a212011-06-29 20:01:29 +0200984 stream = io.StringIO()
985 runtest.stringio = stream
986 else:
987 stream = runtest.stringio
988 stream.seek(0)
989 stream.truncate()
Victor Stinner8313d6a2011-06-29 15:22:26 +0200990
991 orig_stdout = sys.stdout
Victor Stinnera7c33e52011-06-29 13:00:54 +0200992 orig_stderr = sys.stderr
Victor Stinner8313d6a2011-06-29 15:22:26 +0200993 try:
Victor Stinnerea95de72011-06-29 15:34:48 +0200994 sys.stdout = stream
995 sys.stderr = stream
Victor Stinner8313d6a2011-06-29 15:22:26 +0200996 result = runtest_inner(test, verbose, quiet, huntrleaks,
997 debug, display_failure=False)
998 if result[0] == FAILED:
Victor Stinnerea95de72011-06-29 15:34:48 +0200999 output = stream.getvalue()
Victor Stinner8313d6a2011-06-29 15:22:26 +02001000 orig_stderr.write(output)
1001 orig_stderr.flush()
1002 finally:
1003 sys.stdout = orig_stdout
1004 sys.stderr = orig_stderr
Victor Stinnera7c33e52011-06-29 13:00:54 +02001005 else:
Victor Stinnerea95de72011-06-29 15:34:48 +02001006 support.verbose = verbose # Tell tests to be moderately quiet
Victor Stinnera7c33e52011-06-29 13:00:54 +02001007 result = runtest_inner(test, verbose, quiet, huntrleaks, debug,
1008 display_failure=not verbose)
Antoine Pitrou293954d2011-03-23 23:01:49 +01001009 return result
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001010 finally:
Victor Stinner7d648a02011-03-31 18:27:50 +02001011 if use_timeout:
Victor Stinner934676a2013-06-17 20:35:08 +02001012 faulthandler.cancel_dump_traceback_later()
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001013 cleanup_test_droppings(test, verbose)
Victor Stinner8313d6a2011-06-29 15:22:26 +02001014runtest.stringio = None
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001015
Nick Coghlan6ead5522009-10-18 13:19:33 +00001016# Unit tests are supposed to leave the execution environment unchanged
1017# once they complete. But sometimes tests have bugs, especially when
1018# tests fail, and the changes to environment go on to mess up other
1019# tests. This can cause issues with buildbot stability, since tests
1020# are run in random order and so problems may appear to come and go.
1021# There are a few things we can save and restore to mitigate this, and
1022# the following context manager handles this task.
1023
1024class saved_test_environment:
1025 """Save bits of the test environment and restore them at block exit.
1026
1027 with saved_test_environment(testname, verbose, quiet):
1028 #stuff
1029
1030 Unless quiet is True, a warning is printed to stderr if any of
1031 the saved items was changed by the test. The attribute 'changed'
1032 is initially False, but is set to True if a change is detected.
1033
1034 If verbose is more than 1, the before and after state of changed
1035 items is also printed.
1036 """
1037
1038 changed = False
1039
1040 def __init__(self, testname, verbose=0, quiet=False):
1041 self.testname = testname
1042 self.verbose = verbose
1043 self.quiet = quiet
1044
1045 # To add things to save and restore, add a name XXX to the resources list
1046 # and add corresponding get_XXX/restore_XXX functions. get_XXX should
1047 # return the value to be saved and compared against a second call to the
1048 # get function when test execution completes. restore_XXX should accept
1049 # the saved value and restore the resource using it. It will be called if
1050 # and only if a change in the value is detected.
1051 #
1052 # Note: XXX will have any '.' replaced with '_' characters when determining
1053 # the corresponding method names.
1054
1055 resources = ('sys.argv', 'cwd', 'sys.stdin', 'sys.stdout', 'sys.stderr',
Brett Cannon29c0e4f2010-03-20 22:22:57 +00001056 'os.environ', 'sys.path', 'sys.path_hooks', '__import__',
Nick Coghlan7bd5dbe2010-12-05 07:17:25 +00001057 'warnings.filters', 'asyncore.socket_map',
Ezio Melotti45763d02011-03-20 15:34:28 +02001058 'logging._handlers', 'logging._handlerList', 'sys.gettrace',
Antoine Pitrouc081c0c2011-07-15 22:12:24 +02001059 'sys.warnoptions', 'threading._dangling',
Éric Araujo28df8de2011-09-19 05:10:45 +02001060 'multiprocessing.process._dangling',
Éric Araujoec177c12012-06-24 03:27:43 -04001061 'sysconfig._CONFIG_VARS', 'sysconfig._INSTALL_SCHEMES',
Brett Cannon6d26eba2013-06-16 15:20:48 -04001062 'support.TESTFN', 'locale', 'warnings.showwarning',
Éric Araujo28df8de2011-09-19 05:10:45 +02001063 )
Nick Coghlan6ead5522009-10-18 13:19:33 +00001064
1065 def get_sys_argv(self):
1066 return id(sys.argv), sys.argv, sys.argv[:]
1067 def restore_sys_argv(self, saved_argv):
1068 sys.argv = saved_argv[1]
1069 sys.argv[:] = saved_argv[2]
1070
1071 def get_cwd(self):
1072 return os.getcwd()
1073 def restore_cwd(self, saved_cwd):
1074 os.chdir(saved_cwd)
1075
1076 def get_sys_stdout(self):
1077 return sys.stdout
1078 def restore_sys_stdout(self, saved_stdout):
1079 sys.stdout = saved_stdout
1080
1081 def get_sys_stderr(self):
1082 return sys.stderr
1083 def restore_sys_stderr(self, saved_stderr):
1084 sys.stderr = saved_stderr
1085
1086 def get_sys_stdin(self):
1087 return sys.stdin
1088 def restore_sys_stdin(self, saved_stdin):
1089 sys.stdin = saved_stdin
1090
1091 def get_os_environ(self):
1092 return id(os.environ), os.environ, dict(os.environ)
1093 def restore_os_environ(self, saved_environ):
1094 os.environ = saved_environ[1]
1095 os.environ.clear()
1096 os.environ.update(saved_environ[2])
1097
1098 def get_sys_path(self):
1099 return id(sys.path), sys.path, sys.path[:]
1100 def restore_sys_path(self, saved_path):
1101 sys.path = saved_path[1]
1102 sys.path[:] = saved_path[2]
1103
Brett Cannon055470a2010-02-19 15:57:10 +00001104 def get_sys_path_hooks(self):
1105 return id(sys.path_hooks), sys.path_hooks, sys.path_hooks[:]
1106 def restore_sys_path_hooks(self, saved_hooks):
1107 sys.path_hooks = saved_hooks[1]
1108 sys.path_hooks[:] = saved_hooks[2]
1109
Brett Cannon31f59292011-02-21 19:29:56 +00001110 def get_sys_gettrace(self):
1111 return sys.gettrace()
1112 def restore_sys_gettrace(self, trace_fxn):
1113 sys.settrace(trace_fxn)
1114
Brett Cannon055470a2010-02-19 15:57:10 +00001115 def get___import__(self):
Brett Cannon45071902010-06-14 22:22:54 +00001116 return builtins.__import__
Brett Cannon055470a2010-02-19 15:57:10 +00001117 def restore___import__(self, import_):
Brett Cannon45071902010-06-14 22:22:54 +00001118 builtins.__import__ = import_
Brett Cannon055470a2010-02-19 15:57:10 +00001119
Brett Cannon29c0e4f2010-03-20 22:22:57 +00001120 def get_warnings_filters(self):
1121 return id(warnings.filters), warnings.filters, warnings.filters[:]
1122 def restore_warnings_filters(self, saved_filters):
1123 warnings.filters = saved_filters[1]
1124 warnings.filters[:] = saved_filters[2]
1125
Antoine Pitroub14ac8c2010-08-16 00:28:05 +00001126 def get_asyncore_socket_map(self):
1127 asyncore = sys.modules.get('asyncore')
Antoine Pitrouaa879652010-10-29 11:54:38 +00001128 # XXX Making a copy keeps objects alive until __exit__ gets called.
1129 return asyncore and asyncore.socket_map.copy() or {}
Antoine Pitroub14ac8c2010-08-16 00:28:05 +00001130 def restore_asyncore_socket_map(self, saved_map):
1131 asyncore = sys.modules.get('asyncore')
1132 if asyncore is not None:
Antoine Pitrouaa879652010-10-29 11:54:38 +00001133 asyncore.close_all(ignore_all=True)
Antoine Pitroub14ac8c2010-08-16 00:28:05 +00001134 asyncore.socket_map.update(saved_map)
1135
Éric Araujoff913062011-11-29 16:45:07 +01001136 def get_shutil_archive_formats(self):
1137 # we could call get_archives_formats() but that only returns the
1138 # registry keys; we want to check the values too (the functions that
1139 # are registered)
1140 return shutil._ARCHIVE_FORMATS, shutil._ARCHIVE_FORMATS.copy()
1141 def restore_shutil_archive_formats(self, saved):
1142 shutil._ARCHIVE_FORMATS = saved[0]
1143 shutil._ARCHIVE_FORMATS.clear()
1144 shutil._ARCHIVE_FORMATS.update(saved[1])
1145
1146 def get_shutil_unpack_formats(self):
1147 return shutil._UNPACK_FORMATS, shutil._UNPACK_FORMATS.copy()
1148 def restore_shutil_unpack_formats(self, saved):
1149 shutil._UNPACK_FORMATS = saved[0]
1150 shutil._UNPACK_FORMATS.clear()
1151 shutil._UNPACK_FORMATS.update(saved[1])
1152
Nick Coghlan7d819752010-12-05 06:45:03 +00001153 def get_logging__handlers(self):
1154 # _handlers is a WeakValueDictionary
Nick Coghlan7bd5dbe2010-12-05 07:17:25 +00001155 return id(logging._handlers), logging._handlers, logging._handlers.copy()
Nick Coghlan7d819752010-12-05 06:45:03 +00001156 def restore_logging__handlers(self, saved_handlers):
1157 # Can't easily revert the logging state
1158 pass
1159
Nick Coghlan7bd5dbe2010-12-05 07:17:25 +00001160 def get_logging__handlerList(self):
1161 # _handlerList is a list of weakrefs to handlers
1162 return id(logging._handlerList), logging._handlerList, logging._handlerList[:]
1163 def restore_logging__handlerList(self, saved_handlerList):
1164 # Can't easily revert the logging state
1165 pass
1166
Ezio Melotti0123e052011-03-20 15:09:26 +02001167 def get_sys_warnoptions(self):
1168 return id(sys.warnoptions), sys.warnoptions, sys.warnoptions[:]
1169 def restore_sys_warnoptions(self, saved_options):
1170 sys.warnoptions = saved_options[1]
1171 sys.warnoptions[:] = saved_options[2]
1172
Antoine Pitrouc081c0c2011-07-15 22:12:24 +02001173 # Controlling dangling references to Thread objects can make it easier
1174 # to track reference leaks.
1175 def get_threading__dangling(self):
1176 if not threading:
1177 return None
1178 # This copies the weakrefs without making any strong reference
1179 return threading._dangling.copy()
1180 def restore_threading__dangling(self, saved):
1181 if not threading:
1182 return
1183 threading._dangling.clear()
1184 threading._dangling.update(saved)
1185
1186 # Same for Process objects
1187 def get_multiprocessing_process__dangling(self):
1188 if not multiprocessing:
1189 return None
1190 # 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
Vinay Sajipf9596182012-03-02 01:01:13 +00001216 def get_support_TESTFN(self):
1217 if os.path.isfile(support.TESTFN):
1218 result = 'f'
1219 elif os.path.isdir(support.TESTFN):
1220 result = 'd'
1221 else:
1222 result = None
1223 return result
1224 def restore_support_TESTFN(self, saved_value):
1225 if saved_value is None:
1226 if os.path.isfile(support.TESTFN):
1227 os.unlink(support.TESTFN)
1228 elif os.path.isdir(support.TESTFN):
1229 shutil.rmtree(support.TESTFN)
Éric Araujo28df8de2011-09-19 05:10:45 +02001230
Victor Stinnerd9ccf7f2013-06-17 20:40:05 +02001231 _lc = [getattr(locale, lc) for lc in dir(locale)
Victor Stinner546ccf02013-06-17 21:28:14 +02001232 if lc.startswith('LC_')]
Brett Cannon49e835b2013-04-01 14:11:37 -04001233 def get_locale(self):
1234 pairings = []
1235 for lc in self._lc:
1236 try:
Victor Stinner546ccf02013-06-17 21:28:14 +02001237 pairings.append((lc, locale.setlocale(lc, None)))
Victor Stinnerd9ccf7f2013-06-17 20:40:05 +02001238 except (TypeError, ValueError):
Brett Cannon49e835b2013-04-01 14:11:37 -04001239 continue
1240 return pairings
1241 def restore_locale(self, saved):
1242 for lc, setting in saved:
1243 locale.setlocale(lc, setting)
1244
Brett Cannon6d26eba2013-06-16 15:20:48 -04001245 def get_warnings_showwarning(self):
1246 return warnings.showwarning
1247 def restore_warnings_showwarning(self, fxn):
1248 warnings.showwarning = fxn
1249
Nick Coghlan6ead5522009-10-18 13:19:33 +00001250 def resource_info(self):
1251 for name in self.resources:
1252 method_suffix = name.replace('.', '_')
1253 get_name = 'get_' + method_suffix
1254 restore_name = 'restore_' + method_suffix
1255 yield name, getattr(self, get_name), getattr(self, restore_name)
1256
1257 def __enter__(self):
1258 self.saved_values = dict((name, get()) for name, get, restore
1259 in self.resource_info())
1260 return self
1261
1262 def __exit__(self, exc_type, exc_val, exc_tb):
Antoine Pitrouaa879652010-10-29 11:54:38 +00001263 saved_values = self.saved_values
1264 del self.saved_values
Nick Coghlan6ead5522009-10-18 13:19:33 +00001265 for name, get, restore in self.resource_info():
1266 current = get()
Antoine Pitrouaa879652010-10-29 11:54:38 +00001267 original = saved_values.pop(name)
Nick Coghlan6ead5522009-10-18 13:19:33 +00001268 # Check for changes to the resource's value
1269 if current != original:
1270 self.changed = True
1271 restore(original)
1272 if not self.quiet:
1273 print("Warning -- {} was modified by {}".format(
1274 name, self.testname),
1275 file=sys.stderr)
1276 if self.verbose > 1:
1277 print(" Before: {}\n After: {} ".format(
1278 original, current),
1279 file=sys.stderr)
1280 return False
1281
1282
Victor Stinnera7c33e52011-06-29 13:00:54 +02001283def runtest_inner(test, verbose, quiet,
1284 huntrleaks=False, debug=False, display_failure=True):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001285 support.unload(test)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001286
Antoine Pitrou88909542009-06-29 13:54:42 +00001287 test_time = 0.0
Collin Wintera5503d52009-05-15 01:20:21 +00001288 refleak = False # True if the test leaked references.
Guido van Rossum152494a1996-12-20 03:12:20 +00001289 try:
R. David Murray0bc11ae2009-10-18 22:18:17 +00001290 if test.startswith('test.'):
1291 abstest = test
1292 else:
1293 # Always import it from the test package
1294 abstest = 'test.' + test
1295 with saved_test_environment(test, verbose, quiet) as environment:
1296 start_time = time.time()
Brett Cannon613cf252012-11-14 13:42:51 -05001297 the_module = importlib.import_module(abstest)
R David Murray78fc25c2012-04-09 08:55:42 -04001298 # If the test has a test_main, that will run the appropriate
1299 # tests. If not, use normal unittest test loading.
1300 test_runner = getattr(the_module, "test_main", None)
1301 if test_runner is None:
1302 tests = unittest.TestLoader().loadTestsFromModule(the_module)
1303 test_runner = lambda: support.run_unittest(tests)
1304 test_runner()
R. David Murray0bc11ae2009-10-18 22:18:17 +00001305 if huntrleaks:
R David Murray78fc25c2012-04-09 08:55:42 -04001306 refleak = dash_R(the_module, test, test_runner,
R. David Murray0bc11ae2009-10-18 22:18:17 +00001307 huntrleaks)
1308 test_time = time.time() - start_time
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001309 except support.ResourceDenied as msg:
Fred Drake9a0db072003-02-03 15:19:30 +00001310 if not quiet:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001311 print(test, "skipped --", msg)
Fred Drake9a0db072003-02-03 15:19:30 +00001312 sys.stdout.flush()
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001313 return RESOURCE_DENIED, test_time
R. David Murraya21e4ca2009-03-31 23:16:50 +00001314 except unittest.SkipTest as msg:
Trent Mickf29f47b2000-08-11 19:02:59 +00001315 if not quiet:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001316 print(test, "skipped --", msg)
Guido van Rossum3cda93e2002-09-13 21:28:03 +00001317 sys.stdout.flush()
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001318 return SKIPPED, test_time
Fred Drakefe5c22a2000-08-18 16:04:05 +00001319 except KeyboardInterrupt:
1320 raise
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001321 except support.TestFailed as msg:
Victor Stinnera7c33e52011-06-29 13:00:54 +02001322 if display_failure:
1323 print("test", test, "failed --", msg, file=sys.stderr)
1324 else:
1325 print("test", test, "failed", file=sys.stderr)
R. David Murray11cabcf2010-09-29 01:08:05 +00001326 sys.stderr.flush()
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001327 return FAILED, test_time
Guido van Rossum9e48b271997-07-16 01:56:13 +00001328 except:
Antoine Pitrou779a5b02011-03-21 19:55:16 +01001329 msg = traceback.format_exc()
1330 print("test", test, "crashed --", msg, file=sys.stderr)
R. David Murray11cabcf2010-09-29 01:08:05 +00001331 sys.stderr.flush()
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001332 return FAILED, test_time
Guido van Rossum152494a1996-12-20 03:12:20 +00001333 else:
Collin Wintera5503d52009-05-15 01:20:21 +00001334 if refleak:
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001335 return FAILED, test_time
Nick Coghlan6ead5522009-10-18 13:19:33 +00001336 if environment.changed:
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001337 return ENV_CHANGED, test_time
1338 return PASSED, test_time
Guido van Rossum0fcca4e2001-09-21 20:31:52 +00001339
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001340def cleanup_test_droppings(testname, verbose):
1341 import shutil
Benjamin Peterson25c95f12009-05-08 20:42:26 +00001342 import stat
Antoine Pitrouc14efc42010-10-29 19:34:45 +00001343 import gc
1344
1345 # First kill any dangling references to open files etc.
1346 # This can also issue some ResourceWarnings which would otherwise get
Antoine Pitrou2b40efd2010-10-29 19:36:37 +00001347 # triggered during the following test run, and possibly produce failures.
Antoine Pitrouc14efc42010-10-29 19:34:45 +00001348 gc.collect()
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001349
1350 # Try to clean up junk commonly left behind. While tests shouldn't leave
1351 # any files or directories behind, when a test fails that can be tedious
1352 # for it to arrange. The consequences can be especially nasty on Windows,
1353 # since if a test leaves a file open, it cannot be deleted by name (while
1354 # there's nothing we can do about that here either, we can display the
1355 # name of the offending test, which is a real help).
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001356 for name in (support.TESTFN,
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001357 "db_home",
1358 ):
1359 if not os.path.exists(name):
1360 continue
1361
1362 if os.path.isdir(name):
1363 kind, nuker = "directory", shutil.rmtree
1364 elif os.path.isfile(name):
1365 kind, nuker = "file", os.unlink
1366 else:
1367 raise SystemError("os.path says %r exists but is neither "
1368 "directory nor file" % name)
1369
1370 if verbose:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001371 print("%r left behind %s %r" % (testname, kind, name))
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001372 try:
Benjamin Peterson25c95f12009-05-08 20:42:26 +00001373 # if we have chmod, fix possible permissions problems
1374 # that might prevent cleanup
1375 if (hasattr(os, 'chmod')):
1376 os.chmod(name, stat.S_IRWXU | stat.S_IRWXG | stat.S_IRWXO)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001377 nuker(name)
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001378 except Exception as msg:
1379 print(("%r left behind %s %r and it couldn't be "
1380 "removed: %s" % (testname, kind, name, msg)), file=sys.stderr)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001381
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001382def dash_R(the_module, test, indirect_test, huntrleaks):
Collin Wintera5503d52009-05-15 01:20:21 +00001383 """Run a test multiple times, looking for reference leaks.
1384
1385 Returns:
1386 False if the test didn't leak references; True if we detected refleaks.
1387 """
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001388 # This code is hackish and inelegant, but it seems to do the job.
Raymond Hettinger158c9c22011-02-22 00:41:50 +00001389 import copyreg
1390 import collections.abc
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001391
1392 if not hasattr(sys, 'gettotalrefcount'):
1393 raise Exception("Tracking reference leaks requires a debug build "
1394 "of Python")
1395
1396 # Save current values for dash_R_cleanup() to restore.
1397 fs = warnings.filters[:]
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +00001398 ps = copyreg.dispatch_table.copy()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001399 pic = sys.path_importer_cache.copy()
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001400 try:
1401 import zipimport
Brett Cannonc9a1bfe2013-06-12 20:12:30 -04001402 except ModuleNotFoundError:
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001403 zdc = None # Run unmodified on platforms without zipimport support
1404 else:
1405 zdc = zipimport._zip_directory_cache.copy()
Christian Heimes93852662007-12-01 12:22:32 +00001406 abcs = {}
Raymond Hettinger158c9c22011-02-22 00:41:50 +00001407 for abc in [getattr(collections.abc, a) for a in collections.abc.__all__]:
Christian Heimesbe5b30b2008-03-03 19:18:51 +00001408 if not isabstract(abc):
Christian Heimes93852662007-12-01 12:22:32 +00001409 continue
1410 for obj in abc.__subclasses__() + [abc]:
1411 abcs[obj] = obj._abc_registry.copy()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001412
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001413 nwarmup, ntracked, fname = huntrleaks
Ezio Melotti184bdfb2010-02-18 09:37:05 +00001414 fname = os.path.join(support.SAVEDCWD, fname)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001415 repcount = nwarmup + ntracked
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001416 rc_deltas = [0] * repcount
1417 alloc_deltas = [0] * repcount
1418
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001419 print("beginning", repcount, "repetitions", file=sys.stderr)
1420 print(("1234567890"*(repcount//10 + 1))[:repcount], file=sys.stderr)
Antoine Pitrou88909542009-06-29 13:54:42 +00001421 sys.stderr.flush()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001422 for i in range(repcount):
R David Murray14d080e2013-01-12 11:34:38 -05001423 indirect_test()
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001424 alloc_after, rc_after = dash_R_cleanup(fs, ps, pic, zdc, abcs)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001425 sys.stderr.write('.')
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001426 sys.stderr.flush()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001427 if i >= nwarmup:
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001428 rc_deltas[i] = rc_after - rc_before
1429 alloc_deltas[i] = alloc_after - alloc_before
1430 alloc_before, rc_before = alloc_after, rc_after
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001431 print(file=sys.stderr)
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001432 # These checkers return False on success, True on failure
1433 def check_rc_deltas(deltas):
1434 return any(deltas)
1435 def check_alloc_deltas(deltas):
1436 # At least 1/3rd of 0s
1437 if 3 * deltas.count(0) < len(deltas):
1438 return True
1439 # Nothing else than 1s, 0s and -1s
1440 if not set(deltas) <= {1,0,-1}:
1441 return True
1442 return False
1443 failed = False
1444 for deltas, item_name, checker in [
1445 (rc_deltas, 'references', check_rc_deltas),
1446 (alloc_deltas, 'memory blocks', check_alloc_deltas)]:
1447 if checker(deltas):
1448 msg = '%s leaked %s %s, sum=%s' % (
1449 test, deltas[nwarmup:], item_name, sum(deltas))
1450 print(msg, file=sys.stderr)
1451 sys.stderr.flush()
1452 with open(fname, "a") as refrep:
1453 print(msg, file=refrep)
1454 refrep.flush()
1455 failed = True
1456 return failed
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001457
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001458def dash_R_cleanup(fs, ps, pic, zdc, abcs):
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +00001459 import gc, copyreg
Brett Cannonf4fd9932008-05-10 21:11:46 +00001460 import _strptime, linecache
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001461 import urllib.parse, urllib.request, mimetypes, doctest
Raymond Hettinger158c9c22011-02-22 00:41:50 +00001462 import struct, filecmp, collections.abc
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001463 from distutils.dir_util import _path_created
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001464 from weakref import WeakSet
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001465
Christian Heimesdae2a892008-04-19 00:55:37 +00001466 # Clear the warnings registry, so they can be displayed again
1467 for mod in sys.modules.values():
1468 if hasattr(mod, '__warningregistry__'):
1469 del mod.__warningregistry__
1470
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001471 # Restore some original values.
1472 warnings.filters[:] = fs
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +00001473 copyreg.dispatch_table.clear()
1474 copyreg.dispatch_table.update(ps)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001475 sys.path_importer_cache.clear()
1476 sys.path_importer_cache.update(pic)
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001477 try:
1478 import zipimport
Brett Cannonc9a1bfe2013-06-12 20:12:30 -04001479 except ModuleNotFoundError:
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001480 pass # Run unmodified on platforms without zipimport support
1481 else:
1482 zipimport._zip_directory_cache.clear()
1483 zipimport._zip_directory_cache.update(zdc)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001484
Christian Heimes26855632008-01-27 23:50:43 +00001485 # clear type cache
Christian Heimes15ebc882008-02-04 18:48:49 +00001486 sys._clear_type_cache()
Christian Heimes26855632008-01-27 23:50:43 +00001487
Guido van Rossum3de862d2007-08-18 00:10:33 +00001488 # Clear ABC registries, restoring previously saved ABC registries.
Raymond Hettinger158c9c22011-02-22 00:41:50 +00001489 for abc in [getattr(collections.abc, a) for a in collections.abc.__all__]:
Christian Heimesbe5b30b2008-03-03 19:18:51 +00001490 if not isabstract(abc):
Christian Heimes941973a2007-11-30 21:53:03 +00001491 continue
Guido van Rossum7eaf8222007-06-18 17:58:50 +00001492 for obj in abc.__subclasses__() + [abc]:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001493 obj._abc_registry = abcs.get(obj, WeakSet()).copy()
Guido van Rossumc1e315d2007-08-20 19:29:24 +00001494 obj._abc_cache.clear()
1495 obj._abc_negative_cache.clear()
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001496
Antoine Pitrou046467c2009-10-30 18:30:35 +00001497 # Flush standard output, so that buffered data is sent to the OS and
1498 # associated Python objects are reclaimed.
1499 for stream in (sys.stdout, sys.stderr, sys.__stdout__, sys.__stderr__):
1500 if stream is not None:
1501 stream.flush()
1502
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001503 # Clear assorted module caches.
1504 _path_created.clear()
1505 re.purge()
1506 _strptime._regex_cache.clear()
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001507 urllib.parse.clear_cache()
1508 urllib.request.urlcleanup()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001509 linecache.clearcache()
1510 mimetypes._default_mime_types()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001511 filecmp._cache.clear()
Christian Heimesa34706f2008-01-04 03:06:10 +00001512 struct._clearcache()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001513 doctest.master = None
Meador Inge11e38132011-11-25 22:33:32 -06001514 try:
1515 import ctypes
Brett Cannonc9a1bfe2013-06-12 20:12:30 -04001516 except ModuleNotFoundError:
Meador Inge11e38132011-11-25 22:33:32 -06001517 # Don't worry about resetting the cache if ctypes is not supported
1518 pass
1519 else:
1520 ctypes._reset_cache()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001521
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001522 # Collect cyclic trash and read memory statistics immediately after.
1523 func1 = sys.getallocatedblocks
1524 func2 = sys.gettotalrefcount
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001525 gc.collect()
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001526 return func1(), func2()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001527
Stefan Krah5c3ddc82012-08-17 23:09:48 +02001528def warm_caches():
1529 # char cache
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001530 s = bytes(range(256))
1531 for i in range(256):
1532 s[i:i+1]
Stefan Krah5c3ddc82012-08-17 23:09:48 +02001533 # unicode cache
1534 x = [chr(i) for i in range(256)]
1535 # int cache
1536 x = list(range(-5, 257))
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001537
Florent Xiclunada7bfd52010-03-06 11:43:55 +00001538def findtestdir(path=None):
1539 return path or os.path.dirname(__file__) or os.curdir
Guido van Rossum152494a1996-12-20 03:12:20 +00001540
Florent Xiclunada7bfd52010-03-06 11:43:55 +00001541def removepy(names):
1542 if not names:
1543 return
1544 for idx, name in enumerate(names):
1545 basename, ext = os.path.splitext(name)
1546 if ext == '.py':
1547 names[idx] = basename
Tim Petersc5000df2002-06-02 21:42:01 +00001548
Guido van Rossum152494a1996-12-20 03:12:20 +00001549def count(n, word):
1550 if n == 1:
Guido van Rossum41360a41998-03-26 19:42:58 +00001551 return "%d %s" % (n, word)
Guido van Rossum152494a1996-12-20 03:12:20 +00001552 else:
Guido van Rossum41360a41998-03-26 19:42:58 +00001553 return "%d %ss" % (n, word)
Guido van Rossum152494a1996-12-20 03:12:20 +00001554
Tim Petersa45da922001-08-12 03:45:50 +00001555def printlist(x, width=70, indent=4):
Tim Peters7c7efe92002-08-23 17:55:54 +00001556 """Print the elements of iterable x to stdout.
Tim Petersa45da922001-08-12 03:45:50 +00001557
1558 Optional arg width (default 70) is the maximum line length.
1559 Optional arg indent (default 4) is the number of blanks with which to
1560 begin each line.
1561 """
1562
Tim Petersba78bc42002-07-04 19:45:06 +00001563 from textwrap import fill
1564 blanks = ' ' * indent
Florent Xiclunafd1b0932010-03-28 00:25:02 +00001565 # Print the sorted list: 'x' may be a '--random' list or a set()
1566 print(fill(' '.join(str(elt) for elt in sorted(x)), width,
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001567 initial_indent=blanks, subsequent_indent=blanks))
Tim Petersa45da922001-08-12 03:45:50 +00001568
Tim Petersb5b7b782001-08-12 01:20:39 +00001569
Chris Jerdonek517e9252013-02-27 09:02:53 -08001570def main_in_temp_cwd():
1571 """Run main() in a temporary working directory."""
Michael Foord3ab34cc2010-12-03 12:27:40 +00001572 if sysconfig.is_python_build():
Antoine Pitrouee429342011-04-16 18:53:59 +02001573 try:
Michael Foord3ab34cc2010-12-03 12:27:40 +00001574 os.mkdir(TEMPDIR)
Florent Xicluna68f71a32011-10-28 16:06:23 +02001575 except FileExistsError:
1576 pass
Michael Foord3ab34cc2010-12-03 12:27:40 +00001577
1578 # Define a writable temp dir that will be used as cwd while running
1579 # the tests. The name of the dir includes the pid to allow parallel
1580 # testing (see the -j option).
Chris Jerdonek517e9252013-02-27 09:02:53 -08001581 test_cwd = 'test_python_{}'.format(os.getpid())
1582 test_cwd = os.path.join(TEMPDIR, test_cwd)
Michael Foord3ab34cc2010-12-03 12:27:40 +00001583
Chris Jerdonek517e9252013-02-27 09:02:53 -08001584 # Run the tests in a context manager that temporarily changes the CWD to a
1585 # temporary and writable directory. If it's not possible to create or
1586 # change the CWD, the original CWD will be used. The original CWD is
1587 # available from support.SAVEDCWD.
1588 with support.temp_cwd(test_cwd, quiet=True):
1589 main()
1590
Nick Coghlan4c4c0f22010-12-03 07:44:33 +00001591
Guido van Rossum152494a1996-12-20 03:12:20 +00001592if __name__ == '__main__':
Nick Coghlan4c4c0f22010-12-03 07:44:33 +00001593 # Remove regrtest.py's own directory from the module search path. Despite
1594 # the elimination of implicit relative imports, this is still needed to
1595 # ensure that submodules of the test package do not inappropriately appear
1596 # as top-level modules even when people (or buildbots!) invoke regrtest.py
1597 # directly instead of using the -m switch
1598 mydir = os.path.abspath(os.path.normpath(os.path.dirname(sys.argv[0])))
1599 i = len(sys.path)
1600 while i >= 0:
1601 i -= 1
1602 if os.path.abspath(os.path.normpath(sys.path[i])) == mydir:
1603 del sys.path[i]
1604
Florent Xiclunadc69e722010-09-13 16:35:02 +00001605 # findtestdir() gets the dirname out of __file__, so we have to make it
1606 # absolute before changing the working directory.
1607 # For example __file__ may be relative when running trace or profile.
1608 # See issue #9323.
1609 __file__ = os.path.abspath(__file__)
1610
1611 # sanity check
Florent Xiclunada7bfd52010-03-06 11:43:55 +00001612 assert __file__ == os.path.abspath(sys.argv[0])
Ezio Melotti184bdfb2010-02-18 09:37:05 +00001613
Chris Jerdonek517e9252013-02-27 09:02:53 -08001614 main_in_temp_cwd()