Debug diagnostics tests

Author: plemarquand

.vscode-test.js

@@ -15,7 +15,7 @@
 const { defineConfig } = require("@vscode/test-cli");
 const path = require("path");
 
-const isCIBuild = process.env["CI"] === "1";
+const isCIBuild = false; // process.env["CI"] === "1";
 const isFastTestRun = process.env["FAST_TEST_RUN"] === "1";
 
 // "env" in launch.json doesn't seem to work with vscode-test

src/DiagnosticsManager.ts

@@ -87,13 +87,19 @@ export class DiagnosticsManager implements vscode.Disposable {
                 .then(map => {
                     // Clean up old "swiftc" diagnostics
                     this.removeSwiftcDiagnostics();
-                    map.forEach((diagnostics, uri) =>
+                    map.forEach((diagnostics, uri) => {
+                        console.log(
+                            ">>> PROVIDED DIAGNOSTIC!",
+                            uri,
+                            "::",
+                            JSON.stringify(diagnostics)
+                        );
                         this.handleDiagnostics(
                             vscode.Uri.file(uri),
                             DiagnosticsManager.isSwiftc,
                             diagnostics
-                        )
-                    );
+                        );
+                    });
                 })
                 .catch(e =>
                     context.outputChannel.log(`${e}`, 'Failed to provide "swiftc" diagnostics')
@@ -319,9 +325,12 @@ export class DiagnosticsManager implements vscode.Disposable {
     ): ParsedDiagnostic | vscode.DiagnosticRelatedInformation | undefined {
         const diagnosticRegex = /^(.*?):(\d+)(?::(\d+))?:\s+(warning|error|note):\s+([^\\[]*)/g;
         const match = diagnosticRegex.exec(line);
+        console.log(">>> CHECK LINE", line);
         if (!match) {
+            console.log(">>> NO MATCH", line);
             return;
         }
+        console.log(">>> MATCH", match);
         const uri = match[1];
         const message = this.capitalize(match[5]).trim();
         const range = this.range(match[2], match[3]);

test/integration-tests/DiagnosticsManager.test.ts

@@ -25,21 +25,41 @@ import { Version } from "../../src/utilities/version";
 import { folderContextPromise, globalWorkspaceContextPromise } from "./extension.test";
 import { Workbench } from "../../src/utilities/commands";
 
-const waitForDiagnostics = (uris: vscode.Uri[], allowEmpty: boolean = true) =>
-    new Promise<void>(res =>
-        vscode.languages.onDidChangeDiagnostics(e => {
-            const paths = e.uris.map(u => u.fsPath);
-            for (const uri of uris) {
-                if (!paths.includes(uri.fsPath)) {
-                    return;
-                }
-                if (!allowEmpty && !vscode.languages.getDiagnostics(uri).length) {
-                    return;
-                }
+// Wait for all the expected diagnostics to be recieved. This may happen over several
+// `onChangeDiagnostics` events.
+const waitForDiagnostics = (expectedDiagnostics: { [uri: string]: vscode.Diagnostic[] }) => {
+    return new Promise<void>(resolve => {
+        // Keep a lookup of diagnostics we haven't encountered yet. When all array values in
+        // this lookup are empty then we've seen all diagnostics and we can resolve successfully.
+        const expected = { ...expectedDiagnostics };
+        const disposable = vscode.languages.onDidChangeDiagnostics(e => {
+            const matchingPaths = Object.keys(expectedDiagnostics).filter(uri =>
+                e.uris.some(u => u.fsPath === uri)
+            );
+            console.log(">>> Got diag for matching paths", matchingPaths);
+            for (const uri of matchingPaths) {
+                const actualDiagnostics = vscode.languages.getDiagnostics(vscode.Uri.parse(uri));
+                console.log(">>> ", uri, "Actual diagnostics", actualDiagnostics);
+                console.log(">>> ", uri, "before", expected[uri].length);
+                expected[uri] = expected[uri].filter(expectedDiagnostic => {
+                    return !actualDiagnostics.some(actualDiagnostic =>
+                        isEqual(actualDiagnostic, expectedDiagnostic)
+                    );
+                });
+                console.log(">>> ", uri, "after", expected[uri].length);
             }
-            res();
-        })
-    );
+
+            const allDiagnosticsFulfilled = Object.values(expected).every(
+                diagnostics => diagnostics.length === 0
+            );
+
+            if (allDiagnosticsFulfilled) {
+                disposable.dispose();
+                resolve();
+            }
+        });
+    });
+};
 
 const isEqual = (d1: vscode.Diagnostic, d2: vscode.Diagnostic) =>
     d1.severity === d2.severity &&
@@ -56,7 +76,7 @@ function assertHasDiagnostic(uri: vscode.Uri, expected: vscode.Diagnostic): vsco
     assert.notEqual(
         diagnostic,
         undefined,
-        `Could not find diagnostic matching:\n${JSON.stringify(expected)}`
+        `Could not find diagnostic matching:\n${JSON.stringify(expected)}\nDiagnostics found:\n${JSON.stringify(diagnostics)}`
     );
     return diagnostic!;
 }
@@ -92,7 +112,7 @@ suite("DiagnosticsManager Test Suite", async function () {
     let cppHeaderUri: vscode.Uri;
 
     suiteSetup(async function () {
-        this.timeout(30000);
+        this.timeout(60000);
 
         workspaceContext = await globalWorkspaceContextPromise;
         toolchain = workspaceContext.toolchain;
@@ -112,7 +132,7 @@ suite("DiagnosticsManager Test Suite", async function () {
     });
 
     suite("Parse diagnostics", async () => {
-        suite("Parse from task output", async () => {
+        suite.only("Parse from task output", async () => {
             const expectedWarningDiagnostic = new vscode.Diagnostic(
                 new vscode.Range(new vscode.Position(1, 8), new vscode.Position(1, 8)),
                 "Initialization of variable 'unused' was never used; consider replacing with assignment to '_' or removing it",
@@ -153,20 +173,21 @@ suite("DiagnosticsManager Test Suite", async function () {
             });
 
             test("default diagnosticsStyle", async () => {
+                console.log(">>> Updating diagnosticsStyle to default");
                 await swiftConfig.update("diagnosticsStyle", "default");
-                const task = createBuildAllTask(folderContext);
-                // Run actual task
-                const promise = waitForDiagnostics([mainUri, funcUri]);
-                await executeTaskAndWaitForResult(task);
-                await promise;
-                await waitForNoRunningTasks();
 
-                // Should have parsed correct severity
-                assertHasDiagnostic(mainUri, expectedWarningDiagnostic);
-                assertHasDiagnostic(mainUri, expectedMainErrorDiagnostic);
-                // Check parsed for other file
-                assertHasDiagnostic(funcUri, expectedFuncErrorDiagnostic);
-            }).timeout(2 * 60 * 1000); // Allow 2 minutes to build
+                console.log(">>> Running actual task and waiting for diagnostics");
+                await Promise.all([
+                    executeTaskAndWaitForResult(createBuildAllTask(folderContext)),
+                    waitForDiagnostics({
+                        [mainUri.fsPath]: [expectedWarningDiagnostic, expectedMainErrorDiagnostic], // Should have parsed correct severity
+                        [funcUri.fsPath]: [expectedFuncErrorDiagnostic], // Check parsed for other file
+                    }),
+                ]);
+
+                console.log(">>> Waiting for no running tasks");
+                await waitForNoRunningTasks();
+            });
 
             test("swift diagnosticsStyle", async function () {
                 // This is only supported in swift versions >=5.10.0
@@ -176,31 +197,29 @@ suite("DiagnosticsManager Test Suite", async function () {
                     return;
                 }
                 await swiftConfig.update("diagnosticsStyle", "swift");
-                const task = createBuildAllTask(folderContext);
-                // Run actual task
-                const promise = waitForDiagnostics([mainUri, funcUri]);
-                await executeTaskAndWaitForResult(task);
-                await promise;
+                await Promise.all([
+                    executeTaskAndWaitForResult(createBuildAllTask(folderContext)),
+                    waitForDiagnostics({
+                        [mainUri.fsPath]: [expectedWarningDiagnostic, expectedMainErrorDiagnostic], // Should have parsed correct severity
+                        [funcUri.fsPath]: [expectedFuncErrorDiagnostic], // Check parsed for other file
+                    }),
+                ]);
                 await waitForNoRunningTasks();
-
-                // Should have parsed severity
-                assertHasDiagnostic(mainUri, expectedWarningDiagnostic);
-                assertHasDiagnostic(mainUri, expectedMainErrorDiagnostic);
-                // Check parsed for other file
-                assertHasDiagnostic(funcUri, expectedFuncErrorDiagnostic);
-            }).timeout(2 * 60 * 1000); // Allow 2 minutes to build
+            });
 
             test("llvm diagnosticsStyle", async () => {
                 await swiftConfig.update("diagnosticsStyle", "llvm");
-                const task = createBuildAllTask(folderContext);
-                // Run actual task
-                const promise = waitForDiagnostics([mainUri, funcUri]);
-                await executeTaskAndWaitForResult(task);
-                await promise;
+
+                await Promise.all([
+                    executeTaskAndWaitForResult(createBuildAllTask(folderContext)),
+                    waitForDiagnostics({
+                        [mainUri.fsPath]: [expectedWarningDiagnostic, expectedMainErrorDiagnostic], // Should have parsed correct severity
+                        [funcUri.fsPath]: [expectedFuncErrorDiagnostic], // Check parsed for other file
+                    }),
+                ]);
                 await waitForNoRunningTasks();
 
                 // Should have parsed severity
-                assertHasDiagnostic(mainUri, expectedWarningDiagnostic);
                 const diagnostic = assertHasDiagnostic(mainUri, expectedMainErrorDiagnostic);
                 // Should have parsed related note
                 assert.equal(diagnostic.relatedInformation?.length, 1);
@@ -215,9 +234,7 @@ suite("DiagnosticsManager Test Suite", async function () {
                     ),
                     true
                 );
-                // Check parsed for other file
-                assertHasDiagnostic(funcUri, expectedFuncErrorDiagnostic);
-            }).timeout(2 * 60 * 1000); // Allow 2 minutes to build
+            });
 
             test("Parses C diagnostics", async function () {
                 const swiftVersion = workspaceContext.toolchain.swiftVersion;
@@ -228,12 +245,6 @@ suite("DiagnosticsManager Test Suite", async function () {
                 }
 
                 await swiftConfig.update("diagnosticsStyle", "llvm");
-                const task = createBuildAllTask(cFolderContext);
-                // Run actual task
-                const promise = waitForDiagnostics([cUri]);
-                await executeTaskAndWaitForResult(task);
-                await promise;
-                await waitForNoRunningTasks();
 
                 // Should have parsed severity
                 const expectedDiagnostic1 = new vscode.Diagnostic(
@@ -249,8 +260,13 @@ suite("DiagnosticsManager Test Suite", async function () {
                 );
                 expectedDiagnostic2.source = "swiftc";
 
-                assertHasDiagnostic(cUri, expectedDiagnostic1);
-                assertHasDiagnostic(cUri, expectedDiagnostic2);
+                await Promise.all([
+                    executeTaskAndWaitForResult(createBuildAllTask(cFolderContext)),
+                    waitForDiagnostics({
+                        [cUri.fsPath]: [expectedDiagnostic1, expectedDiagnostic2],
+                    }),
+                ]);
+                await waitForNoRunningTasks();
             });
 
             test("Parses C++ diagnostics", async function () {
@@ -262,12 +278,6 @@ suite("DiagnosticsManager Test Suite", async function () {
                 }
 
                 await swiftConfig.update("diagnosticsStyle", "llvm");
-                const task = createBuildAllTask(cppFolderContext);
-                // Run actual task
-                const promise = waitForDiagnostics([cppUri]);
-                await executeTaskAndWaitForResult(task);
-                await promise;
-                await waitForNoRunningTasks();
 
                 // Should have parsed severity
                 const expectedDiagnostic1 = new vscode.Diagnostic(
@@ -276,7 +286,6 @@ suite("DiagnosticsManager Test Suite", async function () {
                     vscode.DiagnosticSeverity.Error
                 );
                 expectedDiagnostic1.source = "swiftc";
-                assertHasDiagnostic(cppUri, expectedDiagnostic1);
 
                 // Should have parsed releated information
                 const expectedDiagnostic2 = new vscode.Diagnostic(
@@ -285,6 +294,21 @@ suite("DiagnosticsManager Test Suite", async function () {
                     vscode.DiagnosticSeverity.Error
                 );
                 expectedDiagnostic2.source = "swiftc";
+
+                await Promise.all([
+                    executeTaskAndWaitForResult(createBuildAllTask(cppFolderContext)),
+                    waitForDiagnostics({
+                        [cppUri.fsPath]: [expectedDiagnostic1, expectedDiagnostic2],
+                    }),
+                ]);
+                await waitForNoRunningTasks();
+                // const task = createBuildAllTask(cppFolderContext);
+                // // Run actual task
+                // const promise = Promise.resolve(); // waitForDiagnostics([cppUri]);
+                // await executeTaskAndWaitForResult(task);
+                // await promise;
+                // await waitForNoRunningTasks();
+
                 const diagnostic = assertHasDiagnostic(cppUri, expectedDiagnostic2);
                 assert.equal(
                     diagnostic.relatedInformation![0].location.uri.fsPath,
@@ -315,7 +339,7 @@ suite("DiagnosticsManager Test Suite", async function () {
             test("Parse partial line", async () => {
                 const fixture = testSwiftTask("swift", ["build"], workspaceFolder, toolchain);
                 await vscode.tasks.executeTask(fixture.task);
-                const diagnosticsPromise = waitForDiagnostics([mainUri]);
+                const diagnosticsPromise = Promise.resolve(); // waitForDiagnostics([mainUri]);
                 // Wait to spawn before writing
                 fixture.process.write(`${mainUri.fsPath}:13:5: err`, "");
                 fixture.process.write("or: Cannot find 'fo", "");
@@ -331,7 +355,7 @@ suite("DiagnosticsManager Test Suite", async function () {
             test("Ignore duplicates", async () => {
                 const fixture = testSwiftTask("swift", ["build"], workspaceFolder, toolchain);
                 await vscode.tasks.executeTask(fixture.task);
-                const diagnosticsPromise = waitForDiagnostics([mainUri]);
+                const diagnosticsPromise = Promise.resolve(); // waitForDiagnostics([mainUri]);
                 // Wait to spawn before writing
                 const output = `${mainUri.fsPath}:13:5: error: Cannot find 'foo' in scope`;
                 fixture.process.write(output);
@@ -349,7 +373,7 @@ suite("DiagnosticsManager Test Suite", async function () {
             test("New set of swiftc diagnostics clear old list", async () => {
                 let fixture = testSwiftTask("swift", ["build"], workspaceFolder, toolchain);
                 await vscode.tasks.executeTask(fixture.task);
-                let diagnosticsPromise = waitForDiagnostics([mainUri]);
+                let diagnosticsPromise = Promise.resolve(); // waitForDiagnostics([mainUri]);
                 // Wait to spawn before writing
                 fixture.process.write(`${mainUri.fsPath}:13:5: error: Cannot find 'foo' in scope`);
                 fixture.process.close(1);
@@ -363,7 +387,7 @@ suite("DiagnosticsManager Test Suite", async function () {
                 // Run again but no diagnostics returned
                 fixture = testSwiftTask("swift", ["build"], workspaceFolder, toolchain);
                 await vscode.tasks.executeTask(fixture.task);
-                diagnosticsPromise = waitForDiagnostics([mainUri]);
+                diagnosticsPromise = Promise.resolve(); // waitForDiagnostics([mainUri]);
                 fixture.process.close(0);
                 await waitForNoRunningTasks();
                 await diagnosticsPromise;
@@ -920,7 +944,7 @@ suite("DiagnosticsManager Test Suite", async function () {
             await executeTaskAndWaitForResult(task);
 
             // Open file
-            const promise = waitForDiagnostics([mainUri], false);
+            const promise = Promise.resolve(); // waitForDiagnostics([mainUri], false);
             const document = await vscode.workspace.openTextDocument(mainUri);
             await vscode.languages.setTextDocumentLanguage(document, "swift");
             await vscode.window.showTextDocument(document);
@@ -961,7 +985,7 @@ suite("DiagnosticsManager Test Suite", async function () {
             await executeTaskAndWaitForResult(task);
 
             // Open file
-            const promise = waitForDiagnostics([cUri], false);
+            const promise = Promise.resolve(); //  waitForDiagnostics([cUri], false);
             const document = await vscode.workspace.openTextDocument(cUri);
             await vscode.languages.setTextDocumentLanguage(document, "c");
             await vscode.window.showTextDocument(document);