twisted.protocols.test.test_tls.TLSMemoryBIOTests(TestCase) class documentation

Part of twisted.protocols.test.test_tls (View In Hierarchy)

Tests for the implementation of ISSLTransport which runs over another ITransport.

Method test_interfaces TLSMemoryBIOProtocol instances provide ISSLTransport and ISystemHandle.
Method test_wrappedProtocolInterfaces TLSMemoryBIOProtocol instances provide the interfaces provided by the transport they wrap.
Method test_getHandle TLSMemoryBIOProtocol.getHandle returns the OpenSSL.SSL.Connection instance it uses to actually implement TLS.
Method test_makeConnection When TLSMemoryBIOProtocol is connected to a transport, it connects the protocol it wraps to a transport.
Method handshakeProtocols Start handshake between TLS client and server.
Method test_handshake The TLS handshake is performed when TLSMemoryBIOProtocol is connected to a transport.
Method test_handshakeFailure TLSMemoryBIOProtocol reports errors in the handshake process to the application-level protocol object using its connectionLost method and disconnects the underlying transport.
Method test_getPeerCertificate TLSMemoryBIOProtocol.getPeerCertificate returns the OpenSSL.crypto.X509Type instance representing the peer's certificate.
Method test_writeAfterHandshake Bytes written to TLSMemoryBIOProtocol before the handshake is complete are received by the protocol on the other side of the connection once the handshake succeeds.
Method writeBeforeHandshakeTest Run test where client sends data before handshake, given the sending protocol and expected bytes.
Method test_writeBeforeHandshake Bytes written to TLSMemoryBIOProtocol before the handshake is complete are received by the protocol on the other side of the connection once the handshake succeeds.
Method test_writeSequence Bytes written to TLSMemoryBIOProtocol with writeSequence are received by the protocol on the other side of the connection.
Method test_writeAfterLoseConnection Bytes written to TLSMemoryBIOProtocol after loseConnection is called are not transmitted (unless there is a registered producer, which will be tested elsewhere).
Method test_writeUnicodeRaisesTypeError Writing unicode to TLSMemoryBIOProtocol throws a TypeError.
Method test_multipleWrites If multiple separate TLS messages are received in a single chunk from the underlying transport, all of the application bytes from each message are delivered to the application-level protocol.
Method hugeWrite If a very long string is passed to TLSMemoryBIOProtocol.write, any trailing part of it which cannot be send immediately is buffered and sent later.
Method test_hugeWrite_TLSv1 Undocumented
Method test_hugeWrite_TLSv1_1 Undocumented
Method test_hugeWrite_TLSv1_2 Undocumented
Method test_disorderlyShutdown If a TLSMemoryBIOProtocol loses its connection unexpectedly, this is reported to the application.
Method test_loseConnectionAfterHandshake TLSMemoryBIOProtocol.loseConnection sends a TLS close alert and shuts down the underlying connection cleanly on both sides, after transmitting all buffered data.
Method test_connectionLostOnlyAfterUnderlyingCloses The user protocol's connectionLost is only called when transport underlying TLS is disconnected.
Method test_loseConnectionTwice If TLSMemoryBIOProtocol.loseConnection is called multiple times, all but the first call have no effect.
Method test_loseConnectionAfterConnectionLost If TLSMemoryBIOProtocol.loseConnection is called after connectionLost, it does nothing.
Method test_unexpectedEOF Unexpected disconnects get converted to ConnectionLost errors.
Method test_errorWriting Errors while writing cause the protocols to be disconnected.
Method test_noCircularReferences TLSMemoryBIOProtocol doesn't leave circular references that keep it in memory after connection is closed.

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 test_interfaces(self):

TLSMemoryBIOProtocol instances provide ISSLTransport and ISystemHandle.

def test_wrappedProtocolInterfaces(self):

TLSMemoryBIOProtocol instances provide the interfaces provided by the transport they wrap.

