twisted.conch.test.test_session.SessionInterfaceTests

class documentation

class SessionInterfaceTests(RegistryUsingMixin, TestCase): (source)

View In Hierarchy

Tests for the SSHSession class interface. This interface is not ideal, but it is tested in order to maintain backwards compatibility.

Method assertRequestRaisedRuntimeError Assert that the request we just made raised a RuntimeError (and only a RuntimeError).
Method assertSessionIsStubSession Asserts that self.session.session is an instance of StubSessionForStubOldAvatar.
Method getSSHSession Return a new SSH session.
Method setUp Make an SSHSession object to test. Give the channel some window so that it's allowed to send packets. 500 and 100 are arbitrary values.
Method test_badSubsystemDoesNotCreateClient When a subsystem request fails, SSHSession.client should not be set.
Method test_client_closed SSHSession.closed() should tell the transport connected to the client that the connection was lost.
Method test_client_closed_with_env_subsystem If the peer requests an environment variable in its setup process followed by requesting a subsystem, SSHSession.closed() should tell the transport connected to the client that the connection was lost.
Method test_client_dataReceived SSHSession.dataReceived() passes data along to a client. If the data comes before there is a client, the data should be discarded.
Method test_client_extReceived SSHSession.extReceived() passed data of type EXTENDED_DATA_STDERR along to the client. If the data comes before there is a client, or if the data is not of type EXTENDED_DATA_STDERR, it is discared.
Method test_client_extReceivedWithoutWriteErr SSHSession.extReceived() should handle the case where the transport on the client doesn't have a writeErr method.
Method test_closed When a close is received and an ISession adapter is present, it should be notified of the close message.
Method test_closeReceived When a close is received, the session should send a close message.
Method test_eofReceived When an EOF is received and an ISession adapter is present, it should be notified of the EOF message.
Method test_init SSHSession initializes its buffer (buf), client, and ISession adapter. The avatar should not need to be adaptable to an ISession immediately.
Method test_lookupSubsystem When a client requests a subsystem, the SSHSession object should get the subsystem by calling avatar.lookupSubsystem, and attach it as the client.
Method test_lookupSubsystem_closeReceived SSHSession.closeReceived() should sent a close message to the remote side.
Method test_lookupSubsystem_data After having looked up a subsystem, data should be passed along to the client. Additionally, subsystems were passed the entire request packet as data, instead of just the additional data.
Method test_lookupSubsystemDoesNotNeedISession Previously, if one only wanted to implement a subsystem, an ISession adapter wasn't needed because subsystems were looked up using the lookupSubsystem method on the avatar.
Method test_requestExec When a client requests a command, the SSHSession object should get the command by getting an ISession adapter for the avatar, then calling execCommand with a ProcessProtocol to attach and the command line.
Method test_requestExecWithData When a client executes a command, it should be able to give pass data back and forth.
Method test_requestPty When a client requests a PTY, the SSHSession object should make the request by getting an ISession adapter for the avatar, then calling getPty with the terminal type, the window size, and any modes the client gave us.
Method test_requestShell When a client requests a shell, the SSHSession object should get the shell by getting an ISession adapter for the avatar, then calling openShell() with a ProcessProtocol to attach.
Method test_requestShellWithData When a client executes a shell, it should be able to give pass data back and forth between the local and the remote side.
Method test_requestWindowChange When the client requests to change the window size, the SSHSession object should make the request by getting an ISession adapter for the avatar, then calling windowChanged with the new window size.
Method test_setEnv When a client requests passing an environment variable, the SSHSession object should make the request by getting an ISessionSetEnv adapter for the avatar, then calling setEnv with the environment variable name and value.
Method test_setEnvMultiplexShare Calling another session service after setenv will provide the previous session with the environment variables.
Method test_setEnvNotProvidingISessionSetEnv If the avatar does not have an ISessionSetEnv adapter, then a request to pass an environment variable fails gracefully.
Method test_setEnvSessionShare Multiple setenv requests will share the same session.
Class Variable skip Undocumented
Instance Variable session Undocumented

Inherited from TestCase (via RegistryUsingMixin):

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 RegistryUsingMixin, 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 RegistryUsingMixin, 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 assertRequestRaisedRuntimeError(self): (source)

Assert that the request we just made raised a RuntimeError (and only a RuntimeError).

