twisted.test.test_internet.ThreePhaseEventTests(unittest.TestCase) class documentation

Part of twisted.test.test_internet (View In Hierarchy)

Tests for the private implementation helpers for system event triggers.

Method setUp Create a trigger, an argument, and an event to be used by tests.
Method test_addInvalidPhase _ThreePhaseEvent.addTrigger should raise KeyError when called with an invalid phase.
Method test_addBeforeTrigger _ThreePhaseEvent.addTrigger should accept 'before' as a phase, a callable, and some arguments and add the callable with the arguments to the before list.
Method test_addDuringTrigger _ThreePhaseEvent.addTrigger should accept 'during' as a phase, a callable, and some arguments and add the callable with the arguments to the during list.
Method test_addAfterTrigger _ThreePhaseEvent.addTrigger should accept 'after' as a phase, a callable, and some arguments and add the callable with the arguments to the after list.
Method test_removeTrigger _ThreePhaseEvent.removeTrigger should accept an opaque object previously returned by _ThreePhaseEvent.addTrigger and remove the associated trigger.
Method test_removeNonexistentTrigger _ThreePhaseEvent.removeTrigger should raise ValueError when given an object not previously returned by _ThreePhaseEvent.addTrigger.
Method test_removeRemovedTrigger _ThreePhaseEvent.removeTrigger should raise ValueError the second time it is called with an object returned by _ThreePhaseEvent.addTrigger.
Method test_removeAlmostValidTrigger _ThreePhaseEvent.removeTrigger should raise ValueError if it is given a trigger handle which resembles a valid trigger handle aside from its phase being incorrect.
Method test_fireEvent _ThreePhaseEvent.fireEvent should call before, during, and after phase triggers in that order.
Method test_asynchronousBefore _ThreePhaseEvent.fireEvent should wait for any Deferred returned by a before phase trigger before proceeding to during events.
Method test_beforeTriggerException If a before-phase trigger raises a synchronous exception, it should be logged and the remaining triggers should be run.
Method test_duringTriggerException If a during-phase trigger raises a synchronous exception, it should be logged and the remaining triggers should be run.
Method test_synchronousRemoveAlreadyExecutedBefore If a before-phase trigger tries to remove another before-phase trigger which has already run, a warning should be emitted.
Method test_synchronousRemovePendingBefore If a before-phase trigger removes another before-phase trigger which has not yet run, the removed trigger should not be run.
Method test_synchronousBeforeRemovesDuring If a before-phase trigger removes a during-phase trigger, the during-phase trigger should not be run.
Method test_asynchronousBeforeRemovesDuring If a before-phase trigger returns a Deferred and later removes a during-phase trigger before the Deferred fires, the during-phase trigger should not be run.
Method test_synchronousBeforeRemovesConspicuouslySimilarDuring No summary
Method test_synchronousRemovePendingDuring If a during-phase trigger removes another during-phase trigger which has not yet run, the removed trigger should not be run.
Method test_triggersRunOnce A trigger should only be called on the first call to _ThreePhaseEvent.fireEvent.
Method test_finishedBeforeTriggersCleared The temporary list _ThreePhaseEvent.finishedBefore should be emptied and the state reset to 'BASE' before the first during-phase trigger executes.

Inherited from TestCase:

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 _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 defer.Deferreds. After they complete, do some reactor cleanup.
Method _wait Take a Deferred that only ever callbacks. Block until it happens.

Inherited from SynchronousTestCase (via TestCase):

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__ No summary
Method __ne__ Undocumented
Method __hash__ 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 Create a new path name which can be used for a new file or directory.
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 TestCase, SynchronousTestCase):

