fix "build complete" message (#3313)

motivation: print "build complete" message reliably

changes:
* move the logic to printg the "build complete" message to the build complete handler
* add tests

Author: tomerd

Sources/Build/BuildOperation.swift

@@ -128,11 +128,11 @@ public final class BuildOperation: PackageStructureDelegate, SPMBuildCore.BuildS
         let llbuildTarget = try computeLLBuildTargetName(for: subset)
         let success = buildSystem.build(target: llbuildTarget)
 
-        buildSystemDelegate?.progressAnimation.complete(success: success)
+        buildSystemDelegate?.buildComplete(success: success)
         delegate?.buildSystem(self, didFinishWithResult: success)
         guard success else { throw Diagnostics.fatalError }
 
-        // Create backwards-compatibilty symlink to old build path.
+        // Create backwards-compatibility symlink to old build path.
         let oldBuildPath = buildParameters.dataPath.parentDirectory.appending(
             component: buildParameters.configuration.dirname
         )

Sources/Build/BuildOperationBuildSystemDelegateHandler.swift

@@ -608,14 +608,25 @@ final class BuildOperationBuildSystemDelegateHandler: LLBuildBuildSystemDelegate
         onCommmandFailure?()
     }
 
+    func buildComplete(success: Bool) {
+        if success {
+            self.progressAnimation.update(
+                step: taskTracker.finishedCount,
+                total: taskTracker.totalCount,
+                text: "Build complete!")
+        }
+        self.progressAnimation.complete(success: success)
+    }
+
     // MARK: Private
 
     private func updateProgress() {
         if let progressText = taskTracker.latestFinishedText {
-            progressAnimation.update(
+            self.progressAnimation.update(
                 step: taskTracker.finishedCount,
                 total: taskTracker.totalCount,
-                text: progressText)
+                text: progressText
+            )
         }
     }
 }
@@ -638,13 +649,7 @@ fileprivate struct CommandTaskTracker {
         case .isUpToDate:
             totalCount -= 1
         case .isComplete:
-            if (totalCount == finishedCount) {
-                let latestOutput: String? = latestFinishedText
-                latestFinishedText = """
-                \(latestOutput ?? "")\n
-                * Build Completed!
-                """
-            }
+            break
         @unknown default:
             assertionFailure("unhandled command status kind \(kind) for command \(command)")
             break

Tests/CommandsTests/BuildToolTests.swift

@@ -242,4 +242,22 @@ final class BuildToolTests: XCTestCase {
             }
         }
     }
+
+    func testBuildCompleteMessage() {
+        fixture(name: "DependencyResolution/Internal/Simple") { path in
+            do {
+                let result = try execute([], packagePath: path)
+                #if os(macOS)
+                XCTAssertTrue(result.stdout.contains("[6/6] Build complete!"), result.stdout)
+                #else
+                XCTAssertTrue(result.stdout.contains("[8/8] Build complete!"), result.stdout)
+                #endif
+            }
+
+            do {
+                let result = try execute([], packagePath: path)
+                XCTAssertTrue(result.stdout.contains("[0/0] Build complete!"), result.stdout)
+            }
+        }
+    }
 }

Tests/FunctionalTests/PluginTests.swift

@@ -22,7 +22,7 @@ class PluginTests: XCTestCase {
                 XCTAssert(stdout.contains("Linking MySourceGenTool"), "stdout:\n\(stdout)")
                 XCTAssert(stdout.contains("Generating Foo.swift from Foo.dat"), "stdout:\n\(stdout)")
                 XCTAssert(stdout.contains("Linking MyLocalTool"), "stdout:\n\(stdout)")
-                XCTAssert(stdout.contains("Build Completed"), "stdout:\n\(stdout)")
+                XCTAssert(stdout.contains("Build complete!"), "stdout:\n\(stdout)")
             }
             catch {
                 print(error)
@@ -38,7 +38,7 @@ class PluginTests: XCTestCase {
                 XCTAssert(stdout.contains("Linking MySourceGenTool"), "stdout:\n\(stdout)")
                 XCTAssert(stdout.contains("Generating Foo.swift from Foo.dat"), "stdout:\n\(stdout)")
                 XCTAssert(stdout.contains("Linking MyTool"), "stdout:\n\(stdout)")
-                XCTAssert(stdout.contains("Build Completed"), "stdout:\n\(stdout)")
+                XCTAssert(stdout.contains("Build complete!"), "stdout:\n\(stdout)")
             }
             catch {
                 print(error)