aboutsummaryrefslogtreecommitdiffstats
path: root/libpathod/templates/docs_test.html
diff options
context:
space:
mode:
Diffstat (limited to 'libpathod/templates/docs_test.html')
-rw-r--r--libpathod/templates/docs_test.html43
1 files changed, 43 insertions, 0 deletions
diff --git a/libpathod/templates/docs_test.html b/libpathod/templates/docs_test.html
index 27129f1c..c9162f87 100644
--- a/libpathod/templates/docs_test.html
+++ b/libpathod/templates/docs_test.html
@@ -6,4 +6,47 @@
<small>Using pathod and pathoc in your unit tests.</small>
</h1>
</div>
+
+<div class="row">
+ <div class="span6">
+
+ <p> The <b>libpathod.test</b> module is a light, flexible testing layer
+ for HTTP clients. It works by firing up a Pathod instance in a separate
+ thread, letting you use Pathod's full abilities to generate responses,
+ and then query Pathod's internal logs to establish what happened. All
+ the mechanics of startup, shutdown, finding free ports and so forth are
+ taken care of for you. </p>
+
+ <p> The canonical docs can be accessed using pydoc: </p>
+
+ <pre class="terminal">pydoc libpathod.testing</pre>
+
+ <p> The remainder of this page demonstrates some common interaction
+ patterns using <a
+ href="http://nose.readthedocs.org/en/latest/">nose</a>. These examples
+ are also applicable with only minor modification to most commonly used
+ Python testing engines.</p>
+
+ </div>
+ <div class="span6">
+ <h1> Context Decorator </h1>
+
+ {% include "examples_context.html" %}
+ </div>
+</div>
+
+<div class="row">
+ <div class="span6">
+ <h1> One instance per test </h1>
+
+ {% include "examples_setup.html" %}
+ </div>
+ <div class="span6">
+ <h1> One instance per suite </h1>
+
+ {% include "examples_setupall.html" %}
+ </div>
+</div>
+
+
{% endblock %}