diff options
author | Aldo Cortesi <aldo@nullcube.com> | 2016-12-17 10:03:35 +1300 |
---|---|---|
committer | Aldo Cortesi <aldo@nullcube.com> | 2016-12-17 10:03:35 +1300 |
commit | 007aeef770151e48c9265fd9cafb8bc014115d2d (patch) | |
tree | ad78796d792500465f42b9dea5f6a2ad1920a1ea /docs | |
parent | c4929bbc190a52e4ac0f38492e085338b3e5827d (diff) | |
download | mitmproxy-007aeef770151e48c9265fd9cafb8bc014115d2d.tar.gz mitmproxy-007aeef770151e48c9265fd9cafb8bc014115d2d.tar.bz2 mitmproxy-007aeef770151e48c9265fd9cafb8bc014115d2d.zip |
Addon test docs, remove stray deprecated events
Fixes #1572
Diffstat (limited to 'docs')
-rw-r--r-- | docs/scripting/overview.rst | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/scripting/overview.rst b/docs/scripting/overview.rst index 7df5532d..84f2135e 100644 --- a/docs/scripting/overview.rst +++ b/docs/scripting/overview.rst @@ -131,6 +131,23 @@ purposes. You can use it as follows: :language: python +Testing +------- + +Mitmproxy includes a number of helpers for testing addons. The +``mitmproxy.test.taddons`` module contains a context helper that takes care of +setting up and tearing down the addon event context. The +``mitmproxy.test.tflow`` module contains helpers for quickly creating test +flows. Pydoc is the canonical reference for these modules, and mitmproxy's own +test suite is an excellent source of examples of usage. Here, for instance, is +the mitmproxy unit tests for the `anticache` option, demonstrating a good +cross-section of the test helpers: + +.. literalinclude:: ../../test/mitmproxy/addons/test_anticache.py + :caption: :src:`test/mitmproxy/addons/test_anticache.py` + :language: python + + Developing scripts ------------------ |