Method fail Absolutely fail the test. Do not pass go, do not collect $200.
Method assertFalse Fail the test if condition evaluates to True.
Method assertTrue Fail the test if condition evaluates to False.
Method assertRaises 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 assertIs Fail the test if first is not second. This is an obect-identity-equality test, not an object equality (i.e. __eq__) test.
Method assertIsNot Fail the test if first is second. This is an obect-identity-equality test, not an object equality (i.e. __eq__) test.
Method assertNotEqual Fail the test if first == second.
Method assertIn Fail the test if containee is not found in container.
Method assertNotIn Fail the test if containee is found in container.
Method assertNotAlmostEqual 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 assertAlmostEqual 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 assertApproximates Fail if first - second > tolerance
Method assertSubstring Fail if substring does not exist within astring.
Method assertNotSubstring Fail if astring contains substring.
Method assertWarns 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 assertIsInstance Fail if instance is not an instance of the given class or of one of the given classes.
Method assertNotIsInstance Fail if instance is an instance of the given class or of one of the given classes.
Method successResultOf Return the current success result of deferred or raise self.failureException.
Method failureResultOf Return the current failure result of deferred or raise self.failureException.
Method assertNoResult Assert that deferred does not have a result at this point.
Method assertRegex Fail the test if a regexp search of text fails.
def setUp(self):

Create a trigger, an argument, and an event to be used by tests.

def test_addInvalidPhase(self):

_ThreePhaseEvent.addTrigger should raise KeyError when called with an invalid phase.

def test_addBeforeTrigger(self):

_ThreePhaseEvent.addTrigger should accept 'before' as a phase, a callable, and some arguments and add the callable with the arguments to the before list.

def test_addDuringTrigger(self):

_ThreePhaseEvent.addTrigger should accept 'during' as a phase, a callable, and some arguments and add the callable with the arguments to the during list.

def test_addAfterTrigger(self):

_ThreePhaseEvent.addTrigger should accept 'after' as a phase, a callable, and some arguments and add the callable with the arguments to the after list.

def test_removeTrigger(self):

_ThreePhaseEvent.removeTrigger should accept an opaque object previously returned by _ThreePhaseEvent.addTrigger and remove the associated trigger.

def test_removeNonexistentTrigger(self):

_ThreePhaseEvent.removeTrigger should raise ValueError when given an object not previously returned by _ThreePhaseEvent.addTrigger.

def test_removeRemovedTrigger(self):

_ThreePhaseEvent.removeTrigger should raise ValueError the second time it is called with an object returned by _ThreePhaseEvent.addTrigger.

def test_removeAlmostValidTrigger(self):

_ThreePhaseEvent.removeTrigger should raise ValueError if it is given a trigger handle which resembles a valid trigger handle aside from its phase being incorrect.

def test_fireEvent(self):

_ThreePhaseEvent.fireEvent should call before, during, and after phase triggers in that order.

def test_asynchronousBefore(self):

_ThreePhaseEvent.fireEvent should wait for any Deferred returned by a before phase trigger before proceeding to during events.

def test_beforeTriggerException(self):

If a before-phase trigger raises a synchronous exception, it should be logged and the remaining triggers should be run.

def test_duringTriggerException(self):

If a during-phase trigger raises a synchronous exception, it should be logged and the remaining triggers should be run.

def test_synchronousRemoveAlreadyExecutedBefore(self):

If a before-phase trigger tries to remove another before-phase trigger which has already run, a warning should be emitted.

def test_synchronousRemovePendingBefore(self):

If a before-phase trigger removes another before-phase trigger which has not yet run, the removed trigger should not be run.

def test_synchronousBeforeRemovesDuring(self):

If a before-phase trigger removes a during-phase trigger, the during-phase trigger should not be run.

def test_asynchronousBeforeRemovesDuring(self):

If a before-phase trigger returns a Deferred and later removes a during-phase trigger before the Deferred fires, the during-phase trigger should not be run.

def test_synchronousBeforeRemovesConspicuouslySimilarDuring(self):

If a before-phase trigger removes a during-phase trigger which is identical to an already-executed before-phase trigger aside from their phases, no warning should be emitted and the during-phase trigger should not be run.

def test_synchronousRemovePendingDuring(self):

If a during-phase trigger removes another during-phase trigger which has not yet run, the removed trigger should not be run.

def test_triggersRunOnce(self):

A trigger should only be called on the first call to _ThreePhaseEvent.fireEvent.

def test_finishedBeforeTriggersCleared(self):

The temporary list _ThreePhaseEvent.finishedBefore should be emptied and the state reset to 'BASE' before the first during-phase trigger executes.

API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.