twisted.conch.test.test_cftp.OurServerCmdLineClientTests(CFTPClientTestBase) class documentation

Part of twisted.conch.test.test_cftp (View In Hierarchy)

Functional tests which launch a SFTP server over TCP on localhost and check cftp command line interface using a spawned process.

Due to the spawned process you can not add a debugger breakpoint for the client code.

Method setUp Undocumented
Method tearDown Undocumented
Method runCommand Run the given command with the cftp client. Return a Deferred that fires when the command is complete. Payload is the server's output for that command.
Method runScript Run the given commands with the cftp client. Returns a Deferred that fires when the commands are all complete. The Deferred's payload is a list of output for each command.
Method testCdPwd No summary
Method testChAttrs Check that 'ls -l' output includes the access permissions and that this output changes appropriately with 'chmod'.
Method testList Check 'ls' works as expected. Checks for wildcards, hidden files, listing directories and listing empty directories.
Method testHelp Check that running the '?' command returns help.
Method assertFilesEqual Assert that the files at name1 and name2 contain exactly the same data.
Method testGet Test that 'get' saves the remote file to the correct local location, that the output of 'get' is correct and that 'rm' actually removes the file.
Method testWildcardGet Test that 'get' works correctly when given wildcard parameters.
Method testPut Check that 'put' uploads files correctly and that they can be successfully removed. Also check the output of the put command.
Method test_putOverLongerFile Check that 'put' uploads files correctly when overwriting a longer file.
Method test_putMultipleOverLongerFile Check that 'put' uploads files correctly when overwriting a longer file and you use a wildcard to specify the files to upload.
Method testWildcardPut What happens if you issue a 'put' command and include a wildcard (i.e. '*') in parameter? Check that all files matching the wildcard are uploaded to the correct directory.
Method testLink Test that 'ln' creates a file which appears as a link in the output of 'ls'. Check that removing the new file succeeds without output.
Method testRemoteDirectory Test that we can create and remove directories with the cftp client.
Method test_existingRemoteDirectory Test that a mkdir on an existing directory fails with the appropriate error, and doesn't log an useless error server side.
Method testLocalDirectory Test that we can create a directory locally and remove it with the cftp client. This test works because the 'remote' server is running out of a local directory.
Method testRename Test that we can rename a file.
Method _killProcess Undocumented

Inherited from CFTPClientTestBase:

Method startServer Undocumented
Method stopServer Undocumented
Method _cbStopServer Undocumented

Inherited from TestCase (via CFTPClientTestBase, SFTPTestBase):

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.Deferreds. After they complete, do some reactor cleanup.
Method _wait Take a Deferred that only ever callbacks. Block until it happens.

Inherited from SynchronousTestCase (via CFTPClientTestBase, SFTPTestBase, 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 CFTPClientTestBase, SFTPTestBase, 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):
overrides twisted.conch.test.test_cftp.CFTPClientTestBase.setUp
Undocumented
def tearDown(self):
overrides twisted.conch.test.test_cftp.CFTPClientTestBase.tearDown
Undocumented
def _killProcess(self, ignored):
Undocumented
def runCommand(self, command):

Run the given command with the cftp client. Return a Deferred that fires when the command is complete. Payload is the server's output for that command.

def runScript(self, *commands):

Run the given commands with the cftp client. Returns a Deferred that fires when the commands are all complete. The Deferred's payload is a list of output for each command.

def testCdPwd(self):

Test that 'pwd' reports the current remote directory, that 'lpwd' reports the current local directory, and that changing to a subdirectory then changing to its parent leaves you in the original remote directory.

def testChAttrs(self):

Check that 'ls -l' output includes the access permissions and that this output changes appropriately with 'chmod'.

def testList(self):

Check 'ls' works as expected. Checks for wildcards, hidden files, listing directories and listing empty directories.

def testHelp(self):

Check that running the '?' command returns help.

def assertFilesEqual(self, name1, name2, msg=None):

Assert that the files at name1 and name2 contain exactly the same data.

def testGet(self):

Test that 'get' saves the remote file to the correct local location, that the output of 'get' is correct and that 'rm' actually removes the file.

def testWildcardGet(self):

Test that 'get' works correctly when given wildcard parameters.

def testPut(self):

Check that 'put' uploads files correctly and that they can be successfully removed. Also check the output of the put command.

def test_putOverLongerFile(self):

Check that 'put' uploads files correctly when overwriting a longer file.

def test_putMultipleOverLongerFile(self):

Check that 'put' uploads files correctly when overwriting a longer file and you use a wildcard to specify the files to upload.

def testWildcardPut(self):

What happens if you issue a 'put' command and include a wildcard (i.e. '*') in parameter? Check that all files matching the wildcard are uploaded to the correct directory.

def testLink(self):

Test that 'ln' creates a file which appears as a link in the output of 'ls'. Check that removing the new file succeeds without output.

def testRemoteDirectory(self):

Test that we can create and remove directories with the cftp client.

def test_existingRemoteDirectory(self):

Test that a mkdir on an existing directory fails with the appropriate error, and doesn't log an useless error server side.

def testLocalDirectory(self):

Test that we can create a directory locally and remove it with the cftp client. This test works because the 'remote' server is running out of a local directory.

def testRename(self):

Test that we can rename a file.

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