Task / Configurable runner environment

Sources/ScipioKit/BuildOptions.swift

@@ -1,7 +1,20 @@
 import Foundation
 import OrderedCollections
+import Basics
 
 struct BuildOptions: Hashable, Codable, Sendable {
+
+    private enum CodingKeys: CodingKey {
+        case buildConfiguration
+        case isDebugSymbolsEmbedded
+        case frameworkType
+        case sdks
+        case extraFlags
+        case extraBuildParameters
+        case enableLibraryEvolution
+        case customFrameworkModuleMapContents
+    }
+
     init(
         buildConfiguration: BuildConfiguration,
         isDebugSymbolsEmbedded: Bool,
@@ -10,7 +23,8 @@ struct BuildOptions: Hashable, Codable, Sendable {
         extraFlags: ExtraFlags?,
         extraBuildParameters: ExtraBuildParameters?,
         enableLibraryEvolution: Bool,
-        customFrameworkModuleMapContents: Data?
+        customFrameworkModuleMapContents: Data?,
+        toolchainEnvironment: [String: String]?
     ) {
         self.buildConfiguration = buildConfiguration
         self.isDebugSymbolsEmbedded = isDebugSymbolsEmbedded
@@ -20,6 +34,7 @@ struct BuildOptions: Hashable, Codable, Sendable {
         self.extraBuildParameters = extraBuildParameters
         self.enableLibraryEvolution = enableLibraryEvolution
         self.customFrameworkModuleMapContents = customFrameworkModuleMapContents
+        self.toolchainEnvironment = toolchainEnvironment
     }
 
     let buildConfiguration: BuildConfiguration
@@ -33,6 +48,7 @@ struct BuildOptions: Hashable, Codable, Sendable {
     /// - Note: It have to store the actual file contents rather than its path,
     /// because the cache key should change when the file contents change.
     let customFrameworkModuleMapContents: Data?
+    private(set) var toolchainEnvironment: [String: String]?
 }
 
 public struct ExtraFlags: Hashable, Codable, Sendable {
@@ -189,3 +205,15 @@ extension ExtraFlags {
         )
     }
 }
+
+#if compiler(>=6.0)
+
+extension Environment: @retroactive Hashable {
+    public func hash(into hasher: inout Hasher) {
+        for item in self {
+            hasher.combine(item.value)
+        }
+    }
+}
+
+#endif

Sources/ScipioKit/Producer/PIF/PIFCompiler.swift

@@ -30,15 +30,15 @@ struct PIFCompiler: Compiler {
 
     private func fetchDefaultToolchainBinPath() async throws -> AbsolutePath {
         let result = try await executor.execute("/usr/bin/xcrun", "xcode-select", "-p")
-        let rawString = try result.unwrapOutput()
+        let rawString = try result.unwrapOutput().trimmingCharacters(in: .whitespacesAndNewlines)
         let developerDirPath = try AbsolutePath(validating: rawString)
         let toolchainPath = try RelativePath(validating: "./Toolchains/XcodeDefault.xctoolchain/usr/bin")
         return developerDirPath.appending(toolchainPath)
     }
 
     private func makeToolchain(for sdk: SDK) async throws -> UserToolchain {
         let toolchainDirPath = try await fetchDefaultToolchainBinPath()
-        let toolchainGenerator = ToolchainGenerator(toolchainDirPath: toolchainDirPath)
+        let toolchainGenerator = ToolchainGenerator(toolchainDirPath: toolchainDirPath, environment: buildOptions.toolchainEnvironment)
         return try await toolchainGenerator.makeToolChain(sdk: sdk)
     }
 

Sources/ScipioKit/Producer/PIF/ToolchainGenerator.swift

@@ -2,6 +2,7 @@ import Foundation
 import TSCUtility
 #if compiler(>=6.0)
 @_spi(SwiftPMInternal) import PackageModel
+@_spi(SwiftPMInternal) import struct Basics.Environment
 #else
 import PackageModel
 #endif
@@ -11,15 +12,26 @@ import struct Basics.Triple
 struct ToolchainGenerator {
     private let toolchainDirPath: AbsolutePath
     private let executor: any Executor
+    private let environment: [String: String]?
 
-    init(toolchainDirPath: AbsolutePath, executor: any Executor = ProcessExecutor()) {
+    init(
+        toolchainDirPath: AbsolutePath,
+        executor: any Executor = ProcessExecutor(),
+        environment: [String: String]? = nil
+    ) {
         self.toolchainDirPath = toolchainDirPath
         self.executor = executor
+        self.environment = environment
     }
 
     func makeToolChain(sdk: SDK) async throws -> UserToolchain {
         let destination: SwiftSDK = try await makeDestination(sdk: sdk)
-        #if swift(>=5.10)
+        #if compiler(>=6.0)
+        return try UserToolchain(
+            swiftSDK: destination,
+            environment: environment.map(Environment.init) ?? .current
+        )
+        #elseif swift(>=5.10)
         return try UserToolchain(swiftSDK: destination)
         #else
         return try UserToolchain(destination: destination)

Sources/ScipioKit/Runner.swift

@@ -132,6 +132,7 @@ extension Runner {
             public var enableLibraryEvolution: Bool
             /// An option indicates use custom modulemaps for distributionb
             public var frameworkModuleMapGenerationPolicy: FrameworkModuleMapGenerationPolicy
+            public var toolchainEnvironment: [String: String]?
 
             public init(
                 buildConfiguration: BuildConfiguration = .release,
@@ -142,7 +143,8 @@ extension Runner {
                 extraFlags: ExtraFlags? = nil,
                 extraBuildParameters: [String: String]? = nil,
                 enableLibraryEvolution: Bool = false,
-                frameworkModuleMapGenerationPolicy: FrameworkModuleMapGenerationPolicy = .autoGenerated
+                frameworkModuleMapGenerationPolicy: FrameworkModuleMapGenerationPolicy = .autoGenerated,
+                toolchainEnvironment: [String: String]? = nil
             ) {
                 self.buildConfiguration = buildConfiguration
                 self.platforms = platforms
@@ -153,6 +155,7 @@ extension Runner {
                 self.extraBuildParameters = extraBuildParameters
                 self.enableLibraryEvolution = enableLibraryEvolution
                 self.frameworkModuleMapGenerationPolicy = frameworkModuleMapGenerationPolicy
+                self.toolchainEnvironment = toolchainEnvironment
             }
         }
         public struct TargetBuildOptions {
@@ -165,6 +168,7 @@ extension Runner {
             public var extraBuildParameters: [String: String]?
             public var enableLibraryEvolution: Bool?
             public var frameworkModuleMapGenerationPolicy: FrameworkModuleMapGenerationPolicy?
+            public var environment: [String: String]?
 
             public init(
                 buildConfiguration: BuildConfiguration? = nil,
@@ -175,7 +179,8 @@ extension Runner {
                 extraFlags: ExtraFlags? = nil,
                 extraBuildParameters: [String: String]? = nil,
                 enableLibraryEvolution: Bool? = nil,
-                frameworkModuleMapGenerationPolicy: FrameworkModuleMapGenerationPolicy? = nil
+                frameworkModuleMapGenerationPolicy: FrameworkModuleMapGenerationPolicy? = nil,
+                environment: [String: String]? = nil
             ) {
                 self.buildConfiguration = buildConfiguration
                 self.platforms = platforms
@@ -186,6 +191,7 @@ extension Runner {
                 self.extraFlags = extraFlags
                 self.enableLibraryEvolution = enableLibraryEvolution
                 self.frameworkModuleMapGenerationPolicy = frameworkModuleMapGenerationPolicy
+                self.environment = environment
             }
         }
 
@@ -296,7 +302,8 @@ extension Runner.Options.BuildOptions {
             extraFlags: extraFlags,
             extraBuildParameters: extraBuildParameters,
             enableLibraryEvolution: enableLibraryEvolution,
-            customFrameworkModuleMapContents: customFrameworkModuleMapContents
+            customFrameworkModuleMapContents: customFrameworkModuleMapContents,
+            toolchainEnvironment: toolchainEnvironment
         )
     }
 
@@ -340,7 +347,8 @@ extension Runner.Options.BuildOptions {
             extraFlags: mergedExtraFlags,
             extraBuildParameters: mergedExtraBuildParameters,
             enableLibraryEvolution: fetch(\.enableLibraryEvolution, by: \.enableLibraryEvolution),
-            frameworkModuleMapGenerationPolicy: fetch(\.frameworkModuleMapGenerationPolicy, by: \.frameworkModuleMapGenerationPolicy)
+            frameworkModuleMapGenerationPolicy: fetch(\.frameworkModuleMapGenerationPolicy, by: \.frameworkModuleMapGenerationPolicy),
+            toolchainEnvironment: toolchainEnvironment
         )
     }
 }

Tests/ScipioKitTests/CacheSystemTests.swift

@@ -36,7 +36,11 @@ InstalledDir: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault
                                                            extraFlags: .init(swiftFlags: ["-D", "SOME_FLAG"]),
                                                            extraBuildParameters: ["SWIFT_OPTIMIZATION_LEVEL": "-Osize"],
                                                            enableLibraryEvolution: true,
-                                                           customFrameworkModuleMapContents: Data(customModuleMap.utf8)
+                                                           customFrameworkModuleMapContents: Data(customModuleMap.utf8),
+                                                           toolchainEnvironment: [
+                                                            "DEVELOPER_DIR": "/Xcode.app/Contents/Developer",
+                                                            "PATH": "/Xcode.app/Contents/Developer:/usr/bin:/bin",
+                                                           ]
                                                           ),
                                        clangVersion: "clang-1400.0.29.102",
                                        xcodeVersion: .init(xcodeVersion: "15.4", xcodeBuildVersion: "15F31d")

Tests/ScipioKitTests/RunnerTests.swift

@@ -716,6 +716,7 @@ extension BuildOptions {
         extraFlags: nil,
         extraBuildParameters: nil,
         enableLibraryEvolution: true,
-        customFrameworkModuleMapContents: nil
+        customFrameworkModuleMapContents: nil,
+        toolchainEnvironment: nil
     )
 }