[nextest-runner] handle SIGINFO and SIGUSR1 to dump info to screen #1938
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1938 +/- ##
==========================================
+ Coverage 80.11% 80.27% +0.16%
==========================================
Files 83 83
Lines 21251 22078 +827
==========================================
+ Hits 17026 17724 +698
- Misses 4225 4354 +129 ☔ View full report in Codecov by Sentry. |
02439bd to
6760375
Compare
6760375 to
939bdd5
Compare
sunshowers
added a commit
that referenced
this pull request
Dec 5, 2024
In prior work (#1938) we enabled the `SIGUSR1` and `SIGINFO` handlers to dump internal state to standard output. However, those handlers aren't present on all platforms. * `SIGINFO` doesn't exist on Linux. `SIGUSR1` exists but is hard to send signals over (have to use `kill`, nothing like `^T`). * Windows' very basic signal handling mechanism isn't really up to the task. As an alternative, allow these platforms to specify `t` to dump current test information to the interactive terminal. It would also be interesting to support a Unix domain socket as a way to query current state in the future, and have a separate instance of nextest be able to connect to the socket -- this work naturally builds towards that kind of model.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part 1 of work to perform interactive queries.
With this change, if nextest receives either SIGINFO (where available) or SIGUSR1, it will print a list of all currently running tests with their states. The full test state machine is modeled in the event responses, along with possible sources of errors.
I tried making Ctrl-Break on Windows do the same thing, but unfortunately that doesn't quite work in practice. That's because Ctrl-Break is received by all processes connected to the console, not just by the equivalent of the "foreground process group". The printing out of info works, but running tests are immediately aborted as well. So remove this. (In interactive terminals we'll support an alternative -- pressing
i-- which should work for most use cases on Windows.)There is also an undocumented environment variable
__NEXTEST_SIGQUIT_AS_INFOwhich allowsSIGQUIT(Ctrl-\) to perform an info query. Quite useful for testing on Linux, where SIGINFO is sadly unavailable.Note: illumos does support SIGINFO, but that is blocked on an upstream issue: tokio-rs/tokio#6995