blob: 529734abb4e36ba7436caaeef37ef2ee00947c03 [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 Stinner9e586c22011-06-06 12:04:36 +020025 than TIMEOUT seconds; disabled if TIMEOUT is negative
26 or equals to 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 Stinner3c18f252011-05-22 15:27:14 +0200268
269 # Display the Python traceback fatal errors (e.g. segfault)
270 faulthandler.enable(all_threads=True)
271
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',
Brian Curtinf6643452011-04-28 17:45:17 -0500282 'start=', 'nowindows', 'header', 'testdir=', 'timeout=', 'wait'])
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
Victor Stinner30196882011-06-03 12:53:26 +0200293 timeout = 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'):
Victor Stinner30196882011-06-03 12:53:26 +0200419 print("The timeout option requires "
Victor Stinner9bf133c2011-04-13 01:06:27 +0200420 "faulthandler.dump_tracebacks_later", file=sys.stderr)
421 sys.exit(1)
Victor Stinner0cc8d592011-03-31 18:10:13 +0200422 timeout = float(a)
Victor Stinner30196882011-06-03 12:53:26 +0200423 if timeout <= 0:
Victor Stinner9e586c22011-06-06 12:04:36 +0200424 timeout = None
Brian Curtinf6643452011-04-28 17:45:17 -0500425 elif o == '--wait':
426 input("Press any key to continue...")
R. David Murray35768ad2009-11-15 00:23:21 +0000427 else:
428 print(("No handler for option {}. Please report this as a bug "
Georg Brandldee7b852010-08-02 18:59:52 +0000429 "at http://bugs.python.org.").format(o), file=sys.stderr)
R. David Murray35768ad2009-11-15 00:23:21 +0000430 sys.exit(1)
Tim Petersc5000df2002-06-02 21:42:01 +0000431 if single and fromfile:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000432 usage("-s and -f don't go together!")
Antoine Pitrou88909542009-06-29 13:54:42 +0000433 if use_mp and trace:
Florent Xicluna64fb18e2010-03-06 14:43:34 +0000434 usage("-T and -j don't go together!")
Antoine Pitrou88909542009-06-29 13:54:42 +0000435 if use_mp and findleaks:
Florent Xicluna64fb18e2010-03-06 14:43:34 +0000436 usage("-l and -j don't go together!")
Barry Warsaw08fca522001-08-20 22:33:46 +0000437
Guido van Rossum152494a1996-12-20 03:12:20 +0000438 good = []
439 bad = []
440 skipped = []
Fred Drake9a0db072003-02-03 15:19:30 +0000441 resource_denieds = []
Nick Coghlan6ead5522009-10-18 13:19:33 +0000442 environment_changed = []
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000443 interrupted = False
Barry Warsawe11e3de1999-01-28 19:51:51 +0000444
Neil Schemenauerd569f232000-09-22 15:29:28 +0000445 if findleaks:
Barry Warsawa873b032000-08-03 15:50:37 +0000446 try:
447 import gc
448 except ImportError:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000449 print('No GC available, disabling findleaks.')
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000450 findleaks = False
Barry Warsawa873b032000-08-03 15:50:37 +0000451 else:
Neil Schemenauer8a00abc2000-10-13 01:32:42 +0000452 # Uncomment the line below to report garbage that is not
453 # freeable by reference counting alone. By default only
454 # garbage that is not collectable by the GC is reported.
455 #gc.set_debug(gc.DEBUG_SAVEALL)
Neil Schemenauerd569f232000-09-22 15:29:28 +0000456 found_garbage = []
Barry Warsawa873b032000-08-03 15:50:37 +0000457
Barry Warsawe11e3de1999-01-28 19:51:51 +0000458 if single:
Florent Xiclunaec882212010-08-09 16:56:43 +0000459 filename = os.path.join(TEMPDIR, 'pynexttest')
Barry Warsawe11e3de1999-01-28 19:51:51 +0000460 try:
461 fp = open(filename, 'r')
R. David Murray7dc72cc2009-11-14 16:13:02 +0000462 next_test = fp.read().strip()
463 tests = [next_test]
Barry Warsawe11e3de1999-01-28 19:51:51 +0000464 fp.close()
465 except IOError:
466 pass
Tim Petersc5000df2002-06-02 21:42:01 +0000467
468 if fromfile:
469 tests = []
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000470 fp = open(os.path.join(support.SAVEDCWD, fromfile))
Antoine Pitroud95c7b52010-11-07 20:50:51 +0000471 count_pat = re.compile(r'\[\s*\d+/\s*\d+\]')
Tim Petersc5000df2002-06-02 21:42:01 +0000472 for line in fp:
Antoine Pitroud95c7b52010-11-07 20:50:51 +0000473 line = count_pat.sub('', line)
Tim Petersc5000df2002-06-02 21:42:01 +0000474 guts = line.split() # assuming no test has whitespace in its name
475 if guts and not guts[0].startswith('#'):
476 tests.extend(guts)
477 fp.close()
478
479 # Strip .py extensions.
Florent Xiclunada7bfd52010-03-06 11:43:55 +0000480 removepy(args)
481 removepy(tests)
Tim Petersc5000df2002-06-02 21:42:01 +0000482
Guido van Rossum6c74fea1998-08-25 12:29:08 +0000483 stdtests = STDTESTS[:]
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000484 nottests = NOTTESTS.copy()
Guido van Rossum152494a1996-12-20 03:12:20 +0000485 if exclude:
Guido van Rossum6c74fea1998-08-25 12:29:08 +0000486 for arg in args:
487 if arg in stdtests:
488 stdtests.remove(arg)
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000489 nottests.add(arg)
Guido van Rossum41360a41998-03-26 19:42:58 +0000490 args = []
Florent Xicluna0e62a142010-03-06 17:34:48 +0000491
492 # For a partial run, we do not need to clutter the output.
Antoine Pitrou3c4402f2011-01-03 20:38:52 +0000493 if verbose or header or not (quiet or single or tests or args):
Florent Xicluna0e62a142010-03-06 17:34:48 +0000494 # Print basic platform information
495 print("==", platform.python_implementation(), *sys.version.split())
Florent Xiclunaec882212010-08-09 16:56:43 +0000496 print("== ", platform.platform(aliased=True),
497 "%s-endian" % sys.byteorder)
Florent Xicluna0e62a142010-03-06 17:34:48 +0000498 print("== ", os.getcwd())
Antoine Pitrou3c4402f2011-01-03 20:38:52 +0000499 print("Testing with flags:", sys.flags)
Florent Xicluna0e62a142010-03-06 17:34:48 +0000500
R David Murrayb588f8d2011-03-24 14:42:58 -0400501 # if testdir is set, then we are not running the python tests suite, so
502 # don't add default tests to be executed or skipped (pass empty values)
503 if testdir:
504 alltests = findtests(testdir, list(), set())
505 else:
506 alltests = findtests(testdir, stdtests, nottests)
507
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000508 selected = tests or args or alltests
Barry Warsawe11e3de1999-01-28 19:51:51 +0000509 if single:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000510 selected = selected[:1]
R. David Murrayef1992b2009-12-16 15:19:27 +0000511 try:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000512 next_single_test = alltests[alltests.index(selected[0])+1]
R. David Murrayef1992b2009-12-16 15:19:27 +0000513 except IndexError:
514 next_single_test = None
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000515 # Remove all the tests that precede start if it's set.
516 if start:
517 try:
518 del tests[:tests.index(start)]
519 except ValueError:
520 print("Couldn't find starting test (%s), using all tests" % start)
Skip Montanaroab1c7912000-06-30 16:39:27 +0000521 if randomize:
Collin Winterfd12f492009-03-29 04:05:05 +0000522 random.seed(random_seed)
523 print("Using random seed", random_seed)
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000524 random.shuffle(selected)
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000525 if trace:
Georg Brandl33c28812009-04-01 23:07:29 +0000526 import trace, tempfile
527 tracer = trace.Trace(ignoredirs=[sys.prefix, sys.exec_prefix,
528 tempfile.gettempdir()],
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000529 trace=False, count=True)
R. David Murray7dc72cc2009-11-14 16:13:02 +0000530
Christian Heimesb186d002008-03-18 15:15:01 +0000531 test_times = []
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000532 support.verbose = verbose # Tell tests to be moderately quiet
533 support.use_resources = use_resources
Guido van Rossum5796d262000-04-21 21:35:06 +0000534 save_modules = sys.modules.keys()
Antoine Pitrou88909542009-06-29 13:54:42 +0000535
536 def accumulate_result(test, result):
537 ok, test_time = result
538 test_times.append((test_time, test))
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000539 if ok == PASSED:
Antoine Pitrou88909542009-06-29 13:54:42 +0000540 good.append(test)
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000541 elif ok == FAILED:
Antoine Pitrou88909542009-06-29 13:54:42 +0000542 bad.append(test)
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000543 elif ok == ENV_CHANGED:
544 bad.append(test)
545 environment_changed.append(test)
546 elif ok == SKIPPED:
Antoine Pitrou88909542009-06-29 13:54:42 +0000547 skipped.append(test)
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000548 elif ok == RESOURCE_DENIED:
549 skipped.append(test)
550 resource_denieds.append(test)
Antoine Pitrou88909542009-06-29 13:54:42 +0000551
R. David Murray7dc72cc2009-11-14 16:13:02 +0000552 if forever:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000553 def test_forever(tests=list(selected)):
R. David Murray7dc72cc2009-11-14 16:13:02 +0000554 while True:
555 for test in tests:
556 yield test
557 if bad:
558 return
559 tests = test_forever()
Georg Brandle8e02e32010-08-03 07:56:50 +0000560 test_count = ''
561 test_count_width = 3
R. David Murray7dc72cc2009-11-14 16:13:02 +0000562 else:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000563 tests = iter(selected)
Georg Brandle8e02e32010-08-03 07:56:50 +0000564 test_count = '/{}'.format(len(selected))
565 test_count_width = len(test_count) - 1
R. David Murray7dc72cc2009-11-14 16:13:02 +0000566
Antoine Pitrou88909542009-06-29 13:54:42 +0000567 if use_mp:
Victor Stinner45df8202010-04-28 22:31:17 +0000568 try:
569 from threading import Thread
570 except ImportError:
571 print("Multiprocess option requires thread support")
572 sys.exit(2)
Georg Brandl1b37e872010-03-14 10:45:50 +0000573 from queue import Queue
574 from subprocess import Popen, PIPE
Antoine Pitrou88909542009-06-29 13:54:42 +0000575 debug_output_pat = re.compile(r"\[\d+ refs\]$")
Antoine Pitrou88909542009-06-29 13:54:42 +0000576 output = Queue()
R. David Murray7dc72cc2009-11-14 16:13:02 +0000577 def tests_and_args():
578 for test in tests:
579 args_tuple = (
R. David Murray8e286c42010-12-27 20:09:32 +0000580 (test, verbose, quiet),
R. David Murray7dc72cc2009-11-14 16:13:02 +0000581 dict(huntrleaks=huntrleaks, use_resources=use_resources,
Victor Stinner0cc8d592011-03-31 18:10:13 +0200582 debug=debug, rerun_failed=verbose3, timeout=timeout)
R. David Murray7dc72cc2009-11-14 16:13:02 +0000583 )
584 yield (test, args_tuple)
585 pending = tests_and_args()
Antoine Pitrou1b03f2c2010-10-14 11:12:00 +0000586 opt_args = support.args_from_interpreter_flags()
587 base_cmd = [sys.executable] + opt_args + ['-m', 'test.regrtest']
Antoine Pitrou88909542009-06-29 13:54:42 +0000588 def work():
589 # A worker thread.
Neal Norwitz14ca3272006-02-28 18:05:43 +0000590 try:
Antoine Pitrou88909542009-06-29 13:54:42 +0000591 while True:
592 try:
R. David Murray7dc72cc2009-11-14 16:13:02 +0000593 test, args_tuple = next(pending)
594 except StopIteration:
R. David Murray27144602009-10-19 15:26:16 +0000595 output.put((None, None, None, None))
Antoine Pitrou88909542009-06-29 13:54:42 +0000596 return
Antoine Pitrou88909542009-06-29 13:54:42 +0000597 # -E is needed by some tests, e.g. test_import
Antoine Pitrou1b03f2c2010-10-14 11:12:00 +0000598 popen = Popen(base_cmd + ['--slaveargs', json.dumps(args_tuple)],
R. David Murray27144602009-10-19 15:26:16 +0000599 stdout=PIPE, stderr=PIPE,
Antoine Pitrou36e778e2010-08-18 20:44:14 +0000600 universal_newlines=True,
601 close_fds=(os.name != 'nt'))
R. David Murray27144602009-10-19 15:26:16 +0000602 stdout, stderr = popen.communicate()
Victor Stinner4b739882011-03-31 18:02:36 +0200603 retcode = popen.wait()
R. David Murray27144602009-10-19 15:26:16 +0000604 # Strip last refcount output line if it exists, since it
605 # comes from the shutdown of the interpreter in the subcommand.
606 stderr = debug_output_pat.sub("", stderr)
607 stdout, _, result = stdout.strip().rpartition("\n")
Victor Stinner4b739882011-03-31 18:02:36 +0200608 if retcode != 0:
609 result = (CHILD_ERROR, "Exit code %s" % retcode)
610 output.put((test, stdout.rstrip(), stderr.rstrip(), result))
611 return
R. David Murray7dc72cc2009-11-14 16:13:02 +0000612 if not result:
613 output.put((None, None, None, None))
614 return
Antoine Pitrou88909542009-06-29 13:54:42 +0000615 result = json.loads(result)
R. David Murray27144602009-10-19 15:26:16 +0000616 output.put((test, stdout.rstrip(), stderr.rstrip(), result))
Antoine Pitrou88909542009-06-29 13:54:42 +0000617 except BaseException:
R. David Murray27144602009-10-19 15:26:16 +0000618 output.put((None, None, None, None))
Neal Norwitz14ca3272006-02-28 18:05:43 +0000619 raise
Antoine Pitrou88909542009-06-29 13:54:42 +0000620 workers = [Thread(target=work) for i in range(use_mp)]
621 for worker in workers:
622 worker.start()
623 finished = 0
Georg Brandldee7b852010-08-02 18:59:52 +0000624 test_index = 1
R. David Murray7dc72cc2009-11-14 16:13:02 +0000625 try:
626 while finished < use_mp:
627 test, stdout, stderr, result = output.get()
628 if test is None:
629 finished += 1
630 continue
Victor Stinnera2a895c2011-05-23 23:14:05 +0200631 accumulate_result(test, result)
Georg Brandldee7b852010-08-02 18:59:52 +0000632 if not quiet:
Ezio Melotti84f75c62011-05-24 01:00:10 +0300633 fmt = "[{1:{0}}{2}/{3}] {4}" if bad else "[{1:{0}}{2}] {4}"
634 print(fmt.format(
Victor Stinnera2a895c2011-05-23 23:14:05 +0200635 test_count_width, test_index, test_count,
636 len(bad), test))
R. David Murray7dc72cc2009-11-14 16:13:02 +0000637 if stdout:
638 print(stdout)
639 if stderr:
640 print(stderr, file=sys.stderr)
641 if result[0] == INTERRUPTED:
642 assert result[1] == 'KeyboardInterrupt'
643 raise KeyboardInterrupt # What else?
Victor Stinner4b739882011-03-31 18:02:36 +0200644 if result[0] == CHILD_ERROR:
Victor Stinner571e8fd2011-05-01 22:57:43 +0200645 raise Exception("Child error on {}: {}".format(test, result[1]))
Georg Brandldee7b852010-08-02 18:59:52 +0000646 test_index += 1
R. David Murray7dc72cc2009-11-14 16:13:02 +0000647 except KeyboardInterrupt:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000648 interrupted = True
R. David Murray7dc72cc2009-11-14 16:13:02 +0000649 pending.close()
Antoine Pitrou88909542009-06-29 13:54:42 +0000650 for worker in workers:
651 worker.join()
652 else:
Georg Brandldee7b852010-08-02 18:59:52 +0000653 for test_index, test in enumerate(tests, 1):
Antoine Pitrou88909542009-06-29 13:54:42 +0000654 if not quiet:
Ezio Melotti84f75c62011-05-24 01:00:10 +0300655 fmt = "[{1:{0}}{2}/{3}] {4}" if bad else "[{1:{0}}{2}] {4}"
656 print(fmt.format(
Victor Stinnera2a895c2011-05-23 23:14:05 +0200657 test_count_width, test_index, test_count, len(bad), test))
Antoine Pitrou88909542009-06-29 13:54:42 +0000658 sys.stdout.flush()
659 if trace:
660 # If we're tracing code coverage, then we don't exit with status
661 # if on a false return value from main.
Victor Stinner0cc8d592011-03-31 18:10:13 +0200662 tracer.runctx('runtest(test, verbose, quiet, timeout=timeout)',
Antoine Pitrou88909542009-06-29 13:54:42 +0000663 globals=globals(), locals=vars())
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000664 else:
Antoine Pitrou88909542009-06-29 13:54:42 +0000665 try:
Antoine Pitrou293954d2011-03-23 23:01:49 +0100666 result = runtest(test, verbose, quiet, huntrleaks, debug,
Victor Stinner0cc8d592011-03-31 18:10:13 +0200667 rerun_failed=verbose3, timeout=timeout)
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000668 accumulate_result(test, result)
Antoine Pitrou88909542009-06-29 13:54:42 +0000669 except KeyboardInterrupt:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000670 interrupted = True
Antoine Pitrou88909542009-06-29 13:54:42 +0000671 break
672 except:
673 raise
674 if findleaks:
675 gc.collect()
676 if gc.garbage:
677 print("Warning: test created", len(gc.garbage), end=' ')
678 print("uncollectable object(s).")
679 # move the uncollectable objects somewhere so we don't see
680 # them again
681 found_garbage.extend(gc.garbage)
682 del gc.garbage[:]
683 # Unload the newly imported modules (best effort finalization)
684 for module in sys.modules.keys():
685 if module not in save_modules and module.startswith("test."):
686 support.unload(module)
Jeremy Hylton7a1ea0e2001-10-17 13:45:28 +0000687
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000688 if interrupted:
689 # print a newline after ^C
690 print()
691 print("Test suite interrupted by signal SIGINT.")
692 omitted = set(selected) - set(good) - set(bad) - set(skipped)
693 print(count(len(omitted), "test"), "omitted:")
694 printlist(omitted)
Guido van Rossum152494a1996-12-20 03:12:20 +0000695 if good and not quiet:
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000696 if not bad and not skipped and not interrupted and len(good) > 1:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000697 print("All", end=' ')
698 print(count(len(good), "test"), "OK.")
Christian Heimesb186d002008-03-18 15:15:01 +0000699 if print_slow:
700 test_times.sort(reverse=True)
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000701 print("10 slowest tests:")
Christian Heimesb186d002008-03-18 15:15:01 +0000702 for time, test in test_times[:10]:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000703 print("%s: %.1fs" % (test, time))
Guido van Rossum152494a1996-12-20 03:12:20 +0000704 if bad:
Nick Coghlan6ead5522009-10-18 13:19:33 +0000705 bad = sorted(set(bad) - set(environment_changed))
706 if bad:
707 print(count(len(bad), "test"), "failed:")
708 printlist(bad)
709 if environment_changed:
710 print("{} altered the execution environment:".format(
711 count(len(environment_changed), "test")))
712 printlist(environment_changed)
Guido van Rossum152494a1996-12-20 03:12:20 +0000713 if skipped and not quiet:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000714 print(count(len(skipped), "test"), "skipped:")
Tim Petersa45da922001-08-12 03:45:50 +0000715 printlist(skipped)
Barry Warsawe11e3de1999-01-28 19:51:51 +0000716
Tim Petersb5b7b782001-08-12 01:20:39 +0000717 e = _ExpectedSkips()
Tim Petersa2be2d62001-08-12 02:01:09 +0000718 plat = sys.platform
Tim Petersb5b7b782001-08-12 01:20:39 +0000719 if e.isvalid():
Raymond Hettingera690a992003-11-16 16:17:49 +0000720 surprise = set(skipped) - e.getexpected() - set(resource_denieds)
Tim Petersb5b7b782001-08-12 01:20:39 +0000721 if surprise:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000722 print(count(len(surprise), "skip"), \
723 "unexpected on", plat + ":")
Tim Petersa45da922001-08-12 03:45:50 +0000724 printlist(surprise)
Tim Petersb5b7b782001-08-12 01:20:39 +0000725 else:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000726 print("Those skips are all expected on", plat + ".")
Tim Petersb5b7b782001-08-12 01:20:39 +0000727 else:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000728 print("Ask someone to teach regrtest.py about which tests are")
729 print("expected to get skipped on", plat + ".")
Tim Petersb5b7b782001-08-12 01:20:39 +0000730
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000731 if verbose2 and bad:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000732 print("Re-running failed tests in verbose mode")
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000733 for test in bad:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000734 print("Re-running test %r in verbose mode" % test)
Tim Peters922dd7d2006-03-10 23:37:10 +0000735 sys.stdout.flush()
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000736 try:
Antoine Pitrou88909542009-06-29 13:54:42 +0000737 verbose = True
Victor Stinner0cc8d592011-03-31 18:10:13 +0200738 ok = runtest(test, True, quiet, huntrleaks, debug, timeout=timeout)
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000739 except KeyboardInterrupt:
740 # print a newline separate from the ^C
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000741 print()
Martin v. Löwis04824ce2006-03-10 21:26:16 +0000742 break
743 except:
744 raise
745
Barry Warsawe11e3de1999-01-28 19:51:51 +0000746 if single:
R. David Murrayef1992b2009-12-16 15:19:27 +0000747 if next_single_test:
748 with open(filename, 'w') as fp:
749 fp.write(next_single_test + '\n')
Barry Warsawe11e3de1999-01-28 19:51:51 +0000750 else:
751 os.unlink(filename)
752
Barry Warsaw3b6d0252004-02-07 22:43:03 +0000753 if trace:
754 r = tracer.results()
755 r.write_results(show_missing=True, summary=True, coverdir=coverdir)
756
Skip Montanaro0179a182004-06-06 15:53:18 +0000757 if runleaks:
758 os.system("leaks %d" % os.getpid())
759
Florent Xiclunad6995eb2010-03-30 19:43:09 +0000760 sys.exit(len(bad) > 0 or interrupted)
Barry Warsaw08fca522001-08-20 22:33:46 +0000761
Guido van Rossum152494a1996-12-20 03:12:20 +0000762
R David Murrayb588f8d2011-03-24 14:42:58 -0400763# small set of tests to determine if we have a basically functioning interpreter
764# (i.e. if any of these fail, then anything else is likely to follow)
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000765STDTESTS = [
Guido van Rossum152494a1996-12-20 03:12:20 +0000766 'test_grammar',
767 'test_opcodes',
Guido van Rossumd8faa362007-04-27 19:54:29 +0000768 'test_dict',
Guido van Rossum152494a1996-12-20 03:12:20 +0000769 'test_builtin',
770 'test_exceptions',
771 'test_types',
Collin Winter7afaa882007-03-08 19:54:43 +0000772 'test_unittest',
773 'test_doctest',
774 'test_doctest2',
Neal Norwitz94fa2ee2008-03-31 02:55:15 +0000775]
Guido van Rossum152494a1996-12-20 03:12:20 +0000776
R David Murrayb588f8d2011-03-24 14:42:58 -0400777# set of tests that we don't want to be executed when using regrtest
R David Murray57648302011-03-24 14:57:05 -0400778NOTTESTS = set()
Guido van Rossum152494a1996-12-20 03:12:20 +0000779
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000780def findtests(testdir=None, stdtests=STDTESTS, nottests=NOTTESTS):
Guido van Rossum152494a1996-12-20 03:12:20 +0000781 """Return a list of all applicable test modules."""
Florent Xiclunada7bfd52010-03-06 11:43:55 +0000782 testdir = findtestdir(testdir)
Guido van Rossum152494a1996-12-20 03:12:20 +0000783 names = os.listdir(testdir)
784 tests = []
Florent Xiclunada7bfd52010-03-06 11:43:55 +0000785 others = set(stdtests) | nottests
Guido van Rossum152494a1996-12-20 03:12:20 +0000786 for name in names:
R David Murray661720e2011-03-21 15:14:34 -0400787 mod, ext = os.path.splitext(name)
788 if mod[:5] == "test_" and ext in (".py", "") and mod not in others:
789 tests.append(mod)
Florent Xiclunada7bfd52010-03-06 11:43:55 +0000790 return stdtests + sorted(tests)
Guido van Rossum152494a1996-12-20 03:12:20 +0000791
Victor Stinnerf58087b2010-05-02 17:24:51 +0000792def replace_stdout():
793 """Set stdout encoder error handler to backslashreplace (as stderr error
794 handler) to avoid UnicodeEncodeError when printing a traceback"""
Victor Stinner4b2b43d2011-01-05 03:54:26 +0000795 import atexit
796
Victor Stinnerf58087b2010-05-02 17:24:51 +0000797 stdout = sys.stdout
798 sys.stdout = open(stdout.fileno(), 'w',
799 encoding=stdout.encoding,
Victor Stinner4b2b43d2011-01-05 03:54:26 +0000800 errors="backslashreplace",
Victor Stinnerbe621032011-05-25 02:01:55 +0200801 closefd=False,
802 newline='\n')
Victor Stinner4b2b43d2011-01-05 03:54:26 +0000803
804 def restore_stdout():
805 sys.stdout.close()
806 sys.stdout = stdout
807 atexit.register(restore_stdout)
Victor Stinnerf58087b2010-05-02 17:24:51 +0000808
Antoine Pitrou88909542009-06-29 13:54:42 +0000809def runtest(test, verbose, quiet,
Antoine Pitrou293954d2011-03-23 23:01:49 +0100810 huntrleaks=False, debug=False, use_resources=None,
Victor Stinner0cc8d592011-03-31 18:10:13 +0200811 rerun_failed=False, timeout=None):
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000812 """Run a single test.
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000813
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000814 test -- the name of the test
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000815 verbose -- if true, print more messages
Trent Mickf29f47b2000-08-11 19:02:59 +0000816 quiet -- if true, don't print 'skipped' messages (probably redundant)
Christian Heimesb186d002008-03-18 15:15:01 +0000817 test_times -- a list of (time, test_name) pairs
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000818 huntrleaks -- run multiple times to test for leaks; requires a debug
819 build; a triple corresponding to -R's three arguments
Antoine Pitrou293954d2011-03-23 23:01:49 +0100820 rerun_failed -- if true, re-run in verbose mode when failed
Victor Stinner0cc8d592011-03-31 18:10:13 +0200821 timeout -- dump the traceback and exit if a test takes more than
822 timeout seconds
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000823
824 Returns one of the test result constants:
825 INTERRUPTED KeyboardInterrupt when run under -j
826 RESOURCE_DENIED test skipped because resource denied
827 SKIPPED test skipped for some other reason
828 ENV_CHANGED test failed because it changed the execution environment
829 FAILED test failed
830 PASSED test passed
Guido van Rossum6fd83b71998-08-01 17:04:08 +0000831 """
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000832
Antoine Pitrou88909542009-06-29 13:54:42 +0000833 support.verbose = verbose # Tell tests to be moderately quiet
834 if use_resources is not None:
835 support.use_resources = use_resources
Victor Stinner30196882011-06-03 12:53:26 +0200836 use_timeout = (timeout is not None)
Victor Stinner7d648a02011-03-31 18:27:50 +0200837 if use_timeout:
Victor Stinner0cc8d592011-03-31 18:10:13 +0200838 faulthandler.dump_tracebacks_later(timeout, exit=True)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000839 try:
Antoine Pitrou293954d2011-03-23 23:01:49 +0100840 result = runtest_inner(test, verbose, quiet, huntrleaks, debug)
841 if result[0] == FAILED and rerun_failed:
842 cleanup_test_droppings(test, verbose)
843 sys.stdout.flush()
844 sys.stderr.flush()
845 print("Re-running test {} in verbose mode".format(test))
Victor Stinner0cc8d592011-03-31 18:10:13 +0200846 runtest(test, True, quiet, huntrleaks, debug, timeout=timeout)
Antoine Pitrou293954d2011-03-23 23:01:49 +0100847 return result
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000848 finally:
Victor Stinner7d648a02011-03-31 18:27:50 +0200849 if use_timeout:
Victor Stinner0cc8d592011-03-31 18:10:13 +0200850 faulthandler.cancel_dump_tracebacks_later()
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000851 cleanup_test_droppings(test, verbose)
852
Nick Coghlan6ead5522009-10-18 13:19:33 +0000853# Unit tests are supposed to leave the execution environment unchanged
854# once they complete. But sometimes tests have bugs, especially when
855# tests fail, and the changes to environment go on to mess up other
856# tests. This can cause issues with buildbot stability, since tests
857# are run in random order and so problems may appear to come and go.
858# There are a few things we can save and restore to mitigate this, and
859# the following context manager handles this task.
860
861class saved_test_environment:
862 """Save bits of the test environment and restore them at block exit.
863
864 with saved_test_environment(testname, verbose, quiet):
865 #stuff
866
867 Unless quiet is True, a warning is printed to stderr if any of
868 the saved items was changed by the test. The attribute 'changed'
869 is initially False, but is set to True if a change is detected.
870
871 If verbose is more than 1, the before and after state of changed
872 items is also printed.
873 """
874
875 changed = False
876
877 def __init__(self, testname, verbose=0, quiet=False):
878 self.testname = testname
879 self.verbose = verbose
880 self.quiet = quiet
881
882 # To add things to save and restore, add a name XXX to the resources list
883 # and add corresponding get_XXX/restore_XXX functions. get_XXX should
884 # return the value to be saved and compared against a second call to the
885 # get function when test execution completes. restore_XXX should accept
886 # the saved value and restore the resource using it. It will be called if
887 # and only if a change in the value is detected.
888 #
889 # Note: XXX will have any '.' replaced with '_' characters when determining
890 # the corresponding method names.
891
892 resources = ('sys.argv', 'cwd', 'sys.stdin', 'sys.stdout', 'sys.stderr',
Brett Cannon29c0e4f2010-03-20 22:22:57 +0000893 'os.environ', 'sys.path', 'sys.path_hooks', '__import__',
Nick Coghlan7bd5dbe2010-12-05 07:17:25 +0000894 'warnings.filters', 'asyncore.socket_map',
Ezio Melotti45763d02011-03-20 15:34:28 +0200895 'logging._handlers', 'logging._handlerList', 'sys.gettrace',
Ezio Melotti0123e052011-03-20 15:09:26 +0200896 'sys.warnoptions')
Nick Coghlan6ead5522009-10-18 13:19:33 +0000897
898 def get_sys_argv(self):
899 return id(sys.argv), sys.argv, sys.argv[:]
900 def restore_sys_argv(self, saved_argv):
901 sys.argv = saved_argv[1]
902 sys.argv[:] = saved_argv[2]
903
904 def get_cwd(self):
905 return os.getcwd()
906 def restore_cwd(self, saved_cwd):
907 os.chdir(saved_cwd)
908
909 def get_sys_stdout(self):
910 return sys.stdout
911 def restore_sys_stdout(self, saved_stdout):
912 sys.stdout = saved_stdout
913
914 def get_sys_stderr(self):
915 return sys.stderr
916 def restore_sys_stderr(self, saved_stderr):
917 sys.stderr = saved_stderr
918
919 def get_sys_stdin(self):
920 return sys.stdin
921 def restore_sys_stdin(self, saved_stdin):
922 sys.stdin = saved_stdin
923
924 def get_os_environ(self):
925 return id(os.environ), os.environ, dict(os.environ)
926 def restore_os_environ(self, saved_environ):
927 os.environ = saved_environ[1]
928 os.environ.clear()
929 os.environ.update(saved_environ[2])
930
931 def get_sys_path(self):
932 return id(sys.path), sys.path, sys.path[:]
933 def restore_sys_path(self, saved_path):
934 sys.path = saved_path[1]
935 sys.path[:] = saved_path[2]
936
Brett Cannon055470a2010-02-19 15:57:10 +0000937 def get_sys_path_hooks(self):
938 return id(sys.path_hooks), sys.path_hooks, sys.path_hooks[:]
939 def restore_sys_path_hooks(self, saved_hooks):
940 sys.path_hooks = saved_hooks[1]
941 sys.path_hooks[:] = saved_hooks[2]
942
Brett Cannon31f59292011-02-21 19:29:56 +0000943 def get_sys_gettrace(self):
944 return sys.gettrace()
945 def restore_sys_gettrace(self, trace_fxn):
946 sys.settrace(trace_fxn)
947
Brett Cannon055470a2010-02-19 15:57:10 +0000948 def get___import__(self):
Brett Cannon45071902010-06-14 22:22:54 +0000949 return builtins.__import__
Brett Cannon055470a2010-02-19 15:57:10 +0000950 def restore___import__(self, import_):
Brett Cannon45071902010-06-14 22:22:54 +0000951 builtins.__import__ = import_
Brett Cannon055470a2010-02-19 15:57:10 +0000952
Brett Cannon29c0e4f2010-03-20 22:22:57 +0000953 def get_warnings_filters(self):
954 return id(warnings.filters), warnings.filters, warnings.filters[:]
955 def restore_warnings_filters(self, saved_filters):
956 warnings.filters = saved_filters[1]
957 warnings.filters[:] = saved_filters[2]
958
Antoine Pitroub14ac8c2010-08-16 00:28:05 +0000959 def get_asyncore_socket_map(self):
960 asyncore = sys.modules.get('asyncore')
Antoine Pitrouaa879652010-10-29 11:54:38 +0000961 # XXX Making a copy keeps objects alive until __exit__ gets called.
962 return asyncore and asyncore.socket_map.copy() or {}
Antoine Pitroub14ac8c2010-08-16 00:28:05 +0000963 def restore_asyncore_socket_map(self, saved_map):
964 asyncore = sys.modules.get('asyncore')
965 if asyncore is not None:
Antoine Pitrouaa879652010-10-29 11:54:38 +0000966 asyncore.close_all(ignore_all=True)
Antoine Pitroub14ac8c2010-08-16 00:28:05 +0000967 asyncore.socket_map.update(saved_map)
968
Nick Coghlan7d819752010-12-05 06:45:03 +0000969 def get_logging__handlers(self):
970 # _handlers is a WeakValueDictionary
Nick Coghlan7bd5dbe2010-12-05 07:17:25 +0000971 return id(logging._handlers), logging._handlers, logging._handlers.copy()
Nick Coghlan7d819752010-12-05 06:45:03 +0000972 def restore_logging__handlers(self, saved_handlers):
973 # Can't easily revert the logging state
974 pass
975
Nick Coghlan7bd5dbe2010-12-05 07:17:25 +0000976 def get_logging__handlerList(self):
977 # _handlerList is a list of weakrefs to handlers
978 return id(logging._handlerList), logging._handlerList, logging._handlerList[:]
979 def restore_logging__handlerList(self, saved_handlerList):
980 # Can't easily revert the logging state
981 pass
982
Ezio Melotti0123e052011-03-20 15:09:26 +0200983 def get_sys_warnoptions(self):
984 return id(sys.warnoptions), sys.warnoptions, sys.warnoptions[:]
985 def restore_sys_warnoptions(self, saved_options):
986 sys.warnoptions = saved_options[1]
987 sys.warnoptions[:] = saved_options[2]
988
Nick Coghlan6ead5522009-10-18 13:19:33 +0000989 def resource_info(self):
990 for name in self.resources:
991 method_suffix = name.replace('.', '_')
992 get_name = 'get_' + method_suffix
993 restore_name = 'restore_' + method_suffix
994 yield name, getattr(self, get_name), getattr(self, restore_name)
995
996 def __enter__(self):
997 self.saved_values = dict((name, get()) for name, get, restore
998 in self.resource_info())
999 return self
1000
1001 def __exit__(self, exc_type, exc_val, exc_tb):
Antoine Pitrouaa879652010-10-29 11:54:38 +00001002 saved_values = self.saved_values
1003 del self.saved_values
Nick Coghlan6ead5522009-10-18 13:19:33 +00001004 for name, get, restore in self.resource_info():
1005 current = get()
Antoine Pitrouaa879652010-10-29 11:54:38 +00001006 original = saved_values.pop(name)
Nick Coghlan6ead5522009-10-18 13:19:33 +00001007 # Check for changes to the resource's value
1008 if current != original:
1009 self.changed = True
1010 restore(original)
1011 if not self.quiet:
1012 print("Warning -- {} was modified by {}".format(
1013 name, self.testname),
1014 file=sys.stderr)
1015 if self.verbose > 1:
1016 print(" Before: {}\n After: {} ".format(
1017 original, current),
1018 file=sys.stderr)
1019 return False
1020
1021
R. David Murray8e286c42010-12-27 20:09:32 +00001022def runtest_inner(test, verbose, quiet, huntrleaks=False, debug=False):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001023 support.unload(test)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001024
Antoine Pitrou88909542009-06-29 13:54:42 +00001025 test_time = 0.0
Collin Wintera5503d52009-05-15 01:20:21 +00001026 refleak = False # True if the test leaked references.
Guido van Rossum152494a1996-12-20 03:12:20 +00001027 try:
R. David Murray0bc11ae2009-10-18 22:18:17 +00001028 if test.startswith('test.'):
1029 abstest = test
1030 else:
1031 # Always import it from the test package
1032 abstest = 'test.' + test
1033 with saved_test_environment(test, verbose, quiet) as environment:
1034 start_time = time.time()
1035 the_package = __import__(abstest, globals(), locals(), [])
1036 the_module = getattr(the_package, test)
1037 # Old tests run to completion simply as a side-effect of
1038 # being imported. For tests based on unittest or doctest,
1039 # explicitly invoke their test_main() function (if it exists).
1040 indirect_test = getattr(the_module, "test_main", None)
1041 if indirect_test is not None:
1042 indirect_test()
1043 if huntrleaks:
1044 refleak = dash_R(the_module, test, indirect_test,
1045 huntrleaks)
1046 test_time = time.time() - start_time
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001047 except support.ResourceDenied as msg:
Fred Drake9a0db072003-02-03 15:19:30 +00001048 if not quiet:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001049 print(test, "skipped --", msg)
Fred Drake9a0db072003-02-03 15:19:30 +00001050 sys.stdout.flush()
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001051 return RESOURCE_DENIED, test_time
R. David Murraya21e4ca2009-03-31 23:16:50 +00001052 except unittest.SkipTest as msg:
Trent Mickf29f47b2000-08-11 19:02:59 +00001053 if not quiet:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001054 print(test, "skipped --", msg)
Guido van Rossum3cda93e2002-09-13 21:28:03 +00001055 sys.stdout.flush()
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001056 return SKIPPED, test_time
Fred Drakefe5c22a2000-08-18 16:04:05 +00001057 except KeyboardInterrupt:
1058 raise
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001059 except support.TestFailed as msg:
R. David Murray11cabcf2010-09-29 01:08:05 +00001060 print("test", test, "failed --", msg, file=sys.stderr)
1061 sys.stderr.flush()
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001062 return FAILED, test_time
Guido van Rossum9e48b271997-07-16 01:56:13 +00001063 except:
Antoine Pitrou779a5b02011-03-21 19:55:16 +01001064 msg = traceback.format_exc()
1065 print("test", test, "crashed --", msg, file=sys.stderr)
R. David Murray11cabcf2010-09-29 01:08:05 +00001066 sys.stderr.flush()
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001067 return FAILED, test_time
Guido van Rossum152494a1996-12-20 03:12:20 +00001068 else:
Collin Wintera5503d52009-05-15 01:20:21 +00001069 if refleak:
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001070 return FAILED, test_time
Nick Coghlan6ead5522009-10-18 13:19:33 +00001071 if environment.changed:
Benjamin Petersona0dfa822009-11-13 02:25:08 +00001072 return ENV_CHANGED, test_time
1073 return PASSED, test_time
Guido van Rossum0fcca4e2001-09-21 20:31:52 +00001074
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001075def cleanup_test_droppings(testname, verbose):
1076 import shutil
Benjamin Peterson25c95f12009-05-08 20:42:26 +00001077 import stat
Antoine Pitrouc14efc42010-10-29 19:34:45 +00001078 import gc
1079
1080 # First kill any dangling references to open files etc.
1081 # This can also issue some ResourceWarnings which would otherwise get
Antoine Pitrou2b40efd2010-10-29 19:36:37 +00001082 # triggered during the following test run, and possibly produce failures.
Antoine Pitrouc14efc42010-10-29 19:34:45 +00001083 gc.collect()
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001084
1085 # Try to clean up junk commonly left behind. While tests shouldn't leave
1086 # any files or directories behind, when a test fails that can be tedious
1087 # for it to arrange. The consequences can be especially nasty on Windows,
1088 # since if a test leaves a file open, it cannot be deleted by name (while
1089 # there's nothing we can do about that here either, we can display the
1090 # name of the offending test, which is a real help).
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001091 for name in (support.TESTFN,
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001092 "db_home",
1093 ):
1094 if not os.path.exists(name):
1095 continue
1096
1097 if os.path.isdir(name):
1098 kind, nuker = "directory", shutil.rmtree
1099 elif os.path.isfile(name):
1100 kind, nuker = "file", os.unlink
1101 else:
1102 raise SystemError("os.path says %r exists but is neither "
1103 "directory nor file" % name)
1104
1105 if verbose:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001106 print("%r left behind %s %r" % (testname, kind, name))
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001107 try:
Benjamin Peterson25c95f12009-05-08 20:42:26 +00001108 # if we have chmod, fix possible permissions problems
1109 # that might prevent cleanup
1110 if (hasattr(os, 'chmod')):
1111 os.chmod(name, stat.S_IRWXU | stat.S_IRWXG | stat.S_IRWXO)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001112 nuker(name)
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001113 except Exception as msg:
1114 print(("%r left behind %s %r and it couldn't be "
1115 "removed: %s" % (testname, kind, name, msg)), file=sys.stderr)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001116
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001117def dash_R(the_module, test, indirect_test, huntrleaks):
Collin Wintera5503d52009-05-15 01:20:21 +00001118 """Run a test multiple times, looking for reference leaks.
1119
1120 Returns:
1121 False if the test didn't leak references; True if we detected refleaks.
1122 """
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001123 # This code is hackish and inelegant, but it seems to do the job.
Raymond Hettinger158c9c22011-02-22 00:41:50 +00001124 import copyreg
1125 import collections.abc
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001126
1127 if not hasattr(sys, 'gettotalrefcount'):
1128 raise Exception("Tracking reference leaks requires a debug build "
1129 "of Python")
1130
1131 # Save current values for dash_R_cleanup() to restore.
1132 fs = warnings.filters[:]
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +00001133 ps = copyreg.dispatch_table.copy()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001134 pic = sys.path_importer_cache.copy()
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001135 try:
1136 import zipimport
1137 except ImportError:
1138 zdc = None # Run unmodified on platforms without zipimport support
1139 else:
1140 zdc = zipimport._zip_directory_cache.copy()
Christian Heimes93852662007-12-01 12:22:32 +00001141 abcs = {}
Raymond Hettinger158c9c22011-02-22 00:41:50 +00001142 for abc in [getattr(collections.abc, a) for a in collections.abc.__all__]:
Christian Heimesbe5b30b2008-03-03 19:18:51 +00001143 if not isabstract(abc):
Christian Heimes93852662007-12-01 12:22:32 +00001144 continue
1145 for obj in abc.__subclasses__() + [abc]:
1146 abcs[obj] = obj._abc_registry.copy()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001147
1148 if indirect_test:
1149 def run_the_test():
1150 indirect_test()
1151 else:
1152 def run_the_test():
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001153 del sys.modules[the_module.__name__]
1154 exec('import ' + the_module.__name__)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001155
1156 deltas = []
1157 nwarmup, ntracked, fname = huntrleaks
Ezio Melotti184bdfb2010-02-18 09:37:05 +00001158 fname = os.path.join(support.SAVEDCWD, fname)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001159 repcount = nwarmup + ntracked
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001160 print("beginning", repcount, "repetitions", file=sys.stderr)
1161 print(("1234567890"*(repcount//10 + 1))[:repcount], file=sys.stderr)
Antoine Pitrou88909542009-06-29 13:54:42 +00001162 sys.stderr.flush()
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001163 dash_R_cleanup(fs, ps, pic, zdc, abcs)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001164 for i in range(repcount):
Collin Winter58bee592010-03-17 02:08:57 +00001165 rc_before = sys.gettotalrefcount()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001166 run_the_test()
1167 sys.stderr.write('.')
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001168 sys.stderr.flush()
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001169 dash_R_cleanup(fs, ps, pic, zdc, abcs)
Collin Winter58bee592010-03-17 02:08:57 +00001170 rc_after = sys.gettotalrefcount()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001171 if i >= nwarmup:
Collin Winter58bee592010-03-17 02:08:57 +00001172 deltas.append(rc_after - rc_before)
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001173 print(file=sys.stderr)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001174 if any(deltas):
Guido van Rossum360e4b82007-05-14 22:51:27 +00001175 msg = '%s leaked %s references, sum=%s' % (test, deltas, sum(deltas))
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001176 print(msg, file=sys.stderr)
Antoine Pitrou88909542009-06-29 13:54:42 +00001177 sys.stderr.flush()
1178 with open(fname, "a") as refrep:
1179 print(msg, file=refrep)
1180 refrep.flush()
Collin Wintera5503d52009-05-15 01:20:21 +00001181 return True
1182 return False
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001183
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001184def dash_R_cleanup(fs, ps, pic, zdc, abcs):
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +00001185 import gc, copyreg
Brett Cannonf4fd9932008-05-10 21:11:46 +00001186 import _strptime, linecache
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001187 import urllib.parse, urllib.request, mimetypes, doctest
Raymond Hettinger158c9c22011-02-22 00:41:50 +00001188 import struct, filecmp, collections.abc
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001189 from distutils.dir_util import _path_created
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001190 from weakref import WeakSet
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001191
Christian Heimesdae2a892008-04-19 00:55:37 +00001192 # Clear the warnings registry, so they can be displayed again
1193 for mod in sys.modules.values():
1194 if hasattr(mod, '__warningregistry__'):
1195 del mod.__warningregistry__
1196
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001197 # Restore some original values.
1198 warnings.filters[:] = fs
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +00001199 copyreg.dispatch_table.clear()
1200 copyreg.dispatch_table.update(ps)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001201 sys.path_importer_cache.clear()
1202 sys.path_importer_cache.update(pic)
Nick Coghlan260bd3e2009-11-16 06:49:25 +00001203 try:
1204 import zipimport
1205 except ImportError:
1206 pass # Run unmodified on platforms without zipimport support
1207 else:
1208 zipimport._zip_directory_cache.clear()
1209 zipimport._zip_directory_cache.update(zdc)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001210
Christian Heimes26855632008-01-27 23:50:43 +00001211 # clear type cache
Christian Heimes15ebc882008-02-04 18:48:49 +00001212 sys._clear_type_cache()
Christian Heimes26855632008-01-27 23:50:43 +00001213
Guido van Rossum3de862d2007-08-18 00:10:33 +00001214 # Clear ABC registries, restoring previously saved ABC registries.
Raymond Hettinger158c9c22011-02-22 00:41:50 +00001215 for abc in [getattr(collections.abc, a) for a in collections.abc.__all__]:
Christian Heimesbe5b30b2008-03-03 19:18:51 +00001216 if not isabstract(abc):
Christian Heimes941973a2007-11-30 21:53:03 +00001217 continue
Guido van Rossum7eaf8222007-06-18 17:58:50 +00001218 for obj in abc.__subclasses__() + [abc]:
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001219 obj._abc_registry = abcs.get(obj, WeakSet()).copy()
Guido van Rossumc1e315d2007-08-20 19:29:24 +00001220 obj._abc_cache.clear()
1221 obj._abc_negative_cache.clear()
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001222
Antoine Pitrou046467c2009-10-30 18:30:35 +00001223 # Flush standard output, so that buffered data is sent to the OS and
1224 # associated Python objects are reclaimed.
1225 for stream in (sys.stdout, sys.stderr, sys.__stdout__, sys.__stderr__):
1226 if stream is not None:
1227 stream.flush()
1228
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001229 # Clear assorted module caches.
1230 _path_created.clear()
1231 re.purge()
1232 _strptime._regex_cache.clear()
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001233 urllib.parse.clear_cache()
1234 urllib.request.urlcleanup()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001235 linecache.clearcache()
1236 mimetypes._default_mime_types()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001237 filecmp._cache.clear()
Christian Heimesa34706f2008-01-04 03:06:10 +00001238 struct._clearcache()
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001239 doctest.master = None
1240
1241 # Collect cyclic trash.
1242 gc.collect()
1243
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001244def warm_char_cache():
1245 s = bytes(range(256))
1246 for i in range(256):
1247 s[i:i+1]
1248
Florent Xiclunada7bfd52010-03-06 11:43:55 +00001249def findtestdir(path=None):
1250 return path or os.path.dirname(__file__) or os.curdir
Guido van Rossum152494a1996-12-20 03:12:20 +00001251
Florent Xiclunada7bfd52010-03-06 11:43:55 +00001252def removepy(names):
1253 if not names:
1254 return
1255 for idx, name in enumerate(names):
1256 basename, ext = os.path.splitext(name)
1257 if ext == '.py':
1258 names[idx] = basename
Tim Petersc5000df2002-06-02 21:42:01 +00001259
Guido van Rossum152494a1996-12-20 03:12:20 +00001260def count(n, word):
1261 if n == 1:
Guido van Rossum41360a41998-03-26 19:42:58 +00001262 return "%d %s" % (n, word)
Guido van Rossum152494a1996-12-20 03:12:20 +00001263 else:
Guido van Rossum41360a41998-03-26 19:42:58 +00001264 return "%d %ss" % (n, word)
Guido van Rossum152494a1996-12-20 03:12:20 +00001265
Tim Petersa45da922001-08-12 03:45:50 +00001266def printlist(x, width=70, indent=4):
Tim Peters7c7efe92002-08-23 17:55:54 +00001267 """Print the elements of iterable x to stdout.
Tim Petersa45da922001-08-12 03:45:50 +00001268
1269 Optional arg width (default 70) is the maximum line length.
1270 Optional arg indent (default 4) is the number of blanks with which to
1271 begin each line.
1272 """
1273
Tim Petersba78bc42002-07-04 19:45:06 +00001274 from textwrap import fill
1275 blanks = ' ' * indent
Florent Xiclunafd1b0932010-03-28 00:25:02 +00001276 # Print the sorted list: 'x' may be a '--random' list or a set()
1277 print(fill(' '.join(str(elt) for elt in sorted(x)), width,
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001278 initial_indent=blanks, subsequent_indent=blanks))
Tim Petersa45da922001-08-12 03:45:50 +00001279
Tim Petersde14a302002-04-01 05:04:46 +00001280# Map sys.platform to a string containing the basenames of tests
1281# expected to be skipped on that platform.
Tim Peters2a182db2002-10-09 01:07:11 +00001282#
1283# Special cases:
1284# test_pep277
1285# The _ExpectedSkips constructor adds this to the set of expected
1286# skips if not os.path.supports_unicode_filenames.
Neal Norwitz55b61d22003-02-28 19:57:03 +00001287# test_timeout
1288# Controlled by test_timeout.skip_expected. Requires the network
1289# resource and a socket module.
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001290#
1291# Tests that are expected to be skipped everywhere except on one platform
1292# are also handled separately.
Tim Petersde14a302002-04-01 05:04:46 +00001293
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001294_expectations = {
1295 'win32':
1296 """
Tim Petersc7c516a2003-09-20 22:06:13 +00001297 test__locale
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001298 test_crypt
Tim Petersd7030572001-10-22 22:06:08 +00001299 test_curses
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001300 test_dbm
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001301 test_fcntl
1302 test_fork1
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001303 test_epoll
Benjamin Peterson4d480532008-05-26 19:08:31 +00001304 test_dbm_gnu
Kristján Valur Jónsson42a40c52009-04-01 11:28:47 +00001305 test_dbm_ndbm
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001306 test_grp
Tim Petersfd8e6e52003-03-04 00:26:38 +00001307 test_ioctl
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001308 test_largefile
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001309 test_kqueue
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001310 test_openpty
Tim Petersefc4b122002-12-10 18:47:56 +00001311 test_ossaudiodev
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001312 test_pipes
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001313 test_poll
Tim Peters003eb302003-02-17 21:48:48 +00001314 test_posix
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001315 test_pty
1316 test_pwd
Tim Peters1e33ffa2002-04-23 23:09:02 +00001317 test_resource
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001318 test_signal
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001319 test_syslog
Tim Peterscea2cc42004-08-04 02:32:03 +00001320 test_threadsignals
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001321 test_wait3
1322 test_wait4
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001323 """,
1324 'linux2':
1325 """
Guido van Rossumf66dacd2001-10-23 15:10:55 +00001326 test_curses
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001327 test_largefile
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001328 test_kqueue
Guido van Rossum4507ec72003-02-14 19:29:22 +00001329 test_ossaudiodev
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001330 """,
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001331 'unixware7':
Martin v. Löwis0ace3262001-09-05 14:38:48 +00001332 """
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001333 test_epoll
Martin v. Löwis0ace3262001-09-05 14:38:48 +00001334 test_largefile
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001335 test_kqueue
Martin v. Löwis0ace3262001-09-05 14:38:48 +00001336 test_minidom
Martin v. Löwis0ace3262001-09-05 14:38:48 +00001337 test_openpty
1338 test_pyexpat
1339 test_sax
Martin v. Löwis0ace3262001-09-05 14:38:48 +00001340 test_sundry
Martin v. Löwis0ace3262001-09-05 14:38:48 +00001341 """,
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001342 'openunix8':
1343 """
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001344 test_epoll
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001345 test_largefile
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001346 test_kqueue
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001347 test_minidom
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001348 test_openpty
1349 test_pyexpat
1350 test_sax
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001351 test_sundry
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001352 """,
1353 'sco_sv3':
1354 """
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001355 test_asynchat
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001356 test_fork1
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001357 test_epoll
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001358 test_gettext
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001359 test_largefile
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001360 test_locale
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001361 test_kqueue
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001362 test_minidom
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001363 test_openpty
1364 test_pyexpat
1365 test_queue
1366 test_sax
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001367 test_sundry
1368 test_thread
1369 test_threaded_import
1370 test_threadedtempfile
1371 test_threading
Martin v. Löwis21ee4092002-09-30 16:19:48 +00001372 """,
Jack Jansen8a97f4a2001-12-05 23:27:32 +00001373 'darwin':
Jack Jansen398c2362001-12-02 21:41:36 +00001374 """
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001375 test__locale
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001376 test_curses
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001377 test_epoll
Benjamin Peterson4d480532008-05-26 19:08:31 +00001378 test_dbm_gnu
Skip Montanaro97019ff2010-10-25 01:35:48 +00001379 test_gdb
Jack Jansen398c2362001-12-02 21:41:36 +00001380 test_largefile
Jack Jansenacda3392002-12-30 23:03:13 +00001381 test_locale
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001382 test_minidom
Jack Jansenacda3392002-12-30 23:03:13 +00001383 test_ossaudiodev
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001384 test_poll
Jack Jansen398c2362001-12-02 21:41:36 +00001385 """,
Guido van Rossum11c3f092002-07-17 15:08:24 +00001386 'sunos5':
1387 """
Guido van Rossum11c3f092002-07-17 15:08:24 +00001388 test_curses
1389 test_dbm
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001390 test_epoll
1391 test_kqueue
Benjamin Peterson4d480532008-05-26 19:08:31 +00001392 test_dbm_gnu
Guido van Rossum11c3f092002-07-17 15:08:24 +00001393 test_gzip
Guido van Rossum11c3f092002-07-17 15:08:24 +00001394 test_openpty
Guido van Rossum11c3f092002-07-17 15:08:24 +00001395 test_zipfile
1396 test_zlib
Jeremy Hyltoned375e12002-07-17 15:56:55 +00001397 """,
Skip Montanarob3230212002-03-15 02:54:03 +00001398 'hp-ux11':
1399 """
Skip Montanarob3230212002-03-15 02:54:03 +00001400 test_curses
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001401 test_epoll
Benjamin Peterson4d480532008-05-26 19:08:31 +00001402 test_dbm_gnu
Skip Montanarob3230212002-03-15 02:54:03 +00001403 test_gzip
Skip Montanarob3230212002-03-15 02:54:03 +00001404 test_largefile
Skip Montanarob3230212002-03-15 02:54:03 +00001405 test_locale
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001406 test_kqueue
Skip Montanarob3230212002-03-15 02:54:03 +00001407 test_minidom
Skip Montanarob3230212002-03-15 02:54:03 +00001408 test_openpty
1409 test_pyexpat
1410 test_sax
Skip Montanarob3230212002-03-15 02:54:03 +00001411 test_zipfile
1412 test_zlib
1413 """,
Jason Tishler25115942002-12-05 15:18:15 +00001414 'cygwin':
1415 """
Jason Tishler25115942002-12-05 15:18:15 +00001416 test_curses
1417 test_dbm
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001418 test_epoll
Jason Tishlerc23f39c2003-07-22 18:35:58 +00001419 test_ioctl
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001420 test_kqueue
Jason Tishler25115942002-12-05 15:18:15 +00001421 test_largefile
Jason Tishler25115942002-12-05 15:18:15 +00001422 test_locale
Jason Tishler5c4ded22003-02-05 16:46:01 +00001423 test_ossaudiodev
Jason Tishler25115942002-12-05 15:18:15 +00001424 test_socketserver
Jason Tishler25115942002-12-05 15:18:15 +00001425 """,
Andrew MacIntyrefd07e7d2002-12-31 11:26:50 +00001426 'os2emx':
1427 """
Andrew MacIntyrefd07e7d2002-12-31 11:26:50 +00001428 test_audioop
Andrew MacIntyrefd07e7d2002-12-31 11:26:50 +00001429 test_curses
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001430 test_epoll
1431 test_kqueue
Andrew MacIntyrefd07e7d2002-12-31 11:26:50 +00001432 test_largefile
Andrew MacIntyrefd07e7d2002-12-31 11:26:50 +00001433 test_mmap
Andrew MacIntyrefd07e7d2002-12-31 11:26:50 +00001434 test_openpty
1435 test_ossaudiodev
1436 test_pty
1437 test_resource
1438 test_signal
Andrew MacIntyrefd07e7d2002-12-31 11:26:50 +00001439 """,
Guido van Rossum944a6c32003-11-20 22:11:29 +00001440 'freebsd4':
1441 """
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001442 test_epoll
Benjamin Peterson4d480532008-05-26 19:08:31 +00001443 test_dbm_gnu
Guido van Rossum944a6c32003-11-20 22:11:29 +00001444 test_locale
Guido van Rossum944a6c32003-11-20 22:11:29 +00001445 test_ossaudiodev
1446 test_pep277
Hye-Shik Changf64700a2004-08-18 15:13:41 +00001447 test_pty
Guido van Rossum944a6c32003-11-20 22:11:29 +00001448 test_socketserver
Hye-Shik Changf64700a2004-08-18 15:13:41 +00001449 test_tcl
Guilherme Poloa91790a2009-02-09 20:40:42 +00001450 test_tk
Guilherme Polo9de29af2009-01-28 20:40:48 +00001451 test_ttk_guionly
1452 test_ttk_textonly
Guido van Rossum944a6c32003-11-20 22:11:29 +00001453 test_timeout
Guido van Rossum944a6c32003-11-20 22:11:29 +00001454 test_urllibnet
Benjamin Petersone5384b02008-10-04 22:00:42 +00001455 test_multiprocessing
Martin v. Löwis56f88112003-06-07 20:01:37 +00001456 """,
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +00001457 'aix5':
1458 """
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +00001459 test_bz2
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001460 test_epoll
Benjamin Peterson4d480532008-05-26 19:08:31 +00001461 test_dbm_gnu
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +00001462 test_gzip
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001463 test_kqueue
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +00001464 test_ossaudiodev
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +00001465 test_tcl
Guilherme Poloa91790a2009-02-09 20:40:42 +00001466 test_tk
Guilherme Polo9de29af2009-01-28 20:40:48 +00001467 test_ttk_guionly
1468 test_ttk_textonly
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +00001469 test_zipimport
1470 test_zlib
1471 """,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001472 'openbsd3':
1473 """
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001474 test_ctypes
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001475 test_epoll
Benjamin Peterson4d480532008-05-26 19:08:31 +00001476 test_dbm_gnu
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001477 test_locale
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001478 test_normalization
1479 test_ossaudiodev
1480 test_pep277
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001481 test_tcl
Guilherme Poloa91790a2009-02-09 20:40:42 +00001482 test_tk
Guilherme Polo9de29af2009-01-28 20:40:48 +00001483 test_ttk_guionly
1484 test_ttk_textonly
Benjamin Petersone5384b02008-10-04 22:00:42 +00001485 test_multiprocessing
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001486 """,
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001487 'netbsd3':
1488 """
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001489 test_ctypes
1490 test_curses
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001491 test_epoll
Benjamin Peterson4d480532008-05-26 19:08:31 +00001492 test_dbm_gnu
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001493 test_locale
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001494 test_ossaudiodev
1495 test_pep277
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001496 test_tcl
Guilherme Poloa91790a2009-02-09 20:40:42 +00001497 test_tk
Guilherme Polo9de29af2009-01-28 20:40:48 +00001498 test_ttk_guionly
1499 test_ttk_textonly
Benjamin Petersone5384b02008-10-04 22:00:42 +00001500 test_multiprocessing
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001501 """,
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001502}
Martin v. Löwis32d0c1b2004-07-26 12:09:13 +00001503_expectations['freebsd5'] = _expectations['freebsd4']
Hye-Shik Changf64700a2004-08-18 15:13:41 +00001504_expectations['freebsd6'] = _expectations['freebsd4']
Hye-Shik Chang4e422812005-07-17 02:36:59 +00001505_expectations['freebsd7'] = _expectations['freebsd4']
Guido van Rossum8ce8a782007-11-01 19:42:39 +00001506_expectations['freebsd8'] = _expectations['freebsd4']
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001507
Tim Petersb5b7b782001-08-12 01:20:39 +00001508class _ExpectedSkips:
1509 def __init__(self):
Tim Peters2a182db2002-10-09 01:07:11 +00001510 import os.path
Neal Norwitz55b61d22003-02-28 19:57:03 +00001511 from test import test_timeout
Tim Peters1b445d32002-11-24 18:53:11 +00001512
Tim Peters7c7efe92002-08-23 17:55:54 +00001513 self.valid = False
Tim Petersde14a302002-04-01 05:04:46 +00001514 if sys.platform in _expectations:
Guido van Rossumf73e30c2001-08-12 02:22:19 +00001515 s = _expectations[sys.platform]
Raymond Hettingera690a992003-11-16 16:17:49 +00001516 self.expected = set(s.split())
Tim Peters1b445d32002-11-24 18:53:11 +00001517
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001518 # These are broken tests, for now skipped on every platform.
1519 # XXX Fix these!
Benjamin Petersone9ea19e2008-08-19 23:02:38 +00001520 self.expected.add('test_nis')
Benjamin Peterson4fde0c42008-03-31 02:36:22 +00001521
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001522 # expected to be skipped on every platform, even Linux
Tim Peters2a182db2002-10-09 01:07:11 +00001523 if not os.path.supports_unicode_filenames:
1524 self.expected.add('test_pep277')
Tim Peters1b445d32002-11-24 18:53:11 +00001525
Neal Norwitz94fa2ee2008-03-31 02:55:15 +00001526 # doctest, profile and cProfile tests fail when the codec for the
1527 # fs encoding isn't built in because PyUnicode_Decode() adds two
1528 # calls into Python.
1529 encs = ("utf-8", "latin-1", "ascii", "mbcs", "utf-16", "utf-32")
1530 if sys.getfilesystemencoding().lower() not in encs:
1531 self.expected.add('test_profile')
1532 self.expected.add('test_cProfile')
1533 self.expected.add('test_doctest')
Guido van Rossumdaa251c2007-10-25 23:47:33 +00001534
Neal Norwitz55b61d22003-02-28 19:57:03 +00001535 if test_timeout.skip_expected:
1536 self.expected.add('test_timeout')
1537
Tim Petersecd79eb2003-01-29 00:35:32 +00001538 if sys.platform != "win32":
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001539 # test_sqlite is only reliable on Windows where the library
1540 # is distributed with Python
Benjamin Peterson54ad0be2010-10-29 21:33:10 +00001541 WIN_ONLY = {"test_unicode_file", "test_winreg",
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001542 "test_winsound", "test_startfile",
Ross Lagerwall226580e2011-04-09 20:05:04 +02001543 "test_sqlite", "test_msilib"}
Benjamin Peterson54ad0be2010-10-29 21:33:10 +00001544 self.expected |= WIN_ONLY
Tim Petersf2715e02003-02-19 02:35:07 +00001545
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001546 if sys.platform != 'sunos5':
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001547 self.expected.add('test_nis')
Guido van Rossumd59da4b2007-05-22 18:11:13 +00001548
Benjamin Peterson65c66ab2010-10-29 21:31:35 +00001549 if support.python_is_optimized():
1550 self.expected.add("test_gdb")
1551
Tim Peters7c7efe92002-08-23 17:55:54 +00001552 self.valid = True
Tim Petersb5b7b782001-08-12 01:20:39 +00001553
1554 def isvalid(self):
1555 "Return true iff _ExpectedSkips knows about the current platform."
1556 return self.valid
1557
1558 def getexpected(self):
1559 """Return set of test names we expect to skip on current platform.
1560
1561 self.isvalid() must be true.
1562 """
1563
1564 assert self.isvalid()
1565 return self.expected
1566
Michael Foord3ab34cc2010-12-03 12:27:40 +00001567def _make_temp_dir_for_build(TEMPDIR):
1568 # When tests are run from the Python build directory, it is best practice
1569 # to keep the test files in a subfolder. It eases the cleanup of leftover
1570 # files using command "make distclean".
1571 if sysconfig.is_python_build():
1572 TEMPDIR = os.path.join(sysconfig.get_config_var('srcdir'), 'build')
1573 TEMPDIR = os.path.abspath(TEMPDIR)
Antoine Pitrouee429342011-04-16 18:53:59 +02001574 try:
Michael Foord3ab34cc2010-12-03 12:27:40 +00001575 os.mkdir(TEMPDIR)
Antoine Pitrouee429342011-04-16 18:53:59 +02001576 except OSError as e:
1577 if e.errno != errno.EEXIST:
1578 raise
Michael Foord3ab34cc2010-12-03 12:27:40 +00001579
1580 # Define a writable temp dir that will be used as cwd while running
1581 # the tests. The name of the dir includes the pid to allow parallel
1582 # testing (see the -j option).
1583 TESTCWD = 'test_python_{}'.format(os.getpid())
1584
1585 TESTCWD = os.path.join(TEMPDIR, TESTCWD)
1586 return TEMPDIR, TESTCWD
Nick Coghlan4c4c0f22010-12-03 07:44:33 +00001587
Guido van Rossum152494a1996-12-20 03:12:20 +00001588if __name__ == '__main__':
Nick Coghlan4c4c0f22010-12-03 07:44:33 +00001589 # Remove regrtest.py's own directory from the module search path. Despite
1590 # the elimination of implicit relative imports, this is still needed to
1591 # ensure that submodules of the test package do not inappropriately appear
1592 # as top-level modules even when people (or buildbots!) invoke regrtest.py
1593 # directly instead of using the -m switch
1594 mydir = os.path.abspath(os.path.normpath(os.path.dirname(sys.argv[0])))
1595 i = len(sys.path)
1596 while i >= 0:
1597 i -= 1
1598 if os.path.abspath(os.path.normpath(sys.path[i])) == mydir:
1599 del sys.path[i]
1600
Florent Xiclunadc69e722010-09-13 16:35:02 +00001601 # findtestdir() gets the dirname out of __file__, so we have to make it
1602 # absolute before changing the working directory.
1603 # For example __file__ may be relative when running trace or profile.
1604 # See issue #9323.
1605 __file__ = os.path.abspath(__file__)
1606
1607 # sanity check
Florent Xiclunada7bfd52010-03-06 11:43:55 +00001608 assert __file__ == os.path.abspath(sys.argv[0])
Ezio Melotti184bdfb2010-02-18 09:37:05 +00001609
Michael Foord3ab34cc2010-12-03 12:27:40 +00001610 TEMPDIR, TESTCWD = _make_temp_dir_for_build(TEMPDIR)
Ezio Melotti184bdfb2010-02-18 09:37:05 +00001611
1612 # Run the tests in a context manager that temporary changes the CWD to a
1613 # temporary and writable directory. If it's not possible to create or
1614 # change the CWD, the original CWD will be used. The original CWD is
1615 # available from support.SAVEDCWD.
1616 with support.temp_cwd(TESTCWD, quiet=True):
1617 main()