Add withTimeout() to surface hangs as diagnosable failures#267
Open
broken-circle wants to merge 1 commit into
Open
Add withTimeout() to surface hangs as diagnosable failures#267broken-circle wants to merge 1 commit into
withTimeout() to surface hangs as diagnosable failures#267broken-circle wants to merge 1 commit into
Conversation
Some tests such as `testDoesNotReapUnrelatedChildProcess()` non- deterministically hang, consuming the full CI job timeout with no actionable signal. Surface the hang as a `TimeoutError` with the test name and timeout duration instead.
Contributor
|
I actually don't remember why I suggested using the Swift Build code as Swift Testing has had the testTimeout trait for well over a year. @iCharlesHu do you remember what the issue was here? |
Contributor
Author
|
Yeah,
The 1 minute timeout is fine for this test, but if finer-grained timeouts come up later, the helper would be more useful. I'd say we can drop it now and come back to it later if we need it. |
This file contains hidden or 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
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.
This PR adds
withTimeout()as an internal test helper and applies it totestDoesNotReapUnrelatedChildProcess(), so a hang surfaces as aTimeoutErrorwith the test name and timeout duration instead of consuming the full CI job timeout with no actionable diagnostic.withTimeout()is adapted from the swift-build implementation as suggested by @jakepetroules. I madedescriptionnon-optional since every call site in this repo is likely to want a useful description, addeddefer-based cancelation, and threw directly fromgroup.next(). I can use the exactswift-buildversion if you'd prefer it.Addresses #157, which should remain open until the reason for the underlying hang is determined.