twisted.test.test_ftp.FTPServerPasvDataConnectionTests

Known subclasses: twisted.test.test_ftp.FTPServerPortDataConnectionTests

PASV data connection.

Method	test_LISTEmpty	When listing empty folders, LIST returns an empty response.
Method	test_LISTWithBinLsFlags	LIST ignores requests for folder with names like '-al' and will list the content of current folder.
Method	test_LISTWithContent	LIST returns all folder's members, each member listed on a separate line and with name and other details.
Method	test_LISTUnicode	Unicode filenames returned from `IFTPShell.list` are encoded using UTF-8 before being sent with the response.
Method	test_LISTNonASCIIBytes	When LIST receive a filename as byte string from `IFTPShell.list` it will just pass the data to lower level without any change.
Method	test_ManyLargeDownloads	Download many large files.
Method	test_downloadFolder	When RETR is called for a folder, it will fail complaining that the path is a folder.
Method	test_NLSTEmpty	NLST with no argument returns the directory listing for the current working directory.
Method	test_NLSTNonexistent	NLST on a non-existent file/directory returns nothing.
Method	test_NLSTUnicode	NLST will receive Unicode filenames for IFTPShell.list, and will encode them using UTF-8.
Method	test_NLSTNonASCIIBytes	NLST will just pass the non-Unicode data to lower level.
Method	test_NLSTOnPathToFile	NLST on an existent file returns only the path to that file.
Method	_makeDataConnection	Establish a passive data connection (i.e. client connecting to server).
Method	_download	Download file.
Method	_listTestHelper	Exercise handling by the implementation of LIST or NLST of certain return values and types from an `IFTPShell.list` implementation.

Inherited from FTPServerTestCase:

Instance Variable	clientFactory	class used as ftp client.
Method	setUp	Undocumented
Method	assertCommandResponse	Asserts that a sending an FTP command receives the expected response.
Method	assertCommandFailed	Undocumented
Method	_anonymousLogin	Undocumented
Method	_userLogin	Authenticates the FTP client using the test account.

Inherited from TestCase (via FTPServerTestCase):

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 FTPServerTestCase, 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 FTPServerTestCase, 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 _makeDataConnection(self, ignored=None):

overridden in twisted.test.test_ftp.FTPServerPortDataConnectionTests

Establish a passive data connection (i.e. client connecting to server).

Parameters	ignored	ignored
Returns	`Deferred.addCallback`

def _download(self, command, chainDeferred=None):

Download file.

Parameters	command	command to run
	chainDeferred	`Deferred` used to queue commands.
Returns	`Deferred` of command response

def test_LISTEmpty(self):

When listing empty folders, LIST returns an empty response.

def test_LISTWithBinLsFlags(self):

LIST ignores requests for folder with names like '-al' and will list the content of current folder.

def test_LISTWithContent(self):

LIST returns all folder's members, each member listed on a separate line and with name and other details.

def _listTestHelper(self, command, listOutput, expectedOutput):

Exercise handling by the implementation of LIST or NLST of certain return values and types from an IFTPShell.list implementation.

This will issue command and assert that if the IFTPShell.list implementation includes listOutput as one of the file entries then the result given to the client is matches expectedOutput.

Parameters	command	Either `b"LIST"` or `b"NLST"` (type: `bytes`)
	listOutput	A value suitable to be used as an element of the list returned by `IFTPShell.list`. Vary the values and types of the contents to exercise different code paths in the server's handling of this result.
	expectedOutput	A line of output to expect as a result of `listOutput` being transformed into a response to the command issued. (type: `bytes`)
Returns	A `Deferred` which fires when the test is done, either with an `Failure` if the test failed or with a function object if it succeeds. The function object is the function which implements `IFTPShell.list` (and is useful to make assertions about what warnings might have been emitted). (type: `Deferred`)

def test_LISTUnicode(self):

Unicode filenames returned from IFTPShell.list are encoded using UTF-8 before being sent with the response.

def test_LISTNonASCIIBytes(self):

When LIST receive a filename as byte string from IFTPShell.list it will just pass the data to lower level without any change.

Returns _listTestHelper

def test_ManyLargeDownloads(self):

Download many large files.

Returns Deferred

def test_downloadFolder(self):

When RETR is called for a folder, it will fail complaining that the path is a folder.

def test_NLSTEmpty(self):

NLST with no argument returns the directory listing for the current working directory.

def test_NLSTNonexistent(self):

NLST on a non-existent file/directory returns nothing.

def test_NLSTUnicode(self):

NLST will receive Unicode filenames for IFTPShell.list, and will encode them using UTF-8.

def test_NLSTNonASCIIBytes(self):

NLST will just pass the non-Unicode data to lower level.

def test_NLSTOnPathToFile(self):

NLST on an existent file returns only the path to that file.

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

twisted.test.test_ftp.FTPServerPasvDataConnectionTests(FTPServerTestCase) class documentation

`twisted.test.test_ftp.FTPServerPasvDataConnectionTests(FTPServerTestCase)` class documentation