class documentation

class TestCase(SynchronousTestCase): (source)

Implements interfaces: twisted.trial.itrial.ITestCase

View In Hierarchy

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.

Method __call__ Run the test. Should always do exactly the same thing as run().
Method __init__ Construct an asynchronous test case for methodName.
Method add​Cleanup Extend the base cleanup feature with support for cleanup functions which return Deferreds.
Method assert​Failure 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 defer​Run​Cleanups Run any scheduled cleanups and report errors (if any) to the result. object.
Method defer​Set​Up Undocumented
Method defer​Tear​Down Undocumented
Method defer​Test​Method Undocumented
Method get​Suppress Undocumented
Method get​Timeout No summary
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 _cb​Defer​Test​Method Undocumented
Method _class​Clean​Up Undocumented
Method _clean​Up Undocumented
Method _deprecate​Reactor 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 _eb​Defer​Set​Up Undocumented
Method _eb​Defer​Tear​Down Undocumented
Method _eb​Defer​Test​Method Undocumented
Method _make​Reactor​Method Create a method which wraps the reactor method name. The new method issues a deprecation warning and calls the original.
Method _run Run a single method, either a test method or fixture.
Method _run​Fixtures​And​Test Really run setUp, the test method, and tearDown. Any of these may return defer.Deferreds. After they complete, do some reactor cleanup.
Method _undeprecate​Reactor Restore the deprecated reactor methods. Undoes what _deprecateReactor did.
Method _wait Take a Deferred that only ever callbacks. Block until it happens.
Instance Variable _passed Undocumented
Instance Variable _reactor​Methods Undocumented
Instance Variable _timed​Out Undocumented

Inherited from SynchronousTestCase:

Method __eq__ No summary
Method __hash__ Undocumented
Method call​Deprecated Call a function that should have been deprecated at a specific version and in favor of a specific alternative, and assert that it was thusly deprecated.
Method flush​Logged​Errors Remove stored errors received from the log.
Method flush​Warnings Remove stored warnings from the list of captured warnings and return them.
Method get​Deprecated​Module​Attribute Retrieve a module attribute which should have been deprecated, and assert that we saw the appropriate deprecation warning.
Method get​Skip No summary
Method get​Todo No summary
Method mktemp Create a new path name which can be used for a new file or directory.
Method patch Monkey patch an object for the duration of the test.
Method run Run the test case, storing the results in result.
Method run​Test If no methodName argument is passed to the constructor, run will treat this method as the thing with the actual test inside.
Method short​Description Undocumented
Instance Variable failure​Exception An 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.
Instance Variable skip None 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).
Instance Variable suppress None 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.
Instance Variable todo None, 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 _get​Skip​Reason Return the reason to use for skipping a test method.
Method _get​Suppress No summary
Method _install​Observer Undocumented
Method _remove​Observer Undocumented
Method _run​Cleanups Synchronously run any cleanups which have been added.
Instance Variable _cleanups Undocumented
Instance Variable _observer Undocumented
Instance Variable _parents Undocumented
Instance Variable _test​Method​Name Undocumented
Instance Variable _warnings Undocumented

Inherited from _Assertions (via SynchronousTestCase):

Method assert​Almost​Equal Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.
Method assert​Approximates Fail if first - second > tolerance
Method assert​Equal Fail the test if first and second are not equal.
Method assert​False Fail the test if condition evaluates to True.
Method assert​In Fail the test if containee is not found in container.
Method assert​Is Fail the test if first is not second. This is an obect-identity-equality test, not an object equality (i.e. __eq__) test.
Method assert​Is​Instance Fail if instance is not an instance of the given class or of one of the given classes.
Method assert​Is​Not Fail the test if first is second. This is an obect-identity-equality test, not an object equality (i.e. __eq__) test.
Method assert​No​Result Assert that deferred does not have a result at this point.
Method assert​Not​Almost​Equal Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.
Method assert​Not​Equal Fail the test if first == second.
Method assert​Not​In Fail the test if containee is found in container.
Method assert​Not​Is​Instance Fail if instance is an instance of the given class or of one of the given classes.
Method assert​Not​Substring Fail if astring contains substring.
Method assert​Raises Fail the test unless calling the function f with the given args and kwargs raises exception. The failure will report the traceback and call stack of the unexpected exception.
Method assert​Substring Fail if substring does not exist within astring.
Method assert​True Fail the test if condition evaluates to False.
Method assert​Warns Fail if the given function doesn't generate the specified warning when called. It calls the function, checks the warning, and forwards the result of the function if everything is fine.
Method fail Absolutely fail the test. Do not pass go, do not collect $200.
Method failure​Result​Of Return the current failure result of deferred or raise self.failureException.
Method success​Result​Of Return the current success result of deferred or raise self.failureException.
def __call__(self, *args, **kwargs): (source)
Run the test. Should always do exactly the same thing as run().
def __init__(self, methodName='runTest'): (source)
Construct an asynchronous test case for methodName.
Parameters
method​NameThe 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 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 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.
@defer.inlineCallbacks
def deferRunCleanups(self, ignored, result): (source)
Run any scheduled cleanups and report errors (if any) to the result. object.
def deferSetUp(self, ignored, result): (source)

Undocumented

def deferTearDown(self, ignored, result): (source)

Undocumented

def deferTestMethod(self, ignored, result): (source)

Undocumented

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.
timeout = (source)
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 _cbDeferTestMethod(self, ignored, result): (source)

Undocumented

def _classCleanUp(self, result): (source)

Undocumented

def _cleanUp(self, result): (source)

Undocumented

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.
Parameters
reactorThe Twisted reactor.
def _ebDeferSetUp(self, failure, result): (source)

Undocumented

def _ebDeferTearDown(self, failure, result): (source)

Undocumented

def _ebDeferTestMethod(self, f, 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 _run(self, methodName, result): (source)
Run a single method, either a test method or fixture.
Parameters
method​NameUndocumented
resultThe TestResult instance to which to report results.
suppressAny warnings to suppress, as defined by the suppress attribute on this method, test case, or the module it is defined in.
todoAny expected failure or failures, as defined by the todo attribute on this method, test case, or the module it is defined in.
methodThe method to run.
Returns
True if the method fails and no further method/fixture calls should be made, False otherwise.
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.
Parameters
resultA TestResult object.
def _undeprecateReactor(self, reactor): (source)
Restore the deprecated reactor methods. Undoes what _deprecateReactor did.
Parameters
reactorThe Twisted reactor.
def _wait(self, d, running=_wait_is_running): (source)
Take a Deferred that only ever callbacks. Block until it happens.
_reactorMethods: dict = (source)

Undocumented

_timedOut: bool = (source)

Undocumented