t.t.u.TestCase(SynchronousTestCase) : class documentation

Part of twisted.trial.unittest View Source View In Hierarchy

Implements interfaces: twisted.trial.itrial.ITestCase

A unit test. The atom of the unit testing universe.

This class extends SynchronousTestCase which extends unittest.TestCase from the standard library. The main feature is the ability to return Deferreds from tests and fixture methods and to have the suite wait for those Deferreds to fire. Also provides new assertions such as assertFailure.

Instance Variable timeout A real number of seconds. If set, the test will raise an error if it takes longer than timeout seconds. If not set, util.DEFAULT_TIMEOUT_DURATION is used.
Method __init__ Construct an asynchronous test case for methodName.
Method assertFailure Fail if deferred does not errback with one of expectedFailures. Returns the original Deferred with callbacks added. You will need to return this Deferred from your test case.
Method __call__ Run the test. Should always do exactly the same thing as run().
Method deferSetUp Undocumented
Method deferTestMethod Undocumented
Method deferTearDown Undocumented
Method deferRunCleanups Run any scheduled cleanups and report errors (if any to the result object.
Method addCleanup Extend the base cleanup feature with support for cleanup functions which return Deferreds.
Method getSuppress Undocumented
Method getTimeout No summary
Method visit Visit this test case. Call visitor with self as a parameter.
Method _run Undocumented
Method _ebDeferSetUp Undocumented
Method _cbDeferTestMethod Undocumented
Method _ebDeferTestMethod Undocumented
Method _ebDeferTearDown Undocumented
Method _cbDeferRunCleanups Undocumented
Method _cleanUp Undocumented
Method _classCleanUp Undocumented
Method _makeReactorMethod Create a method which wraps the reactor method name. The new method issues a deprecation warning and calls the original.
Method _deprecateReactor Deprecate iterate, crash and stop on reactor. That is, each method is wrapped in a function that issues a deprecation warning, then calls the original.
Method _undeprecateReactor Restore the deprecated reactor methods. Undoes what _deprecateReactor did.
Method _runCleanups Run the cleanups added with addCleanup in order.
Method _runFixturesAndTest Really run setUp, the test method, and tearDown. Any of these may return defer.Deferreds. After they complete, do some reactor cleanup.
Method _wait Take a Deferred that only ever callbacks. Block until it happens.
timeout =
A real number of seconds. If set, the test will raise an error if it takes longer than timeout seconds. If not set, util.DEFAULT_TIMEOUT_DURATION is used.
def __init__(self, methodName='runTest'): (source)
Construct an asynchronous test case for methodName.
ParametersmethodNameThe name of a method on self. This method should be a unit test. That is, it should be a short method that calls some of the assert* methods. If methodName is unspecified, SynchronousTestCase.runTest will be used as the test method. This is mostly useful for testing Trial.
def assertFailure(self, deferred, *expectedFailures): (source)
Fail if deferred does not errback with one of expectedFailures. Returns the original Deferred with callbacks added. You will need to return this Deferred from your test case.
def _run(self, methodName, result): (source)
Undocumented
def __call__(self, *args, **kwargs): (source)
Run the test. Should always do exactly the same thing as run().
def deferSetUp(self, ignored, result): (source)
Undocumented
def _ebDeferSetUp(self, failure, result): (source)
Undocumented
def deferTestMethod(self, ignored, result): (source)
Undocumented
def _cbDeferTestMethod(self, ignored, result): (source)
Undocumented
def _ebDeferTestMethod(self, f, result): (source)
Undocumented
def deferTearDown(self, ignored, result): (source)
Undocumented
def _ebDeferTearDown(self, failure, result): (source)
Undocumented
def deferRunCleanups(self, ignored, result): (source)
Run any scheduled cleanups and report errors (if any to the result object.
def _cbDeferRunCleanups(self, cleanupResults, result): (source)
Undocumented
def _cleanUp(self, result): (source)
Undocumented
def _classCleanUp(self, result): (source)
Undocumented
def _makeReactorMethod(self, name): (source)
Create a method which wraps the reactor method name. The new method issues a deprecation warning and calls the original.
def _deprecateReactor(self, reactor): (source)
Deprecate iterate, crash and stop on reactor. That is, each method is wrapped in a function that issues a deprecation warning, then calls the original.
ParametersreactorThe Twisted reactor.
def _undeprecateReactor(self, reactor): (source)
Restore the deprecated reactor methods. Undoes what _deprecateReactor did.
ParametersreactorThe Twisted reactor.
def _runCleanups(self): (source)
Run the cleanups added with addCleanup in order.
ReturnsA Deferred that fires when all cleanups are run.
def _runFixturesAndTest(self, result): (source)
Really run setUp, the test method, and tearDown. Any of these may return defer.Deferreds. After they complete, do some reactor cleanup.
ParametersresultA TestResult object.
def addCleanup(self, f, *args, **kwargs): (source)
Extend the base cleanup feature with support for cleanup functions which return Deferreds.

If the function f returns a Deferred, TestCase will wait until the Deferred has fired before proceeding to the next function.

def getSuppress(self): (source)
Undocumented
def getTimeout(self): (source)
Returns the timeout value set on this test. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a timeout attribute, returns that. Returns util.DEFAULT_TIMEOUT_DURATION if it cannot find anything. See TestCase docstring for more details.
def visit(self, visitor): (source)
Visit this test case. Call visitor with self as a parameter.

Deprecated in Twisted 8.0.

ParametersvisitorA callable which expects a single parameter: a test case.
ReturnsNone
def _wait(self, d, running=_wait_is_running): (source)
Take a Deferred that only ever callbacks. Block until it happens.
API Documentation for Twisted, generated by pydoctor at 2012-12-26 12:18:15.