blob: 0526b14fdbdf77f54cb7f8eba6866e2d0448c4c9 [file] [log] [blame]
Brett Cannonf1cfb622003-05-04 21:15:27 +00001"""Supporting definitions for the Python regression tests."""
Guido van Rossum3bead091992-01-27 17:00:37 +00002
Benjamin Petersonee8712c2008-05-20 21:35:26 +00003if __name__ != 'test.support':
4 raise ImportError('support must be imported from the test package')
Barry Warsaw408b6d32002-07-30 23:27:12 +00005
Guido van Rossumd8faa362007-04-27 19:54:29 +00006import contextlib
7import errno
Benjamin Petersonfa0d7032009-06-01 22:42:33 +00008import functools
Benjamin Peterson8cc7d882009-06-01 23:14:51 +00009import gc
Guido van Rossumd8faa362007-04-27 19:54:29 +000010import socket
Fred Drakecd1b1dd2001-03-21 18:26:33 +000011import sys
Guido van Rossumd8faa362007-04-27 19:54:29 +000012import os
Benjamin Petersone549ead2009-03-28 21:42:05 +000013import platform
Christian Heimes23daade2008-02-25 12:39:23 +000014import shutil
Thomas Wouters902d6eb2007-01-09 23:18:33 +000015import warnings
Guido van Rossumd8faa362007-04-27 19:54:29 +000016import unittest
R. David Murraya21e4ca2009-03-31 23:16:50 +000017import importlib
Walter Dörwald155374d2009-05-01 19:58:58 +000018import collections
Florent Xiclunab14930c2010-03-13 15:26:44 +000019import re
Brian Curtind40e6f72010-07-08 21:39:08 +000020import subprocess
Barry Warsaw28a691b2010-04-17 00:19:56 +000021import imp
Benjamin Petersona6590e82010-04-11 21:22:10 +000022import time
Benjamin Peterson65c66ab2010-10-29 21:31:35 +000023import sysconfig
Antoine Pitroub9c73e82011-07-29 23:53:38 +020024import fnmatch
Vinay Sajip129fd042010-12-10 08:19:38 +000025import logging.handlers
Benjamin Peterson65c66ab2010-10-29 21:31:35 +000026
Victor Stinner45df8202010-04-28 22:31:17 +000027try:
Antoine Pitrou707f2282011-07-15 22:29:44 +020028 import _thread, threading
Victor Stinner45df8202010-04-28 22:31:17 +000029except ImportError:
30 _thread = None
Antoine Pitrou707f2282011-07-15 22:29:44 +020031 threading = None
32try:
33 import multiprocessing.process
34except ImportError:
35 multiprocessing = None
36
Fred Drakecd1b1dd2001-03-21 18:26:33 +000037
Barry Warsaw28a691b2010-04-17 00:19:56 +000038__all__ = [
39 "Error", "TestFailed", "ResourceDenied", "import_module",
40 "verbose", "use_resources", "max_memuse", "record_original_stdout",
41 "get_original_stdout", "unload", "unlink", "rmtree", "forget",
Victor Stinner88701e22011-06-01 13:13:04 +020042 "is_resource_enabled", "requires", "requires_mac_ver",
43 "find_unused_port", "bind_port",
Barry Warsaw28a691b2010-04-17 00:19:56 +000044 "fcmp", "is_jython", "TESTFN", "HOST", "FUZZ", "SAVEDCWD", "temp_cwd",
45 "findfile", "sortdict", "check_syntax_error", "open_urlresource",
46 "check_warnings", "CleanImport", "EnvironmentVarGuard",
47 "TransientResource", "captured_output", "captured_stdout",
Ezio Melotti07352b02011-05-14 14:51:18 +030048 "captured_stdin", "captured_stderr",
Barry Warsaw28a691b2010-04-17 00:19:56 +000049 "time_out", "socket_peer_reset", "ioerror_peer_reset",
Antoine Pitroua88c83c2010-09-07 20:42:19 +000050 "run_with_locale", 'temp_umask', "transient_internet",
Barry Warsaw28a691b2010-04-17 00:19:56 +000051 "set_memlimit", "bigmemtest", "bigaddrspacetest", "BasicTestRunner",
52 "run_unittest", "run_doctest", "threading_setup", "threading_cleanup",
53 "reap_children", "cpython_only", "check_impl_detail", "get_attribute",
Vinay Sajip129fd042010-12-10 08:19:38 +000054 "swap_item", "swap_attr", "requires_IEEE_754",
Benjamin Peterson31dc3732011-05-08 15:34:24 -050055 "TestHandler", "Matcher", "can_symlink", "skip_unless_symlink",
Alexander Belopolsky2420d832012-04-29 15:56:49 -040056 "import_fresh_module", "failfast", "run_with_tz"
Antoine Pitrou4d7979b2010-09-07 21:22:56 +000057 ]
Florent Xiclunaf089fd62010-03-19 14:25:03 +000058
Fred Drake1790dd42000-07-24 06:55:00 +000059class Error(Exception):
Fred Drake004d5e62000-10-23 17:22:08 +000060 """Base class for regression test exceptions."""
Fred Drake1790dd42000-07-24 06:55:00 +000061
62class TestFailed(Error):
Fred Drake004d5e62000-10-23 17:22:08 +000063 """Test failed."""
Fred Drake1790dd42000-07-24 06:55:00 +000064
Benjamin Petersone549ead2009-03-28 21:42:05 +000065class ResourceDenied(unittest.SkipTest):
Fred Drake9a0db072003-02-03 15:19:30 +000066 """Test skipped because it requested a disallowed resource.
67
68 This is raised when a test calls requires() for a resource that
69 has not be enabled. It is used to distinguish between expected
70 and unexpected skips.
71 """
72
Nick Coghlanfce769e2009-04-11 14:30:59 +000073@contextlib.contextmanager
74def _ignore_deprecated_imports(ignore=True):
75 """Context manager to suppress package and module deprecation
76 warnings when importing them.
77
78 If ignore is False, this context manager has no effect."""
79 if ignore:
80 with warnings.catch_warnings():
81 warnings.filterwarnings("ignore", ".+ (module|package)",
82 DeprecationWarning)
83 yield
84 else:
85 yield
86
87
Benjamin Peterson699adb92008-05-08 22:27:58 +000088def import_module(name, deprecated=False):
R. David Murraya21e4ca2009-03-31 23:16:50 +000089 """Import and return the module to be tested, raising SkipTest if
90 it is not available.
91
92 If deprecated is True, any module or package deprecation messages
93 will be suppressed."""
Nick Coghlanfce769e2009-04-11 14:30:59 +000094 with _ignore_deprecated_imports(deprecated):
Benjamin Peterson699adb92008-05-08 22:27:58 +000095 try:
Nick Coghlanfce769e2009-04-11 14:30:59 +000096 return importlib.import_module(name)
R. David Murraya21e4ca2009-03-31 23:16:50 +000097 except ImportError as msg:
98 raise unittest.SkipTest(str(msg))
Nick Coghlanfce769e2009-04-11 14:30:59 +000099
100
Nick Coghlan47384702009-04-22 16:13:36 +0000101def _save_and_remove_module(name, orig_modules):
102 """Helper function to save and remove a module from sys.modules
103
Ezio Melotti199e0852011-05-09 06:41:55 +0300104 Raise ImportError if the module can't be imported."""
Ezio Melottifec3ad12011-05-14 06:02:25 +0300105 # try to import the module and raise an error if it can't be imported
106 if name not in sys.modules:
Ezio Melotti199e0852011-05-09 06:41:55 +0300107 __import__(name)
Nick Coghlan47384702009-04-22 16:13:36 +0000108 del sys.modules[name]
Ezio Melottifec3ad12011-05-14 06:02:25 +0300109 for modname in list(sys.modules):
110 if modname == name or modname.startswith(name + '.'):
111 orig_modules[modname] = sys.modules[modname]
112 del sys.modules[modname]
Nick Coghlan47384702009-04-22 16:13:36 +0000113
114def _save_and_block_module(name, orig_modules):
115 """Helper function to save and block a module in sys.modules
116
Ezio Melotti199e0852011-05-09 06:41:55 +0300117 Return True if the module was in sys.modules, False otherwise."""
Nick Coghlan47384702009-04-22 16:13:36 +0000118 saved = True
119 try:
120 orig_modules[name] = sys.modules[name]
121 except KeyError:
122 saved = False
Alexander Belopolsky903396e2010-07-13 14:50:16 +0000123 sys.modules[name] = None
Nick Coghlan47384702009-04-22 16:13:36 +0000124 return saved
125
126
127def import_fresh_module(name, fresh=(), blocked=(), deprecated=False):
Nick Coghlanfce769e2009-04-11 14:30:59 +0000128 """Imports and returns a module, deliberately bypassing the sys.modules cache
129 and importing a fresh copy of the module. Once the import is complete,
130 the sys.modules cache is restored to its original state.
131
Nick Coghlan47384702009-04-22 16:13:36 +0000132 Modules named in fresh are also imported anew if needed by the import.
Ezio Melotti199e0852011-05-09 06:41:55 +0300133 If one of these modules can't be imported, None is returned.
Nick Coghlan47384702009-04-22 16:13:36 +0000134
135 Importing of modules named in blocked is prevented while the fresh import
Nick Coghlanfce769e2009-04-11 14:30:59 +0000136 takes place.
137
138 If deprecated is True, any module or package deprecation messages
139 will be suppressed."""
Ezio Melotti6b60fb92011-05-14 06:47:51 +0300140 # NOTE: test_heapq, test_json and test_warnings include extra sanity checks
141 # to make sure that this utility function is working as expected
Nick Coghlanfce769e2009-04-11 14:30:59 +0000142 with _ignore_deprecated_imports(deprecated):
Nick Coghlan47384702009-04-22 16:13:36 +0000143 # Keep track of modules saved for later restoration as well
144 # as those which just need a blocking entry removed
Nick Coghlanfce769e2009-04-11 14:30:59 +0000145 orig_modules = {}
Nick Coghlan47384702009-04-22 16:13:36 +0000146 names_to_remove = []
147 _save_and_remove_module(name, orig_modules)
Nick Coghlanfce769e2009-04-11 14:30:59 +0000148 try:
Nick Coghlan47384702009-04-22 16:13:36 +0000149 for fresh_name in fresh:
150 _save_and_remove_module(fresh_name, orig_modules)
151 for blocked_name in blocked:
152 if not _save_and_block_module(blocked_name, orig_modules):
153 names_to_remove.append(blocked_name)
154 fresh_module = importlib.import_module(name)
Ezio Melotti199e0852011-05-09 06:41:55 +0300155 except ImportError:
156 fresh_module = None
Nick Coghlanfce769e2009-04-11 14:30:59 +0000157 finally:
Nick Coghlan47384702009-04-22 16:13:36 +0000158 for orig_name, module in orig_modules.items():
159 sys.modules[orig_name] = module
160 for name_to_remove in names_to_remove:
161 del sys.modules[name_to_remove]
162 return fresh_module
Nick Coghlanfce769e2009-04-11 14:30:59 +0000163
Benjamin Peterson699adb92008-05-08 22:27:58 +0000164
R. David Murraya21e4ca2009-03-31 23:16:50 +0000165def get_attribute(obj, name):
166 """Get an attribute, raising SkipTest if AttributeError is raised."""
167 try:
168 attribute = getattr(obj, name)
169 except AttributeError:
170 raise unittest.SkipTest("module %s has no attribute %s" % (
171 obj.__name__, name))
172 else:
173 return attribute
174
Barry Warsawc0fb6052001-08-20 22:29:23 +0000175verbose = 1 # Flag set to 0 by regrtest.py
Thomas Wouters477c8d52006-05-27 19:21:47 +0000176use_resources = None # Flag set to [] by regrtest.py
177max_memuse = 0 # Disable bigmem tests (they will still be run with
178 # small sizes, to make sure they work.)
Neal Norwitz3ce5d922008-08-24 07:08:55 +0000179real_max_memuse = 0
Antoine Pitrou216a3bc2011-07-23 22:33:39 +0200180failfast = False
Antoine Pitroub9c73e82011-07-29 23:53:38 +0200181match_tests = None
Guido van Rossum531661c1996-12-20 02:58:22 +0000182
Tim Peters8dee8092001-09-25 20:05:11 +0000183# _original_stdout is meant to hold stdout at the time regrtest began.
184# This may be "the real" stdout, or IDLE's emulation of stdout, or whatever.
185# The point is to have some flavor of stdout the user can actually see.
186_original_stdout = None
187def record_original_stdout(stdout):
188 global _original_stdout
189 _original_stdout = stdout
190
191def get_original_stdout():
192 return _original_stdout or sys.stdout
193
Guido van Rossum3bead091992-01-27 17:00:37 +0000194def unload(name):
Fred Drake004d5e62000-10-23 17:22:08 +0000195 try:
196 del sys.modules[name]
197 except KeyError:
198 pass
Guido van Rossum3bead091992-01-27 17:00:37 +0000199
Neal Norwitz0e17f8c2006-01-23 07:51:27 +0000200def unlink(filename):
Neal Norwitz0e17f8c2006-01-23 07:51:27 +0000201 try:
202 os.unlink(filename)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000203 except OSError as error:
204 # The filename need not exist.
Michael Foord2d9c2d52010-05-04 22:29:10 +0000205 if error.errno not in (errno.ENOENT, errno.ENOTDIR):
Barry Warsaw28a691b2010-04-17 00:19:56 +0000206 raise
Neal Norwitz0e17f8c2006-01-23 07:51:27 +0000207
Christian Heimes23daade2008-02-25 12:39:23 +0000208def rmtree(path):
209 try:
210 shutil.rmtree(path)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000211 except OSError as error:
Christian Heimes23daade2008-02-25 12:39:23 +0000212 # Unix returns ENOENT, Windows returns ESRCH.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000213 if error.errno not in (errno.ENOENT, errno.ESRCH):
Christian Heimes23daade2008-02-25 12:39:23 +0000214 raise
215
Barry Warsaw28a691b2010-04-17 00:19:56 +0000216def make_legacy_pyc(source):
217 """Move a PEP 3147 pyc/pyo file to its legacy pyc/pyo location.
218
219 The choice of .pyc or .pyo extension is done based on the __debug__ flag
220 value.
221
222 :param source: The file system path to the source file. The source file
223 does not need to exist, however the PEP 3147 pyc file must exist.
224 :return: The file system path to the legacy pyc file.
225 """
226 pyc_file = imp.cache_from_source(source)
227 up_one = os.path.dirname(os.path.abspath(source))
228 legacy_pyc = os.path.join(up_one, source + ('c' if __debug__ else 'o'))
229 os.rename(pyc_file, legacy_pyc)
230 return legacy_pyc
231
Guido van Rossum3bead091992-01-27 17:00:37 +0000232def forget(modname):
Barry Warsaw28a691b2010-04-17 00:19:56 +0000233 """'Forget' a module was ever imported.
234
235 This removes the module from sys.modules and deletes any PEP 3147 or
236 legacy .pyc and .pyo files.
237 """
Fred Drake004d5e62000-10-23 17:22:08 +0000238 unload(modname)
Fred Drake004d5e62000-10-23 17:22:08 +0000239 for dirname in sys.path:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000240 source = os.path.join(dirname, modname + '.py')
241 # It doesn't matter if they exist or not, unlink all possible
242 # combinations of PEP 3147 and legacy pyc and pyo files.
243 unlink(source + 'c')
244 unlink(source + 'o')
245 unlink(imp.cache_from_source(source, debug_override=True))
246 unlink(imp.cache_from_source(source, debug_override=False))
Guido van Rossum3bead091992-01-27 17:00:37 +0000247
Antoine Pitrou4914f9e2011-02-26 16:49:08 +0000248# On some platforms, should not run gui test even if it is allowed
249# in `use_resources'.
250if sys.platform.startswith('win'):
251 import ctypes
252 import ctypes.wintypes
253 def _is_gui_available():
254 UOI_FLAGS = 1
255 WSF_VISIBLE = 0x0001
256 class USEROBJECTFLAGS(ctypes.Structure):
257 _fields_ = [("fInherit", ctypes.wintypes.BOOL),
258 ("fReserved", ctypes.wintypes.BOOL),
259 ("dwFlags", ctypes.wintypes.DWORD)]
260 dll = ctypes.windll.user32
261 h = dll.GetProcessWindowStation()
262 if not h:
263 raise ctypes.WinError()
264 uof = USEROBJECTFLAGS()
265 needed = ctypes.wintypes.DWORD()
266 res = dll.GetUserObjectInformationW(h,
267 UOI_FLAGS,
268 ctypes.byref(uof),
269 ctypes.sizeof(uof),
270 ctypes.byref(needed))
271 if not res:
272 raise ctypes.WinError()
273 return bool(uof.dwFlags & WSF_VISIBLE)
274else:
275 def _is_gui_available():
276 return True
277
Tim Petersb4ee4eb2002-12-04 03:26:57 +0000278def is_resource_enabled(resource):
Brett Cannonf1cfb622003-05-04 21:15:27 +0000279 """Test whether a resource is enabled. Known resources are set by
280 regrtest.py."""
Tim Petersb4ee4eb2002-12-04 03:26:57 +0000281 return use_resources is not None and resource in use_resources
282
Barry Warsawc0fb6052001-08-20 22:29:23 +0000283def requires(resource, msg=None):
Brett Cannonf1cfb622003-05-04 21:15:27 +0000284 """Raise ResourceDenied if the specified resource is not available.
285
286 If the caller's module is __main__ then automatically return True. The
Barry Warsaw28a691b2010-04-17 00:19:56 +0000287 possibility of False being returned occurs when regrtest.py is
288 executing.
289 """
Antoine Pitrou4914f9e2011-02-26 16:49:08 +0000290 if resource == 'gui' and not _is_gui_available():
291 raise unittest.SkipTest("Cannot use the 'gui' resource")
Skip Montanarod839ecd2003-04-24 19:06:57 +0000292 # see if the caller's module is __main__ - if so, treat as if
293 # the resource was set
Benjamin Petersone549ead2009-03-28 21:42:05 +0000294 if sys._getframe(1).f_globals.get("__name__") == "__main__":
Skip Montanarod839ecd2003-04-24 19:06:57 +0000295 return
Tim Petersb4ee4eb2002-12-04 03:26:57 +0000296 if not is_resource_enabled(resource):
Barry Warsawc0fb6052001-08-20 22:29:23 +0000297 if msg is None:
298 msg = "Use of the `%s' resource not enabled" % resource
Fred Drake9a0db072003-02-03 15:19:30 +0000299 raise ResourceDenied(msg)
Barry Warsawc0fb6052001-08-20 22:29:23 +0000300
Victor Stinner88701e22011-06-01 13:13:04 +0200301def requires_mac_ver(*min_version):
302 """Decorator raising SkipTest if the OS is Mac OS X and the OS X
303 version if less than min_version.
304
305 For example, @requires_mac_ver(10, 5) raises SkipTest if the OS X version
306 is lesser than 10.5.
307 """
308 def decorator(func):
309 @functools.wraps(func)
310 def wrapper(*args, **kw):
311 if sys.platform == 'darwin':
312 version_txt = platform.mac_ver()[0]
313 try:
314 version = tuple(map(int, version_txt.split('.')))
315 except ValueError:
316 pass
317 else:
318 if version < min_version:
319 min_version_txt = '.'.join(map(str, min_version))
320 raise unittest.SkipTest(
321 "Mac OS X %s or higher required, not %s"
322 % (min_version_txt, version_txt))
323 return func(*args, **kw)
324 wrapper.min_version = min_version
325 return wrapper
326 return decorator
327
Christian Heimes5e696852008-04-09 08:37:03 +0000328HOST = 'localhost'
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000329
Christian Heimes5e696852008-04-09 08:37:03 +0000330def find_unused_port(family=socket.AF_INET, socktype=socket.SOCK_STREAM):
331 """Returns an unused port that should be suitable for binding. This is
332 achieved by creating a temporary socket with the same family and type as
333 the 'sock' parameter (default is AF_INET, SOCK_STREAM), and binding it to
334 the specified host address (defaults to 0.0.0.0) with the port set to 0,
335 eliciting an unused ephemeral port from the OS. The temporary socket is
336 then closed and deleted, and the ephemeral port is returned.
337
338 Either this method or bind_port() should be used for any tests where a
339 server socket needs to be bound to a particular port for the duration of
340 the test. Which one to use depends on whether the calling code is creating
341 a python socket, or if an unused port needs to be provided in a constructor
342 or passed to an external program (i.e. the -accept argument to openssl's
343 s_server mode). Always prefer bind_port() over find_unused_port() where
344 possible. Hard coded ports should *NEVER* be used. As soon as a server
345 socket is bound to a hard coded port, the ability to run multiple instances
346 of the test simultaneously on the same host is compromised, which makes the
347 test a ticking time bomb in a buildbot environment. On Unix buildbots, this
348 may simply manifest as a failed test, which can be recovered from without
349 intervention in most cases, but on Windows, the entire python process can
350 completely and utterly wedge, requiring someone to log in to the buildbot
351 and manually kill the affected process.
352
353 (This is easy to reproduce on Windows, unfortunately, and can be traced to
354 the SO_REUSEADDR socket option having different semantics on Windows versus
355 Unix/Linux. On Unix, you can't have two AF_INET SOCK_STREAM sockets bind,
356 listen and then accept connections on identical host/ports. An EADDRINUSE
357 socket.error will be raised at some point (depending on the platform and
358 the order bind and listen were called on each socket).
359
360 However, on Windows, if SO_REUSEADDR is set on the sockets, no EADDRINUSE
361 will ever be raised when attempting to bind two identical host/ports. When
362 accept() is called on each socket, the second caller's process will steal
363 the port from the first caller, leaving them both in an awkwardly wedged
364 state where they'll no longer respond to any signals or graceful kills, and
365 must be forcibly killed via OpenProcess()/TerminateProcess().
366
367 The solution on Windows is to use the SO_EXCLUSIVEADDRUSE socket option
368 instead of SO_REUSEADDR, which effectively affords the same semantics as
369 SO_REUSEADDR on Unix. Given the propensity of Unix developers in the Open
370 Source world compared to Windows ones, this is a common mistake. A quick
371 look over OpenSSL's 0.9.8g source shows that they use SO_REUSEADDR when
372 openssl.exe is called with the 's_server' option, for example. See
373 http://bugs.python.org/issue2550 for more info. The following site also
374 has a very thorough description about the implications of both REUSEADDR
375 and EXCLUSIVEADDRUSE on Windows:
376 http://msdn2.microsoft.com/en-us/library/ms740621(VS.85).aspx)
377
378 XXX: although this approach is a vast improvement on previous attempts to
379 elicit unused ports, it rests heavily on the assumption that the ephemeral
380 port returned to us by the OS won't immediately be dished back out to some
381 other process when we close and delete our temporary socket but before our
382 calling code has a chance to bind the returned port. We can deal with this
383 issue if/when we come across it.
384 """
385
386 tempsock = socket.socket(family, socktype)
387 port = bind_port(tempsock)
388 tempsock.close()
389 del tempsock
390 return port
391
392def bind_port(sock, host=HOST):
393 """Bind the socket to a free port and return the port number. Relies on
394 ephemeral ports in order to ensure we are using an unbound port. This is
395 important as many tests may be running simultaneously, especially in a
396 buildbot environment. This method raises an exception if the sock.family
397 is AF_INET and sock.type is SOCK_STREAM, *and* the socket has SO_REUSEADDR
398 or SO_REUSEPORT set on it. Tests should *never* set these socket options
399 for TCP/IP sockets. The only case for setting these options is testing
400 multicasting via multiple UDP sockets.
401
402 Additionally, if the SO_EXCLUSIVEADDRUSE socket option is available (i.e.
403 on Windows), it will be set on the socket. This will prevent anyone else
404 from bind()'ing to our host/port for the duration of the test.
405 """
406
407 if sock.family == socket.AF_INET and sock.type == socket.SOCK_STREAM:
408 if hasattr(socket, 'SO_REUSEADDR'):
409 if sock.getsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR) == 1:
410 raise TestFailed("tests should never set the SO_REUSEADDR " \
411 "socket option on TCP/IP sockets!")
412 if hasattr(socket, 'SO_REUSEPORT'):
413 if sock.getsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT) == 1:
414 raise TestFailed("tests should never set the SO_REUSEPORT " \
415 "socket option on TCP/IP sockets!")
416 if hasattr(socket, 'SO_EXCLUSIVEADDRUSE'):
417 sock.setsockopt(socket.SOL_SOCKET, socket.SO_EXCLUSIVEADDRUSE, 1)
418
419 sock.bind((host, 0))
420 port = sock.getsockname()[1]
421 return port
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000422
Guido van Rossum35fb82a1993-01-26 13:04:43 +0000423FUZZ = 1e-6
424
425def fcmp(x, y): # fuzzy comparison function
Neal Norwitz79212992006-08-21 16:27:31 +0000426 if isinstance(x, float) or isinstance(y, float):
Fred Drake004d5e62000-10-23 17:22:08 +0000427 try:
Fred Drake004d5e62000-10-23 17:22:08 +0000428 fuzz = (abs(x) + abs(y)) * FUZZ
429 if abs(x-y) <= fuzz:
430 return 0
431 except:
432 pass
Neal Norwitz79212992006-08-21 16:27:31 +0000433 elif type(x) == type(y) and isinstance(x, (tuple, list)):
Fred Drake004d5e62000-10-23 17:22:08 +0000434 for i in range(min(len(x), len(y))):
435 outcome = fcmp(x[i], y[i])
Fred Drake132dce22000-12-12 23:11:42 +0000436 if outcome != 0:
Fred Drake004d5e62000-10-23 17:22:08 +0000437 return outcome
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000438 return (len(x) > len(y)) - (len(x) < len(y))
439 return (x > y) - (x < y)
Guido van Rossum35fb82a1993-01-26 13:04:43 +0000440
Eric Smithf24a0d92010-12-04 13:32:18 +0000441# decorator for skipping tests on non-IEEE 754 platforms
442requires_IEEE_754 = unittest.skipUnless(
443 float.__getformat__("double").startswith("IEEE"),
444 "test requires IEEE 754 doubles")
445
Finn Bock57bc5fa2002-11-01 18:02:03 +0000446is_jython = sys.platform.startswith('java')
447
Barry Warsaw559f6682001-03-23 18:04:02 +0000448# Filename used for testing
449if os.name == 'java':
450 # Jython disallows @ in module names
451 TESTFN = '$test'
Martin v. Löwisa94568a2003-05-10 07:36:56 +0000452else:
Barry Warsaw559f6682001-03-23 18:04:02 +0000453 TESTFN = '@test'
Walter Dörwald9b775532007-06-08 14:30:53 +0000454
Antoine Pitrou88909542009-06-29 13:54:42 +0000455# Disambiguate TESTFN for parallel testing, while letting it remain a valid
456# module name.
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000457TESTFN = "{}_{}_tmp".format(TESTFN, os.getpid())
Antoine Pitrou88909542009-06-29 13:54:42 +0000458
Michael Foord2d9c2d52010-05-04 22:29:10 +0000459
Victor Stinnerd91df1a2010-08-18 10:56:19 +0000460# TESTFN_UNICODE is a non-ascii filename
461TESTFN_UNICODE = TESTFN + "-\xe0\xf2\u0258\u0141\u011f"
Victor Stinner74a833f2010-08-18 21:06:23 +0000462if sys.platform == 'darwin':
463 # In Mac OS X's VFS API file names are, by definition, canonically
464 # decomposed Unicode, encoded using UTF-8. See QA1173:
465 # http://developer.apple.com/mac/library/qa/qa2001/qa1173.html
466 import unicodedata
467 TESTFN_UNICODE = unicodedata.normalize('NFD', TESTFN_UNICODE)
Antoine Pitrou88909542009-06-29 13:54:42 +0000468TESTFN_ENCODING = sys.getfilesystemencoding()
Victor Stinner3d85a6f2010-08-13 13:02:04 +0000469
Victor Stinner09c449c2010-08-13 22:23:24 +0000470# TESTFN_UNENCODABLE is a filename (str type) that should *not* be able to be
Victor Stinner3d85a6f2010-08-13 13:02:04 +0000471# encoded by the filesystem encoding (in strict mode). It can be None if we
472# cannot generate such filename.
Victor Stinnera0241c82010-08-15 19:28:21 +0000473TESTFN_UNENCODABLE = None
Victor Stinner3d85a6f2010-08-13 13:02:04 +0000474if os.name in ('nt', 'ce'):
Victor Stinnera0241c82010-08-15 19:28:21 +0000475 # skip win32s (0) or Windows 9x/ME (1)
476 if sys.getwindowsversion().platform >= 2:
Victor Stinner8ce7df62010-09-10 11:19:59 +0000477 # Different kinds of characters from various languages to minimize the
478 # probability that the whole name is encodable to MBCS (issue #9819)
479 TESTFN_UNENCODABLE = TESTFN + "-\u5171\u0141\u2661\u0363\uDC80"
Victor Stinner3d85a6f2010-08-13 13:02:04 +0000480 try:
Victor Stinner09c449c2010-08-13 22:23:24 +0000481 TESTFN_UNENCODABLE.encode(TESTFN_ENCODING)
Victor Stinner3d85a6f2010-08-13 13:02:04 +0000482 except UnicodeEncodeError:
483 pass
484 else:
485 print('WARNING: The filename %r CAN be encoded by the filesystem encoding (%s). '
486 'Unicode filename tests may not be effective'
Victor Stinner09c449c2010-08-13 22:23:24 +0000487 % (TESTFN_UNENCODABLE, TESTFN_ENCODING))
488 TESTFN_UNENCODABLE = None
Victor Stinnera0241c82010-08-15 19:28:21 +0000489# Mac OS X denies unencodable filenames (invalid utf-8)
Victor Stinner03c9e1d2010-08-14 17:35:20 +0000490elif sys.platform != 'darwin':
Victor Stinner3d85a6f2010-08-13 13:02:04 +0000491 try:
492 # ascii and utf-8 cannot encode the byte 0xff
493 b'\xff'.decode(TESTFN_ENCODING)
494 except UnicodeDecodeError:
495 # 0xff will be encoded using the surrogate character u+DCFF
Victor Stinner09c449c2010-08-13 22:23:24 +0000496 TESTFN_UNENCODABLE = TESTFN \
Victor Stinner3d85a6f2010-08-13 13:02:04 +0000497 + b'-\xff'.decode(TESTFN_ENCODING, 'surrogateescape')
498 else:
499 # File system encoding (eg. ISO-8859-* encodings) can encode
500 # the byte 0xff. Skip some unicode filename tests.
Victor Stinnera0241c82010-08-15 19:28:21 +0000501 pass
Neal Norwitz26a1eef2002-11-03 00:35:53 +0000502
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000503# Save the initial cwd
504SAVEDCWD = os.getcwd()
505
506@contextlib.contextmanager
Nick Coghland26c18a2010-08-17 13:06:11 +0000507def temp_cwd(name='tempcwd', quiet=False, path=None):
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000508 """
Nick Coghland26c18a2010-08-17 13:06:11 +0000509 Context manager that temporarily changes the CWD.
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000510
Nick Coghland26c18a2010-08-17 13:06:11 +0000511 An existing path may be provided as *path*, in which case this
512 function makes no changes to the file system.
513
514 Otherwise, the new CWD is created in the current directory and it's
515 named *name*. If *quiet* is False (default) and it's not possible to
516 create or change the CWD, an error is raised. If it's True, only a
517 warning is raised and the original CWD is used.
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000518 """
519 saved_dir = os.getcwd()
520 is_temporary = False
Nick Coghland26c18a2010-08-17 13:06:11 +0000521 if path is None:
522 path = name
523 try:
524 os.mkdir(name)
525 is_temporary = True
526 except OSError:
527 if not quiet:
528 raise
529 warnings.warn('tests may fail, unable to create temp CWD ' + name,
530 RuntimeWarning, stacklevel=3)
Neal Norwitz26a1eef2002-11-03 00:35:53 +0000531 try:
Nick Coghland26c18a2010-08-17 13:06:11 +0000532 os.chdir(path)
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000533 except OSError:
534 if not quiet:
535 raise
536 warnings.warn('tests may fail, unable to change the CWD to ' + name,
537 RuntimeWarning, stacklevel=3)
538 try:
539 yield os.getcwd()
540 finally:
541 os.chdir(saved_dir)
542 if is_temporary:
543 rmtree(name)
544
Guido van Rossuma8f7e592001-03-13 09:31:07 +0000545
Barry Warsaw28a691b2010-04-17 00:19:56 +0000546@contextlib.contextmanager
547def temp_umask(umask):
548 """Context manager that temporarily sets the process umask."""
549 oldmask = os.umask(umask)
550 try:
551 yield
552 finally:
553 os.umask(oldmask)
554
555
Florent Xiclunaf15351d2010-03-13 23:24:31 +0000556def findfile(file, here=__file__, subdir=None):
Brett Cannonf1cfb622003-05-04 21:15:27 +0000557 """Try to find a file on sys.path and the working directory. If it is not
558 found the argument passed to the function is returned (this does not
559 necessarily signal failure; could still be the legitimate path)."""
Fred Drake004d5e62000-10-23 17:22:08 +0000560 if os.path.isabs(file):
561 return file
Florent Xiclunaf15351d2010-03-13 23:24:31 +0000562 if subdir is not None:
563 file = os.path.join(subdir, file)
Fred Drake004d5e62000-10-23 17:22:08 +0000564 path = sys.path
565 path = [os.path.dirname(here)] + path
566 for dn in path:
567 fn = os.path.join(dn, file)
568 if os.path.exists(fn): return fn
569 return file
Marc-André Lemburg36619082001-01-17 19:11:13 +0000570
Tim Peters2f228e72001-05-13 00:19:31 +0000571def sortdict(dict):
572 "Like repr(dict), but in sorted order."
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000573 items = sorted(dict.items())
Tim Peters2f228e72001-05-13 00:19:31 +0000574 reprpairs = ["%r: %r" % pair for pair in items]
575 withcommas = ", ".join(reprpairs)
576 return "{%s}" % withcommas
577
Benjamin Peterson7522c742009-01-19 21:00:09 +0000578def make_bad_fd():
579 """
580 Create an invalid file descriptor by opening and closing a file and return
581 its fd.
582 """
583 file = open(TESTFN, "wb")
584 try:
585 return file.fileno()
586 finally:
587 file.close()
588 unlink(TESTFN)
589
Thomas Wouters89f507f2006-12-13 04:49:30 +0000590def check_syntax_error(testcase, statement):
Benjamin Petersone549ead2009-03-28 21:42:05 +0000591 testcase.assertRaises(SyntaxError, compile, statement,
592 '<test string>', 'exec')
Fred Drakecd1b1dd2001-03-21 18:26:33 +0000593
Martin v. Löwis234a34a2007-08-30 20:58:02 +0000594def open_urlresource(url, *args, **kw):
Jeremy Hylton1afc1692008-06-18 20:49:58 +0000595 import urllib.request, urllib.parse
Fred Drakecd1b1dd2001-03-21 18:26:33 +0000596
Florent Xiclunaf089fd62010-03-19 14:25:03 +0000597 check = kw.pop('check', None)
598
Jeremy Hylton1afc1692008-06-18 20:49:58 +0000599 filename = urllib.parse.urlparse(url)[2].split('/')[-1] # '/': it's URL!
Hye-Shik Changaaa2f1d2005-12-10 17:44:27 +0000600
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +0000601 fn = os.path.join(os.path.dirname(__file__), "data", filename)
Florent Xiclunaf089fd62010-03-19 14:25:03 +0000602
603 def check_valid_file(fn):
604 f = open(fn, *args, **kw)
605 if check is None:
606 return f
607 elif check(f):
608 f.seek(0)
609 return f
610 f.close()
611
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +0000612 if os.path.exists(fn):
Florent Xiclunaf089fd62010-03-19 14:25:03 +0000613 f = check_valid_file(fn)
614 if f is not None:
615 return f
616 unlink(fn)
617
618 # Verify the requirement before downloading the file
619 requires('urlfetch')
Hye-Shik Changaaa2f1d2005-12-10 17:44:27 +0000620
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000621 print('\tfetching %s ...' % url, file=get_original_stdout())
Antoine Pitroufd0680b2009-11-01 22:13:48 +0000622 f = urllib.request.urlopen(url, timeout=15)
623 try:
624 with open(fn, "wb") as out:
625 s = f.read()
626 while s:
627 out.write(s)
628 s = f.read()
629 finally:
630 f.close()
Florent Xiclunaf089fd62010-03-19 14:25:03 +0000631
632 f = check_valid_file(fn)
633 if f is not None:
634 return f
635 raise TestFailed('invalid resource "%s"' % fn)
636
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000637
Benjamin Petersonfcf5d632008-10-16 23:24:44 +0000638class WarningsRecorder(object):
639 """Convenience wrapper for the warnings list returned on
640 entry to the warnings.catch_warnings() context manager.
Guido van Rossumd8faa362007-04-27 19:54:29 +0000641 """
Benjamin Petersonfcf5d632008-10-16 23:24:44 +0000642 def __init__(self, warnings_list):
Florent Xiclunab14930c2010-03-13 15:26:44 +0000643 self._warnings = warnings_list
644 self._last = 0
Benjamin Petersonfcf5d632008-10-16 23:24:44 +0000645
646 def __getattr__(self, attr):
Florent Xiclunab14930c2010-03-13 15:26:44 +0000647 if len(self._warnings) > self._last:
648 return getattr(self._warnings[-1], attr)
Benjamin Petersonfcf5d632008-10-16 23:24:44 +0000649 elif attr in warnings.WarningMessage._WARNING_DETAILS:
650 return None
651 raise AttributeError("%r has no attribute %r" % (self, attr))
652
Florent Xiclunab14930c2010-03-13 15:26:44 +0000653 @property
654 def warnings(self):
655 return self._warnings[self._last:]
656
Benjamin Petersonfcf5d632008-10-16 23:24:44 +0000657 def reset(self):
Florent Xiclunab14930c2010-03-13 15:26:44 +0000658 self._last = len(self._warnings)
659
660
661def _filterwarnings(filters, quiet=False):
662 """Catch the warnings, then check if all the expected
663 warnings have been raised and re-raise unexpected warnings.
664 If 'quiet' is True, only re-raise the unexpected warnings.
665 """
666 # Clear the warning registry of the calling module
667 # in order to re-raise the warnings.
668 frame = sys._getframe(2)
669 registry = frame.f_globals.get('__warningregistry__')
670 if registry:
671 registry.clear()
672 with warnings.catch_warnings(record=True) as w:
673 # Set filter "always" to record all warnings. Because
674 # test_warnings swap the module, we need to look up in
675 # the sys.modules dictionary.
676 sys.modules['warnings'].simplefilter("always")
677 yield WarningsRecorder(w)
678 # Filter the recorded warnings
Antoine Pitrou31e08a42010-10-29 11:54:03 +0000679 reraise = list(w)
Florent Xiclunab14930c2010-03-13 15:26:44 +0000680 missing = []
681 for msg, cat in filters:
682 seen = False
Antoine Pitrou31e08a42010-10-29 11:54:03 +0000683 for w in reraise[:]:
684 warning = w.message
Florent Xiclunab14930c2010-03-13 15:26:44 +0000685 # Filter out the matching messages
Antoine Pitrou31e08a42010-10-29 11:54:03 +0000686 if (re.match(msg, str(warning), re.I) and
687 issubclass(warning.__class__, cat)):
Florent Xiclunab14930c2010-03-13 15:26:44 +0000688 seen = True
Antoine Pitrou31e08a42010-10-29 11:54:03 +0000689 reraise.remove(w)
Florent Xiclunab14930c2010-03-13 15:26:44 +0000690 if not seen and not quiet:
691 # This filter caught nothing
692 missing.append((msg, cat.__name__))
693 if reraise:
Antoine Pitrou31e08a42010-10-29 11:54:03 +0000694 raise AssertionError("unhandled warning %s" % reraise[0])
Florent Xiclunab14930c2010-03-13 15:26:44 +0000695 if missing:
696 raise AssertionError("filter (%r, %s) did not catch any warning" %
697 missing[0])
698
Benjamin Petersonfcf5d632008-10-16 23:24:44 +0000699
700@contextlib.contextmanager
Florent Xiclunab14930c2010-03-13 15:26:44 +0000701def check_warnings(*filters, **kwargs):
702 """Context manager to silence warnings.
703
704 Accept 2-tuples as positional arguments:
705 ("message regexp", WarningCategory)
706
707 Optional argument:
708 - if 'quiet' is True, it does not fail if a filter catches nothing
Florent Xicluna53b506b2010-03-18 20:00:57 +0000709 (default True without argument,
710 default False if some filters are defined)
Florent Xiclunab14930c2010-03-13 15:26:44 +0000711
712 Without argument, it defaults to:
Florent Xicluna53b506b2010-03-18 20:00:57 +0000713 check_warnings(("", Warning), quiet=True)
Florent Xiclunab14930c2010-03-13 15:26:44 +0000714 """
Florent Xicluna53b506b2010-03-18 20:00:57 +0000715 quiet = kwargs.get('quiet')
Florent Xiclunab14930c2010-03-13 15:26:44 +0000716 if not filters:
717 filters = (("", Warning),)
Florent Xicluna53b506b2010-03-18 20:00:57 +0000718 # Preserve backward compatibility
719 if quiet is None:
720 quiet = True
721 return _filterwarnings(filters, quiet)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000722
Alexandre Vassalotti5f8ced22008-05-16 00:03:33 +0000723
724class CleanImport(object):
725 """Context manager to force import to return a new module reference.
726
727 This is useful for testing module-level behaviours, such as
Nick Coghlanb1304932008-07-13 12:25:08 +0000728 the emission of a DeprecationWarning on import.
Alexandre Vassalotti5f8ced22008-05-16 00:03:33 +0000729
730 Use like this:
731
732 with CleanImport("foo"):
Brett Cannonddb5e702010-02-03 22:16:11 +0000733 importlib.import_module("foo") # new reference
Alexandre Vassalotti5f8ced22008-05-16 00:03:33 +0000734 """
735
736 def __init__(self, *module_names):
737 self.original_modules = sys.modules.copy()
738 for module_name in module_names:
739 if module_name in sys.modules:
740 module = sys.modules[module_name]
741 # It is possible that module_name is just an alias for
742 # another module (e.g. stub for modules renamed in 3.x).
743 # In that case, we also need delete the real module to clear
744 # the import cache.
745 if module.__name__ != module_name:
746 del sys.modules[module.__name__]
747 del sys.modules[module_name]
748
749 def __enter__(self):
750 return self
751
752 def __exit__(self, *ignore_exc):
753 sys.modules.update(self.original_modules)
754
755
Walter Dörwald155374d2009-05-01 19:58:58 +0000756class EnvironmentVarGuard(collections.MutableMapping):
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000757
758 """Class to help protect the environment variable properly. Can be used as
759 a context manager."""
760
761 def __init__(self):
Walter Dörwald155374d2009-05-01 19:58:58 +0000762 self._environ = os.environ
Walter Dörwald4ba80132009-04-25 12:48:43 +0000763 self._changed = {}
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000764
Walter Dörwald155374d2009-05-01 19:58:58 +0000765 def __getitem__(self, envvar):
766 return self._environ[envvar]
767
768 def __setitem__(self, envvar, value):
Walter Dörwald4ba80132009-04-25 12:48:43 +0000769 # Remember the initial value on the first access
770 if envvar not in self._changed:
Walter Dörwald155374d2009-05-01 19:58:58 +0000771 self._changed[envvar] = self._environ.get(envvar)
772 self._environ[envvar] = value
773
774 def __delitem__(self, envvar):
775 # Remember the initial value on the first access
776 if envvar not in self._changed:
777 self._changed[envvar] = self._environ.get(envvar)
778 if envvar in self._environ:
779 del self._environ[envvar]
780
781 def keys(self):
782 return self._environ.keys()
783
784 def __iter__(self):
785 return iter(self._environ)
786
787 def __len__(self):
788 return len(self._environ)
789
790 def set(self, envvar, value):
791 self[envvar] = value
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000792
793 def unset(self, envvar):
Walter Dörwald155374d2009-05-01 19:58:58 +0000794 del self[envvar]
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000795
796 def __enter__(self):
797 return self
798
799 def __exit__(self, *ignore_exc):
Walter Dörwald4ba80132009-04-25 12:48:43 +0000800 for (k, v) in self._changed.items():
801 if v is None:
Walter Dörwald155374d2009-05-01 19:58:58 +0000802 if k in self._environ:
803 del self._environ[k]
Walter Dörwald4ba80132009-04-25 12:48:43 +0000804 else:
Walter Dörwald155374d2009-05-01 19:58:58 +0000805 self._environ[k] = v
Nick Coghlan6ead5522009-10-18 13:19:33 +0000806 os.environ = self._environ
807
808
809class DirsOnSysPath(object):
810 """Context manager to temporarily add directories to sys.path.
811
812 This makes a copy of sys.path, appends any directories given
813 as positional arguments, then reverts sys.path to the copied
814 settings when the context ends.
815
816 Note that *all* sys.path modifications in the body of the
817 context manager, including replacement of the object,
818 will be reverted at the end of the block.
819 """
820
821 def __init__(self, *paths):
822 self.original_value = sys.path[:]
823 self.original_object = sys.path
824 sys.path.extend(paths)
825
826 def __enter__(self):
827 return self
828
829 def __exit__(self, *ignore_exc):
830 sys.path = self.original_object
831 sys.path[:] = self.original_value
Walter Dörwald155374d2009-05-01 19:58:58 +0000832
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000833
Guido van Rossumd8faa362007-04-27 19:54:29 +0000834class TransientResource(object):
835
836 """Raise ResourceDenied if an exception is raised while the context manager
837 is in effect that matches the specified exception and attributes."""
838
839 def __init__(self, exc, **kwargs):
840 self.exc = exc
841 self.attrs = kwargs
842
843 def __enter__(self):
844 return self
845
846 def __exit__(self, type_=None, value=None, traceback=None):
847 """If type_ is a subclass of self.exc and value has attributes matching
848 self.attrs, raise ResourceDenied. Otherwise let the exception
849 propagate (if any)."""
850 if type_ is not None and issubclass(self.exc, type_):
851 for attr, attr_value in self.attrs.items():
852 if not hasattr(value, attr):
853 break
854 if getattr(value, attr) != attr_value:
855 break
856 else:
857 raise ResourceDenied("an optional resource is not available")
858
Raymond Hettinger686057b2009-06-04 00:11:54 +0000859# Context managers that raise ResourceDenied when various issues
860# with the Internet connection manifest themselves as exceptions.
Antoine Pitroua88c83c2010-09-07 20:42:19 +0000861# XXX deprecate these and use transient_internet() instead
Raymond Hettinger686057b2009-06-04 00:11:54 +0000862time_out = TransientResource(IOError, errno=errno.ETIMEDOUT)
863socket_peer_reset = TransientResource(socket.error, errno=errno.ECONNRESET)
864ioerror_peer_reset = TransientResource(IOError, errno=errno.ECONNRESET)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000865
Fred Drakecd1b1dd2001-03-21 18:26:33 +0000866
Thomas Woutersed03b412007-08-28 21:37:11 +0000867@contextlib.contextmanager
Antoine Pitroua88c83c2010-09-07 20:42:19 +0000868def transient_internet(resource_name, *, timeout=30.0, errnos=()):
Antoine Pitroufec12ff2010-04-21 19:46:23 +0000869 """Return a context manager that raises ResourceDenied when various issues
870 with the Internet connection manifest themselves as exceptions."""
Antoine Pitrou8bc09032010-09-07 21:09:09 +0000871 default_errnos = [
872 ('ECONNREFUSED', 111),
873 ('ECONNRESET', 104),
Antoine Pitrou5d938cb2011-01-08 10:28:11 +0000874 ('EHOSTUNREACH', 113),
Antoine Pitrou8bc09032010-09-07 21:09:09 +0000875 ('ENETUNREACH', 101),
876 ('ETIMEDOUT', 110),
877 ]
Antoine Pitrou2673c5b2010-09-07 21:43:31 +0000878 default_gai_errnos = [
Antoine Pitrou4875c462011-07-09 02:31:24 +0200879 ('EAI_AGAIN', -3),
Charles-François Natali13859bf2011-12-10 13:16:44 +0100880 ('EAI_FAIL', -4),
Antoine Pitrou2673c5b2010-09-07 21:43:31 +0000881 ('EAI_NONAME', -2),
882 ('EAI_NODATA', -5),
Antoine Pitrou390ea0f2011-04-29 00:44:33 +0200883 # Encountered when trying to resolve IPv6-only hostnames
884 ('WSANO_DATA', 11004),
Antoine Pitrou2673c5b2010-09-07 21:43:31 +0000885 ]
Antoine Pitrou8bc09032010-09-07 21:09:09 +0000886
Antoine Pitroua88c83c2010-09-07 20:42:19 +0000887 denied = ResourceDenied("Resource '%s' is not available" % resource_name)
Antoine Pitrou8bc09032010-09-07 21:09:09 +0000888 captured_errnos = errnos
Antoine Pitrou2673c5b2010-09-07 21:43:31 +0000889 gai_errnos = []
Antoine Pitrou8bc09032010-09-07 21:09:09 +0000890 if not captured_errnos:
891 captured_errnos = [getattr(errno, name, num)
892 for (name, num) in default_errnos]
Antoine Pitrou2673c5b2010-09-07 21:43:31 +0000893 gai_errnos = [getattr(socket, name, num)
894 for (name, num) in default_gai_errnos]
Antoine Pitroua88c83c2010-09-07 20:42:19 +0000895
896 def filter_error(err):
Antoine Pitrou2673c5b2010-09-07 21:43:31 +0000897 n = getattr(err, 'errno', None)
Antoine Pitroua88c83c2010-09-07 20:42:19 +0000898 if (isinstance(err, socket.timeout) or
Antoine Pitrou2673c5b2010-09-07 21:43:31 +0000899 (isinstance(err, socket.gaierror) and n in gai_errnos) or
900 n in captured_errnos):
Antoine Pitroua88c83c2010-09-07 20:42:19 +0000901 if not verbose:
902 sys.stderr.write(denied.args[0] + "\n")
903 raise denied from err
904
905 old_timeout = socket.getdefaulttimeout()
906 try:
907 if timeout is not None:
908 socket.setdefaulttimeout(timeout)
Antoine Pitroufec12ff2010-04-21 19:46:23 +0000909 yield
Antoine Pitroua88c83c2010-09-07 20:42:19 +0000910 except IOError as err:
Antoine Pitrou8bc09032010-09-07 21:09:09 +0000911 # urllib can wrap original socket errors multiple times (!), we must
912 # unwrap to get at the original error.
913 while True:
914 a = err.args
915 if len(a) >= 1 and isinstance(a[0], IOError):
916 err = a[0]
917 # The error can also be wrapped as args[1]:
918 # except socket.error as msg:
919 # raise IOError('socket error', msg).with_traceback(sys.exc_info()[2])
920 elif len(a) >= 2 and isinstance(a[1], IOError):
921 err = a[1]
922 else:
923 break
Antoine Pitroua88c83c2010-09-07 20:42:19 +0000924 filter_error(err)
Antoine Pitroua88c83c2010-09-07 20:42:19 +0000925 raise
926 # XXX should we catch generic exceptions and look for their
927 # __cause__ or __context__?
928 finally:
929 socket.setdefaulttimeout(old_timeout)
Antoine Pitroufec12ff2010-04-21 19:46:23 +0000930
931
932@contextlib.contextmanager
Benjamin Petersonad9d48d2008-04-02 21:49:44 +0000933def captured_output(stream_name):
Ezio Melotti07352b02011-05-14 14:51:18 +0300934 """Return a context manager used by captured_stdout/stdin/stderr
Ezio Melottifc778fd2011-05-14 08:22:47 +0300935 that temporarily replaces the sys stream *stream_name* with a StringIO."""
Thomas Woutersed03b412007-08-28 21:37:11 +0000936 import io
Benjamin Petersonad9d48d2008-04-02 21:49:44 +0000937 orig_stdout = getattr(sys, stream_name)
938 setattr(sys, stream_name, io.StringIO())
Christian Heimes81ee3ef2008-05-04 22:42:01 +0000939 try:
940 yield getattr(sys, stream_name)
941 finally:
942 setattr(sys, stream_name, orig_stdout)
Benjamin Petersonad9d48d2008-04-02 21:49:44 +0000943
944def captured_stdout():
Ezio Melottifc778fd2011-05-14 08:22:47 +0300945 """Capture the output of sys.stdout:
946
947 with captured_stdout() as s:
948 print("hello")
949 self.assertEqual(s.getvalue(), "hello")
950 """
Benjamin Petersonad9d48d2008-04-02 21:49:44 +0000951 return captured_output("stdout")
Thomas Woutersed03b412007-08-28 21:37:11 +0000952
Nick Coghlan6b22f3f2010-12-12 15:24:21 +0000953def captured_stderr():
954 return captured_output("stderr")
955
Nick Coghlan6ead5522009-10-18 13:19:33 +0000956def captured_stdin():
957 return captured_output("stdin")
958
Ezio Melotti07352b02011-05-14 14:51:18 +0300959
Benjamin Petersone549ead2009-03-28 21:42:05 +0000960def gc_collect():
961 """Force as many objects as possible to be collected.
962
963 In non-CPython implementations of Python, this is needed because timely
964 deallocation is not guaranteed by the garbage collector. (Even in CPython
965 this can be the case in case of reference cycles.) This means that __del__
966 methods may be called later than expected and weakrefs may remain alive for
967 longer than expected. This function tries its best to force all garbage
968 objects to disappear.
969 """
Benjamin Petersone549ead2009-03-28 21:42:05 +0000970 gc.collect()
Benjamin Petersona6590e82010-04-11 21:22:10 +0000971 if is_jython:
972 time.sleep(0.1)
Benjamin Petersone549ead2009-03-28 21:42:05 +0000973 gc.collect()
974 gc.collect()
975
Thomas Woutersed03b412007-08-28 21:37:11 +0000976
Benjamin Peterson65c66ab2010-10-29 21:31:35 +0000977def python_is_optimized():
978 """Find if Python was built with optimizations."""
Antoine Pitrou64474542010-10-31 11:34:47 +0000979 cflags = sysconfig.get_config_var('PY_CFLAGS') or ''
Benjamin Peterson65c66ab2010-10-29 21:31:35 +0000980 final_opt = ""
981 for opt in cflags.split():
982 if opt.startswith('-O'):
983 final_opt = opt
984 return final_opt and final_opt != '-O0'
985
986
Fred Drakecd1b1dd2001-03-21 18:26:33 +0000987#=======================================================================
Thomas Wouters477c8d52006-05-27 19:21:47 +0000988# Decorator for running a function in a different locale, correctly resetting
989# it afterwards.
990
991def run_with_locale(catstr, *locales):
992 def decorator(func):
993 def inner(*args, **kwds):
994 try:
995 import locale
996 category = getattr(locale, catstr)
997 orig_locale = locale.setlocale(category)
998 except AttributeError:
999 # if the test author gives us an invalid category string
1000 raise
1001 except:
1002 # cannot retrieve original locale, so do nothing
1003 locale = orig_locale = None
1004 else:
1005 for loc in locales:
1006 try:
1007 locale.setlocale(category, loc)
1008 break
1009 except:
1010 pass
1011
1012 # now run the function, resetting the locale on exceptions
1013 try:
1014 return func(*args, **kwds)
1015 finally:
1016 if locale and orig_locale:
1017 locale.setlocale(category, orig_locale)
Neal Norwitz221085d2007-02-25 20:55:47 +00001018 inner.__name__ = func.__name__
Thomas Wouters477c8d52006-05-27 19:21:47 +00001019 inner.__doc__ = func.__doc__
1020 return inner
1021 return decorator
1022
1023#=======================================================================
Alexander Belopolsky2420d832012-04-29 15:56:49 -04001024# Decorator for running a function in a specific timezone, correctly
1025# resetting it afterwards.
1026
1027def run_with_tz(tz):
1028 def decorator(func):
1029 def inner(*args, **kwds):
1030 if 'TZ' in os.environ:
1031 orig_tz = os.environ['TZ']
1032 else:
1033 orig_tz = None
1034 os.environ['TZ'] = tz
1035 time.tzset()
1036
1037 # now run the function, resetting the tz on exceptions
1038 try:
1039 return func(*args, **kwds)
1040 finally:
1041 if orig_tz == None:
1042 del os.environ['TZ']
1043 else:
1044 os.environ['TZ'] = orig_tz
1045 time.tzset()
1046
1047 inner.__name__ = func.__name__
1048 inner.__doc__ = func.__doc__
1049 return inner
1050 return decorator
1051
1052#=======================================================================
Georg Brandldb028442008-02-05 20:48:58 +00001053# Big-memory-test support. Separate from 'resources' because memory use
1054# should be configurable.
Thomas Wouters477c8d52006-05-27 19:21:47 +00001055
1056# Some handy shorthands. Note that these are used for byte-limits as well
1057# as size-limits, in the various bigmem tests
1058_1M = 1024*1024
1059_1G = 1024 * _1M
1060_2G = 2 * _1G
Neal Norwitz3ce5d922008-08-24 07:08:55 +00001061_4G = 4 * _1G
Thomas Wouters477c8d52006-05-27 19:21:47 +00001062
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001063MAX_Py_ssize_t = sys.maxsize
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001064
Thomas Wouters477c8d52006-05-27 19:21:47 +00001065def set_memlimit(limit):
Thomas Wouters477c8d52006-05-27 19:21:47 +00001066 global max_memuse
Neal Norwitz3ce5d922008-08-24 07:08:55 +00001067 global real_max_memuse
Thomas Wouters477c8d52006-05-27 19:21:47 +00001068 sizes = {
1069 'k': 1024,
1070 'm': _1M,
1071 'g': _1G,
1072 't': 1024*_1G,
1073 }
1074 m = re.match(r'(\d+(\.\d+)?) (K|M|G|T)b?$', limit,
1075 re.IGNORECASE | re.VERBOSE)
1076 if m is None:
1077 raise ValueError('Invalid memory limit %r' % (limit,))
1078 memlimit = int(float(m.group(1)) * sizes[m.group(3).lower()])
Neal Norwitz3ce5d922008-08-24 07:08:55 +00001079 real_max_memuse = memlimit
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001080 if memlimit > MAX_Py_ssize_t:
1081 memlimit = MAX_Py_ssize_t
1082 if memlimit < _2G - 1:
Thomas Wouters477c8d52006-05-27 19:21:47 +00001083 raise ValueError('Memory limit %r too low to be useful' % (limit,))
1084 max_memuse = memlimit
1085
Antoine Pitrou94190bb2011-10-04 10:22:36 +02001086def _memory_watchdog(start_evt, finish_evt, period=10.0):
1087 """A function which periodically watches the process' memory consumption
1088 and prints it out.
1089 """
1090 # XXX: because of the GIL, and because the very long operations tested
1091 # in most bigmem tests are uninterruptible, the loop below gets woken up
1092 # much less often than expected.
1093 # The polling code should be rewritten in raw C, without holding the GIL,
1094 # and push results onto an anonymous pipe.
1095 try:
1096 page_size = os.sysconf('SC_PAGESIZE')
1097 except (ValueError, AttributeError):
1098 try:
1099 page_size = os.sysconf('SC_PAGE_SIZE')
1100 except (ValueError, AttributeError):
1101 page_size = 4096
1102 procfile = '/proc/{pid}/statm'.format(pid=os.getpid())
1103 try:
1104 f = open(procfile, 'rb')
1105 except IOError as e:
1106 warnings.warn('/proc not available for stats: {}'.format(e),
1107 RuntimeWarning)
1108 sys.stderr.flush()
1109 return
1110 with f:
1111 start_evt.set()
1112 old_data = -1
1113 while not finish_evt.wait(period):
1114 f.seek(0)
1115 statm = f.read().decode('ascii')
1116 data = int(statm.split()[5])
1117 if data != old_data:
1118 old_data = data
1119 print(" ... process data size: {data:.1f}G"
1120 .format(data=data * page_size / (1024 ** 3)))
1121
1122def bigmemtest(size, memuse, dry_run=True):
Thomas Wouters477c8d52006-05-27 19:21:47 +00001123 """Decorator for bigmem tests.
1124
1125 'minsize' is the minimum useful size for the test (in arbitrary,
1126 test-interpreted units.) 'memuse' is the number of 'bytes per size' for
Antoine Pitrouaca5fa72011-01-12 21:19:59 +00001127 the test, or a good estimate of it.
Thomas Wouters477c8d52006-05-27 19:21:47 +00001128
Antoine Pitrou94190bb2011-10-04 10:22:36 +02001129 if 'dry_run' is False, it means the test doesn't support dummy runs
1130 when -M is not specified.
Thomas Wouters477c8d52006-05-27 19:21:47 +00001131 """
1132 def decorator(f):
1133 def wrapper(self):
Antoine Pitrou7cdb4952009-03-07 23:40:49 +00001134 size = wrapper.size
1135 memuse = wrapper.memuse
Neal Norwitz3ce5d922008-08-24 07:08:55 +00001136 if not real_max_memuse:
1137 maxsize = 5147
1138 else:
1139 maxsize = size
1140
Antoine Pitrou82be19f2011-08-29 23:09:33 +02001141 if ((real_max_memuse or not dry_run)
1142 and real_max_memuse < maxsize * memuse):
1143 raise unittest.SkipTest(
1144 "not enough memory: %.1fG minimum needed"
1145 % (size * memuse / (1024 ** 3)))
Neal Norwitz3ce5d922008-08-24 07:08:55 +00001146
Antoine Pitrou94190bb2011-10-04 10:22:36 +02001147 if real_max_memuse and verbose and threading:
1148 print()
1149 print(" ... expected peak memory use: {peak:.1f}G"
1150 .format(peak=size * memuse / (1024 ** 3)))
1151 sys.stdout.flush()
1152 start_evt = threading.Event()
1153 finish_evt = threading.Event()
1154 t = threading.Thread(target=_memory_watchdog,
1155 args=(start_evt, finish_evt, 0.5))
1156 t.daemon = True
1157 t.start()
1158 start_evt.set()
1159 else:
1160 t = None
1161
1162 try:
1163 return f(self, maxsize)
1164 finally:
1165 if t:
1166 finish_evt.set()
1167 t.join()
1168
Neal Norwitz3ce5d922008-08-24 07:08:55 +00001169 wrapper.size = size
1170 wrapper.memuse = memuse
Neal Norwitz3ce5d922008-08-24 07:08:55 +00001171 return wrapper
1172 return decorator
1173
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001174def bigaddrspacetest(f):
1175 """Decorator for tests that fill the address space."""
1176 def wrapper(self):
1177 if max_memuse < MAX_Py_ssize_t:
Antoine Pitrou98c62bd2011-01-12 21:58:39 +00001178 if MAX_Py_ssize_t >= 2**63 - 1 and max_memuse >= 2**31:
Antoine Pitroue0d3f8a2011-01-12 21:50:44 +00001179 raise unittest.SkipTest(
1180 "not enough memory: try a 32-bit build instead")
1181 else:
1182 raise unittest.SkipTest(
1183 "not enough memory: %.1fG minimum needed"
1184 % (MAX_Py_ssize_t / (1024 ** 3)))
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001185 else:
1186 return f(self)
1187 return wrapper
1188
Thomas Wouters477c8d52006-05-27 19:21:47 +00001189#=======================================================================
Guido van Rossumd8faa362007-04-27 19:54:29 +00001190# unittest integration.
Fred Drakecd1b1dd2001-03-21 18:26:33 +00001191
Steve Purcell5ddd1a82001-03-22 08:45:36 +00001192class BasicTestRunner:
Fred Drakecd1b1dd2001-03-21 18:26:33 +00001193 def run(self, test):
Steve Purcell5ddd1a82001-03-22 08:45:36 +00001194 result = unittest.TestResult()
Fred Drakecd1b1dd2001-03-21 18:26:33 +00001195 test(result)
1196 return result
1197
Benjamin Petersone549ead2009-03-28 21:42:05 +00001198def _id(obj):
1199 return obj
1200
1201def requires_resource(resource):
Antoine Pitrou4914f9e2011-02-26 16:49:08 +00001202 if resource == 'gui' and not _is_gui_available():
1203 return unittest.skip("resource 'gui' is not available")
Antoine Pitrou5bc4fa72010-10-14 15:34:31 +00001204 if is_resource_enabled(resource):
Benjamin Petersone549ead2009-03-28 21:42:05 +00001205 return _id
1206 else:
1207 return unittest.skip("resource {0!r} is not enabled".format(resource))
1208
1209def cpython_only(test):
1210 """
1211 Decorator for tests only applicable on CPython.
1212 """
1213 return impl_detail(cpython=True)(test)
1214
1215def impl_detail(msg=None, **guards):
1216 if check_impl_detail(**guards):
1217 return _id
1218 if msg is None:
1219 guardnames, default = _parse_guards(guards)
1220 if default:
1221 msg = "implementation detail not available on {0}"
1222 else:
1223 msg = "implementation detail specific to {0}"
1224 guardnames = sorted(guardnames.keys())
1225 msg = msg.format(' or '.join(guardnames))
1226 return unittest.skip(msg)
1227
1228def _parse_guards(guards):
1229 # Returns a tuple ({platform_name: run_me}, default_value)
1230 if not guards:
1231 return ({'cpython': True}, False)
Eric Smith886b40a2009-04-26 21:26:45 +00001232 is_true = list(guards.values())[0]
1233 assert list(guards.values()) == [is_true] * len(guards) # all True or all False
Benjamin Petersone549ead2009-03-28 21:42:05 +00001234 return (guards, not is_true)
1235
1236# Use the following check to guard CPython's implementation-specific tests --
1237# or to run them only on the implementation(s) guarded by the arguments.
1238def check_impl_detail(**guards):
1239 """This function returns True or False depending on the host platform.
1240 Examples:
1241 if check_impl_detail(): # only on CPython (default)
1242 if check_impl_detail(jython=True): # only on Jython
1243 if check_impl_detail(cpython=False): # everywhere except on CPython
1244 """
1245 guards, default = _parse_guards(guards)
1246 return guards.get(platform.python_implementation().lower(), default)
1247
1248
Antoine Pitroub9c73e82011-07-29 23:53:38 +02001249def _filter_suite(suite, pred):
1250 """Recursively filter test cases in a suite based on a predicate."""
1251 newtests = []
1252 for test in suite._tests:
1253 if isinstance(test, unittest.TestSuite):
1254 _filter_suite(test, pred)
1255 newtests.append(test)
1256 else:
1257 if pred(test):
1258 newtests.append(test)
1259 suite._tests = newtests
1260
Fred Drakecd1b1dd2001-03-21 18:26:33 +00001261
Guido van Rossumd8faa362007-04-27 19:54:29 +00001262def _run_suite(suite):
Barry Warsawc88425e2001-09-20 06:31:22 +00001263 """Run tests from a unittest.TestSuite-derived class."""
Fred Drakecd1b1dd2001-03-21 18:26:33 +00001264 if verbose:
Antoine Pitrou216a3bc2011-07-23 22:33:39 +02001265 runner = unittest.TextTestRunner(sys.stdout, verbosity=2,
1266 failfast=failfast)
Fred Drakecd1b1dd2001-03-21 18:26:33 +00001267 else:
Steve Purcell5ddd1a82001-03-22 08:45:36 +00001268 runner = BasicTestRunner()
Fred Drakecd1b1dd2001-03-21 18:26:33 +00001269
Steve Purcell5ddd1a82001-03-22 08:45:36 +00001270 result = runner.run(suite)
1271 if not result.wasSuccessful():
Fred Drake14f6c182001-07-16 18:51:32 +00001272 if len(result.errors) == 1 and not result.failures:
1273 err = result.errors[0][1]
1274 elif len(result.failures) == 1 and not result.errors:
1275 err = result.failures[0][1]
1276 else:
R. David Murray723357e2009-10-19 18:06:17 +00001277 err = "multiple errors occurred"
1278 if not verbose: err += "; run in verbose mode for details"
Tim Peters2d84f2c2001-09-08 03:37:56 +00001279 raise TestFailed(err)
Tim Petersa0a62222001-09-09 06:12:01 +00001280
Barry Warsawc10d6902001-09-20 06:30:41 +00001281
Walter Dörwald21d3a322003-05-01 17:45:56 +00001282def run_unittest(*classes):
1283 """Run tests from unittest.TestCase-derived classes."""
Guido van Rossumd8faa362007-04-27 19:54:29 +00001284 valid_types = (unittest.TestSuite, unittest.TestCase)
Raymond Hettinger9dcbbea2003-04-27 07:54:23 +00001285 suite = unittest.TestSuite()
Walter Dörwald21d3a322003-05-01 17:45:56 +00001286 for cls in classes:
Guido van Rossum3172c5d2007-10-16 18:12:55 +00001287 if isinstance(cls, str):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001288 if cls in sys.modules:
1289 suite.addTest(unittest.findTestCases(sys.modules[cls]))
1290 else:
1291 raise ValueError("str arguments must be keys in sys.modules")
1292 elif isinstance(cls, valid_types):
Raymond Hettinger21d99872003-07-16 02:59:32 +00001293 suite.addTest(cls)
1294 else:
1295 suite.addTest(unittest.makeSuite(cls))
Antoine Pitroub9c73e82011-07-29 23:53:38 +02001296 def case_pred(test):
1297 if match_tests is None:
1298 return True
1299 for name in test.id().split("."):
1300 if fnmatch.fnmatchcase(name, match_tests):
1301 return True
1302 return False
1303 _filter_suite(suite, case_pred)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001304 _run_suite(suite)
Raymond Hettinger9dcbbea2003-04-27 07:54:23 +00001305
Barry Warsawc10d6902001-09-20 06:30:41 +00001306
Tim Petersa0a62222001-09-09 06:12:01 +00001307#=======================================================================
1308# doctest driver.
1309
1310def run_doctest(module, verbosity=None):
Tim Peters17111f32001-10-03 04:08:26 +00001311 """Run doctest on the given module. Return (#failures, #tests).
Tim Petersa0a62222001-09-09 06:12:01 +00001312
1313 If optional argument verbosity is not specified (or is None), pass
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001314 support's belief about verbosity on to doctest. Else doctest's
Tim Petersbea3fb82001-09-10 01:39:21 +00001315 usual behavior is used (it searches sys.argv for -v).
Tim Petersa0a62222001-09-09 06:12:01 +00001316 """
1317
1318 import doctest
1319
1320 if verbosity is None:
1321 verbosity = verbose
1322 else:
1323 verbosity = None
1324
Victor Stinnerbddc4d42011-06-29 15:52:46 +02001325 f, t = doctest.testmod(module, verbose=verbosity)
1326 if f:
1327 raise TestFailed("%d of %d doctests failed" % (f, t))
Raymond Hettinger35b34bd2003-05-17 00:58:33 +00001328 if verbose:
Georg Brandldb028442008-02-05 20:48:58 +00001329 print('doctest (%s) ... %d tests with zero failures' %
1330 (module.__name__, t))
Raymond Hettinger35b34bd2003-05-17 00:58:33 +00001331 return f, t
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001332
Antoine Pitrou060cee22009-11-13 16:29:04 +00001333
1334#=======================================================================
1335# Support for saving and restoring the imported modules.
1336
1337def modules_setup():
1338 return sys.modules.copy(),
1339
1340def modules_cleanup(oldmodules):
1341 # Encoders/decoders are registered permanently within the internal
1342 # codec cache. If we destroy the corresponding modules their
1343 # globals will be set to None which will trip up the cached functions.
1344 encodings = [(k, v) for k, v in sys.modules.items()
1345 if k.startswith('encodings.')]
1346 sys.modules.clear()
1347 sys.modules.update(encodings)
Nick Coghlan90be5fb2011-01-11 10:05:20 +00001348 # XXX: This kind of problem can affect more than just encodings. In particular
Eric Smitha3e8f3d2011-01-11 10:24:34 +00001349 # extension modules (such as _ssl) don't cope with reloading properly.
Nick Coghlan90be5fb2011-01-11 10:05:20 +00001350 # Really, test modules should be cleaning out the test specific modules they
1351 # know they added (ala test_runpy) rather than relying on this function (as
1352 # test_importhooks and test_pkg do currently).
1353 # Implicitly imported *real* modules should be left alone (see issue 10556).
Antoine Pitrou060cee22009-11-13 16:29:04 +00001354 sys.modules.update(oldmodules)
1355
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001356#=======================================================================
1357# Threading support to prevent reporting refleaks when running regrtest.py -R
1358
Antoine Pitrou65c9c642009-10-30 17:25:12 +00001359# NOTE: we use thread._count() rather than threading.enumerate() (or the
1360# moral equivalent thereof) because a threading.Thread object is still alive
1361# until its __bootstrap() method has returned, even after it has been
1362# unregistered from the threading module.
1363# thread._count(), on the other hand, only gets decremented *after* the
1364# __bootstrap() method has returned, which gives us reliable reference counts
1365# at the end of a test run.
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001366
Antoine Pitrou65c9c642009-10-30 17:25:12 +00001367def threading_setup():
Victor Stinner45df8202010-04-28 22:31:17 +00001368 if _thread:
Antoine Pitrou707f2282011-07-15 22:29:44 +02001369 return _thread._count(), threading._dangling.copy()
Victor Stinner45df8202010-04-28 22:31:17 +00001370 else:
Antoine Pitrou707f2282011-07-15 22:29:44 +02001371 return 1, ()
Antoine Pitrou65c9c642009-10-30 17:25:12 +00001372
Antoine Pitrou707f2282011-07-15 22:29:44 +02001373def threading_cleanup(*original_values):
Victor Stinner45df8202010-04-28 22:31:17 +00001374 if not _thread:
1375 return
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001376 _MAX_COUNT = 10
Antoine Pitrou65c9c642009-10-30 17:25:12 +00001377 for count in range(_MAX_COUNT):
Antoine Pitrou707f2282011-07-15 22:29:44 +02001378 values = _thread._count(), threading._dangling
1379 if values == original_values:
Antoine Pitrou65c9c642009-10-30 17:25:12 +00001380 break
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001381 time.sleep(0.1)
Antoine Pitrou707f2282011-07-15 22:29:44 +02001382 gc_collect()
Antoine Pitrou65c9c642009-10-30 17:25:12 +00001383 # XXX print a warning in case of failure?
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001384
Benjamin Petersonfa0d7032009-06-01 22:42:33 +00001385def reap_threads(func):
Victor Stinner45df8202010-04-28 22:31:17 +00001386 """Use this function when threads are being used. This will
1387 ensure that the threads are cleaned up even when the test fails.
1388 If threading is unavailable this function does nothing.
1389 """
1390 if not _thread:
1391 return func
1392
Benjamin Petersonfa0d7032009-06-01 22:42:33 +00001393 @functools.wraps(func)
1394 def decorator(*args):
1395 key = threading_setup()
1396 try:
1397 return func(*args)
1398 finally:
1399 threading_cleanup(*key)
1400 return decorator
1401
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001402def reap_children():
1403 """Use this function at the end of test_main() whenever sub-processes
1404 are started. This will help ensure that no extra children (zombies)
1405 stick around to hog resources and create problems when looking
1406 for refleaks.
1407 """
1408
1409 # Reap all our dead child processes so we don't leave zombies around.
1410 # These hog resources and might be causing some of the buildbots to die.
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001411 if hasattr(os, 'waitpid'):
1412 any_process = -1
1413 while True:
1414 try:
1415 # This will raise an exception on Windows. That's ok.
1416 pid, status = os.waitpid(any_process, os.WNOHANG)
1417 if pid == 0:
1418 break
1419 except:
1420 break
Collin Winterf2bf2b32010-03-17 00:41:56 +00001421
1422@contextlib.contextmanager
1423def swap_attr(obj, attr, new_val):
1424 """Temporary swap out an attribute with a new object.
1425
1426 Usage:
1427 with swap_attr(obj, "attr", 5):
1428 ...
1429
1430 This will set obj.attr to 5 for the duration of the with: block,
1431 restoring the old value at the end of the block. If `attr` doesn't
1432 exist on `obj`, it will be created and then deleted at the end of the
1433 block.
1434 """
1435 if hasattr(obj, attr):
1436 real_val = getattr(obj, attr)
1437 setattr(obj, attr, new_val)
1438 try:
1439 yield
1440 finally:
1441 setattr(obj, attr, real_val)
1442 else:
1443 setattr(obj, attr, new_val)
1444 try:
1445 yield
1446 finally:
1447 delattr(obj, attr)
1448
1449@contextlib.contextmanager
1450def swap_item(obj, item, new_val):
1451 """Temporary swap out an item with a new object.
1452
1453 Usage:
1454 with swap_item(obj, "item", 5):
1455 ...
1456
1457 This will set obj["item"] to 5 for the duration of the with: block,
1458 restoring the old value at the end of the block. If `item` doesn't
1459 exist on `obj`, it will be created and then deleted at the end of the
1460 block.
1461 """
1462 if item in obj:
1463 real_val = obj[item]
1464 obj[item] = new_val
1465 try:
1466 yield
1467 finally:
1468 obj[item] = real_val
1469 else:
1470 obj[item] = new_val
1471 try:
1472 yield
1473 finally:
1474 del obj[item]
Antoine Pitrou62f68ed2010-08-04 11:48:56 +00001475
1476def strip_python_stderr(stderr):
1477 """Strip the stderr of a Python process from potential debug output
1478 emitted by the interpreter.
1479
1480 This will typically be run on the result of the communicate() method
1481 of a subprocess.Popen object.
1482 """
1483 stderr = re.sub(br"\[\d+ refs\]\r?\n?$", b"", stderr).strip()
1484 return stderr
Antoine Pitrou1b03f2c2010-10-14 11:12:00 +00001485
1486def args_from_interpreter_flags():
1487 """Return a list of command-line arguments reproducing the current
1488 settings in sys.flags."""
1489 flag_opt_map = {
1490 'bytes_warning': 'b',
1491 'dont_write_bytecode': 'B',
Antoine Pitroue9f637b2012-02-20 23:49:07 +01001492 'hash_randomization': 'R',
Antoine Pitrou1b03f2c2010-10-14 11:12:00 +00001493 'ignore_environment': 'E',
1494 'no_user_site': 's',
1495 'no_site': 'S',
1496 'optimize': 'O',
1497 'verbose': 'v',
1498 }
1499 args = []
1500 for flag, opt in flag_opt_map.items():
1501 v = getattr(sys.flags, flag)
1502 if v > 0:
1503 args.append('-' + opt * v)
1504 return args
Vinay Sajip129fd042010-12-10 08:19:38 +00001505
1506#============================================================
1507# Support for assertions about logging.
1508#============================================================
1509
1510class TestHandler(logging.handlers.BufferingHandler):
1511 def __init__(self, matcher):
1512 # BufferingHandler takes a "capacity" argument
1513 # so as to know when to flush. As we're overriding
1514 # shouldFlush anyway, we can set a capacity of zero.
1515 # You can call flush() manually to clear out the
1516 # buffer.
1517 logging.handlers.BufferingHandler.__init__(self, 0)
1518 self.matcher = matcher
1519
1520 def shouldFlush(self):
1521 return False
1522
1523 def emit(self, record):
1524 self.format(record)
1525 self.buffer.append(record.__dict__)
1526
1527 def matches(self, **kwargs):
1528 """
1529 Look for a saved dict whose keys/values match the supplied arguments.
1530 """
1531 result = False
1532 for d in self.buffer:
1533 if self.matcher.matches(d, **kwargs):
1534 result = True
1535 break
1536 return result
1537
1538class Matcher(object):
1539
1540 _partial_matches = ('msg', 'message')
1541
1542 def matches(self, d, **kwargs):
1543 """
1544 Try to match a single dict with the supplied arguments.
1545
1546 Keys whose values are strings and which are in self._partial_matches
1547 will be checked for partial (i.e. substring) matches. You can extend
1548 this scheme to (for example) do regular expression matching, etc.
1549 """
1550 result = True
1551 for k in kwargs:
1552 v = kwargs[k]
1553 dv = d.get(k)
1554 if not self.match_value(k, dv, v):
1555 result = False
1556 break
1557 return result
1558
1559 def match_value(self, k, dv, v):
1560 """
1561 Try to match a single stored value (dv) with a supplied value (v).
1562 """
1563 if type(v) != type(dv):
1564 result = False
1565 elif type(dv) is not str or k not in self._partial_matches:
1566 result = (v == dv)
1567 else:
1568 result = dv.find(v) >= 0
1569 return result
Brian Curtin3b4499c2010-12-28 14:31:47 +00001570
1571
1572_can_symlink = None
1573def can_symlink():
1574 global _can_symlink
1575 if _can_symlink is not None:
1576 return _can_symlink
Victor Stinner62ec61f2011-06-07 12:17:15 +02001577 symlink_path = TESTFN + "can_symlink"
Brian Curtin3b4499c2010-12-28 14:31:47 +00001578 try:
Victor Stinner62ec61f2011-06-07 12:17:15 +02001579 os.symlink(TESTFN, symlink_path)
Brian Curtin3b4499c2010-12-28 14:31:47 +00001580 can = True
Brian Curtind25aef52011-06-13 15:16:04 -05001581 except (OSError, NotImplementedError, AttributeError):
Brian Curtin3b4499c2010-12-28 14:31:47 +00001582 can = False
Victor Stinner62ec61f2011-06-07 12:17:15 +02001583 else:
1584 os.remove(symlink_path)
Brian Curtin3b4499c2010-12-28 14:31:47 +00001585 _can_symlink = can
1586 return can
1587
1588def skip_unless_symlink(test):
1589 """Skip decorator for tests that require functional symlink"""
1590 ok = can_symlink()
1591 msg = "Requires functional symlink implementation"
1592 return test if ok else unittest.skip(msg)(test)
Antoine Pitroue8706232011-03-15 21:05:36 +01001593
Antoine Pitrou2c50a092011-03-15 21:02:59 +01001594def patch(test_instance, object_to_patch, attr_name, new_value):
1595 """Override 'object_to_patch'.'attr_name' with 'new_value'.
1596
1597 Also, add a cleanup procedure to 'test_instance' to restore
1598 'object_to_patch' value for 'attr_name'.
1599 The 'attr_name' should be a valid attribute for 'object_to_patch'.
1600
1601 """
1602 # check that 'attr_name' is a real attribute for 'object_to_patch'
1603 # will raise AttributeError if it does not exist
1604 getattr(object_to_patch, attr_name)
1605
1606 # keep a copy of the old value
1607 attr_is_local = False
1608 try:
1609 old_value = object_to_patch.__dict__[attr_name]
1610 except (AttributeError, KeyError):
1611 old_value = getattr(object_to_patch, attr_name, None)
1612 else:
1613 attr_is_local = True
1614
1615 # restore the value when the test is done
1616 def cleanup():
1617 if attr_is_local:
1618 setattr(object_to_patch, attr_name, old_value)
1619 else:
1620 delattr(object_to_patch, attr_name)
1621
1622 test_instance.addCleanup(cleanup)
1623
1624 # actually override the attribute
1625 setattr(object_to_patch, attr_name, new_value)