twisted.web.test.test_http2.HTTP2TimeoutTests(unittest.TestCase, HTTP2TestHelpers) class documentation

Part of twisted.web.test.test_http2 (View In Hierarchy)

The H2Connection object times out idle connections.

Method patch_TimeoutMixin_clock Unfortunately, TimeoutMixin does not allow passing an explicit reactor to test timeouts. For that reason, we need to monkeypatch the method set up by the TimeoutMixin.
Method initiateH2Connection Performs test setup by building a HTTP/2 connection object, a transport to back it, a reactor to run in, and sending in some initial data as needed.
Method assertTimedOut Confirm that the data that was sent matches what we expect from a timeout: namely, that it ends with a GOAWAY frame carrying an appropriate error code and last stream ID.
Method prepareAbortTest Does the common setup for tests that want to test the aborting functionality of the HTTP/2 stack.
Method test_timeoutAfterInactivity When a H2Connection does not receive any data for more than the time out interval, it closes the connection cleanly.
Method test_timeoutResetByRequestData When a H2Connection receives data, the timeout is reset.
Method test_timeoutResetByResponseData When a H2Connection sends data, the timeout is reset.
Method test_timeoutWithProtocolErrorIfStreamsOpen When a H2Connection times out with active streams, the error code returned is h2.errors.ErrorCodes.PROTOCOL_ERROR.
Method test_noTimeoutIfConnectionLost When a H2Connection loses its connection it cancels its timeout.
Method test_timeoutEventuallyForcesConnectionClosed When a H2Connection has timed the connection out, and the transport doesn't get torn down within 15 seconds, it gets forcibly closed.
Method test_losingConnectionCancelsTheAbort When a H2Connection has timed the connection out, getting connectionLost called on it cancels the forcible connection close.
Method test_losingConnectionWithNoAbortTimeOut When a H2Connection has timed the connection out but the abortTimeout is set to None, the connection is never aborted.
Method test_connectionLostAfterForceClose If a timed out transport doesn't close after 15 seconds, the HTTPChannel will forcibly close it.
Method test_timeOutClientThatSendsOnlyInvalidFrames A client that sends only invalid frames is eventually timed out.

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.

Inherited from HTTP2TestHelpers:

Method assertAllStreamsBlocked Confirm that all streams are blocked: that is, the priority tree believes that none of the streams have data ready to send.
def patch_TimeoutMixin_clock(self, connection, reactor):

Unfortunately, TimeoutMixin does not allow passing an explicit reactor to test timeouts. For that reason, we need to monkeypatch the method set up by the TimeoutMixin.

ParametersconnectionThe HTTP/2 connection object to patch. (type: H2Connection)
reactorThe reactor whose callLater method we want. (type: An object implementing twisted.internet.interfaces.IReactorTime)
def initiateH2Connection(self, initialData, requestFactory):

Performs test setup by building a HTTP/2 connection object, a transport to back it, a reactor to run in, and sending in some initial data as needed.

ParametersinitialDataThe initial HTTP/2 data to be fed into the connection after setup. (type: bytes)
requestFactoryThe Request factory to use with the connection.
def assertTimedOut(self, data, frameCount, errorCode, lastStreamID):

Confirm that the data that was sent matches what we expect from a timeout: namely, that it ends with a GOAWAY frame carrying an appropriate error code and last stream ID.

def prepareAbortTest(self, abortTimeout=_DEFAULT):

Does the common setup for tests that want to test the aborting functionality of the HTTP/2 stack.

ParametersabortTimeoutThe value to use for the abortTimeout. Defaults to whatever is set on H2Connection.abortTimeout. (type: int or None)
ReturnsA tuple of the reactor being used for the connection, the connection itself, and the transport.
def test_timeoutAfterInactivity(self):

When a H2Connection does not receive any data for more than the time out interval, it closes the connection cleanly.

def test_timeoutResetByRequestData(self):

When a H2Connection receives data, the timeout is reset.

def test_timeoutResetByResponseData(self):

When a H2Connection sends data, the timeout is reset.

def test_timeoutWithProtocolErrorIfStreamsOpen(self):

When a H2Connection times out with active streams, the error code returned is h2.errors.ErrorCodes.PROTOCOL_ERROR.

def test_noTimeoutIfConnectionLost(self):

When a H2Connection loses its connection it cancels its timeout.

def test_timeoutEventuallyForcesConnectionClosed(self):

When a H2Connection has timed the connection out, and the transport doesn't get torn down within 15 seconds, it gets forcibly closed.

def test_losingConnectionCancelsTheAbort(self):

When a H2Connection has timed the connection out, getting connectionLost called on it cancels the forcible connection close.

def test_losingConnectionWithNoAbortTimeOut(self):

When a H2Connection has timed the connection out but the abortTimeout is set to None, the connection is never aborted.

def test_connectionLostAfterForceClose(self):

If a timed out transport doesn't close after 15 seconds, the HTTPChannel will forcibly close it.

def test_timeOutClientThatSendsOnlyInvalidFrames(self):

A client that sends only invalid frames is eventually timed out.

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