mitmproxy/test/examples/test_examples.py

import pytest

from mitmproxy import options
from mitmproxy import contentviews
from mitmproxy import proxy
from mitmproxy import master
from mitmproxy.addons import script

from mitmproxy.test import tflow
from mitmproxy.test import tutils
from mitmproxy.net.http import Headers

from ..mitmproxy import tservers

example_dir = tutils.test_data.push("../examples")


class ScriptError(Exception):
    pass


class RaiseMaster(master.Master):
    def add_log(self, e, level):
        if level in ("warn", "error"):
            raise ScriptError(e)


def tscript(cmd, args=""):
    o = options.Options()
    cmd = example_dir.path(cmd) + " " + args
    m = RaiseMaster(o, proxy.DummyServer())
    sc = script.Script(cmd)
    m.addons.add(sc)
    return m, sc


class TestScripts(tservers.MasterTest):
    def test_add_header(self):
        m, _ = tscript("simple/add_header.py")
        f = tflow.tflow(resp=tutils.tresp())
        m.addons.handle_lifecycle("response", f)
        assert f.response.headers["newheader"] == "foo"

    def test_custom_contentviews(self):
        m, sc = tscript("simple/custom_contentview.py")
        swapcase = contentviews.get("swapcase")
        _, fmt = swapcase(b"<html>Test!</html>")
        assert any(b'tEST!' in val[0][1] for val in fmt)

    def test_iframe_injector(self):
        with pytest.raises(ScriptError):
            tscript("simple/modify_body_inject_iframe.py")

        m, sc = tscript("simple/modify_body_inject_iframe.py", "http://example.org/evil_iframe")
        f = tflow.tflow(resp=tutils.tresp(content=b"<html><body>mitmproxy</body></html>"))
        m.addons.handle_lifecycle("response", f)
        content = f.response.content
        assert b'iframe' in content and b'evil_iframe' in content

    def test_modify_form(self):
        m, sc = tscript("simple/modify_form.py")

        form_header = Headers(content_type="application/x-www-form-urlencoded")
        f = tflow.tflow(req=tutils.treq(headers=form_header))
        m.addons.handle_lifecycle("request", f)

        assert f.request.urlencoded_form["mitmproxy"] == "rocks"

        f.request.headers["content-type"] = ""
        m.addons.handle_lifecycle("request", f)
        assert list(f.request.urlencoded_form.items()) == [("foo", "bar")]

    def test_modify_querystring(self):
        m, sc = tscript("simple/modify_querystring.py")
        f = tflow.tflow(req=tutils.treq(path="/search?q=term"))

        m.addons.handle_lifecycle("request", f)
        assert f.request.query["mitmproxy"] == "rocks"

        f.request.path = "/"
        m.addons.handle_lifecycle("request", f)
        assert f.request.query["mitmproxy"] == "rocks"

    def test_arguments(self):
        m, sc = tscript("simple/script_arguments.py", "mitmproxy rocks")
        f = tflow.tflow(resp=tutils.tresp(content=b"I <3 mitmproxy"))
        m.addons.handle_lifecycle("response", f)
        assert f.response.content == b"I <3 rocks"

    def test_redirect_requests(self):
        m, sc = tscript("simple/redirect_requests.py")
        f = tflow.tflow(req=tutils.treq(host="example.org"))
        m.addons.handle_lifecycle("request", f)
        assert f.request.host == "mitmproxy.org"

    def test_send_reply_from_proxy(self):
        m, sc = tscript("simple/send_reply_from_proxy.py")
        f = tflow.tflow(req=tutils.treq(host="example.com", port=80))
        m.addons.handle_lifecycle("request", f)
        assert f.response.content == b"Hello World"

    def test_dns_spoofing(self):
        m, sc = tscript("complex/dns_spoofing.py")
        original_host = "example.com"

        host_header = Headers(host=original_host)
        f = tflow.tflow(req=tutils.treq(headers=host_header, port=80))

        m.addons.handle_lifecycle("requestheaders", f)

        # Rewrite by reverse proxy mode
        f.request.scheme = "https"
        f.request.port = 443

        m.addons.handle_lifecycle("request", f)

        assert f.request.scheme == "http"
        assert f.request.port == 80

        assert f.request.headers["Host"] == original_host
