-
Notifications
You must be signed in to change notification settings - Fork 109
Organize discovered tests in a runner plan based on the module they're implemented in #1131
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.
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
Draft
stmontgomery
wants to merge
1
commit into
swiftlang:main
Choose a base branch
from
stmontgomery:module-selection
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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 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 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,7 +10,15 @@ | |
|
||
extension Test: Identifiable { | ||
public struct ID: Sendable, Equatable, Hashable { | ||
/// The name of the module containing the corresponding test. | ||
/// The name of the module in which this test is defined. | ||
/// | ||
/// This may be different than the name of the module this test's containing | ||
/// suite type is declared in. For example, if the test is defined in an | ||
/// extension of a type declared in an imported module, the value of this | ||
/// property on the ID of the containing suite will be the name of the | ||
/// imported module, but the value of this property for the ID of the test | ||
/// within that extension will be the name of the module which declares the | ||
/// extension. | ||
public var moduleName: String | ||
|
||
/// The fully qualified name components (other than the module name) used to | ||
|
@@ -123,6 +131,8 @@ extension Test: Identifiable { | |
var result = containingTypeInfo.map(ID.init) | ||
?? ID(moduleName: sourceLocation.moduleName, nameComponents: [], sourceLocation: nil) | ||
|
||
result.moduleName = sourceLocation.moduleName | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. How about we store this value in a separate field (if it differs from the inferred module)? |
||
|
||
if !isSuite { | ||
result.nameComponents.append(name) | ||
result.sourceLocation = sourceLocation | ||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
// | ||
// This source file is part of the Swift.org open source project | ||
// | ||
// Copyright (c) 2025 Apple Inc. and the Swift project authors | ||
// Licensed under Apache License v2.0 with Runtime Library Exception | ||
// | ||
// See https://swift.org/LICENSE.txt for license information | ||
// See https://swift.org/CONTRIBUTORS.txt for Swift project authors | ||
// | ||
|
||
@testable @_spi(ForToolsIntegrationOnly) import Testing | ||
|
||
@Suite("Test.ID Tests") | ||
struct Test_IDTests { | ||
@Test func topmostSuiteInCurrentModule() async throws { | ||
let plan = await Runner.Plan(selecting: SomeSuite.self) | ||
|
||
let suiteID = try #require(plan.tests.first { $0.name == "SomeSuite" }?.id) | ||
#expect(suiteID.moduleName == .currentModuleName()) | ||
|
||
let functionID = try #require(plan.tests.first { $0.name == "example()" }?.id) | ||
#expect(functionID.moduleName == .currentModuleName()) | ||
} | ||
|
||
@Test func topmostSuiteInDifferentModule() async throws { | ||
let plan = await Runner.Plan(selecting: String.AnotherSuite.self) | ||
|
||
let suiteID = try #require(plan.tests.first { $0.name == "AnotherSuite" }?.id) | ||
#expect(suiteID.moduleName == .currentModuleName()) | ||
|
||
let functionID = try #require(plan.tests.first { $0.name == "example()" }?.id) | ||
#expect(functionID.moduleName == .currentModuleName()) | ||
} | ||
} | ||
|
||
// MARK: - Fixtures | ||
|
||
@Suite(.hidden) struct SomeSuite { | ||
@Test func example() {} | ||
} | ||
|
||
extension String { | ||
@Suite(.hidden) struct AnotherSuite { | ||
@Test func example() {} | ||
} | ||
} |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Danger! This is potentially ambiguous. We may want to instead describe such a test in terms of both modules.