twisted.application.test.test_internet.ClientServiceTests

class documentation

class ClientServiceTests(SynchronousTestCase): (source)

View In Hierarchy

Tests for ClientService.

Method makeReconnector Create a ClientService along with a ConnectInformation indicating the connections in progress on its endpoint.
Method test_clientConnected When a client connects, the service keeps a reference to the new protocol and resets the delay.
Method test_clientConnectionFailed When a client connection fails, the service removes its reference to the protocol and tries again after a timeout.
Method test_clientConnectionLost When a client connection is lost, the service removes its reference to the protocol and calls retry.
Method test_clientConnectionLostWhileStopping When a client connection is lost while the service is stopping, the protocol stopping deferred is called and the reference to the protocol is removed.
Method test_interfacesForTransport If the protocol objects returned by the factory given to ClientService provide special "marker" interfaces for their transport - IHalfCloseableProtocol or IFileDescriptorReceiver - those interfaces will be provided by the protocol objects passed on to the reactor.
Method test_prepareConnectionCalledAfterConnectionMade The prepareConnection callback is invoked only once a connection is made.
Method test_prepareConnectionCalledOnReconnect The prepareConnection callback is invoked each time a connection is made, including on reconnection.
Method test_prepareConnectionCalledWhenServiceStarts The prepareConnection callable is called after ClientService.startService once the connection is made.
Method test_prepareConnectionCalledWithProtocol The prepareConnection callable is passed the connected protocol instance.
Method test_prepareConnectionReturningADeferred The prepareConnection callable returns a deferred and calls to ClientService.whenConnected wait until it fires.
Method test_prepareConnectionReturnValueIgnored The prepareConnection return value is ignored when it does not indicate a failure. Even though the callback participates in the internal new-connection Deferred chain for error propagation purposes, any successful result does not affect the ultimate return value.
Method test_prepareConnectionThrows The connection attempt counts as a failure when the prepareConnection callable throws.
Method test_retryCancelled When ClientService.stopService is called while waiting between connection attempts, the pending reconnection attempt is cancelled and the service is stopped immediately.
Method test_startService When the service is started, a connection attempt is made.
Method test_startServiceWaitsForDisconnect When ClientService is restarted after having been connected, it waits to start connecting until after having disconnected.
Method test_startServiceWhileStopped When ClientService is stopped - that is, ClientService.stopService has been called and the Deferred it returns has fired - calling startService will cause a new connection to be made, and new calls to ...
Method test_startServiceWhileStopping When ClientService is stopping - that is, ClientService.stopService has been called, but the Deferred it returns has not fired yet - calling startService will cause a new connection to be made, and new calls to ...
Method test_startStopFactory Although somewhat obscure, IProtocolFactory includes both doStart and doStop methods; ensure that when these methods are called on the factory that was passed to the reactor, the factory that was passed from the application receives them.
Method test_startTwice If ClientService is started when it's already started, it will log a complaint and do nothing else (in particular it will not make additional connections).
Method test_stopServiceBeforeStartService Calling ClientService.stopService before ClientService.startService returns a Deferred that has already fired with None.
Method test_stopServiceOnStoppedService Calling ClientService.stopService on a stopped service returns a Deferred that has already fired with None.
Method test_stopServiceWhileConnected When the service is stopped, no further connect attempts are made. The returned Deferred fires when all outstanding connections have been stopped.
Method test_stopServiceWhileConnecting When the service is stopped while initially connecting, the connection attempt is cancelled.
Method test_stopServiceWhileDisconnecting Calling ClientService.stopService twice after it has connected (that is, stopping it while it is disconnecting) returns a Deferred each time that fires when the disconnection has completed.
Method test_stopServiceWhileRestarting Calling ClientService.stopService after calling a reconnection attempt returns a Deferred that fires when the disconnection has completed.
Method test_stopServiceWhileRetrying When the service is stopped while retrying, the retry is cancelled.
Method test_whenConnectedErrbacksOnStopService ClientService.whenConnected returns a Deferred that errbacks with CancelledError if ClientService.stopService is called between connection attempts.
Method test_whenConnectedFails ClientService.whenConnected returns a Deferred that fails, if asked, when some number of connections have failed.
Method test_whenConnectedLater ClientService.whenConnected returns a Deferred that fires when a connection is established.
Method test_whenConnectedStopService ClientService.whenConnected returns a Deferred that fails when ClientService.stopService is called.

Inherited from SynchronousTestCase:

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 __init__ Undocumented
Method addCleanup Add the given function to a list of functions to be called after the test has run, but before tearDown.
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 _run Run a single method, either a test method or fixture.
Method _runCleanups Synchronously run any cleanups which have been added.
Method _runFixturesAndTest Run setUp, a test method, test cleanups, and tearDown.
Instance Variable _cleanups Undocumented
Instance Variable _observer Undocumented
Instance Variable _parents Undocumented
Instance Variable _passed Undocumented
Instance Variable _testMethodName Undocumented
Instance Variable _warnings Undocumented

