twisted.web.test.test_newclient.RequestTests

Tests for Request.

Method	setUp	Undocumented
Method	test_sendSimplestRequest	`Request.writeTo` formats the request data and writes it to the given transport.
Method	test_sendSimplestPersistentRequest	A pesistent request does not send 'Connection: close' header.
Method	test_sendRequestHeaders	`Request.writeTo` formats header data and writes it to the given transport.
Method	test_sanitizeLinearWhitespaceInRequestHeaders	Linear whitespace in request headers is replaced with a single space.
Method	test_sendChunkedRequestBody	`Request.writeTo` uses chunked encoding to write data from the request body producer to the given transport. It registers the request body producer with the transport.
Method	test_sendChunkedRequestBodyWithError	No summary
Method	test_sendRequestBodyWithLength	If `Request` is created with a `bodyProducer` with a known length, that length is sent as the value for the Content-Length header and chunked encoding is not used.
Method	test_sendPUTRequestEmptyBody	If PUT `Request` is created without a `bodyProducer`, Content-Length: 0 is included in the header and chunked encoding is not used.
Method	test_sendPOSTRequestEmptyBody	If POST `Request` is created without a `bodyProducer`, Content-Length: 0 is included in the header and chunked encoding is not used.
Method	test_sendRequestBodyWithTooFewBytes	No summary
Method	test_sendRequestBodyWithTooManyBytes	No summary
Method	test_sendRequestBodyErrorWithTooManyBytes	No summary
Method	test_sendRequestBodyErrorWithConsumerError	No summary
Method	test_sendRequestBodyFinishedEarlyThenTooManyBytes	No summary
Method	test_sendRequestBodyErroredEarlyThenTooManyBytes	No summary
Method	test_sendChunkedRequestBodyFinishedThenWriteMore	No summary
Method	test_sendChunkedRequestBodyFinishedWithErrorThenWriteMore	No summary
Method	test_sendRequestBodyWithError	No summary
Method	test_hostHeaderRequired	`Request.writeTo` raises `BadHeaders` if there is not exactly one Host header and writes nothing to the given transport.
Method	test_stopWriting	`Request.stopWriting` calls its body producer's `stopProducing` method.
Method	test_brokenStopProducing	If the body producer's `stopProducing` method raises an exception, `Request.stopWriting` logs it and does not re-raise it.
Method	_sendRequestEmptyBodyWithLength	Verify that the message generated by a `Request` initialized with the given method and `None` as the `bodyProducer` includes Content-Length: 0 in the header.
Method	_sendRequestBodyWithTooManyBytesTest	No summary
Method	_sendRequestBodyFinishedEarlyThenTooManyBytes	No summary

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.Deferred`s. 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):

Undocumented

def test_sendSimplestRequest(self):

Request.writeTo formats the request data and writes it to the given transport.

def test_sendSimplestPersistentRequest(self):

A pesistent request does not send 'Connection: close' header.

def test_sendRequestHeaders(self):

Request.writeTo formats header data and writes it to the given transport.

def test_sanitizeLinearWhitespaceInRequestHeaders(self):

Linear whitespace in request headers is replaced with a single space.

def test_sendChunkedRequestBody(self):

Request.writeTo uses chunked encoding to write data from the request body producer to the given transport. It registers the request body producer with the transport.

def test_sendChunkedRequestBodyWithError(self):

If Request is created with a bodyProducer without a known length and the Deferred returned from its startProducing method fires with a Failure, the Deferred returned by Request.writeTo fires with that Failure and the body producer is unregistered from the transport. The final zero-length chunk is not written to the transport.

def test_sendRequestBodyWithLength(self):

If Request is created with a bodyProducer with a known length, that length is sent as the value for the Content-Length header and chunked encoding is not used.

def _sendRequestEmptyBodyWithLength(self, method):

Verify that the message generated by a Request initialized with the given method and None as the bodyProducer includes Content-Length: 0 in the header.

Parameters method The HTTP method issue in the request. (type: bytes)

def test_sendPUTRequestEmptyBody(self):

If PUT Request is created without a bodyProducer, Content-Length: 0 is included in the header and chunked encoding is not used.

def test_sendPOSTRequestEmptyBody(self):

If POST Request is created without a bodyProducer, Content-Length: 0 is included in the header and chunked encoding is not used.

def test_sendRequestBodyWithTooFewBytes(self):

If Request is created with a bodyProducer with a known length and the producer does not produce that many bytes, the Deferred returned by Request.writeTo fires with a Failure wrapping a WrongBodyLength exception.

def _sendRequestBodyWithTooManyBytesTest(self, finisher):

Verify that when too many bytes have been written by a body producer and then the body producer's startProducing Deferred fires that the producer is unregistered from the transport and that the Deferred returned from Request.writeTo is fired with a Failure wrapping a WrongBodyLength.

Parameters finisher A callable which will be invoked with the body producer after too many bytes have been written to the transport. It should fire the startProducing Deferred somehow.

def test_sendRequestBodyWithTooManyBytes(self):

If Request is created with a bodyProducer with a known length and the producer tries to produce more than than many bytes, the Deferred returned by Request.writeTo fires with a Failure wrapping a WrongBodyLength exception.

def test_sendRequestBodyErrorWithTooManyBytes(self):

def test_sendRequestBodyErrorWithConsumerError(self):

Though there should be no way for the internal finishedConsuming Deferred in Request._writeToBodyProducerContentLength to fire a Failure after the finishedProducing Deferred has fired, in case this does happen, the error should be logged with a message about how there's probably a bug in Request.

This is a whitebox test.

def _sendRequestBodyFinishedEarlyThenTooManyBytes(self, finisher):

Verify that if the body producer fires its Deferred and then keeps writing to the consumer that the extra writes are ignored and the Deferred returned by Request.writeTo fires with a Failure wrapping the most appropriate exception type.

def test_sendRequestBodyFinishedEarlyThenTooManyBytes(self):

If the request body producer indicates it is done by firing the Deferred returned from its startProducing method but then goes on to write too many bytes, the Deferred returned by {Request.writeTo} fires with a Failure wrapping WrongBodyLength.

def test_sendRequestBodyErroredEarlyThenTooManyBytes(self):

If the request body producer indicates an error by firing the Deferred returned from its startProducing method but then goes on to write too many bytes, the Deferred returned by {Request.writeTo} fires with that Failure and WrongBodyLength is logged.

def test_sendChunkedRequestBodyFinishedThenWriteMore(self, _with=None):

If the request body producer with an unknown length tries to write after firing the Deferred returned by its startProducing method, the write call raises an exception and does not write anything to the underlying transport.

def test_sendChunkedRequestBodyFinishedWithErrorThenWriteMore(self):

If the request body producer with an unknown length tries to write after firing the Deferred returned by its startProducing method with a Failure, the write call raises an exception and does not write anything to the underlying transport.

def test_sendRequestBodyWithError(self):

If the Deferred returned from the startProducing method of the IBodyProducer passed to Request fires with a Failure, the Deferred returned from Request.writeTo fails with that Failure.

def test_hostHeaderRequired(self):

Request.writeTo raises BadHeaders if there is not exactly one Host header and writes nothing to the given transport.

def test_stopWriting(self):

Request.stopWriting calls its body producer's stopProducing method.

def test_brokenStopProducing(self):

If the body producer's stopProducing method raises an exception, Request.stopWriting logs it and does not re-raise it.

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

twisted.web.test.test_newclient.RequestTests(TestCase) class documentation

`twisted.web.test.test_newclient.RequestTests(TestCase)` class documentation