Serialize platform options in the PIF (#2639)

Author: neonichu

Sources/XCBuildSupport/PIF.swift

@@ -711,6 +711,7 @@ public enum PIF {
             case OTHER_LDRFLAGS
             case OTHER_SWIFT_FLAGS
             case PRELINK_FLAGS
+            case SPECIALIZATION_SDK_OPTIONS
             case SUPPORTED_PLATFORMS
             case SWIFT_ACTIVE_COMPILATION_CONDITIONS
         }

Sources/XCBuildSupport/PIFBuilder.swift

@@ -270,6 +270,12 @@ final class PackagePIFProjectBuilder: PIFProjectBuilder {
                 .append("$(PLATFORM_DIR)/Developer/Library/Frameworks")
         }
 
+        PlatformRegistry.default.knownPlatforms.forEach {
+            guard let platform = PIF.BuildSettings.Platform.from(platform: $0) else { return }
+            guard let supportedPlatform = firstTarget?.getSupportedPlatform(for: $0) else { return }
+            settings[.SPECIALIZATION_SDK_OPTIONS, for: platform] = supportedPlatform.options
+        }
+
         // Disable signing for all the things since there is no way to configure
         // signing information in packages right now.
         settings[.ENTITLEMENTS_REQUIRED] = "NO"
@@ -1480,3 +1486,16 @@ extension PIF.PlatformFilter {
         }
     }()
 }
+
+private extension PIF.BuildSettings.Platform {
+    static func from(platform: PackageModel.Platform) -> PIF.BuildSettings.Platform? {
+        switch platform {
+        case .iOS: return .iOS
+        case .linux: return .linux
+        case .macOS: return .macOS
+        case .tvOS: return .tvOS
+        case .watchOS: return .watchOS
+        default: return nil
+        }
+    }
+}

Tests/XCBuildSupportTests/PIFBuilderTests.swift

@@ -191,6 +191,10 @@ class PIFBuilderTests: XCTestCase {
                         for platform in [PIF.BuildSettings.Platform.macOS, .iOS, .tvOS] {
                             XCTAssertEqual(settings[.FRAMEWORK_SEARCH_PATHS, for: platform], frameworksSearchPaths)
                         }
+
+                        for platform in PIF.BuildSettings.Platform.allCases {
+                            XCTAssertEqual(settings[.SPECIALIZATION_SDK_OPTIONS, for: platform], [])
+                        }
                     }
                 }
 
@@ -230,6 +234,10 @@ class PIFBuilderTests: XCTestCase {
                         for platform in [PIF.BuildSettings.Platform.macOS, .iOS, .tvOS] {
                             XCTAssertEqual(settings[.FRAMEWORK_SEARCH_PATHS, for: platform], frameworksSearchPaths)
                         }
+
+                        for platform in PIF.BuildSettings.Platform.allCases {
+                            XCTAssertEqual(settings[.SPECIALIZATION_SDK_OPTIONS, for: platform], [])
+                        }
                     }
                 }
             }
@@ -281,6 +289,10 @@ class PIFBuilderTests: XCTestCase {
                         for platform in [PIF.BuildSettings.Platform.macOS, .iOS, .tvOS] {
                             XCTAssertEqual(settings[.FRAMEWORK_SEARCH_PATHS, for: platform], frameworksSearchPaths)
                         }
+
+                        for platform in PIF.BuildSettings.Platform.allCases {
+                            XCTAssertEqual(settings[.SPECIALIZATION_SDK_OPTIONS, for: platform], [])
+                        }
                     }
                 }
 
@@ -320,6 +332,10 @@ class PIFBuilderTests: XCTestCase {
                         for platform in [PIF.BuildSettings.Platform.macOS, .iOS, .tvOS] {
                             XCTAssertEqual(settings[.FRAMEWORK_SEARCH_PATHS, for: platform], frameworksSearchPaths)
                         }
+
+                        for platform in PIF.BuildSettings.Platform.allCases {
+                            XCTAssertEqual(settings[.SPECIALIZATION_SDK_OPTIONS, for: platform], [])
+                        }
                     }
                 }
             }
@@ -2029,6 +2045,48 @@ class PIFBuilderTests: XCTestCase {
             }
         }
     }
+
+    func testSDKOptions() {
+        let fs = InMemoryFileSystem(emptyFiles:
+            "/Foo/Sources/foo/main.swift"
+        )
+
+        let diagnostics = DiagnosticsEngine()
+        let graph = loadPackageGraph(
+            fs: fs,
+            diagnostics: diagnostics,
+            manifests: [
+                Manifest.createManifest(
+                    name: "Foo",
+                    platforms: [
+                        PlatformDescription(name: "macos", version: "10.14", options: ["best"]),
+                    ],
+                    path: "/Foo",
+                    url: "/Foo",
+                    v: .vNext,
+                    packageKind: .root,
+                    targets: [
+                        .init(name: "foo", dependencies: []),
+                    ]),
+            ],
+            shouldCreateMultipleTestProducts: true
+        )
+
+        let builder = PIFBuilder(graph: graph, parameters: .mock(), diagnostics: diagnostics)
+        let pif = builder.construct()
+
+        XCTAssertNoDiagnostics(diagnostics)
+
+        PIFTester(pif) { workspace in
+            workspace.checkProject("PACKAGE:/Foo") { project in
+                project.checkBuildConfiguration("Debug") { configuration in
+                    configuration.checkBuildSettings { settings in
+                        XCTAssertEqual(settings[.SPECIALIZATION_SDK_OPTIONS, for: .macOS], ["best"])
+                    }
+                }
+            }
+        }
+    }
   #endif
 }