Class t.t.u.TestCase(_Assertions):

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

Known subclasses: twisted.trial.unittest._SubTestCase

Implements interfaces: twisted.trial.itrial.ITestCase

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

This class 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.

To write a unit test, subclass TestCase and define a method (say, 'test_foo') on the subclass. To run the test, instantiate your subclass with the name of the method, and call run on the instance, passing a TestResult object.

The trial script will automatically find any TestCase subclasses defined in modules beginning with 'test_' and construct test cases for all methods beginning with 'test'.

If an error is logged during the test run, the test will fail with an error. See log.err.
Instance VariablesfailureExceptionAn exception class, defaulting to FailTest. If the test method raises this exception, it will be reported as a failure, rather than an exception. All of the assertion methods raise this if the assertion fails.
forceGarbageCollectionIf set to True, gc.collect() will be called before and after the test. Otherwise, garbage collection will happen in whatever way Python sees fit.
skipNone or a string explaining why this test is to be skipped. If defined, the test will not be run. Instead, it will be reported to the result object as 'skipped' (if the TestResult supports skipping).
suppressNone or a list of tuples of (args, kwargs) to be passed to warnings.filterwarnings. Use these to suppress warnings raised in a test. Useful for testing deprecated code. See also util.suppress.
timeoutNone or a real number of seconds. If set, the test will raise an error if it takes longer than timeout seconds.
todoNone, a string or a tuple of (errors, reason) where errors is either an exception class or an iterable of exception classes, and reason is a string. See Todo or makeTodo for more information.
Method __init__ Construct an asynchronous test case for methodName.
Method _initInstances Undocumented
Method _isFirst Undocumented
Method _isLast Undocumented
Method _prepareClassFixture Lots of tests assume that test methods all run in the same instance
Method _run Undocumented
Method shortDescription Undocumented
Method __call__ Undocumented
Method deferSetUpClass Undocumented
Method _ebDeferSetUpClass Undocumented
Method deferSetUp Undocumented
Method _ebDeferSetUp Undocumented
Method deferTestMethod Undocumented
Method _cbDeferTestMethod Undocumented
Method _ebDeferTestMethod Undocumented
Method deferTearDown Undocumented
Method _ebDeferTearDown Undocumented
Method deferTearDownClass Undocumented
Method _ebTearDownClass Undocumented
Method _cleanUp Undocumented
Method _classCleanUp Undocumented
Method _makeReactorMethod Create a method which wraps the reactor method name. The new
Method _deprecateReactor Deprecate iterate, crash and stop on reactor. That is,
Method _undeprecateReactor Restore the deprecated reactor methods. Undoes what
Method _installObserver Undocumented
Method _removeObserver Undocumented
Method flushLoggedErrors Remove stored errors received from the log.
Method runTest If no methodName argument is passed to the constructor, run will
Method run Run the test case, storing the results in result.
Method _getReason Undocumented
Method getSkip Return the skip reason set on this test, if any is set. Checks on the
Method getTodo Return a Todo object if the test is marked todo. Checks on the
Method getTimeout Returns the timeout value set on this test. Checks on the instance
Method getSuppress Returns any warning suppressions set for this test. Checks on the
Method visit Visit this test case. Call visitor with self as a parameter.
Method mktemp Returns a unique name that may be used as either a temporary
Method _wait Take a Deferred that only ever callbacks. Block until it happens.

Inherited from _Assertions:

Method fail absolutely fails the test, do not pass go, do not collect $200
Method failIf fails the test if condition evaluates to False
Method failUnless fails the test if condition evaluates to True
Method failUnlessRaises fails the test unless calling the function f with the given args
Method failUnlessEqual fail the test if first and second are not equal
Method failUnlessIdentical fail the test if first is not second. This is an
Method failIfIdentical fail the test if first is second. This is an
Method failIfEqual fail the test if first == second
Method failUnlessIn fail the test if containee is not found in container
Method failIfIn fail the test if containee is found in container
Method failIfAlmostEqual Fail if the two objects are equal as determined by their
Method failUnlessAlmostEqual Fail if the two objects are unequal as determined by their
Method failUnlessApproximates asserts that first - second > tolerance
Method failUnlessFailure Assert that deferred will errback with one of
Method failUnlessSubstring Undocumented
Method failIfSubstring Undocumented
def __init__(self, methodName='runTest'): (source)
overridden in twisted.trial.unittest._SubTestCase
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, runTest will be used as the test method. This is mostly useful for testing Trial.
def _initInstances(cls): (source)
Undocumented
def _isFirst(self): (source)
Undocumented
def _isLast(self): (source)
Undocumented
def _prepareClassFixture(self): (source)
Lots of tests assume that test methods all run in the same instance of TestCase. This isn't true. Calling this method ensures that self.__class__._testCaseInstance contains an instance of this class that will remain the same for all tests from this class.
def _run(self, methodName, result): (source)
Undocumented
def shortDescription(self): (source)
Undocumented
def __call__(self, *args, **kwargs): (source)
Undocumented
def deferSetUpClass(self, result): (source)
Undocumented
def _ebDeferSetUpClass(self, error, result): (source)
Undocumented
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 deferTearDownClass(self, ignored, result): (source)
Undocumented
def _ebTearDownClass(self, error, 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 _installObserver(self): (source)
Undocumented
def _removeObserver(self): (source)
Undocumented
def flushLoggedErrors(self, *errorTypes): (source)

Remove stored errors received from the log.

TestCase stores each error logged during the run of the test and reports them as errors during the cleanup phase (after tearDown).
Parameters*errorTypesIf unspecifed, flush all errors. Otherwise, only flush errors that match the given types.
ReturnsA list of failures that have been removed.
def runTest(self): (source)
If no methodName argument is passed to the constructor, run will treat this method as the thing with the actual test inside.
def run(self, result): (source)

Run the test case, storing the results in result.

First runs setUp on self, then runs the test method (defined in the constructor), then runs tearDown. Any of these may return Deferreds. After they complete, does some reactor cleanup.
ParametersresultA TestResult object.
def _getReason(self, f): (source)
Undocumented
def getSkip(self): (source)
Return the skip reason set on this test, if any is set. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a skip attribute, returns that. Returns None if it cannot find anything. See TestCase docstring for more details.
def getTodo(self): (source)
Return a Todo object if the test is marked todo. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a todo attribute, returns that. Returns None if it cannot find anything. See TestCase docstring for more details.
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 getSuppress(self): (source)
Returns any warning suppressions set for this test. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a suppress attribute, returns that. Returns any empty list (i.e. suppress no warnings) 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.
ParametersvisitorA callable which expects a single parameter: a test case.
ReturnsNone
def mktemp(self): (source)
Returns a unique name that may be used as either a temporary directory or filename.
Noteyou must call os.mkdir on the value returned from this method if you wish to use it as a directory!
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.