twisted.test.test_amp.BinaryProtocolTests(unittest.TestCase) class documentation

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

Tests for amp.BinaryBoxProtocol.

Method setUp Keep track of all boxes received by this test in its capacity as an IBoxReceiver implementor.
Method startReceivingBoxes Implement IBoxReceiver.startReceivingBoxes to just remember the value passed in.
Method ampBoxReceived A box was received by the protocol.
Method stopReceivingBoxes Record the reason that we stopped receiving boxes.
Method getPeer Undocumented
Method getHost Undocumented
Method write Undocumented
Method test_startReceivingBoxes When amp.BinaryBoxProtocol is connected to a transport, it calls startReceivingBoxes on its IBoxReceiver with itself as the IBoxSender parameter.
Method test_sendBoxInStartReceivingBoxes No summary
Method test_receiveBoxStateMachine No summary
Method test_firstBoxFirstKeyExcessiveLength amp.BinaryBoxProtocol drops its connection if the length prefix for the first a key it receives is larger than 255.
Method test_firstBoxSubsequentKeyExcessiveLength amp.BinaryBoxProtocol drops its connection if the length prefix for a subsequent key in the first box it receives is larger than 255.
Method test_subsequentBoxFirstKeyExcessiveLength amp.BinaryBoxProtocol drops its connection if the length prefix for the first key in a subsequent box it receives is larger than 255.
Method test_excessiveKeyFailure If amp.BinaryBoxProtocol disconnects because it received a key length prefix which was too large, the IBoxReceiver's stopReceivingBoxes method is called with a TooLong failure.
Method test_unhandledErrorWithTransport amp.BinaryBoxProtocol.unhandledError logs the failure passed to it and disconnects its transport.
Method test_unhandledErrorWithoutTransport amp.BinaryBoxProtocol.unhandledError completes without error when there is no associated transport.
Method test_receiveBoxData When a binary box protocol receives the serialized form of an AMP box, it should emit a similar box to its boxReceiver.
Method test_receiveLongerBoxData An amp.BinaryBoxProtocol can receive serialized AMP boxes with values of up to (2 ** 16 - 1) bytes.
Method test_sendBox When a binary box protocol sends a box, it should emit the serialized bytes of that box to its transport.
Method test_connectionLostStopSendingBoxes When a binary box protocol loses its connection, it should notify its box receiver that it has stopped receiving boxes.
Method test_protocolSwitch BinaryBoxProtocol has the capacity to switch to a different protocol on a box boundary. When a protocol is in the process of switching, it cannot receive traffic.
Method test_protocolSwitchEmptyBuffer After switching to a different protocol, if no extra bytes beyond the switch box were delivered, an empty string is not passed to the switched protocol's dataReceived method.
Method test_protocolSwitchInvalidStates No summary
Method test_protocolSwitchLoseConnection When the protocol is switched, it should notify its nested protocol of disconnection.
Method test_protocolSwitchLoseClientConnection When the protocol is switched, it should notify its nested client protocol factory of disconnection.
Instance Variable _boxSender After startReceivingBoxes is called, the IBoxSender which was passed to it.

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.
_boxSender =
After startReceivingBoxes is called, the IBoxSender which was passed to it.
def setUp(self):

Keep track of all boxes received by this test in its capacity as an IBoxReceiver implementor.

def startReceivingBoxes(self, sender):

Implement IBoxReceiver.startReceivingBoxes to just remember the value passed in.

def ampBoxReceived(self, box):

A box was received by the protocol.

def stopReceivingBoxes(self, reason):

Record the reason that we stopped receiving boxes.

def getPeer(self):
Undocumented
def getHost(self):
Undocumented
def write(self, data):
Undocumented
def test_startReceivingBoxes(self):

When amp.BinaryBoxProtocol is connected to a transport, it calls startReceivingBoxes on its IBoxReceiver with itself as the IBoxSender parameter.

def test_sendBoxInStartReceivingBoxes(self):

The IBoxReceiver which is started when amp.BinaryBoxProtocol is connected to a transport can call sendBox on the IBoxSender passed to it before startReceivingBoxes returns and have that box sent.

def test_receiveBoxStateMachine(self): 
When a binary box protocol receives:
    * a key
    * a value
    * an empty string
it should emit a box and send it to its boxReceiver.
def test_firstBoxFirstKeyExcessiveLength(self):

amp.BinaryBoxProtocol drops its connection if the length prefix for the first a key it receives is larger than 255.

def test_firstBoxSubsequentKeyExcessiveLength(self):

amp.BinaryBoxProtocol drops its connection if the length prefix for a subsequent key in the first box it receives is larger than 255.

def test_subsequentBoxFirstKeyExcessiveLength(self):

amp.BinaryBoxProtocol drops its connection if the length prefix for the first key in a subsequent box it receives is larger than 255.

def test_excessiveKeyFailure(self):

If amp.BinaryBoxProtocol disconnects because it received a key length prefix which was too large, the IBoxReceiver's stopReceivingBoxes method is called with a TooLong failure.

def test_unhandledErrorWithTransport(self):

amp.BinaryBoxProtocol.unhandledError logs the failure passed to it and disconnects its transport.

def test_unhandledErrorWithoutTransport(self):

amp.BinaryBoxProtocol.unhandledError completes without error when there is no associated transport.

def test_receiveBoxData(self):

When a binary box protocol receives the serialized form of an AMP box, it should emit a similar box to its boxReceiver.

def test_receiveLongerBoxData(self):

An amp.BinaryBoxProtocol can receive serialized AMP boxes with values of up to (2 ** 16 - 1) bytes.

def test_sendBox(self):

When a binary box protocol sends a box, it should emit the serialized bytes of that box to its transport.

def test_connectionLostStopSendingBoxes(self):

When a binary box protocol loses its connection, it should notify its box receiver that it has stopped receiving boxes.

def test_protocolSwitch(self):

BinaryBoxProtocol has the capacity to switch to a different protocol on a box boundary. When a protocol is in the process of switching, it cannot receive traffic.

def test_protocolSwitchEmptyBuffer(self):

After switching to a different protocol, if no extra bytes beyond the switch box were delivered, an empty string is not passed to the switched protocol's dataReceived method.

def test_protocolSwitchInvalidStates(self):

In order to make sure the protocol never gets any invalid data sent into the middle of a box, it must be locked for switching before it is switched. It can only be unlocked if the switch failed, and attempting to send a box while it is locked should raise an exception.

def test_protocolSwitchLoseConnection(self):

When the protocol is switched, it should notify its nested protocol of disconnection.

def test_protocolSwitchLoseClientConnection(self):

When the protocol is switched, it should notify its nested client protocol factory of disconnection.

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