twisted.conch.test.test_endpoints.NewConnectionTests

class documentation

class NewConnectionTests(TestCase, SSHCommandClientEndpointTestsMixin): (source)

Tests for SSHCommandClientEndpoint when using the newConnection constructor.

Method	`assertClientTransportState`	Assert that the transport for the given protocol has been disconnected. `SSHCommandClientEndpoint.newConnection` creates a new dedicated SSH connection and cleans it up after the command exits.
Method	`create`	Create and return a new `SSHCommandClientEndpoint` using the `newConnection` constructor.
Method	`finishConnection`	Establish the first attempted TCP connection using the SSH server which `self.factory` can create.
Method	`loseConnectionToServer`	Lose the connection to a server and pump the `IOPump` sufficiently for the client to handle the lost connection. Asserts that the client disconnects its transport.
Method	`setUp`	Configure an SSH server with password authentication enabled for a well-known (to the tests) account.
Method	`setupKeyChecker`	Create an `ISSHPrivateKey` checker which recognizes `users` and add it to `portal`.
Method	`test_agentAuthentication`	If `SSHCommandClientEndpoint` is initialized with an `SSHAgentClient`, the agent is used to authenticate with the SSH server. Once the connection with the SSH server has concluded, the connection to the agent is disconnected.
Method	`test_authenticationFallback`	If the SSH server does not accept any of the specified SSH keys, the specified password is tried.
Method	`test_connectionCancelledBeforeConnected`	If the connection is cancelled before it finishes connecting, the connection attempt is stopped.
Method	`test_connectionCancelledBeforeSecure`	If the connection is cancelled before the SSH transport layer has finished key exchange (ie, gotten to the point where we may attempt to authenticate), the `Deferred` returned by `SSHCommandClientEndpoint.connect`...
Method	`test_connectionClosedBeforeSecure`	If the connection closes at any point before the SSH transport layer has finished key exchange (ie, gotten to the point where we may attempt to authenticate), the `Deferred` returned by `SSHCommandClientEndpoint.connect`...
Method	`test_connectionFailed`	If a connection cannot be established, the `Deferred` returned by `SSHCommandClientEndpoint.connect` fires with a `Failure` representing the reason for the connection setup failure.
Method	`test_defaultPort`	`SSHCommandClientEndpoint` uses the default port number for SSH when the `port` argument is not specified.
Method	`test_destination`	`SSHCommandClientEndpoint` uses the `IReactorTCP` passed to it to attempt a connection to the host/port address also passed to it.
Method	`test_interface`	`SSHCommandClientEndpoint` instances provide `IStreamClientEndpoint`.
Method	`test_loseConnection`	The transport connected to the protocol has a `loseConnection` method which causes the channel in which the command is running to close and the overall connection to be closed.
Method	`test_mismatchedHostKey`	If the SSH public key presented by the SSH server does not match the previously remembered key, as reported by the `KnownHostsFile` instance use to construct the endpoint, for that server, the `Deferred` returned by ...
Method	`test_passwordAuthenticationFailure`	If the SSH server rejects the password presented during authentication, the `Deferred` returned by `SSHCommandClientEndpoint.connect` fires with a `Failure` wrapping `AuthenticationFailed`.
Method	`test_publicKeyAuthentication`	If `SSHCommandClientEndpoint` is initialized with any private keys, it will try to use them to authenticate with the SSH server.
Method	`test_publicKeyAuthenticationFailure`	If the SSH server rejects the key pair presented during authentication, the `Deferred` returned by `SSHCommandClientEndpoint.connect` fires with a `Failure` wrapping `AuthenticationFailed`.
Method	`test_skipPasswordAuthentication`	If the password is not specified, `SSHCommandClientEndpoint` doesn't try it as an authentication mechanism.
Method	`test_specifiedPort`	`SSHCommandClientEndpoint` uses the `port` argument if specified.
Method	`test_userRejectedHostKey`	If the `KnownHostsFile` instance used to construct `SSHCommandClientEndpoint` rejects the SSH public key presented by the server, the `Deferred` returned by `SSHCommandClientEndpoint.connect` fires with a `Failure`...
Instance Variable	`hostKeyPath`	Undocumented
Instance Variable	`knownHosts`	Undocumented

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.Deferred`s. 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	`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	`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`.

