Don't show XCTest failures under Problems view (#926)

Stop parsing diagnostics once build is complete

Issue: #925

Author: award999

src/DiagnosticsManager.ts

@@ -17,6 +17,7 @@ import stripAnsi = require("strip-ansi");
 import configuration from "./configuration";
 import { SwiftExecution } from "./tasks/SwiftExecution";
 import { WorkspaceContext } from "./WorkspaceContext";
+import { checkIfBuildComplete } from "./utilities/tasks";
 
 interface ParsedDiagnostic {
     uri: string;
@@ -262,6 +263,10 @@ export class DiagnosticsManager implements vscode.Disposable {
                     // Otherwise want to keep remaining data to pre-pend next write
                     remainingData = lines.pop();
                     for (const line of lines) {
+                        if (checkIfBuildComplete(line)) {
+                            done();
+                            return;
+                        }
                         const result = this.parseDiagnostic(line);
                         if (!result) {
                             continue;

src/ui/SwiftBuildStatus.ts

@@ -17,6 +17,7 @@ import * as vscode from "vscode";
 import configuration, { ShowBuildStatusOptions } from "../configuration";
 import { RunningTask, StatusItem } from "./StatusItem";
 import { SwiftExecution } from "../tasks/SwiftExecution";
+import { checkIfBuildComplete } from "../utilities/tasks";
 
 /**
  * Progress of `swift` build, parsed from the
@@ -111,7 +112,7 @@ export class SwiftBuildStatus implements vscode.Disposable {
         // be concerned with
         const lines = sanitizedData.split(/\r\n|\n|\r/gm).reverse();
         for (const line of lines) {
-            if (this.checkIfBuildComplete(line)) {
+            if (checkIfBuildComplete(line)) {
                 return true;
             }
             const progress = this.findBuildProgress(line);
@@ -128,22 +129,6 @@ export class SwiftBuildStatus implements vscode.Disposable {
         return false;
     }
 
-    private checkIfBuildComplete(line: string): boolean {
-        // Output in this format for "build" and "test" commands
-        const completeRegex = /^Build complete!/gm;
-        let match = completeRegex.exec(line);
-        if (match) {
-            return true;
-        }
-        // Output in this format for "run" commands
-        const productCompleteRegex = /^Build of product '.*' complete!/gm;
-        match = productCompleteRegex.exec(line);
-        if (match) {
-            return true;
-        }
-        return false;
-    }
-
     private checkIfFetching(line: string): boolean {
         const fetchRegex = /^Fetching\s/gm;
         return !!fetchRegex.exec(line);

src/utilities/tasks.ts

@@ -35,3 +35,19 @@ function getScopeWorkspaceFolder(task: vscode.Task): string | undefined {
     }
     return;
 }
+
+export function checkIfBuildComplete(line: string): boolean {
+    // Output in this format for "build" and "test" commands
+    const completeRegex = /^Build complete!/gm;
+    let match = completeRegex.exec(line);
+    if (match) {
+        return true;
+    }
+    // Output in this format for "run" commands
+    const productCompleteRegex = /^Build of product '.*' complete!/gm;
+    match = productCompleteRegex.exec(line);
+    if (match) {
+        return true;
+    }
+    return false;
+}

test/suite/DiagnosticsManager.test.ts

@@ -276,6 +276,25 @@ suite("DiagnosticsManager Test Suite", async function () {
                 // Should have cleaned up
                 assert.equal(diagnostics.length, 0);
             });
+
+            // https://github.com/apple/swift/issues/73973
+            test("Ignore XCTest failures", async () => {
+                const testUri = vscode.Uri.file(
+                    `${workspaceFolder.uri.path}/Tests/MyCLITests/MyCLIXCTests.swift`
+                );
+                const fixture = testSwiftTask("swift", ["test"], workspaceFolder, toolchain);
+                await vscode.tasks.executeTask(fixture.task);
+                // Wait to spawn before writing
+                fixture.process.write("Build complete!");
+                fixture.process.write(
+                    `${testUri.path}:11: error: -[MyCLITests.MyCLIXCTests testFailure] : XCTAssertEqual failed: ("41") is not equal to ("42")`
+                );
+                fixture.process.close(1);
+                await waitForNoRunningTasks();
+                const diagnostics = vscode.languages.getDiagnostics(testUri);
+                // Should be empty
+                assert.equal(diagnostics.length, 0);
+            });
         });
     });