twisted.test.test_process.MockProcessTests

class documentation

class MockProcessTests(unittest.TestCase): (source)

View In Hierarchy

Mock a process runner to test forked child code path.

Method setUp Replace process os, fcntl, sys, switchUID, fdesc and pty modules with the mock class MockOS.
Method tearDown Reset processes registered for reap.
Method test_kill process.Process.signalProcess calls os.kill translating the given signal string to the PID.
Method test_killErrorInKill process.Process.signalProcess doesn't mask OSError exceptions if the errno is different from errno.ESRCH.
Method test_killExited process.Process.signalProcess raises error.ProcessExitedAlready if the process has exited.
Method test_killExitedButNotDetected process.Process.signalProcess raises error.ProcessExitedAlready if the process has exited but that twisted hasn't seen it (for example, if the process has been waited outside of twisted): os.kill then raise ...
Method test_mockErrorECHILDInReapProcess Test that reapProcess doesn't log anything when waitpid raises a OSError with errno ECHILD.
Method test_mockErrorInPipe If os.pipe raises an exception after some pipes where created, the created pipes are closed and don't leak.
Method test_mockFork Test a classic spawnProcess. Check the path of the client code: fork, exec, exit.
Method test_mockForkErrorCloseFDs When os.fork raises an exception, the file descriptors created before are closed and don't leak.
Method test_mockForkErrorClosePTY When os.fork raises an exception, the file descriptors created by pty.openpty are closed and don't leak, when usePTY is set to True.
Method test_mockForkErrorGivenFDs When os.forks raises an exception and that file descriptors have been specified with the childFDs arguments of reactor.spawnProcess, they are not closed.
Method test_mockForkErrorPTYGivenFDs If a tuple is passed to usePTY to specify slave and master file descriptors and that os.fork raises an exception, these file descriptors aren't closed.
Method test_mockForkInParentGarbageCollectorDisabled The garbage collector should be disabled when reactor.spawnProcess returns if it was initially disabled.
Method test_mockForkInParentGarbageCollectorEnabled The garbage collector should be enabled when reactor.spawnProcess returns if it was initially enabled.
Method test_mockForkTTY Test a TTY spawnProcess: check the path of the client code: fork, exec, exit.
Method test_mockPTYSetUid Try creating a PTY process with setting its uid: it's almost the same path as the standard path, but with a switchUID call before the exec.
Method test_mockPTYSetUidInParent When spawning a child process with PTY and a UID different from the UID of the current process, the current process does not have its UID changed.
Method test_mockSetUid Try creating a process with setting its uid: it's almost the same path as the standard path, but with a switchUID call before the exec.
Method test_mockSetUidInParent When spawning a child process with a UID different from the UID of the current process, the current process does not have its UID changed.
Method test_mockWithExecError Spawn a process but simulate an error during execution in the client path: os.execvpe raises an error. It should close all the standard fds, try to print the error encountered, and exit cleanly.
Method test_mockWithForkErrorGarbageCollectorDisabled The garbage collector should be disabled when reactor.spawnProcess raises because os.fork raised, if it was initially disabled.
Method test_mockWithForkErrorGarbageCollectorEnabled The garbage collector should be enabled when reactor.spawnProcess raises because os.fork raised, if it was initially enabled.
Method test_mockWithWaitError Test that reapProcess logs errors raised.
Class Variable skip Undocumented
Instance Variable mockos Undocumented
Instance Variable mocksig Undocumented
Method _mockForkInParentTest Assert that in the main process, spawnProcess disables the garbage collector, calls fork, closes the pipe file descriptors it created for the child process, and calls waitpid.
Method _mockWithForkError Assert that if the fork call fails, no other process setup calls are made and that spawnProcess raises the exception fork raised.

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

Replace process os, fcntl, sys, switchUID, fdesc and pty modules with the mock class MockOS.

def tearDown(self): (source)

