twisted.web.test.test_static.RangeTests

class documentation

class RangeTests(TestCase): (source)

View In Hierarchy

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

Method parseMultipartBody Parse body as a multipart MIME response separated by boundary.
Method setUp 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.
Method tearDown Clean up the resource file and the log observer.
Method test_bodyLength A correct response to a range request is as long as the length of the requested range.
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 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.
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_invalidRangeRequest 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.
Method test_invalidRanges File._parseRangeHeader raises ValueError when passed syntactically invalid byte ranges.
Method test_invalidStartBytePos 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...
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_multipleRanges If multiple byte ranges are specified their starts and stops are returned.
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_range A single bytes range with explicit start and stop positions is parsed into a two-tuple of those positions.
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_rangeMissingStop A single bytes range without an explicit stop position is parsed into a two-tuple giving the start position and None.
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_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).
Instance Variable catcher List which gathers all log information.
Instance Variable file Temporary (binary) file containing the content to be served.
Instance Variable payload Undocumented
Instance Variable request A fake request, requesting resource.
Instance Variable resource A leaf web resource using file as content.
Method _assertLogged Asserts that a given log message occurred with an expected message.

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 parseMultipartBody(self, body, boundary): (source)

Parse body as a multipart MIME response separated by boundary.

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

def setUp(self): (source)

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

Clean up the resource file and the log observer.

def test_bodyLength(self): (source)

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

def test_explicitRange(self): (source)

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

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

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

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

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

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

def test_invalidStartBytePos(self): (source)

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).

def test_multipleRangeRequest(self): (source)

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

def test_multipleRangeRequestWithRangeOverlappingEnd(self): (source)

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

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

def test_nullRangeElements(self): (source)

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

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

def test_rangeMissingStart(self): (source)

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

def test_rangeMissingStop(self): (source)

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

def test_rangeWithSpace(self): (source)

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

def test_statusCodeRequestedRangeNotSatisfiable(self): (source)

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).

catcher: list = (source)

List which gathers all log information.

file: file = (source)

Temporary (binary) file containing the content to be served.

payload: bytes = (source)

Undocumented

request: DummyRequest = (source)

A fake request, requesting resource.

resource: static.File = (source)

A leaf web resource using file as content.

def _assertLogged(self, expected): (source)

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