class documentation

class ChunkedTransferEncodingTests(unittest.TestCase): (source)

View In Hierarchy

Tests for _ChunkedTransferDecoder, which turns a byte stream encoded using HTTP chunked Transfer-Encoding back into the original byte stream.

Method test_afterFinished _ChunkedTransferDecoder.dataReceived raises RuntimeError if it is called after it has seen the last chunk.
Method test_decoding _ChunkedTransferDecoder.dataReceived decodes chunked-encoded data and passes the result to the specified callback.
Method test_earlyConnectionLose _ChunkedTransferDecoder.noMoreData raises _DataLoss if it is called and the end of the last trailer has not yet been received.
Method test_empty _ChunkedTransferDecoder.dataReceived is robust against receiving a zero-length input.
Method test_extensions _ChunkedTransferDecoder.dataReceived disregards chunk-extension fields.
Method test_extensionsMalformed _ChunkedTransferDecoder.dataReceived raises _MalformedChunkedDataError when the chunk extension fields contain invalid characters.
Method test_extra _ChunkedTransferDecoder.dataReceived passes any bytes which come after the terminating zero-length chunk to the completion callback.
Method test_finish _ChunkedTransferDecoder.dataReceived interprets a zero-length chunk as the end of the chunked data stream and calls the completion callback.
Method test_finishedConnectionLose _ChunkedTransferDecoder.noMoreData does not raise any exception if it is called after the terminal zero length chunk is received.
Method test_long _ChunkedTransferDecoder.dataReceived delivers partial chunk data as soon as it is received.
Method test_malformedChunkEnd _ChunkedTransferDecoder.dataReceived raises _MalformedChunkedDataError when the chunk is followed by characters other than \r\n.
Method test_malformedChunkEndFinal _ChunkedTransferDecoder.dataReceived raises _MalformedChunkedDataError when the terminal zero-length chunk is followed by characters other than \r\n.
Method test_malformedChunkSize _ChunkedTransferDecoder.dataReceived raises _MalformedChunkedDataError when the chunk size can't be decoded as a base-16 integer.
Method test_malformedChunkSizeHex _ChunkedTransferDecoder.dataReceived raises _MalformedChunkedDataError when the chunk size is prefixed with "0x", as if it were a Python integer literal.
Method test_malformedChunkSizeNegative _ChunkedTransferDecoder.dataReceived raises _MalformedChunkedDataError when the chunk size is negative.
Method test_newlines _ChunkedTransferDecoder.dataReceived doesn't treat CR LF pairs embedded in chunk bodies specially.
Method test_oversizedChunkSizeLine _ChunkedTransferDecoder.dataReceived raises _MalformedChunkedDataError when the chunk size line exceeds 4 KiB. This applies even when the data has already been received and buffered so that behavior is consistent regardless of how bytes are framed.
Method test_oversizedChunkSizeLinePartial _ChunkedTransferDecoder.dataReceived raises _MalformedChunkedDataError when the amount of data buffered while looking for the end of the chunk size line exceeds 4 KiB so that buffering does not continue without bound.
Method test_reentrantFinishedNoMoreData _ChunkedTransferDecoder.noMoreData can be called from the finished callback without raising an exception.
Method test_short _ChunkedTransferDecoder.dataReceived decodes chunks broken up and delivered in multiple calls.

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 test_afterFinished(self): (source)

_ChunkedTransferDecoder.dataReceived raises RuntimeError if it is called after it has seen the last chunk.

def test_decoding(self): (source)

_ChunkedTransferDecoder.dataReceived decodes chunked-encoded data and passes the result to the specified callback.

def test_earlyConnectionLose(self): (source)

_ChunkedTransferDecoder.noMoreData raises _DataLoss if it is called and the end of the last trailer has not yet been received.

def test_empty(self): (source)

_ChunkedTransferDecoder.dataReceived is robust against receiving a zero-length input.

def test_extensions(self): (source)

_ChunkedTransferDecoder.dataReceived disregards chunk-extension fields.

def test_extensionsMalformed(self): (source)

_ChunkedTransferDecoder.dataReceived raises _MalformedChunkedDataError when the chunk extension fields contain invalid characters.

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

def test_extra(self): (source)

_ChunkedTransferDecoder.dataReceived passes any bytes which come after the terminating zero-length chunk to the completion callback.

def test_finish(self): (source)

_ChunkedTransferDecoder.dataReceived interprets a zero-length chunk as the end of the chunked data stream and calls the completion callback.

def test_finishedConnectionLose(self): (source)

_ChunkedTransferDecoder.noMoreData does not raise any exception if it is called after the terminal zero length chunk is received.

def test_long(self): (source)

_ChunkedTransferDecoder.dataReceived delivers partial chunk data as soon as it is received.

def test_malformedChunkEnd(self): (source)

_ChunkedTransferDecoder.dataReceived raises _MalformedChunkedDataError when the chunk is followed by characters other than \r\n.

def test_malformedChunkEndFinal(self): (source)

_ChunkedTransferDecoder.dataReceived raises _MalformedChunkedDataError when the terminal zero-length chunk is followed by characters other than \r\n.

def test_malformedChunkSize(self): (source)

_ChunkedTransferDecoder.dataReceived raises _MalformedChunkedDataError when the chunk size can't be decoded as a base-16 integer.

def test_malformedChunkSizeHex(self): (source)

_ChunkedTransferDecoder.dataReceived raises _MalformedChunkedDataError when the chunk size is prefixed with "0x", as if it were a Python integer literal.

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

def test_malformedChunkSizeNegative(self): (source)

_ChunkedTransferDecoder.dataReceived raises _MalformedChunkedDataError when the chunk size is negative.

def test_newlines(self): (source)

_ChunkedTransferDecoder.dataReceived doesn't treat CR LF pairs embedded in chunk bodies specially.

def test_oversizedChunkSizeLine(self): (source)

_ChunkedTransferDecoder.dataReceived raises _MalformedChunkedDataError when the chunk size line exceeds 4 KiB. This applies even when the data has already been received and buffered so that behavior is consistent regardless of how bytes are framed.

def test_oversizedChunkSizeLinePartial(self): (source)

_ChunkedTransferDecoder.dataReceived raises _MalformedChunkedDataError when the amount of data buffered while looking for the end of the chunk size line exceeds 4 KiB so that buffering does not continue without bound.

def test_reentrantFinishedNoMoreData(self): (source)

_ChunkedTransferDecoder.noMoreData can be called from the finished callback without raising an exception.

def test_short(self): (source)

_ChunkedTransferDecoder.dataReceived decodes chunks broken up and delivered in multiple calls.