twisted.application.runner.test.test_pidfile.PIDFileTests(twisted.trial.unittest.TestCase) class documentation

Part of twisted.application.runner.test.test_pidfile (View In Hierarchy)

Tests for PIDFile.

Method test_interface PIDFile conforms to IPIDFile.
Method test_formatWithPID PIDFile._format returns the expected format when given a PID.
Method test_readWithPID PIDFile.read returns the PID from the given file path.
Method test_readEmptyPID PIDFile.read raises InvalidPIDFileError when given an empty file path.
Method test_readWithBogusPID PIDFile.read raises InvalidPIDFileError when given an empty file path.
Method test_readDoesntExist PIDFile.read raises NoPIDFound when given a non-existing file path.
Method test_readOpenRaisesOSErrorNotENOENT PIDFile.read re-raises OSError if the associated errno is anything other than errno.ENOENT.
Method test_writePID PIDFile._write stores the given PID.
Method test_writePIDInvalid PIDFile._write raises ValueError when given an invalid PID.
Method test_writeRunningPID PIDFile.writeRunningPID stores the PID for the current process.
Method test_remove PIDFile.remove removes the PID file.
Method test_isRunningDoesExist PIDFile.isRunning returns true for a process that does exist.
Method test_isRunningThis PIDFile.isRunning returns true for this process (which is running).
Method test_isRunningDoesNotExist PIDFile.isRunning raises StalePIDFileError for a process that does not exist (errno=ESRCH).
Method test_isRunningNotAllowed PIDFile.isRunning returns true for a process that we are not allowed to kill (errno=EPERM).
Method test_isRunningInit PIDFile.isRunning returns true for a process that we are not allowed to kill (errno=EPERM).
Method test_isRunningUnknownErrno PIDFile.isRunning re-raises OSError if the attached errno value from os.kill is not an expected one.
Method test_isRunningNoPIDFile PIDFile.isRunning returns false if the PID file doesn't exist.
Method test_contextManager When used as a context manager, a PIDFile will store the current pid on entry, then removes the PID file on exit.
Method test_contextManagerDoesntExist When used as a context manager, a PIDFile will replace the underlying PIDFile rather than raising AlreadyRunningError if the contained PID file exists but refers to a non-running PID.
Method test_contextManagerAlreadyRunning When used as a context manager, a PIDFile will raise AlreadyRunningError if the there is already a running process with the contained PID.

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

PIDFile conforms to IPIDFile.

def test_formatWithPID(self):

PIDFile._format returns the expected format when given a PID.

def test_readWithPID(self):

PIDFile.read returns the PID from the given file path.

def test_readEmptyPID(self):

PIDFile.read raises InvalidPIDFileError when given an empty file path.

def test_readWithBogusPID(self):

PIDFile.read raises InvalidPIDFileError when given an empty file path.

def test_readDoesntExist(self):

PIDFile.read raises NoPIDFound when given a non-existing file path.

def test_readOpenRaisesOSErrorNotENOENT(self):

PIDFile.read re-raises OSError if the associated errno is anything other than errno.ENOENT.

def test_writePID(self):

PIDFile._write stores the given PID.

def test_writePIDInvalid(self):

PIDFile._write raises ValueError when given an invalid PID.

def test_writeRunningPID(self):

PIDFile.writeRunningPID stores the PID for the current process.

def test_remove(self):

PIDFile.remove removes the PID file.

@ifPlatformSupported
def test_isRunningDoesExist(self):

PIDFile.isRunning returns true for a process that does exist.

@ifPlatformSupported
def test_isRunningThis(self):

PIDFile.isRunning returns true for this process (which is running).

NoteThis differs from PIDFileTests.test_isRunningDoesExist in that it actually invokes the kill system call, which is useful for testing of our chosen method for probing the existence of a process.
@ifPlatformSupported
def test_isRunningDoesNotExist(self):

PIDFile.isRunning raises StalePIDFileError for a process that does not exist (errno=ESRCH).

@ifPlatformSupported
def test_isRunningNotAllowed(self):

PIDFile.isRunning returns true for a process that we are not allowed to kill (errno=EPERM).

@ifPlatformSupported
def test_isRunningInit(self):

PIDFile.isRunning returns true for a process that we are not allowed to kill (errno=EPERM).

NotesThis differs from PIDFileTests.test_isRunningNotAllowed in that it actually invokes the kill system call, which is useful for testing of our chosen method for probing the existence of a process that we are not allowed to kill.
In this case, we try killing init, which is process #1 on POSIX systems, so this test is not portable. init should always be running and should not be killable by non-root users.
@ifPlatformSupported
def test_isRunningUnknownErrno(self):

PIDFile.isRunning re-raises OSError if the attached errno value from os.kill is not an expected one.

def test_isRunningNoPIDFile(self):

PIDFile.isRunning returns false if the PID file doesn't exist.

def test_contextManager(self):

When used as a context manager, a PIDFile will store the current pid on entry, then removes the PID file on exit.

@ifPlatformSupported
def test_contextManagerDoesntExist(self):

When used as a context manager, a PIDFile will replace the underlying PIDFile rather than raising AlreadyRunningError if the contained PID file exists but refers to a non-running PID.

@ifPlatformSupported
def test_contextManagerAlreadyRunning(self):

When used as a context manager, a PIDFile will raise AlreadyRunningError if the there is already a running process with the contained PID.

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