twisted.web.test.test_newclient.HTTP11ClientProtocolTests

class documentation

class HTTP11ClientProtocolTests(TestCase): (source)

Tests for the HTTP 1.1 client protocol implementation, HTTP11ClientProtocol.

Method	`assertCancelDuringBodyProduction`	The `Deferred` returned by `HTTP11ClientProtocol.request` will fire with a `RequestGenerationFailed` failure containing a `CancelledError` exception if the request was cancelled before a `bodyProducer` has finished producing.
Method	`setUp`	Create an `HTTP11ClientProtocol` connected to a fake transport.
Method	`test_abortAfterConnectionLost`	`HTTP11ClientProtocol.abort` called after the connection is lost returns a `Deferred` that fires immediately.
Method	`test_abortAfterResponseHeaders`	When the connection is aborted after the response headers have been received and the `Response` has been made available to application code, the response body protocol's `connectionLost` method will be invoked with a ...
Method	`test_abortBeforeResponseBody`	The Deferred returned by `HTTP11ClientProtocol.request` will fire with a `ResponseFailed` failure containing a `ConnectionAborted` exception, if the connection was aborted before all response headers have been received.
Method	`test_abortClosesConnection`	`HTTP11ClientProtocol.abort` will tell the transport to close its connection when it is invoked, and returns a `Deferred` that fires when the connection is lost.
Method	`test_cancelBeforeResponse`	The `Deferred` returned by `HTTP11ClientProtocol.request` will fire with a `ResponseNeverReceived` failure containing a `CancelledError` exception if the request was cancelled before any response headers were received.
Method	`test_cancelDuringBodyProduction`	The `Deferred` returned by `HTTP11ClientProtocol.request` will fire with a `RequestGenerationFailed` failure containing a `CancelledError` exception if the request was cancelled before a `bodyProducer` with an explicit length has finished producing.
Method	`test_cancelDuringChunkedBodyProduction`	The `Deferred` returned by `HTTP11ClientProtocol.request` will fire with a `RequestGenerationFailed` failure containing a `CancelledError` exception if the request was cancelled before a `bodyProducer` with `UNKNOWN_LENGTH`...
Method	`test_cancelDuringResponse`	The `Deferred` returned by `HTTP11ClientProtocol.request` will fire with a `ResponseFailed` failure containing a `CancelledError` exception if the request was cancelled before all response headers were received.
Method	`test_chunkedResponseBodyUnfinishedWhenConnectionLost`	If the final chunk has not been received when the connection is lost (for any reason), the protocol passed to `deliverBody` has its `connectionLost` method called with a `Failure` wrapping the exception for that reason.
Method	`test_connectionLostAfterReceivingResponseBeforeRequestGenerationDone`	If response bytes are delivered to `HTTP11ClientProtocol` before the request completes, calling `connectionLost` on the protocol will result in protocol being moved to `'CONNECTION_LOST'` state.
Method	`test_connectionLostBeforeGenerationFailed`	If the request passed to `HTTP11ClientProtocol` finished generation with an error after the `HTTP11ClientProtocol`'s connection has been lost, nothing happens.
Method	`test_connectionLostBeforeGenerationFinished`	If the request passed to `HTTP11ClientProtocol` finishes generation successfully after the `HTTP11ClientProtocol`'s connection has been lost, nothing happens.
Method	`test_connectionLostDuringRequestGeneration`	If `HTTP11ClientProtocol`'s transport is disconnected before the `Deferred` returned by `Request.writeTo` fires, the `Deferred` returned by `HTTP11ClientProtocol.request` fires with a `Failure` of `RequestTransmissionFailed`...
Method	`test_errorMessageOnConnectionLostBeforeGenerationFailedDoesNotConfuse`	If the request passed to `HTTP11ClientProtocol` finished generation with an error after the `HTTP11ClientProtocol`'s connection has been lost, an error is logged that gives a non-confusing hint to user on what went wrong.
Method	`test_failedWriteTo`	If the `Deferred` returned by `Request.writeTo` fires with a `Failure`, `HTTP11ClientProtocol.request` disconnects its transport and returns a `Deferred` which fires with a `Failure` of `RequestGenerationFailed` wrapping the underlying failure.
Method	`test_parserDataReceivedException`	If the parser `HTTP11ClientProtocol` delivers bytes to in `dataReceived` raises an exception, the exception is wrapped in a `Failure` and passed to the parser's `connectionLost` and then the `HTTP11ClientProtocol`...
Method	`test_proxyStopped`	When the HTTP response parser is disconnected, the `TransportProxyProducer` which was connected to it as a transport is stopped.
Method	`test_quiescentCallbackCalled`	If after a response is done the {HTTP11ClientProtocol} stays open and returns to QUIESCENT state, all per-request state is reset and the `quiescentCallback` is called with the protocol instance.
Method	`test_quiescentCallbackCalledEmptyResponse`	The quiescentCallback is called before the request `Deferred` fires, in cases where the response has no body.
Method	`test_quiescentCallbackNotCalled`	If after a response is done the {HTTP11ClientProtocol} returns a `Connection: close` header in the response, the `quiescentCallback` is not called and the connection is lost.
Method	`test_quiescentCallbackNotCalledNonPersistentQuery`	If the request was non-persistent (i.e. sent `Connection: close`), the `quiescentCallback` is not called and the connection is lost.
Method	`test_quiescentCallbackThrows`	If `quiescentCallback` throws an exception, the error is logged and protocol is disconnected.
Method	`test_receiveResponseBeforeRequestGenerationDone`	If response bytes are delivered to `HTTP11ClientProtocol` before the `Deferred` returned by `Request.writeTo` fires, those response bytes are parsed as part of the response.
Method	`test_receiveResponseBody`	The `deliverBody` method of the response object with which the `Deferred` returned by `HTTP11ClientProtocol.request` fires can be used to get the body of the response.
Method	`test_receiveResponseHeaders`	The headers included in a response delivered to `HTTP11ClientProtocol` are included on the `Response` instance passed to the callback returned by the `request` method.
Method	`test_receiveResponseHeadersTooLong`	The connection is closed when the server respond with a header which is above the maximum line.
Method	`test_receiveSimplestResponse`	When a response is delivered to `HTTP11ClientProtocol`, the `Deferred` previously returned by the `request` method is called back with a `Response` instance and the connection is closed.
Method	`test_request`	`HTTP11ClientProtocol.request` accepts a `Request` and calls its `writeTo` method with its own transport.
Method	`test_requestAfterConnectionLost`	`HTTP11ClientProtocol.request` returns a `Deferred` which immediately fires with a `Failure` wrapping a `RequestNotSent` if called after the protocol has been disconnected.
Method	`test_responseBodyFinishedWhenConnectionLostWhenContentLengthIsUnknown`	If the length of the response body is unknown, the protocol passed to the response's `deliverBody` method has its `connectionLost` method called with a `Failure` wrapping a `PotentialDataLoss` exception.
Method	`test_secondRequest`	The second time `HTTP11ClientProtocol.request` is called, it returns a `Deferred` which immediately fires with a `Failure` wrapping a `RequestNotSent` exception.
Method	`test_synchronousWriteToError`	If `Request.writeTo` raises an exception, `HTTP11ClientProtocol.request` returns a `Deferred` which fires with a `Failure` of `RequestGenerationFailed` wrapping that exception.
Method	`test_transportProducingWhenQuiescentAfterFullBody`	The `quiescentCallback` passed to `HTTP11ClientProtocol` will only be invoked once that protocol is in a state similar to its initial state. One of the aspects of this initial state is the producer-state of its transport; an ...
Instance Variable	`protocol`	Undocumented
Instance Variable	`transport`	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	`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.Deferred`s. 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 assertCancelDuringBodyProduction(self, producerLength): (source) ¶

