twisted.web.test.test_static.RangeTests(TestCase) class documentation

Part of twisted.web.test.test_static (View In Hierarchy)

Tests for Range-Header support in twisted.web.static.File.

Instance Variable file Temporary (binary) file containing the content to be served. (type: file)
Instance Variable resource A leaf web resource using file as content. (type: static.File)
Instance Variable request A fake request, requesting resource. (type: DummyRequest)
Instance Variable catcher List which gathers all log information. (type: list)
Method setUp No summary
Method tearDown Clean up the resource file and the log observer.
Method test_invalidRanges File._parseRangeHeader raises ValueError when passed syntactically invalid byte ranges.
Method test_rangeMissingStop A single bytes range without an explicit stop position is parsed into a two-tuple giving the start position and None.
Method test_rangeMissingStart A single bytes range without an explicit start position is parsed into a two-tuple of None and the end position.
Method test_range A single bytes range with explicit start and stop positions is parsed into a two-tuple of those positions.
Method test_rangeWithSpace A single bytes range with whitespace in allowed places is parsed in the same way as it would be without the whitespace.
Method test_nullRangeElements If there are multiple byte ranges but only one is non-null, the non-null range is parsed and its start and stop returned.
Method test_multipleRanges If multiple byte ranges are specified their starts and stops are returned.
Method test_bodyLength A correct response to a range request is as long as the length of the requested range.
Method test_invalidRangeRequest No summary
Method parseMultipartBody Parse body as a multipart MIME response separated by boundary.
Method test_multipleRangeRequest The response to a request for multiple bytes ranges is a MIME-ish multipart response.
Method test_multipleRangeRequestWithRangeOverlappingEnd The response to a request for multiple bytes ranges is a MIME-ish multipart response, even when one of the ranged falls off the end of the resource.
Method test_implicitEnd If the end byte position is omitted, then it is treated as if the length of the resource was specified by the end byte position.
Method test_implicitStart If the start byte position is omitted but the end byte position is supplied, then the range is treated as requesting the last -N bytes of the resource, where N is the end byte position.
Method test_explicitRange A correct response to a bytes range header request from A to B starts with the A'th byte and ends with (including) the B'th byte. The first byte of a page is numbered with 0.
Method test_explicitRangeOverlappingEnd No summary
Method test_statusCodeRequestedRangeNotSatisfiable If a range is syntactically invalid due to the start being greater than the end, the range header is ignored (the request is responded to as if it were not present).
Method test_invalidStartBytePos No summary
Method _assertLogged Asserts that a given log message occurred with an expected message.

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.Deferreds. 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.
file =
Temporary (binary) file containing the content to be served. (type: file)
resource =
A leaf web resource using file as content. (type: static.File)
request =
A fake request, requesting resource. (type: DummyRequest)
catcher =
List which gathers all log information. (type: list)
def setUp(self):

Create a temporary file with a fixed payload of 64 bytes. Create a resource for that file and create a request which will be for that resource. Each test can set a different range header to test different aspects of the implementation.

def tearDown(self):

Clean up the resource file and the log observer.

def _assertLogged(self, expected):

Asserts that a given log message occurred with an expected message.

def test_invalidRanges(self):

File._parseRangeHeader raises ValueError when passed syntactically invalid byte ranges.

def test_rangeMissingStop(self):

A single bytes range without an explicit stop position is parsed into a two-tuple giving the start position and None.

def test_rangeMissingStart(self):

A single bytes range without an explicit start position is parsed into a two-tuple of None and the end position.

def test_range(self):

A single bytes range with explicit start and stop positions is parsed into a two-tuple of those positions.

def test_rangeWithSpace(self):

A single bytes range with whitespace in allowed places is parsed in the same way as it would be without the whitespace.

def test_nullRangeElements(self):

If there are multiple byte ranges but only one is non-null, the non-null range is parsed and its start and stop returned.

def test_multipleRanges(self):

If multiple byte ranges are specified their starts and stops are returned.

def test_bodyLength(self):

A correct response to a range request is as long as the length of the requested range.

def test_invalidRangeRequest(self):

An incorrect range request (RFC 2616 defines a correct range request as a Bytes-Unit followed by a '=' character followed by a specific range. Only 'bytes' is defined) results in the range header value being logged and a normal 200 response being sent.

def parseMultipartBody(self, body, boundary):

Parse body as a multipart MIME response separated by boundary.

Note that this with fail the calling test on certain syntactic problems.

def test_multipleRangeRequest(self):

The response to a request for multiple bytes ranges is a MIME-ish multipart response.

def test_multipleRangeRequestWithRangeOverlappingEnd(self):

The response to a request for multiple bytes ranges is a MIME-ish multipart response, even when one of the ranged falls off the end of the resource.

def test_implicitEnd(self):

If the end byte position is omitted, then it is treated as if the length of the resource was specified by the end byte position.

def test_implicitStart(self):

If the start byte position is omitted but the end byte position is supplied, then the range is treated as requesting the last -N bytes of the resource, where N is the end byte position.

def test_explicitRange(self):

A correct response to a bytes range header request from A to B starts with the A'th byte and ends with (including) the B'th byte. The first byte of a page is numbered with 0.

def test_explicitRangeOverlappingEnd(self):

A correct response to a bytes range header request from A to B when B is past the end of the resource starts with the A'th byte and ends with the last byte of the resource. The first byte of a page is numbered with 0.

def test_statusCodeRequestedRangeNotSatisfiable(self):

If a range is syntactically invalid due to the start being greater than the end, the range header is ignored (the request is responded to as if it were not present).

def test_invalidStartBytePos(self):

If a range is unsatisfiable due to the start not being less than the length of the resource, the response is 416 (Requested range not satisfiable) and no data is written to the response body (RFC 2616, section 14.35.1).

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