twisted.web.test.test_agent.AgentTests(TestCase, FakeReactorAndConnectMixin, AgentTestsMixin, IntegrationTestingMixin) class documentation

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

Tests for the new HTTP client API provided by Agent.

Method makeAgent
Method setUp Create an Agent wrapped around a fake reactor.
Method test_defaultPool If no pool is passed in, the Agent creates a non-persistent pool.
Method test_persistent If persistent is set to True on the HTTPConnectionPool (the default), Requests are created with their persistent flag set to True.
Method test_nonPersistent If persistent is set to False when creating the HTTPConnectionPool, Requests are created with their persistent flag set to False.
Method test_connectUsesConnectionPool When a connection is made by the Agent, it uses its pool's getConnection method to do so, with the endpoint returned by self._getEndpoint. The key used is (scheme, host, port).
Method test_nonBytesMethod Agent.request raises TypeError when the method argument isn't bytes.
Method test_unsupportedScheme Agent.request returns a Deferred which fails with SchemeNotSupported if the scheme of the URI passed to it is not 'http'.
Method test_connectionFailed The Deferred returned by Agent.request fires with a Failure if the TCP connection attempt fails.
Method test_connectHTTP Agent._getEndpoint return a HostnameEndpoint when passed a scheme of 'http'.
Method test_nonDecodableURI Agent._getEndpoint when given a non-ASCII decodable URI will raise a ValueError saying such.
Method test_hostProvided If None is passed to Agent.request for the headers parameter, a Headers instance is created for the request and a Host header added to it.
Method test_hostIPv6Bracketed If an IPv6 address is used in the uri passed to Agent.request, the computed Host header needs to be bracketed.
Method test_hostOverride If the headers passed to Agent.request includes a value for the Host header, that value takes precedence over the one which would otherwise be automatically provided.
Method test_headersUnmodified If a Host header must be added to the request, the Headers instance passed to Agent.request is not modified.
Method test_hostValueStandardHTTP When passed a scheme of 'http' and a port of 80, Agent._computeHostValue returns a string giving just the host name passed to it.
Method test_hostValueNonStandardHTTP When passed a scheme of 'http' and a port other than 80, Agent._computeHostValue returns a string giving the host passed to it joined together with the port number by ":".
Method test_hostValueStandardHTTPS When passed a scheme of 'https' and a port of 443, Agent._computeHostValue returns a string giving just the host name passed to it.
Method test_hostValueNonStandardHTTPS When passed a scheme of 'https' and a port other than 443, Agent._computeHostValue returns a string giving the host passed to it joined together with the port number by ":".
Method test_request No summary
Method test_connectTimeout Agent takes a connectTimeout argument which is forwarded to the following connectTCP agent.
Method test_connectTimeoutHTTPS Agent takes a connectTimeout argument which is forwarded to the following connectTCP call.
Method test_bindAddress Agent takes a bindAddress argument which is forwarded to the following connectTCP call.
Method test_bindAddressSSL Agent takes a bindAddress argument which is forwarded to the following connectSSL call.
Method test_responseIncludesRequest Responses returned by Agent.request have a reference to the Request that was originally issued.
Method test_requestAbsoluteURI Request.absoluteURI is the absolute URI of the request.
Method test_requestMissingAbsoluteURI Request.absoluteURI is None if Request._parsedURI is None.
Method test_endpointFactory Agent.usingEndpointFactory creates an Agent that uses the given factory to create endpoints.
Method test_endpointFactoryDefaultPool If no pool is passed in to Agent.usingEndpointFactory, a default pool is constructed with no persistent connections.
Method test_endpointFactoryPool If a pool is passed in to Agent.usingEndpointFactory it is used as the Agent pool.

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.

Inherited from FakeReactorAndConnectMixin:

Method createReactor Create a MemoryReactorClock and give it some hostnames it can resolve.
Class StubEndpoint Endpoint that wraps existing endpoint, substitutes StubHTTPProtocol, and resulting protocol instances are attached to the given test case.
Method buildAgentForWrapperTest Return an Agent suitable for use in tests that wrap the Agent and want both a fake reactor and StubHTTPProtocol.
Method connect Fake implementation of an endpoint which synchronously succeeds with an instance of StubHTTPProtocol for ease of testing.

Inherited from AgentTestsMixin:

Method test_interface The agent object provides IAgent.

Inherited from IntegrationTestingMixin:

