blob: 120bd6089e45025db844f7a16e7b4ff45e2c4ef1 [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
Brian Curtinf6643452011-04-28 17:45:17 -050027--wait -- wait for user input, e.g., allow a debugger to be attached
Georg Brandl96f78972009-10-27 21:02:11 +000028
29Verbosity
30
31-v/--verbose -- run tests in verbose mode with output to stdout
32-w/--verbose2 -- re-run failed tests in verbose mode
33-W/--verbose3 -- re-run failed tests in verbose mode immediately
34-d/--debug -- print traceback for failed tests
R. David Murray0ba81e02010-04-26 17:02:32 +000035-q/--quiet -- no output unless one or more tests fail
Georg Brandl96f78972009-10-27 21:02:11 +000036-S/--slow -- print the slowest 10 tests
Antoine Pitrou3c4402f2011-01-03 20:38:52 +000037 --header -- print header with interpreter info
Georg Brandl96f78972009-10-27 21:02:11 +000038
39Selecting tests
40
R. David Murray0ba81e02010-04-26 17:02:32 +000041-r/--random -- randomize test execution order (see below)
Antoine Pitrou68530ac2011-01-03 20:40:07 +000042 --randseed -- pass a random seed to reproduce a previous random run
Georg Brandl96f78972009-10-27 21:02:11 +000043-f/--fromfile -- read names of tests to run from a file (see below)
44-x/--exclude -- arguments are tests to *exclude*
R. David Murray0ba81e02010-04-26 17:02:32 +000045-s/--single -- single step through a set of tests (see below)
Georg Brandl96f78972009-10-27 21:02:11 +000046-u/--use RES1,RES2,...
47 -- specify which special resource intensive tests to run
48-M/--memlimit LIMIT
49 -- run very large memory-consuming tests
R David Murrayb588f8d2011-03-24 14:42:58 -040050 --testdir DIR
51 -- execute test files in the specified directory (instead
52 of the Python stdlib test suite)
Georg Brandl96f78972009-10-27 21:02:11 +000053
54Special runs
55
56-l/--findleaks -- if GC is available detect tests that leak memory
57-L/--runleaks -- run the leaks(1) command just before exit
58-R/--huntrleaks RUNCOUNTS
59 -- search for reference leaks (needs debug build, v. slow)
60-j/--multiprocess PROCESSES
61 -- run PROCESSES processes at once
R. David Murray0ba81e02010-04-26 17:02:32 +000062-T/--coverage -- turn on code coverage tracing using the trace module
Georg Brandl96f78972009-10-27 21:02:11 +000063-D/--coverdir DIRECTORY
64 -- Directory where coverage files are put
65-N/--nocoverdir -- Put coverage files alongside modules
66-t/--threshold THRESHOLD
67 -- call gc.set_threshold(THRESHOLD)
68-n/--nowindows -- suppress error message boxes on Windows
R. David Murray0ba81e02010-04-26 17:02:32 +000069-F/--forever -- run the specified tests in a loop, until an error happens
Guido van Rossum152494a1996-12-20 03:12:20 +000070
R. David Murray0ba81e02010-04-26 17:02:32 +000071
72Additional Option Details:
Guido van Rossumf58ed251997-03-07 21:04:33 +000073
Collin Winterfd12f492009-03-29 04:05:05 +000074-r randomizes test execution order. You can use --randseed=int to provide a
75int seed value for the randomizer; this is useful for reproducing troublesome
76test orders.
77
R. David Murray0ba81e02010-04-26 17:02:32 +000078-s On the first invocation of regrtest using -s, the first test file found
79or the first test file given on the command line is run, and the name of
80the next test is recorded in a file named pynexttest. If run from the
81Python build directory, pynexttest is located in the 'build' subdirectory,
82otherwise it is located in tempfile.gettempdir(). On subsequent runs,
83the test in pynexttest is run, and the next test is written to pynexttest.
84When the last test has been run, pynexttest is deleted. In this way it
85is possible to single step through the test files. This is useful when
86doing memory analysis on the Python interpreter, which process tends to
87consume too many resources to run the full regression test non-stop.
Barry Warsawe11e3de1999-01-28 19:51:51 +000088
Neal Norwitz94fa2ee2008-03-31 02:55:15 +000089-S is used to continue running tests after an aborted run. It will
90maintain the order a standard run (ie, this assumes -r is not used).
91This is useful after the tests have prematurely stopped for some external
92reason and you want to start running from where you left off rather
93than starting from the beginning.
94
Guido van Rossum9e9d4f82002-06-07 15:17:03 +000095-f reads the names of tests from the file given as f's argument, one
96or more test names per line. Whitespace is ignored. Blank lines and
97lines beginning with '#' are ignored. This is especially useful for
98whittling down failures involving interactions among tests.
Tim Petersc5000df2002-06-02 21:42:01 +000099
Skip Montanaro0179a182004-06-06 15:53:18 +0000100-L causes the leaks(1) command to be run just before exit if it exists.
101leaks(1) is available on Mac OS X and presumably on some other
102FreeBSD-derived systems.
103
Michael W. Hudson61147f62004-08-03 11:33:28 +0000104-R runs each test several times and examines sys.gettotalrefcount() to
105see if the test appears to be leaking references. The argument should
106be of the form stab:run:fname where 'stab' is the number of times the
107test is run to let gettotalrefcount settle down, 'run' is the number
108of times further it is run and 'fname' is the name of the file the
109reports are written to. These parameters all have defaults (5, 4 and
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000110"reflog.txt" respectively), and the minimal invocation is '-R :'.
Michael W. Hudson61147f62004-08-03 11:33:28 +0000111
Thomas Wouters477c8d52006-05-27 19:21:47 +0000112-M runs tests that require an exorbitant amount of memory. These tests
113typically try to ascertain containers keep working when containing more than
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001142 billion objects, which only works on 64-bit systems. There are also some
115tests that try to exhaust the address space of the process, which only makes
116sense on 32-bit systems with at least 2Gb of memory. The passed-in memlimit,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000117which is a string in the form of '2.5Gb', determines howmuch memory the
118tests will limit themselves to (but they may go slightly over.) The number
119shouldn't be more memory than the machine has (including swap memory). You
120should also keep in mind that swap memory is generally much, much slower
121than RAM, and setting memlimit to all available RAM or higher will heavily
122tax the machine. On the other hand, it is no use running these tests with a
123limit of less than 2.5Gb, and many require more than 20Gb. Tests that expect
124to use more than memlimit memory will be skipped. The big-memory tests
125generally run very, very long.
126
Guido van Rossum9e9d4f82002-06-07 15:17:03 +0000127-u is used to specify which special resource intensive tests to run,
128such as those requiring large file support or network connectivity.
129The argument is a comma-separated list of words indicating the
130resources to test. Currently only the following are defined:
Barry Warsaw08fca522001-08-20 22:33:46 +0000131
Fred Drake3a15dac2002-04-11 16:39:16 +0000132 all - Enable all special resources.
133
Guido van Rossum315aa362003-03-11 14:46:48 +0000134 audio - Tests that use the audio device. (There are known
135 cases of broken audio drivers that can crash Python or
136 even the Linux kernel.)
137
Andrew M. Kuchling2158df02001-10-22 15:26:09 +0000138 curses - Tests that use curses and will modify the terminal's
139 state and output modes.
Tim Peters1633a2e2001-10-30 05:56:40 +0000140
Guido van Rossum9e9d4f82002-06-07 15:17:03 +0000141 largefile - It is okay to run some test that may create huge
142 files. These tests can take a long time and may
143 consume >2GB of disk space temporarily.
Barry Warsaw08fca522001-08-20 22:33:46 +0000144
Guido van Rossum9e9d4f82002-06-07 15:17:03 +0000145 network - It is okay to run tests that use external network
146 resource, e.g. testing SSL support for sockets.
Martin v. Löwis1c6b1a22002-11-19 17:47:07 +0000147
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000148 decimal - Test the decimal module against a large suite that
149 verifies compliance with standards.
150
Antoine Pitrou5bc4fa72010-10-14 15:34:31 +0000151 cpu - Used for certain CPU-heavy tests.
Jeremy Hylton4336eda2004-08-07 19:25:33 +0000152
Tim Peterseba28be2005-03-28 01:08:02 +0000153 subprocess Run all tests for the subprocess module.
Peter Astrandf7f1bb72005-03-03 20:47:37 +0000154
Hye-Shik Changaaa2f1d2005-12-10 17:44:27 +0000155 urlfetch - It is okay to download files required on testing.
156
Guilherme Polo9de29af2009-01-28 20:40:48 +0000157 gui - Run tests that require a running GUI.
158
Fred Drake4dd0f7e2002-11-26 21:44:56 +0000159To enable all resources except one, use '-uall,-<resource>'. For
Georg Brandl1158a332009-06-04 09:30:30 +0000160example, to run all the tests except for the gui tests, give the
161option '-uall,-gui'.
Guido van Rossum152494a1996-12-20 03:12:20 +0000162"""
163
Brett Cannon45071902010-06-14 22:22:54 +0000164import builtins
Victor Stinner024e37a2011-03-31 01:31:06 +0200165import faulthandler
Guido van Rossum152494a1996-12-20 03:12:20 +0000166import getopt
Antoine Pitrou88909542009-06-29 13:54:42 +0000167import json
Christian Heimesb186d002008-03-18 15:15:01 +0000168import os
Skip Montanaroab1c7912000-06-30 16:39:27 +0000169import random
Thomas Wouters9ada3d62006-04-21 09:47:09 +0000170import re
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000171import io
Christian Heimesb186d002008-03-18 15:15:01 +0000172import sys
173import time
Antoine Pitrouee429342011-04-16 18:53:59 +0200174import errno
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000175import traceback
Christian Heimesb186d002008-03-18 15:15:01 +0000176import warnings
Benjamin Petersone549ead2009-03-28 21:42:05 +0000177import unittest
Christian Heimesbe5b30b2008-03-03 19:18:51 +0000178from inspect import isabstract
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000179import tempfile
Florent Xiclunada7bfd52010-03-06 11:43:55 +0000180import platform
181import sysconfig
Nick Coghlan7d819752010-12-05 06:45:03 +0000182import logging
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000183
Florent Xicluna64fb18e2010-03-06 14:43:34 +0000184
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000185# Some times __path__ and __file__ are not absolute (e.g. while running from
186# Lib/) and, if we change the CWD to run the tests in a temporary dir, some
187# imports might fail. This affects only the modules imported before os.chdir().
188# These modules are searched first in sys.path[0] (so '' -- the CWD) and if
189# they are found in the CWD their __file__ and __path__ will be relative (this
190# happens before the chdir). All the modules imported after the chdir, are
191# not found in the CWD, and since the other paths in sys.path[1:] are absolute
192# (site.py absolutize them), the __file__ and __path__ will be absolute too.
193# Therefore it is necessary to absolutize manually the __file__ and __path__ of
194# the packages to prevent later imports to fail when the CWD is different.
195for module in sys.modules.values():
196 if hasattr(module, '__path__'):
197 module.__path__ = [os.path.abspath(path) for path in module.__path__]
198 if hasattr(module, '__file__'):
199 module.__file__ = os.path.abspath(module.__file__)
200
Guido van Rossumdc15c272002-08-12 21:55:51 +0000201
Guido van Rossumbb484652002-12-02 09:56:21 +0000202# MacOSX (a.k.a. Darwin) has a default stack size that is too small
203# for deeply recursive regular expressions. We see this as crashes in
204# the Python test suite when running test_re.py and test_sre.py. The
205# fix is to set the stack limit to 2048.
206# This approach may also be useful for other Unixy platforms that
207# suffer from small default stack limits.
208if sys.platform == 'darwin':
209 try:
210 import resource
211 except ImportError:
212 pass
213 else:
214 soft, hard = resource.getrlimit(resource.RLIMIT_STACK)
215 newsoft = min(hard, max(soft, 1024*2048))
216 resource.setrlimit(resource.RLIMIT_STACK, (newsoft, hard))
217
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000218# Test result constants.
219PASSED = 1
220FAILED = 0
221ENV_CHANGED = -1
222SKIPPED = -2
223RESOURCE_DENIED = -3
224INTERRUPTED = -4
Victor Stinner4b739882011-03-31 18:02:36 +0200225CHILD_ERROR = -5 # error in a child process
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000226
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000227from test import support
Fred Drake3a15dac2002-04-11 16:39:16 +0000228
Georg Brandl1158a332009-06-04 09:30:30 +0000229RESOURCE_NAMES = ('audio', 'curses', 'largefile', 'network',
Antoine Pitrou5bc4fa72010-10-14 15:34:31 +0000230 'decimal', 'cpu', 'subprocess', 'urlfetch', 'gui')
Fred Drake3a15dac2002-04-11 16:39:16 +0000231
Florent Xiclunaec882212010-08-09 16:56:43 +0000232TEMPDIR = os.path.abspath(tempfile.gettempdir())
Fred Drake3a15dac2002-04-11 16:39:16 +0000233
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000234def usage(msg):
235 print(msg, file=sys.stderr)
236 print("Use --help for usage", file=sys.stderr)
237 sys.exit(2)
Barry Warsaw08fca522001-08-20 22:33:46 +0000238
239
Antoine Pitrou88909542009-06-29 13:54:42 +0000240def main(tests=None, testdir=None, verbose=0, quiet=False,
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000241 exclude=False, single=False, randomize=False, fromfile=None,
Walter Dörwaldaee4da62004-11-12 18:51:27 +0000242 findleaks=False, use_resources=None, trace=False, coverdir='coverage',
Collin Winterfd12f492009-03-29 04:05:05 +0000243 runleaks=False, huntrleaks=False, verbose2=False, print_slow=False,
Antoine Pitrou3c4402f2011-01-03 20:38:52 +0000244 random_seed=None, use_mp=None, verbose3=False, forever=False,
Victor Stinner9bf133c2011-04-13 01:06:27 +0200245 header=False):
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000246 """Execute a test suite.
247
Thomas Wouters7e474022000-07-16 12:04:32 +0000248 This also parses command-line options and modifies its behavior
Fred Drake004d5e62000-10-23 17:22:08 +0000249 accordingly.
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000250
251 tests -- a list of strings containing test names (optional)
252 testdir -- the directory in which to look for tests (optional)
253
254 Users other than the Python test suite will certainly want to
255 specify testdir; if it's omitted, the directory containing the
Fred Drake004d5e62000-10-23 17:22:08 +0000256 Python test suite is searched for.
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000257
258 If the tests argument is omitted, the tests listed on the
259 command-line will be used. If that's empty, too, then all *.py
260 files beginning with test_ will be used.
Skip Montanaroab1c7912000-06-30 16:39:27 +0000261
Antoine Pitrou88909542009-06-29 13:54:42 +0000262 The other default arguments (verbose, quiet, exclude,
Collin Winterfd12f492009-03-29 04:05:05 +0000263 single, randomize, findleaks, use_resources, trace, coverdir,
264 print_slow, and random_seed) allow programmers calling main()
265 directly to set the values that would normally be set by flags
266 on the command line.
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000267 """
Victor Stinner9bf133c2011-04-13 01:06:27 +0200268 if hasattr(faulthandler, 'dump_tracebacks_later'):
269 timeout = 60*60
270 else:
271 timeout = None
Fred Drake004d5e62000-10-23 17:22:08 +0000272
Victor Stinner1802d3f2010-05-19 17:11:19 +0000273 replace_stdout()
274
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000275 support.record_original_stdout(sys.stdout)
Guido van Rossum152494a1996-12-20 03:12:20 +0000276 try:
R. David Murray7dc72cc2009-11-14 16:13:02 +0000277 opts, args = getopt.getopt(sys.argv[1:], 'hvqxsSrf:lu:t:TD:NLR:FwWM:nj:',
Georg Brandl96f78972009-10-27 21:02:11 +0000278 ['help', 'verbose', 'verbose2', 'verbose3', 'quiet',
279 'exclude', 'single', 'slow', 'random', 'fromfile', 'findleaks',
280 'use=', 'threshold=', 'trace', 'coverdir=', 'nocoverdir',
R. David Murray7dc72cc2009-11-14 16:13:02 +0000281 'runleaks', 'huntrleaks=', 'memlimit=', 'randseed=',
Brett Cannon63eef1e2011-01-06 22:32:41 +0000282 'multiprocess=', 'coverage', 'slaveargs=', 'forever', 'debug',
Brian Curtinf6643452011-04-28 17:45:17 -0500283 'start=', 'nowindows', 'header', 'testdir=', 'timeout=', 'wait'])
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000284 except getopt.error as msg:
285 usage(msg)
Barry Warsaw08fca522001-08-20 22:33:46 +0000286
287 # Defaults
Collin Winterfd12f492009-03-29 04:05:05 +0000288 if random_seed is None:
289 random_seed = random.randrange(10000000)
Barry Warsaw08fca522001-08-20 22:33:46 +0000290 if use_resources is None:
291 use_resources = []
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000292 debug = False
293 start = None
Guido van Rossum152494a1996-12-20 03:12:20 +0000294 for o, a in opts:
Barry Warsaw08fca522001-08-20 22:33:46 +0000295 if o in ('-h', '--help'):
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000296 print(__doc__)
297 return
Barry Warsaw08fca522001-08-20 22:33:46 +0000298 elif o in ('-v', '--verbose'):
299 verbose += 1
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000300 elif o in ('-w', '--verbose2'):
301 verbose2 = True
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000302 elif o in ('-d', '--debug'):
303 debug = True
Georg Brandl96f78972009-10-27 21:02:11 +0000304 elif o in ('-W', '--verbose3'):
305 verbose3 = True
Barry Warsaw08fca522001-08-20 22:33:46 +0000306 elif o in ('-q', '--quiet'):
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000307 quiet = True;
Barry Warsaw08fca522001-08-20 22:33:46 +0000308 verbose = 0
Barry Warsaw08fca522001-08-20 22:33:46 +0000309 elif o in ('-x', '--exclude'):
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000310 exclude = True
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000311 elif o in ('-S', '--start'):
312 start = a
Barry Warsaw08fca522001-08-20 22:33:46 +0000313 elif o in ('-s', '--single'):
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000314 single = True
Christian Heimesb186d002008-03-18 15:15:01 +0000315 elif o in ('-S', '--slow'):
316 print_slow = True
Barry Warsaw08fca522001-08-20 22:33:46 +0000317 elif o in ('-r', '--randomize'):
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000318 randomize = True
Collin Winterfd12f492009-03-29 04:05:05 +0000319 elif o == '--randseed':
320 random_seed = int(a)
Tim Petersc5000df2002-06-02 21:42:01 +0000321 elif o in ('-f', '--fromfile'):
322 fromfile = a
Barry Warsaw08fca522001-08-20 22:33:46 +0000323 elif o in ('-l', '--findleaks'):
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000324 findleaks = True
Skip Montanaro0179a182004-06-06 15:53:18 +0000325 elif o in ('-L', '--runleaks'):
326 runleaks = True
Guido van Rossum9e9d4f82002-06-07 15:17:03 +0000327 elif o in ('-t', '--threshold'):
328 import gc
329 gc.set_threshold(int(a))
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000330 elif o in ('-T', '--coverage'):
331 trace = True
Walter Dörwaldaee4da62004-11-12 18:51:27 +0000332 elif o in ('-D', '--coverdir'):
R David Murray03504fc2011-03-24 14:35:30 -0400333 # CWD is replaced with a temporary dir before calling main(), so we
334 # need join it with the saved CWD so it goes where the user expects.
335 coverdir = os.path.join(support.SAVEDCWD, a)
Walter Dörwaldaee4da62004-11-12 18:51:27 +0000336 elif o in ('-N', '--nocoverdir'):
337 coverdir = None
Michael W. Hudson61147f62004-08-03 11:33:28 +0000338 elif o in ('-R', '--huntrleaks'):
339 huntrleaks = a.split(':')
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000340 if len(huntrleaks) not in (2, 3):
341 print(a, huntrleaks)
342 usage('-R takes 2 or 3 colon-separated arguments')
343 if not huntrleaks[0]:
Michael W. Hudson61147f62004-08-03 11:33:28 +0000344 huntrleaks[0] = 5
345 else:
346 huntrleaks[0] = int(huntrleaks[0])
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000347 if not huntrleaks[1]:
Michael W. Hudson61147f62004-08-03 11:33:28 +0000348 huntrleaks[1] = 4
349 else:
350 huntrleaks[1] = int(huntrleaks[1])
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000351 if len(huntrleaks) == 2 or not huntrleaks[2]:
352 huntrleaks[2:] = ["reflog.txt"]
353 # Avoid false positives due to the character cache in
354 # stringobject.c filling slowly with random data
355 warm_char_cache()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000356 elif o in ('-M', '--memlimit'):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000357 support.set_memlimit(a)
Barry Warsaw08fca522001-08-20 22:33:46 +0000358 elif o in ('-u', '--use'):
Guido van Rossumfe3f6962001-09-06 16:09:41 +0000359 u = [x.lower() for x in a.split(',')]
360 for r in u:
Fred Drake3a15dac2002-04-11 16:39:16 +0000361 if r == 'all':
Fred Drake4dd0f7e2002-11-26 21:44:56 +0000362 use_resources[:] = RESOURCE_NAMES
363 continue
364 remove = False
365 if r[0] == '-':
366 remove = True
367 r = r[1:]
Fred Drake3a15dac2002-04-11 16:39:16 +0000368 if r not in RESOURCE_NAMES:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000369 usage('Invalid -u/--use option: ' + a)
Fred Drake4dd0f7e2002-11-26 21:44:56 +0000370 if remove:
371 if r in use_resources:
372 use_resources.remove(r)
373 elif r not in use_resources:
Andrew MacIntyree41abab2002-04-30 12:11:04 +0000374 use_resources.append(r)
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000375 elif o in ('-n', '--nowindows'):
376 import msvcrt
377 msvcrt.SetErrorMode(msvcrt.SEM_FAILCRITICALERRORS|
378 msvcrt.SEM_NOALIGNMENTFAULTEXCEPT|
379 msvcrt.SEM_NOGPFAULTERRORBOX|
380 msvcrt.SEM_NOOPENFILEERRORBOX)
381 try:
382 msvcrt.CrtSetReportMode
383 except AttributeError:
384 # release build
385 pass
386 else:
387 for m in [msvcrt.CRT_WARN, msvcrt.CRT_ERROR, msvcrt.CRT_ASSERT]:
388 msvcrt.CrtSetReportMode(m, msvcrt.CRTDBG_MODE_FILE)
389 msvcrt.CrtSetReportFile(m, msvcrt.CRTDBG_FILE_STDERR)
R. David Murray7dc72cc2009-11-14 16:13:02 +0000390 elif o in ('-F', '--forever'):
391 forever = True
Antoine Pitrou88909542009-06-29 13:54:42 +0000392 elif o in ('-j', '--multiprocess'):
393 use_mp = int(a)
Antoine Pitrou6ab79d92011-03-23 20:17:45 +0100394 if use_mp <= 0:
395 try:
396 import multiprocessing
397 # Use all cores + extras for tests that like to sleep
398 use_mp = 2 + multiprocessing.cpu_count()
399 except (ImportError, NotImplementedError):
400 use_mp = 3
Antoine Pitrou3c4402f2011-01-03 20:38:52 +0000401 elif o == '--header':
402 header = True
Antoine Pitrou88909542009-06-29 13:54:42 +0000403 elif o == '--slaveargs':
404 args, kwargs = json.loads(a)
405 try:
406 result = runtest(*args, **kwargs)
407 except BaseException as e:
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000408 result = INTERRUPTED, e.__class__.__name__
Antoine Pitrou88909542009-06-29 13:54:42 +0000409 sys.stdout.flush()
410 print() # Force a newline (just in case)
411 print(json.dumps(result))
412 sys.exit(0)
R David Murrayb588f8d2011-03-24 14:42:58 -0400413 elif o == '--testdir':
414 # CWD is replaced with a temporary dir before calling main(), so we
415 # join it with the saved CWD so it ends up where the user expects.
416 testdir = os.path.join(support.SAVEDCWD, a)
Victor Stinner0cc8d592011-03-31 18:10:13 +0200417 elif o == '--timeout':
Victor Stinner9bf133c2011-04-13 01:06:27 +0200418 if not hasattr(faulthandler, 'dump_tracebacks_later'):
419 print("--timeout option requires "
420 "faulthandler.dump_tracebacks_later", file=sys.stderr)
421 sys.exit(1)
Victor Stinner0cc8d592011-03-31 18:10:13 +0200422 timeout = float(a)
Brian Curtinf6643452011-04-28 17:45:17 -0500423 elif o == '--wait':
424 input("Press any key to continue...")
R. David Murray35768ad2009-11-15 00:23:21 +0000425 else:
426 print(("No handler for option {}. Please report this as a bug "
Georg Brandldee7b852010-08-02 18:59:52 +0000427 "at http://bugs.python.org.").format(o), file=sys.stderr)
R. David Murray35768ad2009-11-15 00:23:21 +0000428 sys.exit(1)
Tim Petersc5000df2002-06-02 21:42:01 +0000429 if single and fromfile:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000430 usage("-s and -f don't go together!")
Antoine Pitrou88909542009-06-29 13:54:42 +0000431 if use_mp and trace:
Florent Xicluna64fb18e2010-03-06 14:43:34 +0000432 usage("-T and -j don't go together!")
Antoine Pitrou88909542009-06-29 13:54:42 +0000433 if use_mp and findleaks:
Florent Xicluna64fb18e2010-03-06 14:43:34 +0000434 usage("-l and -j don't go together!")
Barry Warsaw08fca522001-08-20 22:33:46 +0000435
Guido van Rossum152494a1996-12-20 03:12:20 +0000436 good = []
437 bad = []
438 skipped = []
Fred Drake9a0db072003-02-03 15:19:30 +0000439 resource_denieds = []
Nick Coghlan6ead5522009-10-18 13:19:33 +0000440 environment_changed = []
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000441 interrupted = False
Barry Warsawe11e3de1999-01-28 19:51:51 +0000442
Neil Schemenauerd569f232000-09-22 15:29:28 +0000443 if findleaks:
Barry Warsawa873b032000-08-03 15:50:37 +0000444 try:
445 import gc
446 except ImportError:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000447 print('No GC available, disabling findleaks.')
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000448 findleaks = False
Barry Warsawa873b032000-08-03 15:50:37 +0000449 else:
Neil Schemenauer8a00abc2000-10-13 01:32:42 +0000450 # Uncomment the line below to report garbage that is not
451 # freeable by reference counting alone. By default only
452 # garbage that is not collectable by the GC is reported.
453 #gc.set_debug(gc.DEBUG_SAVEALL)
Neil Schemenauerd569f232000-09-22 15:29:28 +0000454 found_garbage = []
Barry Warsawa873b032000-08-03 15:50:37 +0000455
Barry Warsawe11e3de1999-01-28 19:51:51 +0000456 if single:
Florent Xiclunaec882212010-08-09 16:56:43 +0000457 filename = os.path.join(TEMPDIR, 'pynexttest')
Barry Warsawe11e3de1999-01-28 19:51:51 +0000458 try:
459 fp = open(filename, 'r')
R. David Murray7dc72cc2009-11-14 16:13:02 +0000460 next_test = fp.read().strip()
461 tests = [next_test]
Barry Warsawe11e3de1999-01-28 19:51:51 +0000462 fp.close()
463 except IOError:
464 pass
Tim Petersc5000df2002-06-02 21:42:01 +0000465
466 if fromfile:
467 tests = []
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000468 fp = open(os.path.join(support.SAVEDCWD, fromfile))
Antoine Pitroud95c7b52010-11-07 20:50:51 +0000469 count_pat = re.compile(r'\[\s*\d+/\s*\d+\]')
Tim Petersc5000df2002-06-02 21:42:01 +0000470 for line in fp:
Antoine Pitroud95c7b52010-11-07 20:50:51 +0000471 line = count_pat.sub('', line)
Tim Petersc5000df2002-06-02 21:42:01 +0000472 guts = line.split() # assuming no test has whitespace in its name
473 if guts and not guts[0].startswith('#'):
474 tests.extend(guts)
475 fp.close()
476
477 # Strip .py extensions.
Florent Xiclunada7bfd52010-03-06 11:43:55 +0000478 removepy(args)
479 removepy(tests)
Tim Petersc5000df2002-06-02 21:42:01 +0000480
Guido van Rossum6c74fea1998-08-25 12:29:08 +0000481 stdtests = STDTESTS[:]
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000482 nottests = NOTTESTS.copy()
Guido van Rossum152494a1996-12-20 03:12:20 +0000483 if exclude:
Guido van Rossum6c74fea1998-08-25 12:29:08 +0000484 for arg in args:
485 if arg in stdtests:
486 stdtests.remove(arg)
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000487 nottests.add(arg)
Guido van Rossum41360a41998-03-26 19:42:58 +0000488 args = []
Florent Xicluna0e62a142010-03-06 17:34:48 +0000489
490 # For a partial run, we do not need to clutter the output.
Antoine Pitrou3c4402f2011-01-03 20:38:52 +0000491 if verbose or header or not (quiet or single or tests or args):
Florent Xicluna0e62a142010-03-06 17:34:48 +0000492 # Print basic platform information
493 print("==", platform.python_implementation(), *sys.version.split())
Florent Xiclunaec882212010-08-09 16:56:43 +0000494 print("== ", platform.platform(aliased=True),
495 "%s-endian" % sys.byteorder)
Florent Xicluna0e62a142010-03-06 17:34:48 +0000496 print("== ", os.getcwd())
Antoine Pitrou3c4402f2011-01-03 20:38:52 +0000497 print("Testing with flags:", sys.flags)
Florent Xicluna0e62a142010-03-06 17:34:48 +0000498
R David Murrayb588f8d2011-03-24 14:42:58 -0400499 # if testdir is set, then we are not running the python tests suite, so
500 # don't add default tests to be executed or skipped (pass empty values)
501 if testdir:
502 alltests = findtests(testdir, list(), set())
503 else:
504 alltests = findtests(testdir, stdtests, nottests)
505
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000506 selected = tests or args or alltests
Barry Warsawe11e3de1999-01-28 19:51:51 +0000507 if single:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000508 selected = selected[:1]
R. David Murrayef1992b2009-12-16 15:19:27 +0000509 try:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000510 next_single_test = alltests[alltests.index(selected[0])+1]
R. David Murrayef1992b2009-12-16 15:19:27 +0000511 except IndexError:
512 next_single_test = None
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000513 # Remove all the tests that precede start if it's set.
514 if start:
515 try:
516 del tests[:tests.index(start)]
517 except ValueError:
518 print("Couldn't find starting test (%s), using all tests" % start)
Skip Montanaroab1c7912000-06-30 16:39:27 +0000519 if randomize:
Collin Winterfd12f492009-03-29 04:05:05 +0000520 random.seed(random_seed)
521 print("Using random seed", random_seed)
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000522 random.shuffle(selected)
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000523 if trace:
Georg Brandl33c28812009-04-01 23:07:29 +0000524 import trace, tempfile
525 tracer = trace.Trace(ignoredirs=[sys.prefix, sys.exec_prefix,
526 tempfile.gettempdir()],
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000527 trace=False, count=True)
R. David Murray7dc72cc2009-11-14 16:13:02 +0000528
Christian Heimesb186d002008-03-18 15:15:01 +0000529 test_times = []
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000530 support.verbose = verbose # Tell tests to be moderately quiet
531 support.use_resources = use_resources
Guido van Rossum5796d262000-04-21 21:35:06 +0000532 save_modules = sys.modules.keys()
Antoine Pitrou88909542009-06-29 13:54:42 +0000533
534 def accumulate_result(test, result):
535 ok, test_time = result
536 test_times.append((test_time, test))
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000537 if ok == PASSED:
Antoine Pitrou88909542009-06-29 13:54:42 +0000538 good.append(test)
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000539 elif ok == FAILED:
Antoine Pitrou88909542009-06-29 13:54:42 +0000540 bad.append(test)
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000541 elif ok == ENV_CHANGED:
542 bad.append(test)
543 environment_changed.append(test)
544 elif ok == SKIPPED:
Antoine Pitrou88909542009-06-29 13:54:42 +0000545 skipped.append(test)
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000546 elif ok == RESOURCE_DENIED:
547 skipped.append(test)
548 resource_denieds.append(test)
Antoine Pitrou88909542009-06-29 13:54:42 +0000549
R. David Murray7dc72cc2009-11-14 16:13:02 +0000550 if forever:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000551 def test_forever(tests=list(selected)):
R. David Murray7dc72cc2009-11-14 16:13:02 +0000552 while True:
553 for test in tests:
554 yield test
555 if bad:
556 return
557 tests = test_forever()
Georg Brandle8e02e32010-08-03 07:56:50 +0000558 test_count = ''
559 test_count_width = 3
R. David Murray7dc72cc2009-11-14 16:13:02 +0000560 else:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000561 tests = iter(selected)
Georg Brandle8e02e32010-08-03 07:56:50 +0000562 test_count = '/{}'.format(len(selected))
563 test_count_width = len(test_count) - 1
R. David Murray7dc72cc2009-11-14 16:13:02 +0000564
Antoine Pitrou88909542009-06-29 13:54:42 +0000565 if use_mp:
Victor Stinner45df8202010-04-28 22:31:17 +0000566 try:
567 from threading import Thread
568 except ImportError:
569 print("Multiprocess option requires thread support")
570 sys.exit(2)
Georg Brandl1b37e872010-03-14 10:45:50 +0000571 from queue import Queue
572 from subprocess import Popen, PIPE
Antoine Pitrou88909542009-06-29 13:54:42 +0000573 debug_output_pat = re.compile(r"\[\d+ refs\]$")
Antoine Pitrou88909542009-06-29 13:54:42 +0000574 output = Queue()
R. David Murray7dc72cc2009-11-14 16:13:02 +0000575 def tests_and_args():
576 for test in tests:
577 args_tuple = (
R. David Murray8e286c42010-12-27 20:09:32 +0000578 (test, verbose, quiet),
R. David Murray7dc72cc2009-11-14 16:13:02 +0000579 dict(huntrleaks=huntrleaks, use_resources=use_resources,
Victor Stinner0cc8d592011-03-31 18:10:13 +0200580 debug=debug, rerun_failed=verbose3, timeout=timeout)
R. David Murray7dc72cc2009-11-14 16:13:02 +0000581 )
582 yield (test, args_tuple)
583 pending = tests_and_args()
Antoine Pitrou1b03f2c2010-10-14 11:12:00 +0000584 opt_args = support.args_from_interpreter_flags()
585 base_cmd = [sys.executable] + opt_args + ['-m', 'test.regrtest']
Antoine Pitrou88909542009-06-29 13:54:42 +0000586 def work():
587 # A worker thread.
Neal Norwitz14ca3272006-02-28 18:05:43 +0000588 try:
Antoine Pitrou88909542009-06-29 13:54:42 +0000589 while True:
590 try:
R. David Murray7dc72cc2009-11-14 16:13:02 +0000591 test, args_tuple = next(pending)
592 except StopIteration:
R. David Murray27144602009-10-19 15:26:16 +0000593 output.put((None, None, None, None))
Antoine Pitrou88909542009-06-29 13:54:42 +0000594 return
Antoine Pitrou88909542009-06-29 13:54:42 +0000595 # -E is needed by some tests, e.g. test_import
Antoine Pitrou1b03f2c2010-10-14 11:12:00 +0000596 popen = Popen(base_cmd + ['--slaveargs', json.dumps(args_tuple)],
R. David Murray27144602009-10-19 15:26:16 +0000597 stdout=PIPE, stderr=PIPE,
Antoine Pitrou36e778e2010-08-18 20:44:14 +0000598 universal_newlines=True,
599 close_fds=(os.name != 'nt'))
R. David Murray27144602009-10-19 15:26:16 +0000600 stdout, stderr = popen.communicate()
Victor Stinner4b739882011-03-31 18:02:36 +0200601 retcode = popen.wait()
R. David Murray27144602009-10-19 15:26:16 +0000602 # Strip last refcount output line if it exists, since it
603 # comes from the shutdown of the interpreter in the subcommand.
604 stderr = debug_output_pat.sub("", stderr)
605 stdout, _, result = stdout.strip().rpartition("\n")
Victor Stinner4b739882011-03-31 18:02:36 +0200606 if retcode != 0:
607 result = (CHILD_ERROR, "Exit code %s" % retcode)
608 output.put((test, stdout.rstrip(), stderr.rstrip(), result))
609 return
R. David Murray7dc72cc2009-11-14 16:13:02 +0000610 if not result:
611 output.put((None, None, None, None))
612 return
Antoine Pitrou88909542009-06-29 13:54:42 +0000613 result = json.loads(result)
R. David Murray27144602009-10-19 15:26:16 +0000614 output.put((test, stdout.rstrip(), stderr.rstrip(), result))
Antoine Pitrou88909542009-06-29 13:54:42 +0000615 except BaseException:
R. David Murray27144602009-10-19 15:26:16 +0000616 output.put((None, None, None, None))
Neal Norwitz14ca3272006-02-28 18:05:43 +0000617 raise
Antoine Pitrou88909542009-06-29 13:54:42 +0000618 workers = [Thread(target=work) for i in range(use_mp)]
619 for worker in workers:
620 worker.start()
621 finished = 0
Georg Brandldee7b852010-08-02 18:59:52 +0000622 test_index = 1
R. David Murray7dc72cc2009-11-14 16:13:02 +0000623 try:
624 while finished < use_mp:
625 test, stdout, stderr, result = output.get()
626 if test is None:
627 finished += 1
628 continue
Georg Brandldee7b852010-08-02 18:59:52 +0000629 if not quiet:
Georg Brandle8e02e32010-08-03 07:56:50 +0000630 print("[{1:{0}}{2}] {3}".format(
Georg Brandldee7b852010-08-02 18:59:52 +0000631 test_count_width, test_index, test_count, test))
R. David Murray7dc72cc2009-11-14 16:13:02 +0000632 if stdout:
633 print(stdout)
634 if stderr:
635 print(stderr, file=sys.stderr)
636 if result[0] == INTERRUPTED:
637 assert result[1] == 'KeyboardInterrupt'
638 raise KeyboardInterrupt # What else?
Victor Stinner4b739882011-03-31 18:02:36 +0200639 if result[0] == CHILD_ERROR:
Victor Stinner571e8fd2011-05-01 22:57:43 +0200640 raise Exception("Child error on {}: {}".format(test, result[1]))
R. David Murray7dc72cc2009-11-14 16:13:02 +0000641 accumulate_result(test, result)
Georg Brandldee7b852010-08-02 18:59:52 +0000642 test_index += 1
R. David Murray7dc72cc2009-11-14 16:13:02 +0000643 except KeyboardInterrupt:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000644 interrupted = True
R. David Murray7dc72cc2009-11-14 16:13:02 +0000645 pending.close()
Antoine Pitrou88909542009-06-29 13:54:42 +0000646 for worker in workers:
647 worker.join()
648 else:
Georg Brandldee7b852010-08-02 18:59:52 +0000649 for test_index, test in enumerate(tests, 1):
Antoine Pitrou88909542009-06-29 13:54:42 +0000650 if not quiet:
Georg Brandle8e02e32010-08-03 07:56:50 +0000651 print("[{1:{0}}{2}] {3}".format(
Georg Brandldee7b852010-08-02 18:59:52 +0000652 test_count_width, test_index, test_count, test))
Antoine Pitrou88909542009-06-29 13:54:42 +0000653 sys.stdout.flush()
654 if trace:
655 # If we're tracing code coverage, then we don't exit with status
656 # if on a false return value from main.
Victor Stinner0cc8d592011-03-31 18:10:13 +0200657 tracer.runctx('runtest(test, verbose, quiet, timeout=timeout)',
Antoine Pitrou88909542009-06-29 13:54:42 +0000658 globals=globals(), locals=vars())
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000659 else:
Antoine Pitrou88909542009-06-29 13:54:42 +0000660 try:
Antoine Pitrou293954d2011-03-23 23:01:49 +0100661 result = runtest(test, verbose, quiet, huntrleaks, debug,
Victor Stinner0cc8d592011-03-31 18:10:13 +0200662 rerun_failed=verbose3, timeout=timeout)
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000663 accumulate_result(test, result)
Antoine Pitrou88909542009-06-29 13:54:42 +0000664 except KeyboardInterrupt:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000665 interrupted = True
Antoine Pitrou88909542009-06-29 13:54:42 +0000666 break
667 except:
668 raise
669 if findleaks:
670 gc.collect()
671 if gc.garbage:
672 print("Warning: test created", len(gc.garbage), end=' ')
673 print("uncollectable object(s).")
674 # move the uncollectable objects somewhere so we don't see
675 # them again
676 found_garbage.extend(gc.garbage)
677 del gc.garbage[:]
678 # Unload the newly imported modules (best effort finalization)
679 for module in sys.modules.keys():
680 if module not in save_modules and module.startswith("test."):
681 support.unload(module)
Jeremy Hylton7a1ea0e2001-10-17 13:45:28 +0000682
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000683 if interrupted:
684 # print a newline after ^C
685 print()
686 print("Test suite interrupted by signal SIGINT.")
687 omitted = set(selected) - set(good) - set(bad) - set(skipped)
688 print(count(len(omitted), "test"), "omitted:")
689 printlist(omitted)
Guido van Rossum152494a1996-12-20 03:12:20 +0000690 if good and not quiet:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000691 if not bad and not skipped and not interrupted and len(good) > 1:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000692 print("All", end=' ')
693 print(count(len(good), "test"), "OK.")
Christian Heimesb186d002008-03-18 15:15:01 +0000694 if print_slow:
695 test_times.sort(reverse=True)
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000696 print("10 slowest tests:")
Christian Heimesb186d002008-03-18 15:15:01 +0000697 for time, test in test_times[:10]:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000698 print("%s: %.1fs" % (test, time))
Guido van Rossum152494a1996-12-20 03:12:20 +0000699 if bad:
Nick Coghlan6ead5522009-10-18 13:19:33 +0000700 bad = sorted(set(bad) - set(environment_changed))
701 if bad:
702 print(count(len(bad), "test"), "failed:")
703 printlist(bad)
704 if environment_changed:
705 print("{} altered the execution environment:".format(
706 count(len(environment_changed), "test")))
707 printlist(environment_changed)
Guido van Rossum152494a1996-12-20 03:12:20 +0000708 if skipped and not quiet:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000709 print(count(len(skipped), "test"), "skipped:")
Tim Petersa45da922001-08-12 03:45:50 +0000710 printlist(skipped)
Barry Warsawe11e3de1999-01-28 19:51:51 +0000711
Tim Petersb5b7b782001-08-12 01:20:39 +0000712 e = _ExpectedSkips()
Tim Petersa2be2d62001-08-12 02:01:09 +0000713 plat = sys.platform
Tim Petersb5b7b782001-08-12 01:20:39 +0000714 if e.isvalid():
Raymond Hettingera690a992003-11-16 16:17:49 +0000715 surprise = set(skipped) - e.getexpected() - set(resource_denieds)
Tim Petersb5b7b782001-08-12 01:20:39 +0000716 if surprise:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000717 print(count(len(surprise), "skip"), \
718 "unexpected on", plat + ":")
Tim Petersa45da922001-08-12 03:45:50 +0000719 printlist(surprise)
Tim Petersb5b7b782001-08-12 01:20:39 +0000720 else:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000721 print("Those skips are all expected on", plat + ".")
Tim Petersb5b7b782001-08-12 01:20:39 +0000722 else:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000723 print("Ask someone to teach regrtest.py about which tests are")
724 print("expected to get skipped on", plat + ".")
Tim Petersb5b7b782001-08-12 01:20:39 +0000725
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000726 if verbose2 and bad:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000727 print("Re-running failed tests in verbose mode")
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000728 for test in bad:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000729 print("Re-running test %r in verbose mode" % test)
Tim Peters922dd7d2006-03-10 23:37:10 +0000730 sys.stdout.flush()
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000731 try:
Antoine Pitrou88909542009-06-29 13:54:42 +0000732 verbose = True
Victor Stinner0cc8d592011-03-31 18:10:13 +0200733 ok = runtest(test, True, quiet, huntrleaks, debug, timeout=timeout)
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000734 except KeyboardInterrupt:
735 # print a newline separate from the ^C
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000736 print()
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000737 break
738 except:
739 raise
740
Barry Warsawe11e3de1999-01-28 19:51:51 +0000741 if single:
R. David Murrayef1992b2009-12-16 15:19:27 +0000742 if next_single_test:
743 with open(filename, 'w') as fp:
744 fp.write(next_single_test + '\n')
Barry Warsawe11e3de1999-01-28 19:51:51 +0000745 else:
746 os.unlink(filename)
747
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000748 if trace:
749 r = tracer.results()
750 r.write_results(show_missing=True, summary=True, coverdir=coverdir)
751
Skip Montanaro0179a182004-06-06 15:53:18 +0000752 if runleaks:
753 os.system("leaks %d" % os.getpid())
754
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000755 sys.exit(len(bad) > 0 or interrupted)
Barry Warsaw08fca522001-08-20 22:33:46 +0000756
Guido van Rossum152494a1996-12-20 03:12:20 +0000757
R David Murrayb588f8d2011-03-24 14:42:58 -0400758# small set of tests to determine if we have a basically functioning interpreter
759# (i.e. if any of these fail, then anything else is likely to follow)
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000760STDTESTS = [
Guido van Rossum152494a1996-12-20 03:12:20 +0000761 'test_grammar',
762 'test_opcodes',
Guido van Rossumd8faa362007-04-27 19:54:29 +0000763 'test_dict',
Guido van Rossum152494a1996-12-20 03:12:20 +0000764 'test_builtin',
765 'test_exceptions',
766 'test_types',
Collin Winter7afaa882007-03-08 19:54:43 +0000767 'test_unittest',
768 'test_doctest',
769 'test_doctest2',
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000770]
Guido van Rossum152494a1996-12-20 03:12:20 +0000771
R David Murrayb588f8d2011-03-24 14:42:58 -0400772# set of tests that we don't want to be executed when using regrtest
R David Murray57648302011-03-24 14:57:05 -0400773NOTTESTS = set()
Guido van Rossum152494a1996-12-20 03:12:20 +0000774
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000775def findtests(testdir=None, stdtests=STDTESTS, nottests=NOTTESTS):
Guido van Rossum152494a1996-12-20 03:12:20 +0000776 """Return a list of all applicable test modules."""
Florent Xiclunada7bfd52010-03-06 11:43:55 +0000777 testdir = findtestdir(testdir)
Guido van Rossum152494a1996-12-20 03:12:20 +0000778 names = os.listdir(testdir)
779 tests = []
Florent Xiclunada7bfd52010-03-06 11:43:55 +0000780 others = set(stdtests) | nottests
Guido van Rossum152494a1996-12-20 03:12:20 +0000781 for name in names:
R David Murray661720e2011-03-21 15:14:34 -0400782 mod, ext = os.path.splitext(name)
783 if mod[:5] == "test_" and ext in (".py", "") and mod not in others:
784 tests.append(mod)
Florent Xiclunada7bfd52010-03-06 11:43:55 +0000785 return stdtests + sorted(tests)
Guido van Rossum152494a1996-12-20 03:12:20 +0000786
Victor Stinnerf58087b2010-05-02 17:24:51 +0000787def replace_stdout():
788 """Set stdout encoder error handler to backslashreplace (as stderr error
789 handler) to avoid UnicodeEncodeError when printing a traceback"""
Victor Stinnera3032802010-05-07 00:57:12 +0000790 if os.name == "nt":
791 # Replace sys.stdout breaks the stdout newlines on Windows: issue #8533
792 return
Victor Stinner4b2b43d2011-01-05 03:54:26 +0000793
794 import atexit
795
Victor Stinnerf58087b2010-05-02 17:24:51 +0000796 stdout = sys.stdout
797 sys.stdout = open(stdout.fileno(), 'w',
798 encoding=stdout.encoding,
Victor Stinner4b2b43d2011-01-05 03:54:26 +0000799 errors="backslashreplace",
800 closefd=False)
801
802 def restore_stdout():
803 sys.stdout.close()
804 sys.stdout = stdout
805 atexit.register(restore_stdout)
Victor Stinnerf58087b2010-05-02 17:24:51 +0000806
Antoine Pitrou88909542009-06-29 13:54:42 +0000807def runtest(test, verbose, quiet,
Antoine Pitrou293954d2011-03-23 23:01:49 +0100808 huntrleaks=False, debug=False, use_resources=None,
Victor Stinner0cc8d592011-03-31 18:10:13 +0200809 rerun_failed=False, timeout=None):
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000810 """Run a single test.
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000811
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000812 test -- the name of the test
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000813 verbose -- if true, print more messages
Trent Mickf29f47b2000-08-11 19:02:59 +0000814 quiet -- if true, don't print 'skipped' messages (probably redundant)
Christian Heimesb186d002008-03-18 15:15:01 +0000815 test_times -- a list of (time, test_name) pairs
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000816 huntrleaks -- run multiple times to test for leaks; requires a debug
817 build; a triple corresponding to -R's three arguments
Antoine Pitrou293954d2011-03-23 23:01:49 +0100818 rerun_failed -- if true, re-run in verbose mode when failed
Victor Stinner0cc8d592011-03-31 18:10:13 +0200819 timeout -- dump the traceback and exit if a test takes more than
820 timeout seconds
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000821
822 Returns one of the test result constants:
823 INTERRUPTED KeyboardInterrupt when run under -j
824 RESOURCE_DENIED test skipped because resource denied
825 SKIPPED test skipped for some other reason
826 ENV_CHANGED test failed because it changed the execution environment
827 FAILED test failed
828 PASSED test passed
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000829 """
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000830
Antoine Pitrou88909542009-06-29 13:54:42 +0000831 support.verbose = verbose # Tell tests to be moderately quiet
832 if use_resources is not None:
833 support.use_resources = use_resources
Victor Stinner7d648a02011-03-31 18:27:50 +0200834 use_timeout = (timeout is not None and timeout > 0)
835 if use_timeout:
Victor Stinner0cc8d592011-03-31 18:10:13 +0200836 faulthandler.dump_tracebacks_later(timeout, exit=True)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000837 try:
Antoine Pitrou293954d2011-03-23 23:01:49 +0100838 result = runtest_inner(test, verbose, quiet, huntrleaks, debug)
839 if result[0] == FAILED and rerun_failed:
840 cleanup_test_droppings(test, verbose)
841 sys.stdout.flush()
842 sys.stderr.flush()
843 print("Re-running test {} in verbose mode".format(test))
Victor Stinner0cc8d592011-03-31 18:10:13 +0200844 runtest(test, True, quiet, huntrleaks, debug, timeout=timeout)
Antoine Pitrou293954d2011-03-23 23:01:49 +0100845 return result
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000846 finally:
Victor Stinner7d648a02011-03-31 18:27:50 +0200847 if use_timeout:
Victor Stinner0cc8d592011-03-31 18:10:13 +0200848 faulthandler.cancel_dump_tracebacks_later()
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000849 cleanup_test_droppings(test, verbose)
850
Nick Coghlan6ead5522009-10-18 13:19:33 +0000851# Unit tests are supposed to leave the execution environment unchanged
852# once they complete. But sometimes tests have bugs, especially when
853# tests fail, and the changes to environment go on to mess up other
854# tests. This can cause issues with buildbot stability, since tests
855# are run in random order and so problems may appear to come and go.
856# There are a few things we can save and restore to mitigate this, and
857# the following context manager handles this task.
858
859class saved_test_environment:
860 """Save bits of the test environment and restore them at block exit.
861
862 with saved_test_environment(testname, verbose, quiet):
863 #stuff
864
865 Unless quiet is True, a warning is printed to stderr if any of
866 the saved items was changed by the test. The attribute 'changed'
867 is initially False, but is set to True if a change is detected.
868
869 If verbose is more than 1, the before and after state of changed
870 items is also printed.
871 """
872
873 changed = False
874
875 def __init__(self, testname, verbose=0, quiet=False):
876 self.testname = testname
877 self.verbose = verbose
878 self.quiet = quiet
879
880 # To add things to save and restore, add a name XXX to the resources list
881 # and add corresponding get_XXX/restore_XXX functions. get_XXX should
882 # return the value to be saved and compared against a second call to the
883 # get function when test execution completes. restore_XXX should accept
884 # the saved value and restore the resource using it. It will be called if
885 # and only if a change in the value is detected.
886 #
887 # Note: XXX will have any '.' replaced with '_' characters when determining
888 # the corresponding method names.
889
890 resources = ('sys.argv', 'cwd', 'sys.stdin', 'sys.stdout', 'sys.stderr',
Brett Cannon29c0e4f2010-03-20 22:22:57 +0000891 'os.environ', 'sys.path', 'sys.path_hooks', '__import__',
Nick Coghlan7bd5dbe2010-12-05 07:17:25 +0000892 'warnings.filters', 'asyncore.socket_map',
Ezio Melotti45763d02011-03-20 15:34:28 +0200893 'logging._handlers', 'logging._handlerList', 'sys.gettrace',
Ezio Melotti0123e052011-03-20 15:09:26 +0200894 'sys.warnoptions')
Nick Coghlan6ead5522009-10-18 13:19:33 +0000895
896 def get_sys_argv(self):
897 return id(sys.argv), sys.argv, sys.argv[:]
898 def restore_sys_argv(self, saved_argv):
899 sys.argv = saved_argv[1]
900 sys.argv[:] = saved_argv[2]
901
902 def get_cwd(self):
903 return os.getcwd()
904 def restore_cwd(self, saved_cwd):
905 os.chdir(saved_cwd)
906
907 def get_sys_stdout(self):
908 return sys.stdout
909 def restore_sys_stdout(self, saved_stdout):
910 sys.stdout = saved_stdout
911
912 def get_sys_stderr(self):
913 return sys.stderr
914 def restore_sys_stderr(self, saved_stderr):
915 sys.stderr = saved_stderr
916
917 def get_sys_stdin(self):
918 return sys.stdin
919 def restore_sys_stdin(self, saved_stdin):
920 sys.stdin = saved_stdin
921
922 def get_os_environ(self):
923 return id(os.environ), os.environ, dict(os.environ)
924 def restore_os_environ(self, saved_environ):
925 os.environ = saved_environ[1]
926 os.environ.clear()
927 os.environ.update(saved_environ[2])
928
929 def get_sys_path(self):
930 return id(sys.path), sys.path, sys.path[:]
931 def restore_sys_path(self, saved_path):
932 sys.path = saved_path[1]
933 sys.path[:] = saved_path[2]
934
Brett Cannon055470a2010-02-19 15:57:10 +0000935 def get_sys_path_hooks(self):
936 return id(sys.path_hooks), sys.path_hooks, sys.path_hooks[:]
937 def restore_sys_path_hooks(self, saved_hooks):
938 sys.path_hooks = saved_hooks[1]
939 sys.path_hooks[:] = saved_hooks[2]
940
Brett Cannon31f59292011-02-21 19:29:56 +0000941 def get_sys_gettrace(self):
942 return sys.gettrace()
943 def restore_sys_gettrace(self, trace_fxn):
944 sys.settrace(trace_fxn)
945
Brett Cannon055470a2010-02-19 15:57:10 +0000946 def get___import__(self):
Brett Cannon45071902010-06-14 22:22:54 +0000947 return builtins.__import__
Brett Cannon055470a2010-02-19 15:57:10 +0000948 def restore___import__(self, import_):
Brett Cannon45071902010-06-14 22:22:54 +0000949 builtins.__import__ = import_
Brett Cannon055470a2010-02-19 15:57:10 +0000950
Brett Cannon29c0e4f2010-03-20 22:22:57 +0000951 def get_warnings_filters(self):
952 return id(warnings.filters), warnings.filters, warnings.filters[:]
953 def restore_warnings_filters(self, saved_filters):
954 warnings.filters = saved_filters[1]
955 warnings.filters[:] = saved_filters[2]
956
Antoine Pitroub14ac8c2010-08-16 00:28:05 +0000957 def get_asyncore_socket_map(self):
958 asyncore = sys.modules.get('asyncore')
Antoine Pitrouaa879652010-10-29 11:54:38 +0000959 # XXX Making a copy keeps objects alive until __exit__ gets called.
960 return asyncore and asyncore.socket_map.copy() or {}
Antoine Pitroub14ac8c2010-08-16 00:28:05 +0000961 def restore_asyncore_socket_map(self, saved_map):
962 asyncore = sys.modules.get('asyncore')
963 if asyncore is not None:
Antoine Pitrouaa879652010-10-29 11:54:38 +0000964 asyncore.close_all(ignore_all=True)
Antoine Pitroub14ac8c2010-08-16 00:28:05 +0000965 asyncore.socket_map.update(saved_map)
966
Nick Coghlan7d819752010-12-05 06:45:03 +0000967 def get_logging__handlers(self):
968 # _handlers is a WeakValueDictionary
Nick Coghlan7bd5dbe2010-12-05 07:17:25 +0000969 return id(logging._handlers), logging._handlers, logging._handlers.copy()
Nick Coghlan7d819752010-12-05 06:45:03 +0000970 def restore_logging__handlers(self, saved_handlers):
971 # Can't easily revert the logging state
972 pass
973
Nick Coghlan7bd5dbe2010-12-05 07:17:25 +0000974 def get_logging__handlerList(self):
975 # _handlerList is a list of weakrefs to handlers
976 return id(logging._handlerList), logging._handlerList, logging._handlerList[:]
977 def restore_logging__handlerList(self, saved_handlerList):
978 # Can't easily revert the logging state
979 pass
980
Ezio Melotti0123e052011-03-20 15:09:26 +0200981 def get_sys_warnoptions(self):
982 return id(sys.warnoptions), sys.warnoptions, sys.warnoptions[:]
983 def restore_sys_warnoptions(self, saved_options):
984 sys.warnoptions = saved_options[1]
985 sys.warnoptions[:] = saved_options[2]
986
Nick Coghlan6ead5522009-10-18 13:19:33 +0000987 def resource_info(self):
988 for name in self.resources:
989 method_suffix = name.replace('.', '_')
990 get_name = 'get_' + method_suffix
991 restore_name = 'restore_' + method_suffix
992 yield name, getattr(self, get_name), getattr(self, restore_name)
993
994 def __enter__(self):
995 self.saved_values = dict((name, get()) for name, get, restore
996 in self.resource_info())
997 return self
998
999 def __exit__(self, exc_type, exc_val, exc_tb):
Antoine Pitrouaa879652010-10-29 11:54:38 +00001000 saved_values = self.saved_values
1001 del self.saved_values
Nick Coghlan6ead5522009-10-18 13:19:33 +00001002 for name, get, restore in self.resource_info():
1003 current = get()
Antoine Pitrouaa879652010-10-29 11:54:38 +00001004 original = saved_values.pop(name)
Nick Coghlan6ead5522009-10-18 13:19:33 +00001005 # Check for changes to the resource's value
1006 if current != original:
1007 self.changed = True
1008 restore(original)
1009 if not self.quiet:
1010 print("Warning -- {} was modified by {}".format(
1011 name, self.testname),
1012 file=sys.stderr)
1013 if self.verbose > 1:
1014 print(" Before: {}\n After: {} ".format(
1015 original, current),
1016 file=sys.stderr)
1017 return False
1018
1019
R. David Murray8e286c42010-12-27 20:09:32 +00001020def runtest_inner(test, verbose, quiet, huntrleaks=False, debug=False):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001021 support.unload(test)
Benjamin Petersonb48af542010-04-11 20:43:16 +00001022 if verbose:
1023 capture_stdout = None
1024 else:
1025 capture_stdout = io.StringIO()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001026
Antoine Pitrou88909542009-06-29 13:54:42 +00001027 test_time = 0.0
Collin Wintera5503d52009-05-15 01:20:21 +00001028 refleak = False # True if the test leaked references.
Guido van Rossum152494a1996-12-20 03:12:20 +00001029 try:
R. David Murray0bc11ae2009-10-18 22:18:17 +00001030 if test.startswith('test.'):
1031 abstest = test
1032 else:
1033 # Always import it from the test package
1034 abstest = 'test.' + test
1035 with saved_test_environment(test, verbose, quiet) as environment:
1036 start_time = time.time()
1037 the_package = __import__(abstest, globals(), locals(), [])
1038 the_module = getattr(the_package, test)
1039 # Old tests run to completion simply as a side-effect of
1040 # being imported. For tests based on unittest or doctest,
1041 # explicitly invoke their test_main() function (if it exists).
1042 indirect_test = getattr(the_module, "test_main", None)
1043 if indirect_test is not None:
1044 indirect_test()
1045 if huntrleaks:
1046 refleak = dash_R(the_module, test, indirect_test,
1047 huntrleaks)
1048 test_time = time.time() - start_time
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001049 except support.ResourceDenied as msg:
Fred Drake9a0db072003-02-03 15:19:30 +00001050 if not quiet:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001051 print(test, "skipped --", msg)
Fred Drake9a0db072003-02-03 15:19:30 +00001052 sys.stdout.flush()
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001053 return RESOURCE_DENIED, test_time
R. David Murraya21e4ca2009-03-31 23:16:50 +00001054 except unittest.SkipTest as msg:
Trent Mickf29f47b2000-08-11 19:02:59 +00001055 if not quiet:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001056 print(test, "skipped --", msg)
Guido van Rossum3cda93e2002-09-13 21:28:03 +00001057 sys.stdout.flush()
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001058 return SKIPPED, test_time
Fred Drakefe5c22a2000-08-18 16:04:05 +00001059 except KeyboardInterrupt:
1060 raise
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001061 except support.TestFailed as msg:
R. David Murray11cabcf2010-09-29 01:08:05 +00001062 print("test", test, "failed --", msg, file=sys.stderr)
1063 sys.stderr.flush()
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001064 return FAILED, test_time
Guido van Rossum9e48b271997-07-16 01:56:13 +00001065 except:
Antoine Pitrou779a5b02011-03-21 19:55:16 +01001066 msg = traceback.format_exc()
1067 print("test", test, "crashed --", msg, file=sys.stderr)
R. David Murray11cabcf2010-09-29 01:08:05 +00001068 sys.stderr.flush()
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001069 return FAILED, test_time
Guido van Rossum152494a1996-12-20 03:12:20 +00001070 else:
Collin Wintera5503d52009-05-15 01:20:21 +00001071 if refleak:
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001072 return FAILED, test_time
Nick Coghlan6ead5522009-10-18 13:19:33 +00001073 if environment.changed:
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001074 return ENV_CHANGED, test_time
1075 return PASSED, test_time
Guido van Rossum0fcca4e2001-09-21 20:31:52 +00001076
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001077def cleanup_test_droppings(testname, verbose):
1078 import shutil
Benjamin Peterson25c95f12009-05-08 20:42:26 +00001079 import stat
Antoine Pitrouc14efc42010-10-29 19:34:45 +00001080 import gc
1081
1082 # First kill any dangling references to open files etc.
1083 # This can also issue some ResourceWarnings which would otherwise get
Antoine Pitrou2b40efd2010-10-29 19:36:37 +00001084 # triggered during the following test run, and possibly produce failures.
Antoine Pitrouc14efc42010-10-29 19:34:45 +00001085 gc.collect()
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001086
1087 # Try to clean up junk commonly left behind. While tests shouldn't leave
1088 # any files or directories behind, when a test fails that can be tedious
1089 # for it to arrange. The consequences can be especially nasty on Windows,
1090 # since if a test leaves a file open, it cannot be deleted by name (while
1091 # there's nothing we can do about that here either, we can display the
1092 # name of the offending test, which is a real help).
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001093 for name in (support.TESTFN,
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001094 "db_home",
1095 ):
1096 if not os.path.exists(name):
1097 continue
1098
1099 if os.path.isdir(name):
1100 kind, nuker = "directory", shutil.rmtree
1101 elif os.path.isfile(name):
1102 kind, nuker = "file", os.unlink
1103 else:
1104 raise SystemError("os.path says %r exists but is neither "
1105 "directory nor file" % name)
1106
1107 if verbose:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001108 print("%r left behind %s %r" % (testname, kind, name))
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001109 try:
Benjamin Peterson25c95f12009-05-08 20:42:26 +00001110 # if we have chmod, fix possible permissions problems
1111 # that might prevent cleanup
1112 if (hasattr(os, 'chmod')):
1113 os.chmod(name, stat.S_IRWXU | stat.S_IRWXG | stat.S_IRWXO)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001114 nuker(name)
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001115 except Exception as msg:
1116 print(("%r left behind %s %r and it couldn't be "
1117 "removed: %s" % (testname, kind, name, msg)), file=sys.stderr)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001118
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001119def dash_R(the_module, test, indirect_test, huntrleaks):
Collin Wintera5503d52009-05-15 01:20:21 +00001120 """Run a test multiple times, looking for reference leaks.
1121
1122 Returns:
1123 False if the test didn't leak references; True if we detected refleaks.
1124 """
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001125 # This code is hackish and inelegant, but it seems to do the job.
Raymond Hettinger158c9c22011-02-22 00:41:50 +00001126 import copyreg
1127 import collections.abc
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001128
1129 if not hasattr(sys, 'gettotalrefcount'):
1130 raise Exception("Tracking reference leaks requires a debug build "
1131 "of Python")
1132
1133 # Save current values for dash_R_cleanup() to restore.
1134 fs = warnings.filters[:]
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +00001135 ps = copyreg.dispatch_table.copy()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001136 pic = sys.path_importer_cache.copy()
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001137 try:
1138 import zipimport
1139 except ImportError:
1140 zdc = None # Run unmodified on platforms without zipimport support
1141 else:
1142 zdc = zipimport._zip_directory_cache.copy()
Christian Heimes93852662007-12-01 12:22:32 +00001143 abcs = {}
Raymond Hettinger158c9c22011-02-22 00:41:50 +00001144 for abc in [getattr(collections.abc, a) for a in collections.abc.__all__]:
Christian Heimesbe5b30b2008-03-03 19:18:51 +00001145 if not isabstract(abc):
Christian Heimes93852662007-12-01 12:22:32 +00001146 continue
1147 for obj in abc.__subclasses__() + [abc]:
1148 abcs[obj] = obj._abc_registry.copy()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001149
1150 if indirect_test:
1151 def run_the_test():
1152 indirect_test()
1153 else:
1154 def run_the_test():
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001155 del sys.modules[the_module.__name__]
1156 exec('import ' + the_module.__name__)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001157
1158 deltas = []
1159 nwarmup, ntracked, fname = huntrleaks
Ezio Melotti184bdfb2010-02-18 09:37:05 +00001160 fname = os.path.join(support.SAVEDCWD, fname)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001161 repcount = nwarmup + ntracked
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001162 print("beginning", repcount, "repetitions", file=sys.stderr)
1163 print(("1234567890"*(repcount//10 + 1))[:repcount], file=sys.stderr)
Antoine Pitrou88909542009-06-29 13:54:42 +00001164 sys.stderr.flush()
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001165 dash_R_cleanup(fs, ps, pic, zdc, abcs)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001166 for i in range(repcount):
Collin Winter58bee592010-03-17 02:08:57 +00001167 rc_before = sys.gettotalrefcount()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001168 run_the_test()
1169 sys.stderr.write('.')
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001170 sys.stderr.flush()
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001171 dash_R_cleanup(fs, ps, pic, zdc, abcs)
Collin Winter58bee592010-03-17 02:08:57 +00001172 rc_after = sys.gettotalrefcount()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001173 if i >= nwarmup:
Collin Winter58bee592010-03-17 02:08:57 +00001174 deltas.append(rc_after - rc_before)
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001175 print(file=sys.stderr)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001176 if any(deltas):
Guido van Rossum360e4b82007-05-14 22:51:27 +00001177 msg = '%s leaked %s references, sum=%s' % (test, deltas, sum(deltas))
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001178 print(msg, file=sys.stderr)
Antoine Pitrou88909542009-06-29 13:54:42 +00001179 sys.stderr.flush()
1180 with open(fname, "a") as refrep:
1181 print(msg, file=refrep)
1182 refrep.flush()
Collin Wintera5503d52009-05-15 01:20:21 +00001183 return True
1184 return False
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001185
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001186def dash_R_cleanup(fs, ps, pic, zdc, abcs):
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +00001187 import gc, copyreg
Brett Cannonf4fd9932008-05-10 21:11:46 +00001188 import _strptime, linecache
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001189 import urllib.parse, urllib.request, mimetypes, doctest
Raymond Hettinger158c9c22011-02-22 00:41:50 +00001190 import struct, filecmp, collections.abc
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001191 from distutils.dir_util import _path_created
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001192 from weakref import WeakSet
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001193
Christian Heimesdae2a892008-04-19 00:55:37 +00001194 # Clear the warnings registry, so they can be displayed again
1195 for mod in sys.modules.values():
1196 if hasattr(mod, '__warningregistry__'):
1197 del mod.__warningregistry__
1198
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001199 # Restore some original values.
1200 warnings.filters[:] = fs
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +00001201 copyreg.dispatch_table.clear()
1202 copyreg.dispatch_table.update(ps)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001203 sys.path_importer_cache.clear()
1204 sys.path_importer_cache.update(pic)
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001205 try:
1206 import zipimport
1207 except ImportError:
1208 pass # Run unmodified on platforms without zipimport support
1209 else:
1210 zipimport._zip_directory_cache.clear()
1211 zipimport._zip_directory_cache.update(zdc)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001212
Christian Heimes26855632008-01-27 23:50:43 +00001213 # clear type cache
Christian Heimes15ebc882008-02-04 18:48:49 +00001214 sys._clear_type_cache()
Christian Heimes26855632008-01-27 23:50:43 +00001215
Guido van Rossum3de862d2007-08-18 00:10:33 +00001216 # Clear ABC registries, restoring previously saved ABC registries.
Raymond Hettinger158c9c22011-02-22 00:41:50 +00001217 for abc in [getattr(collections.abc, a) for a in collections.abc.__all__]:
Christian Heimesbe5b30b2008-03-03 19:18:51 +00001218 if not isabstract(abc):
Christian Heimes941973a2007-11-30 21:53:03 +00001219 continue
Guido van Rossum7eaf8222007-06-18 17:58:50 +00001220 for obj in abc.__subclasses__() + [abc]:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001221 obj._abc_registry = abcs.get(obj, WeakSet()).copy()
Guido van Rossumc1e315d2007-08-20 19:29:24 +00001222 obj._abc_cache.clear()
1223 obj._abc_negative_cache.clear()
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001224
Antoine Pitrou046467c2009-10-30 18:30:35 +00001225 # Flush standard output, so that buffered data is sent to the OS and
1226 # associated Python objects are reclaimed.
1227 for stream in (sys.stdout, sys.stderr, sys.__stdout__, sys.__stderr__):
1228 if stream is not None:
1229 stream.flush()
1230
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001231 # Clear assorted module caches.
1232 _path_created.clear()
1233 re.purge()
1234 _strptime._regex_cache.clear()
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001235 urllib.parse.clear_cache()
1236 urllib.request.urlcleanup()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001237 linecache.clearcache()
1238 mimetypes._default_mime_types()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001239 filecmp._cache.clear()
Christian Heimesa34706f2008-01-04 03:06:10 +00001240 struct._clearcache()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001241 doctest.master = None
1242
1243 # Collect cyclic trash.
1244 gc.collect()
1245
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001246def warm_char_cache():
1247 s = bytes(range(256))
1248 for i in range(256):
1249 s[i:i+1]
1250
Florent Xiclunada7bfd52010-03-06 11:43:55 +00001251def findtestdir(path=None):
1252 return path or os.path.dirname(__file__) or os.curdir
Guido van Rossum152494a1996-12-20 03:12:20 +00001253
Florent Xiclunada7bfd52010-03-06 11:43:55 +00001254def removepy(names):
1255 if not names:
1256 return
1257 for idx, name in enumerate(names):
1258 basename, ext = os.path.splitext(name)
1259 if ext == '.py':
1260 names[idx] = basename
Tim Petersc5000df2002-06-02 21:42:01 +00001261
Guido van Rossum152494a1996-12-20 03:12:20 +00001262def count(n, word):
1263 if n == 1:
Guido van Rossum41360a41998-03-26 19:42:58 +00001264 return "%d %s" % (n, word)
Guido van Rossum152494a1996-12-20 03:12:20 +00001265 else:
Guido van Rossum41360a41998-03-26 19:42:58 +00001266 return "%d %ss" % (n, word)
Guido van Rossum152494a1996-12-20 03:12:20 +00001267
Tim Petersa45da922001-08-12 03:45:50 +00001268def printlist(x, width=70, indent=4):
Tim Peters7c7efe92002-08-23 17:55:54 +00001269 """Print the elements of iterable x to stdout.
Tim Petersa45da922001-08-12 03:45:50 +00001270
1271 Optional arg width (default 70) is the maximum line length.
1272 Optional arg indent (default 4) is the number of blanks with which to
1273 begin each line.
1274 """
1275
Tim Petersba78bc42002-07-04 19:45:06 +00001276 from textwrap import fill
1277 blanks = ' ' * indent
Florent Xiclunafd1b0932010-03-28 00:25:02 +00001278 # Print the sorted list: 'x' may be a '--random' list or a set()
1279 print(fill(' '.join(str(elt) for elt in sorted(x)), width,
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001280 initial_indent=blanks, subsequent_indent=blanks))
Tim Petersa45da922001-08-12 03:45:50 +00001281
Tim Petersde14a302002-04-01 05:04:46 +00001282# Map sys.platform to a string containing the basenames of tests
1283# expected to be skipped on that platform.
Tim Peters2a182db2002-10-09 01:07:11 +00001284#
1285# Special cases:
1286# test_pep277
1287# The _ExpectedSkips constructor adds this to the set of expected
1288# skips if not os.path.supports_unicode_filenames.
Neal Norwitz55b61d22003-02-28 19:57:03 +00001289# test_timeout
1290# Controlled by test_timeout.skip_expected. Requires the network
1291# resource and a socket module.
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001292#
1293# Tests that are expected to be skipped everywhere except on one platform
1294# are also handled separately.
Tim Petersde14a302002-04-01 05:04:46 +00001295
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001296_expectations = {
1297 'win32':
1298 """
Tim Petersc7c516a2003-09-20 22:06:13 +00001299 test__locale
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001300 test_crypt
Tim Petersd7030572001-10-22 22:06:08 +00001301 test_curses
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001302 test_dbm
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001303 test_fcntl
1304 test_fork1
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001305 test_epoll
Benjamin Peterson4d480532008-05-26 19:08:31 +00001306 test_dbm_gnu
Kristján Valur Jónsson42a40c52009-04-01 11:28:47 +00001307 test_dbm_ndbm
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001308 test_grp
Tim Petersfd8e6e52003-03-04 00:26:38 +00001309 test_ioctl
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001310 test_largefile
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001311 test_kqueue
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001312 test_openpty
Tim Petersefc4b122002-12-10 18:47:56 +00001313 test_ossaudiodev
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001314 test_pipes
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001315 test_poll
Tim Peters003eb302003-02-17 21:48:48 +00001316 test_posix
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001317 test_pty
1318 test_pwd
Tim Peters1e33ffa2002-04-23 23:09:02 +00001319 test_resource
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001320 test_signal
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001321 test_syslog
Tim Peterscea2cc42004-08-04 02:32:03 +00001322 test_threadsignals
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001323 test_wait3
1324 test_wait4
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001325 """,
1326 'linux2':
1327 """
Guido van Rossumf66dacd2001-10-23 15:10:55 +00001328 test_curses
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001329 test_largefile
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001330 test_kqueue
Guido van Rossum4507ec72003-02-14 19:29:22 +00001331 test_ossaudiodev
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001332 """,
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001333 'unixware7':
Martin v. Löwis0ace3262001-09-05 14:38:48 +00001334 """
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001335 test_epoll
Martin v. Löwis0ace3262001-09-05 14:38:48 +00001336 test_largefile
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001337 test_kqueue
Martin v. Löwis0ace3262001-09-05 14:38:48 +00001338 test_minidom
Martin v. Löwis0ace3262001-09-05 14:38:48 +00001339 test_openpty
1340 test_pyexpat
1341 test_sax
Martin v. Löwis0ace3262001-09-05 14:38:48 +00001342 test_sundry
Martin v. Löwis0ace3262001-09-05 14:38:48 +00001343 """,
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001344 'openunix8':
1345 """
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001346 test_epoll
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001347 test_largefile
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001348 test_kqueue
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001349 test_minidom
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001350 test_openpty
1351 test_pyexpat
1352 test_sax
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001353 test_sundry
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001354 """,
1355 'sco_sv3':
1356 """
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001357 test_asynchat
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001358 test_fork1
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001359 test_epoll
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001360 test_gettext
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001361 test_largefile
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001362 test_locale
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001363 test_kqueue
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001364 test_minidom
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001365 test_openpty
1366 test_pyexpat
1367 test_queue
1368 test_sax
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001369 test_sundry
1370 test_thread
1371 test_threaded_import
1372 test_threadedtempfile
1373 test_threading
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001374 """,
Jack Jansen8a97f4a2001-12-05 23:27:32 +00001375 'darwin':
Jack Jansen398c2362001-12-02 21:41:36 +00001376 """
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001377 test__locale
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001378 test_curses
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001379 test_epoll
Benjamin Peterson4d480532008-05-26 19:08:31 +00001380 test_dbm_gnu
Skip Montanaro97019ff2010-10-25 01:35:48 +00001381 test_gdb
Jack Jansen398c2362001-12-02 21:41:36 +00001382 test_largefile
Jack Jansenacda3392002-12-30 23:03:13 +00001383 test_locale
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001384 test_minidom
Jack Jansenacda3392002-12-30 23:03:13 +00001385 test_ossaudiodev
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001386 test_poll
Jack Jansen398c2362001-12-02 21:41:36 +00001387 """,
Guido van Rossum11c3f092002-07-17 15:08:24 +00001388 'sunos5':
1389 """
Guido van Rossum11c3f092002-07-17 15:08:24 +00001390 test_curses
1391 test_dbm
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001392 test_epoll
1393 test_kqueue
Benjamin Peterson4d480532008-05-26 19:08:31 +00001394 test_dbm_gnu
Guido van Rossum11c3f092002-07-17 15:08:24 +00001395 test_gzip
Guido van Rossum11c3f092002-07-17 15:08:24 +00001396 test_openpty
Guido van Rossum11c3f092002-07-17 15:08:24 +00001397 test_zipfile
1398 test_zlib
Jeremy Hyltoned375e12002-07-17 15:56:55 +00001399 """,
Skip Montanarob3230212002-03-15 02:54:03 +00001400 'hp-ux11':
1401 """
Skip Montanarob3230212002-03-15 02:54:03 +00001402 test_curses
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001403 test_epoll
Benjamin Peterson4d480532008-05-26 19:08:31 +00001404 test_dbm_gnu
Skip Montanarob3230212002-03-15 02:54:03 +00001405 test_gzip
Skip Montanarob3230212002-03-15 02:54:03 +00001406 test_largefile
Skip Montanarob3230212002-03-15 02:54:03 +00001407 test_locale
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001408 test_kqueue
Skip Montanarob3230212002-03-15 02:54:03 +00001409 test_minidom
Skip Montanarob3230212002-03-15 02:54:03 +00001410 test_openpty
1411 test_pyexpat
1412 test_sax
Skip Montanarob3230212002-03-15 02:54:03 +00001413 test_zipfile
1414 test_zlib
1415 """,
Jason Tishler25115942002-12-05 15:18:15 +00001416 'cygwin':
1417 """
Jason Tishler25115942002-12-05 15:18:15 +00001418 test_curses
1419 test_dbm
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001420 test_epoll
Jason Tishlerc23f39c2003-07-22 18:35:58 +00001421 test_ioctl
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001422 test_kqueue
Jason Tishler25115942002-12-05 15:18:15 +00001423 test_largefile
Jason Tishler25115942002-12-05 15:18:15 +00001424 test_locale
Jason Tishler5c4ded22003-02-05 16:46:01 +00001425 test_ossaudiodev
Jason Tishler25115942002-12-05 15:18:15 +00001426 test_socketserver
Jason Tishler25115942002-12-05 15:18:15 +00001427 """,
Andrew MacIntyrefd07e7d2002-12-31 11:26:50 +00001428 'os2emx':
1429 """
Andrew MacIntyrefd07e7d2002-12-31 11:26:50 +00001430 test_audioop
Andrew MacIntyrefd07e7d2002-12-31 11:26:50 +00001431 test_curses
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001432 test_epoll
1433 test_kqueue
Andrew MacIntyrefd07e7d2002-12-31 11:26:50 +00001434 test_largefile
Andrew MacIntyrefd07e7d2002-12-31 11:26:50 +00001435 test_mmap
Andrew MacIntyrefd07e7d2002-12-31 11:26:50 +00001436 test_openpty
1437 test_ossaudiodev
1438 test_pty
1439 test_resource
1440 test_signal
Andrew MacIntyrefd07e7d2002-12-31 11:26:50 +00001441 """,
Guido van Rossum944a6c32003-11-20 22:11:29 +00001442 'freebsd4':
1443 """
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001444 test_epoll
Benjamin Peterson4d480532008-05-26 19:08:31 +00001445 test_dbm_gnu
Guido van Rossum944a6c32003-11-20 22:11:29 +00001446 test_locale
Guido van Rossum944a6c32003-11-20 22:11:29 +00001447 test_ossaudiodev
1448 test_pep277
Hye-Shik Changf64700a2004-08-18 15:13:41 +00001449 test_pty
Guido van Rossum944a6c32003-11-20 22:11:29 +00001450 test_socketserver
Hye-Shik Changf64700a2004-08-18 15:13:41 +00001451 test_tcl
Guilherme Poloa91790a2009-02-09 20:40:42 +00001452 test_tk
Guilherme Polo9de29af2009-01-28 20:40:48 +00001453 test_ttk_guionly
1454 test_ttk_textonly
Guido van Rossum944a6c32003-11-20 22:11:29 +00001455 test_timeout
Guido van Rossum944a6c32003-11-20 22:11:29 +00001456 test_urllibnet
Benjamin Petersone5384b02008-10-04 22:00:42 +00001457 test_multiprocessing
Martin v. Löwis56f88112003-06-07 20:01:37 +00001458 """,
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +00001459 'aix5':
1460 """
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +00001461 test_bz2
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001462 test_epoll
Benjamin Peterson4d480532008-05-26 19:08:31 +00001463 test_dbm_gnu
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +00001464 test_gzip
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001465 test_kqueue
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +00001466 test_ossaudiodev
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +00001467 test_tcl
Guilherme Poloa91790a2009-02-09 20:40:42 +00001468 test_tk
Guilherme Polo9de29af2009-01-28 20:40:48 +00001469 test_ttk_guionly
1470 test_ttk_textonly
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +00001471 test_zipimport
1472 test_zlib
1473 """,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001474 'openbsd3':
1475 """
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001476 test_ctypes
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001477 test_epoll
Benjamin Peterson4d480532008-05-26 19:08:31 +00001478 test_dbm_gnu
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001479 test_locale
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001480 test_normalization
1481 test_ossaudiodev
1482 test_pep277
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001483 test_tcl
Guilherme Poloa91790a2009-02-09 20:40:42 +00001484 test_tk
Guilherme Polo9de29af2009-01-28 20:40:48 +00001485 test_ttk_guionly
1486 test_ttk_textonly
Benjamin Petersone5384b02008-10-04 22:00:42 +00001487 test_multiprocessing
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001488 """,
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001489 'netbsd3':
1490 """
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001491 test_ctypes
1492 test_curses
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001493 test_epoll
Benjamin Peterson4d480532008-05-26 19:08:31 +00001494 test_dbm_gnu
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001495 test_locale
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001496 test_ossaudiodev
1497 test_pep277
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001498 test_tcl
Guilherme Poloa91790a2009-02-09 20:40:42 +00001499 test_tk
Guilherme Polo9de29af2009-01-28 20:40:48 +00001500 test_ttk_guionly
1501 test_ttk_textonly
Benjamin Petersone5384b02008-10-04 22:00:42 +00001502 test_multiprocessing
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001503 """,
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001504}
Martin v. Löwis32d0c1b2004-07-26 12:09:13 +00001505_expectations['freebsd5'] = _expectations['freebsd4']
Hye-Shik Changf64700a2004-08-18 15:13:41 +00001506_expectations['freebsd6'] = _expectations['freebsd4']
Hye-Shik Chang4e422812005-07-17 02:36:59 +00001507_expectations['freebsd7'] = _expectations['freebsd4']
Guido van Rossum8ce8a782007-11-01 19:42:39 +00001508_expectations['freebsd8'] = _expectations['freebsd4']
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001509
Tim Petersb5b7b782001-08-12 01:20:39 +00001510class _ExpectedSkips:
1511 def __init__(self):
Tim Peters2a182db2002-10-09 01:07:11 +00001512 import os.path
Neal Norwitz55b61d22003-02-28 19:57:03 +00001513 from test import test_timeout
Tim Peters1b445d32002-11-24 18:53:11 +00001514
Tim Peters7c7efe92002-08-23 17:55:54 +00001515 self.valid = False
Tim Petersde14a302002-04-01 05:04:46 +00001516 if sys.platform in _expectations:
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001517 s = _expectations[sys.platform]
Raymond Hettingera690a992003-11-16 16:17:49 +00001518 self.expected = set(s.split())
Tim Peters1b445d32002-11-24 18:53:11 +00001519
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001520 # These are broken tests, for now skipped on every platform.
1521 # XXX Fix these!
Benjamin Petersone9ea19e2008-08-19 23:02:38 +00001522 self.expected.add('test_nis')
Benjamin Peterson4fde0c42008-03-31 02:36:22 +00001523
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001524 # expected to be skipped on every platform, even Linux
Tim Peters2a182db2002-10-09 01:07:11 +00001525 if not os.path.supports_unicode_filenames:
1526 self.expected.add('test_pep277')
Tim Peters1b445d32002-11-24 18:53:11 +00001527
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001528 # doctest, profile and cProfile tests fail when the codec for the
1529 # fs encoding isn't built in because PyUnicode_Decode() adds two
1530 # calls into Python.
1531 encs = ("utf-8", "latin-1", "ascii", "mbcs", "utf-16", "utf-32")
1532 if sys.getfilesystemencoding().lower() not in encs:
1533 self.expected.add('test_profile')
1534 self.expected.add('test_cProfile')
1535 self.expected.add('test_doctest')
Guido van Rossumdaa251c2007-10-25 23:47:33 +00001536
Neal Norwitz55b61d22003-02-28 19:57:03 +00001537 if test_timeout.skip_expected:
1538 self.expected.add('test_timeout')
1539
Tim Petersecd79eb2003-01-29 00:35:32 +00001540 if sys.platform != "win32":
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001541 # test_sqlite is only reliable on Windows where the library
1542 # is distributed with Python
Benjamin Peterson54ad0be2010-10-29 21:33:10 +00001543 WIN_ONLY = {"test_unicode_file", "test_winreg",
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001544 "test_winsound", "test_startfile",
Ross Lagerwall226580e2011-04-09 20:05:04 +02001545 "test_sqlite", "test_msilib"}
Benjamin Peterson54ad0be2010-10-29 21:33:10 +00001546 self.expected |= WIN_ONLY
Tim Petersf2715e02003-02-19 02:35:07 +00001547
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001548 if sys.platform != 'sunos5':
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001549 self.expected.add('test_nis')
Guido van Rossumd59da4b2007-05-22 18:11:13 +00001550
Benjamin Peterson65c66ab2010-10-29 21:31:35 +00001551 if support.python_is_optimized():
1552 self.expected.add("test_gdb")
1553
Tim Peters7c7efe92002-08-23 17:55:54 +00001554 self.valid = True
Tim Petersb5b7b782001-08-12 01:20:39 +00001555
1556 def isvalid(self):
1557 "Return true iff _ExpectedSkips knows about the current platform."
1558 return self.valid
1559
1560 def getexpected(self):
1561 """Return set of test names we expect to skip on current platform.
1562
1563 self.isvalid() must be true.
1564 """
1565
1566 assert self.isvalid()
1567 return self.expected
1568
Michael Foord3ab34cc2010-12-03 12:27:40 +00001569def _make_temp_dir_for_build(TEMPDIR):
1570 # When tests are run from the Python build directory, it is best practice
1571 # to keep the test files in a subfolder. It eases the cleanup of leftover
1572 # files using command "make distclean".
1573 if sysconfig.is_python_build():
1574 TEMPDIR = os.path.join(sysconfig.get_config_var('srcdir'), 'build')
1575 TEMPDIR = os.path.abspath(TEMPDIR)
Antoine Pitrouee429342011-04-16 18:53:59 +02001576 try:
Michael Foord3ab34cc2010-12-03 12:27:40 +00001577 os.mkdir(TEMPDIR)
Antoine Pitrouee429342011-04-16 18:53:59 +02001578 except OSError as e:
1579 if e.errno != errno.EEXIST:
1580 raise
Michael Foord3ab34cc2010-12-03 12:27:40 +00001581
1582 # Define a writable temp dir that will be used as cwd while running
1583 # the tests. The name of the dir includes the pid to allow parallel
1584 # testing (see the -j option).
1585 TESTCWD = 'test_python_{}'.format(os.getpid())
1586
1587 TESTCWD = os.path.join(TEMPDIR, TESTCWD)
1588 return TEMPDIR, TESTCWD
Nick Coghlan4c4c0f22010-12-03 07:44:33 +00001589
Guido van Rossum152494a1996-12-20 03:12:20 +00001590if __name__ == '__main__':
Victor Stinner024e37a2011-03-31 01:31:06 +02001591 # Display the Python traceback on segfault and division by zero
Victor Stinner55b5fa72011-05-04 11:02:12 +02001592 faulthandler.enable(all_threads=True)
Victor Stinner024e37a2011-03-31 01:31:06 +02001593
Nick Coghlan4c4c0f22010-12-03 07:44:33 +00001594 # Remove regrtest.py's own directory from the module search path. Despite
1595 # the elimination of implicit relative imports, this is still needed to
1596 # ensure that submodules of the test package do not inappropriately appear
1597 # as top-level modules even when people (or buildbots!) invoke regrtest.py
1598 # directly instead of using the -m switch
1599 mydir = os.path.abspath(os.path.normpath(os.path.dirname(sys.argv[0])))
1600 i = len(sys.path)
1601 while i >= 0:
1602 i -= 1
1603 if os.path.abspath(os.path.normpath(sys.path[i])) == mydir:
1604 del sys.path[i]
1605
Florent Xiclunadc69e722010-09-13 16:35:02 +00001606 # findtestdir() gets the dirname out of __file__, so we have to make it
1607 # absolute before changing the working directory.
1608 # For example __file__ may be relative when running trace or profile.
1609 # See issue #9323.
1610 __file__ = os.path.abspath(__file__)
1611
1612 # sanity check
Florent Xiclunada7bfd52010-03-06 11:43:55 +00001613 assert __file__ == os.path.abspath(sys.argv[0])
Ezio Melotti184bdfb2010-02-18 09:37:05 +00001614
Michael Foord3ab34cc2010-12-03 12:27:40 +00001615 TEMPDIR, TESTCWD = _make_temp_dir_for_build(TEMPDIR)
Ezio Melotti184bdfb2010-02-18 09:37:05 +00001616
1617 # Run the tests in a context manager that temporary changes the CWD to a
1618 # temporary and writable directory. If it's not possible to create or
1619 # change the CWD, the original CWD will be used. The original CWD is
1620 # available from support.SAVEDCWD.
1621 with support.temp_cwd(TESTCWD, quiet=True):
1622 main()