blob: 1e0eac3b0fbbd103d5d2ad3ec700b24a634e46b4 [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
Victor Stinner234cbef2015-09-30 01:13:53 +020061 if ns.huntrleaks:
62 unittest.BaseTestSuite._cleanup = False
63
Victor Stinner234cbef2015-09-30 01:13:53 +020064 if ns.memlimit is not None:
65 support.set_memlimit(ns.memlimit)
66
67 if ns.threshold is not None:
68 gc.set_threshold(ns.threshold)
69
Steve Dower9ddc4162019-05-29 08:20:35 -070070 suppress_msvcrt_asserts(ns.verbose and ns.verbose >= 2)
Victor Stinner234cbef2015-09-30 01:13:53 +020071
Victor Stinnera2045022015-09-30 02:17:28 +020072 support.use_resources = ns.use_resources
73
Steve Dowerb82e17e2019-05-23 08:45:22 -070074 if hasattr(sys, 'addaudithook'):
75 # Add an auditing hook for all tests to ensure PySys_Audit is tested
76 def _test_audit_hook(name, args):
77 pass
78 sys.addaudithook(_test_audit_hook)
79
Victor Stinner234cbef2015-09-30 01:13:53 +020080
Steve Dower9ddc4162019-05-29 08:20:35 -070081def suppress_msvcrt_asserts(verbose):
82 try:
83 import msvcrt
84 except ImportError:
85 return
86
87 msvcrt.SetErrorMode(msvcrt.SEM_FAILCRITICALERRORS|
88 msvcrt.SEM_NOALIGNMENTFAULTEXCEPT|
89 msvcrt.SEM_NOGPFAULTERRORBOX|
90 msvcrt.SEM_NOOPENFILEERRORBOX)
91 try:
92 msvcrt.CrtSetReportMode
93 except AttributeError:
94 # release build
95 return
96
97 for m in [msvcrt.CRT_WARN, msvcrt.CRT_ERROR, msvcrt.CRT_ASSERT]:
98 if verbose:
99 msvcrt.CrtSetReportMode(m, msvcrt.CRTDBG_MODE_FILE)
100 msvcrt.CrtSetReportFile(m, msvcrt.CRTDBG_FILE_STDERR)
101 else:
102 msvcrt.CrtSetReportMode(m, 0)
103
104
105
Victor Stinner234cbef2015-09-30 01:13:53 +0200106def replace_stdout():
107 """Set stdout encoder error handler to backslashreplace (as stderr error
108 handler) to avoid UnicodeEncodeError when printing a traceback"""
109 stdout = sys.stdout
Victor Stinnerccef8232017-10-13 12:59:12 -0700110 try:
111 fd = stdout.fileno()
112 except ValueError:
113 # On IDLE, sys.stdout has no file descriptor and is not a TextIOWrapper
114 # object. Leaving sys.stdout unchanged.
115 #
116 # Catch ValueError to catch io.UnsupportedOperation on TextIOBase
117 # and ValueError on a closed stream.
118 return
119
120 sys.stdout = open(fd, 'w',
Victor Stinner234cbef2015-09-30 01:13:53 +0200121 encoding=stdout.encoding,
122 errors="backslashreplace",
123 closefd=False,
124 newline='\n')
125
126 def restore_stdout():
127 sys.stdout.close()
128 sys.stdout = stdout
129 atexit.register(restore_stdout)