class documentation

class ConnectionTests(unittest.TestCase): (source)

View In Hierarchy

Undocumented

Method setUp Undocumented
Method tearDown Undocumented
Method test_adjustWindow Test that channel window adjust messages cause bytes to be added to the window.
Method test_CHANNEL_CLOSE Test that channel close messages are passed up to the channel. Also, test that channel.close() is called if both sides are closed when this message is received.
Method test_CHANNEL_DATA Test that channel data messages are passed up to the channel, or cause the channel to be closed if the data is too large.
Method test_CHANNEL_EOF Test that channel eof messages are passed up to the channel.
Method test_CHANNEL_EXTENDED_DATA Test that channel extended data messages are passed up to the channel, or cause the channel to be closed if they're too big.
Method test_CHANNEL_OPEN Test that open channel packets cause a channel to be created and opened or a failure message to be returned.
Method test_CHANNEL_OPEN_CONFIRMATION Test that channel open confirmation packets cause the channel to be notified that it's open.
Method test_CHANNEL_OPEN_FAILURE Test that channel open failure packets cause the channel to be notified that its opening failed.
Method test_CHANNEL_REQUEST_failure Test that channel requests that fail send MSG_CHANNEL_FAILURE.
Method test_CHANNEL_REQUEST_FAILURE Test that channel request failure messages cause the Deferred to be erred back.
Method test_CHANNEL_REQUEST_success Test that channel requests that succeed send MSG_CHANNEL_SUCCESS.
Method test_CHANNEL_REQUEST_SUCCESS Test that channel request success messages cause the Deferred to be called back.
Method test_CHANNEL_WINDOW_ADJUST Test that channel window adjust messages add bytes to the channel window.
Method test_channelClosedCausesLeftoverChannelDeferredsToErrback Whenever an SSH channel gets closed any Deferred that was returned by a sendRequest() on its parent connection must be errbacked.
Method test_getChannelWithAvatar Test that getChannel dispatches to the avatar when an avatar is present. Correct functioning without the avatar is verified in test_CHANNEL_OPEN.
Method test_GLOBAL_REQUEST Test that global request packets are dispatched to the global_* methods and the return values are translated into success or failure messages.
Method test_gotGlobalRequestWithoutAvatar Test that gotGlobalRequests dispatches to global_* without an avatar.
Method test_linkAvatar Test that the connection links itself to the avatar in the transport.
Method test_lookupChannelError If a lookupChannel implementation raises error.ConchError with the arguments in the wrong order, a MSG_CHANNEL_OPEN failure is still sent in response to the message.
Method test_openChannel Test that open channel messages are sent in the right format.
Method test_REQUEST_FAILURE Test that global request failure packets cause the Deferred to be erred back.
Method test_REQUEST_SUCCESS Test that global request success packets cause the Deferred to be called back.
Method test_sendClose Test that channel close messages are sent in the right format.
Method test_sendData Test that channel data messages are sent in the right format.
Method test_sendEOF Test that channel EOF messages are sent in the right format.
Method test_sendExtendedData Test that channel extended data messages are sent in the right format.
Method test_sendGlobalRequest Test that global request messages are sent in the right format.
Method test_sendRequest Test that channel request messages are sent in the right format.
Method test_serviceStopped Test that serviceStopped() closes any open channels.
Class Variable skip Undocumented
Instance Variable conn Undocumented
Instance Variable transport Undocumented
Method _lookupChannelErrorTest Deliver a request for a channel open which will result in an exception being raised during channel lookup. Assert that an error response is delivered as a result.
Method _openChannel Open the channel with the default connection.

Inherited from TestCase:

Method __call__ Run the test. Should always do exactly the same thing as run().
Method __init__ Construct an asynchronous test case for methodName.
Method addCleanup Extend the base cleanup feature with support for cleanup functions which return Deferreds.
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 deferRunCleanups Run any scheduled cleanups and report errors (if any) to the result. object.
Method deferSetUp Undocumented
Method deferTearDown Undocumented
Method deferTestMethod Undocumented
Method getSuppress Undocumented
Method getTimeout Returns the timeout value set on this test. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a timeout attribute, returns that. Returns util.DEFAULT_TIMEOUT_DURATION...
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 _cbDeferTestMethod Undocumented
Method _classCleanUp Undocumented
Method _cleanUp Undocumented
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 _ebDeferSetUp Undocumented
Method _ebDeferTearDown Undocumented
Method _ebDeferTestMethod Undocumented
Method _makeReactorMethod Create a method which wraps the reactor method name. The new method issues a deprecation warning and calls the original.
Method _run Run a single method, either a test method or fixture.
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 _undeprecateReactor Restore the deprecated reactor methods. Undoes what _deprecateReactor did.
Method _wait Take a Deferred that only ever callbacks. Block until it happens.
Instance Variable _passed Undocumented
Instance Variable _reactorMethods Undocumented
Instance Variable _timedOut Undocumented

Inherited from SynchronousTestCase (via TestCase):

