twisted.web.test.test_wsgi.EnvironTests(WSGITestsMixin, TestCase) class documentation

Part of twisted.web.test.test_wsgi (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_environIsDict WSGIResource calls the application object with an environ parameter which is exactly of type dict.
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_pathInfo No summary
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_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_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_serverName No summary
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_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_headers HTTP request headers are copied into the environ dict passed to the application with a HTTP_ prefix added to their names.
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.
Method test_wsgiRunOnce The 'wsgi.run_once' 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_wsgiMultiprocess The 'wsgi.multiprocess' 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_wsgiErrors No summary
Method test_wsgiErrorsExpectsOnlyNativeStringsInPython2 No summary
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.

Inherited from WSGITestsMixin:

Instance Variable channelFactory A no-argument callable which will be invoked to create a new HTTP channel to associate with request objects.
Method setUp Undocumented
Method lowLevelRender
Method render Undocumented
Method requestFactoryFactory Undocumented
Method getContentFromResponse Undocumented
Method prepareRequest Prepare a Request which, when a request is received, captures the environ and start_response callable passed to a WSGI app.

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.
def environKeyEqual(self, key, value):
Undocumented
def test_environIsDict(self):

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

def test_requestMethod(self):

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

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

def test_scriptName(self):

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

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

def test_pathInfo(self):

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

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

def test_queryString(self):

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

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

def test_contentType(self):

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

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

def test_contentLength(self):

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

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

def test_serverName(self):

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

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

def test_serverPort(self):

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

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

def test_serverProtocol(self):

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

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

def test_remoteAddr(self):

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

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

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

def test_wsgiVersion(self):

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.

def test_wsgiRunOnce(self):

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

def test_wsgiMultithread(self):

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

def test_wsgiMultiprocess(self):

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

def test_wsgiURLScheme(self):

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

def test_wsgiErrors(self):

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

The 'wsgi.errors' file-like object from the environ dict expects writes of only native strings in Python 2. Some existing WSGI applications may write non-native (i.e. unicode) strings so, for compatibility, these elicit only a warning in Python 2.

def test_wsgiErrorsAcceptsOnlyNativeStringsInPython3(self):

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.

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