diff options
| author | Maximilian Hils <git@maximilianhils.com> | 2014-01-28 17:29:28 +0100 |
|---|---|---|
| committer | Maximilian Hils <git@maximilianhils.com> | 2014-01-28 17:29:28 +0100 |
| commit | 1e3e0dd1271afda59ec244b64391b6579a998dce (patch) | |
| tree | 5f1f617ccc8ea2b29650c10197407b1d3ecb7139 /doc-src/dev/testing.html | |
| parent | 17f09aa0afe9695505b746c370e1c5b889c19058 (diff) | |
| parent | 3aa78f9ff38471f84a471618e1a43ca02fc65b6a (diff) | |
| download | mitmproxy-1e3e0dd1271afda59ec244b64391b6579a998dce.tar.gz mitmproxy-1e3e0dd1271afda59ec244b64391b6579a998dce.tar.bz2 mitmproxy-1e3e0dd1271afda59ec244b64391b6579a998dce.zip | |
merge master
Diffstat (limited to 'doc-src/dev/testing.html')
| -rw-r--r-- | doc-src/dev/testing.html | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/doc-src/dev/testing.html b/doc-src/dev/testing.html new file mode 100644 index 00000000..4cee29e8 --- /dev/null +++ b/doc-src/dev/testing.html @@ -0,0 +1,43 @@ + +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 [nose](https://nose.readthedocs.org/en/latest/). +At the point where you send your pull request, a command like this: + +<pre class="terminal"> +> nosetests --with-cov --cov-report term-missing ./test +</pre> + +Should give output something like this: + +<pre class="terminal"> +> ---------- coverage: platform darwin, python 2.7.2-final-0 -- +> Name Stmts Miss Cover Missing +> ---------------------------------------------------- +> libmproxy/__init__ 0 0 100% +> libmproxy/app 4 0 100% +> libmproxy/cmdline 100 0 100% +> libmproxy/controller 69 0 100% +> libmproxy/dump 150 0 100% +> libmproxy/encoding 39 0 100% +> libmproxy/filt 201 0 100% +> libmproxy/flow 891 0 100% +> libmproxy/proxy 427 0 100% +> libmproxy/script 27 0 100% +> libmproxy/utils 133 0 100% +> libmproxy/version 4 0 100% +> ---------------------------------------------------- +> TOTAL 2045 0 100% +> ---------------------------------------------------- +> Ran 251 tests in 11.864s +</pre> + + +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. + |