The Deferred returned by HTTP11ClientProtocol.request will fire with a RequestGenerationFailed failure containing a CancelledError exception if the request was cancelled before a bodyProducer has finished producing.

def setUp(self): (source) ¶

Create an HTTP11ClientProtocol connected to a fake transport.

def test_abortAfterConnectionLost(self): (source) ¶

HTTP11ClientProtocol.abort called after the connection is lost returns a Deferred that fires immediately.

def test_abortAfterResponseHeaders(self): (source) ¶

When the connection is aborted after the response headers have been received and the Response has been made available to application code, the response body protocol's connectionLost method will be invoked with a ResponseFailed failure containing a ConnectionAborted exception.

def test_abortBeforeResponseBody(self): (source) ¶

The Deferred returned by HTTP11ClientProtocol.request will fire with a ResponseFailed failure containing a ConnectionAborted exception, if the connection was aborted before all response headers have been received.

def test_abortClosesConnection(self): (source) ¶

HTTP11ClientProtocol.abort will tell the transport to close its connection when it is invoked, and returns a Deferred that fires when the connection is lost.

def test_cancelBeforeResponse(self): (source) ¶

The Deferred returned by HTTP11ClientProtocol.request will fire with a ResponseNeverReceived failure containing a CancelledError exception if the request was cancelled before any response headers were received.

def test_cancelDuringBodyProduction(self): (source) ¶

def test_cancelDuringChunkedBodyProduction(self): (source) ¶

def test_cancelDuringResponse(self): (source) ¶

The Deferred returned by HTTP11ClientProtocol.request will fire with a ResponseFailed failure containing a CancelledError exception if the request was cancelled before all response headers were received.

def test_chunkedResponseBodyUnfinishedWhenConnectionLost(self): (source) ¶

If the final chunk has not been received when the connection is lost (for any reason), the protocol passed to deliverBody has its connectionLost method called with a Failure wrapping the exception for that reason.

def test_connectionLostAfterReceivingResponseBeforeRequestGenerationDone(self): (source) ¶

If response bytes are delivered to HTTP11ClientProtocol before the request completes, calling connectionLost on the protocol will result in protocol being moved to 'CONNECTION_LOST' state.

def test_connectionLostBeforeGenerationFailed(self): (source) ¶

If the request passed to HTTP11ClientProtocol finished generation with an error after the HTTP11ClientProtocol's connection has been lost, nothing happens.

