Remove TaskConstructionTester default run destination argument

This makes it more obvious that a task construction test is targeting the macOS platform, and makes our test infrastructure slightly less Apple-centric by ceasing to encode an implicit assumption of a default platform.

Author: jakepetroules

Sources/SWBTestSupport/PlatformFilter.swift

@@ -126,7 +126,7 @@ extension CoreBasedTests {
 
             let filtersString = platformFilters.sorted().map { $0.platform + ($0.environment.nilIfEmpty.map { "-\($0)"} ?? "") }.joined(separator: ", ") // Just for test logging.
 
-            try await TaskConstructionTester(core, testWorkspace).checkBuild(BuildParameters(configuration: "Debug", activeRunDestination: runDestination), userPreferences: UserPreferences.defaultForTesting.with(enableDebugActivityLogs: true)) { results in
+            try await TaskConstructionTester(core, testWorkspace).checkBuild(BuildParameters(configuration: "Debug"), runDestination: runDestination, userPreferences: UserPreferences.defaultForTesting.with(enableDebugActivityLogs: true)) { results in
                 results.consumeTasksMatchingRuleTypes(["CreateBuildDirectory", "CreateUniversalBinary", "Gate", "GenerateDSYMFile", "Ld", "MkDir", "ProcessInfoPlistFile", "RegisterExecutionPolicyException", "RegisterWithLaunchServices", "SymLink", "Touch", "WriteAuxiliaryFile", "Validate"])
 
                 // We should always build this

Sources/SWBTestSupport/TaskConstructionTester.swift

@@ -766,7 +766,16 @@ package final class TaskConstructionTester {
         let parameters = parameters ?? BuildParameters(configuration: "Debug")
 
         // If the build parameters don't specify a run destination, but we were passed one, then use the one we were passed. (checkBuild() defaults this to .macOS.)
-        let runDestination = parameters.activeRunDestination ?? runDestination
+        let activeRunDestination: RunDestinationInfo? = switch (parameters.activeRunDestination, runDestination) {
+        case let (.some(lhs), (.some(rhs))):
+            preconditionFailure("Specified run destinations from both explicit build parameters and default destination: \(lhs), \(rhs)")
+        case let (.some(destination), nil):
+            destination
+        case let (nil, .some(destination)):
+            destination
+        case (nil, nil):
+            nil
+        }
 
         // Define a default set of overrides.
         var overrides = [
@@ -781,14 +790,14 @@ package final class TaskConstructionTester {
 
         // If we have a run destination, then we default ONLY_ACTIVE_ARCH to YES. This means when they build with a non-generic run destination, that run destination's architecture will be used rather than building universal.
         // If we don't have a run destination, then defaulting ONLY_ACTIVE_ARCH is probably the wrong thing to do.
-        if runDestination != nil {
+        if activeRunDestination != nil {
             overrides["ONLY_ACTIVE_ARCH"] = "YES"
         }
         // Add overrides from the parameters we were passed, which will supersede the default overrides above.
         overrides.addContents(of: parameters.overrides)
 
         // Create and return the effective parameters.
-        return BuildParameters(action: parameters.action, configuration: parameters.configuration, activeRunDestination: runDestination, activeArchitecture: parameters.activeArchitecture, overrides: overrides, commandLineOverrides: parameters.commandLineOverrides, commandLineConfigOverridesPath: parameters.commandLineConfigOverridesPath, commandLineConfigOverrides: parameters.commandLineConfigOverrides, environmentConfigOverridesPath: parameters.environmentConfigOverridesPath, environmentConfigOverrides: parameters.environmentConfigOverrides, arena: parameters.arena)
+        return BuildParameters(action: parameters.action, configuration: parameters.configuration, activeRunDestination: activeRunDestination, activeArchitecture: parameters.activeArchitecture, overrides: overrides, commandLineOverrides: parameters.commandLineOverrides, commandLineConfigOverridesPath: parameters.commandLineConfigOverridesPath, commandLineConfigOverrides: parameters.commandLineConfigOverrides, environmentConfigOverridesPath: parameters.environmentConfigOverridesPath, environmentConfigOverrides: parameters.environmentConfigOverrides, arena: parameters.arena)
     }
 
     /// Returns the effective build request to use for the build.
@@ -819,7 +828,7 @@ package final class TaskConstructionTester {
     /// Construct the tasks for the given build parameters, and test the result.
     /// - parameter runDestination: If the run destination in `parameter` is nil, then the value passed here will be used instead. Due to the defined default value, this means that tests build for macOS unless they specify otherwise.
     /// - parameter checkTaskGraphIntegrity: If `true` (the default), then the task graph's integrity will be checked, and test errors will be emitted for scenarios such as missing producers for nodes, and multiple producers for nodes.  A test may wish to pass `false` for this if it is deliberately constructing a bad task graph in order to examine the resulting errors.
-    package func checkBuild(_ inputParameters: BuildParameters? = nil, runDestination: SWBProtocol.RunDestinationInfo? = .macOS, targetName: String? = nil, buildRequest inputBuildRequest: BuildRequest? = nil, provisioningOverrides: ProvisioningTaskInputs? = nil, processEnvironment: [String: String] = [:], fs: any FSProxy = PseudoFS(), userPreferences: UserPreferences? = nil, clientDelegate: (any TaskPlanningClientDelegate)? = nil, checkTaskGraphIntegrity: Bool = true, useDefaultToolChainOverride: Bool = true, systemInfo: SystemInfo? = nil, sourceLocation: SourceLocation = #_sourceLocation, body: (PlanningResults) async throws -> Void) async rethrows {
+    package func checkBuild(_ inputParameters: BuildParameters? = nil, runDestination: SWBProtocol.RunDestinationInfo?, targetName: String? = nil, buildRequest inputBuildRequest: BuildRequest? = nil, provisioningOverrides: ProvisioningTaskInputs? = nil, processEnvironment: [String: String] = [:], fs: any FSProxy = PseudoFS(), userPreferences: UserPreferences? = nil, clientDelegate: (any TaskPlanningClientDelegate)? = nil, checkTaskGraphIntegrity: Bool = true, useDefaultToolChainOverride: Bool = true, systemInfo: SystemInfo? = nil, sourceLocation: SourceLocation = #_sourceLocation, body: (PlanningResults) async throws -> Void) async rethrows {
         // For test stability we modify the build parameters we were passed.
         let parameters = effectiveBuildParameters(inputParameters ?? inputBuildRequest?.parameters, runDestination: runDestination, useDefaultToolChainOverride: useDefaultToolChainOverride)
 
@@ -1009,7 +1018,7 @@ extension TaskConstructionTester {
             runDestination: runDestination,
             sourceLocation: sourceLocation
         )
-        return try await checkBuild(buildRequest: buildRequest, systemInfo: systemInfo, sourceLocation: sourceLocation, body: body)
+        return try await checkBuild(runDestination: runDestination, buildRequest: buildRequest, systemInfo: systemInfo, sourceLocation: sourceLocation, body: body)
     }
 }
 

Tests/SWBCoreTests/ProductTypesTests.swift

@@ -71,7 +71,7 @@ fileprivate struct ProductTypesTests: CoreBasedTests {
         let fs = PseudoFS()
 
         let tester = try TaskConstructionTester(core, testWorkspace)
-        await tester.checkBuild(BuildParameters(action: .install, configuration: "Release"), fs: fs) { results in
+        await tester.checkBuild(BuildParameters(action: .install, configuration: "Release"), runDestination: .macOS, fs: fs) { results in
             results.consumeTasksMatchingRuleTypes(["CreateBuildDirectory", "WriteAuxiliaryFile", "Gate", "RegisterExecutionPolicyException", "SetOwnerAndGroup", "SetMode", "ProcessInfoPlistFile", "ProcessProductPackaging", "ProcessProductPackagingDER", "ProcessInfoPlist"])
 
             results.checkTarget("aFramework") { target in

Tests/SWBCoreTests/SettingsTests.swift

@@ -4191,7 +4191,7 @@ import SWBMacro
         let buildRequestContext = BuildRequestContext(workspaceContext: context)
         let tester = try await TaskConstructionTester(getCore(), testWorkspace)
 
-        await tester.checkBuild() { results in
+        await tester.checkBuild(runDestination: .macOS) { results in
             results.checkNoDiagnostics()
             results.checkNote("A script phase disables sandboxing, forcing `EAGER_COMPILATION_ALLOW_SCRIPTS` to off (in target \'A\' from project \'aProject\')")
 

Tests/SWBTaskConstructionPerfTests/TaskConstructionPerfTests.swift

@@ -52,7 +52,7 @@ fileprivate struct TaskConstructionPerfTests: CoreBasedTests, PerfTests {
             )
             let tester = try await TaskConstructionTester(self.getCore(), testWorkspace)
             await measure {
-                await tester.checkBuild(checkTaskGraphIntegrity: false) { tester in
+                await tester.checkBuild(runDestination: .macOS, checkTaskGraphIntegrity: false) { tester in
                     tester.checkTasks(.matchRuleType("CreateBuildDirectory")) { tasks in
                         #expect(tasks.count == 1503)
                     }

Tests/SWBTaskConstructionTests/AppClipTaskConstructionTests.swift

@@ -25,7 +25,7 @@ fileprivate struct AppClipTaskConstructionTests: CoreBasedTests {
             let fs = PseudoFS()
             let tester = try await TaskConstructionTester(getCore(), TestProject.appClip(sourceRoot: tmpDir, fs: fs))
 
-            await tester.checkBuild(BuildParameters(action: .build, configuration: "Debug", activeRunDestination: .iOS), fs: fs) { results in
+            await tester.checkBuild(BuildParameters(action: .build, configuration: "Debug"), runDestination: .iOS, fs: fs) { results in
                 results.checkNoDiagnostics()
                 for variant in ["thinned", "unthinned"] {
                     results.checkTask(.matchTargetName("Foo"), .matchRuleType("CompileAssetCatalogVariant"), .matchRuleItem(variant)) { task in
@@ -40,14 +40,14 @@ fileprivate struct AppClipTaskConstructionTests: CoreBasedTests {
                 }
             }
 
-            await tester.checkBuild(BuildParameters(action: .build, configuration: "Debug", activeRunDestination: .iOSSimulator), fs: fs) { results in
+            await tester.checkBuild(BuildParameters(action: .build, configuration: "Debug"), runDestination: .iOSSimulator, fs: fs) { results in
                 results.checkNoDiagnostics()
                 results.checkTask(.matchTargetName("Foo"), .matchRuleType("ValidateEmbeddedBinary")) { task in
                     task.checkCommandLine(["embeddedBinaryValidationUtility", "\(tmpDir.str)/build/Debug-iphonesimulator/Foo.app/AppClips/BarClip.app", "-info-plist-path", "\(tmpDir.str)/build/Debug-iphonesimulator/Foo.app/Info.plist"])
                 }
             }
 
-            await tester.checkBuild(BuildParameters(action: .build, configuration: "Debug", activeRunDestination: .macCatalyst), fs: fs) { results in
+            await tester.checkBuild(BuildParameters(action: .build, configuration: "Debug"), runDestination: .macCatalyst, fs: fs) { results in
                 results.checkNoDiagnostics()
                 results.checkTask(.matchTargetName("Foo"), .matchRuleType("Ld")) { task in
                     task.checkCommandLineLastArgumentEqual("\(tmpDir.str)/build/Debug\(MacCatalystInfo.publicSDKBuiltProductsDirSuffix)/Foo.app/Contents/MacOS/Foo")

Tests/SWBTaskConstructionTests/AppExtensionTaskConstructionTests.swift

@@ -72,13 +72,13 @@ fileprivate struct AppExtensionTaskConstructionTests: CoreBasedTests {
             ])
         let tester = try await TaskConstructionTester(getCore(), testProject)
 
-        await tester.checkBuild(BuildParameters(action: .build, configuration: "Debug", activeRunDestination: .macOS)) { results in
+        await tester.checkBuild(BuildParameters(action: .build, configuration: "Debug"), runDestination: .macOS) { results in
             results.checkNoDiagnostics()
             results.checkTask(.matchTargetName("Foo"), .matchRule(["Copy", "/tmp/Test/aProject/build/Debug/Foo.app/Contents/Extensions/Modern.appex", "/tmp/Test/aProject/build/Debug/Modern.appex"])) { task in }
             results.checkTask(.matchTargetName("Foo"), .matchRule(["Copy", "/tmp/Test/aProject/build/Debug/Foo.app/Contents/PlugIns/Legacy.appex", "/tmp/Test/aProject/build/Debug/Legacy.appex"])) { task in }
         }
 
-        await tester.checkBuild(BuildParameters(action: .build, configuration: "Debug", activeRunDestination: .iOS)) { results in
+        await tester.checkBuild(BuildParameters(action: .build, configuration: "Debug"), runDestination: .iOS) { results in
             results.checkNoDiagnostics()
             results.checkTask(.matchTargetName("Foo"), .matchRule(["Copy", "/tmp/Test/aProject/build/Debug-iphoneos/Foo.app/Extensions/Modern.appex", "/tmp/Test/aProject/build/Debug-iphoneos/Modern.appex"])) { task in }
             results.checkTask(.matchTargetName("Foo"), .matchRule(["Copy", "/tmp/Test/aProject/build/Debug-iphoneos/Foo.app/PlugIns/Legacy.appex", "/tmp/Test/aProject/build/Debug-iphoneos/Legacy.appex"])) { task in }