blob: 9a83fbe1d004d22724b001a7c9a694085c182392 [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"""
4Usage:
Guido van Rossum152494a1996-12-20 03:12:20 +00005
Georg Brandlbe41a482011-01-05 21:47:47 +00006python -m test [options] [test_name1 [test_name2 ...]]
R. David Murray0ba81e02010-04-26 17:02:32 +00007python path/to/Lib/test/regrtest.py [options] [test_name1 [test_name2 ...]]
Guido van Rossum152494a1996-12-20 03:12:20 +00008
R. David Murray0ba81e02010-04-26 17:02:32 +00009
10If no arguments or options are provided, finds all files matching
11the pattern "test_*" in the Lib/test subdirectory and runs
12them in alphabetical order (but see -M and -u, below, for exceptions).
13
14For more rigorous testing, it is useful to use the following
15command line:
16
Georg Brandlbe41a482011-01-05 21:47:47 +000017python -E -Wd -m test [options] [test_name1 ...]
R. David Murray0ba81e02010-04-26 17:02:32 +000018
19
20Options:
Guido van Rossum152494a1996-12-20 03:12:20 +000021
Georg Brandl96f78972009-10-27 21:02:11 +000022-h/--help -- print this text and exit
Victor Stinner0cc8d592011-03-31 18:10:13 +020023--timeout TIMEOUT
24 -- dump the traceback and exit if a test takes more
Victor Stinnerd91a5ca2011-04-01 18:16:36 +020025 than TIMEOUT seconds (default: 30 minutes); disable
Victor Stinner305bff12011-04-01 15:59:59 +020026 the timeout if TIMEOUT is zero
Georg Brandl96f78972009-10-27 21:02:11 +000027
28Verbosity
29
30-v/--verbose -- run tests in verbose mode with output to stdout
31-w/--verbose2 -- re-run failed tests in verbose mode
32-W/--verbose3 -- re-run failed tests in verbose mode immediately
33-d/--debug -- print traceback for failed tests
R. David Murray0ba81e02010-04-26 17:02:32 +000034-q/--quiet -- no output unless one or more tests fail
Georg Brandl96f78972009-10-27 21:02:11 +000035-S/--slow -- print the slowest 10 tests
Antoine Pitrou3c4402f2011-01-03 20:38:52 +000036 --header -- print header with interpreter info
Georg Brandl96f78972009-10-27 21:02:11 +000037
38Selecting tests
39
R. David Murray0ba81e02010-04-26 17:02:32 +000040-r/--random -- randomize test execution order (see below)
Antoine Pitrou68530ac2011-01-03 20:40:07 +000041 --randseed -- pass a random seed to reproduce a previous random run
Georg Brandl96f78972009-10-27 21:02:11 +000042-f/--fromfile -- read names of tests to run from a file (see below)
43-x/--exclude -- arguments are tests to *exclude*
R. David Murray0ba81e02010-04-26 17:02:32 +000044-s/--single -- single step through a set of tests (see below)
Georg Brandl96f78972009-10-27 21:02:11 +000045-u/--use RES1,RES2,...
46 -- specify which special resource intensive tests to run
47-M/--memlimit LIMIT
48 -- run very large memory-consuming tests
R David Murrayb588f8d2011-03-24 14:42:58 -040049 --testdir DIR
50 -- execute test files in the specified directory (instead
51 of the Python stdlib test suite)
Georg Brandl96f78972009-10-27 21:02:11 +000052
53Special runs
54
55-l/--findleaks -- if GC is available detect tests that leak memory
56-L/--runleaks -- run the leaks(1) command just before exit
57-R/--huntrleaks RUNCOUNTS
58 -- search for reference leaks (needs debug build, v. slow)
59-j/--multiprocess PROCESSES
60 -- run PROCESSES processes at once
R. David Murray0ba81e02010-04-26 17:02:32 +000061-T/--coverage -- turn on code coverage tracing using the trace module
Georg Brandl96f78972009-10-27 21:02:11 +000062-D/--coverdir DIRECTORY
63 -- Directory where coverage files are put
64-N/--nocoverdir -- Put coverage files alongside modules
65-t/--threshold THRESHOLD
66 -- call gc.set_threshold(THRESHOLD)
67-n/--nowindows -- suppress error message boxes on Windows
R. David Murray0ba81e02010-04-26 17:02:32 +000068-F/--forever -- run the specified tests in a loop, until an error happens
Guido van Rossum152494a1996-12-20 03:12:20 +000069
R. David Murray0ba81e02010-04-26 17:02:32 +000070
71Additional Option Details:
Guido van Rossumf58ed251997-03-07 21:04:33 +000072
Collin Winterfd12f492009-03-29 04:05:05 +000073-r randomizes test execution order. You can use --randseed=int to provide a
74int seed value for the randomizer; this is useful for reproducing troublesome
75test orders.
76
R. David Murray0ba81e02010-04-26 17:02:32 +000077-s On the first invocation of regrtest using -s, the first test file found
78or the first test file given on the command line is run, and the name of
79the next test is recorded in a file named pynexttest. If run from the
80Python build directory, pynexttest is located in the 'build' subdirectory,
81otherwise it is located in tempfile.gettempdir(). On subsequent runs,
82the test in pynexttest is run, and the next test is written to pynexttest.
83When the last test has been run, pynexttest is deleted. In this way it
84is possible to single step through the test files. This is useful when
85doing memory analysis on the Python interpreter, which process tends to
86consume too many resources to run the full regression test non-stop.
Barry Warsawe11e3de1999-01-28 19:51:51 +000087
Neal Norwitz94fa2ee2008-03-31 02:55:15 +000088-S is used to continue running tests after an aborted run. It will
89maintain the order a standard run (ie, this assumes -r is not used).
90This is useful after the tests have prematurely stopped for some external
91reason and you want to start running from where you left off rather
92than starting from the beginning.
93
Guido van Rossum9e9d4f82002-06-07 15:17:03 +000094-f reads the names of tests from the file given as f's argument, one
95or more test names per line. Whitespace is ignored. Blank lines and
96lines beginning with '#' are ignored. This is especially useful for
97whittling down failures involving interactions among tests.
Tim Petersc5000df2002-06-02 21:42:01 +000098
Skip Montanaro0179a182004-06-06 15:53:18 +000099-L causes the leaks(1) command to be run just before exit if it exists.
100leaks(1) is available on Mac OS X and presumably on some other
101FreeBSD-derived systems.
102
Michael W. Hudson61147f62004-08-03 11:33:28 +0000103-R runs each test several times and examines sys.gettotalrefcount() to
104see if the test appears to be leaking references. The argument should
105be of the form stab:run:fname where 'stab' is the number of times the
106test is run to let gettotalrefcount settle down, 'run' is the number
107of times further it is run and 'fname' is the name of the file the
108reports are written to. These parameters all have defaults (5, 4 and
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000109"reflog.txt" respectively), and the minimal invocation is '-R :'.
Michael W. Hudson61147f62004-08-03 11:33:28 +0000110
Thomas Wouters477c8d52006-05-27 19:21:47 +0000111-M runs tests that require an exorbitant amount of memory. These tests
112typically try to ascertain containers keep working when containing more than
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001132 billion objects, which only works on 64-bit systems. There are also some
114tests that try to exhaust the address space of the process, which only makes
115sense on 32-bit systems with at least 2Gb of memory. The passed-in memlimit,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000116which is a string in the form of '2.5Gb', determines howmuch memory the
117tests will limit themselves to (but they may go slightly over.) The number
118shouldn't be more memory than the machine has (including swap memory). You
119should also keep in mind that swap memory is generally much, much slower
120than RAM, and setting memlimit to all available RAM or higher will heavily
121tax the machine. On the other hand, it is no use running these tests with a
122limit of less than 2.5Gb, and many require more than 20Gb. Tests that expect
123to use more than memlimit memory will be skipped. The big-memory tests
124generally run very, very long.
125
Guido van Rossum9e9d4f82002-06-07 15:17:03 +0000126-u is used to specify which special resource intensive tests to run,
127such as those requiring large file support or network connectivity.
128The argument is a comma-separated list of words indicating the
129resources to test. Currently only the following are defined:
Barry Warsaw08fca522001-08-20 22:33:46 +0000130
Fred Drake3a15dac2002-04-11 16:39:16 +0000131 all - Enable all special resources.
132
Guido van Rossum315aa362003-03-11 14:46:48 +0000133 audio - Tests that use the audio device. (There are known
134 cases of broken audio drivers that can crash Python or
135 even the Linux kernel.)
136
Andrew M. Kuchling2158df02001-10-22 15:26:09 +0000137 curses - Tests that use curses and will modify the terminal's
138 state and output modes.
Tim Peters1633a2e2001-10-30 05:56:40 +0000139
Guido van Rossum9e9d4f82002-06-07 15:17:03 +0000140 largefile - It is okay to run some test that may create huge
141 files. These tests can take a long time and may
142 consume >2GB of disk space temporarily.
Barry Warsaw08fca522001-08-20 22:33:46 +0000143
Guido van Rossum9e9d4f82002-06-07 15:17:03 +0000144 network - It is okay to run tests that use external network
145 resource, e.g. testing SSL support for sockets.
Martin v. Löwis1c6b1a22002-11-19 17:47:07 +0000146
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000147 decimal - Test the decimal module against a large suite that
148 verifies compliance with standards.
149
Antoine Pitrou5bc4fa72010-10-14 15:34:31 +0000150 cpu - Used for certain CPU-heavy tests.
Jeremy Hylton4336eda2004-08-07 19:25:33 +0000151
Tim Peterseba28be2005-03-28 01:08:02 +0000152 subprocess Run all tests for the subprocess module.
Peter Astrandf7f1bb72005-03-03 20:47:37 +0000153
Hye-Shik Changaaa2f1d2005-12-10 17:44:27 +0000154 urlfetch - It is okay to download files required on testing.
155
Guilherme Polo9de29af2009-01-28 20:40:48 +0000156 gui - Run tests that require a running GUI.
157
Fred Drake4dd0f7e2002-11-26 21:44:56 +0000158To enable all resources except one, use '-uall,-<resource>'. For
Georg Brandl1158a332009-06-04 09:30:30 +0000159example, to run all the tests except for the gui tests, give the
160option '-uall,-gui'.
Guido van Rossum152494a1996-12-20 03:12:20 +0000161"""
162
Brett Cannon45071902010-06-14 22:22:54 +0000163import builtins
Victor Stinner024e37a2011-03-31 01:31:06 +0200164import faulthandler
Guido van Rossum152494a1996-12-20 03:12:20 +0000165import getopt
Antoine Pitrou88909542009-06-29 13:54:42 +0000166import json
Christian Heimesb186d002008-03-18 15:15:01 +0000167import os
Skip Montanaroab1c7912000-06-30 16:39:27 +0000168import random
Thomas Wouters9ada3d62006-04-21 09:47:09 +0000169import re
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000170import io
Christian Heimesb186d002008-03-18 15:15:01 +0000171import sys
172import time
Antoine Pitrouee429342011-04-16 18:53:59 +0200173import errno
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000174import traceback
Christian Heimesb186d002008-03-18 15:15:01 +0000175import warnings
Benjamin Petersone549ead2009-03-28 21:42:05 +0000176import unittest
Christian Heimesbe5b30b2008-03-03 19:18:51 +0000177from inspect import isabstract
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000178import tempfile
Florent Xiclunada7bfd52010-03-06 11:43:55 +0000179import platform
180import sysconfig
Nick Coghlan7d819752010-12-05 06:45:03 +0000181import logging
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000182
Florent Xicluna64fb18e2010-03-06 14:43:34 +0000183
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000184# Some times __path__ and __file__ are not absolute (e.g. while running from
185# Lib/) and, if we change the CWD to run the tests in a temporary dir, some
186# imports might fail. This affects only the modules imported before os.chdir().
187# These modules are searched first in sys.path[0] (so '' -- the CWD) and if
188# they are found in the CWD their __file__ and __path__ will be relative (this
189# happens before the chdir). All the modules imported after the chdir, are
190# not found in the CWD, and since the other paths in sys.path[1:] are absolute
191# (site.py absolutize them), the __file__ and __path__ will be absolute too.
192# Therefore it is necessary to absolutize manually the __file__ and __path__ of
193# the packages to prevent later imports to fail when the CWD is different.
194for module in sys.modules.values():
195 if hasattr(module, '__path__'):
196 module.__path__ = [os.path.abspath(path) for path in module.__path__]
197 if hasattr(module, '__file__'):
198 module.__file__ = os.path.abspath(module.__file__)
199
Guido van Rossumdc15c272002-08-12 21:55:51 +0000200
Guido van Rossumbb484652002-12-02 09:56:21 +0000201# MacOSX (a.k.a. Darwin) has a default stack size that is too small
202# for deeply recursive regular expressions. We see this as crashes in
203# the Python test suite when running test_re.py and test_sre.py. The
204# fix is to set the stack limit to 2048.
205# This approach may also be useful for other Unixy platforms that
206# suffer from small default stack limits.
207if sys.platform == 'darwin':
208 try:
209 import resource
210 except ImportError:
211 pass
212 else:
213 soft, hard = resource.getrlimit(resource.RLIMIT_STACK)
214 newsoft = min(hard, max(soft, 1024*2048))
215 resource.setrlimit(resource.RLIMIT_STACK, (newsoft, hard))
216
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000217# Test result constants.
218PASSED = 1
219FAILED = 0
220ENV_CHANGED = -1
221SKIPPED = -2
222RESOURCE_DENIED = -3
223INTERRUPTED = -4
Victor Stinner4b739882011-03-31 18:02:36 +0200224CHILD_ERROR = -5 # error in a child process
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000225
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000226from test import support
Fred Drake3a15dac2002-04-11 16:39:16 +0000227
Georg Brandl1158a332009-06-04 09:30:30 +0000228RESOURCE_NAMES = ('audio', 'curses', 'largefile', 'network',
Antoine Pitrou5bc4fa72010-10-14 15:34:31 +0000229 'decimal', 'cpu', 'subprocess', 'urlfetch', 'gui')
Fred Drake3a15dac2002-04-11 16:39:16 +0000230
Florent Xiclunaec882212010-08-09 16:56:43 +0000231TEMPDIR = os.path.abspath(tempfile.gettempdir())
Fred Drake3a15dac2002-04-11 16:39:16 +0000232
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000233def usage(msg):
234 print(msg, file=sys.stderr)
235 print("Use --help for usage", file=sys.stderr)
236 sys.exit(2)
Barry Warsaw08fca522001-08-20 22:33:46 +0000237
238
Antoine Pitrou88909542009-06-29 13:54:42 +0000239def main(tests=None, testdir=None, verbose=0, quiet=False,
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000240 exclude=False, single=False, randomize=False, fromfile=None,
Walter Dörwaldaee4da62004-11-12 18:51:27 +0000241 findleaks=False, use_resources=None, trace=False, coverdir='coverage',
Collin Winterfd12f492009-03-29 04:05:05 +0000242 runleaks=False, huntrleaks=False, verbose2=False, print_slow=False,
Antoine Pitrou3c4402f2011-01-03 20:38:52 +0000243 random_seed=None, use_mp=None, verbose3=False, forever=False,
Victor Stinner9bf133c2011-04-13 01:06:27 +0200244 header=False):
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000245 """Execute a test suite.
246
Thomas Wouters7e474022000-07-16 12:04:32 +0000247 This also parses command-line options and modifies its behavior
Fred Drake004d5e62000-10-23 17:22:08 +0000248 accordingly.
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000249
250 tests -- a list of strings containing test names (optional)
251 testdir -- the directory in which to look for tests (optional)
252
253 Users other than the Python test suite will certainly want to
254 specify testdir; if it's omitted, the directory containing the
Fred Drake004d5e62000-10-23 17:22:08 +0000255 Python test suite is searched for.
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000256
257 If the tests argument is omitted, the tests listed on the
258 command-line will be used. If that's empty, too, then all *.py
259 files beginning with test_ will be used.
Skip Montanaroab1c7912000-06-30 16:39:27 +0000260
Antoine Pitrou88909542009-06-29 13:54:42 +0000261 The other default arguments (verbose, quiet, exclude,
Collin Winterfd12f492009-03-29 04:05:05 +0000262 single, randomize, findleaks, use_resources, trace, coverdir,
263 print_slow, and random_seed) allow programmers calling main()
264 directly to set the values that would normally be set by flags
265 on the command line.
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000266 """
Victor Stinner9bf133c2011-04-13 01:06:27 +0200267 if hasattr(faulthandler, 'dump_tracebacks_later'):
268 timeout = 60*60
269 else:
270 timeout = None
Fred Drake004d5e62000-10-23 17:22:08 +0000271
Victor Stinner1802d3f2010-05-19 17:11:19 +0000272 replace_stdout()
273
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000274 support.record_original_stdout(sys.stdout)
Guido van Rossum152494a1996-12-20 03:12:20 +0000275 try:
R. David Murray7dc72cc2009-11-14 16:13:02 +0000276 opts, args = getopt.getopt(sys.argv[1:], 'hvqxsSrf:lu:t:TD:NLR:FwWM:nj:',
Georg Brandl96f78972009-10-27 21:02:11 +0000277 ['help', 'verbose', 'verbose2', 'verbose3', 'quiet',
278 'exclude', 'single', 'slow', 'random', 'fromfile', 'findleaks',
279 'use=', 'threshold=', 'trace', 'coverdir=', 'nocoverdir',
R. David Murray7dc72cc2009-11-14 16:13:02 +0000280 'runleaks', 'huntrleaks=', 'memlimit=', 'randseed=',
Brett Cannon63eef1e2011-01-06 22:32:41 +0000281 'multiprocess=', 'coverage', 'slaveargs=', 'forever', 'debug',
Victor Stinner0cc8d592011-03-31 18:10:13 +0200282 'start=', 'nowindows', 'header', 'testdir=', 'timeout='])
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000283 except getopt.error as msg:
284 usage(msg)
Barry Warsaw08fca522001-08-20 22:33:46 +0000285
286 # Defaults
Collin Winterfd12f492009-03-29 04:05:05 +0000287 if random_seed is None:
288 random_seed = random.randrange(10000000)
Barry Warsaw08fca522001-08-20 22:33:46 +0000289 if use_resources is None:
290 use_resources = []
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000291 debug = False
292 start = None
Guido van Rossum152494a1996-12-20 03:12:20 +0000293 for o, a in opts:
Barry Warsaw08fca522001-08-20 22:33:46 +0000294 if o in ('-h', '--help'):
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000295 print(__doc__)
296 return
Barry Warsaw08fca522001-08-20 22:33:46 +0000297 elif o in ('-v', '--verbose'):
298 verbose += 1
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000299 elif o in ('-w', '--verbose2'):
300 verbose2 = True
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000301 elif o in ('-d', '--debug'):
302 debug = True
Georg Brandl96f78972009-10-27 21:02:11 +0000303 elif o in ('-W', '--verbose3'):
304 verbose3 = True
Barry Warsaw08fca522001-08-20 22:33:46 +0000305 elif o in ('-q', '--quiet'):
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000306 quiet = True;
Barry Warsaw08fca522001-08-20 22:33:46 +0000307 verbose = 0
Barry Warsaw08fca522001-08-20 22:33:46 +0000308 elif o in ('-x', '--exclude'):
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000309 exclude = True
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000310 elif o in ('-S', '--start'):
311 start = a
Barry Warsaw08fca522001-08-20 22:33:46 +0000312 elif o in ('-s', '--single'):
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000313 single = True
Christian Heimesb186d002008-03-18 15:15:01 +0000314 elif o in ('-S', '--slow'):
315 print_slow = True
Barry Warsaw08fca522001-08-20 22:33:46 +0000316 elif o in ('-r', '--randomize'):
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000317 randomize = True
Collin Winterfd12f492009-03-29 04:05:05 +0000318 elif o == '--randseed':
319 random_seed = int(a)
Tim Petersc5000df2002-06-02 21:42:01 +0000320 elif o in ('-f', '--fromfile'):
321 fromfile = a
Barry Warsaw08fca522001-08-20 22:33:46 +0000322 elif o in ('-l', '--findleaks'):
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000323 findleaks = True
Skip Montanaro0179a182004-06-06 15:53:18 +0000324 elif o in ('-L', '--runleaks'):
325 runleaks = True
Guido van Rossum9e9d4f82002-06-07 15:17:03 +0000326 elif o in ('-t', '--threshold'):
327 import gc
328 gc.set_threshold(int(a))
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000329 elif o in ('-T', '--coverage'):
330 trace = True
Walter Dörwaldaee4da62004-11-12 18:51:27 +0000331 elif o in ('-D', '--coverdir'):
R David Murray03504fc2011-03-24 14:35:30 -0400332 # CWD is replaced with a temporary dir before calling main(), so we
333 # need join it with the saved CWD so it goes where the user expects.
334 coverdir = os.path.join(support.SAVEDCWD, a)
Walter Dörwaldaee4da62004-11-12 18:51:27 +0000335 elif o in ('-N', '--nocoverdir'):
336 coverdir = None
Michael W. Hudson61147f62004-08-03 11:33:28 +0000337 elif o in ('-R', '--huntrleaks'):
338 huntrleaks = a.split(':')
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000339 if len(huntrleaks) not in (2, 3):
340 print(a, huntrleaks)
341 usage('-R takes 2 or 3 colon-separated arguments')
342 if not huntrleaks[0]:
Michael W. Hudson61147f62004-08-03 11:33:28 +0000343 huntrleaks[0] = 5
344 else:
345 huntrleaks[0] = int(huntrleaks[0])
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000346 if not huntrleaks[1]:
Michael W. Hudson61147f62004-08-03 11:33:28 +0000347 huntrleaks[1] = 4
348 else:
349 huntrleaks[1] = int(huntrleaks[1])
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000350 if len(huntrleaks) == 2 or not huntrleaks[2]:
351 huntrleaks[2:] = ["reflog.txt"]
352 # Avoid false positives due to the character cache in
353 # stringobject.c filling slowly with random data
354 warm_char_cache()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000355 elif o in ('-M', '--memlimit'):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000356 support.set_memlimit(a)
Barry Warsaw08fca522001-08-20 22:33:46 +0000357 elif o in ('-u', '--use'):
Guido van Rossumfe3f6962001-09-06 16:09:41 +0000358 u = [x.lower() for x in a.split(',')]
359 for r in u:
Fred Drake3a15dac2002-04-11 16:39:16 +0000360 if r == 'all':
Fred Drake4dd0f7e2002-11-26 21:44:56 +0000361 use_resources[:] = RESOURCE_NAMES
362 continue
363 remove = False
364 if r[0] == '-':
365 remove = True
366 r = r[1:]
Fred Drake3a15dac2002-04-11 16:39:16 +0000367 if r not in RESOURCE_NAMES:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000368 usage('Invalid -u/--use option: ' + a)
Fred Drake4dd0f7e2002-11-26 21:44:56 +0000369 if remove:
370 if r in use_resources:
371 use_resources.remove(r)
372 elif r not in use_resources:
Andrew MacIntyree41abab2002-04-30 12:11:04 +0000373 use_resources.append(r)
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000374 elif o in ('-n', '--nowindows'):
375 import msvcrt
376 msvcrt.SetErrorMode(msvcrt.SEM_FAILCRITICALERRORS|
377 msvcrt.SEM_NOALIGNMENTFAULTEXCEPT|
378 msvcrt.SEM_NOGPFAULTERRORBOX|
379 msvcrt.SEM_NOOPENFILEERRORBOX)
380 try:
381 msvcrt.CrtSetReportMode
382 except AttributeError:
383 # release build
384 pass
385 else:
386 for m in [msvcrt.CRT_WARN, msvcrt.CRT_ERROR, msvcrt.CRT_ASSERT]:
387 msvcrt.CrtSetReportMode(m, msvcrt.CRTDBG_MODE_FILE)
388 msvcrt.CrtSetReportFile(m, msvcrt.CRTDBG_FILE_STDERR)
R. David Murray7dc72cc2009-11-14 16:13:02 +0000389 elif o in ('-F', '--forever'):
390 forever = True
Antoine Pitrou88909542009-06-29 13:54:42 +0000391 elif o in ('-j', '--multiprocess'):
392 use_mp = int(a)
Antoine Pitrou6ab79d92011-03-23 20:17:45 +0100393 if use_mp <= 0:
394 try:
395 import multiprocessing
396 # Use all cores + extras for tests that like to sleep
397 use_mp = 2 + multiprocessing.cpu_count()
398 except (ImportError, NotImplementedError):
399 use_mp = 3
Antoine Pitrou3c4402f2011-01-03 20:38:52 +0000400 elif o == '--header':
401 header = True
Antoine Pitrou88909542009-06-29 13:54:42 +0000402 elif o == '--slaveargs':
403 args, kwargs = json.loads(a)
404 try:
405 result = runtest(*args, **kwargs)
406 except BaseException as e:
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000407 result = INTERRUPTED, e.__class__.__name__
Antoine Pitrou88909542009-06-29 13:54:42 +0000408 sys.stdout.flush()
409 print() # Force a newline (just in case)
410 print(json.dumps(result))
411 sys.exit(0)
R David Murrayb588f8d2011-03-24 14:42:58 -0400412 elif o == '--testdir':
413 # CWD is replaced with a temporary dir before calling main(), so we
414 # join it with the saved CWD so it ends up where the user expects.
415 testdir = os.path.join(support.SAVEDCWD, a)
Victor Stinner0cc8d592011-03-31 18:10:13 +0200416 elif o == '--timeout':
Victor Stinner9bf133c2011-04-13 01:06:27 +0200417 if not hasattr(faulthandler, 'dump_tracebacks_later'):
418 print("--timeout option requires "
419 "faulthandler.dump_tracebacks_later", file=sys.stderr)
420 sys.exit(1)
Victor Stinner0cc8d592011-03-31 18:10:13 +0200421 timeout = float(a)
R. David Murray35768ad2009-11-15 00:23:21 +0000422 else:
423 print(("No handler for option {}. Please report this as a bug "
Georg Brandldee7b852010-08-02 18:59:52 +0000424 "at http://bugs.python.org.").format(o), file=sys.stderr)
R. David Murray35768ad2009-11-15 00:23:21 +0000425 sys.exit(1)
Tim Petersc5000df2002-06-02 21:42:01 +0000426 if single and fromfile:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000427 usage("-s and -f don't go together!")
Antoine Pitrou88909542009-06-29 13:54:42 +0000428 if use_mp and trace:
Florent Xicluna64fb18e2010-03-06 14:43:34 +0000429 usage("-T and -j don't go together!")
Antoine Pitrou88909542009-06-29 13:54:42 +0000430 if use_mp and findleaks:
Florent Xicluna64fb18e2010-03-06 14:43:34 +0000431 usage("-l and -j don't go together!")
Barry Warsaw08fca522001-08-20 22:33:46 +0000432
Guido van Rossum152494a1996-12-20 03:12:20 +0000433 good = []
434 bad = []
435 skipped = []
Fred Drake9a0db072003-02-03 15:19:30 +0000436 resource_denieds = []
Nick Coghlan6ead5522009-10-18 13:19:33 +0000437 environment_changed = []
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000438 interrupted = False
Barry Warsawe11e3de1999-01-28 19:51:51 +0000439
Neil Schemenauerd569f232000-09-22 15:29:28 +0000440 if findleaks:
Barry Warsawa873b032000-08-03 15:50:37 +0000441 try:
442 import gc
443 except ImportError:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000444 print('No GC available, disabling findleaks.')
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000445 findleaks = False
Barry Warsawa873b032000-08-03 15:50:37 +0000446 else:
Neil Schemenauer8a00abc2000-10-13 01:32:42 +0000447 # Uncomment the line below to report garbage that is not
448 # freeable by reference counting alone. By default only
449 # garbage that is not collectable by the GC is reported.
450 #gc.set_debug(gc.DEBUG_SAVEALL)
Neil Schemenauerd569f232000-09-22 15:29:28 +0000451 found_garbage = []
Barry Warsawa873b032000-08-03 15:50:37 +0000452
Barry Warsawe11e3de1999-01-28 19:51:51 +0000453 if single:
Florent Xiclunaec882212010-08-09 16:56:43 +0000454 filename = os.path.join(TEMPDIR, 'pynexttest')
Barry Warsawe11e3de1999-01-28 19:51:51 +0000455 try:
456 fp = open(filename, 'r')
R. David Murray7dc72cc2009-11-14 16:13:02 +0000457 next_test = fp.read().strip()
458 tests = [next_test]
Barry Warsawe11e3de1999-01-28 19:51:51 +0000459 fp.close()
460 except IOError:
461 pass
Tim Petersc5000df2002-06-02 21:42:01 +0000462
463 if fromfile:
464 tests = []
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000465 fp = open(os.path.join(support.SAVEDCWD, fromfile))
Antoine Pitroud95c7b52010-11-07 20:50:51 +0000466 count_pat = re.compile(r'\[\s*\d+/\s*\d+\]')
Tim Petersc5000df2002-06-02 21:42:01 +0000467 for line in fp:
Antoine Pitroud95c7b52010-11-07 20:50:51 +0000468 line = count_pat.sub('', line)
Tim Petersc5000df2002-06-02 21:42:01 +0000469 guts = line.split() # assuming no test has whitespace in its name
470 if guts and not guts[0].startswith('#'):
471 tests.extend(guts)
472 fp.close()
473
474 # Strip .py extensions.
Florent Xiclunada7bfd52010-03-06 11:43:55 +0000475 removepy(args)
476 removepy(tests)
Tim Petersc5000df2002-06-02 21:42:01 +0000477
Guido van Rossum6c74fea1998-08-25 12:29:08 +0000478 stdtests = STDTESTS[:]
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000479 nottests = NOTTESTS.copy()
Guido van Rossum152494a1996-12-20 03:12:20 +0000480 if exclude:
Guido van Rossum6c74fea1998-08-25 12:29:08 +0000481 for arg in args:
482 if arg in stdtests:
483 stdtests.remove(arg)
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000484 nottests.add(arg)
Guido van Rossum41360a41998-03-26 19:42:58 +0000485 args = []
Florent Xicluna0e62a142010-03-06 17:34:48 +0000486
487 # For a partial run, we do not need to clutter the output.
Antoine Pitrou3c4402f2011-01-03 20:38:52 +0000488 if verbose or header or not (quiet or single or tests or args):
Florent Xicluna0e62a142010-03-06 17:34:48 +0000489 # Print basic platform information
490 print("==", platform.python_implementation(), *sys.version.split())
Florent Xiclunaec882212010-08-09 16:56:43 +0000491 print("== ", platform.platform(aliased=True),
492 "%s-endian" % sys.byteorder)
Florent Xicluna0e62a142010-03-06 17:34:48 +0000493 print("== ", os.getcwd())
Antoine Pitrou3c4402f2011-01-03 20:38:52 +0000494 print("Testing with flags:", sys.flags)
Florent Xicluna0e62a142010-03-06 17:34:48 +0000495
R David Murrayb588f8d2011-03-24 14:42:58 -0400496 # if testdir is set, then we are not running the python tests suite, so
497 # don't add default tests to be executed or skipped (pass empty values)
498 if testdir:
499 alltests = findtests(testdir, list(), set())
500 else:
501 alltests = findtests(testdir, stdtests, nottests)
502
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000503 selected = tests or args or alltests
Barry Warsawe11e3de1999-01-28 19:51:51 +0000504 if single:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000505 selected = selected[:1]
R. David Murrayef1992b2009-12-16 15:19:27 +0000506 try:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000507 next_single_test = alltests[alltests.index(selected[0])+1]
R. David Murrayef1992b2009-12-16 15:19:27 +0000508 except IndexError:
509 next_single_test = None
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000510 # Remove all the tests that precede start if it's set.
511 if start:
512 try:
513 del tests[:tests.index(start)]
514 except ValueError:
515 print("Couldn't find starting test (%s), using all tests" % start)
Skip Montanaroab1c7912000-06-30 16:39:27 +0000516 if randomize:
Collin Winterfd12f492009-03-29 04:05:05 +0000517 random.seed(random_seed)
518 print("Using random seed", random_seed)
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000519 random.shuffle(selected)
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000520 if trace:
Georg Brandl33c28812009-04-01 23:07:29 +0000521 import trace, tempfile
522 tracer = trace.Trace(ignoredirs=[sys.prefix, sys.exec_prefix,
523 tempfile.gettempdir()],
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000524 trace=False, count=True)
R. David Murray7dc72cc2009-11-14 16:13:02 +0000525
Christian Heimesb186d002008-03-18 15:15:01 +0000526 test_times = []
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000527 support.verbose = verbose # Tell tests to be moderately quiet
528 support.use_resources = use_resources
Guido van Rossum5796d262000-04-21 21:35:06 +0000529 save_modules = sys.modules.keys()
Antoine Pitrou88909542009-06-29 13:54:42 +0000530
531 def accumulate_result(test, result):
532 ok, test_time = result
533 test_times.append((test_time, test))
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000534 if ok == PASSED:
Antoine Pitrou88909542009-06-29 13:54:42 +0000535 good.append(test)
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000536 elif ok == FAILED:
Antoine Pitrou88909542009-06-29 13:54:42 +0000537 bad.append(test)
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000538 elif ok == ENV_CHANGED:
539 bad.append(test)
540 environment_changed.append(test)
541 elif ok == SKIPPED:
Antoine Pitrou88909542009-06-29 13:54:42 +0000542 skipped.append(test)
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000543 elif ok == RESOURCE_DENIED:
544 skipped.append(test)
545 resource_denieds.append(test)
Antoine Pitrou88909542009-06-29 13:54:42 +0000546
R. David Murray7dc72cc2009-11-14 16:13:02 +0000547 if forever:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000548 def test_forever(tests=list(selected)):
R. David Murray7dc72cc2009-11-14 16:13:02 +0000549 while True:
550 for test in tests:
551 yield test
552 if bad:
553 return
554 tests = test_forever()
Georg Brandle8e02e32010-08-03 07:56:50 +0000555 test_count = ''
556 test_count_width = 3
R. David Murray7dc72cc2009-11-14 16:13:02 +0000557 else:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000558 tests = iter(selected)
Georg Brandle8e02e32010-08-03 07:56:50 +0000559 test_count = '/{}'.format(len(selected))
560 test_count_width = len(test_count) - 1
R. David Murray7dc72cc2009-11-14 16:13:02 +0000561
Antoine Pitrou88909542009-06-29 13:54:42 +0000562 if use_mp:
Victor Stinner45df8202010-04-28 22:31:17 +0000563 try:
564 from threading import Thread
565 except ImportError:
566 print("Multiprocess option requires thread support")
567 sys.exit(2)
Georg Brandl1b37e872010-03-14 10:45:50 +0000568 from queue import Queue
569 from subprocess import Popen, PIPE
Antoine Pitrou88909542009-06-29 13:54:42 +0000570 debug_output_pat = re.compile(r"\[\d+ refs\]$")
Antoine Pitrou88909542009-06-29 13:54:42 +0000571 output = Queue()
R. David Murray7dc72cc2009-11-14 16:13:02 +0000572 def tests_and_args():
573 for test in tests:
574 args_tuple = (
R. David Murray8e286c42010-12-27 20:09:32 +0000575 (test, verbose, quiet),
R. David Murray7dc72cc2009-11-14 16:13:02 +0000576 dict(huntrleaks=huntrleaks, use_resources=use_resources,
Victor Stinner0cc8d592011-03-31 18:10:13 +0200577 debug=debug, rerun_failed=verbose3, timeout=timeout)
R. David Murray7dc72cc2009-11-14 16:13:02 +0000578 )
579 yield (test, args_tuple)
580 pending = tests_and_args()
Antoine Pitrou1b03f2c2010-10-14 11:12:00 +0000581 opt_args = support.args_from_interpreter_flags()
582 base_cmd = [sys.executable] + opt_args + ['-m', 'test.regrtest']
Antoine Pitrou88909542009-06-29 13:54:42 +0000583 def work():
584 # A worker thread.
Neal Norwitz14ca3272006-02-28 18:05:43 +0000585 try:
Antoine Pitrou88909542009-06-29 13:54:42 +0000586 while True:
587 try:
R. David Murray7dc72cc2009-11-14 16:13:02 +0000588 test, args_tuple = next(pending)
589 except StopIteration:
R. David Murray27144602009-10-19 15:26:16 +0000590 output.put((None, None, None, None))
Antoine Pitrou88909542009-06-29 13:54:42 +0000591 return
Antoine Pitrou88909542009-06-29 13:54:42 +0000592 # -E is needed by some tests, e.g. test_import
Antoine Pitrou1b03f2c2010-10-14 11:12:00 +0000593 popen = Popen(base_cmd + ['--slaveargs', json.dumps(args_tuple)],
R. David Murray27144602009-10-19 15:26:16 +0000594 stdout=PIPE, stderr=PIPE,
Antoine Pitrou36e778e2010-08-18 20:44:14 +0000595 universal_newlines=True,
596 close_fds=(os.name != 'nt'))
R. David Murray27144602009-10-19 15:26:16 +0000597 stdout, stderr = popen.communicate()
Victor Stinner4b739882011-03-31 18:02:36 +0200598 retcode = popen.wait()
R. David Murray27144602009-10-19 15:26:16 +0000599 # Strip last refcount output line if it exists, since it
600 # comes from the shutdown of the interpreter in the subcommand.
601 stderr = debug_output_pat.sub("", stderr)
602 stdout, _, result = stdout.strip().rpartition("\n")
Victor Stinner4b739882011-03-31 18:02:36 +0200603 if retcode != 0:
604 result = (CHILD_ERROR, "Exit code %s" % retcode)
605 output.put((test, stdout.rstrip(), stderr.rstrip(), result))
606 return
R. David Murray7dc72cc2009-11-14 16:13:02 +0000607 if not result:
608 output.put((None, None, None, None))
609 return
Antoine Pitrou88909542009-06-29 13:54:42 +0000610 result = json.loads(result)
R. David Murray27144602009-10-19 15:26:16 +0000611 output.put((test, stdout.rstrip(), stderr.rstrip(), result))
Antoine Pitrou88909542009-06-29 13:54:42 +0000612 except BaseException:
R. David Murray27144602009-10-19 15:26:16 +0000613 output.put((None, None, None, None))
Neal Norwitz14ca3272006-02-28 18:05:43 +0000614 raise
Antoine Pitrou88909542009-06-29 13:54:42 +0000615 workers = [Thread(target=work) for i in range(use_mp)]
616 for worker in workers:
617 worker.start()
618 finished = 0
Georg Brandldee7b852010-08-02 18:59:52 +0000619 test_index = 1
R. David Murray7dc72cc2009-11-14 16:13:02 +0000620 try:
621 while finished < use_mp:
622 test, stdout, stderr, result = output.get()
623 if test is None:
624 finished += 1
625 continue
Georg Brandldee7b852010-08-02 18:59:52 +0000626 if not quiet:
Georg Brandle8e02e32010-08-03 07:56:50 +0000627 print("[{1:{0}}{2}] {3}".format(
Georg Brandldee7b852010-08-02 18:59:52 +0000628 test_count_width, test_index, test_count, test))
R. David Murray7dc72cc2009-11-14 16:13:02 +0000629 if stdout:
630 print(stdout)
631 if stderr:
632 print(stderr, file=sys.stderr)
633 if result[0] == INTERRUPTED:
634 assert result[1] == 'KeyboardInterrupt'
635 raise KeyboardInterrupt # What else?
Victor Stinner4b739882011-03-31 18:02:36 +0200636 if result[0] == CHILD_ERROR:
Victor Stinner0cc8d592011-03-31 18:10:13 +0200637 raise Exception("Child error: {}".format(result[1]))
R. David Murray7dc72cc2009-11-14 16:13:02 +0000638 accumulate_result(test, result)
Georg Brandldee7b852010-08-02 18:59:52 +0000639 test_index += 1
R. David Murray7dc72cc2009-11-14 16:13:02 +0000640 except KeyboardInterrupt:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000641 interrupted = True
R. David Murray7dc72cc2009-11-14 16:13:02 +0000642 pending.close()
Antoine Pitrou88909542009-06-29 13:54:42 +0000643 for worker in workers:
644 worker.join()
645 else:
Georg Brandldee7b852010-08-02 18:59:52 +0000646 for test_index, test in enumerate(tests, 1):
Antoine Pitrou88909542009-06-29 13:54:42 +0000647 if not quiet:
Georg Brandle8e02e32010-08-03 07:56:50 +0000648 print("[{1:{0}}{2}] {3}".format(
Georg Brandldee7b852010-08-02 18:59:52 +0000649 test_count_width, test_index, test_count, test))
Antoine Pitrou88909542009-06-29 13:54:42 +0000650 sys.stdout.flush()
651 if trace:
652 # If we're tracing code coverage, then we don't exit with status
653 # if on a false return value from main.
Victor Stinner0cc8d592011-03-31 18:10:13 +0200654 tracer.runctx('runtest(test, verbose, quiet, timeout=timeout)',
Antoine Pitrou88909542009-06-29 13:54:42 +0000655 globals=globals(), locals=vars())
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000656 else:
Antoine Pitrou88909542009-06-29 13:54:42 +0000657 try:
Antoine Pitrou293954d2011-03-23 23:01:49 +0100658 result = runtest(test, verbose, quiet, huntrleaks, debug,
Victor Stinner0cc8d592011-03-31 18:10:13 +0200659 rerun_failed=verbose3, timeout=timeout)
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000660 accumulate_result(test, result)
Antoine Pitrou88909542009-06-29 13:54:42 +0000661 except KeyboardInterrupt:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000662 interrupted = True
Antoine Pitrou88909542009-06-29 13:54:42 +0000663 break
664 except:
665 raise
666 if findleaks:
667 gc.collect()
668 if gc.garbage:
669 print("Warning: test created", len(gc.garbage), end=' ')
670 print("uncollectable object(s).")
671 # move the uncollectable objects somewhere so we don't see
672 # them again
673 found_garbage.extend(gc.garbage)
674 del gc.garbage[:]
675 # Unload the newly imported modules (best effort finalization)
676 for module in sys.modules.keys():
677 if module not in save_modules and module.startswith("test."):
678 support.unload(module)
Jeremy Hylton7a1ea0e2001-10-17 13:45:28 +0000679
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000680 if interrupted:
681 # print a newline after ^C
682 print()
683 print("Test suite interrupted by signal SIGINT.")
684 omitted = set(selected) - set(good) - set(bad) - set(skipped)
685 print(count(len(omitted), "test"), "omitted:")
686 printlist(omitted)
Guido van Rossum152494a1996-12-20 03:12:20 +0000687 if good and not quiet:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000688 if not bad and not skipped and not interrupted and len(good) > 1:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000689 print("All", end=' ')
690 print(count(len(good), "test"), "OK.")
Christian Heimesb186d002008-03-18 15:15:01 +0000691 if print_slow:
692 test_times.sort(reverse=True)
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000693 print("10 slowest tests:")
Christian Heimesb186d002008-03-18 15:15:01 +0000694 for time, test in test_times[:10]:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000695 print("%s: %.1fs" % (test, time))
Guido van Rossum152494a1996-12-20 03:12:20 +0000696 if bad:
Nick Coghlan6ead5522009-10-18 13:19:33 +0000697 bad = sorted(set(bad) - set(environment_changed))
698 if bad:
699 print(count(len(bad), "test"), "failed:")
700 printlist(bad)
701 if environment_changed:
702 print("{} altered the execution environment:".format(
703 count(len(environment_changed), "test")))
704 printlist(environment_changed)
Guido van Rossum152494a1996-12-20 03:12:20 +0000705 if skipped and not quiet:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000706 print(count(len(skipped), "test"), "skipped:")
Tim Petersa45da922001-08-12 03:45:50 +0000707 printlist(skipped)
Barry Warsawe11e3de1999-01-28 19:51:51 +0000708
Tim Petersb5b7b782001-08-12 01:20:39 +0000709 e = _ExpectedSkips()
Tim Petersa2be2d62001-08-12 02:01:09 +0000710 plat = sys.platform
Tim Petersb5b7b782001-08-12 01:20:39 +0000711 if e.isvalid():
Raymond Hettingera690a992003-11-16 16:17:49 +0000712 surprise = set(skipped) - e.getexpected() - set(resource_denieds)
Tim Petersb5b7b782001-08-12 01:20:39 +0000713 if surprise:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000714 print(count(len(surprise), "skip"), \
715 "unexpected on", plat + ":")
Tim Petersa45da922001-08-12 03:45:50 +0000716 printlist(surprise)
Tim Petersb5b7b782001-08-12 01:20:39 +0000717 else:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000718 print("Those skips are all expected on", plat + ".")
Tim Petersb5b7b782001-08-12 01:20:39 +0000719 else:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000720 print("Ask someone to teach regrtest.py about which tests are")
721 print("expected to get skipped on", plat + ".")
Tim Petersb5b7b782001-08-12 01:20:39 +0000722
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000723 if verbose2 and bad:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000724 print("Re-running failed tests in verbose mode")
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000725 for test in bad:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000726 print("Re-running test %r in verbose mode" % test)
Tim Peters922dd7d2006-03-10 23:37:10 +0000727 sys.stdout.flush()
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000728 try:
Antoine Pitrou88909542009-06-29 13:54:42 +0000729 verbose = True
Victor Stinner0cc8d592011-03-31 18:10:13 +0200730 ok = runtest(test, True, quiet, huntrleaks, debug, timeout=timeout)
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000731 except KeyboardInterrupt:
732 # print a newline separate from the ^C
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000733 print()
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000734 break
735 except:
736 raise
737
Barry Warsawe11e3de1999-01-28 19:51:51 +0000738 if single:
R. David Murrayef1992b2009-12-16 15:19:27 +0000739 if next_single_test:
740 with open(filename, 'w') as fp:
741 fp.write(next_single_test + '\n')
Barry Warsawe11e3de1999-01-28 19:51:51 +0000742 else:
743 os.unlink(filename)
744
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000745 if trace:
746 r = tracer.results()
747 r.write_results(show_missing=True, summary=True, coverdir=coverdir)
748
Skip Montanaro0179a182004-06-06 15:53:18 +0000749 if runleaks:
750 os.system("leaks %d" % os.getpid())
751
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000752 sys.exit(len(bad) > 0 or interrupted)
Barry Warsaw08fca522001-08-20 22:33:46 +0000753
Guido van Rossum152494a1996-12-20 03:12:20 +0000754
R David Murrayb588f8d2011-03-24 14:42:58 -0400755# small set of tests to determine if we have a basically functioning interpreter
756# (i.e. if any of these fail, then anything else is likely to follow)
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000757STDTESTS = [
Guido van Rossum152494a1996-12-20 03:12:20 +0000758 'test_grammar',
759 'test_opcodes',
Guido van Rossumd8faa362007-04-27 19:54:29 +0000760 'test_dict',
Guido van Rossum152494a1996-12-20 03:12:20 +0000761 'test_builtin',
762 'test_exceptions',
763 'test_types',
Collin Winter7afaa882007-03-08 19:54:43 +0000764 'test_unittest',
765 'test_doctest',
766 'test_doctest2',
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000767]
Guido van Rossum152494a1996-12-20 03:12:20 +0000768
R David Murrayb588f8d2011-03-24 14:42:58 -0400769# set of tests that we don't want to be executed when using regrtest
R David Murray57648302011-03-24 14:57:05 -0400770NOTTESTS = set()
Guido van Rossum152494a1996-12-20 03:12:20 +0000771
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000772def findtests(testdir=None, stdtests=STDTESTS, nottests=NOTTESTS):
Guido van Rossum152494a1996-12-20 03:12:20 +0000773 """Return a list of all applicable test modules."""
Florent Xiclunada7bfd52010-03-06 11:43:55 +0000774 testdir = findtestdir(testdir)
Guido van Rossum152494a1996-12-20 03:12:20 +0000775 names = os.listdir(testdir)
776 tests = []
Florent Xiclunada7bfd52010-03-06 11:43:55 +0000777 others = set(stdtests) | nottests
Guido van Rossum152494a1996-12-20 03:12:20 +0000778 for name in names:
R David Murray661720e2011-03-21 15:14:34 -0400779 mod, ext = os.path.splitext(name)
780 if mod[:5] == "test_" and ext in (".py", "") and mod not in others:
781 tests.append(mod)
Florent Xiclunada7bfd52010-03-06 11:43:55 +0000782 return stdtests + sorted(tests)
Guido van Rossum152494a1996-12-20 03:12:20 +0000783
Victor Stinnerf58087b2010-05-02 17:24:51 +0000784def replace_stdout():
785 """Set stdout encoder error handler to backslashreplace (as stderr error
786 handler) to avoid UnicodeEncodeError when printing a traceback"""
Victor Stinnera3032802010-05-07 00:57:12 +0000787 if os.name == "nt":
788 # Replace sys.stdout breaks the stdout newlines on Windows: issue #8533
789 return
Victor Stinner4b2b43d2011-01-05 03:54:26 +0000790
791 import atexit
792
Victor Stinnerf58087b2010-05-02 17:24:51 +0000793 stdout = sys.stdout
794 sys.stdout = open(stdout.fileno(), 'w',
795 encoding=stdout.encoding,
Victor Stinner4b2b43d2011-01-05 03:54:26 +0000796 errors="backslashreplace",
797 closefd=False)
798
799 def restore_stdout():
800 sys.stdout.close()
801 sys.stdout = stdout
802 atexit.register(restore_stdout)
Victor Stinnerf58087b2010-05-02 17:24:51 +0000803
Antoine Pitrou88909542009-06-29 13:54:42 +0000804def runtest(test, verbose, quiet,
Antoine Pitrou293954d2011-03-23 23:01:49 +0100805 huntrleaks=False, debug=False, use_resources=None,
Victor Stinner0cc8d592011-03-31 18:10:13 +0200806 rerun_failed=False, timeout=None):
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000807 """Run a single test.
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000808
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000809 test -- the name of the test
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000810 verbose -- if true, print more messages
Trent Mickf29f47b2000-08-11 19:02:59 +0000811 quiet -- if true, don't print 'skipped' messages (probably redundant)
Christian Heimesb186d002008-03-18 15:15:01 +0000812 test_times -- a list of (time, test_name) pairs
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000813 huntrleaks -- run multiple times to test for leaks; requires a debug
814 build; a triple corresponding to -R's three arguments
Antoine Pitrou293954d2011-03-23 23:01:49 +0100815 rerun_failed -- if true, re-run in verbose mode when failed
Victor Stinner0cc8d592011-03-31 18:10:13 +0200816 timeout -- dump the traceback and exit if a test takes more than
817 timeout seconds
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000818
819 Returns one of the test result constants:
820 INTERRUPTED KeyboardInterrupt when run under -j
821 RESOURCE_DENIED test skipped because resource denied
822 SKIPPED test skipped for some other reason
823 ENV_CHANGED test failed because it changed the execution environment
824 FAILED test failed
825 PASSED test passed
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000826 """
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000827
Antoine Pitrou88909542009-06-29 13:54:42 +0000828 support.verbose = verbose # Tell tests to be moderately quiet
829 if use_resources is not None:
830 support.use_resources = use_resources
Victor Stinner7d648a02011-03-31 18:27:50 +0200831 use_timeout = (timeout is not None and timeout > 0)
832 if use_timeout:
Victor Stinner0cc8d592011-03-31 18:10:13 +0200833 faulthandler.dump_tracebacks_later(timeout, exit=True)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000834 try:
Antoine Pitrou293954d2011-03-23 23:01:49 +0100835 result = runtest_inner(test, verbose, quiet, huntrleaks, debug)
836 if result[0] == FAILED and rerun_failed:
837 cleanup_test_droppings(test, verbose)
838 sys.stdout.flush()
839 sys.stderr.flush()
840 print("Re-running test {} in verbose mode".format(test))
Victor Stinner0cc8d592011-03-31 18:10:13 +0200841 runtest(test, True, quiet, huntrleaks, debug, timeout=timeout)
Antoine Pitrou293954d2011-03-23 23:01:49 +0100842 return result
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000843 finally:
Victor Stinner7d648a02011-03-31 18:27:50 +0200844 if use_timeout:
Victor Stinner0cc8d592011-03-31 18:10:13 +0200845 faulthandler.cancel_dump_tracebacks_later()
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000846 cleanup_test_droppings(test, verbose)
847
Nick Coghlan6ead5522009-10-18 13:19:33 +0000848# Unit tests are supposed to leave the execution environment unchanged
849# once they complete. But sometimes tests have bugs, especially when
850# tests fail, and the changes to environment go on to mess up other
851# tests. This can cause issues with buildbot stability, since tests
852# are run in random order and so problems may appear to come and go.
853# There are a few things we can save and restore to mitigate this, and
854# the following context manager handles this task.
855
856class saved_test_environment:
857 """Save bits of the test environment and restore them at block exit.
858
859 with saved_test_environment(testname, verbose, quiet):
860 #stuff
861
862 Unless quiet is True, a warning is printed to stderr if any of
863 the saved items was changed by the test. The attribute 'changed'
864 is initially False, but is set to True if a change is detected.
865
866 If verbose is more than 1, the before and after state of changed
867 items is also printed.
868 """
869
870 changed = False
871
872 def __init__(self, testname, verbose=0, quiet=False):
873 self.testname = testname
874 self.verbose = verbose
875 self.quiet = quiet
876
877 # To add things to save and restore, add a name XXX to the resources list
878 # and add corresponding get_XXX/restore_XXX functions. get_XXX should
879 # return the value to be saved and compared against a second call to the
880 # get function when test execution completes. restore_XXX should accept
881 # the saved value and restore the resource using it. It will be called if
882 # and only if a change in the value is detected.
883 #
884 # Note: XXX will have any '.' replaced with '_' characters when determining
885 # the corresponding method names.
886
887 resources = ('sys.argv', 'cwd', 'sys.stdin', 'sys.stdout', 'sys.stderr',
Brett Cannon29c0e4f2010-03-20 22:22:57 +0000888 'os.environ', 'sys.path', 'sys.path_hooks', '__import__',
Nick Coghlan7bd5dbe2010-12-05 07:17:25 +0000889 'warnings.filters', 'asyncore.socket_map',
Ezio Melotti45763d02011-03-20 15:34:28 +0200890 'logging._handlers', 'logging._handlerList', 'sys.gettrace',
Ezio Melotti0123e052011-03-20 15:09:26 +0200891 'sys.warnoptions')
Nick Coghlan6ead5522009-10-18 13:19:33 +0000892
893 def get_sys_argv(self):
894 return id(sys.argv), sys.argv, sys.argv[:]
895 def restore_sys_argv(self, saved_argv):
896 sys.argv = saved_argv[1]
897 sys.argv[:] = saved_argv[2]
898
899 def get_cwd(self):
900 return os.getcwd()
901 def restore_cwd(self, saved_cwd):
902 os.chdir(saved_cwd)
903
904 def get_sys_stdout(self):
905 return sys.stdout
906 def restore_sys_stdout(self, saved_stdout):
907 sys.stdout = saved_stdout
908
909 def get_sys_stderr(self):
910 return sys.stderr
911 def restore_sys_stderr(self, saved_stderr):
912 sys.stderr = saved_stderr
913
914 def get_sys_stdin(self):
915 return sys.stdin
916 def restore_sys_stdin(self, saved_stdin):
917 sys.stdin = saved_stdin
918
919 def get_os_environ(self):
920 return id(os.environ), os.environ, dict(os.environ)
921 def restore_os_environ(self, saved_environ):
922 os.environ = saved_environ[1]
923 os.environ.clear()
924 os.environ.update(saved_environ[2])
925
926 def get_sys_path(self):
927 return id(sys.path), sys.path, sys.path[:]
928 def restore_sys_path(self, saved_path):
929 sys.path = saved_path[1]
930 sys.path[:] = saved_path[2]
931
Brett Cannon055470a2010-02-19 15:57:10 +0000932 def get_sys_path_hooks(self):
933 return id(sys.path_hooks), sys.path_hooks, sys.path_hooks[:]
934 def restore_sys_path_hooks(self, saved_hooks):
935 sys.path_hooks = saved_hooks[1]
936 sys.path_hooks[:] = saved_hooks[2]
937
Brett Cannon31f59292011-02-21 19:29:56 +0000938 def get_sys_gettrace(self):
939 return sys.gettrace()
940 def restore_sys_gettrace(self, trace_fxn):
941 sys.settrace(trace_fxn)
942
Brett Cannon055470a2010-02-19 15:57:10 +0000943 def get___import__(self):
Brett Cannon45071902010-06-14 22:22:54 +0000944 return builtins.__import__
Brett Cannon055470a2010-02-19 15:57:10 +0000945 def restore___import__(self, import_):
Brett Cannon45071902010-06-14 22:22:54 +0000946 builtins.__import__ = import_
Brett Cannon055470a2010-02-19 15:57:10 +0000947
Brett Cannon29c0e4f2010-03-20 22:22:57 +0000948 def get_warnings_filters(self):
949 return id(warnings.filters), warnings.filters, warnings.filters[:]
950 def restore_warnings_filters(self, saved_filters):
951 warnings.filters = saved_filters[1]
952 warnings.filters[:] = saved_filters[2]
953
Antoine Pitroub14ac8c2010-08-16 00:28:05 +0000954 def get_asyncore_socket_map(self):
955 asyncore = sys.modules.get('asyncore')
Antoine Pitrouaa879652010-10-29 11:54:38 +0000956 # XXX Making a copy keeps objects alive until __exit__ gets called.
957 return asyncore and asyncore.socket_map.copy() or {}
Antoine Pitroub14ac8c2010-08-16 00:28:05 +0000958 def restore_asyncore_socket_map(self, saved_map):
959 asyncore = sys.modules.get('asyncore')
960 if asyncore is not None:
Antoine Pitrouaa879652010-10-29 11:54:38 +0000961 asyncore.close_all(ignore_all=True)
Antoine Pitroub14ac8c2010-08-16 00:28:05 +0000962 asyncore.socket_map.update(saved_map)
963
Nick Coghlan7d819752010-12-05 06:45:03 +0000964 def get_logging__handlers(self):
965 # _handlers is a WeakValueDictionary
Nick Coghlan7bd5dbe2010-12-05 07:17:25 +0000966 return id(logging._handlers), logging._handlers, logging._handlers.copy()
Nick Coghlan7d819752010-12-05 06:45:03 +0000967 def restore_logging__handlers(self, saved_handlers):
968 # Can't easily revert the logging state
969 pass
970
Nick Coghlan7bd5dbe2010-12-05 07:17:25 +0000971 def get_logging__handlerList(self):
972 # _handlerList is a list of weakrefs to handlers
973 return id(logging._handlerList), logging._handlerList, logging._handlerList[:]
974 def restore_logging__handlerList(self, saved_handlerList):
975 # Can't easily revert the logging state
976 pass
977
Ezio Melotti0123e052011-03-20 15:09:26 +0200978 def get_sys_warnoptions(self):
979 return id(sys.warnoptions), sys.warnoptions, sys.warnoptions[:]
980 def restore_sys_warnoptions(self, saved_options):
981 sys.warnoptions = saved_options[1]
982 sys.warnoptions[:] = saved_options[2]
983
Nick Coghlan6ead5522009-10-18 13:19:33 +0000984 def resource_info(self):
985 for name in self.resources:
986 method_suffix = name.replace('.', '_')
987 get_name = 'get_' + method_suffix
988 restore_name = 'restore_' + method_suffix
989 yield name, getattr(self, get_name), getattr(self, restore_name)
990
991 def __enter__(self):
992 self.saved_values = dict((name, get()) for name, get, restore
993 in self.resource_info())
994 return self
995
996 def __exit__(self, exc_type, exc_val, exc_tb):
Antoine Pitrouaa879652010-10-29 11:54:38 +0000997 saved_values = self.saved_values
998 del self.saved_values
Nick Coghlan6ead5522009-10-18 13:19:33 +0000999 for name, get, restore in self.resource_info():
1000 current = get()
Antoine Pitrouaa879652010-10-29 11:54:38 +00001001 original = saved_values.pop(name)
Nick Coghlan6ead5522009-10-18 13:19:33 +00001002 # Check for changes to the resource's value
1003 if current != original:
1004 self.changed = True
1005 restore(original)
1006 if not self.quiet:
1007 print("Warning -- {} was modified by {}".format(
1008 name, self.testname),
1009 file=sys.stderr)
1010 if self.verbose > 1:
1011 print(" Before: {}\n After: {} ".format(
1012 original, current),
1013 file=sys.stderr)
1014 return False
1015
1016
R. David Murray8e286c42010-12-27 20:09:32 +00001017def runtest_inner(test, verbose, quiet, huntrleaks=False, debug=False):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001018 support.unload(test)
Benjamin Petersonb48af542010-04-11 20:43:16 +00001019 if verbose:
1020 capture_stdout = None
1021 else:
1022 capture_stdout = io.StringIO()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001023
Antoine Pitrou88909542009-06-29 13:54:42 +00001024 test_time = 0.0
Collin Wintera5503d52009-05-15 01:20:21 +00001025 refleak = False # True if the test leaked references.
Guido van Rossum152494a1996-12-20 03:12:20 +00001026 try:
R. David Murray0bc11ae2009-10-18 22:18:17 +00001027 if test.startswith('test.'):
1028 abstest = test
1029 else:
1030 # Always import it from the test package
1031 abstest = 'test.' + test
1032 with saved_test_environment(test, verbose, quiet) as environment:
1033 start_time = time.time()
1034 the_package = __import__(abstest, globals(), locals(), [])
1035 the_module = getattr(the_package, test)
1036 # Old tests run to completion simply as a side-effect of
1037 # being imported. For tests based on unittest or doctest,
1038 # explicitly invoke their test_main() function (if it exists).
1039 indirect_test = getattr(the_module, "test_main", None)
1040 if indirect_test is not None:
1041 indirect_test()
1042 if huntrleaks:
1043 refleak = dash_R(the_module, test, indirect_test,
1044 huntrleaks)
1045 test_time = time.time() - start_time
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001046 except support.ResourceDenied as msg:
Fred Drake9a0db072003-02-03 15:19:30 +00001047 if not quiet:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001048 print(test, "skipped --", msg)
Fred Drake9a0db072003-02-03 15:19:30 +00001049 sys.stdout.flush()
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001050 return RESOURCE_DENIED, test_time
R. David Murraya21e4ca2009-03-31 23:16:50 +00001051 except unittest.SkipTest as msg:
Trent Mickf29f47b2000-08-11 19:02:59 +00001052 if not quiet:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001053 print(test, "skipped --", msg)
Guido van Rossum3cda93e2002-09-13 21:28:03 +00001054 sys.stdout.flush()
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001055 return SKIPPED, test_time
Fred Drakefe5c22a2000-08-18 16:04:05 +00001056 except KeyboardInterrupt:
1057 raise
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001058 except support.TestFailed as msg:
R. David Murray11cabcf2010-09-29 01:08:05 +00001059 print("test", test, "failed --", msg, file=sys.stderr)
1060 sys.stderr.flush()
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001061 return FAILED, test_time
Guido van Rossum9e48b271997-07-16 01:56:13 +00001062 except:
Antoine Pitrou779a5b02011-03-21 19:55:16 +01001063 msg = traceback.format_exc()
1064 print("test", test, "crashed --", msg, file=sys.stderr)
R. David Murray11cabcf2010-09-29 01:08:05 +00001065 sys.stderr.flush()
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001066 return FAILED, test_time
Guido van Rossum152494a1996-12-20 03:12:20 +00001067 else:
Collin Wintera5503d52009-05-15 01:20:21 +00001068 if refleak:
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001069 return FAILED, test_time
Nick Coghlan6ead5522009-10-18 13:19:33 +00001070 if environment.changed:
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001071 return ENV_CHANGED, test_time
1072 return PASSED, test_time
Guido van Rossum0fcca4e2001-09-21 20:31:52 +00001073
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001074def cleanup_test_droppings(testname, verbose):
1075 import shutil
Benjamin Peterson25c95f12009-05-08 20:42:26 +00001076 import stat
Antoine Pitrouc14efc42010-10-29 19:34:45 +00001077 import gc
1078
1079 # First kill any dangling references to open files etc.
1080 # This can also issue some ResourceWarnings which would otherwise get
Antoine Pitrou2b40efd2010-10-29 19:36:37 +00001081 # triggered during the following test run, and possibly produce failures.
Antoine Pitrouc14efc42010-10-29 19:34:45 +00001082 gc.collect()
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001083
1084 # Try to clean up junk commonly left behind. While tests shouldn't leave
1085 # any files or directories behind, when a test fails that can be tedious
1086 # for it to arrange. The consequences can be especially nasty on Windows,
1087 # since if a test leaves a file open, it cannot be deleted by name (while
1088 # there's nothing we can do about that here either, we can display the
1089 # name of the offending test, which is a real help).
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001090 for name in (support.TESTFN,
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001091 "db_home",
1092 ):
1093 if not os.path.exists(name):
1094 continue
1095
1096 if os.path.isdir(name):
1097 kind, nuker = "directory", shutil.rmtree
1098 elif os.path.isfile(name):
1099 kind, nuker = "file", os.unlink
1100 else:
1101 raise SystemError("os.path says %r exists but is neither "
1102 "directory nor file" % name)
1103
1104 if verbose:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001105 print("%r left behind %s %r" % (testname, kind, name))
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001106 try:
Benjamin Peterson25c95f12009-05-08 20:42:26 +00001107 # if we have chmod, fix possible permissions problems
1108 # that might prevent cleanup
1109 if (hasattr(os, 'chmod')):
1110 os.chmod(name, stat.S_IRWXU | stat.S_IRWXG | stat.S_IRWXO)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001111 nuker(name)
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001112 except Exception as msg:
1113 print(("%r left behind %s %r and it couldn't be "
1114 "removed: %s" % (testname, kind, name, msg)), file=sys.stderr)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001115
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001116def dash_R(the_module, test, indirect_test, huntrleaks):
Collin Wintera5503d52009-05-15 01:20:21 +00001117 """Run a test multiple times, looking for reference leaks.
1118
1119 Returns:
1120 False if the test didn't leak references; True if we detected refleaks.
1121 """
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001122 # This code is hackish and inelegant, but it seems to do the job.
Raymond Hettinger158c9c22011-02-22 00:41:50 +00001123 import copyreg
1124 import collections.abc
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001125
1126 if not hasattr(sys, 'gettotalrefcount'):
1127 raise Exception("Tracking reference leaks requires a debug build "
1128 "of Python")
1129
1130 # Save current values for dash_R_cleanup() to restore.
1131 fs = warnings.filters[:]
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +00001132 ps = copyreg.dispatch_table.copy()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001133 pic = sys.path_importer_cache.copy()
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001134 try:
1135 import zipimport
1136 except ImportError:
1137 zdc = None # Run unmodified on platforms without zipimport support
1138 else:
1139 zdc = zipimport._zip_directory_cache.copy()
Christian Heimes93852662007-12-01 12:22:32 +00001140 abcs = {}
Raymond Hettinger158c9c22011-02-22 00:41:50 +00001141 for abc in [getattr(collections.abc, a) for a in collections.abc.__all__]:
Christian Heimesbe5b30b2008-03-03 19:18:51 +00001142 if not isabstract(abc):
Christian Heimes93852662007-12-01 12:22:32 +00001143 continue
1144 for obj in abc.__subclasses__() + [abc]:
1145 abcs[obj] = obj._abc_registry.copy()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001146
1147 if indirect_test:
1148 def run_the_test():
1149 indirect_test()
1150 else:
1151 def run_the_test():
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001152 del sys.modules[the_module.__name__]
1153 exec('import ' + the_module.__name__)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001154
1155 deltas = []
1156 nwarmup, ntracked, fname = huntrleaks
Ezio Melotti184bdfb2010-02-18 09:37:05 +00001157 fname = os.path.join(support.SAVEDCWD, fname)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001158 repcount = nwarmup + ntracked
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001159 print("beginning", repcount, "repetitions", file=sys.stderr)
1160 print(("1234567890"*(repcount//10 + 1))[:repcount], file=sys.stderr)
Antoine Pitrou88909542009-06-29 13:54:42 +00001161 sys.stderr.flush()
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001162 dash_R_cleanup(fs, ps, pic, zdc, abcs)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001163 for i in range(repcount):
Collin Winter58bee592010-03-17 02:08:57 +00001164 rc_before = sys.gettotalrefcount()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001165 run_the_test()
1166 sys.stderr.write('.')
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001167 sys.stderr.flush()
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001168 dash_R_cleanup(fs, ps, pic, zdc, abcs)
Collin Winter58bee592010-03-17 02:08:57 +00001169 rc_after = sys.gettotalrefcount()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001170 if i >= nwarmup:
Collin Winter58bee592010-03-17 02:08:57 +00001171 deltas.append(rc_after - rc_before)
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001172 print(file=sys.stderr)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001173 if any(deltas):
Guido van Rossum360e4b82007-05-14 22:51:27 +00001174 msg = '%s leaked %s references, sum=%s' % (test, deltas, sum(deltas))
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001175 print(msg, file=sys.stderr)
Antoine Pitrou88909542009-06-29 13:54:42 +00001176 sys.stderr.flush()
1177 with open(fname, "a") as refrep:
1178 print(msg, file=refrep)
1179 refrep.flush()
Collin Wintera5503d52009-05-15 01:20:21 +00001180 return True
1181 return False
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001182
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001183def dash_R_cleanup(fs, ps, pic, zdc, abcs):
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +00001184 import gc, copyreg
Brett Cannonf4fd9932008-05-10 21:11:46 +00001185 import _strptime, linecache
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001186 import urllib.parse, urllib.request, mimetypes, doctest
Raymond Hettinger158c9c22011-02-22 00:41:50 +00001187 import struct, filecmp, collections.abc
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001188 from distutils.dir_util import _path_created
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001189 from weakref import WeakSet
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001190
Christian Heimesdae2a892008-04-19 00:55:37 +00001191 # Clear the warnings registry, so they can be displayed again
1192 for mod in sys.modules.values():
1193 if hasattr(mod, '__warningregistry__'):
1194 del mod.__warningregistry__
1195
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001196 # Restore some original values.
1197 warnings.filters[:] = fs
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +00001198 copyreg.dispatch_table.clear()
1199 copyreg.dispatch_table.update(ps)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001200 sys.path_importer_cache.clear()
1201 sys.path_importer_cache.update(pic)
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001202 try:
1203 import zipimport
1204 except ImportError:
1205 pass # Run unmodified on platforms without zipimport support
1206 else:
1207 zipimport._zip_directory_cache.clear()
1208 zipimport._zip_directory_cache.update(zdc)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001209
Christian Heimes26855632008-01-27 23:50:43 +00001210 # clear type cache
Christian Heimes15ebc882008-02-04 18:48:49 +00001211 sys._clear_type_cache()
Christian Heimes26855632008-01-27 23:50:43 +00001212
Guido van Rossum3de862d2007-08-18 00:10:33 +00001213 # Clear ABC registries, restoring previously saved ABC registries.
Raymond Hettinger158c9c22011-02-22 00:41:50 +00001214 for abc in [getattr(collections.abc, a) for a in collections.abc.__all__]:
Christian Heimesbe5b30b2008-03-03 19:18:51 +00001215 if not isabstract(abc):
Christian Heimes941973a2007-11-30 21:53:03 +00001216 continue
Guido van Rossum7eaf8222007-06-18 17:58:50 +00001217 for obj in abc.__subclasses__() + [abc]:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001218 obj._abc_registry = abcs.get(obj, WeakSet()).copy()
Guido van Rossumc1e315d2007-08-20 19:29:24 +00001219 obj._abc_cache.clear()
1220 obj._abc_negative_cache.clear()
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001221
Antoine Pitrou046467c2009-10-30 18:30:35 +00001222 # Flush standard output, so that buffered data is sent to the OS and
1223 # associated Python objects are reclaimed.
1224 for stream in (sys.stdout, sys.stderr, sys.__stdout__, sys.__stderr__):
1225 if stream is not None:
1226 stream.flush()
1227
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001228 # Clear assorted module caches.
1229 _path_created.clear()
1230 re.purge()
1231 _strptime._regex_cache.clear()
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001232 urllib.parse.clear_cache()
1233 urllib.request.urlcleanup()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001234 linecache.clearcache()
1235 mimetypes._default_mime_types()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001236 filecmp._cache.clear()
Christian Heimesa34706f2008-01-04 03:06:10 +00001237 struct._clearcache()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001238 doctest.master = None
1239
1240 # Collect cyclic trash.
1241 gc.collect()
1242
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001243def warm_char_cache():
1244 s = bytes(range(256))
1245 for i in range(256):
1246 s[i:i+1]
1247
Florent Xiclunada7bfd52010-03-06 11:43:55 +00001248def findtestdir(path=None):
1249 return path or os.path.dirname(__file__) or os.curdir
Guido van Rossum152494a1996-12-20 03:12:20 +00001250
Florent Xiclunada7bfd52010-03-06 11:43:55 +00001251def removepy(names):
1252 if not names:
1253 return
1254 for idx, name in enumerate(names):
1255 basename, ext = os.path.splitext(name)
1256 if ext == '.py':
1257 names[idx] = basename
Tim Petersc5000df2002-06-02 21:42:01 +00001258
Guido van Rossum152494a1996-12-20 03:12:20 +00001259def count(n, word):
1260 if n == 1:
Guido van Rossum41360a41998-03-26 19:42:58 +00001261 return "%d %s" % (n, word)
Guido van Rossum152494a1996-12-20 03:12:20 +00001262 else:
Guido van Rossum41360a41998-03-26 19:42:58 +00001263 return "%d %ss" % (n, word)
Guido van Rossum152494a1996-12-20 03:12:20 +00001264
Tim Petersa45da922001-08-12 03:45:50 +00001265def printlist(x, width=70, indent=4):
Tim Peters7c7efe92002-08-23 17:55:54 +00001266 """Print the elements of iterable x to stdout.
Tim Petersa45da922001-08-12 03:45:50 +00001267
1268 Optional arg width (default 70) is the maximum line length.
1269 Optional arg indent (default 4) is the number of blanks with which to
1270 begin each line.
1271 """
1272
Tim Petersba78bc42002-07-04 19:45:06 +00001273 from textwrap import fill
1274 blanks = ' ' * indent
Florent Xiclunafd1b0932010-03-28 00:25:02 +00001275 # Print the sorted list: 'x' may be a '--random' list or a set()
1276 print(fill(' '.join(str(elt) for elt in sorted(x)), width,
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001277 initial_indent=blanks, subsequent_indent=blanks))
Tim Petersa45da922001-08-12 03:45:50 +00001278
Tim Petersde14a302002-04-01 05:04:46 +00001279# Map sys.platform to a string containing the basenames of tests
1280# expected to be skipped on that platform.
Tim Peters2a182db2002-10-09 01:07:11 +00001281#
1282# Special cases:
1283# test_pep277
1284# The _ExpectedSkips constructor adds this to the set of expected
1285# skips if not os.path.supports_unicode_filenames.
Neal Norwitz55b61d22003-02-28 19:57:03 +00001286# test_timeout
1287# Controlled by test_timeout.skip_expected. Requires the network
1288# resource and a socket module.
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001289#
1290# Tests that are expected to be skipped everywhere except on one platform
1291# are also handled separately.
Tim Petersde14a302002-04-01 05:04:46 +00001292
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001293_expectations = {
1294 'win32':
1295 """
Tim Petersc7c516a2003-09-20 22:06:13 +00001296 test__locale
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001297 test_crypt
Tim Petersd7030572001-10-22 22:06:08 +00001298 test_curses
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001299 test_dbm
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001300 test_fcntl
1301 test_fork1
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001302 test_epoll
Benjamin Peterson4d480532008-05-26 19:08:31 +00001303 test_dbm_gnu
Kristján Valur Jónsson42a40c52009-04-01 11:28:47 +00001304 test_dbm_ndbm
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001305 test_grp
Tim Petersfd8e6e52003-03-04 00:26:38 +00001306 test_ioctl
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001307 test_largefile
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001308 test_kqueue
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001309 test_openpty
Tim Petersefc4b122002-12-10 18:47:56 +00001310 test_ossaudiodev
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001311 test_pipes
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001312 test_poll
Tim Peters003eb302003-02-17 21:48:48 +00001313 test_posix
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001314 test_pty
1315 test_pwd
Tim Peters1e33ffa2002-04-23 23:09:02 +00001316 test_resource
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001317 test_signal
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001318 test_syslog
Tim Peterscea2cc42004-08-04 02:32:03 +00001319 test_threadsignals
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001320 test_wait3
1321 test_wait4
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001322 """,
1323 'linux2':
1324 """
Guido van Rossumf66dacd2001-10-23 15:10:55 +00001325 test_curses
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001326 test_largefile
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001327 test_kqueue
Guido van Rossum4507ec72003-02-14 19:29:22 +00001328 test_ossaudiodev
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001329 """,
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001330 'unixware7':
Martin v. Löwis0ace3262001-09-05 14:38:48 +00001331 """
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001332 test_epoll
Martin v. Löwis0ace3262001-09-05 14:38:48 +00001333 test_largefile
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001334 test_kqueue
Martin v. Löwis0ace3262001-09-05 14:38:48 +00001335 test_minidom
Martin v. Löwis0ace3262001-09-05 14:38:48 +00001336 test_openpty
1337 test_pyexpat
1338 test_sax
Martin v. Löwis0ace3262001-09-05 14:38:48 +00001339 test_sundry
Martin v. Löwis0ace3262001-09-05 14:38:48 +00001340 """,
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001341 'openunix8':
1342 """
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001343 test_epoll
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001344 test_largefile
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001345 test_kqueue
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001346 test_minidom
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001347 test_openpty
1348 test_pyexpat
1349 test_sax
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001350 test_sundry
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001351 """,
1352 'sco_sv3':
1353 """
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001354 test_asynchat
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001355 test_fork1
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001356 test_epoll
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001357 test_gettext
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001358 test_largefile
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001359 test_locale
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001360 test_kqueue
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001361 test_minidom
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001362 test_openpty
1363 test_pyexpat
1364 test_queue
1365 test_sax
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001366 test_sundry
1367 test_thread
1368 test_threaded_import
1369 test_threadedtempfile
1370 test_threading
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001371 """,
Jack Jansen8a97f4a2001-12-05 23:27:32 +00001372 'darwin':
Jack Jansen398c2362001-12-02 21:41:36 +00001373 """
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001374 test__locale
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001375 test_curses
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001376 test_epoll
Benjamin Peterson4d480532008-05-26 19:08:31 +00001377 test_dbm_gnu
Skip Montanaro97019ff2010-10-25 01:35:48 +00001378 test_gdb
Jack Jansen398c2362001-12-02 21:41:36 +00001379 test_largefile
Jack Jansenacda3392002-12-30 23:03:13 +00001380 test_locale
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001381 test_minidom
Jack Jansenacda3392002-12-30 23:03:13 +00001382 test_ossaudiodev
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001383 test_poll
Jack Jansen398c2362001-12-02 21:41:36 +00001384 """,
Guido van Rossum11c3f092002-07-17 15:08:24 +00001385 'sunos5':
1386 """
Guido van Rossum11c3f092002-07-17 15:08:24 +00001387 test_curses
1388 test_dbm
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001389 test_epoll
1390 test_kqueue
Benjamin Peterson4d480532008-05-26 19:08:31 +00001391 test_dbm_gnu
Guido van Rossum11c3f092002-07-17 15:08:24 +00001392 test_gzip
Guido van Rossum11c3f092002-07-17 15:08:24 +00001393 test_openpty
Guido van Rossum11c3f092002-07-17 15:08:24 +00001394 test_zipfile
1395 test_zlib
Jeremy Hyltoned375e12002-07-17 15:56:55 +00001396 """,
Skip Montanarob3230212002-03-15 02:54:03 +00001397 'hp-ux11':
1398 """
Skip Montanarob3230212002-03-15 02:54:03 +00001399 test_curses
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001400 test_epoll
Benjamin Peterson4d480532008-05-26 19:08:31 +00001401 test_dbm_gnu
Skip Montanarob3230212002-03-15 02:54:03 +00001402 test_gzip
Skip Montanarob3230212002-03-15 02:54:03 +00001403 test_largefile
Skip Montanarob3230212002-03-15 02:54:03 +00001404 test_locale
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001405 test_kqueue
Skip Montanarob3230212002-03-15 02:54:03 +00001406 test_minidom
Skip Montanarob3230212002-03-15 02:54:03 +00001407 test_openpty
1408 test_pyexpat
1409 test_sax
Skip Montanarob3230212002-03-15 02:54:03 +00001410 test_zipfile
1411 test_zlib
1412 """,
Jason Tishler25115942002-12-05 15:18:15 +00001413 'cygwin':
1414 """
Jason Tishler25115942002-12-05 15:18:15 +00001415 test_curses
1416 test_dbm
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001417 test_epoll
Jason Tishlerc23f39c2003-07-22 18:35:58 +00001418 test_ioctl
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001419 test_kqueue
Jason Tishler25115942002-12-05 15:18:15 +00001420 test_largefile
Jason Tishler25115942002-12-05 15:18:15 +00001421 test_locale
Jason Tishler5c4ded22003-02-05 16:46:01 +00001422 test_ossaudiodev
Jason Tishler25115942002-12-05 15:18:15 +00001423 test_socketserver
Jason Tishler25115942002-12-05 15:18:15 +00001424 """,
Andrew MacIntyrefd07e7d2002-12-31 11:26:50 +00001425 'os2emx':
1426 """
Andrew MacIntyrefd07e7d2002-12-31 11:26:50 +00001427 test_audioop
Andrew MacIntyrefd07e7d2002-12-31 11:26:50 +00001428 test_curses
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001429 test_epoll
1430 test_kqueue
Andrew MacIntyrefd07e7d2002-12-31 11:26:50 +00001431 test_largefile
Andrew MacIntyrefd07e7d2002-12-31 11:26:50 +00001432 test_mmap
Andrew MacIntyrefd07e7d2002-12-31 11:26:50 +00001433 test_openpty
1434 test_ossaudiodev
1435 test_pty
1436 test_resource
1437 test_signal
Andrew MacIntyrefd07e7d2002-12-31 11:26:50 +00001438 """,
Guido van Rossum944a6c32003-11-20 22:11:29 +00001439 'freebsd4':
1440 """
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001441 test_epoll
Benjamin Peterson4d480532008-05-26 19:08:31 +00001442 test_dbm_gnu
Guido van Rossum944a6c32003-11-20 22:11:29 +00001443 test_locale
Guido van Rossum944a6c32003-11-20 22:11:29 +00001444 test_ossaudiodev
1445 test_pep277
Hye-Shik Changf64700a2004-08-18 15:13:41 +00001446 test_pty
Guido van Rossum944a6c32003-11-20 22:11:29 +00001447 test_socketserver
Hye-Shik Changf64700a2004-08-18 15:13:41 +00001448 test_tcl
Guilherme Poloa91790a2009-02-09 20:40:42 +00001449 test_tk
Guilherme Polo9de29af2009-01-28 20:40:48 +00001450 test_ttk_guionly
1451 test_ttk_textonly
Guido van Rossum944a6c32003-11-20 22:11:29 +00001452 test_timeout
Guido van Rossum944a6c32003-11-20 22:11:29 +00001453 test_urllibnet
Benjamin Petersone5384b02008-10-04 22:00:42 +00001454 test_multiprocessing
Martin v. Löwis56f88112003-06-07 20:01:37 +00001455 """,
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +00001456 'aix5':
1457 """
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +00001458 test_bz2
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001459 test_epoll
Benjamin Peterson4d480532008-05-26 19:08:31 +00001460 test_dbm_gnu
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +00001461 test_gzip
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001462 test_kqueue
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +00001463 test_ossaudiodev
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +00001464 test_tcl
Guilherme Poloa91790a2009-02-09 20:40:42 +00001465 test_tk
Guilherme Polo9de29af2009-01-28 20:40:48 +00001466 test_ttk_guionly
1467 test_ttk_textonly
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +00001468 test_zipimport
1469 test_zlib
1470 """,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001471 'openbsd3':
1472 """
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001473 test_ctypes
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001474 test_epoll
Benjamin Peterson4d480532008-05-26 19:08:31 +00001475 test_dbm_gnu
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001476 test_locale
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001477 test_normalization
1478 test_ossaudiodev
1479 test_pep277
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001480 test_tcl
Guilherme Poloa91790a2009-02-09 20:40:42 +00001481 test_tk
Guilherme Polo9de29af2009-01-28 20:40:48 +00001482 test_ttk_guionly
1483 test_ttk_textonly
Benjamin Petersone5384b02008-10-04 22:00:42 +00001484 test_multiprocessing
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001485 """,
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001486 'netbsd3':
1487 """
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001488 test_ctypes
1489 test_curses
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001490 test_epoll
Benjamin Peterson4d480532008-05-26 19:08:31 +00001491 test_dbm_gnu
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001492 test_locale
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001493 test_ossaudiodev
1494 test_pep277
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001495 test_tcl
Guilherme Poloa91790a2009-02-09 20:40:42 +00001496 test_tk
Guilherme Polo9de29af2009-01-28 20:40:48 +00001497 test_ttk_guionly
1498 test_ttk_textonly
Benjamin Petersone5384b02008-10-04 22:00:42 +00001499 test_multiprocessing
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001500 """,
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001501}
Martin v. Löwis32d0c1b2004-07-26 12:09:13 +00001502_expectations['freebsd5'] = _expectations['freebsd4']
Hye-Shik Changf64700a2004-08-18 15:13:41 +00001503_expectations['freebsd6'] = _expectations['freebsd4']
Hye-Shik Chang4e422812005-07-17 02:36:59 +00001504_expectations['freebsd7'] = _expectations['freebsd4']
Guido van Rossum8ce8a782007-11-01 19:42:39 +00001505_expectations['freebsd8'] = _expectations['freebsd4']
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001506
Tim Petersb5b7b782001-08-12 01:20:39 +00001507class _ExpectedSkips:
1508 def __init__(self):
Tim Peters2a182db2002-10-09 01:07:11 +00001509 import os.path
Neal Norwitz55b61d22003-02-28 19:57:03 +00001510 from test import test_timeout
Tim Peters1b445d32002-11-24 18:53:11 +00001511
Tim Peters7c7efe92002-08-23 17:55:54 +00001512 self.valid = False
Tim Petersde14a302002-04-01 05:04:46 +00001513 if sys.platform in _expectations:
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001514 s = _expectations[sys.platform]
Raymond Hettingera690a992003-11-16 16:17:49 +00001515 self.expected = set(s.split())
Tim Peters1b445d32002-11-24 18:53:11 +00001516
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001517 # These are broken tests, for now skipped on every platform.
1518 # XXX Fix these!
Benjamin Petersone9ea19e2008-08-19 23:02:38 +00001519 self.expected.add('test_nis')
Benjamin Peterson4fde0c42008-03-31 02:36:22 +00001520
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001521 # expected to be skipped on every platform, even Linux
Tim Peters2a182db2002-10-09 01:07:11 +00001522 if not os.path.supports_unicode_filenames:
1523 self.expected.add('test_pep277')
Tim Peters1b445d32002-11-24 18:53:11 +00001524
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001525 # doctest, profile and cProfile tests fail when the codec for the
1526 # fs encoding isn't built in because PyUnicode_Decode() adds two
1527 # calls into Python.
1528 encs = ("utf-8", "latin-1", "ascii", "mbcs", "utf-16", "utf-32")
1529 if sys.getfilesystemencoding().lower() not in encs:
1530 self.expected.add('test_profile')
1531 self.expected.add('test_cProfile')
1532 self.expected.add('test_doctest')
Guido van Rossumdaa251c2007-10-25 23:47:33 +00001533
Neal Norwitz55b61d22003-02-28 19:57:03 +00001534 if test_timeout.skip_expected:
1535 self.expected.add('test_timeout')
1536
Tim Petersecd79eb2003-01-29 00:35:32 +00001537 if sys.platform != "win32":
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001538 # test_sqlite is only reliable on Windows where the library
1539 # is distributed with Python
Benjamin Peterson54ad0be2010-10-29 21:33:10 +00001540 WIN_ONLY = {"test_unicode_file", "test_winreg",
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001541 "test_winsound", "test_startfile",
Ross Lagerwall226580e2011-04-09 20:05:04 +02001542 "test_sqlite", "test_msilib"}
Benjamin Peterson54ad0be2010-10-29 21:33:10 +00001543 self.expected |= WIN_ONLY
Tim Petersf2715e02003-02-19 02:35:07 +00001544
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001545 if sys.platform != 'sunos5':
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001546 self.expected.add('test_nis')
Guido van Rossumd59da4b2007-05-22 18:11:13 +00001547
Benjamin Peterson65c66ab2010-10-29 21:31:35 +00001548 if support.python_is_optimized():
1549 self.expected.add("test_gdb")
1550
Tim Peters7c7efe92002-08-23 17:55:54 +00001551 self.valid = True
Tim Petersb5b7b782001-08-12 01:20:39 +00001552
1553 def isvalid(self):
1554 "Return true iff _ExpectedSkips knows about the current platform."
1555 return self.valid
1556
1557 def getexpected(self):
1558 """Return set of test names we expect to skip on current platform.
1559
1560 self.isvalid() must be true.
1561 """
1562
1563 assert self.isvalid()
1564 return self.expected
1565
Michael Foord3ab34cc2010-12-03 12:27:40 +00001566def _make_temp_dir_for_build(TEMPDIR):
1567 # When tests are run from the Python build directory, it is best practice
1568 # to keep the test files in a subfolder. It eases the cleanup of leftover
1569 # files using command "make distclean".
1570 if sysconfig.is_python_build():
1571 TEMPDIR = os.path.join(sysconfig.get_config_var('srcdir'), 'build')
1572 TEMPDIR = os.path.abspath(TEMPDIR)
Antoine Pitrouee429342011-04-16 18:53:59 +02001573 try:
Michael Foord3ab34cc2010-12-03 12:27:40 +00001574 os.mkdir(TEMPDIR)
Antoine Pitrouee429342011-04-16 18:53:59 +02001575 except OSError as e:
1576 if e.errno != errno.EEXIST:
1577 raise
Michael Foord3ab34cc2010-12-03 12:27:40 +00001578
1579 # Define a writable temp dir that will be used as cwd while running
1580 # the tests. The name of the dir includes the pid to allow parallel
1581 # testing (see the -j option).
1582 TESTCWD = 'test_python_{}'.format(os.getpid())
1583
1584 TESTCWD = os.path.join(TEMPDIR, TESTCWD)
1585 return TEMPDIR, TESTCWD
Nick Coghlan4c4c0f22010-12-03 07:44:33 +00001586
Guido van Rossum152494a1996-12-20 03:12:20 +00001587if __name__ == '__main__':
Victor Stinner024e37a2011-03-31 01:31:06 +02001588 # Display the Python traceback on segfault and division by zero
1589 faulthandler.enable()
1590
Nick Coghlan4c4c0f22010-12-03 07:44:33 +00001591 # Remove regrtest.py's own directory from the module search path. Despite
1592 # the elimination of implicit relative imports, this is still needed to
1593 # ensure that submodules of the test package do not inappropriately appear
1594 # as top-level modules even when people (or buildbots!) invoke regrtest.py
1595 # directly instead of using the -m switch
1596 mydir = os.path.abspath(os.path.normpath(os.path.dirname(sys.argv[0])))
1597 i = len(sys.path)
1598 while i >= 0:
1599 i -= 1
1600 if os.path.abspath(os.path.normpath(sys.path[i])) == mydir:
1601 del sys.path[i]
1602
Florent Xiclunadc69e722010-09-13 16:35:02 +00001603 # findtestdir() gets the dirname out of __file__, so we have to make it
1604 # absolute before changing the working directory.
1605 # For example __file__ may be relative when running trace or profile.
1606 # See issue #9323.
1607 __file__ = os.path.abspath(__file__)
1608
1609 # sanity check
Florent Xiclunada7bfd52010-03-06 11:43:55 +00001610 assert __file__ == os.path.abspath(sys.argv[0])
Ezio Melotti184bdfb2010-02-18 09:37:05 +00001611
Michael Foord3ab34cc2010-12-03 12:27:40 +00001612 TEMPDIR, TESTCWD = _make_temp_dir_for_build(TEMPDIR)
Ezio Melotti184bdfb2010-02-18 09:37:05 +00001613
1614 # Run the tests in a context manager that temporary changes the CWD to a
1615 # temporary and writable directory. If it's not possible to create or
1616 # change the CWD, the original CWD will be used. The original CWD is
1617 # available from support.SAVEDCWD.
1618 with support.temp_cwd(TESTCWD, quiet=True):
1619 main()