twisted.trial.unittest.Tester.html [plain text]
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>twisted.trial.unittest.Tester</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.trial.html">Package trial</a> ::
<a href="twisted.trial.unittest.html">Module unittest</a> ::
Class Tester
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.trial.unittest.Tester.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class Tester</h2>
<hr/>
I contain all the supporting machinery for running a single test
method.
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>testClass</span>,
<span class=summary-sig-arg>testCase</span>,
<span class=summary-sig-arg>method</span>,
<span class=summary-sig-arg>runner</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.trial.unittest.Tester.html#_main" class="summary-sig-name"><code>_main</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
I actually to the setUp and run the test.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.trial.unittest.Tester.html#_runPhase" class="summary-sig-name"><code>_runPhase</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>stage</span>,
<span class="summary-sig-vararg">*args</span>,
<span class="summary-sig-kwarg">**kwargs</span>)</span></code>
<br />
I run a single phase of the testing process.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.trial.unittest.Tester.html#cleanUp" class="summary-sig-name"><code>cleanUp</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
I clean up after the test is run.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.trial.unittest.Tester.html#getResult" class="summary-sig-name"><code>getResult</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
I return a tuple containing the first result obtained from the
test.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.trial.unittest.Tester.html#run" class="summary-sig-name"><code>run</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
I run a single test.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="setUp_and_test"></a><span class="summary-sig"><span class="summary-sig-name">setUp_and_test</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="tearDown"></a><span class="summary-sig"><span class="summary-sig-name">tearDown</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="_main"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_main</span>(<span class=sig-arg>self</span>)</span>
</h3>
I actually to the setUp and run the test. I only make sense inside
_runPhase.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="_runPhase"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_runPhase</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>stage</span>,
<span class="sig-vararg">*args</span>,
<span class="sig-kwarg">**kwargs</span>)</span>
</h3>
I run a single phase of the testing process. My job is to give
meaning to exceptions raised during the phase. I attach the results to
the instance member failures.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="cleanUp"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">cleanUp</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>I clean up after the test is run. This includes making sure there
are no pending calls lying around, garbage collecting and flushing
errors.</p>
This is all to ensure that any errors caused by this tests are
caught by this test.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="getResult"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getResult</span>(<span class=sig-arg>self</span>)</span>
</h3>
I return a tuple containing the first result obtained from the test.
If the test was successful, this is also the only result.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="run"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">run</span>(<span class=sig-arg>self</span>)</span>
</h3>
I run a single test. I go through the process of setUp, test,
tearDown and clean up for a single test method. I store my results in
the class and return self.getResult().
<dl><dt></dt><dd>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>KeyboardInterrupt</b></code> -
If someone hits Ctrl-C
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:07:42 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>