class documentation

Tests related to the twisted.cred support in PB.

Method completeClientLostConnection Asserts that the client broker's transport was closed and then mimics the event loop by calling the broker's connectionLost callback with reason, followed by self.clientFactory's clientConnectionLost
Method establishClientAndServer Connect a client obtained from clientFactory and a server obtained from the current server factory via an IOPump, then assign them to the appropriate instance variables
Method setUp Create a portal with no checkers and wrap it around a simple test realm. Set up a PB server on a TCP port which serves perspectives using that portal.
Method test_anonymousLogin Verify that a PB server using a portal configured with a checker which allows IAnonymous credentials can be logged into using IAnonymous credentials.
Method test_anonymousLoginNotPermitted Verify that without an anonymous checker set up, anonymous login is rejected.
Method test_anonymousLoginWithMultipleCheckers Like test_anonymousLogin but against a portal with a checker for both IAnonymous and IUsernamePassword.
Method test_authenticatedLoginWithMultipleCheckers Like test_anonymousLoginWithMultipleCheckers but check that username/password authentication works.
Method test_badUsernamePasswordLogin Test that a login attempt with an invalid user or invalid password fails in the appropriate way.
Method test_clientConnectionLost Test that if the reconnecting flag is passed with a True value then a remote call made from a disconnection notification callback gets a result successfully.
Method test_concurrentLogin Two different correct login attempts can be made on the same root object at the same time and produce two different resulting avatars.
Method test_deadReferenceError Test that when a connection is lost, calling a method on a RemoteReference obtained from it raises DeadReferenceError.
Method test_getRootObject Assert that PBClientFactory.getRootObject's Deferred fires with a RemoteReference, and that disconnecting it runs its disconnection callbacks.
Method test_immediateClose Test that if a Broker loses its connection without receiving any bytes, it doesn't raise any exceptions or log any errors.
Method test_loginConnectionRefused PBClientFactory.login returns a Deferred which is errbacked with the ConnectionRefusedError if the underlying connection is refused.
Method test_loginLogout Test that login can be performed with IUsernamePassword credentials and that when the connection is dropped the avatar is logged out.
Method test_logoutAfterDecref If a RemoteReference to an IPerspective avatar is decrefed and there remain no other references to the avatar on the server, the avatar is garbage collected and the logout method called.
Method test_view Verify that a viewpoint can be retrieved after authenticating with cred.
Instance Variable client Undocumented
Instance Variable clientFactory Undocumented
Instance Variable connector Undocumented
Instance Variable connectorState Undocumented
Instance Variable portal Undocumented
Instance Variable pump Undocumented
Instance Variable realm Undocumented
Instance Variable server Undocumented
Instance Variable serverFactory 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 completeClientLostConnection(self, reason=failure.Failure(main.CONNECTION_DONE)): (source)

Asserts that the client broker's transport was closed and then mimics the event loop by calling the broker's connectionLost callback with reason, followed by self.clientFactory's clientConnectionLost

Parameters
reason:Failure(optional) the reason to pass to the client broker's connectionLost callback
def establishClientAndServer(self, _ignored=None): (source)

Connect a client obtained from clientFactory and a server obtained from the current server factory via an IOPump, then assign them to the appropriate instance variables

Parameters
_ignoredUndocumented
client:pb.BrokerUndocumented
server:pb.BrokerUndocumented
pump:IOPumpUndocumented
connector:twisted.internet.base.IConnectorUndocumented
def setUp(self): (source)

Create a portal with no checkers and wrap it around a simple test realm. Set up a PB server on a TCP port which serves perspectives using that portal.

def test_anonymousLogin(self): (source)

Verify that a PB server using a portal configured with a checker which allows IAnonymous credentials can be logged into using IAnonymous credentials.

def test_anonymousLoginNotPermitted(self): (source)

Verify that without an anonymous checker set up, anonymous login is rejected.

def test_anonymousLoginWithMultipleCheckers(self): (source)

Like test_anonymousLogin but against a portal with a checker for both IAnonymous and IUsernamePassword.

def test_authenticatedLoginWithMultipleCheckers(self): (source)

Like test_anonymousLoginWithMultipleCheckers but check that username/password authentication works.

def test_badUsernamePasswordLogin(self): (source)

Test that a login attempt with an invalid user or invalid password fails in the appropriate way.

def test_clientConnectionLost(self): (source)

Test that if the reconnecting flag is passed with a True value then a remote call made from a disconnection notification callback gets a result successfully.

def test_concurrentLogin(self): (source)

Two different correct login attempts can be made on the same root object at the same time and produce two different resulting avatars.

def test_deadReferenceError(self): (source)

Test that when a connection is lost, calling a method on a RemoteReference obtained from it raises DeadReferenceError.

def test_getRootObject(self): (source)

Assert that PBClientFactory.getRootObject's Deferred fires with a RemoteReference, and that disconnecting it runs its disconnection callbacks.

def test_immediateClose(self): (source)

Test that if a Broker loses its connection without receiving any bytes, it doesn't raise any exceptions or log any errors.

def test_loginConnectionRefused(self): (source)

PBClientFactory.login returns a Deferred which is errbacked with the ConnectionRefusedError if the underlying connection is refused.

def test_loginLogout(self): (source)

Test that login can be performed with IUsernamePassword credentials and that when the connection is dropped the avatar is logged out.

def test_logoutAfterDecref(self): (source)

If a RemoteReference to an IPerspective avatar is decrefed and there remain no other references to the avatar on the server, the avatar is garbage collected and the logout method called.

def test_view(self): (source)

Verify that a viewpoint can be retrieved after authenticating with cred.

Undocumented

clientFactory = (source)

Undocumented

connector = (source)

Undocumented

connectorState = (source)

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

serverFactory = (source)

Undocumented