Method test_integrationTestIPv4 Agent works over IPv4.
Method test_integrationTestIPv4Address Agent works over IPv4 when hostname is an IPv4 address.
Method test_integrationTestIPv6 Agent works over IPv6.
Method test_integrationTestIPv6Address Agent works over IPv6 when hostname is an IPv6 address.
Method integrationTest Agent will make a TCP connection, send an HTTP request, and return a Deferred that fires when the response has been received.
def makeAgent(self):
Returnsa new twisted.web.client.Agent instance
def setUp(self):

Create an Agent wrapped around a fake reactor.

def test_defaultPool(self):

If no pool is passed in, the Agent creates a non-persistent pool.

def test_persistent(self):

If persistent is set to True on the HTTPConnectionPool (the default), Requests are created with their persistent flag set to True.

def test_nonPersistent(self):

If persistent is set to False when creating the HTTPConnectionPool, Requests are created with their persistent flag set to False.

Elsewhere in the tests for the underlying HTTP code we ensure that this will result in the disconnection of the HTTP protocol once the request is done, so that the connection will not be returned to the pool.

def test_connectUsesConnectionPool(self):

When a connection is made by the Agent, it uses its pool's getConnection method to do so, with the endpoint returned by self._getEndpoint. The key used is (scheme, host, port).

def test_nonBytesMethod(self):

Agent.request raises TypeError when the method argument isn't bytes.

def test_unsupportedScheme(self):

Agent.request returns a Deferred which fails with SchemeNotSupported if the scheme of the URI passed to it is not 'http'.

def test_connectionFailed(self):

The Deferred returned by Agent.request fires with a Failure if the TCP connection attempt fails.

def test_connectHTTP(self):

Agent._getEndpoint return a HostnameEndpoint when passed a scheme of 'http'.

def test_nonDecodableURI(self):

Agent._getEndpoint when given a non-ASCII decodable URI will raise a ValueError saying such.

def test_hostProvided(self):

If None is passed to Agent.request for the headers parameter, a Headers instance is created for the request and a Host header added to it.

def test_hostIPv6Bracketed(self):

If an IPv6 address is used in the uri passed to Agent.request, the computed Host header needs to be bracketed.

def test_hostOverride(self):

If the headers passed to Agent.request includes a value for the Host header, that value takes precedence over the one which would otherwise be automatically provided.

def test_headersUnmodified(self):

If a Host header must be added to the request, the Headers instance passed to Agent.request is not modified.

def test_hostValueStandardHTTP(self):

When passed a scheme of 'http' and a port of 80, Agent._computeHostValue returns a string giving just the host name passed to it.

def test_hostValueNonStandardHTTP(self):

When passed a scheme of 'http' and a port other than 80, Agent._computeHostValue returns a string giving the host passed to it joined together with the port number by ":".

def test_hostValueStandardHTTPS(self):

When passed a scheme of 'https' and a port of 443, Agent._computeHostValue returns a string giving just the host name passed to it.

def test_hostValueNonStandardHTTPS(self):

When passed a scheme of 'https' and a port other than 443, Agent._computeHostValue returns a string giving the host passed to it joined together with the port number by ":".

def test_request(self):

Agent.request establishes a new connection to the host indicated by the host part of the URI passed to it and issues a request using the method, the path portion of the URI, the headers, and the body producer passed to it. It returns a Deferred which fires with an IResponse from the server.

def test_connectTimeout(self):

Agent takes a connectTimeout argument which is forwarded to the following connectTCP agent.

def test_connectTimeoutHTTPS(self):

Agent takes a connectTimeout argument which is forwarded to the following connectTCP call.

def test_bindAddress(self):

Agent takes a bindAddress argument which is forwarded to the following connectTCP call.

def test_bindAddressSSL(self):

Agent takes a bindAddress argument which is forwarded to the following connectSSL call.

def test_responseIncludesRequest(self):

Responses returned by Agent.request have a reference to the Request that was originally issued.

def test_requestAbsoluteURI(self):

Request.absoluteURI is the absolute URI of the request.

def test_requestMissingAbsoluteURI(self):

Request.absoluteURI is None if Request._parsedURI is None.

def test_endpointFactory(self):

Agent.usingEndpointFactory creates an Agent that uses the given factory to create endpoints.

def test_endpointFactoryDefaultPool(self):

If no pool is passed in to Agent.usingEndpointFactory, a default pool is constructed with no persistent connections.

def test_endpointFactoryPool(self):

If a pool is passed in to Agent.usingEndpointFactory it is used as the Agent pool.

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