twisted.conch.test.test_cftp.StdioClientTests

Tests for cftp.StdioClient.

Method	setUp	Create a `cftp.StdioClient` hooked up to dummy transport and a fake user database.
Method	test_exec	The exec command runs its arguments locally in a child process using the user's shell.
Method	test_execWithoutShell	If the local user has no shell, the exec command runs its arguments using /bin/sh.
Method	test_bang	The exec command is run for lines which start with `"!"`.
Method	setKnownConsoleSize	For the duration of this test, patch `cftp`'s `fcntl` module to return a fixed width and height.
Method	test_printProgressBarReporting	No summary
Method	test_printProgressBarNoProgress	`StdioClient._printProgressBar` prints a progress description that indicates 0 bytes transferred if no bytes have been transferred and no time has passed.
Method	test_printProgressBarEmptyFile	Print the progress for empty files.
Method	test_getFilenameEmpty	Returns empty value for both filename and remaining data.
Method	test_getFilenameOnlyLocal	Returns empty value for remaining data when line contains only a filename.
Method	test_getFilenameNotQuoted	Returns filename and remaining data striped of leading and trailing spaces.
Method	test_getFilenameQuoted	Returns filename and remaining data not striped of leading and trailing spaces when quoted paths are requested.
Method	makeFile	Create a local file and return its path.
Method	checkPutMessage	Check output of cftp client for a put request.
Method	test_cmd_PUTSingleNoRemotePath	A name based on local path is used when remote path is not provided.
Method	test_cmd_PUTSingleRemotePath	Remote path is extracted from first filename after local file.
Method	test_cmd_PUTMultipleNoRemotePath	When a gobbing expression is used local files are transferred with remote file names based on local names.
Method	test_cmd_PUTMultipleWithRemotePath	No summary

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.

def setUp(self):

Create a cftp.StdioClient hooked up to dummy transport and a fake user database.

def test_exec(self):

The exec command runs its arguments locally in a child process using the user's shell.

def test_execWithoutShell(self):

If the local user has no shell, the exec command runs its arguments using /bin/sh.

def test_bang(self):

The exec command is run for lines which start with "!".

def setKnownConsoleSize(self, width, height):

For the duration of this test, patch cftp's fcntl module to return a fixed width and height.

Parameters	width	the width in characters (type: `int`)
	height	the height in characters (type: `int`)

def test_printProgressBarReporting(self):

StdioClient._printProgressBar prints a progress description, including percent done, amount transferred, transfer rate, and time remaining, all based the given start time, the given FileWrapper's progress information and the reactor's current time.

def test_printProgressBarNoProgress(self):

StdioClient._printProgressBar prints a progress description that indicates 0 bytes transferred if no bytes have been transferred and no time has passed.

def test_printProgressBarEmptyFile(self):

Print the progress for empty files.

def test_getFilenameEmpty(self):

Returns empty value for both filename and remaining data.

def test_getFilenameOnlyLocal(self):

Returns empty value for remaining data when line contains only a filename.

def test_getFilenameNotQuoted(self):

Returns filename and remaining data striped of leading and trailing spaces.

def test_getFilenameQuoted(self):

Returns filename and remaining data not striped of leading and trailing spaces when quoted paths are requested.

def makeFile(self, path=None, content=''):

Create a local file and return its path.

When `path` is None, it will create a new temporary file.

Parameters	path	Optional path for the new file. (type: `str`)
	content	Content to be written in the new file. (type: `bytes`)
Returns	Path to the newly create file.

def checkPutMessage(self, transfers, randomOrder=False):

Check output of cftp client for a put request.

Parameters	transfers	List with tuple of (local, remote, progress).
	randomOrder	When set to `True`, it will ignore the order in which put reposes are received

def test_cmd_PUTSingleNoRemotePath(self):

A name based on local path is used when remote path is not provided.

The progress is updated while chunks are transferred.

def test_cmd_PUTSingleRemotePath(self):

Remote path is extracted from first filename after local file.

Any other data in the line is ignored.

def test_cmd_PUTMultipleNoRemotePath(self):

When a gobbing expression is used local files are transferred with remote file names based on local names.

def test_cmd_PUTMultipleWithRemotePath(self):

When a gobbing expression is used local files are transferred with remote file names based on local names. when a remote folder is requested remote paths are composed from remote path and local filename.

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

twisted.conch.test.test_cftp.StdioClientTests(TestCase) class documentation

`twisted.conch.test.test_cftp.StdioClientTests(TestCase)` class documentation