FIRST COMMIT: Add SwiftBuild coverage SwiftBuildSupport

Refactor some tests, and 'enable' the code-coverage tests

Author: bkhouri

Sources/Commands/SwiftTestCommand.swift

@@ -619,7 +619,6 @@ public struct SwiftTestCommand: AsyncSwiftCommand {
             }
         }
         args += ["-o", productsBuildParameters.codeCovDataFile.pathString]
-
         try await AsyncProcess.checkNonZeroExit(arguments: args)
     }
 
@@ -659,7 +658,7 @@ public struct SwiftTestCommand: AsyncSwiftCommand {
             productsBuildParameters: productsBuildParameters,
             toolsBuildParameters: toolsBuildParameters,
             testProduct: self.options.sharedOptions.testProduct,
-            traitConfiguration: .init(traitOptions: self.globalOptions.traits)
+            traitConfiguration: .init(traitOptions: self.globalOptions.traits),
         )
     }
 
@@ -847,7 +846,7 @@ extension SwiftTestCommand {
                 productsBuildParameters: productsBuildParameters,
                 toolsBuildParameters: toolsBuildParameters,
                 testProduct: self.sharedOptions.testProduct,
-                traitConfiguration: .init(traitOptions: self.globalOptions.traits)
+                traitConfiguration: .init(traitOptions: self.globalOptions.traits),
             )
         }
     }
