Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ensure tests do not leave signalhandlers #6667

Closed
wants to merge 3 commits into from
Closed

Ensure tests do not leave signalhandlers #6667

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
791059b
Ensure tests do not leave signalhandlers
fjetter Jul 4, 2022
77ea746
Use suggested valid_signals
fjetter Jul 4, 2022
9c37048
Ignore suspend for pytest-timeouts
fjetter Jul 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions distributed/utils_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2476,3 +2476,33 @@ def _bind_port(port):
raise TimeoutError(f"Default ports didn't open up in time for {name_of_test}")

yield


_default_signals = None


def _set_default_signals():
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From this function name I assumed it was setting the process' signals with signal.signal, not collecting a copy of the expected signals

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does this work instead?
_default_signals = {sig: signal.getsignal(sig) for sig in signal.valid_signals()}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

>>> pprint.pp({sig: signal.getsignal(sig) for sig in signal.valid_signals()})
{<Signals.SIGHUP: 1>: <Handlers.SIG_DFL: 0>,
 <Signals.SIGINT: 2>: <built-in function default_int_handler>,
 <Signals.SIGQUIT: 3>: <Handlers.SIG_DFL: 0>,
 <Signals.SIGILL: 4>: <Handlers.SIG_DFL: 0>,
 <Signals.SIGTRAP: 5>: <Handlers.SIG_DFL: 0>,
 <Signals.SIGABRT: 6>: <Handlers.SIG_DFL: 0>,
 <Signals.SIGBUS: 7>: <Handlers.SIG_DFL: 0>,
 <Signals.SIGFPE: 8>: <Handlers.SIG_DFL: 0>,
 <Signals.SIGKILL: 9>: <Handlers.SIG_DFL: 0>,
 <Signals.SIGUSR1: 10>: <Handlers.SIG_DFL: 0>,
 <Signals.SIGSEGV: 11>: <Handlers.SIG_DFL: 0>,
 <Signals.SIGUSR2: 12>: <Handlers.SIG_DFL: 0>,
 <Signals.SIGPIPE: 13>: <Handlers.SIG_IGN: 1>,
 <Signals.SIGALRM: 14>: <Handlers.SIG_DFL: 0>,
 <Signals.SIGTERM: 15>: <Handlers.SIG_DFL: 0>,
 16: <Handlers.SIG_DFL: 0>,
 <Signals.SIGCHLD: 17>: <Handlers.SIG_DFL: 0>,
 <Signals.SIGCONT: 18>: <Handlers.SIG_DFL: 0>,
 <Signals.SIGSTOP: 19>: <Handlers.SIG_DFL: 0>,
 <Signals.SIGTSTP: 20>: <Handlers.SIG_DFL: 0>,
 <Signals.SIGTTIN: 21>: <Handlers.SIG_DFL: 0>,
 <Signals.SIGTTOU: 22>: <Handlers.SIG_DFL: 0>,
 <Signals.SIGURG: 23>: <Handlers.SIG_DFL: 0>,
 <Signals.SIGXCPU: 24>: <Handlers.SIG_DFL: 0>,
 <Signals.SIGXFSZ: 25>: <Handlers.SIG_IGN: 1>,
 <Signals.SIGVTALRM: 26>: <Handlers.SIG_DFL: 0>,
 <Signals.SIGPROF: 27>: <Handlers.SIG_DFL: 0>,
 <Signals.SIGWINCH: 28>: <Handlers.SIG_DFL: 0>,
 <Signals.SIGIO: 29>: <Handlers.SIG_DFL: 0>,
 <Signals.SIGPWR: 30>: <Handlers.SIG_DFL: 0>,
 <Signals.SIGSYS: 31>: <Handlers.SIG_DFL: 0>,
 <Signals.SIGRTMIN: 34>: <Handlers.SIG_DFL: 0>,
 35: <Handlers.SIG_DFL: 0>,
 36: <Handlers.SIG_DFL: 0>,
 37: <Handlers.SIG_DFL: 0>,
 38: <Handlers.SIG_DFL: 0>,
 39: <Handlers.SIG_DFL: 0>,
 40: <Handlers.SIG_DFL: 0>,
 41: <Handlers.SIG_DFL: 0>,
 42: <Handlers.SIG_DFL: 0>,
 43: <Handlers.SIG_DFL: 0>,
 44: <Handlers.SIG_DFL: 0>,
 45: <Handlers.SIG_DFL: 0>,
 46: <Handlers.SIG_DFL: 0>,
 47: <Handlers.SIG_DFL: 0>,
 48: <Handlers.SIG_DFL: 0>,
 49: <Handlers.SIG_DFL: 0>,
 50: <Handlers.SIG_DFL: 0>,
 51: <Handlers.SIG_DFL: 0>,
 52: <Handlers.SIG_DFL: 0>,
 53: <Handlers.SIG_DFL: 0>,
 54: <Handlers.SIG_DFL: 0>,
 55: <Handlers.SIG_DFL: 0>,
 56: <Handlers.SIG_DFL: 0>,
 57: <Handlers.SIG_DFL: 0>,
 58: <Handlers.SIG_DFL: 0>,
 59: <Handlers.SIG_DFL: 0>,
 60: <Handlers.SIG_DFL: 0>,
 61: <Handlers.SIG_DFL: 0>,
 62: <Handlers.SIG_DFL: 0>,
 63: <Handlers.SIG_DFL: 0>,
 <Signals.SIGRTMAX: 64>: <Handlers.SIG_DFL: 0>}

Copy link
Member

@graingert graingert Jul 4, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pytest-timeout can use SIGALRM, the asyncio subprocess watcher MultiLoopChildWatcher and SafeChildWatcher can use SIGCHLD

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pytest-timeout can use SIGALRM, the asyncio subprocess watcher MultiLoopChildWatcher and SafeChildWatcher can use SIGCHLD

Question is when they'd install their handlers. I don't mind anybody using custom handlers but I want to make sure tests are not modifying this w/out cleanup (this is just paranoia), similar to our clean fixture

global _default_signals
default_signals = {}
for sig in signal.Signals:
try:
default_signals[sig] = signal.getsignal(sig)
except ValueError:
break


def assert_default_signal_handlers():
if not _default_signals:
_set_default_signals()
assert _default_signals
for sig, default_handler in _default_signals.items():
assert (
signal.getsignal(sig) is default_handler
), f"Non-default handler installed for signal {sig}: {signal.getsignal(sig)}"


@pytest.fixture(autouse=True)
def ensure_default_signalhandlers_active():
assert_default_signal_handlers()
yield
assert_default_signal_handlers()