Inherited from SSHCommandClientEndpointTestsMixin (via TestCase, SynchronousTestCase, _Assertions):

Method	`connectedServerAndClient`	Set up an in-memory connection between protocols created by `serverFactory` and `clientFactory`.
Method	`record`	Hook into and record events which happen to `protocol`.
Method	`test_buildProtocol`	Once the necessary SSH actions have completed successfully, `SSHCommandClientEndpoint.connect` uses the factory passed to it to construct a protocol instance by calling its `buildProtocol` method with an address object representing the SSH connection and command executed.
Method	`test_channelOpenFailure`	If a channel cannot be opened on the authenticated SSH connection, the `Deferred` returned by `SSHCommandClientEndpoint.connect` fires with a `Failure` wrapping the reason given by the server.
Method	`test_connectionLost`	When the command closes the channel, the protocol's `connectionLost` method is called.
Method	`test_dataReceived`	After establishing the connection, when the command on the SSH server produces output, it is delivered to the protocol's `dataReceived` method.
Method	`test_execCancelled`	If execution of the command is cancelled via the `Deferred` returned by `SSHCommandClientEndpoint.connect`, the connection is closed immediately.
Method	`test_execFailure`	If execution of the command fails, the `Deferred` returned by `SSHCommandClientEndpoint.connect` fires with a `Failure` wrapping the reason given by the server.
Method	`test_makeConnection`	`SSHCommandClientEndpoint` establishes an SSH connection, creates a channel in it, runs a command in that channel, and uses the protocol's `makeConnection` to associate it with a protocol representing that command's stdin and stdout.
Method	`test_nonZeroExitSignal`	When the command exits with a non-zero signal, the protocol's `connectionLost` method is called with a `Failure` wrapping an exception which encapsulates that status.
Method	`test_nonZeroExitStatus`	When the command exits with a non-zero status, the protocol's `connectionLost` method is called with a `Failure` wrapping an exception which encapsulates that status.
Method	`test_write`	The transport connected to the protocol has a `write` method which sends bytes to the input of the command executing on the SSH server.
Method	`test_writeSequence`	The transport connected to the protocol has a `writeSequence` method which sends bytes to the input of the command executing on the SSH server.
Method	`test_zeroExitCode`	When the command exits with a non-zero status, the protocol's `connectionLost` method is called with a `Failure` wrapping an exception which encapsulates that status.
Instance Variable	`clientAddress`	Undocumented
Instance Variable	`factory`	Undocumented
Instance Variable	`hostname`	Undocumented
Instance Variable	`passwdDB`	Undocumented
Instance Variable	`password`	Undocumented
Instance Variable	`port`	Undocumented
Instance Variable	`portal`	Undocumented
Instance Variable	`reactor`	Undocumented
Instance Variable	`realm`	Undocumented
Instance Variable	`serverAddress`	Undocumented
Instance Variable	`user`	Undocumented
Method	`_exitStatusTest`	Test handling of non-zero exit statuses or exit signals.

def assertClientTransportState(self, client, immediateClose): (source) ¶

overrides twisted.conch.test.test_endpoints.SSHCommandClientEndpointTestsMixin.assertClientTransportState

Assert that the transport for the given protocol has been disconnected. SSHCommandClientEndpoint.newConnection creates a new dedicated SSH connection and cleans it up after the command exits.

def create(self): (source) ¶

overrides twisted.conch.test.test_endpoints.SSHCommandClientEndpointTestsMixin.create

Create and return a new SSHCommandClientEndpoint using the newConnection constructor.

def finishConnection(self): (source) ¶

overrides twisted.conch.test.test_endpoints.SSHCommandClientEndpointTestsMixin.finishConnection

Establish the first attempted TCP connection using the SSH server which self.factory can create.

def loseConnectionToServer(self, server, client, protocol, pump): (source) ¶

Lose the connection to a server and pump the IOPump sufficiently for the client to handle the lost connection. Asserts that the client disconnects its transport.

