twisted.application.runner.test.test_pidfile.PIDFileTests

class documentation

class PIDFileTests(twisted.trial.unittest.TestCase): (source)

View In Hierarchy

Tests for PIDFile.

Method filePath Undocumented
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_contextManagerAlreadyRunning When used as a context manager, a PIDFile will raise AlreadyRunningError if the there is already a running process with the contained PID.
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_formatWithPID PIDFile._format returns the expected format when given a PID.
Method test_interface PIDFile conforms to IPIDFile.
Method test_isRunningDoesExist PIDFile.isRunning returns true for a process that does exist.
Method test_isRunningDoesNotExist PIDFile.isRunning raises StalePIDFileError for a process that does not exist (errno=ESRCH).
Method test_isRunningInit PIDFile.isRunning returns true for a process that we are not allowed to kill (errno=EPERM).
Method test_isRunningNoPIDFile PIDFile.isRunning returns false if the PID file doesn't exist.
Method test_isRunningNotAllowed PIDFile.isRunning returns true for a process that we are not allowed to kill (errno=EPERM).
Method test_isRunningThis PIDFile.isRunning returns true for this process (which is running).
Method test_isRunningUnknownErrno PIDFile.isRunning re-raises OSError if the attached errno value from os.kill is not an expected one.
Method test_readDoesntExist PIDFile.read raises NoPIDFound when given a non-existing file path.
Method test_readEmptyPID PIDFile.read raises InvalidPIDFileError when given an empty file path.
Method test_readOpenRaisesOSErrorNotENOENT PIDFile.read re-raises OSError if the associated errno is anything other than errno.ENOENT.
Method test_readWithBogusPID PIDFile.read raises InvalidPIDFileError when given an empty file path.
Method test_readWithPID PIDFile.read returns the PID from the given file path.
Method test_remove PIDFile.remove removes the PID file.
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.

Inherited from TestCase:

Method __call__ Run the test. Should always do exactly the same thing as run().
Method __init__ Construct an asynchronous test case for methodName.
Method addCleanup Extend the base cleanup feature with support for cleanup functions which return Deferreds.
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 deferRunCleanups Run any scheduled cleanups and report errors (if any) to the result. object.
Method deferSetUp Undocumented
Method deferTearDown Undocumented
Method deferTestMethod Undocumented
Method getSuppress Undocumented
Method getTimeout Returns the timeout value set on this test. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a timeout attribute, returns that. Returns util.DEFAULT_TIMEOUT_DURATION...
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 _cbDeferTestMethod Undocumented
Method _classCleanUp Undocumented
Method _cleanUp Undocumented
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 _ebDeferSetUp Undocumented
Method _ebDeferTearDown Undocumented
Method _ebDeferTestMethod Undocumented
Method _makeReactorMethod Create a method which wraps the reactor method name. The new method issues a deprecation warning and calls the original.
Method _run Run a single method, either a test method or fixture.
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 _undeprecateReactor Restore the deprecated reactor methods. Undoes what _deprecateReactor did.
Method _wait Take a Deferred that only ever callbacks. Block until it happens.
Instance Variable _passed Undocumented
Instance Variable _reactorMethods Undocumented
Instance Variable _timedOut Undocumented

Inherited from SynchronousTestCase (via TestCase):

Method __eq__ Override the comparison defined by the base TestCase which considers instances of the same class with the same _testMethodName to be equal. Since trial puts TestCase instances into a set, that definition of comparison makes it impossible to run the same test method twice...
Method __hash__ Undocumented
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 flushLoggedErrors Remove stored errors received from the log.
Method flushWarnings Remove stored warnings from the list of captured warnings and return them.
Method getDeprecatedModuleAttribute Retrieve a module attribute which should have been deprecated, and assert that we saw the appropriate deprecation warning.
Method getSkip Return the skip reason set on this test, if any is set. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a skip attribute, returns that in a tuple (...
Method getTodo Return a Todo object if the test is marked todo. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a todo attribute, returns that. Returns ...
Method mktemp Create a new path name which can be used for a new file or directory.
Method patch Monkey patch an object for the duration of the test.
Method run Run the test case, storing the results in result.
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 shortDescription Undocumented
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 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.
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.
Method _getSkipReason Return the reason to use for skipping a test method.
Method _getSuppress Returns any warning suppressions set for this test. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a suppress attribute, returns that. ...
Method _installObserver Undocumented
Method _removeObserver Undocumented
Method _runCleanups Synchronously run any cleanups which have been added.
Instance Variable _cleanups Undocumented
Instance Variable _observer Undocumented
Instance Variable _parents Undocumented
Instance Variable _testMethodName Undocumented
Instance Variable _warnings Undocumented

Inherited from _Assertions (via TestCase, SynchronousTestCase):

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 assertEqual Fail the test if first and second are not equal.
Method assertFalse Fail the test if condition evaluates to True.
Method assertIn Fail the test if containee is not found in container.
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 assertIsInstance Fail if instance is not an instance of the given class or of one of the given classes.
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 assertNoResult Assert that deferred does not have a result at this point.
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 assertNotEqual Fail the test if first == second.
Method assertNotIn Fail the test if containee is found in container.
Method assertNotIsInstance Fail if instance is an instance of the given class or of one of the given classes.
Method assertNotSubstring Fail if astring contains substring.
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 assertSubstring Fail if substring does not exist within astring.
Method assertTrue Fail the test if condition evaluates to False.
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 fail Absolutely fail the test. Do not pass go, do not collect $200.
Method failureResultOf Return the current failure result of deferred or raise self.failureException.
Method successResultOf Return the current success result of deferred or raise self.failureException.
def filePath(self, content=None): (source)

Undocumented

Parameters
content:Optional[bytes]Undocumented
Returns
FilePathUndocumented
def test_contextManager(self): (source)

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

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

@ifPlatformSupported
def test_contextManagerDoesntExist(self): (source)

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.

def test_formatWithPID(self): (source)

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

def test_interface(self): (source)

PIDFile conforms to IPIDFile.

@ifPlatformSupported
def test_isRunningDoesExist(self): (source)

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

@ifPlatformSupported
def test_isRunningDoesNotExist(self): (source)

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

@ifPlatformSupported
def test_isRunningInit(self): (source)

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

Notes
This 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.
def test_isRunningNoPIDFile(self): (source)

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

@ifPlatformSupported
def test_isRunningNotAllowed(self): (source)

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

@ifPlatformSupported
def test_isRunningThis(self): (source)

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

Note
This 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_isRunningUnknownErrno(self): (source)

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

def test_readDoesntExist(self): (source)

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

def test_readEmptyPID(self): (source)

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

def test_readOpenRaisesOSErrorNotENOENT(self): (source)

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

def test_readWithBogusPID(self): (source)

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

def test_readWithPID(self): (source)

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

def test_remove(self): (source)

PIDFile.remove removes the PID file.

def test_writePID(self): (source)

PIDFile._write stores the given PID.

def test_writePIDInvalid(self): (source)

PIDFile._write raises ValueError when given an invalid PID.

def test_writeRunningPID(self): (source)

PIDFile.writeRunningPID stores the PID for the current process.