1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
"""
Tests for L{eliot._traceback}.
"""
from unittest import TestCase, SkipTest
import traceback
import sys
try:
from twisted.python.failure import Failure
except ImportError:
Failure = None
from .._traceback import write_traceback, writeFailure, _writeTracebackMessage
from ..testing import (
assertContainsFields,
validateLogging,
capture_logging,
MemoryLogger,
)
from .._errors import register_exception_extractor
from .test_action import make_error_extraction_tests
def assert_expected_traceback(test, logger, message, exception, expected_traceback):
"""Assert we logged the given exception and the expected traceback."""
lines = expected_traceback.split("\n")
# Remove source code lines:
expected_traceback = "\n".join([l for l in lines if not l.startswith(" ")])
assertContainsFields(
test,
message,
{
"message_type": "eliot:traceback",
"exception": RuntimeError,
"reason": exception,
"traceback": expected_traceback,
},
)
logger.flushTracebacks(RuntimeError)
class TracebackLoggingTests(TestCase):
"""
Tests for L{write_traceback} and L{writeFailure}.
"""
@validateLogging(None)
def test_write_traceback_implicit(self, logger):
"""
L{write_traceback} with no arguments writes the current traceback to
the log.
"""
e = None
def raiser():
raise RuntimeError("because")
try:
raiser()
except Exception as exception:
expected_traceback = traceback.format_exc()
write_traceback(logger)
e = exception
assert_expected_traceback(
self, logger, logger.messages[0], e, expected_traceback
)
@validateLogging(None)
def test_write_traceback_explicit(self, logger):
"""
L{write_traceback} with explicit arguments writes the given traceback
to the log.
"""
e = None
def raiser():
raise RuntimeError("because")
try:
raiser()
except Exception as exception:
expected_traceback = traceback.format_exc()
write_traceback(logger, exc_info=sys.exc_info())
e = exception
assert_expected_traceback(
self, logger, logger.messages[0], e, expected_traceback
)
@capture_logging(None)
def test_writeTracebackDefaultLogger(self, logger):
"""
L{write_traceback} writes to the default log, if none is
specified.
"""
def raiser():
raise RuntimeError("because")
try:
raiser()
except Exception:
write_traceback()
message = logger.messages[0]
assertContainsFields(self, message, {"message_type": "eliot:traceback"})
logger.flushTracebacks(RuntimeError)
@validateLogging(None)
def test_writeFailure(self, logger):
"""
L{writeFailure} writes a L{Failure} to the log.
"""
if Failure is None:
raise SkipTest("Twisted unavailable")
try:
raise RuntimeError("because")
except:
failure = Failure()
expectedTraceback = failure.getBriefTraceback()
writeFailure(failure, logger)
message = logger.messages[0]
assertContainsFields(
self,
message,
{
"message_type": "eliot:traceback",
"exception": RuntimeError,
"reason": failure.value,
"traceback": expectedTraceback,
},
)
logger.flushTracebacks(RuntimeError)
@capture_logging(None)
def test_writeFailureDefaultLogger(self, logger):
"""
L{writeFailure} writes to the default log, if none is
specified.
"""
if Failure is None:
raise SkipTest("Twisted unavailable")
try:
raise RuntimeError("because")
except:
failure = Failure()
writeFailure(failure)
message = logger.messages[0]
assertContainsFields(self, message, {"message_type": "eliot:traceback"})
logger.flushTracebacks(RuntimeError)
@validateLogging(None)
def test_writeFailureResult(self, logger):
"""
L{writeFailure} returns C{None}.
"""
if Failure is None:
raise SkipTest("Twisted unavailable")
try:
raise RuntimeError("because")
except:
result = writeFailure(Failure(), logger)
self.assertIs(result, None)
logger.flushTracebacks(RuntimeError)
@validateLogging(None)
def test_serialization(self, logger):
"""
L{_writeTracebackMessage} serializes exceptions to string values and
types to FQPN.
"""
try:
raise KeyError(123)
except:
exc_info = sys.exc_info()
_writeTracebackMessage(logger, *exc_info)
serialized = logger.serialize()[0]
assertContainsFields(
self,
serialized,
{"exception": "%s.KeyError" % (KeyError.__module__,), "reason": "123"},
)
logger.flushTracebacks(KeyError)
@validateLogging(None)
def test_badException(self, logger):
"""
L{_writeTracebackMessage} logs a message even if given a bad exception.
"""
class BadException(Exception):
def __str__(self):
raise TypeError()
try:
raise BadException()
except BadException:
exc_info = sys.exc_info()
_writeTracebackMessage(logger, *exc_info)
self.assertEqual(
logger.serialize()[0]["reason"],
"eliot: unknown, str() raised exception",
)
logger.flushTracebacks(BadException)
def get_traceback_messages(exception):
"""
Given an exception instance generate a traceback Eliot message.
"""
logger = MemoryLogger()
try:
raise exception
except exception.__class__:
write_traceback(logger)
# MemoryLogger.validate() mutates messages:
# https://github.com/itamarst/eliot/issues/243
messages = [message.copy() for message in logger.messages]
logger.validate()
return messages
class TracebackExtractionTests(make_error_extraction_tests(get_traceback_messages)):
"""
Error extraction tests for tracebacks.
"""
def test_regular_fields(self):
"""
The normal traceback fields are still present when error
extraction is used.
"""
class MyException(Exception):
pass
register_exception_extractor(MyException, lambda e: {"key": e.args[0]})
exception = MyException("because")
messages = get_traceback_messages(exception)
assertContainsFields(
self,
messages[0],
{
"message_type": "eliot:traceback",
"reason": exception,
"exception": MyException,
},
)
|
