Add DriverKit as a supported platform (#3293)

This adds DriverKit as a support platform, so that a minimum deployment target can be specified and conditional build settings can be configured.

rdar://66656200

Author: neonichu

Sources/PackageCollections/Providers/JSONPackageCollectionProvider.swift

@@ -386,6 +386,8 @@ extension PackageModel.Platform {
             self = PackageModel.Platform.tvOS
         case let name where name.contains("watchos"):
             self = PackageModel.Platform.watchOS
+        case let name where name.contains("driverkit"):
+            self = PackageModel.Platform.driverKit
         case let name where name.contains("linux"):
             self = PackageModel.Platform.linux
         case let name where name.contains("android"):

Sources/PackageDescription/SupportedPlatforms.swift

@@ -31,6 +31,9 @@ public struct Platform: Encodable, Equatable {
     /// The watchOS platform.
     public static let watchOS: Platform = Platform(name: "watchos")
 
+    /// The DriverKit platform
+    public static let driverKit: Platform = Platform(name: "driverkit")
+
     /// The Linux platform.
     public static let linux: Platform = Platform(name: "linux")
 
@@ -161,6 +164,25 @@ public struct SupportedPlatform: Encodable, Equatable {
     public static func watchOS(_ versionString: String) -> SupportedPlatform {
         return SupportedPlatform(platform: .watchOS, version: SupportedPlatform.WatchOSVersion(string: versionString).version)
     }
+
+    /// Configures the minimum deployment target version for the DriverKit platform.
+    ///
+    /// - Parameter version: The minimum deployment target that the package supports.
+    @available(_PackageDescription, introduced: 999.0)
+    public static func driverKit(_ version: SupportedPlatform.DriverKitVersion) -> SupportedPlatform {
+        return SupportedPlatform(platform: .driverKit, version: version.version)
+    }
+
+    /// Configures the minimum deployment target version for the DriverKit platform
+    /// using a custom version string.
+    ///
+    /// The version string must be a series of two or three dot-separated integers, such as `19.0` or `19.0.1`.
+    ///
+    /// - Parameter versionString: The minimum deployment target as a string representation of two or three dot-separated integers, such as `19.0.1`.
+    @available(_PackageDescription, introduced: 999.0)
+    public static func driverKit(_ versionString: String) -> SupportedPlatform {
+        return SupportedPlatform(platform: .driverKit, version: SupportedPlatform.DriverKitVersion(string: versionString).version)
+    }
 }
 
 /// An extension to the SupportedPlatform struct that defines major platform versions.
@@ -362,6 +384,27 @@ extension SupportedPlatform {
         @available(_PackageDescription, introduced: 5.3)
         public static let v7: WatchOSVersion = .init(string: "7.0")
     }
+
+    /// The supported DriverKit version.
+    public struct DriverKitVersion: Encodable, AppleOSVersion {
+        fileprivate static let name = "DriverKit"
+        fileprivate static let minimumMajorVersion = 19
+
+        /// The underlying version representation.
+        let version: String
+
+        fileprivate init(uncheckedVersion version: String) {
+            self.version = version
+        }
+
+        /// The value that represents DriverKit 19.0.
+        @available(_PackageDescription, introduced: 999.0)
+        public static let v19: DriverKitVersion = .init(string: "19.0")
+
+        /// The value that represents DriverKit 20.0.
+        @available(_PackageDescription, introduced: 999.0)
+        public static let v20: DriverKitVersion = .init(string: "20.0")
+    }
 }
 
 fileprivate protocol AppleOSVersion {

Sources/PackageLoading/MinimumDeploymentTarget.swift

@@ -68,6 +68,8 @@ private extension PackageModel.Platform {
             return "appletvos"
         case .watchOS:
             return "watchos"
+        case .driverKit:
+            return nil // DriverKit does not support XCTest.
         default:
             return nil
         }

Sources/PackageLoading/PlatformRegistry.swift

@@ -31,6 +31,6 @@ public final class PlatformRegistry {
 
     /// The static list of known platforms.
     private static var _knownPlatforms: [Platform] {
-        return [.macOS, .iOS, .tvOS, .watchOS, .linux, .windows, .android, .wasi]
+        return [.macOS, .iOS, .tvOS, .watchOS, .linux, .windows, .android, .wasi, .driverKit]
     }
 }

Sources/PackageModel/ManifestSourceGeneration.swift

@@ -109,6 +109,8 @@ fileprivate extension SourceCodeFragment {
             self.init(enum: "tvOS", string: platform.version)
         case "watchos":
             self.init(enum: "watchOS", string: platform.version)
+        case "driverkit":
+            self.init(enum: "DriverKit", string: platform.version)
         default:
             self.init(enum: platform.platformName, string: platform.version)
         }
@@ -296,6 +298,7 @@ fileprivate extension SourceCodeFragment {
             case "ios": return SourceCodeFragment(enum: "iOS")
             case "tvos": return SourceCodeFragment(enum: "tvOS")
             case "watchos": return SourceCodeFragment(enum: "watchOS")
+            case "driverkit": return SourceCodeFragment(enum: "DriverKit")
             default: return SourceCodeFragment(enum: platformName)
             }
         }

Sources/PackageModel/Platform.swift

@@ -29,6 +29,7 @@ public struct Platform: Equatable, Hashable, Codable {
     public static let iOS: Platform = Platform(name: "ios", oldestSupportedVersion: "9.0")
     public static let tvOS: Platform = Platform(name: "tvos", oldestSupportedVersion: "9.0")
     public static let watchOS: Platform = Platform(name: "watchos", oldestSupportedVersion: "2.0")
+    public static let driverKit: Platform = Platform(name: "driverkit", oldestSupportedVersion: "19.0")
     public static let linux: Platform = Platform(name: "linux", oldestSupportedVersion: .unknown)
     public static let android: Platform = Platform(name: "android", oldestSupportedVersion: .unknown)
     public static let windows: Platform = Platform(name: "windows", oldestSupportedVersion: .unknown)

Sources/Workspace/InitPackage.swift

@@ -457,6 +457,8 @@ extension PackageModel.Platform {
             return "tvOS"
         case .watchOS:
             return "watchOS"
+        case .driverKit:
+            return "DriverKit"
         default:
             fatalError("unexpected manifest name call for platform \(self)")
         }
@@ -469,7 +471,7 @@ extension SupportedPlatform {
             guard self.version.patch == 0 else {
                 return false
             }
-        } else if [Platform.macOS, .iOS, .watchOS, .tvOS].contains(platform) {
+        } else if [Platform.macOS, .iOS, .watchOS, .tvOS, .driverKit].contains(platform) {
             guard self.version.minor == 0, self.version.patch == 0 else {
                 return false
             }
@@ -488,6 +490,8 @@ extension SupportedPlatform {
             return (9...14).contains(version.major)
         case .watchOS:
             return (2...7).contains(version.major)
+        case .driverKit:
+            return (19...20).contains(version.major)
 
         default:
             return false

Sources/XCBuildSupport/PIF.swift

@@ -885,6 +885,7 @@ public enum PIF {
             case COPY_PHASE_STRIP
             case DEBUG_INFORMATION_FORMAT
             case DEFINES_MODULE
+            case DRIVERKIT_DEPLOYMENT_TARGET
             case DYLIB_INSTALL_NAME_BASE
             case EMBEDDED_CONTENT_CONTAINS_SWIFT
             case ENABLE_NS_ASSERTIONS
@@ -959,6 +960,7 @@ public enum PIF {
             case iOS = "ios"
             case tvOS = "tvos"
             case watchOS = "watchos"
+            case driverKit = "driverkit"
             case linux
 
             public var conditions: [String] {
@@ -967,6 +969,7 @@ public enum PIF {
                 case .iOS: return ["sdk=iphonesimulator*", "sdk=iphoneos*"]
                 case .tvOS: return ["sdk=appletvsimulator*", "sdk=appletvos*"]
                 case .watchOS: return ["sdk=watchsimulator*", "sdk=watchos*"]
+                case .driverKit: return ["sdk=driverkit*"]
                 case .linux: return ["sdk=linux*"]
                 }
             }

Sources/XCBuildSupport/PIFBuilder.swift

@@ -258,6 +258,7 @@ final class PackagePIFProjectBuilder: PIFProjectBuilder {
         settings[.IPHONEOS_DEPLOYMENT_TARGET] = firstTarget?.deploymentTarget(for: .iOS)
         settings[.TVOS_DEPLOYMENT_TARGET] = firstTarget?.deploymentTarget(for: .tvOS)
         settings[.WATCHOS_DEPLOYMENT_TARGET] = firstTarget?.deploymentTarget(for: .watchOS)
+        settings[.DRIVERKIT_DEPLOYMENT_TARGET] = firstTarget?.deploymentTarget(for: .driverKit)
         settings[.DYLIB_INSTALL_NAME_BASE] = "@rpath"
         settings[.USE_HEADERMAP] = "NO"
         settings[.SWIFT_ACTIVE_COMPILATION_CONDITIONS] = ["$(inherited)", "SWIFT_PACKAGE"]
@@ -1483,6 +1484,9 @@ extension Array where Element == PackageConditionProtocol {
             case .windows:
                 result += PIF.PlatformFilter.windowsFilters
 
+            case .driverKit:
+                result += PIF.PlatformFilter.driverKitFilters
+
             default:
                 assertionFailure("Unhandled platform condition: \(condition)")
                 break
@@ -1515,6 +1519,11 @@ extension PIF.PlatformFilter {
         .init(platform: "watchos", environment: "simulator")
     ]
 
+    /// DriverKit platform filters.
+    public static let driverKitFilters: [PIF.PlatformFilter] = [
+        .init(platform: "driverkit"),
+    ]
+
     /// Windows platform filters.
     public static let windowsFilters: [PIF.PlatformFilter] = [
         .init(platform: "windows", environment: "msvc"),
@@ -1543,6 +1552,7 @@ private extension PIF.BuildSettings.Platform {
         case .macOS: return .macOS
         case .tvOS: return .tvOS
         case .watchOS: return .watchOS
+        case .driverKit: return .driverKit
         default: return nil
         }
     }

Sources/Xcodeproj/XcodeProjectModel.swift

@@ -373,6 +373,7 @@ public struct Xcode {
             public var IPHONEOS_DEPLOYMENT_TARGET: String?
             public var TVOS_DEPLOYMENT_TARGET: String?
             public var WATCHOS_DEPLOYMENT_TARGET: String?
+            public var DRIVERKIT_DEPLOYMENT_TARGET: String?
             public var MODULEMAP_FILE: String?
             public var ONLY_ACTIVE_ARCH: String?
             public var OTHER_CFLAGS: [String]?
@@ -421,6 +422,7 @@ public struct Xcode {
                 IPHONEOS_DEPLOYMENT_TARGET: String? = nil,
                 TVOS_DEPLOYMENT_TARGET: String? = nil,
                 WATCHOS_DEPLOYMENT_TARGET: String? = nil,
+                DRIVERKIT_DEPLOYMENT_TARGET: String? = nil,
                 MODULEMAP_FILE: String? = nil,
                 ONLY_ACTIVE_ARCH: String? = nil,
                 OTHER_CFLAGS: [String]? = nil,
@@ -468,6 +470,7 @@ public struct Xcode {
                 self.IPHONEOS_DEPLOYMENT_TARGET = IPHONEOS_DEPLOYMENT_TARGET
                 self.TVOS_DEPLOYMENT_TARGET = TVOS_DEPLOYMENT_TARGET
                 self.WATCHOS_DEPLOYMENT_TARGET = WATCHOS_DEPLOYMENT_TARGET
+                self.DRIVERKIT_DEPLOYMENT_TARGET = DRIVERKIT_DEPLOYMENT_TARGET
                 self.MODULEMAP_FILE = MODULEMAP_FILE
                 self.ONLY_ACTIVE_ARCH = ONLY_ACTIVE_ARCH
                 self.OTHER_CFLAGS = OTHER_CFLAGS

Sources/Xcodeproj/pbxproj.swift

@@ -434,6 +434,8 @@ public func xcodeProject(
                     targetSettings.common.TVOS_DEPLOYMENT_TARGET = version
                 case .watchOS:
                     targetSettings.common.WATCHOS_DEPLOYMENT_TARGET = version
+                case .driverKit:
+                    targetSettings.common.DRIVERKIT_DEPLOYMENT_TARGET = version
                 default:
                     break
                 }

Tests/PackageLoadingTests/PackageBuilderTests.swift

@@ -1682,6 +1682,7 @@ class PackageBuilderTests: XCTestCase {
             "macos": "10.12",
             "ios": "9.0",
             "tvos": "9.0",
+            "driverkit": "19.0",
             "watchos": "2.0",
             "android": "0.0",
             "windows": "0.0",
@@ -1739,6 +1740,7 @@ class PackageBuilderTests: XCTestCase {
             "linux": "0.0",
             "ios": "9.0",
             "watchos": "2.0",
+            "driverkit": "19.0",
             "android": "0.0",
             "windows": "0.0",
             "wasi": "0.0",