twisted.web.test.test_wsgi.EnvironTests

class documentation

class EnvironTests(WSGITestsMixin, TestCase): (source)

View In Hierarchy

Tests for the values in the environ dict passed to the application object by twisted.web.wsgi.WSGIResource.

Method environKeyEqual Undocumented
Method test_contentLength The 'CONTENT_LENGTH' key of the environ dict passed to the application contains the value of the Content-Length request header (RFC 3875, section 4.1.2).
Method test_contentLengthIsNativeString The 'CONTENT_LENGTH' key of the environ dict passed to the application is always a native string.
Method test_contentType The 'CONTENT_TYPE' key of the environ dict passed to the application contains the value of the Content-Type request header (RFC 3875, section 4.1.3).
Method test_contentTypeIsNativeString The 'CONTENT_TYPE' key of the environ dict passed to the application is always a native string.
Method test_environIsDict WSGIResource calls the application object with an environ parameter which is exactly of type dict.
Method test_headers HTTP request headers are copied into the environ dict passed to the application with a HTTP_ prefix added to their names.
Method test_pathInfo The 'PATH_INFO' key of the environ dict passed to the application contains the suffix of the request URI path which is not included in the value for the 'SCRIPT_NAME' key (RFC 3875, section 4.1.5).
Method test_pathInfoIsNativeString The 'PATH_INFO' key of the environ dict passed to the application is always a native string.
Method test_queryString The 'QUERY_STRING' key of the environ dict passed to the application contains the portion of the request URI after the first ? (RFC 3875, section 4.1.7).
Method test_queryStringIsNativeString The 'QUERY_STRING' key of the environ dict passed to the application is always a native string.
Method test_remoteAddr The 'REMOTE_ADDR' key of the environ dict passed to the application contains the address of the client making the request.
Method test_remoteAddrIPv6 The 'REMOTE_ADDR' key of the environ dict passed to the application contains the address of the client making the request when connecting over IPv6.
Method test_requestMethod The 'REQUEST_METHOD' key of the environ dict passed to the application contains the HTTP method in the request (RFC 3875, section 4.1.12).
Method test_requestMethodIsNativeString The 'REQUEST_METHOD' key of the environ dict passed to the application is always a native string.
Method test_scriptName The 'SCRIPT_NAME' key of the environ dict passed to the application contains the abs_path (RFC 2396, section 3) to this resource (RFC 3875, section 4.1.13).
Method test_scriptNameIsNativeString The 'SCRIPT_NAME' key of the environ dict passed to the application is always a native string.
Method test_serverName The 'SERVER_NAME' key of the environ dict passed to the application contains the best determination of the server hostname possible, using either the value of the Host header in the request or the address the server is listening on if that header is not present (RFC 3875, section 4...
Method test_serverNameIsNativeString The 'SERVER_NAME' key of the environ dict passed to the application is always a native string.
Method test_serverPort The 'SERVER_PORT' key of the environ dict passed to the application contains the port number of the server which received the request (RFC 3875, section 4.1.15).
Method test_serverPortIsNativeString The 'SERVER_PORT' key of the environ dict passed to the application is always a native string.
Method test_serverProtocol The 'SERVER_PROTOCOL' key of the environ dict passed to the application contains the HTTP version number received in the request (RFC 3875, section 4.1.16).
Method test_serverProtocolIsNativeString The 'SERVER_PROTOCOL' key of the environ dict passed to the application is always a native string.
Method test_wsgiErrors The 'wsgi.errors' key of the environ dict passed to the application is a file-like object (as defined in the Input and Errors Streams section of PEP 333) which converts bytes written to it into events for the logging system.
Method test_wsgiErrorsAcceptsOnlyNativeStringsInPython3 The 'wsgi.errors' file-like object from the environ dict permits writes of only native strings in Python 3, and raises TypeError for writes of non-native strings.
Method test_wsgiMultiprocess The 'wsgi.multiprocess' key of the environ dict passed to the application is set to False.
Method test_wsgiMultithread The 'wsgi.multithread' key of the environ dict passed to the application is set to True.
Method test_wsgiRunOnce The 'wsgi.run_once' key of the environ dict passed to the application is set to False.
Method test_wsgiURLScheme The 'wsgi.url_scheme' key of the environ dict passed to the application has the request URL scheme.
Method test_wsgiVersion The 'wsgi.version' key of the environ dict passed to the application has the value (1, 0) indicating that this is a WSGI 1.0 container.
Instance Variable channelFactory Undocumented

Inherited from WSGITestsMixin:

Method getContentFromResponse Undocumented
Method lowLevelRender No summary
Method prepareRequest Prepare a Request which, when a request is received, captures the environ and start_response callable passed to a WSGI app.
Method render Undocumented
Method requestFactoryFactory Undocumented
Method setUp Undocumented
Instance Variable reactor Undocumented
Instance Variable threadpool Undocumented

Inherited from TestCase (via WSGITestsMixin):

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 WSGITestsMixin, 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 WSGITestsMixin, 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 environKeyEqual(self, key, value): (source)

Undocumented

def test_contentLength(self): (source)

The 'CONTENT_LENGTH' key of the environ dict passed to the application contains the value of the Content-Length request header (RFC 3875, section 4.1.2).

def test_contentLengthIsNativeString(self): (source)

The 'CONTENT_LENGTH' key of the environ dict passed to the application is always a native string.

def test_contentType(self): (source)

The 'CONTENT_TYPE' key of the environ dict passed to the application contains the value of the Content-Type request header (RFC 3875, section 4.1.3).

def test_contentTypeIsNativeString(self): (source)

The 'CONTENT_TYPE' key of the environ dict passed to the application is always a native string.

def test_environIsDict(self): (source)

WSGIResource calls the application object with an environ parameter which is exactly of type dict.

def test_headers(self): (source)

HTTP request headers are copied into the environ dict passed to the application with a HTTP_ prefix added to their names.

def test_pathInfo(self): (source)

The 'PATH_INFO' key of the environ dict passed to the application contains the suffix of the request URI path which is not included in the value for the 'SCRIPT_NAME' key (RFC 3875, section 4.1.5).

def test_pathInfoIsNativeString(self): (source)

The 'PATH_INFO' key of the environ dict passed to the application is always a native string.

def test_queryString(self): (source)

The 'QUERY_STRING' key of the environ dict passed to the application contains the portion of the request URI after the first ? (RFC 3875, section 4.1.7).

def test_queryStringIsNativeString(self): (source)

The 'QUERY_STRING' key of the environ dict passed to the application is always a native string.

def test_remoteAddr(self): (source)

The 'REMOTE_ADDR' key of the environ dict passed to the application contains the address of the client making the request.

def test_remoteAddrIPv6(self): (source)

The 'REMOTE_ADDR' key of the environ dict passed to the application contains the address of the client making the request when connecting over IPv6.

def test_requestMethod(self): (source)

The 'REQUEST_METHOD' key of the environ dict passed to the application contains the HTTP method in the request (RFC 3875, section 4.1.12).

def test_requestMethodIsNativeString(self): (source)

The 'REQUEST_METHOD' key of the environ dict passed to the application is always a native string.

def test_scriptName(self): (source)

The 'SCRIPT_NAME' key of the environ dict passed to the application contains the abs_path (RFC 2396, section 3) to this resource (RFC 3875, section 4.1.13).

def test_scriptNameIsNativeString(self): (source)

The 'SCRIPT_NAME' key of the environ dict passed to the application is always a native string.

def test_serverName(self): (source)

The 'SERVER_NAME' key of the environ dict passed to the application contains the best determination of the server hostname possible, using either the value of the Host header in the request or the address the server is listening on if that header is not present (RFC 3875, section 4.1.14).

def test_serverNameIsNativeString(self): (source)

The 'SERVER_NAME' key of the environ dict passed to the application is always a native string.

def test_serverPort(self): (source)

The 'SERVER_PORT' key of the environ dict passed to the application contains the port number of the server which received the request (RFC 3875, section 4.1.15).

def test_serverPortIsNativeString(self): (source)

The 'SERVER_PORT' key of the environ dict passed to the application is always a native string.

def test_serverProtocol(self): (source)

The 'SERVER_PROTOCOL' key of the environ dict passed to the application contains the HTTP version number received in the request (RFC 3875, section 4.1.16).

def test_serverProtocolIsNativeString(self): (source)

The 'SERVER_PROTOCOL' key of the environ dict passed to the application is always a native string.

def test_wsgiErrors(self): (source)

The 'wsgi.errors' key of the environ dict passed to the application is a file-like object (as defined in the Input and Errors Streams section of PEP 333) which converts bytes written to it into events for the logging system.

def test_wsgiErrorsAcceptsOnlyNativeStringsInPython3(self): (source)

The 'wsgi.errors' file-like object from the environ dict permits writes of only native strings in Python 3, and raises TypeError for writes of non-native strings.

def test_wsgiMultiprocess(self): (source)

The 'wsgi.multiprocess' key of the environ dict passed to the application is set to False.

def test_wsgiMultithread(self): (source)

The 'wsgi.multithread' key of the environ dict passed to the application is set to True.

def test_wsgiRunOnce(self): (source)

The 'wsgi.run_once' key of the environ dict passed to the application is set to False.

def test_wsgiURLScheme(self): (source)

The 'wsgi.url_scheme' key of the environ dict passed to the application has the request URL scheme.

def test_wsgiVersion(self): (source)

The 'wsgi.version' key of the environ dict passed to the application has the value (1, 0) indicating that this is a WSGI 1.0 container.

channelFactory = (source)
overrides twisted.web.test.test_wsgi.WSGITestsMixin.channelFactory

Undocumented