@@ -1555,7 +1554,7 @@ private func buildTestsIfNeeded(
     productsBuildParameters: BuildParameters,
     toolsBuildParameters: BuildParameters,
     testProduct: String?,
-    traitConfiguration: TraitConfiguration
+    traitConfiguration: TraitConfiguration,
 ) async throws -> [BuiltTestProduct] {
     let buildSystem = try await swiftCommandState.createBuildSystem(
         productsBuildParameters: productsBuildParameters,
@@ -1567,8 +1566,8 @@ private func buildTestsIfNeeded(
     } else {
         .allIncludingTests
     }
-
-    try await buildSystem.build(subset: subset, buildOutputs: [])
+    let buildOutputs: [BuildOutput] = productsBuildParameters.testingParameters.enableCodeCoverage ? [.coverage] : []
+    try await buildSystem.build(subset: subset, buildOutputs: buildOutputs)
 
     // Find the test product.
     let testProducts = await buildSystem.builtTestProducts

Sources/SPMBuildCore/BuildSystem/BuildSystem.swift

@@ -40,7 +40,7 @@ public enum BuildSubset {
 /// result for indication that the output was produced.
 public enum BuildOutput: Equatable {
     public static func == (lhs: BuildOutput, rhs: BuildOutput) -> Bool {
-        switch lhs {    
+        switch lhs {
         case .symbolGraph(let leftOptions):
             switch rhs {
                 case .symbolGraph(let rightOptions):
@@ -62,6 +62,13 @@ public enum BuildOutput: Equatable {
                 default:
                     return false
             }
+        case .coverage:
+            switch rhs {
+                case .buildPlan:
+                    return true
+                default:
+                    return false
+            }
         }
     }
 
@@ -93,6 +100,7 @@ public enum BuildOutput: Equatable {
     case symbolGraph(SymbolGraphOptions)
     case buildPlan
     case replArguments
+    case coverage
 }
 
 /// A protocol that represents a build system used by SwiftPM for all build operations. This allows factoring out the

Sources/SwiftBuildSupport/SwiftBuildSystem.swift

@@ -351,11 +351,14 @@ public final class SwiftBuildSystem: SPMBuildCore.BuildSystem {
 
         try await writePIF(buildParameters: buildParameters)
 
+        var shouldBuildWithCoverage = false
         var symbolGraphOptions: BuildOutput.SymbolGraphOptions?
         for output in buildOutputs {
             switch output {
             case .symbolGraph(let options):
                 symbolGraphOptions = options
+            case .coverage:
+                shouldBuildWithCoverage = true
             default:
                 continue
             }
@@ -365,13 +368,15 @@ public final class SwiftBuildSystem: SPMBuildCore.BuildSystem {
             pifTargetName: subset.pifTargetName,
             symbolGraphOptions: symbolGraphOptions,
             generateReplArguments: buildOutputs.contains(.replArguments),
+            buildWithCoverage: shouldBuildWithCoverage,
         )
     }
 
     private func startSWBuildOperation(
         pifTargetName: String,
         symbolGraphOptions: BuildOutput.SymbolGraphOptions?,
-        generateReplArguments: Bool
+        generateReplArguments: Bool,
+        buildWithCoverage: Bool,
     ) async throws -> BuildResult {
         let buildStartTime = ContinuousClock.Instant.now
         var replArguments: CLIArguments?
@@ -423,7 +428,13 @@ public final class SwiftBuildSystem: SPMBuildCore.BuildSystem {
                         throw error
                     }
 
-                    let request = try await self.makeBuildRequest(session: session, configuredTargets: configuredTargets, derivedDataPath: derivedDataPath, symbolGraphOptions: symbolGraphOptions)
+                    let request = try await self.makeBuildRequest(
+                        session: session,
+                        configuredTargets: configuredTargets,
+                        derivedDataPath: derivedDataPath,
+                        symbolGraphOptions: symbolGraphOptions,
+                        buildWithCoverage: buildWithCoverage,
+                    )
 
                     struct BuildState {
                         private var targetsByID: [Int: SwiftBuild.SwiftBuildMessage.TargetStartedInfo] = [:]
@@ -641,7 +652,11 @@ public final class SwiftBuildSystem: SPMBuildCore.BuildSystem {
         )
     }
 
-    private func makeBuildParameters(session: SWBBuildServiceSession, symbolGraphOptions: BuildOutput.SymbolGraphOptions?) async throws -> SwiftBuild.SWBBuildParameters {
+    private func makeBuildParameters(
+        session: SWBBuildServiceSession,
+        symbolGraphOptions: BuildOutput.SymbolGraphOptions?,
+        buildWithCoverage: Bool,
+    ) async throws -> SwiftBuild.SWBBuildParameters {
         // Generate the run destination parameters.
         let runDestination = makeRunDestination()
 
@@ -666,6 +681,10 @@ public final class SwiftBuildSystem: SPMBuildCore.BuildSystem {
             settings["SWIFT_EXEC"] = buildParameters.toolchain.swiftCompilerPath.pathString
         }
 
+        if buildWithCoverage {
+            settings["CLANG_COVERAGE_MAPPING"] = "YES"
+        }
+
         // FIXME: workaround for old Xcode installations such as what is in CI
         settings["LM_SKIP_METADATA_EXTRACTION"] = "YES"
         if let symbolGraphOptions {
@@ -781,9 +800,19 @@ public final class SwiftBuildSystem: SPMBuildCore.BuildSystem {
         return params
     }
 
-    public func makeBuildRequest(session: SWBBuildServiceSession, configuredTargets: [SWBTargetGUID], derivedDataPath: Basics.AbsolutePath, symbolGraphOptions: BuildOutput.SymbolGraphOptions?) async throws -> SWBBuildRequest {
+    public func makeBuildRequest(
+        session: SWBBuildServiceSession,
+        configuredTargets: [SWBTargetGUID],
+        derivedDataPath: Basics.AbsolutePath,
+        symbolGraphOptions: BuildOutput.SymbolGraphOptions?,
+        buildWithCoverage: Bool,
+    ) async throws -> SWBBuildRequest {
         var request = SWBBuildRequest()
-        request.parameters = try await makeBuildParameters(session: session, symbolGraphOptions: symbolGraphOptions)
+        request.parameters = try await makeBuildParameters(
+            session: session,
+            symbolGraphOptions: symbolGraphOptions,
+            buildWithCoverage: buildWithCoverage,
+        )
         request.configuredTargets = configuredTargets.map { SWBConfiguredTarget(guid: $0.rawValue, parameters: request.parameters) }
         request.useParallelTargets = true
         request.useImplicitDependencies = false