twisted.test.test_ftp.BasicFTPServerTests

class documentation

class BasicFTPServerTests(FTPServerTestCase): (source)

View In Hierarchy

Basic functionality of FTP server.

Method test_AnonymousLogin Login with userid 'anonymous'
Method test_AnonymousLoginDenied Reconfigure the server to disallow anonymous access, and to have an IUsernamePassword checker that always rejects.
Method test_anonymousWriteDenied When an anonymous user attempts to edit the server-side filesystem, they will receive a 550 error with a descriptive message.
Method test_BadCommandArgs Send command with bad arguments.
Method test_DecodeHostPort Decode a host port.
Method test_FEAT When the server receives 'FEAT', it should report the list of supported features. (Additionally, ensure that the server reports various particular features that are supported by all Twisted FTP servers...
Method test_loginError Unexpected exceptions from the login handler are caught
Method test_NoParamsForPASS Issuing PASS without a password is a syntax error.
Method test_NoParamsForUSER Issuing USER without a username is a syntax error.
Method test_NotLoggedInReply When not logged in, most commands other than USER and PASS should get NOT_LOGGED_IN errors, but some can be called before USER and PASS.
Method test_OPTS When the server receives 'OPTS something', it should report that the FTP server does not support the option called 'something'.
Method test_PASSBeforeUSER Issuing PASS before USER should give an error.
Method test_PASV When the client sends the command PASV, the server responds with a host and port, and is listening on that port.
Method test_portRange FTP.passivePortRange should determine the ports which FTP.getDTPPort attempts to bind. If no port from that iterator can be bound, error.CannotListenError should be raised, otherwise the first successful result from ...
Method test_portRangeForwardError Exceptions other than error.CannotListenError which are raised by listenFactory should be raised to the caller of FTP.getDTPPort.
Method test_portRangeInheritedFromFactory The FTP instances created by ftp.FTPFactory.buildProtocol have their passivePortRange attribute set to the same object the factory's passivePortRange attribute is set to.
Method test_Quit Issuing QUIT should return a 221 message.
Method test_RETRBeforePORT Send RETR before sending PORT.
Method test_RNFRandRNTO Sending the RNFR command followed by RNTO, with valid filenames, will perform a successful rename operation.
Method test_RNFRwithoutRNTO Sending the RNFR command followed by any command other than RNTO should return an error informing users that RNFR should be followed by RNTO.
Method test_STORBeforePORT Send STOR before sending PORT.
Method test_STORreturnsErrorFromOpen Any FTP error raised inside STOR while opening the file is returned to the client.
Method test_STORunknownErrorBecomesFileNotFound Any non FTP error raised inside STOR while opening the file is converted into FileNotFound error and returned to the client together with the path.
Method test_SYST SYST command will always return UNIX Type: L8
Method test_tooManyConnections When the connection limit is reached, the server should send an appropriate response
Method test_UnknownCommand Send an invalid command.

Inherited from FTPServerTestCase:

Method assertCommandFailed Undocumented
Method assertCommandResponse Asserts that a sending an FTP command receives the expected response.
Method setUp Undocumented
Class Variable userAnonymous Undocumented
Instance Variable clientFactory class used as ftp client.
Instance Variable directory Undocumented
Instance Variable dirPath Undocumented
Instance Variable factory Undocumented
Instance Variable password Undocumented
Instance Variable port Undocumented
Instance Variable username Undocumented
Method _anonymousLogin Undocumented
Method _userLogin Authenticates the FTP client using the test account.

Inherited from TestCase (via FTPServerTestCase):

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 FTPServerTestCase, 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 FTPServerTestCase, 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 test_AnonymousLogin(self): (source)

Login with userid 'anonymous'

def test_AnonymousLoginDenied(self): (source)

Reconfigure the server to disallow anonymous access, and to have an IUsernamePassword checker that always rejects.

Returns
Deferred of command response
def test_anonymousWriteDenied(self): (source)

When an anonymous user attempts to edit the server-side filesystem, they will receive a 550 error with a descriptive message.

Returns
Deferred of command response
def test_BadCommandArgs(self): (source)

Send command with bad arguments.

Returns
Deferred of command response
def test_DecodeHostPort(self): (source)

Decode a host port.

def test_FEAT(self): (source)

When the server receives 'FEAT', it should report the list of supported features. (Additionally, ensure that the server reports various particular features that are supported by all Twisted FTP servers.)

def test_loginError(self): (source)

Unexpected exceptions from the login handler are caught

def test_NoParamsForPASS(self): (source)

Issuing PASS without a password is a syntax error.

def test_NoParamsForUSER(self): (source)

Issuing USER without a username is a syntax error.

def test_NotLoggedInReply(self): (source)

When not logged in, most commands other than USER and PASS should get NOT_LOGGED_IN errors, but some can be called before USER and PASS.

def test_OPTS(self): (source)

When the server receives 'OPTS something', it should report that the FTP server does not support the option called 'something'.

def test_PASSBeforeUSER(self): (source)

Issuing PASS before USER should give an error.

def test_PASV(self): (source)

When the client sends the command PASV, the server responds with a host and port, and is listening on that port.

def test_portRange(self): (source)

FTP.passivePortRange should determine the ports which FTP.getDTPPort attempts to bind. If no port from that iterator can be bound, error.CannotListenError should be raised, otherwise the first successful result from FTP.listenFactory should be returned.

def test_portRangeForwardError(self): (source)

Exceptions other than error.CannotListenError which are raised by listenFactory should be raised to the caller of FTP.getDTPPort.

def test_portRangeInheritedFromFactory(self): (source)

The FTP instances created by ftp.FTPFactory.buildProtocol have their passivePortRange attribute set to the same object the factory's passivePortRange attribute is set to.

def test_Quit(self): (source)

Issuing QUIT should return a 221 message.

Returns
Deferred of command response
def test_RETRBeforePORT(self): (source)

Send RETR before sending PORT.

Returns
Deferred of command response
def test_RNFRandRNTO(self): (source)

Sending the RNFR command followed by RNTO, with valid filenames, will perform a successful rename operation.

def test_RNFRwithoutRNTO(self): (source)

Sending the RNFR command followed by any command other than RNTO should return an error informing users that RNFR should be followed by RNTO.

def test_STORBeforePORT(self): (source)

Send STOR before sending PORT.

Returns
Deferred of command response
def test_STORreturnsErrorFromOpen(self): (source)

Any FTP error raised inside STOR while opening the file is returned to the client.

def test_STORunknownErrorBecomesFileNotFound(self): (source)

Any non FTP error raised inside STOR while opening the file is converted into FileNotFound error and returned to the client together with the path.

The unknown error is logged.

def test_SYST(self): (source)

SYST command will always return UNIX Type: L8

def test_tooManyConnections(self): (source)

When the connection limit is reached, the server should send an appropriate response

def test_UnknownCommand(self): (source)

Send an invalid command.

Returns
Deferred of command response