Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1 | from contextlib import contextmanager |
Victor Stinner | c790a53 | 2011-04-08 13:39:59 +0200 | [diff] [blame] | 2 | import datetime |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 3 | import faulthandler |
Victor Stinner | 7e32f3a | 2011-06-29 13:44:05 +0200 | [diff] [blame] | 4 | import os |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 5 | import re |
| 6 | import signal |
| 7 | import subprocess |
| 8 | import sys |
| 9 | from test import support, script_helper |
Victor Stinner | d5698cb | 2012-07-31 02:55:49 +0200 | [diff] [blame] | 10 | from test.script_helper import assert_python_ok |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 11 | import tempfile |
| 12 | import unittest |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 13 | from textwrap import dedent |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 14 | |
Victor Stinner | ff4cd88 | 2011-04-07 11:50:25 +0200 | [diff] [blame] | 15 | try: |
| 16 | import threading |
| 17 | HAVE_THREADS = True |
| 18 | except ImportError: |
| 19 | HAVE_THREADS = False |
Victor Stinner | 56e8c29 | 2014-07-21 12:30:22 +0200 | [diff] [blame] | 20 | try: |
| 21 | import _testcapi |
| 22 | except ImportError: |
| 23 | _testcapi = None |
Victor Stinner | ff4cd88 | 2011-04-07 11:50:25 +0200 | [diff] [blame] | 24 | |
Victor Stinner | 44378d4 | 2011-04-01 15:37:12 +0200 | [diff] [blame] | 25 | TIMEOUT = 0.5 |
| 26 | |
Victor Stinner | 301f3f0 | 2011-06-01 13:49:12 +0200 | [diff] [blame] | 27 | def expected_traceback(lineno1, lineno2, header, min_count=1): |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 28 | regex = header |
Victor Stinner | 7ad24e9 | 2011-03-31 22:35:49 +0200 | [diff] [blame] | 29 | regex += ' File "<string>", line %s in func\n' % lineno1 |
| 30 | regex += ' File "<string>", line %s in <module>' % lineno2 |
Victor Stinner | 301f3f0 | 2011-06-01 13:49:12 +0200 | [diff] [blame] | 31 | if 1 < min_count: |
| 32 | return '^' + (regex + '\n') * (min_count - 1) + regex |
| 33 | else: |
| 34 | return '^' + regex + '$' |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 35 | |
| 36 | @contextmanager |
| 37 | def temporary_filename(): |
| 38 | filename = tempfile.mktemp() |
| 39 | try: |
| 40 | yield filename |
| 41 | finally: |
| 42 | support.unlink(filename) |
| 43 | |
| 44 | class FaultHandlerTests(unittest.TestCase): |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 45 | def get_output(self, code, filename=None, fd=None): |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 46 | """ |
| 47 | Run the specified code in Python (in a new child process) and read the |
| 48 | output from the standard error or from a file (if filename is set). |
| 49 | Return the output lines as a list. |
| 50 | |
| 51 | Strip the reference count from the standard error for Python debug |
| 52 | build, and replace "Current thread 0x00007f8d8fbd9700" by "Current |
| 53 | thread XXX". |
| 54 | """ |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 55 | code = dedent(code).strip() |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 56 | pass_fds = [] |
| 57 | if fd is not None: |
| 58 | pass_fds.append(fd) |
Antoine Pitrou | 77e904e | 2013-10-08 23:04:32 +0200 | [diff] [blame] | 59 | with support.SuppressCrashReport(): |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 60 | process = script_helper.spawn_python('-c', code, pass_fds=pass_fds) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 61 | stdout, stderr = process.communicate() |
| 62 | exitcode = process.wait() |
Victor Stinner | 1940233 | 2011-03-31 18:15:52 +0200 | [diff] [blame] | 63 | output = support.strip_python_stderr(stdout) |
| 64 | output = output.decode('ascii', 'backslashreplace') |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 65 | if filename: |
Victor Stinner | 1940233 | 2011-03-31 18:15:52 +0200 | [diff] [blame] | 66 | self.assertEqual(output, '') |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 67 | with open(filename, "rb") as fp: |
| 68 | output = fp.read() |
Victor Stinner | 1940233 | 2011-03-31 18:15:52 +0200 | [diff] [blame] | 69 | output = output.decode('ascii', 'backslashreplace') |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 70 | elif fd is not None: |
| 71 | self.assertEqual(output, '') |
| 72 | os.lseek(fd, os.SEEK_SET, 0) |
| 73 | with open(fd, "rb", closefd=False) as fp: |
| 74 | output = fp.read() |
| 75 | output = output.decode('ascii', 'backslashreplace') |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 76 | output = re.sub('Current thread 0x[0-9a-f]+', |
| 77 | 'Current thread XXX', |
| 78 | output) |
Victor Stinner | 05585cb | 2011-03-31 13:29:56 +0200 | [diff] [blame] | 79 | return output.splitlines(), exitcode |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 80 | |
| 81 | def check_fatal_error(self, code, line_number, name_regex, |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 82 | filename=None, all_threads=True, other_regex=None, |
| 83 | fd=None): |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 84 | """ |
| 85 | Check that the fault handler for fatal errors is enabled and check the |
| 86 | traceback from the child process output. |
| 87 | |
| 88 | Raise an error if the output doesn't match the expected format. |
| 89 | """ |
| 90 | if all_threads: |
Guido van Rossum | 7be5d7d | 2013-10-20 18:21:02 -0700 | [diff] [blame] | 91 | header = 'Current thread XXX (most recent call first)' |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 92 | else: |
Guido van Rossum | 7be5d7d | 2013-10-20 18:21:02 -0700 | [diff] [blame] | 93 | header = 'Stack (most recent call first)' |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 94 | regex = """ |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 95 | ^Fatal Python error: {name} |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 96 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 97 | {header}: |
| 98 | File "<string>", line {lineno} in <module> |
| 99 | """ |
| 100 | regex = dedent(regex.format( |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 101 | lineno=line_number, |
| 102 | name=name_regex, |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 103 | header=re.escape(header))).strip() |
Victor Stinner | f048075 | 2011-03-31 11:34:08 +0200 | [diff] [blame] | 104 | if other_regex: |
| 105 | regex += '|' + other_regex |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 106 | output, exitcode = self.get_output(code, filename=filename, fd=fd) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 107 | output = '\n'.join(output) |
| 108 | self.assertRegex(output, regex) |
Victor Stinner | 05585cb | 2011-03-31 13:29:56 +0200 | [diff] [blame] | 109 | self.assertNotEqual(exitcode, 0) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 110 | |
Victor Stinner | 330426c | 2013-07-03 22:29:42 +0200 | [diff] [blame] | 111 | @unittest.skipIf(sys.platform.startswith('aix'), |
| 112 | "the first page of memory is a mapped read-only on AIX") |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 113 | def test_read_null(self): |
| 114 | self.check_fatal_error(""" |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 115 | import faulthandler |
| 116 | faulthandler.enable() |
| 117 | faulthandler._read_null() |
| 118 | """, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 119 | 3, |
Victor Stinner | a8db378 | 2011-08-08 22:43:45 +0200 | [diff] [blame] | 120 | # Issue #12700: Read NULL raises SIGILL on Mac OS X Lion |
| 121 | '(?:Segmentation fault|Bus error|Illegal instruction)') |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 122 | |
| 123 | def test_sigsegv(self): |
| 124 | self.check_fatal_error(""" |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 125 | import faulthandler |
| 126 | faulthandler.enable() |
| 127 | faulthandler._sigsegv() |
| 128 | """, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 129 | 3, |
| 130 | 'Segmentation fault') |
| 131 | |
Victor Stinner | d727e23 | 2011-04-01 12:13:55 +0200 | [diff] [blame] | 132 | def test_sigabrt(self): |
| 133 | self.check_fatal_error(""" |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 134 | import faulthandler |
| 135 | faulthandler.enable() |
| 136 | faulthandler._sigabrt() |
| 137 | """, |
Victor Stinner | d727e23 | 2011-04-01 12:13:55 +0200 | [diff] [blame] | 138 | 3, |
| 139 | 'Aborted') |
| 140 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 141 | @unittest.skipIf(sys.platform == 'win32', |
| 142 | "SIGFPE cannot be caught on Windows") |
| 143 | def test_sigfpe(self): |
| 144 | self.check_fatal_error(""" |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 145 | import faulthandler |
| 146 | faulthandler.enable() |
| 147 | faulthandler._sigfpe() |
| 148 | """, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 149 | 3, |
| 150 | 'Floating point exception') |
| 151 | |
Victor Stinner | 56e8c29 | 2014-07-21 12:30:22 +0200 | [diff] [blame] | 152 | @unittest.skipIf(_testcapi is None, 'need _testcapi') |
| 153 | @unittest.skipUnless(hasattr(signal, 'SIGBUS'), 'need signal.SIGBUS') |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 154 | def test_sigbus(self): |
| 155 | self.check_fatal_error(""" |
Victor Stinner | 68e0808 | 2014-08-10 19:51:05 +0200 | [diff] [blame] | 156 | import _testcapi |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 157 | import faulthandler |
Victor Stinner | 68e0808 | 2014-08-10 19:51:05 +0200 | [diff] [blame] | 158 | import signal |
Victor Stinner | 56e8c29 | 2014-07-21 12:30:22 +0200 | [diff] [blame] | 159 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 160 | faulthandler.enable() |
Victor Stinner | 68e0808 | 2014-08-10 19:51:05 +0200 | [diff] [blame] | 161 | _testcapi.raise_signal(signal.SIGBUS) |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 162 | """, |
Victor Stinner | 56e8c29 | 2014-07-21 12:30:22 +0200 | [diff] [blame] | 163 | 6, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 164 | 'Bus error') |
| 165 | |
Victor Stinner | 56e8c29 | 2014-07-21 12:30:22 +0200 | [diff] [blame] | 166 | @unittest.skipIf(_testcapi is None, 'need _testcapi') |
| 167 | @unittest.skipUnless(hasattr(signal, 'SIGILL'), 'need signal.SIGILL') |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 168 | def test_sigill(self): |
| 169 | self.check_fatal_error(""" |
Victor Stinner | 68e0808 | 2014-08-10 19:51:05 +0200 | [diff] [blame] | 170 | import _testcapi |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 171 | import faulthandler |
Victor Stinner | 68e0808 | 2014-08-10 19:51:05 +0200 | [diff] [blame] | 172 | import signal |
Victor Stinner | 56e8c29 | 2014-07-21 12:30:22 +0200 | [diff] [blame] | 173 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 174 | faulthandler.enable() |
Victor Stinner | 68e0808 | 2014-08-10 19:51:05 +0200 | [diff] [blame] | 175 | _testcapi.raise_signal(signal.SIGILL) |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 176 | """, |
Victor Stinner | 56e8c29 | 2014-07-21 12:30:22 +0200 | [diff] [blame] | 177 | 6, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 178 | 'Illegal instruction') |
| 179 | |
| 180 | def test_fatal_error(self): |
| 181 | self.check_fatal_error(""" |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 182 | import faulthandler |
| 183 | faulthandler._fatal_error(b'xyz') |
| 184 | """, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 185 | 2, |
| 186 | 'xyz') |
| 187 | |
Charles-François Natali | 3391e64 | 2011-09-01 23:08:21 +0200 | [diff] [blame] | 188 | @unittest.skipIf(sys.platform.startswith('openbsd') and HAVE_THREADS, |
| 189 | "Issue #12868: sigaltstack() doesn't work on " |
| 190 | "OpenBSD if Python is compiled with pthread") |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 191 | @unittest.skipIf(not hasattr(faulthandler, '_stack_overflow'), |
| 192 | 'need faulthandler._stack_overflow()') |
| 193 | def test_stack_overflow(self): |
| 194 | self.check_fatal_error(""" |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 195 | import faulthandler |
| 196 | faulthandler.enable() |
| 197 | faulthandler._stack_overflow() |
| 198 | """, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 199 | 3, |
Victor Stinner | f048075 | 2011-03-31 11:34:08 +0200 | [diff] [blame] | 200 | '(?:Segmentation fault|Bus error)', |
| 201 | other_regex='unable to raise a stack overflow') |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 202 | |
| 203 | def test_gil_released(self): |
| 204 | self.check_fatal_error(""" |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 205 | import faulthandler |
| 206 | faulthandler.enable() |
Victor Stinner | 5083828 | 2014-09-30 13:54:14 +0200 | [diff] [blame] | 207 | faulthandler._sigsegv(True) |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 208 | """, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 209 | 3, |
Victor Stinner | 5083828 | 2014-09-30 13:54:14 +0200 | [diff] [blame] | 210 | 'Segmentation fault') |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 211 | |
| 212 | def test_enable_file(self): |
| 213 | with temporary_filename() as filename: |
| 214 | self.check_fatal_error(""" |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 215 | import faulthandler |
| 216 | output = open({filename}, 'wb') |
| 217 | faulthandler.enable(output) |
| 218 | faulthandler._sigsegv() |
| 219 | """.format(filename=repr(filename)), |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 220 | 4, |
Victor Stinner | 5678539 | 2013-06-17 23:37:59 +0200 | [diff] [blame] | 221 | 'Segmentation fault', |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 222 | filename=filename) |
| 223 | |
Victor Stinner | ff2a661 | 2015-03-13 11:01:30 +0100 | [diff] [blame] | 224 | @unittest.skipIf(sys.platform == "win32", |
| 225 | "subprocess doesn't support pass_fds on Windows") |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 226 | def test_enable_fd(self): |
| 227 | with tempfile.TemporaryFile('wb+') as fp: |
| 228 | fd = fp.fileno() |
| 229 | self.check_fatal_error(""" |
| 230 | import faulthandler |
| 231 | import sys |
| 232 | faulthandler.enable(%s) |
| 233 | faulthandler._sigsegv() |
| 234 | """ % fd, |
| 235 | 4, |
| 236 | 'Segmentation fault', |
| 237 | fd=fd) |
| 238 | |
Victor Stinner | 7bba62f | 2011-05-07 12:43:00 +0200 | [diff] [blame] | 239 | def test_enable_single_thread(self): |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 240 | self.check_fatal_error(""" |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 241 | import faulthandler |
| 242 | faulthandler.enable(all_threads=False) |
| 243 | faulthandler._sigsegv() |
| 244 | """, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 245 | 3, |
Victor Stinner | 5678539 | 2013-06-17 23:37:59 +0200 | [diff] [blame] | 246 | 'Segmentation fault', |
Victor Stinner | 7bba62f | 2011-05-07 12:43:00 +0200 | [diff] [blame] | 247 | all_threads=False) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 248 | |
| 249 | def test_disable(self): |
| 250 | code = """ |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 251 | import faulthandler |
| 252 | faulthandler.enable() |
| 253 | faulthandler.disable() |
| 254 | faulthandler._sigsegv() |
| 255 | """ |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 256 | not_expected = 'Fatal Python error' |
Antoine Pitrou | 77e904e | 2013-10-08 23:04:32 +0200 | [diff] [blame] | 257 | stderr, exitcode = self.get_output(code) |
Victor Stinner | 29001c8 | 2014-09-25 00:38:48 +0200 | [diff] [blame] | 258 | stderr = '\n'.join(stderr) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 259 | self.assertTrue(not_expected not in stderr, |
| 260 | "%r is present in %r" % (not_expected, stderr)) |
Victor Stinner | 05585cb | 2011-03-31 13:29:56 +0200 | [diff] [blame] | 261 | self.assertNotEqual(exitcode, 0) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 262 | |
| 263 | def test_is_enabled(self): |
Victor Stinner | 7e32f3a | 2011-06-29 13:44:05 +0200 | [diff] [blame] | 264 | orig_stderr = sys.stderr |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 265 | try: |
Victor Stinner | 7e32f3a | 2011-06-29 13:44:05 +0200 | [diff] [blame] | 266 | # regrtest may replace sys.stderr by io.StringIO object, but |
| 267 | # faulthandler.enable() requires that sys.stderr has a fileno() |
| 268 | # method |
Victor Stinner | 7248850 | 2011-06-29 23:24:31 +0200 | [diff] [blame] | 269 | sys.stderr = sys.__stderr__ |
Victor Stinner | 7e32f3a | 2011-06-29 13:44:05 +0200 | [diff] [blame] | 270 | |
| 271 | was_enabled = faulthandler.is_enabled() |
| 272 | try: |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 273 | faulthandler.enable() |
Victor Stinner | 7e32f3a | 2011-06-29 13:44:05 +0200 | [diff] [blame] | 274 | self.assertTrue(faulthandler.is_enabled()) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 275 | faulthandler.disable() |
Victor Stinner | 7e32f3a | 2011-06-29 13:44:05 +0200 | [diff] [blame] | 276 | self.assertFalse(faulthandler.is_enabled()) |
| 277 | finally: |
| 278 | if was_enabled: |
| 279 | faulthandler.enable() |
| 280 | else: |
| 281 | faulthandler.disable() |
| 282 | finally: |
| 283 | sys.stderr = orig_stderr |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 284 | |
Victor Stinner | d5698cb | 2012-07-31 02:55:49 +0200 | [diff] [blame] | 285 | def test_disabled_by_default(self): |
| 286 | # By default, the module should be disabled |
| 287 | code = "import faulthandler; print(faulthandler.is_enabled())" |
Gregory P. Smith | fe7c5d6 | 2015-01-22 17:33:28 -0800 | [diff] [blame] | 288 | args = filter(None, (sys.executable, |
| 289 | "-E" if sys.flags.ignore_environment else "", |
| 290 | "-c", code)) |
| 291 | env = os.environ.copy() |
| 292 | env.pop("PYTHONFAULTHANDLER", None) |
| 293 | # don't use assert_python_ok() because it always enables faulthandler |
| 294 | output = subprocess.check_output(args, env=env) |
Victor Stinner | 8898350 | 2013-09-08 11:36:23 +0200 | [diff] [blame] | 295 | self.assertEqual(output.rstrip(), b"False") |
Victor Stinner | d5698cb | 2012-07-31 02:55:49 +0200 | [diff] [blame] | 296 | |
| 297 | def test_sys_xoptions(self): |
| 298 | # Test python -X faulthandler |
| 299 | code = "import faulthandler; print(faulthandler.is_enabled())" |
Gregory P. Smith | fe7c5d6 | 2015-01-22 17:33:28 -0800 | [diff] [blame] | 300 | args = filter(None, (sys.executable, |
| 301 | "-E" if sys.flags.ignore_environment else "", |
| 302 | "-X", "faulthandler", "-c", code)) |
| 303 | env = os.environ.copy() |
| 304 | env.pop("PYTHONFAULTHANDLER", None) |
| 305 | # don't use assert_python_ok() because it always enables faulthandler |
| 306 | output = subprocess.check_output(args, env=env) |
Victor Stinner | 8898350 | 2013-09-08 11:36:23 +0200 | [diff] [blame] | 307 | self.assertEqual(output.rstrip(), b"True") |
| 308 | |
| 309 | def test_env_var(self): |
| 310 | # empty env var |
| 311 | code = "import faulthandler; print(faulthandler.is_enabled())" |
| 312 | args = (sys.executable, "-c", code) |
| 313 | env = os.environ.copy() |
| 314 | env['PYTHONFAULTHANDLER'] = '' |
Gregory P. Smith | fe7c5d6 | 2015-01-22 17:33:28 -0800 | [diff] [blame] | 315 | # don't use assert_python_ok() because it always enables faulthandler |
Victor Stinner | 8898350 | 2013-09-08 11:36:23 +0200 | [diff] [blame] | 316 | output = subprocess.check_output(args, env=env) |
| 317 | self.assertEqual(output.rstrip(), b"False") |
| 318 | |
| 319 | # non-empty env var |
| 320 | env = os.environ.copy() |
| 321 | env['PYTHONFAULTHANDLER'] = '1' |
| 322 | output = subprocess.check_output(args, env=env) |
| 323 | self.assertEqual(output.rstrip(), b"True") |
Victor Stinner | d5698cb | 2012-07-31 02:55:49 +0200 | [diff] [blame] | 324 | |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 325 | def check_dump_traceback(self, *, filename=None, fd=None): |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 326 | """ |
| 327 | Explicitly call dump_traceback() function and check its output. |
| 328 | Raise an error if the output doesn't match the expected format. |
| 329 | """ |
| 330 | code = """ |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 331 | import faulthandler |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 332 | |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 333 | filename = {filename!r} |
| 334 | fd = {fd} |
| 335 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 336 | def funcB(): |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 337 | if filename: |
| 338 | with open(filename, "wb") as fp: |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 339 | faulthandler.dump_traceback(fp, all_threads=False) |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 340 | elif fd is not None: |
| 341 | faulthandler.dump_traceback(fd, |
| 342 | all_threads=False) |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 343 | else: |
| 344 | faulthandler.dump_traceback(all_threads=False) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 345 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 346 | def funcA(): |
| 347 | funcB() |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 348 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 349 | funcA() |
| 350 | """ |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 351 | code = code.format( |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 352 | filename=filename, |
| 353 | fd=fd, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 354 | ) |
| 355 | if filename: |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 356 | lineno = 9 |
| 357 | elif fd is not None: |
| 358 | lineno = 12 |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 359 | else: |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 360 | lineno = 14 |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 361 | expected = [ |
Guido van Rossum | 7be5d7d | 2013-10-20 18:21:02 -0700 | [diff] [blame] | 362 | 'Stack (most recent call first):', |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 363 | ' File "<string>", line %s in funcB' % lineno, |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 364 | ' File "<string>", line 17 in funcA', |
| 365 | ' File "<string>", line 19 in <module>' |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 366 | ] |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 367 | trace, exitcode = self.get_output(code, filename, fd) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 368 | self.assertEqual(trace, expected) |
Victor Stinner | 05585cb | 2011-03-31 13:29:56 +0200 | [diff] [blame] | 369 | self.assertEqual(exitcode, 0) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 370 | |
| 371 | def test_dump_traceback(self): |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 372 | self.check_dump_traceback() |
Victor Stinner | 1940233 | 2011-03-31 18:15:52 +0200 | [diff] [blame] | 373 | |
| 374 | def test_dump_traceback_file(self): |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 375 | with temporary_filename() as filename: |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 376 | self.check_dump_traceback(filename=filename) |
| 377 | |
Victor Stinner | ff2a661 | 2015-03-13 11:01:30 +0100 | [diff] [blame] | 378 | @unittest.skipIf(sys.platform == "win32", |
| 379 | "subprocess doesn't support pass_fds on Windows") |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 380 | def test_dump_traceback_fd(self): |
| 381 | with tempfile.TemporaryFile('wb+') as fp: |
| 382 | self.check_dump_traceback(fd=fp.fileno()) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 383 | |
Victor Stinner | 53386d8 | 2012-08-01 19:45:34 +0200 | [diff] [blame] | 384 | def test_truncate(self): |
| 385 | maxlen = 500 |
| 386 | func_name = 'x' * (maxlen + 50) |
| 387 | truncated = 'x' * maxlen + '...' |
| 388 | code = """ |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 389 | import faulthandler |
Victor Stinner | 53386d8 | 2012-08-01 19:45:34 +0200 | [diff] [blame] | 390 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 391 | def {func_name}(): |
| 392 | faulthandler.dump_traceback(all_threads=False) |
Victor Stinner | 53386d8 | 2012-08-01 19:45:34 +0200 | [diff] [blame] | 393 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 394 | {func_name}() |
| 395 | """ |
Victor Stinner | 53386d8 | 2012-08-01 19:45:34 +0200 | [diff] [blame] | 396 | code = code.format( |
| 397 | func_name=func_name, |
| 398 | ) |
| 399 | expected = [ |
Guido van Rossum | 7be5d7d | 2013-10-20 18:21:02 -0700 | [diff] [blame] | 400 | 'Stack (most recent call first):', |
Victor Stinner | 53386d8 | 2012-08-01 19:45:34 +0200 | [diff] [blame] | 401 | ' File "<string>", line 4 in %s' % truncated, |
| 402 | ' File "<string>", line 6 in <module>' |
| 403 | ] |
| 404 | trace, exitcode = self.get_output(code) |
| 405 | self.assertEqual(trace, expected) |
| 406 | self.assertEqual(exitcode, 0) |
| 407 | |
Victor Stinner | ff4cd88 | 2011-04-07 11:50:25 +0200 | [diff] [blame] | 408 | @unittest.skipIf(not HAVE_THREADS, 'need threads') |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 409 | def check_dump_traceback_threads(self, filename): |
| 410 | """ |
| 411 | Call explicitly dump_traceback(all_threads=True) and check the output. |
| 412 | Raise an error if the output doesn't match the expected format. |
| 413 | """ |
| 414 | code = """ |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 415 | import faulthandler |
| 416 | from threading import Thread, Event |
| 417 | import time |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 418 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 419 | def dump(): |
| 420 | if {filename}: |
| 421 | with open({filename}, "wb") as fp: |
| 422 | faulthandler.dump_traceback(fp, all_threads=True) |
| 423 | else: |
| 424 | faulthandler.dump_traceback(all_threads=True) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 425 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 426 | class Waiter(Thread): |
| 427 | # avoid blocking if the main thread raises an exception. |
| 428 | daemon = True |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 429 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 430 | def __init__(self): |
| 431 | Thread.__init__(self) |
| 432 | self.running = Event() |
| 433 | self.stop = Event() |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 434 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 435 | def run(self): |
| 436 | self.running.set() |
| 437 | self.stop.wait() |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 438 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 439 | waiter = Waiter() |
| 440 | waiter.start() |
| 441 | waiter.running.wait() |
| 442 | dump() |
| 443 | waiter.stop.set() |
| 444 | waiter.join() |
| 445 | """ |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 446 | code = code.format(filename=repr(filename)) |
Victor Stinner | 05585cb | 2011-03-31 13:29:56 +0200 | [diff] [blame] | 447 | output, exitcode = self.get_output(code, filename) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 448 | output = '\n'.join(output) |
| 449 | if filename: |
| 450 | lineno = 8 |
| 451 | else: |
| 452 | lineno = 10 |
| 453 | regex = """ |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 454 | ^Thread 0x[0-9a-f]+ \(most recent call first\): |
| 455 | (?: File ".*threading.py", line [0-9]+ in [_a-z]+ |
| 456 | ){{1,3}} File "<string>", line 23 in run |
| 457 | File ".*threading.py", line [0-9]+ in _bootstrap_inner |
| 458 | File ".*threading.py", line [0-9]+ in _bootstrap |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 459 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 460 | Current thread XXX \(most recent call first\): |
| 461 | File "<string>", line {lineno} in dump |
| 462 | File "<string>", line 28 in <module>$ |
| 463 | """ |
| 464 | regex = dedent(regex.format(lineno=lineno)).strip() |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 465 | self.assertRegex(output, regex) |
Victor Stinner | 05585cb | 2011-03-31 13:29:56 +0200 | [diff] [blame] | 466 | self.assertEqual(exitcode, 0) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 467 | |
| 468 | def test_dump_traceback_threads(self): |
| 469 | self.check_dump_traceback_threads(None) |
Victor Stinner | 1940233 | 2011-03-31 18:15:52 +0200 | [diff] [blame] | 470 | |
| 471 | def test_dump_traceback_threads_file(self): |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 472 | with temporary_filename() as filename: |
| 473 | self.check_dump_traceback_threads(filename) |
| 474 | |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 475 | @unittest.skipIf(not hasattr(faulthandler, 'dump_traceback_later'), |
| 476 | 'need faulthandler.dump_traceback_later()') |
| 477 | def check_dump_traceback_later(self, repeat=False, cancel=False, loops=1, |
| 478 | *, filename=None, fd=None): |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 479 | """ |
| 480 | Check how many times the traceback is written in timeout x 2.5 seconds, |
| 481 | or timeout x 3.5 seconds if cancel is True: 1, 2 or 3 times depending |
| 482 | on repeat and cancel options. |
| 483 | |
| 484 | Raise an error if the output doesn't match the expect format. |
| 485 | """ |
Victor Stinner | c790a53 | 2011-04-08 13:39:59 +0200 | [diff] [blame] | 486 | timeout_str = str(datetime.timedelta(seconds=TIMEOUT)) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 487 | code = """ |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 488 | import faulthandler |
| 489 | import time |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 490 | import sys |
| 491 | |
| 492 | timeout = {timeout} |
| 493 | repeat = {repeat} |
| 494 | cancel = {cancel} |
| 495 | loops = {loops} |
| 496 | filename = {filename!r} |
| 497 | fd = {fd} |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 498 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 499 | def func(timeout, repeat, cancel, file, loops): |
| 500 | for loop in range(loops): |
| 501 | faulthandler.dump_traceback_later(timeout, repeat=repeat, file=file) |
| 502 | if cancel: |
| 503 | faulthandler.cancel_dump_traceback_later() |
| 504 | time.sleep(timeout * 5) |
| 505 | faulthandler.cancel_dump_traceback_later() |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 506 | |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 507 | if filename: |
| 508 | file = open(filename, "wb") |
| 509 | elif fd is not None: |
| 510 | file = sys.stderr.fileno() |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 511 | else: |
| 512 | file = None |
| 513 | func(timeout, repeat, cancel, file, loops) |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 514 | if filename: |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 515 | file.close() |
| 516 | """ |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 517 | code = code.format( |
Victor Stinner | de10f40 | 2011-04-08 12:57:06 +0200 | [diff] [blame] | 518 | timeout=TIMEOUT, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 519 | repeat=repeat, |
| 520 | cancel=cancel, |
Victor Stinner | de10f40 | 2011-04-08 12:57:06 +0200 | [diff] [blame] | 521 | loops=loops, |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 522 | filename=filename, |
| 523 | fd=fd, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 524 | ) |
Victor Stinner | 05585cb | 2011-03-31 13:29:56 +0200 | [diff] [blame] | 525 | trace, exitcode = self.get_output(code, filename) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 526 | trace = '\n'.join(trace) |
| 527 | |
Victor Stinner | f77ccc6 | 2011-04-03 18:45:42 +0200 | [diff] [blame] | 528 | if not cancel: |
Victor Stinner | de10f40 | 2011-04-08 12:57:06 +0200 | [diff] [blame] | 529 | count = loops |
Victor Stinner | f77ccc6 | 2011-04-03 18:45:42 +0200 | [diff] [blame] | 530 | if repeat: |
Victor Stinner | de10f40 | 2011-04-08 12:57:06 +0200 | [diff] [blame] | 531 | count *= 2 |
Guido van Rossum | 7be5d7d | 2013-10-20 18:21:02 -0700 | [diff] [blame] | 532 | header = r'Timeout \(%s\)!\nThread 0x[0-9a-f]+ \(most recent call first\):\n' % timeout_str |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 533 | regex = expected_traceback(17, 26, header, min_count=count) |
Victor Stinner | f77ccc6 | 2011-04-03 18:45:42 +0200 | [diff] [blame] | 534 | self.assertRegex(trace, regex) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 535 | else: |
Victor Stinner | f77ccc6 | 2011-04-03 18:45:42 +0200 | [diff] [blame] | 536 | self.assertEqual(trace, '') |
Victor Stinner | 05585cb | 2011-03-31 13:29:56 +0200 | [diff] [blame] | 537 | self.assertEqual(exitcode, 0) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 538 | |
Georg Brandl | deb92b5 | 2012-09-22 08:58:55 +0200 | [diff] [blame] | 539 | def test_dump_traceback_later(self): |
| 540 | self.check_dump_traceback_later() |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 541 | |
Georg Brandl | deb92b5 | 2012-09-22 08:58:55 +0200 | [diff] [blame] | 542 | def test_dump_traceback_later_repeat(self): |
| 543 | self.check_dump_traceback_later(repeat=True) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 544 | |
Georg Brandl | deb92b5 | 2012-09-22 08:58:55 +0200 | [diff] [blame] | 545 | def test_dump_traceback_later_cancel(self): |
| 546 | self.check_dump_traceback_later(cancel=True) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 547 | |
Georg Brandl | deb92b5 | 2012-09-22 08:58:55 +0200 | [diff] [blame] | 548 | def test_dump_traceback_later_file(self): |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 549 | with temporary_filename() as filename: |
| 550 | self.check_dump_traceback_later(filename=filename) |
| 551 | |
Victor Stinner | ff2a661 | 2015-03-13 11:01:30 +0100 | [diff] [blame] | 552 | @unittest.skipIf(sys.platform == "win32", |
| 553 | "subprocess doesn't support pass_fds on Windows") |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 554 | def test_dump_traceback_later_fd(self): |
| 555 | with tempfile.TemporaryFile('wb+') as fp: |
| 556 | self.check_dump_traceback_later(fd=fp.fileno()) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 557 | |
Georg Brandl | deb92b5 | 2012-09-22 08:58:55 +0200 | [diff] [blame] | 558 | def test_dump_traceback_later_twice(self): |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 559 | self.check_dump_traceback_later(loops=2) |
Victor Stinner | de10f40 | 2011-04-08 12:57:06 +0200 | [diff] [blame] | 560 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 561 | @unittest.skipIf(not hasattr(faulthandler, "register"), |
| 562 | "need faulthandler.register") |
Victor Stinner | a01ca12 | 2011-04-01 12:56:17 +0200 | [diff] [blame] | 563 | def check_register(self, filename=False, all_threads=False, |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 564 | unregister=False, chain=False, fd=None): |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 565 | """ |
| 566 | Register a handler displaying the traceback on a user signal. Raise the |
| 567 | signal and check the written traceback. |
| 568 | |
Victor Stinner | a9a9dab | 2011-07-13 23:39:53 +0200 | [diff] [blame] | 569 | If chain is True, check that the previous signal handler is called. |
| 570 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 571 | Raise an error if the output doesn't match the expected format. |
| 572 | """ |
Victor Stinner | a01ca12 | 2011-04-01 12:56:17 +0200 | [diff] [blame] | 573 | signum = signal.SIGUSR1 |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 574 | code = """ |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 575 | import faulthandler |
| 576 | import os |
| 577 | import signal |
| 578 | import sys |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 579 | |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 580 | all_threads = {all_threads} |
| 581 | signum = {signum} |
| 582 | unregister = {unregister} |
| 583 | chain = {chain} |
| 584 | filename = {filename!r} |
| 585 | fd = {fd} |
| 586 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 587 | def func(signum): |
| 588 | os.kill(os.getpid(), signum) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 589 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 590 | def handler(signum, frame): |
| 591 | handler.called = True |
| 592 | handler.called = False |
Victor Stinner | a9a9dab | 2011-07-13 23:39:53 +0200 | [diff] [blame] | 593 | |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 594 | if filename: |
| 595 | file = open(filename, "wb") |
| 596 | elif fd is not None: |
| 597 | file = sys.stderr.fileno() |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 598 | else: |
| 599 | file = None |
| 600 | if chain: |
| 601 | signal.signal(signum, handler) |
| 602 | faulthandler.register(signum, file=file, |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 603 | all_threads=all_threads, chain={chain}) |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 604 | if unregister: |
| 605 | faulthandler.unregister(signum) |
| 606 | func(signum) |
| 607 | if chain and not handler.called: |
| 608 | if file is not None: |
| 609 | output = file |
| 610 | else: |
| 611 | output = sys.stderr |
| 612 | print("Error: signal handler not called!", file=output) |
| 613 | exitcode = 1 |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 614 | else: |
| 615 | exitcode = 0 |
| 616 | if filename: |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 617 | file.close() |
| 618 | sys.exit(exitcode) |
| 619 | """ |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 620 | code = code.format( |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 621 | all_threads=all_threads, |
Victor Stinner | a01ca12 | 2011-04-01 12:56:17 +0200 | [diff] [blame] | 622 | signum=signum, |
| 623 | unregister=unregister, |
Victor Stinner | a9a9dab | 2011-07-13 23:39:53 +0200 | [diff] [blame] | 624 | chain=chain, |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 625 | filename=filename, |
| 626 | fd=fd, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 627 | ) |
Victor Stinner | 05585cb | 2011-03-31 13:29:56 +0200 | [diff] [blame] | 628 | trace, exitcode = self.get_output(code, filename) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 629 | trace = '\n'.join(trace) |
Victor Stinner | a01ca12 | 2011-04-01 12:56:17 +0200 | [diff] [blame] | 630 | if not unregister: |
| 631 | if all_threads: |
Guido van Rossum | 7be5d7d | 2013-10-20 18:21:02 -0700 | [diff] [blame] | 632 | regex = 'Current thread XXX \(most recent call first\):\n' |
Victor Stinner | a01ca12 | 2011-04-01 12:56:17 +0200 | [diff] [blame] | 633 | else: |
Guido van Rossum | 7be5d7d | 2013-10-20 18:21:02 -0700 | [diff] [blame] | 634 | regex = 'Stack \(most recent call first\):\n' |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 635 | regex = expected_traceback(14, 32, regex) |
Victor Stinner | a01ca12 | 2011-04-01 12:56:17 +0200 | [diff] [blame] | 636 | self.assertRegex(trace, regex) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 637 | else: |
Victor Stinner | a01ca12 | 2011-04-01 12:56:17 +0200 | [diff] [blame] | 638 | self.assertEqual(trace, '') |
| 639 | if unregister: |
| 640 | self.assertNotEqual(exitcode, 0) |
| 641 | else: |
| 642 | self.assertEqual(exitcode, 0) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 643 | |
| 644 | def test_register(self): |
| 645 | self.check_register() |
| 646 | |
Victor Stinner | a01ca12 | 2011-04-01 12:56:17 +0200 | [diff] [blame] | 647 | def test_unregister(self): |
| 648 | self.check_register(unregister=True) |
| 649 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 650 | def test_register_file(self): |
| 651 | with temporary_filename() as filename: |
| 652 | self.check_register(filename=filename) |
| 653 | |
Victor Stinner | ff2a661 | 2015-03-13 11:01:30 +0100 | [diff] [blame] | 654 | @unittest.skipIf(sys.platform == "win32", |
| 655 | "subprocess doesn't support pass_fds on Windows") |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 656 | def test_register_fd(self): |
| 657 | with tempfile.TemporaryFile('wb+') as fp: |
| 658 | self.check_register(fd=fp.fileno()) |
| 659 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 660 | def test_register_threads(self): |
| 661 | self.check_register(all_threads=True) |
| 662 | |
Victor Stinner | a9a9dab | 2011-07-13 23:39:53 +0200 | [diff] [blame] | 663 | def test_register_chain(self): |
| 664 | self.check_register(chain=True) |
| 665 | |
Victor Stinner | e2d6690 | 2014-05-14 17:15:50 +0200 | [diff] [blame] | 666 | @contextmanager |
| 667 | def check_stderr_none(self): |
| 668 | stderr = sys.stderr |
| 669 | try: |
| 670 | sys.stderr = None |
| 671 | with self.assertRaises(RuntimeError) as cm: |
| 672 | yield |
| 673 | self.assertEqual(str(cm.exception), "sys.stderr is None") |
| 674 | finally: |
| 675 | sys.stderr = stderr |
| 676 | |
| 677 | def test_stderr_None(self): |
| 678 | # Issue #21497: provide an helpful error if sys.stderr is None, |
| 679 | # instead of just an attribute error: "None has no attribute fileno". |
| 680 | with self.check_stderr_none(): |
| 681 | faulthandler.enable() |
| 682 | with self.check_stderr_none(): |
| 683 | faulthandler.dump_traceback() |
| 684 | if hasattr(faulthandler, 'dump_traceback_later'): |
| 685 | with self.check_stderr_none(): |
| 686 | faulthandler.dump_traceback_later(1e-3) |
| 687 | if hasattr(faulthandler, "register"): |
| 688 | with self.check_stderr_none(): |
| 689 | faulthandler.register(signal.SIGUSR1) |
| 690 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 691 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 692 | if __name__ == "__main__": |
Brett Cannon | 3e9a9ae | 2013-06-12 21:25:59 -0400 | [diff] [blame] | 693 | unittest.main() |