twisted.test.test_process.MockProcessTests(unittest.TestCase) class documentation

Part of twisted.test.test_process (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_mockFork Test a classic spawnProcess. Check the path of the client code: fork, exec, exit.
Method test_mockForkInParentGarbageCollectorEnabled The garbage collector should be enabled when reactor.spawnProcess returns if it was initially enabled.
Method test_mockForkInParentGarbageCollectorDisabled The garbage collector should be disabled when reactor.spawnProcess returns if it was initially disabled.
Method test_mockForkTTY Test a TTY spawnProcess: check the path of the client code: fork, exec, exit.
Method test_mockWithForkErrorGarbageCollectorEnabled The garbage collector should be enabled when reactor.spawnProcess raises because os.fork raised, if it was initially enabled.
Method test_mockWithForkErrorGarbageCollectorDisabled The garbage collector should be disabled when reactor.spawnProcess raises because os.fork raised, if it was initially disabled.
Method test_mockForkErrorCloseFDs When os.fork raises an exception, the file descriptors created before are closed and don't leak.
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_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_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_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_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_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_mockWithWaitError Test that reapProcess logs errors raised.
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_kill process.Process.signalProcess calls os.kill translating the given signal string to the PID.
Method test_killExited process.Process.signalProcess raises error.ProcessExitedAlready if the process has exited.
Method test_killExitedButNotDetected No summary
Method test_killErrorInKill process.Process.signalProcess doesn't mask OSError exceptions if the errno is different from errno.ESRCH.
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:

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):

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

def tearDown(self):

Reset processes registered for reap.

def test_mockFork(self):

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

def _mockForkInParentTest(self):

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 test_mockForkInParentGarbageCollectorEnabled(self): 
The garbage collector should be enabled when L{reactor.spawnProcess}
returns if it was initially enabled.

@see L{_mockForkInParentTest}
def test_mockForkInParentGarbageCollectorDisabled(self): 
The garbage collector should be disabled when L{reactor.spawnProcess}
returns if it was initially disabled.

@see L{_mockForkInParentTest}
def test_mockForkTTY(self):

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

def _mockWithForkError(self):

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

def test_mockWithForkErrorGarbageCollectorEnabled(self):

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

def test_mockWithForkErrorGarbageCollectorDisabled(self):

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

def test_mockForkErrorCloseFDs(self):

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

def test_mockForkErrorGivenFDs(self):

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

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

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

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

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):

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

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):

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

Test that reapProcess logs errors raised.

def test_mockErrorECHILDInReapProcess(self):

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

def test_mockErrorInPipe(self):

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

def test_kill(self):

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

def test_killExited(self):

process.Process.signalProcess raises error.ProcessExitedAlready if the process has exited.

def test_killExitedButNotDetected(self):

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

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

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