def assertSessionIsStubSession(self): (source)

Asserts that self.session.session is an instance of StubSessionForStubOldAvatar.

def getSSHSession(self, register_adapters=True): (source)

Return a new SSH session.

def setUp(self, register_adapters=True): (source)
overrides twisted.python.test.test_components.RegistryUsingMixin.setUp

Make an SSHSession object to test. Give the channel some window so that it's allowed to send packets. 500 and 100 are arbitrary values.

def test_badSubsystemDoesNotCreateClient(self): (source)

When a subsystem request fails, SSHSession.client should not be set.

def test_client_closed(self): (source)

SSHSession.closed() should tell the transport connected to the client that the connection was lost.

def test_client_closed_with_env_subsystem(self): (source)

If the peer requests an environment variable in its setup process followed by requesting a subsystem, SSHSession.closed() should tell the transport connected to the client that the connection was lost.

def test_client_dataReceived(self): (source)

SSHSession.dataReceived() passes data along to a client. If the data comes before there is a client, the data should be discarded.

def test_client_extReceived(self): (source)

SSHSession.extReceived() passed data of type EXTENDED_DATA_STDERR along to the client. If the data comes before there is a client, or if the data is not of type EXTENDED_DATA_STDERR, it is discared.

def test_client_extReceivedWithoutWriteErr(self): (source)

SSHSession.extReceived() should handle the case where the transport on the client doesn't have a writeErr method.

def test_closed(self): (source)

When a close is received and an ISession adapter is present, it should be notified of the close message.

def test_closeReceived(self): (source)

When a close is received, the session should send a close message.

def test_eofReceived(self): (source)

When an EOF is received and an ISession adapter is present, it should be notified of the EOF message.

def test_init(self): (source)

SSHSession initializes its buffer (buf), client, and ISession adapter. The avatar should not need to be adaptable to an ISession immediately.

def test_lookupSubsystem(self): (source)

When a client requests a subsystem, the SSHSession object should get the subsystem by calling avatar.lookupSubsystem, and attach it as the client.

def test_lookupSubsystem_closeReceived(self): (source)

SSHSession.closeReceived() should sent a close message to the remote side.

def test_lookupSubsystem_data(self): (source)

After having looked up a subsystem, data should be passed along to the client. Additionally, subsystems were passed the entire request packet as data, instead of just the additional data.

We check for the additional tidle to verify that the data passed through the client.

def test_lookupSubsystemDoesNotNeedISession(self): (source)

Previously, if one only wanted to implement a subsystem, an ISession adapter wasn't needed because subsystems were looked up using the lookupSubsystem method on the avatar.

def test_requestExec(self): (source)

When a client requests a command, the SSHSession object should get the command by getting an ISession adapter for the avatar, then calling execCommand with a ProcessProtocol to attach and the command line.

def test_requestExecWithData(self): (source)

When a client executes a command, it should be able to give pass data back and forth.

def test_requestPty(self): (source)

When a client requests a PTY, the SSHSession object should make the request by getting an ISession adapter for the avatar, then calling getPty with the terminal type, the window size, and any modes the client gave us.

def test_requestShell(self): (source)

When a client requests a shell, the SSHSession object should get the shell by getting an ISession adapter for the avatar, then calling openShell() with a ProcessProtocol to attach.

def test_requestShellWithData(self): (source)

When a client executes a shell, it should be able to give pass data back and forth between the local and the remote side.

def test_requestWindowChange(self): (source)

When the client requests to change the window size, the SSHSession object should make the request by getting an ISession adapter for the avatar, then calling windowChanged with the new window size.

def test_setEnv(self): (source)

When a client requests passing an environment variable, the SSHSession object should make the request by getting an ISessionSetEnv adapter for the avatar, then calling setEnv with the environment variable name and value.

def test_setEnvMultiplexShare(self): (source)

Calling another session service after setenv will provide the previous session with the environment variables.

def test_setEnvNotProvidingISessionSetEnv(self): (source)

If the avatar does not have an ISessionSetEnv adapter, then a request to pass an environment variable fails gracefully.

def test_setEnvSessionShare(self): (source)

Multiple setenv requests will share the same session.

skip: str = (source)
overrides twisted.trial.unittest.SynchronousTestCase.skip

Undocumented

session = (source)

Undocumented