class AgentTests(TestCase, FakeReactorAndConnectMixin, AgentTestsMixin, IntegrationTestingMixin): (source)
Tests for the new HTTP client API provided by Agent
.
Method | make |
No summary |
Method | set |
Create an Agent wrapped around a fake reactor. |
Method | test_bind |
Agent takes a bindAddress argument which is forwarded to the following connectTCP call. |
Method | test_bind |
Agent takes a bindAddress argument which is forwarded to the following connectSSL call. |
Method | test_connect |
Agent._getEndpoint return a HostnameEndpoint when passed a scheme of 'http'. |
Method | test_connection |
The Deferred returned by Agent.request fires with a Failure if the TCP connection attempt fails. |
Method | test_connect |
Agent takes a connectTimeout argument which is forwarded to the following connectTCP agent. |
Method | test_connect |
Agent takes a connectTimeout argument which is forwarded to the following connectTCP call. |
Method | test_connect |
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_default |
If no pool is passed in, the Agent creates a non-persistent pool. |
Method | test_endpoint |
Agent.usingEndpointFactory creates an Agent that uses the given factory to create endpoints. |
Method | test_endpoint |
If no pool is passed in to Agent.usingEndpointFactory , a default pool is constructed with no persistent connections. |
Method | test_endpoint |
If a pool is passed in to Agent.usingEndpointFactory it is used as the Agent pool. |
Method | test_headers |
If a Host header must be added to the request, the Headers instance passed to Agent.request is not modified. |
Method | test_host |
If an IPv6 address is used in the uri passed to Agent.request , the computed Host header needs to be bracketed. |
Method | test_host |
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_host |
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_host |
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_host |
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_host |
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_host |
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_non |
Agent.request raises TypeError when the method argument isn't bytes . |
Method | test_non |
Agent._getEndpoint when given a non-ASCII decodable URI will raise a ValueError saying such. |
Method | test_non |
If persistent is set to False when creating the HTTPConnectionPool , Requests are created with their persistent flag set to False. |
Method | test |
If persistent is set to True on the HTTPConnectionPool (the default), Requests are created with their persistent flag set to True. |
Method | test |
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... |
Method | test_request |
Request.absoluteURI is the absolute URI of the request. |
Method | test_request |
Request.absoluteURI is None if Request._parsedURI is None . |
Method | test_response |
Response s returned by Agent.request have a reference to the Request that was originally issued. |
Method | test_unsupported |
Agent.request returns a Deferred which fails with SchemeNotSupported if the scheme of the URI passed to it is not 'http'. |
Instance Variable | agent |
Undocumented |
Instance Variable | reactor |
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 | add |
Extend the base cleanup feature with support for cleanup functions which return Deferreds. |
Method | assert |
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 | defer |
Run any scheduled cleanups and report errors (if any) to the result. object. |
Method | defer |
Undocumented |
Method | defer |
Undocumented |
Method | defer |
Undocumented |
Method | get |
Undocumented |
Method | get |
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 | _cb |
Undocumented |
Method | _class |
Undocumented |
Method | _clean |
Undocumented |
Method | _deprecate |
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 | _eb |
Undocumented |
Method | _eb |
Undocumented |
Method | _eb |
Undocumented |
Method | _make |
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 | _run |
Really run setUp, the test method, and tearDown. Any of these may return defer.Deferred s. After they complete, do some reactor cleanup. |
Method | _undeprecate |
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 | _reactor |
Undocumented |
Instance Variable | _timed |
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 | call |
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 | flush |
Remove stored errors received from the log. |
Method | flush |
Remove stored warnings from the list of captured warnings and return them. |
Method | get |
Retrieve a module attribute which should have been deprecated, and assert that we saw the appropriate deprecation warning. |
Method | get |
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 | get |
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 | run |
If no methodName argument is passed to the constructor, run will treat this method as the thing with the actual test inside. |
Method | short |
Undocumented |
Instance Variable | failure |
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 | _get |
Return the reason to use for skipping a test method. |
Method | _get |
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 | _install |
Undocumented |
Method | _remove |
Undocumented |
Method | _run |
Synchronously run any cleanups which have been added. |
Instance Variable | _cleanups |
Undocumented |
Instance Variable | _observer |
Undocumented |
Instance Variable | _parents |
Undocumented |
Instance Variable | _test |
Undocumented |
Instance Variable | _warnings |
Undocumented |
Inherited from _Assertions
(via TestCase
, SynchronousTestCase
):
Method | assert |
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 | assert |
Fail if first - second > tolerance |
Method | assert |
Fail the test if first and second are not equal. |
Method | assert |
Fail the test if condition evaluates to True. |
Method | assert |
Fail the test if containee is not found in container. |
Method | assert |
Fail the test if first is not second. This is an obect-identity-equality test, not an object equality (i.e. __eq__) test. |
Method | assert |
Fail if instance is not an instance of the given class or of one of the given classes. |
Method | assert |
Fail the test if first is second. This is an obect-identity-equality test, not an object equality (i.e. __eq__) test. |
Method | assert |
Assert that deferred does not have a result at this point. |
Method | assert |
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 | assert |
Fail the test if first == second. |
Method | assert |
Fail the test if containee is found in container. |
Method | assert |
Fail if instance is an instance of the given class or of one of the given classes. |
Method | assert |
Fail if astring contains substring. |
Method | assert |
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 | assert |
Fail if substring does not exist within astring. |
Method | assert |
Fail the test if condition evaluates to False. |
Method | assert |
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 | failure |
Return the current failure result of deferred or raise self.failureException. |
Method | success |
Return the current success result of deferred or raise self.failureException. |
Inherited from FakeReactorAndConnectMixin
(via TestCase
, SynchronousTestCase
, _Assertions
):
Class |
|
Endpoint that wraps existing endpoint, substitutes StubHTTPProtocol, and resulting protocol instances are attached to the given test case. |
Method | build |
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. |
Method | create |
Create a MemoryReactorClock and give it some hostnames it can resolve. |
Instance Variable | protocol |
Undocumented |
Inherited from AgentTestsMixin
(via TestCase
, SynchronousTestCase
, _Assertions
, FakeReactorAndConnectMixin
):
Method | test |
The agent object provides IAgent . |
Inherited from IntegrationTestingMixin
(via TestCase
, SynchronousTestCase
, _Assertions
, FakeReactorAndConnectMixin
, AgentTestsMixin
):
Method | integration |
Agent will make a TCP connection, send an HTTP request, and return a Deferred that fires when the response has been received. |
Method | test_integration |
Agent works over IPv4. |
Method | test_integration |
Agent works over IPv4 when hostname is an IPv4 address. |
Method | test_integration |
Agent works over IPv6. |
Method | test_integration |
Agent works over IPv6 when hostname is an IPv6 address. |
def test_bindAddressSSL(self): (source) ¶
Agent
takes a bindAddress argument which is forwarded to the following connectSSL call.
def test_connectTimeoutHTTPS(self): (source) ¶
Agent
takes a connectTimeout argument which is forwarded to the following connectTCP call.
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).
If no pool is passed in to Agent.usingEndpointFactory
, a default pool is constructed with no persistent connections.
If a Host header must be added to the request, the Headers
instance passed to Agent.request
is not modified.
If an IPv6 address is used in the uri passed to Agent.request
, the computed Host header needs to be bracketed.
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.
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.
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 ":".
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 ":".
When passed a scheme of 'http' and a port of 80, Agent._computeHostValue
returns a string giving just the host name passed to it.
When passed a scheme of 'https' and a port of 443, Agent._computeHostValue
returns a string giving just the host name passed to it.
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.
If persistent is set to True on the HTTPConnectionPool
(the default), Requests are created with their persistent flag set to True.
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.
Agent.request
returns a Deferred
which fails with SchemeNotSupported
if the scheme of the URI passed to it is not 'http'.