twisted.conch.test.test_telnet.TelnetTests(unittest.TestCase) class documentation

Part of twisted.conch.test.test_telnet (View In Hierarchy)

Tests for telnet.Telnet.

telnet.Telnet implements the TELNET protocol (RFC 854), including option and suboption negotiation, and option state tracking.

Method setUp Create an unconnected telnet.Telnet to be used by tests.
Method test_enableLocal telnet.Telnet.enableLocal should reject all options, since telnet.Telnet does not know how to implement any options.
Method test_enableRemote telnet.Telnet.enableRemote should reject all options, since telnet.Telnet does not know how to implement any options.
Method test_disableLocal No summary
Method test_disableRemote No summary
Method test_requestNegotiation telnet.Telnet.requestNegotiation formats the feature byte and the payload bytes into the subnegotiation format and sends them.
Method test_requestNegotiationEscapesIAC If the payload for a subnegotiation includes IAC, it is escaped by telnet.Telnet.requestNegotiation with another IAC.
Method test_oneApplicationDataByte One application-data byte in the default state gets delivered right away.
Method test_twoApplicationDataBytes Two application-data bytes in the default state get delivered together.
Method test_threeApplicationDataBytes Three application-data bytes followed by a control byte get delivered, but the control byte doesn't.
Method test_escapedControl IAC in the escaped state gets delivered and so does another application-data byte following it.
Method test_carriageReturn No summary
Method test_applicationDataBeforeSimpleCommand Application bytes received before a command are delivered before the command is processed.
Method test_applicationDataBeforeCommand Application bytes received before a WILL/WONT/DO/DONT are delivered before the command is processed.
Method test_applicationDataBeforeSubnegotiation Application bytes received before a subnegotiation command are delivered before the negotiation is processed.
Method _deliver Pass the given bytes to the protocol's dataReceived method and assert that the given events occur.

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 an unconnected telnet.Telnet to be used by tests.

def test_enableLocal(self):

telnet.Telnet.enableLocal should reject all options, since telnet.Telnet does not know how to implement any options.

def test_enableRemote(self):

telnet.Telnet.enableRemote should reject all options, since telnet.Telnet does not know how to implement any options.

def test_disableLocal(self):

It is an error for telnet.Telnet.disableLocal to be called, since telnet.Telnet.enableLocal will never allow any options to be enabled locally. If a subclass overrides enableLocal, it must also override disableLocal.

def test_disableRemote(self):

It is an error for telnet.Telnet.disableRemote to be called, since telnet.Telnet.enableRemote will never allow any options to be enabled remotely. If a subclass overrides enableRemote, it must also override disableRemote.

def test_requestNegotiation(self):

telnet.Telnet.requestNegotiation formats the feature byte and the payload bytes into the subnegotiation format and sends them.

See RFC 855.

def test_requestNegotiationEscapesIAC(self):

If the payload for a subnegotiation includes IAC, it is escaped by telnet.Telnet.requestNegotiation with another IAC.

See RFC 855.

def _deliver(self, data, *expected):

Pass the given bytes to the protocol's dataReceived method and assert that the given events occur.

def test_oneApplicationDataByte(self):

One application-data byte in the default state gets delivered right away.

def test_twoApplicationDataBytes(self):

Two application-data bytes in the default state get delivered together.

def test_threeApplicationDataBytes(self):

Three application-data bytes followed by a control byte get delivered, but the control byte doesn't.

def test_escapedControl(self):

IAC in the escaped state gets delivered and so does another application-data byte following it.

def test_carriageReturn(self):

A carriage return only puts the protocol into the newline state. A linefeed in the newline state causes just the newline to be delivered. A nul in the newline state causes a carriage return to be delivered. An IAC in the newline state causes a carriage return to be delivered and puts the protocol into the escaped state. Anything else causes a carriage return and that thing to be delivered.

def test_applicationDataBeforeSimpleCommand(self):

Application bytes received before a command are delivered before the command is processed.

def test_applicationDataBeforeCommand(self):

Application bytes received before a WILL/WONT/DO/DONT are delivered before the command is processed.

def test_applicationDataBeforeSubnegotiation(self):

Application bytes received before a subnegotiation command are delivered before the negotiation is processed.

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