twisted.conch.test.test_channel.ChannelTests(unittest.TestCase) class documentation

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

Tests for SSHChannel.

Method setUp Initialize the channel. remoteMaxPacket is 10 so that data is able to be sent (the default of 0 means no data is sent because no packets are made).
Method test_interface SSHChannel instances provide interfaces.ITransport.
Method test_init Test that SSHChannel initializes correctly. localWindowSize defaults to 131072 (2**17) and localMaxPacket to 32768 (2**15) as reasonable defaults (what OpenSSH uses for those variables).
Method test_str Test that str(SSHChannel) works gives the channel name and local and remote windows at a glance..
Method test_bytes Test that bytes(SSHChannel) works, gives the channel name and local and remote windows at a glance..
Method test_logPrefix Test that SSHChannel.logPrefix gives the name of the channel, the local channel ID and the underlying connection.
Method test_addWindowBytes Test that addWindowBytes adds bytes to the window and resumes writing if it was paused.
Method test_requestReceived Test that requestReceived handles requests by dispatching them to request_* methods.
Method test_closeReceieved Test that the default closeReceieved closes the connection.
Method test_write Test that write handles data correctly. Send data up to the size of the remote window, splitting the data into packets of length remoteMaxPacket.
Method test_writeExtended Test that writeExtended handles data correctly. Send extended data up to the size of the window, splitting the extended data into packets of length remoteMaxPacket.
Method test_writeSequence Test that writeSequence is equivalent to write(''.join(sequece)).
Method test_loseConnection Tesyt that loseConnection() doesn't close the channel until all the data is sent.
Method test_getPeer SSHChannel.getPeer returns the same object as the underlying transport's getPeer method returns.
Method test_getHost SSHChannel.getHost returns the same object as the underlying transport's getHost method returns.

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):

Initialize the channel. remoteMaxPacket is 10 so that data is able to be sent (the default of 0 means no data is sent because no packets are made).

def test_interface(self):

SSHChannel instances provide interfaces.ITransport.

def test_init(self):

Test that SSHChannel initializes correctly. localWindowSize defaults to 131072 (2**17) and localMaxPacket to 32768 (2**15) as reasonable defaults (what OpenSSH uses for those variables).

The values in the second set of assertions are meaningless; they serve only to verify that the instance variables are assigned in the correct order.

def test_str(self):

Test that str(SSHChannel) works gives the channel name and local and remote windows at a glance..

def test_bytes(self):

Test that bytes(SSHChannel) works, gives the channel name and local and remote windows at a glance..

def test_logPrefix(self):

Test that SSHChannel.logPrefix gives the name of the channel, the local channel ID and the underlying connection.

def test_addWindowBytes(self):

Test that addWindowBytes adds bytes to the window and resumes writing if it was paused.

def test_requestReceived(self):

Test that requestReceived handles requests by dispatching them to request_* methods.

def test_closeReceieved(self):

Test that the default closeReceieved closes the connection.

def test_write(self):

Test that write handles data correctly. Send data up to the size of the remote window, splitting the data into packets of length remoteMaxPacket.

def test_writeExtended(self):

Test that writeExtended handles data correctly. Send extended data up to the size of the window, splitting the extended data into packets of length remoteMaxPacket.

def test_writeSequence(self):

Test that writeSequence is equivalent to write(''.join(sequece)).

def test_loseConnection(self):

Tesyt that loseConnection() doesn't close the channel until all the data is sent.

def test_getPeer(self):

SSHChannel.getPeer returns the same object as the underlying transport's getPeer method returns.

def test_getHost(self):

SSHChannel.getHost returns the same object as the underlying transport's getHost method returns.

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