def test_getHandle(self):

TLSMemoryBIOProtocol.getHandle returns the OpenSSL.SSL.Connection instance it uses to actually implement TLS.

This may seem odd. In fact, it is. The OpenSSL.SSL.Connection is not actually the "system handle" here, nor even an object the reactor knows about directly. However, twisted.internet.ssl.Certificate's peerFromTransport and hostFromTransport methods depend on being able to get an OpenSSL.SSL.Connection object in order to work properly. Implementing ISystemHandle.getHandle like this is the easiest way for those APIs to be made to work. If they are changed, then it may make sense to get rid of this implementation of ISystemHandle and return the underlying socket instead.

def test_makeConnection(self):

When TLSMemoryBIOProtocol is connected to a transport, it connects the protocol it wraps to a transport.

def handshakeProtocols(self):

Start handshake between TLS client and server.

def test_handshake(self):

The TLS handshake is performed when TLSMemoryBIOProtocol is connected to a transport.

def test_handshakeFailure(self):

TLSMemoryBIOProtocol reports errors in the handshake process to the application-level protocol object using its connectionLost method and disconnects the underlying transport.

def test_getPeerCertificate(self):

TLSMemoryBIOProtocol.getPeerCertificate returns the OpenSSL.crypto.X509Type instance representing the peer's certificate.

def test_writeAfterHandshake(self):

Bytes written to TLSMemoryBIOProtocol before the handshake is complete are received by the protocol on the other side of the connection once the handshake succeeds.

def writeBeforeHandshakeTest(self, sendingProtocol, data):

Run test where client sends data before handshake, given the sending protocol and expected bytes.

def test_writeBeforeHandshake(self):

Bytes written to TLSMemoryBIOProtocol before the handshake is complete are received by the protocol on the other side of the connection once the handshake succeeds.

def test_writeSequence(self):

Bytes written to TLSMemoryBIOProtocol with writeSequence are received by the protocol on the other side of the connection.

def test_writeAfterLoseConnection(self):

Bytes written to TLSMemoryBIOProtocol after loseConnection is called are not transmitted (unless there is a registered producer, which will be tested elsewhere).

def test_writeUnicodeRaisesTypeError(self):

Writing unicode to TLSMemoryBIOProtocol throws a TypeError.

def test_multipleWrites(self):

If multiple separate TLS messages are received in a single chunk from the underlying transport, all of the application bytes from each message are delivered to the application-level protocol.

def hugeWrite(self, method=TLSv1_METHOD):

If a very long string is passed to TLSMemoryBIOProtocol.write, any trailing part of it which cannot be send immediately is buffered and sent later.

def test_hugeWrite_TLSv1(self):
Undocumented
def test_hugeWrite_TLSv1_1(self):
Undocumented
def test_hugeWrite_TLSv1_2(self):
Undocumented
def test_disorderlyShutdown(self):

If a TLSMemoryBIOProtocol loses its connection unexpectedly, this is reported to the application.

def test_loseConnectionAfterHandshake(self):

TLSMemoryBIOProtocol.loseConnection sends a TLS close alert and shuts down the underlying connection cleanly on both sides, after transmitting all buffered data.

def test_connectionLostOnlyAfterUnderlyingCloses(self):

The user protocol's connectionLost is only called when transport underlying TLS is disconnected.

def test_loseConnectionTwice(self):

If TLSMemoryBIOProtocol.loseConnection is called multiple times, all but the first call have no effect.

def test_loseConnectionAfterConnectionLost(self):

If TLSMemoryBIOProtocol.loseConnection is called after connectionLost, it does nothing.

def test_unexpectedEOF(self):

Unexpected disconnects get converted to ConnectionLost errors.

def test_errorWriting(self):

Errors while writing cause the protocols to be disconnected.

def test_noCircularReferences(self):

TLSMemoryBIOProtocol doesn't leave circular references that keep it in memory after connection is closed.

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