Change the semantics of Test.cancel().
#1332
Merged
Conversation
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
This PR changes the semantics of `Test.cancel()` such that it only cancels the current test case if the current test is parameterized. This PR also removes `Test.Case.cancel()`, but we may opt to add `Test.Case.cancelAll()` or some such in the future to re-add an interface that cancels an entire parameterized test.
grynspan
requested review from
briancroom and
suzannaratcliff
as code owners
grynspan
commented
Sep 22, 2025
| configuration.eventHandler = { event, eventContext in | ||
| switch event.kind { | ||
| case .issueRecorded, .valueAttached, .testCancelled, .testCaseCancelled: | ||
| case .issueRecorded, .valueAttached, .testCancelled: |
There was a problem hiding this comment.
Exit tests no longer need to be concerned with .testCaseCancelled events.
grynspan
commented
Sep 22, 2025
| static func withCurrent<R>(_ test: Self, perform body: () async throws -> R) async rethrows -> R { | ||
| var runtimeState = Runner.RuntimeState.current ?? .init() | ||
| runtimeState.test = test | ||
| runtimeState.testCase = nil |
There was a problem hiding this comment.
This change looks out-of-place, but it ensures that when we set the current test, we clear the current test case. This has no effect on third-party tests but ensures when we run nested tests of our own that they don't get their states intermingled (which breaks Test.cancel()'s new semantics.)
There was a problem hiding this comment.
Good catch. This is probably something we'd probably want even if we'd never sought to add test cancellation
stmontgomery
approved these changes
Sep 23, 2025
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 changes the semantics of
Test.cancel()such that it only cancels the current test case if the current test is parameterized. This PR also removesTest.Case.cancel(), but we may opt to addTest.Case.cancelAll()or some such in the future to re-add an interface that cancels an entire parameterized test.Checklist: