twisted.web.test.test_agent._RedirectAgentTestsMixin

class documentation

class _RedirectAgentTestsMixin(testMixinClass): (source)

Known subclasses: twisted.web.test.test_agent.BrowserLikeRedirectAgentTests, twisted.web.test.test_agent.RedirectAgentTests

View In Hierarchy

Test cases mixin for RedirectAgentTests and BrowserLikeRedirectAgentTests.

Method test_307OnPost When getting a 307 redirect on a POST request, client.RedirectAgent fails with a ResponseFailed error wrapping a error.PageRedirect exception.
Method test_crossDomainHeaders client.RedirectAgent scrubs sensitive headers when redirecting between differing domains.
Method test_crossPortHeaders client.RedirectAgent scrubs sensitive headers when redirecting between differing ports.
Method test_crossSchemeHeaders client.RedirectAgent scrubs sensitive headers when redirecting between differing schemes.
Method test_noLocationField If no Location header field is found when getting a redirect, client.RedirectAgent fails with a ResponseFailed error wrapping a error.RedirectWithNoLocation exception.
Method test_noRedirect client.RedirectAgent behaves like client.Agent if the response doesn't contain a redirect.
Method test_redirect301 client.RedirectAgent follows redirects on status code 301.
Method test_redirect301Scheme client.RedirectAgent follows cross-scheme redirects.
Method test_redirect302 client.RedirectAgent follows redirects on status code 302.
Method test_redirect303 client.RedirectAgent changes the method to GET when getting a 303 redirect on a POST request.
Method test_redirect307 client.RedirectAgent follows redirects on status code 307.
Method test_redirect308 client.RedirectAgent follows redirects on status code 308.
Method test_redirectLimit If the limit of redirects specified to client.RedirectAgent is reached, the deferred fires with ResponseFailed error wrapping a InfiniteRedirection exception.
Method test_relativeURI client.RedirectAgent resolves and follows relative URIs in redirects, preserving query strings.
Method test_relativeURIPreserveFragments client.RedirectAgent resolves and follows relative URIs in redirects, preserving fragments in way that complies with the HTTP 1.1 bis draft.
Method test_relativeURISchemeRelative client.RedirectAgent resolves and follows scheme relative URIs in redirects, replacing the hostname and port when required.
Method test_responseHistory Response.response references the previous Response from a redirect, or None if there was no previous response.
Class Variable agent Undocumented
Class Variable protocol Undocumented
Class Variable reactor Undocumented
Method _sensitiveHeadersTest client.RedirectAgent scrubs sensitive headers when redirecting between differing origins.
Method _testPageRedirectFailure When getting a redirect on an unsupported request method, client.RedirectAgent fails with a ResponseFailed error wrapping a error.PageRedirect exception.
Method _testRedirectDefault When getting a redirect, client.RedirectAgent follows the URL specified in the Location header field and make a new request.
Method _testRedirectToGet client.RedirectAgent changes the method to GET when getting a redirect on a non-GET request.
Method _testRedirectURI When client.RedirectAgent encounters a relative redirect URI, it is resolved against the request URI before following the redirect.

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

When getting a 307 redirect on a POST request, client.RedirectAgent fails with a ResponseFailed error wrapping a error.PageRedirect exception.

def test_crossDomainHeaders(self): (source)

client.RedirectAgent scrubs sensitive headers when redirecting between differing domains.

def test_crossPortHeaders(self): (source)

client.RedirectAgent scrubs sensitive headers when redirecting between differing ports.

def test_crossSchemeHeaders(self): (source)

client.RedirectAgent scrubs sensitive headers when redirecting between differing schemes.

def test_noLocationField(self): (source)

If no Location header field is found when getting a redirect, client.RedirectAgent fails with a ResponseFailed error wrapping a error.RedirectWithNoLocation exception.

def test_noRedirect(self): (source)

client.RedirectAgent behaves like client.Agent if the response doesn't contain a redirect.

def test_redirect301(self): (source)

client.RedirectAgent follows redirects on status code 301.

def test_redirect301Scheme(self): (source)

client.RedirectAgent follows cross-scheme redirects.

def test_redirect302(self): (source)

client.RedirectAgent follows redirects on status code 302.

def test_redirect303(self): (source)

client.RedirectAgent changes the method to GET when getting a 303 redirect on a POST request.

def test_redirect307(self): (source)

client.RedirectAgent follows redirects on status code 307.

def test_redirect308(self): (source)

client.RedirectAgent follows redirects on status code 308.

def test_redirectLimit(self): (source)

If the limit of redirects specified to client.RedirectAgent is reached, the deferred fires with ResponseFailed error wrapping a InfiniteRedirection exception.

def test_relativeURI(self): (source)

client.RedirectAgent resolves and follows relative URIs in redirects, preserving query strings.

def test_relativeURIPreserveFragments(self): (source)

client.RedirectAgent resolves and follows relative URIs in redirects, preserving fragments in way that complies with the HTTP 1.1 bis draft.

See Also
https://tools.ietf.org/html/draft-ietf-httpbis-p2-semantics-22#section-7.1.2
def test_relativeURISchemeRelative(self): (source)

client.RedirectAgent resolves and follows scheme relative URIs in redirects, replacing the hostname and port when required.

def test_responseHistory(self): (source)

Response.response references the previous Response from a redirect, or None if there was no previous response.

agent: IAgent = (source)
overridden in twisted.web.test.test_agent.BrowserLikeRedirectAgentTests, twisted.web.test.test_agent.RedirectAgentTests

Undocumented

protocol: StubHTTPProtocol = (source)

Undocumented

reactor: MemoryReactorClock = (source)
overridden in twisted.web.test.test_agent.BrowserLikeRedirectAgentTests, twisted.web.test.test_agent.RedirectAgentTests

Undocumented

def _sensitiveHeadersTest(self, expectedHostHeader=b'example.com', **crossKwargs): (source)

client.RedirectAgent scrubs sensitive headers when redirecting between differing origins.

Parameters
expectedHostHeader:bytesUndocumented
**crossKwargs:boolUndocumented
def _testPageRedirectFailure(self, code, method): (source)

When getting a redirect on an unsupported request method, client.RedirectAgent fails with a ResponseFailed error wrapping a error.PageRedirect exception.

Parameters
codeHTTP status code.
methodHTTP request method.
def _testRedirectDefault(self, code, crossScheme=False, crossDomain=False, crossPort=False, requestHeaders=None): (source)

When getting a redirect, client.RedirectAgent follows the URL specified in the Location header field and make a new request.

Parameters
code:intHTTP status code.
crossScheme:boolUndocumented
crossDomain:boolUndocumented
crossPort:boolUndocumented
requestHeaders:Optional[Headers]Undocumented
Returns
RequestUndocumented
def _testRedirectToGet(self, code, method): (source)

client.RedirectAgent changes the method to GET when getting a redirect on a non-GET request.

Parameters
codeHTTP status code.
methodHTTP request method.
def _testRedirectURI(self, uri, location, finalURI): (source)

When client.RedirectAgent encounters a relative redirect URI, it is resolved against the request URI before following the redirect.

Parameters
uriRequest URI.
locationLocation header redirect URI.
finalURIExpected final URI.