Parameters
server:`IProtocol` provider	The SSH server protocol over which `protocol` is running.
client:`IProtocol` provider	The SSH client protocol over which `protocol` is running.
protocol:`IProtocol` provider	The protocol created by calling connect on the ssh endpoint under test.
pump:`IOPump`	The `IOPump` connecting client to server.

def setUp(self): (source) ¶

overrides twisted.conch.test.test_endpoints.SSHCommandClientEndpointTestsMixin.setUp

Configure an SSH server with password authentication enabled for a well-known (to the tests) account.

def setupKeyChecker(self, portal, users): (source) ¶

Create an ISSHPrivateKey checker which recognizes users and add it to portal.

Parameters
portal:`Portal`	A `Portal` to which to add the checker.
users:`dict`	The users and their keys the checker will recognize. Keys are byte strings giving user names. Values are byte strings giving OpenSSH-formatted private keys.

def test_agentAuthentication(self): (source) ¶

If SSHCommandClientEndpoint is initialized with an SSHAgentClient, the agent is used to authenticate with the SSH server. Once the connection with the SSH server has concluded, the connection to the agent is disconnected.

def test_authenticationFallback(self): (source) ¶

If the SSH server does not accept any of the specified SSH keys, the specified password is tried.

def test_connectionCancelledBeforeConnected(self): (source) ¶

If the connection is cancelled before it finishes connecting, the connection attempt is stopped.

def test_connectionCancelledBeforeSecure(self): (source) ¶

If the connection is cancelled before the SSH transport layer has finished key exchange (ie, gotten to the point where we may attempt to authenticate), the Deferred returned by SSHCommandClientEndpoint.connect fires with a Failure wrapping CancelledError and the connection is aborted.

def test_connectionClosedBeforeSecure(self): (source) ¶

If the connection closes at any point before the SSH transport layer has finished key exchange (ie, gotten to the point where we may attempt to authenticate), the Deferred returned by SSHCommandClientEndpoint.connect fires with a Failure wrapping the reason for the lost connection.

def test_connectionFailed(self): (source) ¶

If a connection cannot be established, the Deferred returned by SSHCommandClientEndpoint.connect fires with a Failure representing the reason for the connection setup failure.

def test_defaultPort(self): (source) ¶

SSHCommandClientEndpoint uses the default port number for SSH when the port argument is not specified.

def test_destination(self): (source) ¶

SSHCommandClientEndpoint uses the IReactorTCP passed to it to attempt a connection to the host/port address also passed to it.

def test_interface(self): (source) ¶

SSHCommandClientEndpoint instances provide IStreamClientEndpoint.

def test_loseConnection(self): (source) ¶

The transport connected to the protocol has a loseConnection method which causes the channel in which the command is running to close and the overall connection to be closed.

def test_mismatchedHostKey(self): (source) ¶

If the SSH public key presented by the SSH server does not match the previously remembered key, as reported by the KnownHostsFile instance use to construct the endpoint, for that server, the Deferred returned by SSHCommandClientEndpoint.connect fires with a Failure wrapping HostKeyChanged.

def test_passwordAuthenticationFailure(self): (source) ¶

If the SSH server rejects the password presented during authentication, the Deferred returned by SSHCommandClientEndpoint.connect fires with a Failure wrapping AuthenticationFailed.

def test_publicKeyAuthentication(self): (source) ¶

If SSHCommandClientEndpoint is initialized with any private keys, it will try to use them to authenticate with the SSH server.

def test_publicKeyAuthenticationFailure(self): (source) ¶

If the SSH server rejects the key pair presented during authentication, the Deferred returned by SSHCommandClientEndpoint.connect fires with a Failure wrapping AuthenticationFailed.

def test_skipPasswordAuthentication(self): (source) ¶

If the password is not specified, SSHCommandClientEndpoint doesn't try it as an authentication mechanism.

def test_specifiedPort(self): (source) ¶

SSHCommandClientEndpoint uses the port argument if specified.

def test_userRejectedHostKey(self): (source) ¶

If the KnownHostsFile instance used to construct SSHCommandClientEndpoint rejects the SSH public key presented by the server, the Deferred returned by SSHCommandClientEndpoint.connect fires with a Failure wrapping UserRejectedKey.

hostKeyPath = (source) ¶

Undocumented

knownHosts = (source) ¶

Undocumented