twisted.runner.test.test_procmon.ProcmonTests(unittest.TestCase) class documentation

Part of twisted.runner.test.test_procmon (View In Hierarchy)

Tests for ProcessMonitor.

Method setUp Create an ProcessMonitor wrapped around a fake reactor.
Method test_reprLooksGood Repr includes all details
Method test_simpleReprLooksGood Repr does not include unneeded details.
Method test_getStateIncludesProcesses The list of monitored processes must be included in the pickle state.
Method test_getStateExcludesReactor The private ProcessMonitor._reactor instance variable should not be included in the pickle state.
Method test_addProcess ProcessMonitor.addProcess only starts the named program if ProcessMonitor.startService has been called.
Method test_addProcessDuplicateKeyError ProcessMonitor.addProcess raises a KeyError if a process with the given name already exists.
Method test_addProcessEnv ProcessMonitor.addProcess takes an env parameter that is passed to IReactorProcess.spawnProcess.
Method test_addProcessCwd ProcessMonitor.addProcess takes an cwd parameter that is passed to IReactorProcess.spawnProcess.
Method test_removeProcess ProcessMonitor.removeProcess removes the process from the public processes list.
Method test_removeProcessUnknownKeyError ProcessMonitor.removeProcess raises a KeyError if the given process name isn't recognised.
Method test_startProcess No summary
Method test_startProcessAlreadyStarted ProcessMonitor.startProcess silently returns if the named process is already started.
Method test_startProcessUnknownKeyError ProcessMonitor.startProcess raises a KeyError if the given process name isn't recognised.
Method test_stopProcessNaturalTermination ProcessMonitor.stopProcess immediately sends a TERM signal to the named process.
Method test_stopProcessForcedKill ProcessMonitor.stopProcess kills a process which fails to terminate naturally within ProcessMonitor.killTime seconds.
Method test_stopProcessUnknownKeyError ProcessMonitor.stopProcess raises a KeyError if the given process name isn't recognised.
Method test_stopProcessAlreadyStopped ProcessMonitor.stopProcess silently returns if the named process is already stopped. eg Process has crashed and a restart has been rescheduled, but in the meantime, the service is stopped.
Method test_outputReceivedCompleteLine Getting a complete output line on stdout generates a log message.
Method test_ouputReceivedCompleteErrLine Getting a complete output line on stderr generates a log message.
Method test_outputReceivedCompleteLineInvalidUTF8 Getting invalid UTF-8 results in the repr of the raw message
Method test_outputReceivedPartialLine Getting partial line results in no events until process end
Method test_connectionLostLongLivedProcess ProcessMonitor.connectionLost should immediately restart a process if it has been running longer than ProcessMonitor.threshold seconds.
Method test_connectionLostMurderCancel ProcessMonitor.connectionLost cancels a scheduled process killer and deletes the DelayedCall from the ProcessMonitor.murder list.
Method test_connectionLostProtocolDeletion ProcessMonitor.connectionLost removes the corresponding ProcessProtocol instance from the ProcessMonitor.protocols list.
Method test_connectionLostMinMaxRestartDelay ProcessMonitor.connectionLost will wait at least minRestartDelay s and at most maxRestartDelay s
Method test_connectionLostBackoffDelayDoubles ProcessMonitor.connectionLost doubles the restart delay each time the process dies too quickly.
Method test_startService ProcessMonitor.startService starts all monitored processes.
Method test_stopService ProcessMonitor.stopService should stop all monitored processes.
Method test_restartAllRestartsOneProcess ProcessMonitor.restartAll succeeds when there is one process.
Method test_stopServiceCancelRestarts ProcessMonitor.stopService should cancel any scheduled process restarts.
Method test_stopServiceCleanupScheduledRestarts ProcessMonitor.stopService should cancel all scheduled process restarts.

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

Create an ProcessMonitor wrapped around a fake reactor.

def test_reprLooksGood(self):

Repr includes all details

