Move SDK configuration to SwiftSDKConfigurationStore and add tests

Author: marcprux

Sources/PackageModel/SwiftSDKs/SwiftSDK.swift

@@ -266,14 +266,14 @@ public struct SwiftSDK: Equatable {
     /// deserialization.
     public private(set) var toolset: Toolset
 
-    public struct PathsConfiguration: Equatable {
+    public struct PathsConfiguration<Path: Equatable>: Equatable {
         public init(
-            sdkRootPath: Basics.AbsolutePath?,
-            swiftResourcesPath: Basics.AbsolutePath? = nil,
-            swiftStaticResourcesPath: Basics.AbsolutePath? = nil,
-            includeSearchPaths: [Basics.AbsolutePath]? = nil,
-            librarySearchPaths: [Basics.AbsolutePath]? = nil,
-            toolsetPaths: [Basics.AbsolutePath]? = nil
+            sdkRootPath: Path? = nil,
+            swiftResourcesPath: Path? = nil,
+            swiftStaticResourcesPath: Path? = nil,
+            includeSearchPaths: [Path]? = nil,
+            librarySearchPaths: [Path]? = nil,
+            toolsetPaths: [Path]? = nil
         ) {
             self.sdkRootPath = sdkRootPath
             self.swiftResourcesPath = swiftResourcesPath
@@ -284,22 +284,22 @@ public struct SwiftSDK: Equatable {
         }
 
         /// Root directory path of the SDK used to compile for the target triple.
-        public var sdkRootPath: Basics.AbsolutePath?
+        public var sdkRootPath: Path?
 
         /// Path containing Swift resources for dynamic linking.
-        public var swiftResourcesPath: Basics.AbsolutePath?
+        public var swiftResourcesPath: Path?
 
         /// Path containing Swift resources for static linking.
-        public var swiftStaticResourcesPath: Basics.AbsolutePath?
+        public var swiftStaticResourcesPath: Path?
 
         /// Array of paths containing headers.
-        public var includeSearchPaths: [Basics.AbsolutePath]?
+        public var includeSearchPaths: [Path]?
 
         /// Array of paths containing libraries.
-        public var librarySearchPaths: [Basics.AbsolutePath]?
+        public var librarySearchPaths: [Path]?
 
         /// Array of paths containing toolset files.
-        public var toolsetPaths: [Basics.AbsolutePath]?
+        public var toolsetPaths: [Path]?
 
         /// Initialize paths configuration from values deserialized using v3 schema.
         /// - Parameters:
@@ -308,92 +308,50 @@ public struct SwiftSDK: Equatable {
         fileprivate init(
             _ properties: SerializedDestinationV3.TripleProperties,
             swiftSDKDirectory: Basics.AbsolutePath? = nil
-        ) throws {
-            if let swiftSDKDirectory {
-                self.init(
-                    sdkRootPath: try AbsolutePath(validating: properties.sdkRootPath, relativeTo: swiftSDKDirectory),
-                    swiftResourcesPath: try properties.swiftResourcesPath.map {
-                        try AbsolutePath(validating: $0, relativeTo: swiftSDKDirectory)
-                    },
-                    swiftStaticResourcesPath: try properties.swiftStaticResourcesPath.map {
-                        try AbsolutePath(validating: $0, relativeTo: swiftSDKDirectory)
-                    },
-                    includeSearchPaths: try properties.includeSearchPaths?.map {
-                        try AbsolutePath(validating: $0, relativeTo: swiftSDKDirectory)
-                    },
-                    librarySearchPaths: try properties.librarySearchPaths?.map {
-                        try AbsolutePath(validating: $0, relativeTo: swiftSDKDirectory)
-                    },
-                    toolsetPaths: try properties.toolsetPaths?.map {
-                        try AbsolutePath(validating: $0, relativeTo: swiftSDKDirectory)
-                    }
-                )
-            } else {
-                self.init(
-                    sdkRootPath: try AbsolutePath(validating: properties.sdkRootPath),
-                    swiftResourcesPath: try properties.swiftResourcesPath.map {
-                        try AbsolutePath(validating: $0)
-                    },
-                    swiftStaticResourcesPath: try properties.swiftStaticResourcesPath.map {
-                        try AbsolutePath(validating: $0)
-                    },
-                    includeSearchPaths: try properties.includeSearchPaths?.map {
-                        try AbsolutePath(validating: $0)
-                    },
-                    librarySearchPaths: try properties.librarySearchPaths?.map {
-                        try AbsolutePath(validating: $0)
-                    },
-                    toolsetPaths: try properties.toolsetPaths?.map {
-                        try AbsolutePath(validating: $0)
-                    }
-                )
-            }
+        ) throws where Path == Basics.AbsolutePath {
+            self.init(
+                sdkRootPath: try AbsolutePath(validating: properties.sdkRootPath, relativeTo: swiftSDKDirectory),
+                swiftResourcesPath: try properties.swiftResourcesPath.map {
+                    try AbsolutePath(validating: $0, relativeTo: swiftSDKDirectory)
+                },
+                swiftStaticResourcesPath: try properties.swiftStaticResourcesPath.map {
+                    try AbsolutePath(validating: $0, relativeTo: swiftSDKDirectory)
+                },
+                includeSearchPaths: try properties.includeSearchPaths?.map {
+                    try AbsolutePath(validating: $0, relativeTo: swiftSDKDirectory)
+                },
+                librarySearchPaths: try properties.librarySearchPaths?.map {
+                    try AbsolutePath(validating: $0, relativeTo: swiftSDKDirectory)
+                },
+                toolsetPaths: try properties.toolsetPaths?.map {
+                    try AbsolutePath(validating: $0, relativeTo: swiftSDKDirectory)
+                }
+            )
         }
 
         /// Initialize paths configuration from values deserialized using v4 schema.
         /// - Parameters:
         ///   - properties: properties of a Swift SDK for the given triple.
         ///   - swiftSDKDirectory: directory used for converting relative paths in `properties` to absolute paths.
-        fileprivate init(_ properties: SwiftSDKMetadataV4.TripleProperties, swiftSDKDirectory: Basics.AbsolutePath? = nil) throws {
-            if let swiftSDKDirectory {
-                self.init(
-                    sdkRootPath: try AbsolutePath(validating: properties.sdkRootPath, relativeTo: swiftSDKDirectory),
-                    swiftResourcesPath: try properties.swiftResourcesPath.map {
-                        try AbsolutePath(validating: $0, relativeTo: swiftSDKDirectory)
-                    },
-                    swiftStaticResourcesPath: try properties.swiftStaticResourcesPath.map {
-                        try AbsolutePath(validating: $0, relativeTo: swiftSDKDirectory)
-                    },
-                    includeSearchPaths: try properties.includeSearchPaths?.map {
-                        try AbsolutePath(validating: $0, relativeTo: swiftSDKDirectory)
-                    },
-                    librarySearchPaths: try properties.librarySearchPaths?.map {
-                        try AbsolutePath(validating: $0, relativeTo: swiftSDKDirectory)
-                    },
-                    toolsetPaths: try properties.toolsetPaths?.map {
-                        try AbsolutePath(validating: $0, relativeTo: swiftSDKDirectory)
-                    }
-                )
-            } else {
-                self.init(
-                    sdkRootPath: try AbsolutePath(validating: properties.sdkRootPath),
-                    swiftResourcesPath: try properties.swiftResourcesPath.map {
-                        try AbsolutePath(validating: $0)
-                    },
-                    swiftStaticResourcesPath: try properties.swiftStaticResourcesPath.map {
-                        try AbsolutePath(validating: $0)
-                    },
-                    includeSearchPaths: try properties.includeSearchPaths?.map {
-                        try AbsolutePath(validating: $0)
-                    },
-                    librarySearchPaths: try properties.librarySearchPaths?.map {
-                        try AbsolutePath(validating: $0)
-                    },
-                    toolsetPaths: try properties.toolsetPaths?.map {
-                        try AbsolutePath(validating: $0)
-                    }
-                )
-            }
+        fileprivate init(_ properties: SwiftSDKMetadataV4.TripleProperties, swiftSDKDirectory: Basics.AbsolutePath? = nil) throws where Path == Basics.AbsolutePath {
+            self.init(
+                sdkRootPath: try AbsolutePath(validating: properties.sdkRootPath, relativeTo: swiftSDKDirectory),
+                swiftResourcesPath: try properties.swiftResourcesPath.map {
+                    try AbsolutePath(validating: $0, relativeTo: swiftSDKDirectory)
+                },
+                swiftStaticResourcesPath: try properties.swiftStaticResourcesPath.map {
+                    try AbsolutePath(validating: $0, relativeTo: swiftSDKDirectory)
+                },
+                includeSearchPaths: try properties.includeSearchPaths?.map {
+                    try AbsolutePath(validating: $0, relativeTo: swiftSDKDirectory)
+                },
+                librarySearchPaths: try properties.librarySearchPaths?.map {
+                    try AbsolutePath(validating: $0, relativeTo: swiftSDKDirectory)
+                },
+                toolsetPaths: try properties.toolsetPaths?.map {
+                    try AbsolutePath(validating: $0, relativeTo: swiftSDKDirectory)
+                }
+            )
         }
 
         public mutating func merge(with newConfiguration: Self) {
@@ -421,10 +379,45 @@ public struct SwiftSDK: Equatable {
                 self.toolsetPaths = toolsetPaths
             }
         }
+
+        public mutating func merge(with newConfiguration: PathsConfiguration<String>, relativeTo basePath: Path?) throws -> [String] where Path == Basics.AbsolutePath {
+            var updatedProperties: [String] = []
+            if let sdkRootPath = newConfiguration.sdkRootPath {
+                self.sdkRootPath = try AbsolutePath(validating: sdkRootPath, relativeTo: basePath)
+                updatedProperties.append("sdkRootPath")
+            }
+
+            if let swiftResourcesPath = newConfiguration.swiftResourcesPath {
+                self.swiftResourcesPath = try AbsolutePath(validating: swiftResourcesPath, relativeTo: basePath)
+                updatedProperties.append("swiftResourcesPath")
+            }
+
+            if let swiftStaticResourcesPath = newConfiguration.swiftStaticResourcesPath {
+                self.swiftResourcesPath = try AbsolutePath(validating: swiftStaticResourcesPath, relativeTo: basePath)
+                updatedProperties.append("swiftStaticResourcesPath")
+            }
+
+            if let includeSearchPaths = newConfiguration.includeSearchPaths, !includeSearchPaths.isEmpty {
+                self.includeSearchPaths = try includeSearchPaths.map { try AbsolutePath(validating: $0, relativeTo: basePath) }
+                updatedProperties.append("includeSearchPath")
+            }
+
+            if let librarySearchPaths = newConfiguration.librarySearchPaths, !librarySearchPaths.isEmpty {
+                self.librarySearchPaths = try librarySearchPaths.map { try AbsolutePath(validating: $0, relativeTo: basePath) }
+                updatedProperties.append("librarySearchPath")
+            }
+
+            if let toolsetPaths = newConfiguration.toolsetPaths, !toolsetPaths.isEmpty {
+                self.toolsetPaths = try toolsetPaths.map { try AbsolutePath(validating: $0, relativeTo: basePath) }
+                updatedProperties.append("toolsetPath")
+            }
+
+            return updatedProperties
+        }
     }
 
     /// Configuration of file system paths used by this Swift SDK when building.
-    public var pathsConfiguration: PathsConfiguration
+    public var pathsConfiguration: PathsConfiguration<Basics.AbsolutePath>
 
     /// Creates a Swift SDK with the specified properties.
     @available(*, deprecated, message: "use `init(targetTriple:sdkRootDir:toolset:)` instead")
@@ -471,7 +464,7 @@ public struct SwiftSDK: Equatable {
         hostTriple: Triple? = nil,
         targetTriple: Triple? = nil,
         toolset: Toolset,
-        pathsConfiguration: PathsConfiguration,
+        pathsConfiguration: PathsConfiguration<Basics.AbsolutePath>,
         supportsTesting: Bool
     ) {
         let xctestSupport: XCTestSupport
@@ -496,7 +489,7 @@ public struct SwiftSDK: Equatable {
         hostTriple: Triple? = nil,
         targetTriple: Triple? = nil,
         toolset: Toolset,
-        pathsConfiguration: PathsConfiguration,
+        pathsConfiguration: PathsConfiguration<Basics.AbsolutePath>,
         xctestSupport: XCTestSupport = .supported
     ) {
         self.hostTriple = hostTriple
@@ -1208,7 +1201,7 @@ extension Optional where Wrapped == [Basics.AbsolutePath] {
     }
 }
 
-extension SwiftSDK.PathsConfiguration: CustomStringConvertible {
+extension SwiftSDK.PathsConfiguration: CustomStringConvertible where Path == Basics.AbsolutePath {
     public var description: String {
         """
         sdkRootPath: \(sdkRootPath.configurationString)
@@ -1220,3 +1213,13 @@ extension SwiftSDK.PathsConfiguration: CustomStringConvertible {
         """
     }
 }
+
+extension Basics.AbsolutePath {
+    fileprivate init(validating string: String, relativeTo basePath: Basics.AbsolutePath?) throws {
+        if let basePath {
+            try self.init(validating: string, relativeTo: basePath)
+        } else {
+            try self.init(validating: string)
+        }
+    }
+}

Sources/PackageModel/SwiftSDKs/SwiftSDKBundleStore.swift

@@ -70,7 +70,7 @@ public final class SwiftSDKBundleStore {
     let fileSystem: any FileSystem
 
     /// Observability scope used for logging.
-    private let observabilityScope: ObservabilityScope
+    let observabilityScope: ObservabilityScope
 
     /// Closure invoked for output produced by this store during its operation.
     private let outputHandler: (Output) -> Void

Sources/PackageModel/SwiftSDKs/SwiftSDKConfigurationStore.swift

@@ -157,4 +157,92 @@ public final class SwiftSDKConfigurationStore {
         try fileSystem.removeFileTree(configurationPath)
         return true
     }
+
+    public func configure(
+        sdkID: String,
+        targetTriple: String?,
+        showConfiguration: Bool,
+        resetConfiguration: Bool,
+        config: SwiftSDK.PathsConfiguration<String>
+    ) throws -> Bool {
+        let targetTriples: [Triple]
+        if let targetTriple = targetTriple {
+            targetTriples = try [Triple(targetTriple)]
+        } else {
+            // when target-triple is unspecified, configure every triple for the SDK
+            let validBundles = try self.swiftSDKs(for: sdkID)
+            targetTriples = validBundles.compactMap(\.targetTriple)
+            if targetTriples.isEmpty {
+                throw SwiftSDKError.swiftSDKNotFound(
+                    artifactID: sdkID,
+                    hostTriple: hostTriple,
+                    targetTriple: nil
+                )
+            }
+        }
+
+        for targetTriple in targetTriples {
+            guard let swiftSDK = try self.readConfiguration(
+                sdkID: sdkID,
+                targetTriple: targetTriple
+            ) else {
+                throw SwiftSDKError.swiftSDKNotFound(
+                    artifactID: sdkID,
+                    hostTriple: hostTriple,
+                    targetTriple: targetTriple
+                )
+            }
+
+            if showConfiguration {
+                print(swiftSDK.pathsConfiguration)
+                continue
+            }
+
+            if resetConfiguration {
+                if try !self.resetConfiguration(sdkID: sdkID, targetTriple: targetTriple) {
+                    swiftSDKBundleStore.observabilityScope.emit(
+                        warning: "No configuration for Swift SDK `\(sdkID)`"
+                    )
+                } else {
+                    swiftSDKBundleStore.observabilityScope.emit(
+                        info: """
+                    All configuration properties of Swift SDK `\(sdkID)` for target triple \
+                    `\(targetTriple)` were successfully reset.
+                    """
+                    )
+                }
+            } else {
+                var configuration = swiftSDK.pathsConfiguration
+                let updatedProperties = try configuration.merge(with: config, relativeTo: fileSystem.currentWorkingDirectory)
+
+                guard !updatedProperties.isEmpty else {
+                    swiftSDKBundleStore.observabilityScope.emit(
+                        error: """
+                    No properties of Swift SDK `\(sdkID)` for target triple `\(targetTriple)` were updated \
+                    since none were specified. Pass `--help` flag to see the list of all available properties.
+                    """
+                    )
+                    return false
+                }
+
+                var swiftSDK = swiftSDK
+                swiftSDK.pathsConfiguration = configuration
+                swiftSDK.targetTriple = targetTriple
+                try self.updateConfiguration(sdkID: sdkID, swiftSDK: swiftSDK)
+
+                swiftSDKBundleStore.observabilityScope.emit(
+                    info: """
+                These properties of Swift SDK `\(sdkID)` for target triple \
+                `\(targetTriple)` were successfully updated: \(updatedProperties.joined(separator: ", ")).
+                """
+                )
+            }
+
+            if swiftSDKBundleStore.observabilityScope.errorsReported {
+                return false
+            }
+        }
+
+        return true
+    }
 }