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
|
import asyncio
import os
import sys
import traceback
import pytest
from mitmproxy import addonmanager
from mitmproxy import exceptions
from mitmproxy.addons import script
from mitmproxy.test import taddons
from mitmproxy.test import tflow
# We want this to be speedy for testing
script.ReloadInterval = 0.1
@pytest.mark.asyncio
async def test_load_script(tdata):
with taddons.context() as tctx:
ns = script.load_script(
tdata.path(
"mitmproxy/data/addonscripts/recorder/recorder.py"
)
)
assert ns.addons
script.load_script(
"nonexistent"
)
assert await tctx.master.await_log("No such file or directory")
script.load_script(
tdata.path(
"mitmproxy/data/addonscripts/recorder/error.py"
)
)
assert await tctx.master.await_log("invalid syntax")
def test_load_fullname(tdata):
"""
Test that loading two scripts at locations a/foo.py and b/foo.py works.
This only succeeds if they get assigned different basenames.
"""
ns = script.load_script(
tdata.path(
"mitmproxy/data/addonscripts/addon.py"
)
)
assert ns.addons
ns2 = script.load_script(
tdata.path(
"mitmproxy/data/addonscripts/same_filename/addon.py"
)
)
assert ns.name != ns2.name
assert not hasattr(ns2, "addons")
class TestScript:
def test_notfound(self):
with taddons.context():
with pytest.raises(exceptions.OptionsError):
script.Script("nonexistent", False)
def test_quotes_around_filename(self, tdata):
"""
Test that a script specified as '"foo.py"' works to support the calling convention of
mitmproxy 2.0, as e.g. used by Cuckoo Sandbox.
"""
path = tdata.path("mitmproxy/data/addonscripts/recorder/recorder.py")
s = script.Script(
'"{}"'.format(path),
False
)
assert '"' not in s.fullpath
@pytest.mark.asyncio
async def test_simple(self, tdata):
sc = script.Script(
tdata.path(
"mitmproxy/data/addonscripts/recorder/recorder.py"
),
True,
)
with taddons.context(sc) as tctx:
tctx.configure(sc)
await tctx.master.await_log("recorder running")
rec = tctx.master.addons.get("recorder")
assert rec.call_log[0][0:2] == ("recorder", "load")
rec.call_log = []
f = tflow.tflow(resp=True)
tctx.master.addons.trigger("request", f)
assert rec.call_log[0][1] == "request"
@pytest.mark.asyncio
async def test_reload(self, tmpdir):
with taddons.context() as tctx:
f = tmpdir.join("foo.py")
f.ensure(file=True)
f.write("\n")
sc = script.Script(str(f), True)
tctx.configure(sc)
assert await tctx.master.await_log("Loading")
tctx.master.clear()
for i in range(20):
f.write("\n")
if tctx.master.has_log("Loading"):
break
await asyncio.sleep(0.1)
else:
raise AssertionError("No reload seen")
@pytest.mark.asyncio
async def test_exception(self, tdata):
with taddons.context() as tctx:
sc = script.Script(
tdata.path("mitmproxy/data/addonscripts/error.py"),
True,
)
tctx.master.addons.add(sc)
await tctx.master.await_log("error running")
tctx.configure(sc)
f = tflow.tflow(resp=True)
tctx.master.addons.trigger("request", f)
assert await tctx.master.await_log("ValueError: Error!")
assert await tctx.master.await_log("error.py")
@pytest.mark.asyncio
async def test_optionexceptions(self, tdata):
with taddons.context() as tctx:
sc = script.Script(
tdata.path("mitmproxy/data/addonscripts/configure.py"),
True,
)
tctx.master.addons.add(sc)
tctx.configure(sc)
assert await tctx.master.await_log("Options Error")
@pytest.mark.asyncio
async def test_addon(self, tdata):
with taddons.context() as tctx:
sc = script.Script(
tdata.path(
"mitmproxy/data/addonscripts/addon.py"
),
True
)
tctx.master.addons.add(sc)
await tctx.master.await_log("addon running")
assert sc.ns.event_log == [
'scriptload', 'addonload', 'scriptconfigure', 'addonconfigure'
]
class TestCutTraceback:
def raise_(self, i):
if i > 0:
self.raise_(i - 1)
raise RuntimeError()
def test_simple(self):
try:
self.raise_(4)
except RuntimeError:
tb = sys.exc_info()[2]
tb_cut = addonmanager.cut_traceback(tb, "test_simple")
assert len(traceback.extract_tb(tb_cut)) == 5
tb_cut2 = addonmanager.cut_traceback(tb, "nonexistent")
assert len(traceback.extract_tb(tb_cut2)) == len(traceback.extract_tb(tb))
class TestScriptLoader:
@pytest.mark.asyncio
async def test_script_run(self, tdata):
rp = tdata.path("mitmproxy/data/addonscripts/recorder/recorder.py")
sc = script.ScriptLoader()
with taddons.context(sc) as tctx:
sc.script_run([tflow.tflow(resp=True)], rp)
await tctx.master.await_log("recorder response")
debug = [i.msg for i in tctx.master.logs if i.level == "debug"]
assert debug == [
'recorder running', 'recorder configure',
'recorder requestheaders', 'recorder request',
'recorder responseheaders', 'recorder response'
]
@pytest.mark.asyncio
async def test_script_run_nonexistent(self):
sc = script.ScriptLoader()
with taddons.context(sc) as tctx:
sc.script_run([tflow.tflow(resp=True)], "/")
assert await tctx.master.await_log("No such script")
def test_simple(self, tdata):
sc = script.ScriptLoader()
with taddons.context(loadcore=False) as tctx:
tctx.master.addons.add(sc)
sc.running()
assert len(tctx.master.addons) == 1
tctx.master.options.update(
scripts = [
tdata.path(
"mitmproxy/data/addonscripts/recorder/recorder.py"
)
]
)
assert len(tctx.master.addons) == 1
assert len(sc.addons) == 1
tctx.master.options.update(scripts = [])
assert len(tctx.master.addons) == 1
assert len(sc.addons) == 0
def test_dupes(self):
sc = script.ScriptLoader()
with taddons.context(sc) as tctx:
with pytest.raises(exceptions.OptionsError):
tctx.configure(
sc,
scripts = ["one", "one"]
)
@pytest.mark.asyncio
async def test_script_deletion(self, tdata):
tdir = tdata.path("mitmproxy/data/addonscripts/")
with open(tdir + "/dummy.py", 'w') as f:
f.write("\n")
with taddons.context() as tctx:
sl = script.ScriptLoader()
tctx.master.addons.add(sl)
tctx.configure(sl, scripts=[tdata.path("mitmproxy/data/addonscripts/dummy.py")])
await tctx.master.await_log("Loading")
os.remove(tdata.path("mitmproxy/data/addonscripts/dummy.py"))
await tctx.master.await_log("Removing")
assert not tctx.options.scripts
assert not sl.addons
@pytest.mark.asyncio
async def test_script_error_handler(self):
path = "/sample/path/example.py"
exc = SyntaxError
msg = "Error raised"
tb = True
with taddons.context() as tctx:
script.script_error_handler(path, exc, msg, tb)
assert await tctx.master.await_log("/sample/path/example.py")
assert await tctx.master.await_log("Error raised")
assert await tctx.master.await_log("lineno")
assert await tctx.master.await_log("NoneType")
@pytest.mark.asyncio
async def test_order(self, tdata):
rec = tdata.path("mitmproxy/data/addonscripts/recorder")
sc = script.ScriptLoader()
sc.is_running = True
with taddons.context(sc) as tctx:
tctx.configure(
sc,
scripts = [
"%s/a.py" % rec,
"%s/b.py" % rec,
"%s/c.py" % rec,
]
)
await tctx.master.await_log("configure")
debug = [i.msg for i in tctx.master.logs if i.level == "debug"]
assert debug == [
'a load',
'a running',
'a configure',
'b load',
'b running',
'b configure',
'c load',
'c running',
'c configure',
]
tctx.master.clear()
tctx.configure(
sc,
scripts = [
"%s/c.py" % rec,
"%s/a.py" % rec,
"%s/b.py" % rec,
]
)
await tctx.master.await_log("c configure")
debug = [i.msg for i in tctx.master.logs if i.level == "debug"]
assert debug == [
'c configure',
'a configure',
'b configure',
]
tctx.master.clear()
tctx.configure(
sc,
scripts = [
"%s/e.py" % rec,
"%s/a.py" % rec,
]
)
await tctx.master.await_log("Loading")
debug = [i.msg for i in tctx.master.logs if i.level == "debug"]
assert debug == [
'c done',
'b done',
'a configure',
'e load',
'e running',
'e configure',
]
|
