/
test_debug.py
362 lines (303 loc) · 12.7 KB
/
test_debug.py
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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
import io
import re
import sys
import pytest
from werkzeug.debug import console
from werkzeug.debug import DebuggedApplication
from werkzeug.debug import get_current_traceback
from werkzeug.debug import get_machine_id
from werkzeug.debug.console import HTMLStringO
from werkzeug.debug.repr import debug_repr
from werkzeug.debug.repr import DebugReprGenerator
from werkzeug.debug.repr import dump
from werkzeug.debug.repr import helper
from werkzeug.debug.tbtools import Traceback
from werkzeug.test import Client
from werkzeug.wrappers import Request
class TestDebugRepr:
def test_basic_repr(self):
assert debug_repr([]) == "[]"
assert debug_repr([1, 2]) == (
'[<span class="number">1</span>, <span class="number">2</span>]'
)
assert debug_repr([1, "test"]) == (
'[<span class="number">1</span>,'
' <span class="string">'test'</span>]'
)
assert debug_repr([None]) == '[<span class="object">None</span>]'
def test_string_repr(self):
assert debug_repr("") == '<span class="string">''</span>'
assert debug_repr("foo") == '<span class="string">'foo'</span>'
assert debug_repr("s" * 80) == (
f'<span class="string">'{"s" * 69}'
f'<span class="extended">{"s" * 11}'</span></span>'
)
assert debug_repr("<" * 80) == (
f'<span class="string">'{"<" * 69}'
f'<span class="extended">{"<" * 11}'</span></span>'
)
def test_string_subclass_repr(self):
class Test(str):
pass
assert debug_repr(Test("foo")) == (
'<span class="module">test_debug.</span>'
'Test(<span class="string">'foo'</span>)'
)
def test_sequence_repr(self):
assert debug_repr(list(range(20))) == (
'[<span class="number">0</span>, <span class="number">1</span>, '
'<span class="number">2</span>, <span class="number">3</span>, '
'<span class="number">4</span>, <span class="number">5</span>, '
'<span class="number">6</span>, <span class="number">7</span>, '
'<span class="extended"><span class="number">8</span>, '
'<span class="number">9</span>, <span class="number">10</span>, '
'<span class="number">11</span>, <span class="number">12</span>, '
'<span class="number">13</span>, <span class="number">14</span>, '
'<span class="number">15</span>, <span class="number">16</span>, '
'<span class="number">17</span>, <span class="number">18</span>, '
'<span class="number">19</span></span>]'
)
def test_mapping_repr(self):
assert debug_repr({}) == "{}"
assert debug_repr({"foo": 42}) == (
'{<span class="pair"><span class="key"><span class="string">'foo''
'</span></span>: <span class="value"><span class="number">42'
"</span></span></span>}"
)
assert debug_repr(dict(zip(range(10), [None] * 10))) == (
'{<span class="pair"><span class="key"><span class="number">0'
'</span></span>: <span class="value"><span class="object">None'
"</span></span></span>, "
'<span class="pair"><span class="key"><span class="number">1'
'</span></span>: <span class="value"><span class="object">None'
"</span></span></span>, "
'<span class="pair"><span class="key"><span class="number">2'
'</span></span>: <span class="value"><span class="object">None'
"</span></span></span>, "
'<span class="pair"><span class="key"><span class="number">3'
'</span></span>: <span class="value"><span class="object">None'
"</span></span></span>, "
'<span class="extended">'
'<span class="pair"><span class="key"><span class="number">4'
'</span></span>: <span class="value"><span class="object">None'
"</span></span></span>, "
'<span class="pair"><span class="key"><span class="number">5'
'</span></span>: <span class="value"><span class="object">None'
"</span></span></span>, "
'<span class="pair"><span class="key"><span class="number">6'
'</span></span>: <span class="value"><span class="object">None'
"</span></span></span>, "
'<span class="pair"><span class="key"><span class="number">7'
'</span></span>: <span class="value"><span class="object">None'
"</span></span></span>, "
'<span class="pair"><span class="key"><span class="number">8'
'</span></span>: <span class="value"><span class="object">None'
"</span></span></span>, "
'<span class="pair"><span class="key"><span class="number">9'
'</span></span>: <span class="value"><span class="object">None'
"</span></span></span></span>}"
)
assert debug_repr((1, "zwei", "drei")) == (
'(<span class="number">1</span>, <span class="string">''
'zwei'</span>, <span class="string">'drei'</span>)'
)
def test_custom_repr(self):
class Foo:
def __repr__(self):
return "<Foo 42>"
assert debug_repr(Foo()) == '<span class="object"><Foo 42></span>'
def test_list_subclass_repr(self):
class MyList(list):
pass
assert debug_repr(MyList([1, 2])) == (
'<span class="module">test_debug.</span>MyList(['
'<span class="number">1</span>, <span class="number">2</span>])'
)
def test_regex_repr(self):
assert (
debug_repr(re.compile(r"foo\d"))
== "re.compile(<span class=\"string regex\">r'foo\\d'</span>)"
)
# No ur'' in Py3
# https://bugs.python.org/issue15096
assert debug_repr(re.compile("foo\\d")) == (
"re.compile(<span class=\"string regex\">r'foo\\d'</span>)"
)
def test_set_repr(self):
assert (
debug_repr(frozenset("x"))
== 'frozenset([<span class="string">'x'</span>])'
)
assert debug_repr(set("x")) == (
'set([<span class="string">'x'</span>])'
)
def test_recursive_repr(self):
a = [1]
a.append(a)
assert debug_repr(a) == '[<span class="number">1</span>, [...]]'
def test_broken_repr(self):
class Foo:
def __repr__(self):
raise Exception("broken!")
assert debug_repr(Foo()) == (
'<span class="brokenrepr"><broken repr (Exception: '
"broken!)></span>"
)
class Foo:
x = 42
y = 23
def __init__(self):
self.z = 15
class TestDebugHelpers:
def test_object_dumping(self):
drg = DebugReprGenerator()
out = drg.dump_object(Foo())
assert re.search("Details for test_debug.Foo object at", out)
assert re.search('<th>x.*<span class="number">42</span>', out, flags=re.DOTALL)
assert re.search('<th>y.*<span class="number">23</span>', out, flags=re.DOTALL)
assert re.search('<th>z.*<span class="number">15</span>', out, flags=re.DOTALL)
out = drg.dump_object({"x": 42, "y": 23})
assert re.search("Contents of", out)
assert re.search('<th>x.*<span class="number">42</span>', out, flags=re.DOTALL)
assert re.search('<th>y.*<span class="number">23</span>', out, flags=re.DOTALL)
out = drg.dump_object({"x": 42, "y": 23, 23: 11})
assert not re.search("Contents of", out)
out = drg.dump_locals({"x": 42, "y": 23})
assert re.search("Local variables in frame", out)
assert re.search('<th>x.*<span class="number">42</span>', out, flags=re.DOTALL)
assert re.search('<th>y.*<span class="number">23</span>', out, flags=re.DOTALL)
def test_debug_dump(self):
old = sys.stdout
sys.stdout = HTMLStringO()
try:
dump([1, 2, 3])
x = sys.stdout.reset()
dump()
y = sys.stdout.reset()
finally:
sys.stdout = old
assert "Details for list object at" in x
assert '<span class="number">1</span>' in x
assert "Local variables in frame" in y
assert "<th>x" in y
assert "<th>old" in y
def test_debug_help(self):
old = sys.stdout
sys.stdout = HTMLStringO()
try:
helper([1, 2, 3])
x = sys.stdout.reset()
finally:
sys.stdout = old
assert "Help on list object" in x
assert "__delitem__" in x
def test_exc_divider_found_on_chained_exception(self):
@Request.application
def app(request):
def do_something():
raise ValueError("inner")
try:
do_something()
except ValueError:
raise KeyError("outer")
debugged = DebuggedApplication(app)
client = Client(debugged)
response = client.get("/")
data = response.get_data(as_text=True)
assert 'raise ValueError("inner")' in data
assert '<div class="exc-divider">' in data
assert 'raise KeyError("outer")' in data
class TestTraceback:
def test_log(self):
try:
1 / 0
except ZeroDivisionError:
traceback = Traceback(*sys.exc_info())
buffer_ = io.StringIO()
traceback.log(buffer_)
assert buffer_.getvalue().strip() == traceback.plaintext.strip()
def test_sourcelines_encoding(self):
source = (
"# -*- coding: latin1 -*-\n\n"
"def foo():\n"
' """höhö"""\n'
" 1 / 0\n"
"foo()"
).encode("latin1")
code = compile(source, filename="lol.py", mode="exec")
try:
eval(code)
except ZeroDivisionError:
traceback = Traceback(*sys.exc_info())
frames = traceback.frames
assert len(frames) == 3
assert frames[1].filename == "lol.py"
assert frames[2].filename == "lol.py"
class Loader:
def get_source(self, module):
return source
frames[1].loader = frames[2].loader = Loader()
assert frames[1].sourcelines == frames[2].sourcelines
assert [line.code for line in frames[1].get_annotated_lines()] == [
line.code for line in frames[2].get_annotated_lines()
]
assert "höhö" in frames[1].sourcelines[3]
def test_filename_encoding(self, tmpdir, monkeypatch):
moduledir = tmpdir.mkdir("föö")
moduledir.join("bar.py").write("def foo():\n 1/0\n")
monkeypatch.syspath_prepend(str(moduledir))
import bar # type: ignore
try:
bar.foo()
except ZeroDivisionError:
traceback = Traceback(*sys.exc_info())
assert "föö" in "\n".join(frame.render() for frame in traceback.frames)
def test_get_machine_id():
rv = get_machine_id()
assert isinstance(rv, bytes)
@pytest.mark.filterwarnings("ignore::pytest.PytestUnraisableExceptionWarning")
@pytest.mark.parametrize("crash", (True, False))
def test_basic(dev_server, crash):
c = dev_server(use_debugger=True)
r = c.request("/crash" if crash else "")
assert r.status == (500 if crash else 200)
if crash:
assert b"The debugger caught an exception in your WSGI application" in r.data
else:
assert r.json["PATH_INFO"] == "/"
def test_console_closure_variables(monkeypatch):
# restore the original display hook
monkeypatch.setattr(sys, "displayhook", console._displayhook)
c = console.Console()
c.eval("y = 5")
c.eval("x = lambda: y")
ret = c.eval("x()")
assert ret == ">>> x()\n5\n"
@pytest.mark.timeout(2)
def test_chained_exception_cycle():
try:
try:
raise ValueError()
except ValueError:
raise TypeError()
except TypeError as e:
# create a cycle and make it available outside the except block
e.__context__.__context__ = error = e
# if cycles aren't broken, this will time out
tb = Traceback(TypeError, error, error.__traceback__)
assert len(tb.groups) == 2
def test_non_hashable_exception():
class MutableException(ValueError):
__hash__ = None
try:
raise MutableException()
except MutableException:
# previously crashed: `TypeError: unhashable type 'MutableException'`
Traceback(*sys.exc_info())
def test_linked_exception_wo_traceback():
try:
raise Exception("msg1")
except Exception as e:
e.__context__ = Exception("msg2")
# previously crashed: `IndexError: list index out of range`
get_current_traceback()