/usr/share/doc/python-testtools-doc/html/overview.html is in python-testtools-doc 1.8.1-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>testtools: tasteful testing for Python — testtools VERSION documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: 'VERSION',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="testtools VERSION documentation" href="index.html" />
<link rel="next" title="testtools for test authors" href="for-test-authors.html" />
<link rel="prev" title="testtools: tasteful testing for Python" href="index.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="for-test-authors.html" title="testtools for test authors"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="testtools: tasteful testing for Python"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">testtools VERSION documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="testtools-tasteful-testing-for-python">
<h1>testtools: tasteful testing for Python<a class="headerlink" href="#testtools-tasteful-testing-for-python" title="Permalink to this headline">¶</a></h1>
<p>testtools is a set of extensions to the Python standard library’s unit testing
framework. These extensions have been derived from many years of experience
with unit testing in Python and come from many different sources. testtools
supports Python versions all the way back to Python 2.6.</p>
<p>What better way to start than with a contrived code snippet?:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">testtools</span> <span class="kn">import</span> <span class="n">TestCase</span>
<span class="kn">from</span> <span class="nn">testtools.content</span> <span class="kn">import</span> <span class="n">Content</span>
<span class="kn">from</span> <span class="nn">testtools.content_type</span> <span class="kn">import</span> <span class="n">UTF8_TEXT</span>
<span class="kn">from</span> <span class="nn">testtools.matchers</span> <span class="kn">import</span> <span class="n">Equals</span>
<span class="kn">from</span> <span class="nn">myproject</span> <span class="kn">import</span> <span class="n">SillySquareServer</span>
<span class="k">class</span> <span class="nc">TestSillySquareServer</span><span class="p">(</span><span class="n">TestCase</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">setUp</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">TestSillySquareServer</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">setUp</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">server</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">useFixture</span><span class="p">(</span><span class="n">SillySquareServer</span><span class="p">())</span>
<span class="bp">self</span><span class="o">.</span><span class="n">addCleanup</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">attach_log_file</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">attach_log_file</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">addDetail</span><span class="p">(</span>
<span class="s">'log-file'</span><span class="p">,</span>
<span class="n">Content</span><span class="p">(</span><span class="n">UTF8_TEXT</span><span class="p">,</span>
<span class="k">lambda</span><span class="p">:</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">server</span><span class="o">.</span><span class="n">logfile</span><span class="p">,</span> <span class="s">'r'</span><span class="p">)</span><span class="o">.</span><span class="n">readlines</span><span class="p">()))</span>
<span class="k">def</span> <span class="nf">test_server_is_cool</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">assertThat</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">server</span><span class="o">.</span><span class="n">temperature</span><span class="p">,</span> <span class="n">Equals</span><span class="p">(</span><span class="s">"cool"</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">test_square</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">assertThat</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">server</span><span class="o">.</span><span class="n">silly_square_of</span><span class="p">(</span><span class="mi">7</span><span class="p">),</span> <span class="n">Equals</span><span class="p">(</span><span class="mi">49</span><span class="p">))</span>
</pre></div>
</div>
<div class="section" id="why-use-testtools">
<h2>Why use testtools?<a class="headerlink" href="#why-use-testtools" title="Permalink to this headline">¶</a></h2>
<div class="section" id="better-assertion-methods">
<h3>Better assertion methods<a class="headerlink" href="#better-assertion-methods" title="Permalink to this headline">¶</a></h3>
<p>The standard assertion methods that come with unittest aren’t as helpful as
they could be, and there aren’t quite enough of them. testtools adds
<code class="docutils literal"><span class="pre">assertIn</span></code>, <code class="docutils literal"><span class="pre">assertIs</span></code>, <code class="docutils literal"><span class="pre">assertIsInstance</span></code> and their negatives.</p>
</div>
<div class="section" id="matchers-better-than-assertion-methods">
<h3>Matchers: better than assertion methods<a class="headerlink" href="#matchers-better-than-assertion-methods" title="Permalink to this headline">¶</a></h3>
<p>Of course, in any serious project you want to be able to have assertions that
are specific to that project and the particular problem that it is addressing.
Rather than forcing you to define your own assertion methods and maintain your
own inheritance hierarchy of <code class="docutils literal"><span class="pre">TestCase</span></code> classes, testtools lets you write
your own “matchers”, custom predicates that can be plugged into a unit test:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">def</span> <span class="nf">test_response_has_bold</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c"># The response has bold text.</span>
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">server</span><span class="o">.</span><span class="n">getResponse</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">assertThat</span><span class="p">(</span><span class="n">response</span><span class="p">,</span> <span class="n">HTMLContains</span><span class="p">(</span><span class="n">Tag</span><span class="p">(</span><span class="s">'bold'</span><span class="p">,</span> <span class="s">'b'</span><span class="p">)))</span>
</pre></div>
</div>
</div>
<div class="section" id="more-debugging-info-when-you-need-it">
<h3>More debugging info, when you need it<a class="headerlink" href="#more-debugging-info-when-you-need-it" title="Permalink to this headline">¶</a></h3>
<p>testtools makes it easy to add arbitrary data to your test result. If you
want to know what’s in a log file when a test fails, or what the load was on
the computer when a test started, or what files were open, you can add that
information with <code class="docutils literal"><span class="pre">TestCase.addDetail</span></code>, and it will appear in the test
results if that test fails.</p>
</div>
<div class="section" id="extend-unittest-but-stay-compatible-and-re-usable">
<h3>Extend unittest, but stay compatible and re-usable<a class="headerlink" href="#extend-unittest-but-stay-compatible-and-re-usable" title="Permalink to this headline">¶</a></h3>
<p>testtools goes to great lengths to allow serious test authors and test
<em>framework</em> authors to do whatever they like with their tests and their
extensions while staying compatible with the standard library’s unittest.</p>
<p>testtools has completely parametrized how exceptions raised in tests are
mapped to <code class="docutils literal"><span class="pre">TestResult</span></code> methods and how tests are actually executed (ever
wanted <code class="docutils literal"><span class="pre">tearDown</span></code> to be called regardless of whether <code class="docutils literal"><span class="pre">setUp</span></code> succeeds?)</p>
<p>It also provides many simple but handy utilities, like the ability to clone a
test, a <code class="docutils literal"><span class="pre">MultiTestResult</span></code> object that lets many result objects get the
results from one test suite, adapters to bring legacy <code class="docutils literal"><span class="pre">TestResult</span></code> objects
into our new golden age.</p>
</div>
<div class="section" id="cross-python-compatibility">
<h3>Cross-Python compatibility<a class="headerlink" href="#cross-python-compatibility" title="Permalink to this headline">¶</a></h3>
<p>testtools gives you the very latest in unit testing technology in a way that
will work with Python 2.6, 2.7, 3.1 and 3.2.</p>
<p>If you wish to use testtools with Python 2.4 or 2.5, then please use testtools
0.9.15. Up to then we supported Python 2.4 and 2.5, but we found the
constraints involved in not using the newer language features onerous as we
added more support for versions post Python 3.</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">testtools: tasteful testing for Python</a><ul>
<li><a class="reference internal" href="#why-use-testtools">Why use testtools?</a><ul>
<li><a class="reference internal" href="#better-assertion-methods">Better assertion methods</a></li>
<li><a class="reference internal" href="#matchers-better-than-assertion-methods">Matchers: better than assertion methods</a></li>
<li><a class="reference internal" href="#more-debugging-info-when-you-need-it">More debugging info, when you need it</a></li>
<li><a class="reference internal" href="#extend-unittest-but-stay-compatible-and-re-usable">Extend unittest, but stay compatible and re-usable</a></li>
<li><a class="reference internal" href="#cross-python-compatibility">Cross-Python compatibility</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">testtools: tasteful testing for Python</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="for-test-authors.html"
title="next chapter">testtools for test authors</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/overview.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="for-test-authors.html" title="testtools for test authors"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="testtools: tasteful testing for Python"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">testtools VERSION documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2010, The testtools authors.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.
</div>
</body>
</html>
|