Reset processes registered for reap.

def test_kill(self): (source)

process.Process.signalProcess calls os.kill translating the given signal string to the PID.

def test_killErrorInKill(self): (source)

process.Process.signalProcess doesn't mask OSError exceptions if the errno is different from errno.ESRCH.

def test_killExited(self): (source)
def test_killExitedButNotDetected(self): (source)

process.Process.signalProcess raises error.ProcessExitedAlready if the process has exited but that twisted hasn't seen it (for example, if the process has been waited outside of twisted): os.kill then raise OSError with errno.ESRCH as errno.

def test_mockErrorECHILDInReapProcess(self): (source)

Test that reapProcess doesn't log anything when waitpid raises a OSError with errno ECHILD.

def test_mockErrorInPipe(self): (source)

If os.pipe raises an exception after some pipes where created, the created pipes are closed and don't leak.

def test_mockFork(self): (source)

Test a classic spawnProcess. Check the path of the client code: fork, exec, exit.

def test_mockForkErrorCloseFDs(self): (source)

When os.fork raises an exception, the file descriptors created before are closed and don't leak.

def test_mockForkErrorClosePTY(self): (source)

When os.fork raises an exception, the file descriptors created by pty.openpty are closed and don't leak, when usePTY is set to True.

def test_mockForkErrorGivenFDs(self): (source)

When os.forks raises an exception and that file descriptors have been specified with the childFDs arguments of reactor.spawnProcess, they are not closed.

def test_mockForkErrorPTYGivenFDs(self): (source)

If a tuple is passed to usePTY to specify slave and master file descriptors and that os.fork raises an exception, these file descriptors aren't closed.

def test_mockForkInParentGarbageCollectorDisabled(self): (source)

The garbage collector should be disabled when reactor.spawnProcess returns if it was initially disabled.

@see _mockForkInParentTest

def test_mockForkInParentGarbageCollectorEnabled(self): (source)

The garbage collector should be enabled when reactor.spawnProcess returns if it was initially enabled.

@see _mockForkInParentTest

def test_mockForkTTY(self): (source)

Test a TTY spawnProcess: check the path of the client code: fork, exec, exit.

def test_mockPTYSetUid(self): (source)

Try creating a PTY process with setting its uid: it's almost the same path as the standard path, but with a switchUID call before the exec.

def test_mockPTYSetUidInParent(self): (source)

When spawning a child process with PTY and a UID different from the UID of the current process, the current process does not have its UID changed.

def test_mockSetUid(self): (source)

Try creating a process with setting its uid: it's almost the same path as the standard path, but with a switchUID call before the exec.

def test_mockSetUidInParent(self): (source)

When spawning a child process with a UID different from the UID of the current process, the current process does not have its UID changed.

def test_mockWithExecError(self): (source)

Spawn a process but simulate an error during execution in the client path: os.execvpe raises an error. It should close all the standard fds, try to print the error encountered, and exit cleanly.

def test_mockWithForkErrorGarbageCollectorDisabled(self): (source)

The garbage collector should be disabled when reactor.spawnProcess raises because os.fork raised, if it was initially disabled.

def test_mockWithForkErrorGarbageCollectorEnabled(self): (source)

The garbage collector should be enabled when reactor.spawnProcess raises because os.fork raised, if it was initially enabled.

def test_mockWithWaitError(self): (source)

Test that reapProcess logs errors raised.

skip: str = (source)
overrides twisted.trial.unittest.SynchronousTestCase.skip

Undocumented

mockos = (source)

Undocumented

mocksig = (source)

Undocumented

def _mockForkInParentTest(self): (source)

Assert that in the main process, spawnProcess disables the garbage collector, calls fork, closes the pipe file descriptors it created for the child process, and calls waitpid.

def _mockWithForkError(self): (source)

Assert that if the fork call fails, no other process setup calls are made and that spawnProcess raises the exception fork raised.