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

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

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 __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 Run a single method, either a test method or fixture.
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 Deferreds. After they complete, do some reactor cleanup.
Method _wait Take a Deferred that only ever callbacks. Block until it happens.

Inherited from SynchronousTestCase:

Instance Variable failureException 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 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.
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.
Method __eq__ Undocumented
Method __ne__ Undocumented
Method shortDescription Undocumented
Method getSkip No summary
Method getTodo No summary
Method runTest If no methodName argument is passed to the constructor, run will treat this method as the thing with the actual test inside.
Method run Run the test case, storing the results in result.
Method patch Monkey patch an object for the duration of the test.
Method flushLoggedErrors Remove stored errors received from the log.
Method flushWarnings Remove stored warnings from the list of captured warnings and return them.
Method callDeprecated 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 mktemp Returns a unique name that may be used as either a temporary directory or filename.
Method _getSuppress No summary
Method _getSkipReason Return the reason to use for skipping a test method.
Method _installObserver Undocumented
Method _removeObserver Undocumented

Inherited from _Assertions (via SynchronousTestCase):

Method fail Absolutely fail the test. Do not pass go, do not collect $200.
Method failIf Fail the test if condition evaluates to True.
Method failUnless Fail the test if condition evaluates to False.
Method failUnlessRaises 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 assertEqual Fail the test if first and second are not equal.
Method failUnlessIdentical Fail the test if first is not second. This is an obect-identity-equality test, not an object equality (i.e. __eq__) test.
Method failIfIdentical Fail the test if first is second. This is an obect-identity-equality test, not an object equality (i.e. __eq__) test.
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 difference rounded to the given number of decimal places (default 7) and comparing to zero.
Method failUnlessAlmostEqual 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 failUnlessApproximates Fail if first - second > tolerance
Method failUnlessFailure 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 failUnlessSubstring Fail if substring does not exist within astring.
Method failIfSubstring Fail if astring contains substring.
Method failUnlessWarns 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 failUnlessIsInstance Fail if instance is not an instance of the given class or of one of the given classes.
Method failIfIsInstance Fail if instance is not an instance of the given class or of one of the given classes.
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, runTest will be used as the test method. This is mostly useful for testing Trial.
def _run(self, methodName, result): (source)
Run a single method, either a test method or fixture.
ParameterssuppressAny 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.
resultThe TestResult instance to which to report results.
ReturnsTrue if the method fails and no further method/fixture calls should be made, False otherwise.
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 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-09-01 11:44:56.