Skip to content

Add a facility for tests to opt in to loading the downloadable Metal toolchain #747

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Aug 21, 2025
Merged

Add a facility for tests to opt in to loading the downloadable Metal toolchain #747

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions Sources/SWBTestSupport/CoreBasedTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,11 @@ package protocol CoreBasedTests {
}

extension CoreBasedTests {
package static func makeCore(skipLoadingPluginsNamed: Set<String> = [], registerExtraPlugins: @PluginExtensionSystemActor (PluginManager) -> Void = { _ in }, simulatedInferiorProductsPath: Path? = nil, environment: [String: String] = [:], _ delegate: TestingCoreDelegate? = nil, sourceLocation: SourceLocation = #_sourceLocation) async throws -> Core {
/// This will create a customized `Core` object using the specified parameters, providing a test with detailed control over the contents of the `Core` it uses.
package static func makeCore(skipLoadingPluginsNamed: Set<String> = [], registerExtraPlugins: @PluginExtensionSystemActor (PluginManager) -> Void = { _ in }, simulatedInferiorProductsPath: Path? = nil, environment: [String: String] = [:], _ delegate: TestingCoreDelegate? = nil, configurationDelegate: TestingCoreConfigurationDelegate? = nil, sourceLocation: SourceLocation = #_sourceLocation) async throws -> Core {
let core: Result<Core, any Error>
do {
let theCore = try await Core.createInitializedTestingCore(skipLoadingPluginsNamed: skipLoadingPluginsNamed, registerExtraPlugins: registerExtraPlugins, simulatedInferiorProductsPath: simulatedInferiorProductsPath, environment: environment, delegate: delegate)
let theCore = try await Core.createInitializedTestingCore(skipLoadingPluginsNamed: skipLoadingPluginsNamed, registerExtraPlugins: registerExtraPlugins, simulatedInferiorProductsPath: simulatedInferiorProductsPath, environment: environment, delegate: delegate, configurationDelegate: configurationDelegate)
core = .success(theCore)
} catch {
core = .failure(error)
Expand All @@ -48,6 +49,7 @@ extension CoreBasedTests {
return try Self._getCore(core: core, sourceLocation: sourceLocation)
}

/// This private method caches the `Core` object created in `GetCore(sourceLocation:)`, and returns the same object if queried again.
private static func _getCore(core: Result<Core, any Error>, sourceLocation: SourceLocation = #_sourceLocation) throws -> Core {
do {
return try core.get()
Expand Down
66 changes: 40 additions & 26 deletions Sources/SWBTestSupport/CoreTestSupport.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ extension Core {
/// Get an initialized Core suitable for testing.
///
/// This function requires there to be no errors during loading the core.
package static func createInitializedTestingCore(skipLoadingPluginsNamed: Set<String>, registerExtraPlugins: @PluginExtensionSystemActor (PluginManager) -> Void, simulatedInferiorProductsPath: Path? = nil, environment: [String:String] = [:], delegate: TestingCoreDelegate? = nil) async throws -> Core {
package static func createInitializedTestingCore(skipLoadingPluginsNamed: Set<String>, registerExtraPlugins: @PluginExtensionSystemActor (PluginManager) -> Void, simulatedInferiorProductsPath: Path? = nil, environment: [String:String] = [:], delegate: TestingCoreDelegate? = nil, configurationDelegate: TestingCoreConfigurationDelegate? = nil) async throws -> Core {
// When this code is being loaded directly via unit tests, find the running Xcode path.
//
// This is a "well known" launch parameter set in Xcode's schemes.
Expand All @@ -74,33 +74,35 @@ extension Core {
//
// If the given environment already contains `EXTERNAL_TOOLCHAINS_DIR` and `TOOLCHAINS`, we're assuming that we do not have to obtain any toolchain information.
var environment = environment
if (try? ProcessInfo.processInfo.hostOperatingSystem()) == .macOS, !(environment.contains("EXTERNAL_TOOLCHAINS_DIR") && environment.contains("TOOLCHAINS")) {
let activeDeveloperPath: Path
if let developerPath {
activeDeveloperPath = developerPath.path
} else {
activeDeveloperPath = try await Xcode.getActiveDeveloperDirectoryPath()
}
let defaultToolchainPath = activeDeveloperPath.join("Toolchains/XcodeDefault.xctoolchain")

if !localFS.exists(defaultToolchainPath.join("usr/metal/current")) {
struct MetalToolchainInfo: Decodable {
let buildVersion: String
let status: String
let toolchainIdentifier: String
let toolchainSearchPath: String
if configurationDelegate?.loadMetalToolchain == true {
if (try? ProcessInfo.processInfo.hostOperatingSystem()) == .macOS, !(environment.contains("EXTERNAL_TOOLCHAINS_DIR") && environment.contains("TOOLCHAINS")) {
let activeDeveloperPath: Path
if let developerPath {
activeDeveloperPath = developerPath.path
} else {
activeDeveloperPath = try await Xcode.getActiveDeveloperDirectoryPath()
}

let result = try await Process.getOutput(url: URL(fileURLWithPath: activeDeveloperPath.join("usr/bin/xcodebuild").str), arguments: ["-showComponent", "metalToolchain", "-json"], environment: ["DEVELOPER_DIR": activeDeveloperPath.str])
if result.exitStatus != .exit(0) {
throw StubError.error("xcodebuild failed: \(String(data: result.stdout, encoding: .utf8) ?? "")\n\(String(data: result.stderr, encoding: .utf8) ?? "")")
let defaultToolchainPath = activeDeveloperPath.join("Toolchains/XcodeDefault.xctoolchain")

if !localFS.exists(defaultToolchainPath.join("usr/metal/current")) {
struct MetalToolchainInfo: Decodable {
let buildVersion: String
let status: String
let toolchainIdentifier: String
let toolchainSearchPath: String
}

let result = try await Process.getOutput(url: URL(fileURLWithPath: activeDeveloperPath.join("usr/bin/xcodebuild").str), arguments: ["-showComponent", "metalToolchain", "-json"], environment: ["DEVELOPER_DIR": activeDeveloperPath.str])
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should use runProcess instead, since it already wraps getOutput with the necessary plumbing to emit a good error message if the command fails.

if result.exitStatus != .exit(0) {
throw StubError.error("xcodebuild failed: \(String(data: result.stdout, encoding: .utf8) ?? "")\n\(String(data: result.stderr, encoding: .utf8) ?? "")")
}

let metalToolchainInfo = try JSONDecoder().decode(MetalToolchainInfo.self, from: result.stdout)
environment.addContents(of: [
"TOOLCHAINS": "\(metalToolchainInfo.toolchainIdentifier) $(inherited)",
"EXTERNAL_TOOLCHAINS_DIR": metalToolchainInfo.toolchainSearchPath,
])
}

let metalToolchainInfo = try JSONDecoder().decode(MetalToolchainInfo.self, from: result.stdout)
environment.addContents(of: [
"TOOLCHAINS": "\(metalToolchainInfo.toolchainIdentifier) $(inherited)",
"EXTERNAL_TOOLCHAINS_DIR": metalToolchainInfo.toolchainSearchPath,
])
}
}

Expand Down Expand Up @@ -246,3 +248,15 @@ package final class TestingCoreDelegate: CoreDelegate, Sendable {
return _diagnosticsEngine.diagnostics.pathMessageTuples(.warning)
}
}

/// Individual classes may pass an instance of this protocol to `CoreBasedTests.makeCore()` to configure which special elements of the testing core they need. `Core.createInitializedTestingCore()` (above) will configure the core based on what's passed here.
///
/// This allows tests which don't care about those elements to not fail because of errors trying to load them.
package struct TestingCoreConfigurationDelegate: Sendable {
/// Only tests which are exercising Metal should need to load the Metal toolchain, so only those tests will fail if loading the toolchain fails.
package let loadMetalToolchain: Bool

package init(loadMetalToolchain: Bool = false) {
self.loadMetalToolchain = loadMetalToolchain
}
}
2 changes: 1 addition & 1 deletion Tests/SWBBuildSystemTests/BuildCommandTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ fileprivate struct BuildCommandTests: CoreBasedTests {

@Test(.requireSDKs(.macOS), .requireXcode16())
func singleFileCompileMetal() async throws {
let core = try await getCore()
let core = try await Self.makeCore(configurationDelegate: TestingCoreConfigurationDelegate(loadMetalToolchain: true))
try await withTemporaryDirectory { tmpDirPath async throws -> Void in
let testWorkspace = try await TestWorkspace(
"Test",
Expand Down
2 changes: 1 addition & 1 deletion Tests/SWBBuildSystemTests/BuildOperationTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5794,7 +5794,7 @@ That command depends on command in Target 'agg2' (project \'aProject\'): script

@Test(.requireSDKs(.macOS))
func incrementalMetalLinkWithCodeSign() async throws {
let core = try await getCore()
let core = try await Self.makeCore(configurationDelegate: TestingCoreConfigurationDelegate(loadMetalToolchain: true))
try await withTemporaryDirectory { tmpDirPath async throws -> Void in
let testWorkspace = try await TestWorkspace(
"Test",
Expand Down