From 007aeef770151e48c9265fd9cafb8bc014115d2d Mon Sep 17 00:00:00 2001 From: Aldo Cortesi Date: Sat, 17 Dec 2016 10:03:35 +1300 Subject: Addon test docs, remove stray deprecated events Fixes #1572 --- docs/scripting/overview.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'docs/scripting') 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 ------------------ -- cgit v1.2.3