twisted.web.test.test_httpauth.HTTPAuthHeaderTests(unittest.TestCase) class documentation

Part of twisted.web.test.test_httpauth (View In Hierarchy)

Tests for HTTPAuthSessionWrapper.

Method setUp Create a realm, portal, and HTTPAuthSessionWrapper to use in the tests.
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_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_getChildWithDefaultUnauthorizedPassword No summary
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_getChildWithDefaultAuthorized No summary
Method test_renderAuthorized No summary
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_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_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_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.
Method test_anonymousAccess Anonymous requests are allowed if a Portal has an anonymous checker registered.
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 No summary
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:

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.Deferreds. After they complete, do some reactor cleanup.
Method _wait Take a Deferred that only ever callbacks. Block until it happens.

Inherited from SynchronousTestCase (via 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 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 setUp(self):

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

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

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

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.

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_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_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.

def test_anonymousAccess(self):

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

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