def test_connectionLostBeforeGenerationFinished(self): (source) ¶

If the request passed to HTTP11ClientProtocol finishes generation successfully after the HTTP11ClientProtocol's connection has been lost, nothing happens.

def test_connectionLostDuringRequestGeneration(self, mode=None): (source) ¶

If HTTP11ClientProtocol's transport is disconnected before the Deferred returned by Request.writeTo fires, the Deferred returned by HTTP11ClientProtocol.request fires with a Failure of RequestTransmissionFailed wrapping the underlying failure.

def test_errorMessageOnConnectionLostBeforeGenerationFailedDoesNotConfuse(self): (source) ¶

If the request passed to HTTP11ClientProtocol finished generation with an error after the HTTP11ClientProtocol's connection has been lost, an error is logged that gives a non-confusing hint to user on what went wrong.

def test_failedWriteTo(self): (source) ¶

If the Deferred returned by Request.writeTo fires with a Failure, HTTP11ClientProtocol.request disconnects its transport and returns a Deferred which fires with a Failure of RequestGenerationFailed wrapping the underlying failure.

def test_parserDataReceivedException(self): (source) ¶

If the parser HTTP11ClientProtocol delivers bytes to in dataReceived raises an exception, the exception is wrapped in a Failure and passed to the parser's connectionLost and then the HTTP11ClientProtocol's transport is disconnected.

def test_proxyStopped(self): (source) ¶

When the HTTP response parser is disconnected, the TransportProxyProducer which was connected to it as a transport is stopped.

def test_quiescentCallbackCalled(self): (source) ¶

If after a response is done the {HTTP11ClientProtocol} stays open and returns to QUIESCENT state, all per-request state is reset and the quiescentCallback is called with the protocol instance.

This is useful for implementing a persistent connection pool.

The quiescentCallback is called *before* the response-receiving protocol's connectionLost, so that new requests triggered by end of first request can re-use a persistent connection.

def test_quiescentCallbackCalledEmptyResponse(self): (source) ¶

The quiescentCallback is called before the request Deferred fires, in cases where the response has no body.

def test_quiescentCallbackNotCalled(self): (source) ¶

If after a response is done the {HTTP11ClientProtocol} returns a Connection: close header in the response, the quiescentCallback is not called and the connection is lost.

def test_quiescentCallbackNotCalledNonPersistentQuery(self): (source) ¶

If the request was non-persistent (i.e. sent Connection: close), the quiescentCallback is not called and the connection is lost.

def test_quiescentCallbackThrows(self): (source) ¶

If quiescentCallback throws an exception, the error is logged and protocol is disconnected.

def test_receiveResponseBeforeRequestGenerationDone(self): (source) ¶

If response bytes are delivered to HTTP11ClientProtocol before the Deferred returned by Request.writeTo fires, those response bytes are parsed as part of the response.

The connection is also closed, because we're in a confusing state, and therefore the quiescentCallback isn't called.

def test_receiveResponseBody(self): (source) ¶

The deliverBody method of the response object with which the Deferred returned by HTTP11ClientProtocol.request fires can be used to get the body of the response.

def test_receiveResponseHeaders(self): (source) ¶

The headers included in a response delivered to HTTP11ClientProtocol are included on the Response instance passed to the callback returned by the request method.

def test_receiveResponseHeadersTooLong(self): (source) ¶

The connection is closed when the server respond with a header which is above the maximum line.

def test_receiveSimplestResponse(self): (source) ¶

When a response is delivered to HTTP11ClientProtocol, the Deferred previously returned by the request method is called back with a Response instance and the connection is closed.

def test_request(self): (source) ¶

HTTP11ClientProtocol.request accepts a Request and calls its writeTo method with its own transport.

def test_requestAfterConnectionLost(self): (source) ¶

HTTP11ClientProtocol.request returns a Deferred which immediately fires with a Failure wrapping a RequestNotSent if called after the protocol has been disconnected.

def test_responseBodyFinishedWhenConnectionLostWhenContentLengthIsUnknown(self): (source) ¶

If the length of the response body is unknown, the protocol passed to the response's deliverBody method has its connectionLost method called with a Failure wrapping a PotentialDataLoss exception.

def test_secondRequest(self): (source) ¶

The second time HTTP11ClientProtocol.request is called, it returns a Deferred which immediately fires with a Failure wrapping a RequestNotSent exception.

def test_synchronousWriteToError(self): (source) ¶

If Request.writeTo raises an exception, HTTP11ClientProtocol.request returns a Deferred which fires with a Failure of RequestGenerationFailed wrapping that exception.

def test_transportProducingWhenQuiescentAfterFullBody(self): (source) ¶

The quiescentCallback passed to HTTP11ClientProtocol will only be invoked once that protocol is in a state similar to its initial state. One of the aspects of this initial state is the producer-state of its transport; an HTTP11ClientProtocol begins with a transport that is producing, i.e. not pauseProducing'd.

Therefore, when quiescentCallback is invoked the protocol will still be producing.

protocol = (source) ¶

Undocumented

transport = (source) ¶

Undocumented