twisted.web.test.test_http.ParsingTests

class documentation

class ParsingTests(unittest.TestCase): (source)

View In Hierarchy

Tests for protocol parsing in HTTPChannel.

Method assertRequestRejected Execute a HTTP request and assert that it is rejected with a 400 Bad Response and disconnection.
Method runRequest No summary
Method setUp Undocumented
Method test_basicAuth HTTPChannel provides username and password information supplied in an Authorization header to the Request which makes it available via its getUser and getPassword methods.
Method test_basicAuthException A Request that throws an exception processing basic authorization logs an error and uses an empty username and password.
Method test_chunkedEncoding If a request uses the chunked transfer encoding, the request body is decoded accordingly before it is made available on the request.
Method test_contentLengthAndTransferEncoding A request that includes both content-length and transfer-encoding headers fails with a 400 response without calling Request.process.
Method test_contentLengthAndTransferEncodingWithPipelinedRequests Two pipelined requests, the first of which includes both content-length and transfer-encoding headers, triggers a 400 response without calling Request.process.
Method test_contentLengthMalformed A request with a non-integer Content-Length header fails with a 400 response without calling Request.process.
Method test_contentLengthNegative A request with a Content-Length header that is negative fails with a 400 response without calling Request.process.
Method test_contentLengthTooPositive No summary
Method test_duplicateContentLengths A request which includes multiple content-length headers fails with a 400 response without calling Request.process.
Method test_duplicateContentLengthsWithPipelinedRequests Two pipelined requests, the first of which includes multiple content-length headers, trigger a 400 response without calling Request.process.
Method test_extraQuestionMark While only a single '?' is allowed in an URL, several other servers allow several and pass all after the first through as part of the query arguments. Test that we emulate this behavior.
Method test_formPOSTRequest The request body of a POST request with a Content-Type header of application/x-www-form-urlencoded is parsed according to that content type and made available in the args attribute of the request object...
Method test_headerLimitPerRequest HTTPChannel enforces the limit of HTTPChannel.maxHeaders per request so that headers received in an earlier request do not count towards the limit when processing a later request.
Method test_headers Headers received by HTTPChannel in a request are made available to the Request.
Method test_headersMultiline No summary
Method test_headersTooBigInitialCommand Enforces a limit of HTTPChannel.totalHeadersSize on the size of headers received per request starting from initial command line.
Method test_headersTooBigOtherHeaders Enforces a limit of HTTPChannel.totalHeadersSize on the size of headers received per request counting first line and total headers.
Method test_headersTooBigPerRequest Enforces total size of headers per individual request and counter is reset at the end of each request.
Method test_headerStripWhitespace Leading and trailing space and tab characters are stripped from headers. Other forms of whitespace are preserved.
Method test_invalidContentLengthHeader If a Content-Length header with a non-integer value is received, a 400 (Bad Request) response is sent to the client and the connection is closed.
Method test_invalidHeaderNoColon If a header without colon is received a 400 (Bad Request) response is sent to the client and the connection is closed.
Method test_invalidHeaderOnlyColon HTTPChannel rejects a request with an empty header name (i.e. nothing before the colon). It produces a 400 (Bad Request) response is generated and closes the connection.
Method test_invalidHeaderWhitespaceBeforeColon No summary
Method test_invalidNonAsciiMethod When client sends invalid HTTP method containing non-ascii characters HTTP 400 'Bad Request' status will be returned.
Method test_malformedChunkedEncoding If a request uses the chunked transfer encoding, but provides an invalid chunk length value, the request fails with a 400 error.
Method test_multipartEmptyHeaderProcessingFailure When the multipart does not contain a header is should be skipped
Method test_multipartFileData If the request has a Content-Type of multipart/form-data, and the form data is parseable and contains files, the file portions will be added to the request's args.
Method test_multipartFormData If the request has a Content-Type of multipart/form-data, and the form data is parseable, the form arguments will be added to the request's args.
Method test_multipartProcessingFailure When the multipart processing fails the client gets a 400 Bad Request.
Method test_tooManyHeaders HTTPChannel enforces a limit of HTTPChannel.maxHeaders on the number of headers received per request.
Method test_transferEncodingIdentity A request with a valid content-length and a transfer-encoding whose value is identity succeeds.
Method test_unknownTransferEncoding A request whose transfer-encoding header includes a value other than chunked or identity fails with a 400 response without calling Request.process.
Method testCookies Test cookies parsing and reading.
Method testGET Undocumented
Instance Variable didRequest 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.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 assertRequestRejected(self, requestLines): (source)

Execute a HTTP request and assert that it is rejected with a 400 Bad Response and disconnection.

Parameters
requestLines:list of bytesPlain text lines of the request. These lines will be joined with newlines to form the HTTP request that is processed.
def runRequest(self, httpRequest, requestFactory=None, success=True, channel=None): (source)
def setUp(self): (source)