replace tutils.raises with pytest.raises + shim 2017-02-01 15:48:46 +00:00			`import pytest`
Add simple har_dump test 2016-08-03 10:58:41 +00:00
Convert examples and example tests for new-style scripts Remove the test that just loads all the example scripts for now - it's a very low-value test, and we need to think of something better. 2016-07-14 04:20:27 +00:00			`from mitmproxy import options`
			`from mitmproxy import contentviews`
Let's dispense with this fiction that we support multiple servers It's simple enough to re-add if needed, and until then is just cruft. 2016-10-18 23:37:32 +00:00			`from mitmproxy import proxy`
Kill flow.master - create master.Master Also extract events into .events 2016-10-19 00:22:50 +00:00			`from mitmproxy import master`
replace tutils.raises with pytest.raises + shim 2017-02-01 15:48:46 +00:00			`from mitmproxy.addons import script`
Add simple har_dump test 2016-08-03 10:58:41 +00:00
replace tutils.raises with pytest.raises + shim 2017-02-01 15:48:46 +00:00			`from mitmproxy.test import tflow`
tests: clean up test/mitmproxy/tutils.py Remove aliases, use mitmproxy/test/tutils instead. 2016-11-01 20:44:18 +00:00			`from mitmproxy.test import tutils`
The final piece: netlib -> mitproxy.net 2016-10-19 22:56:38 +00:00			`from mitmproxy.net.http import Headers`
Add simple har_dump test 2016-08-03 10:58:41 +00:00
move examples tests (#2199) 2017-03-22 11:02:18 +00:00			`from ..mitmproxy import tservers`
Add tests for modify_form example 2016-03-07 03:42:10 +00:00
tests: clean up test/mitmproxy/tutils.py Remove aliases, use mitmproxy/test/tutils instead. 2016-11-01 20:44:18 +00:00			`example_dir = tutils.test_data.push("../examples")`
Update modify_querystring example & add test for it 2016-03-07 03:49:29 +00:00
add MultiDict This commit introduces MultiDict, a multi-dictionary similar to ODict, but with improved semantics (as in the Headers class). MultiDict fixes a few issues that were present in the Request/Response API. In particular, `request.cookies["foo"] = "bar"` has previously been a no-op, as the cookies property returned a mutable _copy_ of the cookies. 2016-05-19 01:46:42 +00:00
Convert examples and example tests for new-style scripts Remove the test that just loads all the example scripts for now - it's a very low-value test, and we need to think of something better. 2016-07-14 04:20:27 +00:00			`class ScriptError(Exception):`
			`pass`
Update modify_querystring example & add test for it 2016-03-07 03:49:29 +00:00
Add tests for modify_response_body example 2016-03-07 03:58:09 +00:00
Kill flow.master - create master.Master Also extract events into .events 2016-10-19 00:22:50 +00:00			`class RaiseMaster(master.Master):`
add_event -> add_log throughout project "Event" is terribly over-loaded in the project, and "log" is straight-forward and self-explanatory. 2016-07-15 22:00:34 +00:00			`def add_log(self, e, level):`
Convert examples and example tests for new-style scripts Remove the test that just loads all the example scripts for now - it's a very low-value test, and we need to think of something better. 2016-07-14 04:20:27 +00:00			`if level in ("warn", "error"):`
			`raise ScriptError(e)`
Add tests for modify_response_body example 2016-03-07 03:58:09 +00:00
Add tests for redirect_requests example 2016-03-07 06:43:15 +00:00
Convert examples and example tests for new-style scripts Remove the test that just loads all the example scripts for now - it's a very low-value test, and we need to think of something better. 2016-07-14 04:20:27 +00:00			`def tscript(cmd, args=""):`
Addon iface: .configure(options) -> .configure(options, updated) 2016-07-23 03:43:55 +00:00			`o = options.Options()`
Convert examples and example tests for new-style scripts Remove the test that just loads all the example scripts for now - it's a very low-value test, and we need to think of something better. 2016-07-14 04:20:27 +00:00			`cmd = example_dir.path(cmd) + " " + args`
Let's dispense with this fiction that we support multiple servers It's simple enough to re-add if needed, and until then is just cruft. 2016-10-18 23:37:32 +00:00			`m = RaiseMaster(o, proxy.DummyServer())`
Convert examples and example tests for new-style scripts Remove the test that just loads all the example scripts for now - it's a very low-value test, and we need to think of something better. 2016-07-14 04:20:27 +00:00			`sc = script.Script(cmd)`
remove option argument for addons.add (#1576) 2016-09-25 01:21:12 +00:00			`m.addons.add(sc)`
Convert examples and example tests for new-style scripts Remove the test that just loads all the example scripts for now - it's a very low-value test, and we need to think of something better. 2016-07-14 04:20:27 +00:00			`return m, sc`
Add tests for redirect_requests example 2016-03-07 06:43:15 +00:00
Move har_extractor tests to the examples file 2016-03-09 18:21:29 +00:00
coverage++ 2017-02-10 21:12:24 +00:00			`class TestScripts(tservers.MasterTest):`
Convert examples and example tests for new-style scripts Remove the test that just loads all the example scripts for now - it's a very low-value test, and we need to think of something better. 2016-07-14 04:20:27 +00:00			`def test_add_header(self):`
organize examples This commit is largely based on work by Thiago Arrais (@thiagoarrais) and Shane Bradfield (@l33tLumberjack). I wasn't really able to get their PR reasonably merged onto the latest master, so I reapplied their changes manually here and did some further improvements on that. 2016-11-21 01:16:20 +00:00			`m, _ = tscript("simple/add_header.py")`
tests: clean up test/mitmproxy/tutils.py Remove aliases, use mitmproxy/test/tutils instead. 2016-11-01 20:44:18 +00:00			`f = tflow.tflow(resp=tutils.tresp())`
Rip out master handler mechanism All events are now handled by addons, and we no longer support any events on master. 2017-03-16 02:40:43 +00:00			`m.addons.handle_lifecycle("response", f)`
Convert examples and example tests for new-style scripts Remove the test that just loads all the example scripts for now - it's a very low-value test, and we need to think of something better. 2016-07-14 04:20:27 +00:00			`assert f.response.headers["newheader"] == "foo"`
Move har_extractor tests to the examples file 2016-03-09 18:21:29 +00:00
Convert examples and example tests for new-style scripts Remove the test that just loads all the example scripts for now - it's a very low-value test, and we need to think of something better. 2016-07-14 04:20:27 +00:00			`def test_custom_contentviews(self):`
organize examples This commit is largely based on work by Thiago Arrais (@thiagoarrais) and Shane Bradfield (@l33tLumberjack). I wasn't really able to get their PR reasonably merged onto the latest master, so I reapplied their changes manually here and did some further improvements on that. 2016-11-21 01:16:20 +00:00			`m, sc = tscript("simple/custom_contentview.py")`
			`swapcase = contentviews.get("swapcase")`
			`_, fmt = swapcase(b"<html>Test!</html>")`
			`assert any(b'tEST!' in val[0][1] for val in fmt)`
disable harparser on py3 2016-07-07 08:21:15 +00:00
Convert examples and example tests for new-style scripts Remove the test that just loads all the example scripts for now - it's a very low-value test, and we need to think of something better. 2016-07-14 04:20:27 +00:00			`def test_iframe_injector(self):`
replace tutils.raises with pytest.raises + shim 2017-02-01 15:48:46 +00:00			`with pytest.raises(ScriptError):`
organize examples This commit is largely based on work by Thiago Arrais (@thiagoarrais) and Shane Bradfield (@l33tLumberjack). I wasn't really able to get their PR reasonably merged onto the latest master, so I reapplied their changes manually here and did some further improvements on that. 2016-11-21 01:16:20 +00:00			`tscript("simple/modify_body_inject_iframe.py")`
Move har_extractor tests to the examples file 2016-03-09 18:21:29 +00:00
organize examples This commit is largely based on work by Thiago Arrais (@thiagoarrais) and Shane Bradfield (@l33tLumberjack). I wasn't really able to get their PR reasonably merged onto the latest master, so I reapplied their changes manually here and did some further improvements on that. 2016-11-21 01:16:20 +00:00			`m, sc = tscript("simple/modify_body_inject_iframe.py", "http://example.org/evil_iframe")`
minor fixes 2016-12-10 11:06:33 +00:00			`f = tflow.tflow(resp=tutils.tresp(content=b"<html><body>mitmproxy</body></html>"))`
Rip out master handler mechanism All events are now handled by addons, and we no longer support any events on master. 2017-03-16 02:40:43 +00:00			`m.addons.handle_lifecycle("response", f)`
clean up code, improve DummyReply 2016-08-10 05:29:07 +00:00			`content = f.response.content`
Script cleanup: editing in console, Python3 compatibility fixes 2016-07-14 05:19:33 +00:00			`assert b'iframe' in content and b'evil_iframe' in content`
Convert examples and example tests for new-style scripts Remove the test that just loads all the example scripts for now - it's a very low-value test, and we need to think of something better. 2016-07-14 04:20:27 +00:00
			`def test_modify_form(self):`
organize examples This commit is largely based on work by Thiago Arrais (@thiagoarrais) and Shane Bradfield (@l33tLumberjack). I wasn't really able to get their PR reasonably merged onto the latest master, so I reapplied their changes manually here and did some further improvements on that. 2016-11-21 01:16:20 +00:00			`m, sc = tscript("simple/modify_form.py")`
Convert examples and example tests for new-style scripts Remove the test that just loads all the example scripts for now - it's a very low-value test, and we need to think of something better. 2016-07-14 04:20:27 +00:00
			`form_header = Headers(content_type="application/x-www-form-urlencoded")`
tests: clean up test/mitmproxy/tutils.py Remove aliases, use mitmproxy/test/tutils instead. 2016-11-01 20:44:18 +00:00			`f = tflow.tflow(req=tutils.treq(headers=form_header))`
Rip out master handler mechanism All events are now handled by addons, and we no longer support any events on master. 2017-03-16 02:40:43 +00:00			`m.addons.handle_lifecycle("request", f)`
Convert examples and example tests for new-style scripts Remove the test that just loads all the example scripts for now - it's a very low-value test, and we need to think of something better. 2016-07-14 04:20:27 +00:00
fix #1858 2016-12-19 00:15:10 +00:00			`assert f.request.urlencoded_form["mitmproxy"] == "rocks"`
Convert examples and example tests for new-style scripts Remove the test that just loads all the example scripts for now - it's a very low-value test, and we need to think of something better. 2016-07-14 04:20:27 +00:00
			`f.request.headers["content-type"] = ""`
Rip out master handler mechanism All events are now handled by addons, and we no longer support any events on master. 2017-03-16 02:40:43 +00:00			`m.addons.handle_lifecycle("request", f)`
fix #1858 2016-12-19 00:15:10 +00:00			`assert list(f.request.urlencoded_form.items()) == [("foo", "bar")]`
Convert examples and example tests for new-style scripts Remove the test that just loads all the example scripts for now - it's a very low-value test, and we need to think of something better. 2016-07-14 04:20:27 +00:00
			`def test_modify_querystring(self):`
organize examples This commit is largely based on work by Thiago Arrais (@thiagoarrais) and Shane Bradfield (@l33tLumberjack). I wasn't really able to get their PR reasonably merged onto the latest master, so I reapplied their changes manually here and did some further improvements on that. 2016-11-21 01:16:20 +00:00			`m, sc = tscript("simple/modify_querystring.py")`
tests: clean up test/mitmproxy/tutils.py Remove aliases, use mitmproxy/test/tutils instead. 2016-11-01 20:44:18 +00:00			`f = tflow.tflow(req=tutils.treq(path="/search?q=term"))`
Convert examples and example tests for new-style scripts Remove the test that just loads all the example scripts for now - it's a very low-value test, and we need to think of something better. 2016-07-14 04:20:27 +00:00
Rip out master handler mechanism All events are now handled by addons, and we no longer support any events on master. 2017-03-16 02:40:43 +00:00			`m.addons.handle_lifecycle("request", f)`
Convert examples and example tests for new-style scripts Remove the test that just loads all the example scripts for now - it's a very low-value test, and we need to think of something better. 2016-07-14 04:20:27 +00:00			`assert f.request.query["mitmproxy"] == "rocks"`

			`f.request.path = "/"`
Rip out master handler mechanism All events are now handled by addons, and we no longer support any events on master. 2017-03-16 02:40:43 +00:00			`m.addons.handle_lifecycle("request", f)`
Convert examples and example tests for new-style scripts Remove the test that just loads all the example scripts for now - it's a very low-value test, and we need to think of something better. 2016-07-14 04:20:27 +00:00			`assert f.request.query["mitmproxy"] == "rocks"`

docs: overview, classes, arguments 2016-10-15 22:12:58 +00:00			`def test_arguments(self):`
organize examples This commit is largely based on work by Thiago Arrais (@thiagoarrais) and Shane Bradfield (@l33tLumberjack). I wasn't really able to get their PR reasonably merged onto the latest master, so I reapplied their changes manually here and did some further improvements on that. 2016-11-21 01:16:20 +00:00			`m, sc = tscript("simple/script_arguments.py", "mitmproxy rocks")`
tests: clean up test/mitmproxy/tutils.py Remove aliases, use mitmproxy/test/tutils instead. 2016-11-01 20:44:18 +00:00			`f = tflow.tflow(resp=tutils.tresp(content=b"I <3 mitmproxy"))`
Rip out master handler mechanism All events are now handled by addons, and we no longer support any events on master. 2017-03-16 02:40:43 +00:00			`m.addons.handle_lifecycle("response", f)`
Script cleanup: editing in console, Python3 compatibility fixes 2016-07-14 05:19:33 +00:00			`assert f.response.content == b"I <3 rocks"`
Convert examples and example tests for new-style scripts Remove the test that just loads all the example scripts for now - it's a very low-value test, and we need to think of something better. 2016-07-14 04:20:27 +00:00
			`def test_redirect_requests(self):`
organize examples This commit is largely based on work by Thiago Arrais (@thiagoarrais) and Shane Bradfield (@l33tLumberjack). I wasn't really able to get their PR reasonably merged onto the latest master, so I reapplied their changes manually here and did some further improvements on that. 2016-11-21 01:16:20 +00:00			`m, sc = tscript("simple/redirect_requests.py")`
tests: clean up test/mitmproxy/tutils.py Remove aliases, use mitmproxy/test/tutils instead. 2016-11-01 20:44:18 +00:00			`f = tflow.tflow(req=tutils.treq(host="example.org"))`
Rip out master handler mechanism All events are now handled by addons, and we no longer support any events on master. 2017-03-16 02:40:43 +00:00			`m.addons.handle_lifecycle("request", f)`
Convert examples and example tests for new-style scripts Remove the test that just loads all the example scripts for now - it's a very low-value test, and we need to think of something better. 2016-07-14 04:20:27 +00:00			`assert f.request.host == "mitmproxy.org"`

organize examples This commit is largely based on work by Thiago Arrais (@thiagoarrais) and Shane Bradfield (@l33tLumberjack). I wasn't really able to get their PR reasonably merged onto the latest master, so I reapplied their changes manually here and did some further improvements on that. 2016-11-21 01:16:20 +00:00			`def test_send_reply_from_proxy(self):`
			`m, sc = tscript("simple/send_reply_from_proxy.py")`
			`f = tflow.tflow(req=tutils.treq(host="example.com", port=80))`
Rip out master handler mechanism All events are now handled by addons, and we no longer support any events on master. 2017-03-16 02:40:43 +00:00			`m.addons.handle_lifecycle("request", f)`
organize examples This commit is largely based on work by Thiago Arrais (@thiagoarrais) and Shane Bradfield (@l33tLumberjack). I wasn't really able to get their PR reasonably merged onto the latest master, so I reapplied their changes manually here and did some further improvements on that. 2016-11-21 01:16:20 +00:00			`assert f.response.content == b"Hello World"`

Add a test for the host replacement 2017-01-30 22:44:13 +00:00			`def test_dns_spoofing(self):`
			`m, sc = tscript("complex/dns_spoofing.py")`
			`original_host = "example.com"`

			`host_header = Headers(host=original_host)`
Better test 2017-01-31 22:23:13 +00:00			`f = tflow.tflow(req=tutils.treq(headers=host_header, port=80))`
Add a test for the host replacement 2017-01-30 22:44:13 +00:00
Rip out master handler mechanism All events are now handled by addons, and we no longer support any events on master. 2017-03-16 02:40:43 +00:00			`m.addons.handle_lifecycle("requestheaders", f)`
Add a test for the host replacement 2017-01-30 22:44:13 +00:00
			`# Rewrite by reverse proxy mode`
Better test 2017-01-31 22:23:13 +00:00			`f.request.scheme = "https"`
			`f.request.port = 443`
Add a test for the host replacement 2017-01-30 22:44:13 +00:00
Rip out master handler mechanism All events are now handled by addons, and we no longer support any events on master. 2017-03-16 02:40:43 +00:00			`m.addons.handle_lifecycle("request", f)`
Better test 2017-01-31 22:23:13 +00:00
			`assert f.request.scheme == "http"`
			`assert f.request.port == 80`

Add a test for the host replacement 2017-01-30 22:44:13 +00:00			`assert f.request.headers["Host"] == original_host`