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

Part of twisted.test.test_amp (View In Hierarchy)
No class docstring
Method test_interfaceDeclarations The classes in the amp module ought to implement the interfaces that are declared for their benefit.
Method test_helloWorld Verify that a simple command can be sent and its response received with the simple low-level string-based API.
Method test_wireFormatRoundTrip Verify that mixed-case, underscored and dashed arguments are mapped to their python names properly.
Method test_helloWorldUnicode Verify that unicode arguments can be encoded and decoded.
Method test_callRemoteStringRequiresAnswerFalse BoxDispatcher.callRemoteString returns None if requiresAnswer is False.
Method test_unknownCommandLow Verify that unknown commands using low-level APIs will be rejected with an error, but will NOT terminate the connection.
Method test_unknownCommandHigh Verify that unknown commands using high-level APIs will be rejected with an error, but will NOT terminate the connection.
Method test_brokenReturnValue It can be very confusing if you write some code which responds to a command, but gets the return value wrong. Most commonly you end up returning None instead of a dictionary.
Method test_unknownArgument Verify that unknown arguments are ignored, and not passed to a Python function which can't accept them.
Method test_simpleReprs Verify that the various Box objects repr properly, for debugging.
Method test_innerProtocolInRepr Verify that AMP objects output their innerProtocol when set.
Method test_innerProtocolNotInRepr Verify that AMP objects do not output 'inner' when no innerProtocol is set.
Method test_simpleSSLRepr amp._TLSBox.__repr__ returns a string.
Method test_keyTooLong Verify that a key that is too long will immediately raise a synchronous exception.
Method test_valueTooLong Verify that attempting to send value longer than 64k will immediately raise an exception.
Method test_helloWorldCommand Verify that a simple command can be sent and its response received with the high-level value parsing API.
Method test_helloErrorHandling Verify that if a known error type is raised and handled, it will be properly relayed to the other end of the connection and translated into an exception, and no error will be logged.
Method test_helloFatalErrorHandling No summary
Method test_helloNoErrorHandling Verify that if an unknown error type is raised, it will be relayed to the other end of the connection and translated into an exception, it will be logged, and then the connection will be dropped.
Method test_lateAnswer Verify that a command that does not get answered until after the connection terminates will not cause any errors.
Method test_requiresNoAnswer Verify that a command that requires no answer is run.
Method test_requiresNoAnswerFail Verify that commands sent after a failed no-answer request do not complete.
Method test_requiresNoAnswerAfterFail No-answer commands sent after the connection has been torn down do not return a Deferred.
Method test_noAnswerResponderBadAnswer Verify that responders of requiresAnswer=False commands have to return a dictionary anyway.
Method test_noAnswerResponderAskedForAnswer Verify that responders with requiresAnswer=False will actually respond if the client sets requiresAnswer=True. In other words, verify that requiresAnswer is a hint honored only by the client.
Method test_ampListCommand Test encoding of an argument that uses the AmpList encoding.
Method test_optionalAmpListOmitted Sending a command with an omitted AmpList argument that is designated as optional does not raise an InvalidSignature error.
Method test_optionalAmpListPresent Sanity check that optional AmpList arguments are processed normally.
Method test_failEarlyOnArgSending Verify that if we pass an invalid argument list (omitting an argument), an exception will be raised.
Method test_doubleProtocolSwitch As a debugging aid, a protocol system should raise a ProtocolSwitched exception when asked to switch a protocol that is already switched.
Method test_protocolSwitch Verify that it is possible to switch to another protocol mid-connection and send data to it successfully.
Method test_protocolSwitchDeferred Verify that protocol-switching even works if the value returned from the command that does the switch is deferred.
Method test_protocolSwitchFail Verify that if we try to switch protocols and it fails, the connection stays up and we can go back to speaking AMP.
Method test_trafficAfterSwitch Verify that attempts to send traffic after a switch will not corrupt the nested protocol.
Method test_errorAfterSwitch Returning an error after a protocol switch should record the underlying error.
Method test_quitBoxQuits Verify that commands with a responseType of QuitBox will in fact terminate the connection.
Method test_basicLiteralEmit Verify that the command dictionaries for a callRemoteN look correct after being serialized and parsed.
Method test_basicStructuredEmit Verify that a call similar to basicLiteralEmit's is handled properly with high-level quoting and passing to Python methods, and that argument names are correctly handled.

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

The classes in the amp module ought to implement the interfaces that are declared for their benefit.

def test_helloWorld(self):

Verify that a simple command can be sent and its response received with the simple low-level string-based API.

def test_wireFormatRoundTrip(self):

Verify that mixed-case, underscored and dashed arguments are mapped to their python names properly.

