twisted.web.test.test_httpauth.HTTPAuthHeaderTests

class documentation

class HTTPAuthHeaderTests(unittest.TestCase):

Constructor: HTTPAuthHeaderTests(methodName)

View In Hierarchy

Tests for HTTPAuthSessionWrapper.

Method setUp Create a realm, portal, and HTTPAuthSessionWrapper to use in the tests.
Method test_anonymousAccess Anonymous requests are allowed if a Portal has an anonymous checker registered.
Method test_decodeRaises Resource traversal which enouncters an HTTPAuthSessionWrapper results in an UnauthorizedResource when the request has a Basic Authorization header which cannot be decoded using base64.
Method test_getChallengeCalledWithRequest When HTTPAuthSessionWrapper finds an ICredentialFactory to issue a challenge, it calls the getChallenge method with the request as an argument.
Method test_getChildWithDefault Resource traversal which encounters an HTTPAuthSessionWrapper results in an UnauthorizedResource instance when the request does not have the required Authorization headers.
Method test_getChildWithDefaultAuthorized Resource traversal which encounters an HTTPAuthSessionWrapper results in an IResource which renders the IResource avatar retrieved from the portal when the request has a valid Authorization header.
Method test_getChildWithDefaultUnauthorizedPassword Resource traversal which enouncters an HTTPAuthSessionWrapper results in an UnauthorizedResource when the request has an Authorization header with a user which exists and the wrong password.
Method test_getChildWithDefaultUnauthorizedUser Resource traversal which enouncters an HTTPAuthSessionWrapper results in an UnauthorizedResource when the request has an Authorization header with a user which does not exist.
Method test_getChildWithDefaultUnrecognizedScheme Resource traversal which enouncters an HTTPAuthSessionWrapper results in an UnauthorizedResource when the request has an Authorization header with an unrecognized scheme.
Method test_logout The realm's logout callback is invoked after the resource is rendered.
Method test_logoutOnError The realm's logout callback is also invoked if there is an error generating the response (for example, if the client disconnects early).
Method test_renderAuthorized Resource traversal which terminates at an HTTPAuthSessionWrapper and includes correct authentication headers results in the IResource avatar (not one of its children) retrieved from the portal being rendered.
Method test_selectParseResponse HTTPAuthSessionWrapper._selectParseHeader returns a two-tuple giving the ICredentialFactory to use to parse the header and a string containing the portion of the header which remains to be parsed.
Method test_unexpectedDecodeError Any unexpected exception raised by the credential factory's decode method results in a 500 response code and causes the exception to be logged.
Method test_unexpectedLoginError Any unexpected failure from Portal.login results in a 500 response code and causes the failure to be logged.
Instance Variable avatar Undocumented
Instance Variable avatarContent Undocumented
Instance Variable avatars Undocumented
Instance Variable checker Undocumented
Instance Variable childContent Undocumented
Instance Variable childName Undocumented
Instance Variable credentialFactories Undocumented
Instance Variable password Undocumented
Instance Variable portal Undocumented
Instance Variable realm Undocumented
Instance Variable username Undocumented
Instance Variable wrapper Undocumented
Method _authorizedBasicLogin Add an basic authorization header to the given request and then dispatch it, starting from self.wrapper and returning the resulting IResource.
Method _invalidAuthorizationTest Create a request with the given value as the value of an Authorization header and perform resource traversal with it, starting at self.wrapper. Assert that the result is a 401 response code. Return a ...
Method _logoutTest Issue a request for an authentication-protected resource using valid credentials and then return the DummyRequest instance which was used.

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 setUp(self):

Create a realm, portal, and HTTPAuthSessionWrapper to use in the tests.

def test_anonymousAccess(self):

Anonymous requests are allowed if a Portal has an anonymous checker registered.

def test_decodeRaises(self):

Resource traversal which enouncters an HTTPAuthSessionWrapper results in an UnauthorizedResource when the request has a Basic Authorization header which cannot be decoded using base64.

def test_getChallengeCalledWithRequest(self):

When HTTPAuthSessionWrapper finds an ICredentialFactory to issue a challenge, it calls the getChallenge method with the request as an argument.

def test_getChildWithDefault(self):

Resource traversal which encounters an HTTPAuthSessionWrapper results in an UnauthorizedResource instance when the request does not have the required Authorization headers.

def test_getChildWithDefaultAuthorized(self):

Resource traversal which encounters an HTTPAuthSessionWrapper results in an IResource which renders the IResource avatar retrieved from the portal when the request has a valid Authorization header.

def test_getChildWithDefaultUnauthorizedPassword(self):

Resource traversal which enouncters an HTTPAuthSessionWrapper results in an UnauthorizedResource when the request has an Authorization header with a user which exists and the wrong password.

def test_getChildWithDefaultUnauthorizedUser(self):

Resource traversal which enouncters an HTTPAuthSessionWrapper results in an UnauthorizedResource when the request has an Authorization header with a user which does not exist.

def test_getChildWithDefaultUnrecognizedScheme(self):

Resource traversal which enouncters an HTTPAuthSessionWrapper results in an UnauthorizedResource when the request has an Authorization header with an unrecognized scheme.

def test_logout(self):

The realm's logout callback is invoked after the resource is rendered.

def test_logoutOnError(self):

The realm's logout callback is also invoked if there is an error generating the response (for example, if the client disconnects early).

def test_renderAuthorized(self):

Resource traversal which terminates at an HTTPAuthSessionWrapper and includes correct authentication headers results in the IResource avatar (not one of its children) retrieved from the portal being rendered.

def test_selectParseResponse(self):

HTTPAuthSessionWrapper._selectParseHeader returns a two-tuple giving the ICredentialFactory to use to parse the header and a string containing the portion of the header which remains to be parsed.

def test_unexpectedDecodeError(self):

Any unexpected exception raised by the credential factory's decode method results in a 500 response code and causes the exception to be logged.

def test_unexpectedLoginError(self):

Any unexpected failure from Portal.login results in a 500 response code and causes the failure to be logged.

avatar =

Undocumented

avatarContent: bytes =

Undocumented

avatars =

Undocumented

checker =

Undocumented

childContent: bytes =

Undocumented

childName: bytes =

Undocumented

credentialFactories: list =

Undocumented

password: bytes =

Undocumented

portal =

Undocumented

realm =

Undocumented

username: bytes =

Undocumented

wrapper =

Undocumented

def _authorizedBasicLogin(self, request):

Add an basic authorization header to the given request and then dispatch it, starting from self.wrapper and returning the resulting IResource.

def _invalidAuthorizationTest(self, response):

Create a request with the given value as the value of an Authorization header and perform resource traversal with it, starting at self.wrapper. Assert that the result is a 401 response code. Return a Deferred which fires when this is all done.

def _logoutTest(self):

Issue a request for an authentication-protected resource using valid credentials and then return the DummyRequest instance which was used.

This is a helper for tests about the behavior of the logout callback.