Inherited from _Assertions (via 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 makeReconnector(self, fireImmediately=True, startService=True, protocolType=Protocol, **kw): (source)

Create a ClientService along with a ConnectInformation indicating the connections in progress on its endpoint.

Parameters
fireImmediately:boolShould all of the endpoint connection attempts fire synchronously?
startService:boolShould the ClientService be started before being returned?
protocolTypea 0-argument callable returning a new IProtocol provider to be used for application-level protocol connections.
**kwArbitrary keyword arguments to be passed on to ClientService
Returns
a 2-tuple of ConnectInformation (for information about test state) and ClientService (the system under test). The ConnectInformation has 2 additional attributes; applicationFactory and applicationProtocols, which refer to the unwrapped protocol factory and protocol instances passed in to ClientService respectively.
def test_clientConnected(self): (source)

When a client connects, the service keeps a reference to the new protocol and resets the delay.

def test_clientConnectionFailed(self): (source)

When a client connection fails, the service removes its reference to the protocol and tries again after a timeout.

def test_clientConnectionLost(self): (source)

When a client connection is lost, the service removes its reference to the protocol and calls retry.

def test_clientConnectionLostWhileStopping(self): (source)

When a client connection is lost while the service is stopping, the protocol stopping deferred is called and the reference to the protocol is removed.

def test_interfacesForTransport(self): (source)

If the protocol objects returned by the factory given to ClientService provide special "marker" interfaces for their transport - IHalfCloseableProtocol or IFileDescriptorReceiver - those interfaces will be provided by the protocol objects passed on to the reactor.

def test_prepareConnectionCalledAfterConnectionMade(self): (source)

The prepareConnection callback is invoked only once a connection is made.

def test_prepareConnectionCalledOnReconnect(self): (source)

The prepareConnection callback is invoked each time a connection is made, including on reconnection.

def test_prepareConnectionCalledWhenServiceStarts(self): (source)

The prepareConnection callable is called after ClientService.startService once the connection is made.

def test_prepareConnectionCalledWithProtocol(self): (source)

The prepareConnection callable is passed the connected protocol instance.

def test_prepareConnectionReturningADeferred(self): (source)

The prepareConnection callable returns a deferred and calls to ClientService.whenConnected wait until it fires.

def test_prepareConnectionReturnValueIgnored(self): (source)

The prepareConnection return value is ignored when it does not indicate a failure. Even though the callback participates in the internal new-connection Deferred chain for error propagation purposes, any successful result does not affect the ultimate return value.

def test_prepareConnectionThrows(self): (source)

The connection attempt counts as a failure when the prepareConnection callable throws.

def test_retryCancelled(self): (source)

When ClientService.stopService is called while waiting between connection attempts, the pending reconnection attempt is cancelled and the service is stopped immediately.

def test_startService(self): (source)

When the service is started, a connection attempt is made.

def test_startServiceWaitsForDisconnect(self): (source)

When ClientService is restarted after having been connected, it waits to start connecting until after having disconnected.

def test_startServiceWhileStopped(self): (source)

When ClientService is stopped - that is, ClientService.stopService has been called and the Deferred it returns has fired - calling startService will cause a new connection to be made, and new calls to whenConnected to succeed.

def test_startServiceWhileStopping(self): (source)

When ClientService is stopping - that is, ClientService.stopService has been called, but the Deferred it returns has not fired yet - calling startService will cause a new connection to be made, and new calls to whenConnected to succeed.

def test_startStopFactory(self): (source)

Although somewhat obscure, IProtocolFactory includes both doStart and doStop methods; ensure that when these methods are called on the factory that was passed to the reactor, the factory that was passed from the application receives them.

def test_startTwice(self): (source)

If ClientService is started when it's already started, it will log a complaint and do nothing else (in particular it will not make additional connections).

def test_stopServiceBeforeStartService(self): (source)

Calling ClientService.stopService before ClientService.startService returns a Deferred that has already fired with None.

def test_stopServiceOnStoppedService(self): (source)

Calling ClientService.stopService on a stopped service returns a Deferred that has already fired with None.

def test_stopServiceWhileConnected(self): (source)

When the service is stopped, no further connect attempts are made. The returned Deferred fires when all outstanding connections have been stopped.

def test_stopServiceWhileConnecting(self): (source)

When the service is stopped while initially connecting, the connection attempt is cancelled.

def test_stopServiceWhileDisconnecting(self): (source)

Calling ClientService.stopService twice after it has connected (that is, stopping it while it is disconnecting) returns a Deferred each time that fires when the disconnection has completed.

def test_stopServiceWhileRestarting(self): (source)

Calling ClientService.stopService after calling a reconnection attempt returns a Deferred that fires when the disconnection has completed.

def test_stopServiceWhileRetrying(self): (source)

When the service is stopped while retrying, the retry is cancelled.

def test_whenConnectedErrbacksOnStopService(self): (source)

ClientService.whenConnected returns a Deferred that errbacks with CancelledError if ClientService.stopService is called between connection attempts.

def test_whenConnectedFails(self): (source)

ClientService.whenConnected returns a Deferred that fails, if asked, when some number of connections have failed.

def test_whenConnectedLater(self): (source)

ClientService.whenConnected returns a Deferred that fires when a connection is established.

def test_whenConnectedStopService(self): (source)

ClientService.whenConnected returns a Deferred that fails when ClientService.stopService is called.