def test_helloWorldUnicode(self):

Verify that unicode arguments can be encoded and decoded.

def test_callRemoteStringRequiresAnswerFalse(self):

BoxDispatcher.callRemoteString returns None if requiresAnswer is False.

def test_unknownCommandLow(self):

Verify that unknown commands using low-level APIs will be rejected with an error, but will NOT terminate the connection.

def test_unknownCommandHigh(self):

Verify that unknown commands using high-level APIs will be rejected with an error, but will NOT terminate the connection.

def test_brokenReturnValue(self):

It can be very confusing if you write some code which responds to a command, but gets the return value wrong. Most commonly you end up returning None instead of a dictionary.

Verify that if that happens, the framework logs a useful error.

def test_unknownArgument(self):

Verify that unknown arguments are ignored, and not passed to a Python function which can't accept them.

def test_simpleReprs(self):

Verify that the various Box objects repr properly, for debugging.

def test_innerProtocolInRepr(self):

Verify that AMP objects output their innerProtocol when set.

def test_innerProtocolNotInRepr(self):

Verify that AMP objects do not output 'inner' when no innerProtocol is set.

def test_simpleSSLRepr(self):

amp._TLSBox.__repr__ returns a string.

def test_keyTooLong(self):

Verify that a key that is too long will immediately raise a synchronous exception.

def test_valueTooLong(self):

Verify that attempting to send value longer than 64k will immediately raise an exception.

def test_helloWorldCommand(self):

Verify that a simple command can be sent and its response received with the high-level value parsing API.

def test_helloErrorHandling(self):

Verify that if a known error type is raised and handled, it will be properly relayed to the other end of the connection and translated into an exception, and no error will be logged.

def test_helloFatalErrorHandling(self):

Verify that if a known, fatal error type is raised and handled, it will be properly relayed to the other end of the connection and translated into an exception, no error will be logged, and the connection will be terminated.

def test_helloNoErrorHandling(self):

Verify that if an unknown error type is raised, it will be relayed to the other end of the connection and translated into an exception, it will be logged, and then the connection will be dropped.

def test_lateAnswer(self):

Verify that a command that does not get answered until after the connection terminates will not cause any errors.

def test_requiresNoAnswer(self):

Verify that a command that requires no answer is run.

def test_requiresNoAnswerFail(self):

Verify that commands sent after a failed no-answer request do not complete.

def test_requiresNoAnswerAfterFail(self):

No-answer commands sent after the connection has been torn down do not return a Deferred.

def test_noAnswerResponderBadAnswer(self):

Verify that responders of requiresAnswer=False commands have to return a dictionary anyway.

(requiresAnswer is a hint from the _client_ - the server may be called upon to answer commands in any case, if the client wants to know when they complete.)

def test_noAnswerResponderAskedForAnswer(self):

Verify that responders with requiresAnswer=False will actually respond if the client sets requiresAnswer=True. In other words, verify that requiresAnswer is a hint honored only by the client.

def test_ampListCommand(self):

Test encoding of an argument that uses the AmpList encoding.

def test_optionalAmpListOmitted(self):

Sending a command with an omitted AmpList argument that is designated as optional does not raise an InvalidSignature error.

def test_optionalAmpListPresent(self):

Sanity check that optional AmpList arguments are processed normally.

def test_failEarlyOnArgSending(self):

Verify that if we pass an invalid argument list (omitting an argument), an exception will be raised.

def test_doubleProtocolSwitch(self):

As a debugging aid, a protocol system should raise a ProtocolSwitched exception when asked to switch a protocol that is already switched.

def test_protocolSwitch(self, switcher=SimpleSymmetricCommandProtocol, spuriousTraffic=False, spuriousError=False):

Verify that it is possible to switch to another protocol mid-connection and send data to it successfully.

def test_protocolSwitchDeferred(self):

Verify that protocol-switching even works if the value returned from the command that does the switch is deferred.

def test_protocolSwitchFail(self, switcher=SimpleSymmetricCommandProtocol):

Verify that if we try to switch protocols and it fails, the connection stays up and we can go back to speaking AMP.

def test_trafficAfterSwitch(self):

Verify that attempts to send traffic after a switch will not corrupt the nested protocol.

def test_errorAfterSwitch(self):

Returning an error after a protocol switch should record the underlying error.

def test_quitBoxQuits(self):

Verify that commands with a responseType of QuitBox will in fact terminate the connection.

def test_basicLiteralEmit(self):

Verify that the command dictionaries for a callRemoteN look correct after being serialized and parsed.

def test_basicStructuredEmit(self):

Verify that a call similar to basicLiteralEmit's is handled properly with high-level quoting and passing to Python methods, and that argument names are correctly handled.

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