Method __eq__ Override the comparison defined by the base TestCase which considers instances of the same class with the same _testMethodName to be equal. Since trial puts TestCase instances into a set, that definition of comparison makes it impossible to run the same test method twice...
Method __hash__ Undocumented
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 flushLoggedErrors Remove stored errors received from the log.
Method flushWarnings Remove stored warnings from the list of captured warnings and return them.
Method getDeprecatedModuleAttribute Retrieve a module attribute which should have been deprecated, and assert that we saw the appropriate deprecation warning.
Method getSkip Return the skip reason set on this test, if any is set. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a skip attribute, returns that in a tuple (...
Method getTodo Return a Todo object if the test is marked todo. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a todo attribute, returns that. Returns ...
Method mktemp Create a new path name which can be used for a new file or directory.
Method patch Monkey patch an object for the duration of the test.
Method run Run the test case, storing the results in result.
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 shortDescription Undocumented
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 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.
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.
Method _getSkipReason Return the reason to use for skipping a test method.
Method _getSuppress Returns any warning suppressions set for this test. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a suppress attribute, returns that. ...
Method _installObserver Undocumented
Method _removeObserver Undocumented
Method _runCleanups Synchronously run any cleanups which have been added.
Instance Variable _cleanups Undocumented
Instance Variable _observer Undocumented
Instance Variable _parents Undocumented
Instance Variable _testMethodName Undocumented
Instance Variable _warnings Undocumented

Inherited from _Assertions (via TestCase, SynchronousTestCase):

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 assertEqual Fail the test if first and second are not equal.
Method assertFalse Fail the test if condition evaluates to True.
Method assertIn Fail the test if containee is not found in container.
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 assertIsInstance Fail if instance is not an instance of the given class or of one of the given classes.
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 assertNoResult Assert that deferred does not have a result at this point.
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 assertNotEqual Fail the test if first == second.
Method assertNotIn Fail the test if containee is found in container.
Method assertNotIsInstance Fail if instance is an instance of the given class or of one of the given classes.
Method assertNotSubstring Fail if astring contains substring.
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 assertSubstring Fail if substring does not exist within astring.
Method assertTrue Fail the test if condition evaluates to False.
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 fail Absolutely fail the test. Do not pass go, do not collect $200.
Method failureResultOf Return the current failure result of deferred or raise self.failureException.
Method successResultOf Return the current success result of deferred or raise self.failureException.
def setUp(self): (source)

Undocumented

def tearDown(self): (source)

Undocumented

def test_adjustWindow(self): (source)

Test that channel window adjust messages cause bytes to be added to the window.

def test_CHANNEL_CLOSE(self): (source)

Test that channel close messages are passed up to the channel. Also, test that channel.close() is called if both sides are closed when this message is received.

def test_CHANNEL_DATA(self): (source)

Test that channel data messages are passed up to the channel, or cause the channel to be closed if the data is too large.

def test_CHANNEL_EOF(self): (source)

Test that channel eof messages are passed up to the channel.

def test_CHANNEL_EXTENDED_DATA(self): (source)

Test that channel extended data messages are passed up to the channel, or cause the channel to be closed if they're too big.

def test_CHANNEL_OPEN(self): (source)

Test that open channel packets cause a channel to be created and opened or a failure message to be returned.

def test_CHANNEL_OPEN_CONFIRMATION(self): (source)

Test that channel open confirmation packets cause the channel to be notified that it's open.

def test_CHANNEL_OPEN_FAILURE(self): (source)

Test that channel open failure packets cause the channel to be notified that its opening failed.

def test_CHANNEL_REQUEST_failure(self): (source)

Test that channel requests that fail send MSG_CHANNEL_FAILURE.

def test_CHANNEL_REQUEST_FAILURE(self): (source)

Test that channel request failure messages cause the Deferred to be erred back.

def test_CHANNEL_REQUEST_success(self): (source)

Test that channel requests that succeed send MSG_CHANNEL_SUCCESS.

def test_CHANNEL_REQUEST_SUCCESS(self): (source)

Test that channel request success messages cause the Deferred to be called back.

def test_CHANNEL_WINDOW_ADJUST(self): (source)

Test that channel window adjust messages add bytes to the channel window.

def test_channelClosedCausesLeftoverChannelDeferredsToErrback(self): (source)

Whenever an SSH channel gets closed any Deferred that was returned by a sendRequest() on its parent connection must be errbacked.

def test_getChannelWithAvatar(self): (source)

Test that getChannel dispatches to the avatar when an avatar is present. Correct functioning without the avatar is verified in test_CHANNEL_OPEN.

def test_GLOBAL_REQUEST(self): (source)

Test that global request packets are dispatched to the global_* methods and the return values are translated into success or failure messages.

def test_gotGlobalRequestWithoutAvatar(self): (source)

Test that gotGlobalRequests dispatches to global_* without an avatar.

def test_linkAvatar(self): (source)

Test that the connection links itself to the avatar in the transport.

def test_lookupChannelError(self): (source)

If a lookupChannel implementation raises error.ConchError with the arguments in the wrong order, a MSG_CHANNEL_OPEN failure is still sent in response to the message.

This is a temporary work-around until error.ConchError is given better attributes and all of the Conch code starts constructing instances of it properly. Eventually this functionality should be deprecated and then removed.

def test_openChannel(self): (source)

Test that open channel messages are sent in the right format.

def test_REQUEST_FAILURE(self): (source)

Test that global request failure packets cause the Deferred to be erred back.

def test_REQUEST_SUCCESS(self): (source)

Test that global request success packets cause the Deferred to be called back.

def test_sendClose(self): (source)

Test that channel close messages are sent in the right format.

def test_sendData(self): (source)

Test that channel data messages are sent in the right format.

def test_sendEOF(self): (source)

Test that channel EOF messages are sent in the right format.

def test_sendExtendedData(self): (source)

Test that channel extended data messages are sent in the right format.

def test_sendGlobalRequest(self): (source)

Test that global request messages are sent in the right format.

def test_sendRequest(self): (source)

Test that channel request messages are sent in the right format.

def test_serviceStopped(self): (source)

Test that serviceStopped() closes any open channels.

Undocumented

transport = (source)

Undocumented

def _lookupChannelErrorTest(self, code): (source)

Deliver a request for a channel open which will result in an exception being raised during channel lookup. Assert that an error response is delivered as a result.

def _openChannel(self, channel): (source)

Open the channel with the default connection.