twisted.conch.test.test_endpoints.NewConnectionTests

Tests for SSHCommandClientEndpoint when using the newConnection constructor.

Method	setUp	Configure an SSH server with password authentication enabled for a well-known (to the tests) account.
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	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	test_interface	`SSHCommandClientEndpoint` instances provide `IStreamClientEndpoint`.
Method	test_defaultPort	`SSHCommandClientEndpoint` uses the default port number for SSH when the `port` argument is not specified.
Method	test_specifiedPort	`SSHCommandClientEndpoint` uses the `port` argument if 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_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_userRejectedHostKey	No summary
Method	test_mismatchedHostKey	No summary
Method	test_connectionClosedBeforeSecure	No summary
Method	test_connectionCancelledBeforeSecure	No summary
Method	test_connectionCancelledBeforeConnected	If the connection is cancelled before it finishes connecting, the connection attempt is stopped.
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	setupKeyChecker	Create an `ISSHPrivateKey` checker which recognizes `users` and add it to `portal`.
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_authenticationFallback	If the SSH server does not accept any of the specified SSH keys, the specified password is tried.
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_skipPasswordAuthentication	If the password is not specified, `SSHCommandClientEndpoint` doesn't try it as an authentication mechanism.
Method	test_agentAuthentication	No summary
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.

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

Inherited from SSHCommandClientEndpointTestsMixin:

Method	connectedServerAndClient	Set up an in-memory connection between protocols created by `serverFactory` and `clientFactory`.
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_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_execCancelled	If execution of the command is cancelled via the `Deferred` returned by `SSHCommandClientEndpoint.connect`, the connection is closed immediately.
Method	test_buildProtocol	No summary
Method	test_makeConnection	No summary
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_connectionLost	When the command closes the channel, the protocol's `connectionLost` method is called.
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.
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_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	record	Hook into and record events which happen to `protocol`.
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	_exitStatusTest	Test handling of non-zero exit statuses or exit signals.

def setUp(self):

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 create(self):

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

Create and return a new SSHCommandClientEndpoint using the newConnection constructor.

def finishConnection(self):

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

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	The SSH server protocol over which `protocol` is running. (type: `IProtocol` provider)
	client	The SSH client protocol over which `protocol` is running. (type: `IProtocol` provider)
	protocol	The protocol created by calling connect on the ssh endpoint under test. (type: `IProtocol` provider)
	pump	The `IOPump` connecting client to server. (type: `IOPump`)

def assertClientTransportState(self, client, immediateClose):

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 test_interface(self):

SSHCommandClientEndpoint instances provide IStreamClientEndpoint.

def test_defaultPort(self):

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

def test_specifiedPort(self):

SSHCommandClientEndpoint uses the port argument if specified.

def test_destination(self):

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

def test_connectionFailed(self):

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_userRejectedHostKey(self):

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.

def test_mismatchedHostKey(self):

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_connectionClosedBeforeSecure(self):

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_connectionCancelledBeforeSecure(self):

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_connectionCancelledBeforeConnected(self):

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

def test_passwordAuthenticationFailure(self):

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

def setupKeyChecker(self, portal, users):

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

Parameters	portal	A `Portal` to which to add the checker. (type: `Portal`)
	users	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. (type: `dict`)

def test_publicKeyAuthenticationFailure(self):

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_authenticationFallback(self):

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

def test_publicKeyAuthentication(self):

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

def test_skipPasswordAuthentication(self):

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

def test_agentAuthentication(self):

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_loseConnection(self):

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.

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

twisted.conch.test.test_endpoints.NewConnectionTests(TestCase, SSHCommandClientEndpointTestsMixin) class documentation

`twisted.conch.test.test_endpoints.NewConnectionTests(TestCase, SSHCommandClientEndpointTestsMixin)` class documentation