blob: fb5ac350cd084743d0e31d24b0b5f19ad02a7d5e [file] [log] [blame]
Victor Stinner234cbef2015-09-30 01:13:53 +02001import atexit
2import faulthandler
3import os
4import signal
5import sys
6import unittest
7from test import support
8try:
9 import gc
10except ImportError:
11 gc = None
12
Victor Stinner234cbef2015-09-30 01:13:53 +020013
Victor Stinnera2045022015-09-30 02:17:28 +020014def setup_tests(ns):
Victor Stinnerccef8232017-10-13 12:59:12 -070015 try:
16 stderr_fd = sys.__stderr__.fileno()
17 except (ValueError, AttributeError):
18 # Catch ValueError to catch io.UnsupportedOperation on TextIOBase
19 # and ValueError on a closed stream.
20 #
21 # Catch AttributeError for stderr being None.
22 stderr_fd = None
23 else:
24 # Display the Python traceback on fatal errors (e.g. segfault)
25 faulthandler.enable(all_threads=True, file=stderr_fd)
Victor Stinner234cbef2015-09-30 01:13:53 +020026
Victor Stinnerccef8232017-10-13 12:59:12 -070027 # Display the Python traceback on SIGALRM or SIGUSR1 signal
28 signals = []
29 if hasattr(signal, 'SIGALRM'):
30 signals.append(signal.SIGALRM)
31 if hasattr(signal, 'SIGUSR1'):
32 signals.append(signal.SIGUSR1)
33 for signum in signals:
34 faulthandler.register(signum, chain=True, file=stderr_fd)
Victor Stinner234cbef2015-09-30 01:13:53 +020035
36 replace_stdout()
37 support.record_original_stdout(sys.stdout)
38
Victor Stinner9759dd32016-03-30 02:32:52 +020039 if ns.testdir:
40 # Prepend test directory to sys.path, so runtest() will be able
41 # to locate tests
42 sys.path.insert(0, os.path.abspath(ns.testdir))
43
Victor Stinner234cbef2015-09-30 01:13:53 +020044 # Some times __path__ and __file__ are not absolute (e.g. while running from
45 # Lib/) and, if we change the CWD to run the tests in a temporary dir, some
46 # imports might fail. This affects only the modules imported before os.chdir().
47 # These modules are searched first in sys.path[0] (so '' -- the CWD) and if
48 # they are found in the CWD their __file__ and __path__ will be relative (this
49 # happens before the chdir). All the modules imported after the chdir, are
50 # not found in the CWD, and since the other paths in sys.path[1:] are absolute
51 # (site.py absolutize them), the __file__ and __path__ will be absolute too.
52 # Therefore it is necessary to absolutize manually the __file__ and __path__ of
53 # the packages to prevent later imports to fail when the CWD is different.
54 for module in sys.modules.values():
55 if hasattr(module, '__path__'):
Victor Stinner82f04e22016-03-15 23:08:44 +010056 for index, path in enumerate(module.__path__):
57 module.__path__[index] = os.path.abspath(path)
Ned Deilye52ac042018-03-28 01:57:13 -040058 if getattr(module, '__file__', None):
Victor Stinner234cbef2015-09-30 01:13:53 +020059 module.__file__ = os.path.abspath(module.__file__)
60
61 # MacOSX (a.k.a. Darwin) has a default stack size that is too small
62 # for deeply recursive regular expressions. We see this as crashes in
63 # the Python test suite when running test_re.py and test_sre.py. The
64 # fix is to set the stack limit to 2048.
65 # This approach may also be useful for other Unixy platforms that
66 # suffer from small default stack limits.
67 if sys.platform == 'darwin':
68 try:
69 import resource
70 except ImportError:
71 pass
72 else:
73 soft, hard = resource.getrlimit(resource.RLIMIT_STACK)
74 newsoft = min(hard, max(soft, 1024*2048))
75 resource.setrlimit(resource.RLIMIT_STACK, (newsoft, hard))
76
77 if ns.huntrleaks:
78 unittest.BaseTestSuite._cleanup = False
79
Victor Stinner234cbef2015-09-30 01:13:53 +020080 if ns.memlimit is not None:
81 support.set_memlimit(ns.memlimit)
82
83 if ns.threshold is not None:
84 gc.set_threshold(ns.threshold)
85
Steve Dower9ddc4162019-05-29 08:20:35 -070086 suppress_msvcrt_asserts(ns.verbose and ns.verbose >= 2)
Victor Stinner234cbef2015-09-30 01:13:53 +020087
Victor Stinnera2045022015-09-30 02:17:28 +020088 support.use_resources = ns.use_resources
89
Steve Dowerb82e17e2019-05-23 08:45:22 -070090 if hasattr(sys, 'addaudithook'):
91 # Add an auditing hook for all tests to ensure PySys_Audit is tested
92 def _test_audit_hook(name, args):
93 pass
94 sys.addaudithook(_test_audit_hook)
95
Victor Stinner234cbef2015-09-30 01:13:53 +020096
Steve Dower9ddc4162019-05-29 08:20:35 -070097def suppress_msvcrt_asserts(verbose):
98 try:
99 import msvcrt
100 except ImportError:
101 return
102
103 msvcrt.SetErrorMode(msvcrt.SEM_FAILCRITICALERRORS|
104 msvcrt.SEM_NOALIGNMENTFAULTEXCEPT|
105 msvcrt.SEM_NOGPFAULTERRORBOX|
106 msvcrt.SEM_NOOPENFILEERRORBOX)
107 try:
108 msvcrt.CrtSetReportMode
109 except AttributeError:
110 # release build
111 return
112
113 for m in [msvcrt.CRT_WARN, msvcrt.CRT_ERROR, msvcrt.CRT_ASSERT]:
114 if verbose:
115 msvcrt.CrtSetReportMode(m, msvcrt.CRTDBG_MODE_FILE)
116 msvcrt.CrtSetReportFile(m, msvcrt.CRTDBG_FILE_STDERR)
117 else:
118 msvcrt.CrtSetReportMode(m, 0)
119
120
121
Victor Stinner234cbef2015-09-30 01:13:53 +0200122def replace_stdout():
123 """Set stdout encoder error handler to backslashreplace (as stderr error
124 handler) to avoid UnicodeEncodeError when printing a traceback"""
125 stdout = sys.stdout
Victor Stinnerccef8232017-10-13 12:59:12 -0700126 try:
127 fd = stdout.fileno()
128 except ValueError:
129 # On IDLE, sys.stdout has no file descriptor and is not a TextIOWrapper
130 # object. Leaving sys.stdout unchanged.
131 #
132 # Catch ValueError to catch io.UnsupportedOperation on TextIOBase
133 # and ValueError on a closed stream.
134 return
135
136 sys.stdout = open(fd, 'w',
Victor Stinner234cbef2015-09-30 01:13:53 +0200137 encoding=stdout.encoding,
138 errors="backslashreplace",
139 closefd=False,
140 newline='\n')
141
142 def restore_stdout():
143 sys.stdout.close()
144 sys.stdout = stdout
145 atexit.register(restore_stdout)