def test_running_context():
"""Start process and shuts it down."""
executor = SimpleExecutor(sleep_300)
with executor:
assert executor.running() is True
assert executor.running() is False
def test_forgotten_stop():
"""
Test if SimpleExecutor subprocess is killed after an instance is deleted.
Existence can end because of context scope end or by calling 'del'.
If someone forgot to stop() or kill() subprocess it should be killed
by default on instance cleanup.
"""
mark = str(uuid.uuid1())
# We cannot simply do `sleep 300 #<our-uuid>` in a shell because in that
# case bash (default shell on some systems) does `execve` without cloning
# itself - that means there will be no process with commandline like:
# '/bin/sh -c sleep 300 && true #<our-uuid>' - instead that process would
# get substituted with 'sleep 300' and the marked commandline would be
# overwritten.
# Injecting some flow control (`&&`) forces bash to fork properly.
marked_command = 'sleep 300 && true #{0!s}'.format(mark)
executor = SimpleExecutor(marked_command, shell=True)
executor.start()
assert executor.running() is True
assert mark in ps_aux(), "The test process should be running."
del executor
gc.collect() # to force 'del' immediate effect
assert (mark not in ps_aux(),
"The test process should not be running at this point.")
def test_running_context():
"""Start process and shuts it down."""
executor = SimpleExecutor(sleep_300)
with executor:
assert executor.running() is True
assert executor.running() is False
def test_forgotten_stop():
"""
Test if SimpleExecutor subprocess is killed after an instance is deleted.
Existence can end because of context scope end or by calling 'del'.
If someone forgot to stop() or kill() subprocess it should be killed
by default on instance cleanup.
"""
mark = str(uuid.uuid1())
# We cannot simply do `sleep 300 #<our-uuid>` in a shell because in that
# case bash (default shell on some systems) does `execve` without cloning
# itself - that means there will be no process with commandline like:
# '/bin/sh -c sleep 300 && true #<our-uuid>' - instead that process would
# get substituted with 'sleep 300' and the marked commandline would be
# overwritten.
# Injecting some flow control (`&&`) forces bash to fork properly.
marked_command = 'sleep 300 && true #%s' % mark
executor = SimpleExecutor(marked_command, shell=True)
executor.start()
assert executor.running() is True
assert mark in ps_aux(), "The test process should be running."
del executor
gc.collect() # to force 'del' immediate effect
assert (mark not in ps_aux(),
"The test process should not be running at this point.")
def test_stderr_callback():
read_stdout = mock.Mock()
read_stderr = mock.Mock()
executor = SimpleExecutor(['bash', '-c', 'echo hello >&2'],
stdout_callback=read_stdout,
stderr_callback=read_stderr,
timeout=2.0)
executor.start()
assert read_stdout.call_args_list == []
assert read_stderr.call_args_list == [mock.call('hello\n')]
def test_executor_methods_returning_self():
"""Test if SimpleExecutor lets to chain start, stop and kill methods."""
executor = SimpleExecutor(SLEEP_300).start().stop().kill().stop()
assert not executor.running()
# Check if context manager returns executor to use it in 'as' phrase:
with SimpleExecutor(SLEEP_300) as executor:
assert executor.running()
with SimpleExecutor(SLEEP_300).start().stopped() as executor:
assert not executor.running()
assert SimpleExecutor(SLEEP_300).start().stop().output
def test_kill_custom_signal_kill():
"""Start process and shuts it down using signal SIGQUIT passed to kill."""
executor = SimpleExecutor(sleep_300)
executor.start()
assert executor.running() is True
executor.kill(sig=signal.SIGQUIT)
assert executor.running() is False
def test_custom_signal_stop():
"""Start process and shuts it down using signal SIGQUIT."""
executor = SimpleExecutor(sleep_300, sig_stop=signal.SIGQUIT)
executor.start()
assert executor.running() is True
executor.stop()
assert executor.running() is False
def test_stop_custom_signal_stop():
"""Start process and shuts it down using signal SIGQUIT passed to stop."""
executor = SimpleExecutor(SLEEP_300)
executor.start()
assert executor.running() is True
executor.stop(stop_signal=signal.SIGQUIT)
assert executor.running() is False
def test_stopping_not_yet_running_executor():
"""
Test if SimpleExecutor can be stopped even it was never running.
We must make sure that it's possible to call .stop() and SimpleExecutor
will not raise any exception and .start() can be called afterwards.
"""
executor = SimpleExecutor(sleep_300)
executor.stop()
executor.start()
assert executor.running() is True
executor.stop()
def test_kill_custom_signal_kill():
"""Start process and shuts it down using signal SIGQUIT passed to kill."""
executor = SimpleExecutor(sleep_300)
executor.start()
assert executor.running() is True
executor.kill(sig=signal.SIGQUIT)
assert executor.running() is False
def test_process_output(command: Union[str, List[str]]) -> None:
"""Start process, check output and shut it down."""
executor = SimpleExecutor(command)
executor.start()
assert executor.output().read() == "foobar\n"
executor.stop()
def test_stop_custom_signal_stop():
"""Start process and shuts it down using signal SIGQUIT passed to stop."""
executor = SimpleExecutor(SLEEP_300)
executor.start()
assert executor.running() is True
executor.stop(sig=signal.SIGQUIT)
assert executor.running() is False
def test_process_output_shell(command: Union[str, List[str]]) -> None:
"""Start process, check output and shut it down with shell set to True."""
executor = SimpleExecutor(command, shell=True)
executor.start()
assert executor.output().read().strip() == "foobar"
executor.stop()
def test_process_output(command):
"""Start process, check output and shut it down."""
executor = SimpleExecutor(command)
executor.start()
assert executor.output().read() == 'foobar'
executor.stop()
def test_process_output_shell(command):
"""Start process, check output and shut it down with shell set to True."""
executor = SimpleExecutor(command, shell=True)
executor.start()
assert executor.output().read() == 'foobar'
executor.stop()
def test_stop_custom_exit_signal_stop():
"""Start process and expect it to finish with custom signal."""
executor = SimpleExecutor('false', shell=True)
executor.start()
# false exits instant, so there should not be a process to stop
executor.stop(sig=signal.SIGQUIT, exp_sig=3)
assert executor.running() is False
def test_custom_signal_stop():
"""Start process and shuts it down using signal SIGQUIT."""
executor = SimpleExecutor(sleep_300, sig_stop=signal.SIGQUIT)
executor.start()
assert executor.running() is True
executor.stop()
assert executor.running() is False
def test_running_process(command: Union[str, List[str]]) -> None:
"""Start process and shuts it down."""
executor = SimpleExecutor(command)
executor.start()
assert executor.running() is True
executor.stop()
assert executor.running() is False
# check proper __str__ and __repr__ rendering:
assert "SimpleExecutor" in repr(executor)
assert SLEEP_300 in str(executor)
def test_running_process(command):
"""Start process and shuts it down."""
executor = SimpleExecutor(command)
executor.start()
assert executor.running() is True
executor.stop()
assert executor.running() is False
# check proper __str__ and __repr__ rendering:
assert 'SimpleExecutor' in repr(executor)
assert 'sleep 300' in str(executor)
def test_stopping_not_yet_running_executor():
"""
Test if SimpleExecutor can be stopped even it was never running.
We must make sure that it's possible to call .stop() and SimpleExecutor
will not raise any exception and .start() can be called afterwards.
"""
executor = SimpleExecutor(sleep_300)
executor.stop()
executor.start()
assert executor.running() is True
executor.stop()
def test_executor_methods_returning_self():
"""Test if SimpleExecutor lets to chain start, stop and kill methods."""
executor = SimpleExecutor(SLEEP_300).start().stop().kill().stop()
assert not executor.running()
# Check if context manager returns executor to use it in 'as' phrase:
with SimpleExecutor(SLEEP_300) as executor:
assert executor.running()
with SimpleExecutor(SLEEP_300).start().stopped() as executor:
assert not executor.running()
assert SimpleExecutor(SLEEP_300).start().stop().output
def test_context_stopped():
"""Start for context, and shuts it for nested context."""
executor = SimpleExecutor(sleep_300)
with executor:
assert executor.running() is True
with executor.stopped():
assert executor.running() is False
assert executor.running() is True
assert executor.running() is False
def test_process_output(command):
"""Start process, check output and shut it down."""
executor = SimpleExecutor(command)
executor.start()
assert executor.output().read() == 'foobar'
executor.stop()
def test_process_output_shell(command):
"""Start process, check output and shut it down with shell set to True."""
executor = SimpleExecutor(command, shell=True)
executor.start()
assert executor.output().read() == 'foobar'
executor.stop()
def test_running_process(command):
"""Start process and shuts it down."""
executor = SimpleExecutor(command)
executor.start()
assert executor.running() is True
executor.stop()
assert executor.running() is False
# check proper __str__ and __repr__ rendering:
assert 'SimpleExecutor' in repr(executor)
assert 'sleep 300' in str(executor)
def test_stop_custom_exit_signal_stop():
"""Start process and expect it to finish with custom signal."""
executor = SimpleExecutor("false", shell=True)
executor.start()
# false exits instant, so there should not be a process to stop
retry(lambda: executor.stop(stop_signal=signal.SIGQUIT,
expected_returncode=-3))
assert executor.running() is False
def test_context_stopped():
"""Start for context, and shuts it for nested context."""
executor = SimpleExecutor(sleep_300)
with executor:
assert executor.running() is True
with executor.stopped():
assert executor.running() is False
assert executor.running() is True
assert executor.running() is False
def test_daemons_killing():
"""
Test if all subprocesses of SimpleExecutor can be killed.
The most problematic subprocesses are daemons or other services that
change the process group ID. This test verifies that daemon process
is killed after executor's kill().
"""
executor = SimpleExecutor(('python', sample_daemon_path), shell=True)
executor.start()
time.sleep(2)
assert executor.running() is not True, \
"Executor should not have subprocess running as it started a daemon."
assert sample_daemon_path in ps_aux()
executor.kill()
assert sample_daemon_path not in ps_aux()
def test_command(command: Union[str, List[str]]) -> None:
"""Check that the command and command parts are equivalent."""
executor = SimpleExecutor(command)
assert executor.command == SLEEP_300
assert executor.command_parts == SLEEP_300.split()
def test_command(command):
"""Check that the command and command parts are equivalent."""
executor = SimpleExecutor(command)
assert executor.command == SLEEP_300
assert executor.command_parts == SLEEP_300.split()
def test_daemons_killing():
"""
Test if all subprocesses of SimpleExecutor can be killed.
The most problematic subprocesses are daemons or other services that
change the process group ID. This test verifies that daemon process
is killed after executor's kill().
"""
executor = SimpleExecutor(('python', sample_daemon_path), shell=True)
executor.start()
time.sleep(1)
assert executor.running() is not True, \
"Executor should not have subprocess running as it's started daemon."
assert sample_daemon_path in ps_aux()
executor.kill()
assert sample_daemon_path not in ps_aux()
# Second part of this test verifies exceptions being called if `ps xe -ww`
# was called on some OS that doesn't have it.
executor.start()
time.sleep(1)
def fake_output(args):
check_output('something_not_existing_called')
with mock.patch('subprocess.check_output', side_effect=fake_output) as co:
with mock.patch('mirakuru.base.log') as log:
executor.kill()
assert co.mock_calls == [mock.call(('ps', 'xe', '-ww'))]
assert 'error' == log.mock_calls[0][0]
assert '`$ ps xe -ww` command was called' in log.mock_calls[0][1][0]
assert sample_daemon_path in ps_aux()
executor.kill()
assert sample_daemon_path not in ps_aux()
def test_stop_custom_exit_signal_context():
"""Start process and expect custom exit signal in context manager."""
with SimpleExecutor("false", expected_returncode=-3,
shell=True) as executor:
executor.stop(stop_signal=signal.SIGQUIT)
assert executor.running() is False
def test_executor_in_context_only():
"""Start process and shuts it down only in context."""
with SimpleExecutor(SLEEP_300) as executor:
assert executor.running() is True
def test_daemons_killing():
"""
Test if all subprocesses of SimpleExecutor can be killed.
The most problematic subprocesses are daemons or other services that
change the process group ID. This test verifies that daemon process
is killed after executor's kill().
"""
executor = SimpleExecutor(('python', sample_daemon_path), shell=True)
executor.start()
time.sleep(1)
assert executor.running() is not True, \
"Executor should not have subprocess running as it's started daemon."
assert sample_daemon_path in ps_aux()
executor.kill()
assert sample_daemon_path not in ps_aux()
# Second part of this test verifies exceptions being called if `ps xe -ww`
# was called on some OS that doesn't have it.
executor.start()
time.sleep(1)
def fake_output(args):
check_output('something_not_existing_called')
with mock.patch('subprocess.check_output', side_effect=fake_output) as co:
with mock.patch('mirakuru.base.log') as log:
executor.kill()
assert co.mock_calls == [mock.call(('ps', 'xe', '-ww'))]
assert 'error' == log.mock_calls[0][0]
assert '`$ ps xe -ww` command was called' in log.mock_calls[0][1][0]
assert sample_daemon_path in ps_aux()
executor.kill()
assert sample_daemon_path not in ps_aux()
