Merge pull request #154 from dmhts/bugfix/sdk-environment-fixes

Follow-up / Making Scipio environment-configurable

Sources/ScipioKit/DescriptionPackage.swift

@@ -66,12 +66,21 @@ struct DescriptionPackage: PackageLocator {
     /// Then, use package versions only from existing Package.resolved.
     ///   If it is `true`, Package.resolved never be updated.
     ///   Instead, the resolving will fail if the Package.resolved is mis-matched with the workspace.
-    init(packageDirectory: ScipioAbsolutePath, mode: Runner.Mode, onlyUseVersionsFromResolvedFile: Bool) throws {
+    init(
+        packageDirectory: ScipioAbsolutePath,
+        mode: Runner.Mode,
+        onlyUseVersionsFromResolvedFile: Bool,
+        toolchainEnvironment: ToolchainEnvironment? = nil
+    ) throws {
         self.packageDirectory = packageDirectory
         self.mode = mode
-
-        let toolchain = try UserToolchain(swiftSDK: try .hostSwiftSDK())
-        self.toolchain = toolchain
+        self.toolchain = try UserToolchain(
+            swiftSDK: try .hostSwiftSDK(
+                toolchainEnvironment?.toolchainBinPath,
+                environment: toolchainEnvironment?.asSwiftPMEnvironment ?? .current
+            ),
+            environment: toolchainEnvironment?.asSwiftPMEnvironment ?? .current
+        )
 
         let workspace = try Self.makeWorkspace(toolchain: toolchain, packagePath: packageDirectory)
         let scope = makeObservabilitySystem().topScope

Sources/ScipioKit/Producer/FrameworkProducer.swift

@@ -14,7 +14,7 @@ struct FrameworkProducer {
     private let overwrite: Bool
     private let outputDir: URL
     private let fileSystem: any FileSystem
-    private let toolchainEnvironment: [String: String]?
+    private let toolchainEnvironment: ToolchainEnvironment?
 
     private var cacheStorage: (any CacheStorage)? {
         switch cacheMode {
@@ -52,7 +52,7 @@ struct FrameworkProducer {
         cacheMode: Runner.Options.CacheMode,
         overwrite: Bool,
         outputDir: URL,
-        toolchainEnvironment: [String: String]? = nil,
+        toolchainEnvironment: ToolchainEnvironment? = nil,
         fileSystem: any FileSystem = localFileSystem
     ) {
         self.descriptionPackage = descriptionPackage
@@ -280,7 +280,8 @@ struct FrameworkProducer {
             let compiler = PIFCompiler(
                 descriptionPackage: descriptionPackage,
                 buildOptions: buildOptions,
-                buildOptionsMatrix: buildOptionsMatrix
+                buildOptionsMatrix: buildOptionsMatrix,
+                toolchainEnvironment: toolchainEnvironment
             )
             try await compiler.createXCFramework(buildProduct: product,
                                                  outputDirectory: outputDir,

Sources/ScipioKit/Producer/PIF/PIFCompiler.swift

@@ -10,15 +10,15 @@ struct PIFCompiler: Compiler {
     private let fileSystem: any FileSystem
     private let executor: any Executor
     private let buildOptionsMatrix: [String: BuildOptions]
-    private let toolchainEnvironment: [String: String]?
+    private let toolchainEnvironment: ToolchainEnvironment?
 
     private let buildParametersGenerator: BuildParametersGenerator
 
     init(
         descriptionPackage: DescriptionPackage,
         buildOptions: BuildOptions,
         buildOptionsMatrix: [String: BuildOptions],
-        toolchainEnvironment: [String: String]? = nil,
+        toolchainEnvironment: ToolchainEnvironment? = nil,
         fileSystem: any FileSystem = TSCBasic.localFileSystem,
         executor: any Executor = ProcessExecutor()
     ) {

Sources/ScipioKit/Producer/PIF/ToolchainGenerator.swift

@@ -24,7 +24,7 @@ struct ToolchainGenerator {
         let destination: SwiftSDK = try await makeDestination(sdk: sdk)
         return try UserToolchain(
             swiftSDK: destination,
-            environment: environment.map(Environment.init) ?? .current
+            environment: environment?.asSwiftPMEnvironment ?? .current
         )
     }
 
@@ -44,11 +44,11 @@ struct ToolchainGenerator {
         // Compute common arguments for clang and swift.
         var extraCCFlags: [String] = []
         var extraSwiftCFlags: [String] = []
-        let sdkPaths = try SwiftSDK.sdkPlatformFrameworkPaths(environment: [:])
-        extraCCFlags += ["-F", sdkPaths.fwk.pathString]
-        extraSwiftCFlags += ["-F", sdkPaths.fwk.pathString]
-        extraSwiftCFlags += ["-I", sdkPaths.lib.pathString]
-        extraSwiftCFlags += ["-L", sdkPaths.lib.pathString]
+        let macosSDKPlatformPaths = try await resolveSDKPlatformFrameworkPaths()
+        extraCCFlags += ["-F", macosSDKPlatformPaths.frameworkPath.pathString]
+        extraSwiftCFlags += ["-F", macosSDKPlatformPaths.frameworkPath.pathString]
+        extraSwiftCFlags += ["-I", macosSDKPlatformPaths.libPath.pathString]
+        extraSwiftCFlags += ["-L", macosSDKPlatformPaths.libPath.pathString]
 
         let buildFlags = BuildFlags(cCompilerFlags: extraCCFlags, swiftCompilerFlags: extraSwiftCFlags)
         return SwiftSDK(
@@ -60,3 +60,38 @@ struct ToolchainGenerator {
         )
     }
 }
+
+extension ToolchainGenerator {
+
+    /// A non-caching environment-aware implementation of `SwiftSDK.sdkPlatformFrameworkPaths`
+    /// This implementation is based on the original SwiftPM
+    /// https://github.com/swiftlang/swift-package-manager/blob/release/6.0/Sources/PackageModel/SwiftSDKs/SwiftSDK.swift#L592-L595
+    /// Returns `macosx` sdk platform framework path.
+    fileprivate func resolveSDKPlatformFrameworkPaths() async throws -> (frameworkPath: AbsolutePath, libPath: AbsolutePath) {
+        let platformPath = try await executor.execute(
+            "/usr/bin/xcrun",
+            "--sdk",
+            "macosx",
+            "--show-sdk-platform-path"
+        )
+        .unwrapOutput()
+        .spm_chomp()
+
+        guard !platformPath.isEmpty else {
+            throw StringError("could not determine SDK platform path")
+        }
+
+        // For XCTest framework.
+        let frameworkPath = try AbsolutePath(validating: platformPath).appending(
+            components: "Developer", "Library", "Frameworks"
+        )
+
+        // For XCTest Swift library.
+        let libPath = try AbsolutePath(validating: platformPath).appending(
+            components: "Developer", "usr", "lib"
+        )
+
+        return (frameworkPath, libPath)
+    }
+
+}

Sources/ScipioKit/Runner.swift

@@ -74,7 +74,8 @@ public struct Runner {
             descriptionPackage = try DescriptionPackage(
                 packageDirectory: packagePath,
                 mode: mode,
-                onlyUseVersionsFromResolvedFile: false
+                onlyUseVersionsFromResolvedFile: false,
+                toolchainEnvironment: options.toolchainEnvironment
             )
         } catch {
             throw Error.invalidPackage(packageDirectory)
@@ -99,7 +100,8 @@ public struct Runner {
             buildOptionsMatrix: buildOptionsMatrix,
             cacheMode: options.cacheMode,
             overwrite: options.overwrite,
-            outputDir: outputDir
+            outputDir: outputDir,
+            toolchainEnvironment: options.toolchainEnvironment
         )
         do {
             try await producer.produce()
@@ -240,7 +242,7 @@ extension Runner {
         public var cacheMode: CacheMode
         public var overwrite: Bool
         public var verbose: Bool
-        public var toolchainEnvironment: [String: String]?
+        public var toolchainEnvironment: ToolchainEnvironment?
 
         public init(
             baseBuildOptions: BuildOptions = .init(),
@@ -249,7 +251,7 @@ extension Runner {
             cacheMode: CacheMode = .project,
             overwrite: Bool = false,
             verbose: Bool = false,
-            toolchainEnvironment: [String: String]? = nil
+            toolchainEnvironment: ToolchainEnvironment? = nil
         ) {
             self.buildOptionsContainer = BuildOptionsContainer(
                 baseBuildOptions: baseBuildOptions,

Sources/ScipioKit/ToolchainEnvironment.swift

@@ -0,0 +1,19 @@
+import struct Basics.AbsolutePath
+@_spi(SwiftPMInternal) import struct Basics.Environment
+
+public typealias ToolchainEnvironment = [String: String]
+
+extension ToolchainEnvironment {
+    var developerDirPath: String? { self["DEVELOPER_DIR"] }
+    var toolchainBinPath: Basics.AbsolutePath? {
+        if let developerDirPath {
+            return try? AbsolutePath(validating: developerDirPath)
+                .appending(components: "Toolchains", "XcodeDefault.xctoolchain", "usr", "bin")
+        }
+        return nil
+    }
+}
+
+extension ToolchainEnvironment {
+    var asSwiftPMEnvironment: Environment { Environment(self) }
+}

Tests/ScipioKitTests/ToolchainEnvironmentTests.swift

@@ -0,0 +1,19 @@
+import XCTest
+@testable import ScipioKit
+@_spi(SwiftPMInternal) import struct Basics.Environment
+
+final class ToolchainEnvironmentTests: XCTestCase {
+
+    func testBasics() {
+        let environment = [
+            "DEVELOPER_DIR": "/Applications/Xcode.app/Contents/Developer",
+        ]
+
+        XCTAssertEqual(environment.developerDirPath, "/Applications/Xcode.app/Contents/Developer")
+        XCTAssertEqual(
+            environment.toolchainBinPath?.pathString,
+            "/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin"
+        )
+    }
+
+}