def test_simpleReprLooksGood(self):

Repr does not include unneeded details.

Values of attributes that just mean "inherit from launching process" do not appear in the repr of a process.

def test_getStateIncludesProcesses(self):

The list of monitored processes must be included in the pickle state.

def test_getStateExcludesReactor(self):

The private ProcessMonitor._reactor instance variable should not be included in the pickle state.

def test_addProcess(self):

ProcessMonitor.addProcess only starts the named program if ProcessMonitor.startService has been called.

def test_addProcessDuplicateKeyError(self):

ProcessMonitor.addProcess raises a KeyError if a process with the given name already exists.

def test_addProcessEnv(self):

ProcessMonitor.addProcess takes an env parameter that is passed to IReactorProcess.spawnProcess.

def test_addProcessCwd(self):

ProcessMonitor.addProcess takes an cwd parameter that is passed to IReactorProcess.spawnProcess.

def test_removeProcess(self):

ProcessMonitor.removeProcess removes the process from the public processes list.

def test_removeProcessUnknownKeyError(self):

ProcessMonitor.removeProcess raises a KeyError if the given process name isn't recognised.

def test_startProcess(self):

When a process has been started, an instance of LoggingProtocol will be added to the ProcessMonitor.protocols dict and the start time of the process will be recorded in the ProcessMonitor.timeStarted dictionary.

def test_startProcessAlreadyStarted(self):

ProcessMonitor.startProcess silently returns if the named process is already started.

def test_startProcessUnknownKeyError(self):

ProcessMonitor.startProcess raises a KeyError if the given process name isn't recognised.

def test_stopProcessNaturalTermination(self):

ProcessMonitor.stopProcess immediately sends a TERM signal to the named process.

def test_stopProcessForcedKill(self):

ProcessMonitor.stopProcess kills a process which fails to terminate naturally within ProcessMonitor.killTime seconds.

def test_stopProcessUnknownKeyError(self):

ProcessMonitor.stopProcess raises a KeyError if the given process name isn't recognised.

def test_stopProcessAlreadyStopped(self):

ProcessMonitor.stopProcess silently returns if the named process is already stopped. eg Process has crashed and a restart has been rescheduled, but in the meantime, the service is stopped.

def test_outputReceivedCompleteLine(self):

Getting a complete output line on stdout generates a log message.

def test_ouputReceivedCompleteErrLine(self):

Getting a complete output line on stderr generates a log message.

def test_outputReceivedCompleteLineInvalidUTF8(self):

Getting invalid UTF-8 results in the repr of the raw message

def test_outputReceivedPartialLine(self):

Getting partial line results in no events until process end

def test_connectionLostLongLivedProcess(self):

ProcessMonitor.connectionLost should immediately restart a process if it has been running longer than ProcessMonitor.threshold seconds.

def test_connectionLostMurderCancel(self):

ProcessMonitor.connectionLost cancels a scheduled process killer and deletes the DelayedCall from the ProcessMonitor.murder list.

def test_connectionLostProtocolDeletion(self):

ProcessMonitor.connectionLost removes the corresponding ProcessProtocol instance from the ProcessMonitor.protocols list.

def test_connectionLostMinMaxRestartDelay(self):

ProcessMonitor.connectionLost will wait at least minRestartDelay s and at most maxRestartDelay s

def test_connectionLostBackoffDelayDoubles(self):

ProcessMonitor.connectionLost doubles the restart delay each time the process dies too quickly.

def test_startService(self):

ProcessMonitor.startService starts all monitored processes.

def test_stopService(self):

ProcessMonitor.stopService should stop all monitored processes.

def test_restartAllRestartsOneProcess(self):

ProcessMonitor.restartAll succeeds when there is one process.

def test_stopServiceCancelRestarts(self):

ProcessMonitor.stopService should cancel any scheduled process restarts.

def test_stopServiceCleanupScheduledRestarts(self):

ProcessMonitor.stopService should cancel all scheduled process restarts.

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