Undocumented

def test_basicAuth(self): (source)

HTTPChannel provides username and password information supplied in an Authorization header to the Request which makes it available via its getUser and getPassword methods.

def test_basicAuthException(self): (source)

A Request that throws an exception processing basic authorization logs an error and uses an empty username and password.

def test_chunkedEncoding(self): (source)

If a request uses the chunked transfer encoding, the request body is decoded accordingly before it is made available on the request.

def test_contentLengthAndTransferEncoding(self): (source)

A request that includes both content-length and transfer-encoding headers fails with a 400 response without calling Request.process.

def test_contentLengthAndTransferEncodingWithPipelinedRequests(self): (source)

Two pipelined requests, the first of which includes both content-length and transfer-encoding headers, triggers a 400 response without calling Request.process.

def test_contentLengthMalformed(self): (source)

A request with a non-integer Content-Length header fails with a 400 response without calling Request.process.

def test_contentLengthNegative(self): (source)

A request with a Content-Length header that is negative fails with a 400 response without calling Request.process.

This is a potential request smuggling vector: see GHSA-c2jg-hw38-jrqq.

def test_contentLengthTooPositive(self): (source)
def test_duplicateContentLengths(self): (source)

A request which includes multiple content-length headers fails with a 400 response without calling Request.process.

def test_duplicateContentLengthsWithPipelinedRequests(self): (source)

Two pipelined requests, the first of which includes multiple content-length headers, trigger a 400 response without calling Request.process.

def test_extraQuestionMark(self): (source)

While only a single '?' is allowed in an URL, several other servers allow several and pass all after the first through as part of the query arguments. Test that we emulate this behavior.

def test_formPOSTRequest(self): (source)

The request body of a POST request with a Content-Type header of application/x-www-form-urlencoded is parsed according to that content type and made available in the args attribute of the request object. The original bytes of the request may still be read from the content attribute.

def test_headerLimitPerRequest(self): (source)

HTTPChannel enforces the limit of HTTPChannel.maxHeaders per request so that headers received in an earlier request do not count towards the limit when processing a later request.

def test_headers(self): (source)

Headers received by HTTPChannel in a request are made available to the Request.

def test_headersMultiline(self): (source)
def test_headersTooBigInitialCommand(self): (source)

Enforces a limit of HTTPChannel.totalHeadersSize on the size of headers received per request starting from initial command line.

def test_headersTooBigOtherHeaders(self): (source)

Enforces a limit of HTTPChannel.totalHeadersSize on the size of headers received per request counting first line and total headers.

def test_headersTooBigPerRequest(self): (source)

Enforces total size of headers per individual request and counter is reset at the end of each request.

def test_headerStripWhitespace(self): (source)

Leading and trailing space and tab characters are stripped from headers. Other forms of whitespace are preserved.

See RFC 7230 section 3.2.3 and 3.2.4.

def test_invalidContentLengthHeader(self): (source)

If a Content-Length header with a non-integer value is received, a 400 (Bad Request) response is sent to the client and the connection is closed.

def test_invalidHeaderNoColon(self): (source)

If a header without colon is received a 400 (Bad Request) response is sent to the client and the connection is closed.

def test_invalidHeaderOnlyColon(self): (source)

HTTPChannel rejects a request with an empty header name (i.e. nothing before the colon). It produces a 400 (Bad Request) response is generated and closes the connection.

def test_invalidHeaderWhitespaceBeforeColon(self): (source)
def test_invalidNonAsciiMethod(self): (source)

When client sends invalid HTTP method containing non-ascii characters HTTP 400 'Bad Request' status will be returned.

def test_malformedChunkedEncoding(self): (source)

If a request uses the chunked transfer encoding, but provides an invalid chunk length value, the request fails with a 400 error.

def test_multipartEmptyHeaderProcessingFailure(self): (source)

When the multipart does not contain a header is should be skipped

def test_multipartFileData(self): (source)

If the request has a Content-Type of multipart/form-data, and the form data is parseable and contains files, the file portions will be added to the request's args.

def test_multipartFormData(self): (source)

If the request has a Content-Type of multipart/form-data, and the form data is parseable, the form arguments will be added to the request's args.

def test_multipartProcessingFailure(self): (source)

When the multipart processing fails the client gets a 400 Bad Request.

def test_tooManyHeaders(self): (source)

HTTPChannel enforces a limit of HTTPChannel.maxHeaders on the number of headers received per request.

def test_transferEncodingIdentity(self): (source)

A request with a valid content-length and a transfer-encoding whose value is identity succeeds.

def test_unknownTransferEncoding(self): (source)

A request whose transfer-encoding header includes a value other than chunked or identity fails with a 400 response without calling Request.process.

def testCookies(self): (source)

Test cookies parsing and reading.

def testGET(self): (source)

Undocumented

didRequest: bool = (source)

Undocumented