Simplify how we filter out hidden tests. #115
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
grynspan
requested review from
SeanROlszewski,
briancroom,
dennisweissmann,
ejvaughan,
stmontgomery and
suzannaratcliff
as code owners
grynspan
commented
Nov 14, 2023
Contributor
Author
There was a problem hiding this comment.
By making the argument here non-optional, we simplify the logic quite a bit. If a caller wants to reset the test filter, they can set it to { _ in true }, but in practice I don't think mutating a test filter in-flight is a concern for us.
Right now, we're checking if tests are hidden in multiple places during execution. This is somewhat inefficient, but it's also error-prone because it means that we can create new code paths that _don't_ correctly check for hidden tests. This PR consolidates the checks for hidden tests to `Configuration.testFilter` itself. With this change, hidden tests are _always_ filtered out by that filtering function regardless of what value it's set to. The only escape hatch—which we need for our own unit tests only—is to explicitly call the internal-only `Configuration.setTestFilter(toMatch:includeHiddenTests:)` and pass `true`.
grynspan
force-pushed
the
jgrynspan/simplify-hidden-filtering
branch
from
03f1390 to
2442360
Compare
Contributor
Author
|
@swift-ci please test |
Contributor
Author
|
@swift-ci please test Linux |
stmontgomery
approved these changes
Nov 14, 2023
dennisweissmann
approved these changes
Nov 14, 2023
Contributor
Author
|
As @suzannaratcliff worked on this code recently, I'm waiting for her to also take a look before I merge. |
suzannaratcliff
approved these changes
Nov 14, 2023
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.
Right now, we're checking if tests are hidden in multiple places during execution. This is somewhat inefficient, but it's also error-prone because it means that we can create new code paths that don't correctly check for hidden tests.
This PR consolidates the checks for hidden tests to
Configuration.testFilteritself. With this change, hidden tests are always filtered out by that filtering function regardless of what value it's set to. The only escape hatch—which we need for our own unit tests only—is to explicitly call the internal-onlyConfiguration.setTestFilter(toMatch:includeHiddenTests:)and passtrue.Checklist: