diff options
| author | Maximilian Hils <git@maximilianhils.com> | 2017-01-29 22:09:45 +0100 |
|---|---|---|
| committer | Maximilian Hils <git@maximilianhils.com> | 2017-01-29 22:09:45 +0100 |
| commit | e10fb22f9cf223d75b2a8f5a1656921fd0c2b7a6 (patch) | |
| tree | a15ef49b86857172606d1e4ab27e069053b697bd | |
| parent | 0919e385146d495a65fdb73ad263b40caee5787a (diff) | |
| download | mitmproxy-e10fb22f9cf223d75b2a8f5a1656921fd0c2b7a6.tar.gz mitmproxy-e10fb22f9cf223d75b2a8f5a1656921fd0c2b7a6.tar.bz2 mitmproxy-e10fb22f9cf223d75b2a8f5a1656921fd0c2b7a6.zip | |
remove outdated testing section from docs
| -rw-r--r-- | docs/dev/testing.rst | 47 | ||||
| -rw-r--r-- | docs/index.rst | 1 |
2 files changed, 0 insertions, 48 deletions
diff --git a/docs/dev/testing.rst b/docs/dev/testing.rst deleted file mode 100644 index b86efce1..00000000 --- a/docs/dev/testing.rst +++ /dev/null @@ -1,47 +0,0 @@ -.. _testing: - -Testing -======= - -All the mitmproxy projects strive to maintain 100% code coverage. In general, -patches and pull requests will be declined unless they're accompanied by a -suitable extension to the test suite. - -Our tests are written for the `py.test`_ or nose_ test frameworks. -At the point where you send your pull request, a command like this: - ->>> py.test --cov mitmproxy - -Should give output something like this: - -.. code-block:: none - - > ---------- coverage: platform darwin, python 2.7.2-final-0 -- - > Name Stmts Miss Cover Missing - > ---------------------------------------------------- - > mitmproxy/__init__ 0 0 100% - > mitmproxy/app 4 0 100% - > mitmproxy/cmdline 100 0 100% - > mitmproxy/controller 69 0 100% - > mitmproxy/dump 150 0 100% - > mitmproxy/encoding 39 0 100% - > mitmproxy/flowfilter 201 0 100% - > mitmproxy/flow 891 0 100% - > mitmproxy/proxy 427 0 100% - > mitmproxy/script 27 0 100% - > mitmproxy/utils 133 0 100% - > mitmproxy/version 4 0 100% - > ---------------------------------------------------- - > TOTAL 2045 0 100% - > ---------------------------------------------------- - > Ran 251 tests in 11.864s - - -There are exceptions to the coverage requirement - for instance, much of the -console interface code can't sensibly be unit tested. These portions are -excluded from coverage analysis either in the **.coveragerc** file, or using -**#pragma no-cover** directives. To keep our coverage analysis relevant, we use -these measures as sparingly as possible. - -.. _nose: https://nose.readthedocs.org/en/latest/ -.. _py.test: https://pytest.org/ diff --git a/docs/index.rst b/docs/index.rst index 63e0bbf5..9fcededc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -80,7 +80,6 @@ :hidden: :caption: Hacking - dev/testing dev/sslkeylogfile .. Indices and tables |