twisted.conch.test.test_cftp.StdioClientTests

class documentation

class StdioClientTests(TestCase): (source)

View In Hierarchy

Tests for cftp.StdioClient.

Method checkPutMessage Check output of cftp client for a put request.
Method makeFile Create a local file and return its path.
Method setKnownConsoleSize For the duration of this test, patch cftp's fcntl module to return a fixed width and height.
Method setUp Create a cftp.StdioClient hooked up to dummy transport and a fake user database.
Method test_bang The exec command is run for lines which start with "!".
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 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.
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_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_getFilenameEmpty Returns empty value for both filename and remaining data.
Method test_getFilenameNotQuoted Returns filename and remaining data striped of leading and trailing spaces.
Method test_getFilenameOnlyLocal Returns empty value for remaining data when line contains only a filename.
Method test_getFilenameQuoted Returns filename and remaining data not striped of leading and trailing spaces when quoted paths are requested.
Method test_printProgressBarEmptyFile Print the progress for empty files.
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_printProgressBarReporting 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.
Instance Variable client Undocumented
Instance Variable database Undocumented
Instance Variable fakeFilesystem 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.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 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.
def checkPutMessage(self, transfers, randomOrder=False): (source)

Check output of cftp client for a put request.

Parameters
transfersList with tuple of (local, remote, progress).
randomOrderWhen set to True, it will ignore the order in which put reposes are received
def makeFile(self, path=None, content=b''): (source)

Create a local file and return its path.

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

Parameters
path:strOptional path for the new file.
content:bytesContent to be written in the new file.
Returns
Path to the newly create file.
def setKnownConsoleSize(self, width, height): (source)

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

Parameters
width:intthe width in characters
height:intthe height in characters
def setUp(self): (source)

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

def test_bang(self): (source)

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

def test_cmd_PUTMultipleNoRemotePath(self): (source)

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

def test_cmd_PUTMultipleWithRemotePath(self): (source)

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.

def test_cmd_PUTSingleNoRemotePath(self): (source)

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

Remote path is extracted from first filename after local file.

Any other data in the line is ignored.

def test_exec(self): (source)

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

def test_execWithoutShell(self): (source)

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

def test_getFilenameEmpty(self): (source)

Returns empty value for both filename and remaining data.

def test_getFilenameNotQuoted(self): (source)

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

def test_getFilenameOnlyLocal(self): (source)

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

def test_getFilenameQuoted(self): (source)

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

def test_printProgressBarEmptyFile(self): (source)

Print the progress for empty files.

def test_printProgressBarNoProgress(self): (source)

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

def test_printProgressBarReporting(self): (source)

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.

client = (source)

Undocumented

database = (source)

Undocumented

fakeFilesystem = (source)

Undocumented