twisted.application.runner.test.test_runner.RunnerTests(twisted.trial.unittest.TestCase) class documentationtwisted.application.runner.test.test_runner
(View In Hierarchy)
Tests for Runner.
| Method | setUp | Undocumented | 
| Method | test_runInOrder | Runner.runcalls the expected methods in order. | 
| Method | test_runUsesPIDFile | Runner.runuses the provided PID file. | 
| Method | test_runAlreadyRunning | Runner.runexits withExitStatus.EX_USAGEand the expected message if a process is already running that corresponds 
to the given PID file. | 
| Method | test_killNotRequested | Runner.killIfRequestedwhenkillis false doesn't exit and doesn't indiscriminately 
murder anyone. | 
| Method | test_killRequestedWithoutPIDFile | Runner.killIfRequestedwhenkillis true butpidFileisnonePIDFileexits withExitStatus.EX_USAGEand the expected message; and also doesn't indiscriminately murder 
anyone. | 
| Method | test_killRequestedWithPIDFile | Runner.killIfRequestedwhenkillis true and given apidFileperforms a 
targeted killing of the appropriate process. | 
| Method | test_killRequestedWithPIDFileCantRead | Runner.killIfRequestedwhenkillis true and given apidFilethat it 
can't read exits withExitStatus.EX_IOERR. | 
| Method | test_killRequestedWithPIDFileEmpty | Runner.killIfRequestedwhenkillis true and given apidFilecontaining 
no value exits withExitStatus.EX_DATAERR. | 
| Method | test_killRequestedWithPIDFileNotAnInt | Runner.killIfRequestedwhenkillis true and given apidFilecontaining 
a non-integer value exits withExitStatus.EX_DATAERR. | 
| Method | test_startLogging | Runner.startLoggingsets up a filtering observer with a log level predicate set to the given 
log level that contains a file observer of the given type which writes to 
the given file. | 
| Method | test_startReactorWithReactor | Runner.startReactorwith thereactorargument runs the given reactor. | 
| Method | test_startReactorWhenRunning | Runner.startReactorensures thatwhenRunningis called withwhenRunningArgumentswhen the reactor is running. | 
| Method | test_whenRunningWithArguments | Runner.whenRunningcallswhenRunningwithwhenRunningArguments. | 
| Method | test_reactorExitedWithArguments | Runner.whenRunningcallsreactorExitedwithreactorExitedArguments. | 
| Method | _testHook | Verify that the named hook is run with the expected arguments as 
specified by the arguments used to create the Runner,
when the specified caller is invoked. | 
Inherited from TestCase:
| Instance Variable | timeout | A real number of seconds. If set, the test will raise an error if it takes 
longer than timeoutseconds. If not set, 
util.DEFAULT_TIMEOUT_DURATION is used. | 
| Method | __init__ | Construct an asynchronous test case for methodName. | 
| Method | assertFailure | Fail if deferreddoes not errback with one ofexpectedFailures. 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,crashandstoponreactor. 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 _deprecateReactordid. | 
| Method | _runCleanups | Run the cleanups added with addCleanupin order. | 
| Method | _runFixturesAndTest | Really run setUp, the test method, andtearDown.  Any of these may returndefer.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 | Noneor 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 theTestResultsupports skipping). | 
| Instance Variable | todo | None,
a string or a tuple of(errors, reason)whereerrorsis either an exception class or an iterable of 
exception classes, andreasonis a string. SeeTodoormakeTodofor 
more information. | 
| Instance Variable | suppress | Noneor a list of tuples of(args, kwargs)to be passed towarnings.filterwarnings. Use these to suppress warnings raised
in a test. Useful for testing deprecated code. See alsoutil.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 methodNameargument is passed to the constructor,runwill 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 conditionevaluates to True. | 
| Method | assertTrue | Fail the test if conditionevaluates to False. | 
| Method | assertRaises | Fail the test unless calling the function fwith the givenargsandkwargsraisesexception. 
The failure will report the traceback and call stack of the unexpected 
exception. | 
| Method | assertEqual | Fail the test if firstandsecondare not 
equal. | 
| Method | assertIs | Fail the test if firstis notsecond.  This is
an obect-identity-equality test, not an object equality (i.e.__eq__) test. | 
| Method | assertIsNot | Fail the test if firstissecond.  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 containeeis not found incontainer. | 
| Method | assertNotIn | Fail the test if containeeis found incontainer. | 
| 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 substringdoes not exist withinastring. | 
| Method | assertNotSubstring | Fail if astringcontainssubstring. | 
| 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 instanceis not an instance of the given class or 
of one of the given classes. | 
| Method | assertNotIsInstance | Fail if instanceis an instance of the given class or of 
one of the given classes. | 
| Method | successResultOf | Return the current success result of deferredor raiseself.failureException. | 
| Method | failureResultOf | Return the current failure result of deferredor raiseself.failureException. | 
| Method | assertNoResult | Assert that deferreddoes not have a result at this 
point. | 
| Method | assertRegex | Fail the test if a regexpsearch oftextfails. | 
Runner.run
exits with ExitStatus.EX_USAGE
and the expected message if a process is already running that corresponds 
to the given PID file.
Runner.killIfRequested
when kill is false doesn't exit and doesn't indiscriminately 
murder anyone.
Runner.killIfRequested
when kill is true but pidFile is 
nonePIDFile exits with ExitStatus.EX_USAGE
and the expected message; and also doesn't indiscriminately murder 
anyone.
Runner.killIfRequested
when kill is true and given a pidFile performs a 
targeted killing of the appropriate process.
Runner.killIfRequested
when kill is true and given a pidFile that it 
can't read exits with ExitStatus.EX_IOERR.
Runner.killIfRequested
when kill is true and given a pidFile containing 
no value exits with ExitStatus.EX_DATAERR.
Runner.killIfRequested
when kill is true and given a pidFile containing 
a non-integer value exits with ExitStatus.EX_DATAERR.
Runner.startLogging
sets up a filtering observer with a log level predicate set to the given 
log level that contains a file observer of the given type which writes to 
the given file.
Runner.startReactor
with the reactor argument runs the given reactor.
Runner.startReactor
ensures that whenRunning is called with 
whenRunningArguments when the reactor is running.
Runner.whenRunning
calls whenRunning with whenRunningArguments.
Runner.whenRunning
calls reactorExited with 
reactorExitedArguments.
Verify that the named hook is run with the expected arguments as 
specified by the arguments used to create the Runner,
when the specified caller is invoked.
| Parameters | methodName | The name of the hook to verify. (type: str) | 
| callerName | The name of the method that is expected to cause the hook to be called. If None, use theRunnermethod with the same name as the hook. (type:str) |