twisted.web.test.test_tap.ServiceTests(TestCase) class documentation

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

Tests for the service creation APIs in twisted.web.tap.

Method test_path The --path option causes Options to create a root resource which serves responses from the specified path.
Method test_pathServer The --path option to makeService causes it to return a service which will listen on the server address given by the --port option.
Method test_cgiProcessor The --path option creates a root resource which serves a CGIScript instance for any child with the ".cgi" extension.
Method test_epyProcessor The --path option creates a root resource which serves a PythonScript instance for any child with the ".epy" extension.
Method test_rpyProcessor The --path option creates a root resource which serves the resource global defined by the Python source in any child with the ".rpy" extension.
Method test_makePersonalServerFactory makePersonalServerFactory returns a PB server factory which has as its root object a ResourcePublisher.
Method test_personalServer The --personal option to makeService causes it to return a service which will listen on the server address given by the --port option.
Method test_defaultPersonalPath If the --port option not specified but the --personal option is, Options defaults the port to UserDirectory.userSocketName in the user's home directory.
Method test_defaultPort If the --port option is not specified, Options defaults the port to 8080.
Method test_twoPorts If the --http option is given twice, there are two listeners
Method test_wsgi The --wsgi option takes the fully-qualifed Python name of a WSGI application object and creates a WSGIResource at the root which serves that application.
Method test_invalidApplication If --wsgi is given an invalid name, Options.parseOptions raises UsageError.
Method test_HTTPSFailureOnMissingSSL An UsageError is raised when https is requested but there is no support for SSL.
Method test_HTTPSAcceptedOnAvailableSSL When SSL support is present, it accepts the --https option.
Method test_add_header_parsing When --add-header is specific, the value is parsed.
Method test_add_header_resource When --add-header is specified, the resource is a composition that adds headers.
Method test_noTracebacksDeprecation Passing --notracebacks is deprecated.
Method test_displayTracebacks Passing --display-tracebacks will enable traceback rendering on the generated Site.
Method test_displayTracebacksNotGiven Not passing --display-tracebacks will leave traceback rendering on the generated Site off.
Method _pathOption Helper for the --path tests which creates a directory and creates an Options object which uses that directory as its static filesystem root.

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

Helper for the --path tests which creates a directory and creates an Options object which uses that directory as its static filesystem root.

ReturnsA two-tuple of a FilePath referring to the directory and the value associated with the 'root' key in the Options instance after parsing a --path option.
def test_path(self):

The --path option causes Options to create a root resource which serves responses from the specified path.

def test_pathServer(self):

The --path option to makeService causes it to return a service which will listen on the server address given by the --port option.

def test_cgiProcessor(self):

The --path option creates a root resource which serves a CGIScript instance for any child with the ".cgi" extension.

def test_epyProcessor(self):

The --path option creates a root resource which serves a PythonScript instance for any child with the ".epy" extension.

def test_rpyProcessor(self):

The --path option creates a root resource which serves the resource global defined by the Python source in any child with the ".rpy" extension.

def test_makePersonalServerFactory(self):

makePersonalServerFactory returns a PB server factory which has as its root object a ResourcePublisher.

def test_personalServer(self):

The --personal option to makeService causes it to return a service which will listen on the server address given by the --port option.

def test_defaultPersonalPath(self):

If the --port option not specified but the --personal option is, Options defaults the port to UserDirectory.userSocketName in the user's home directory.

def test_defaultPort(self):

If the --port option is not specified, Options defaults the port to 8080.

def test_twoPorts(self):

If the --http option is given twice, there are two listeners

def test_wsgi(self):

The --wsgi option takes the fully-qualifed Python name of a WSGI application object and creates a WSGIResource at the root which serves that application.

def test_invalidApplication(self):

If --wsgi is given an invalid name, Options.parseOptions raises UsageError.

def test_HTTPSFailureOnMissingSSL(self):

An UsageError is raised when https is requested but there is no support for SSL.

def test_HTTPSAcceptedOnAvailableSSL(self):

When SSL support is present, it accepts the --https option.

def test_add_header_parsing(self):

When --add-header is specific, the value is parsed.

def test_add_header_resource(self):

When --add-header is specified, the resource is a composition that adds headers.

def test_noTracebacksDeprecation(self):

Passing --notracebacks is deprecated.

def test_displayTracebacks(self):

Passing --display-tracebacks will enable traceback rendering on the generated Site.

def test_displayTracebacksNotGiven(self):

Not passing --display-tracebacks will leave traceback rendering on the generated Site off.

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