add "building for <configuration>" message (#3826)

motivation: inform users of configuration they building for

changes: add "building for <configuration>" message at the begining of the build

rdar://84533229

Author: tomerd

Sources/Build/BuildOperation.swift

@@ -135,6 +135,8 @@ public final class BuildOperation: PackageStructureDelegate, SPMBuildCore.BuildS
         let buildSystem = try self.createBuildSystem(buildDescription: buildDescription)
         self.buildSystem = buildSystem
 
+        buildSystemDelegate?.buildStart(configuration: self.buildParameters.configuration)
+
         // Perform the build.
         let llbuildTarget = try computeLLBuildTargetName(for: subset)
         let success = buildSystem.build(target: llbuildTarget)

Sources/Build/BuildOperationBuildSystemDelegateHandler.swift

@@ -588,7 +588,7 @@ final class BuildOperationBuildSystemDelegateHandler: LLBuildBuildSystemDelegate
                     self.outputStream.flush()
                 }
             } else {
-                self.taskTracker.swiftCompilerDidOuputMessage(message, targetName: parser.targetName)
+                self.taskTracker.swiftCompilerDidOutputMessage(message, targetName: parser.targetName)
                 self.updateProgress()
             }
 
@@ -619,6 +619,14 @@ final class BuildOperationBuildSystemDelegateHandler: LLBuildBuildSystemDelegate
         self.commandFailureHandler?()
     }
 
+    func buildStart(configuration: BuildConfiguration) {
+        queue.sync {
+            self.progressAnimation.clear()
+            self.outputStream <<< "Building for \(configuration == .debug ? "debugging" : "production")...\n"
+            self.outputStream.flush()
+        }
+    }
+
     func buildComplete(success: Bool) {
         queue.sync {
             self.progressAnimation.complete(success: success)
@@ -657,9 +665,9 @@ fileprivate struct CommandTaskTracker {
     mutating func commandStatusChanged(_ command: SPMLLBuild.Command, kind: CommandStatusKind) {
         switch kind {
         case .isScanning:
-            totalCount += 1
+            self.totalCount += 1
         case .isUpToDate:
-            totalCount -= 1
+            self.totalCount -= 1
         case .isComplete:
             break
         @unknown default:
@@ -670,21 +678,21 @@ fileprivate struct CommandTaskTracker {
 
     mutating func commandFinished(_ command: SPMLLBuild.Command, result: CommandResult, targetName: String?) {
         let progressTextValue = progressText(of: command, targetName: targetName)
-        onTaskProgressUpdateText?(progressTextValue, targetName)
+        self.onTaskProgressUpdateText?(progressTextValue, targetName)
 
-        latestFinishedText = progressTextValue
+        self.latestFinishedText = progressTextValue
 
         switch result {
         case .succeeded, .skipped:
-            finishedCount += 1
+            self.finishedCount += 1
         case .cancelled, .failed:
             break
         default:
             break
         }
     }
 
-    mutating func swiftCompilerDidOuputMessage(_ message: SwiftCompilerMessage, targetName: String) {
+    mutating func swiftCompilerDidOutputMessage(_ message: SwiftCompilerMessage, targetName: String) {
         switch message.kind {
         case .began(let info):
             if let text = progressText(of: message, targetName: targetName) {

Sources/Build/BuildPlan.swift

@@ -804,7 +804,7 @@ public final class SwiftTargetBuildDescription {
             args += ["-color-diagnostics"]
         }
 
-        // Add agruments from declared build settings.
+        // Add arguments from declared build settings.
         args += self.buildSettingsFlags()
 
         // Add the output for the `.swiftinterface`, if requested or if library evolution has been enabled some other way.

Sources/LLBuildManifest/Tools.swift

@@ -70,9 +70,9 @@ public struct CopyTool: ToolProtocol {
     }
 }
 
-/// Package strcuture tool is used to determine if the package has changed in some way
+/// Package structure tool is used to determine if the package has changed in some way
 /// that requires regenerating the build manifest file. This allows us to skip a lot of
-/// redundent work (package graph loading, build planning, manifest generation) during
+/// redundant work (package graph loading, build planning, manifest generation) during
 /// incremental builds.
 public struct PackageStructureTool: ToolProtocol {
     public static let name: String = "package-structure-tool"

Tests/CommandsTests/BuildToolTests.swift

@@ -280,7 +280,21 @@ final class BuildToolTests: XCTestCase {
             do {
                 let result = try execute([], packagePath: path)
                 // test second time, to make sure message is presented even when nothing to build (cached)
-                XCTAssertMatch(result.stdout, .equal("[1/1] Planning build\nBuild complete!\n"))
+                XCTAssertMatch(result.stdout, .equal("[1/1] Planning build\nBuilding for debugging...\nBuild complete!\n"))
+            }
+        }
+    }
+
+    func testBuildStartMessage() {
+        fixture(name: "DependencyResolution/Internal/Simple") { path in
+            do {
+                let result = try execute(["-c", "debug"], packagePath: path)
+                XCTAssertMatch(result.stdout, .prefix("Building for debugging"))
+            }
+
+            do {
+                let result = try execute(["-c", "release"], packagePath: path)
+                XCTAssertMatch(result.stdout, .prefix("Building for production"))
             }
         }
     }