Only configure test explorer once in tests

Author: plemarquand

test/integration-tests/testexplorer/TestExplorerIntegration.test.ts

@@ -14,7 +14,7 @@
 
 import * as assert from "assert";
 import * as vscode from "vscode";
-import { beforeEach } from "mocha";
+import { beforeEach, afterEach } from "mocha";
 import { testAssetUri } from "../../fixtures";
 import { TestExplorer } from "../../../src/TestExplorer/TestExplorer";
 import {
@@ -24,7 +24,6 @@ import {
     eventPromise,
     gatherTests,
     runTest,
-    testExplorerFor,
     waitForTestExplorerReady,
 } from "./utilities";
 import { WorkspaceContext } from "../../../src/WorkspaceContext";
@@ -40,7 +39,7 @@ import {
     reduceTestItemChildren,
 } from "../../../src/TestExplorer/TestUtils";
 import { runnableTag } from "../../../src/TestExplorer/TestDiscovery";
-import { activateExtensionForTest, updateSettings } from "../utilities/testutilities";
+import { activateExtensionForSuite, updateSettings } from "../utilities/testutilities";
 import { Commands } from "../../../src/commands";
 import { SwiftToolchain } from "../../../src/toolchain/toolchain";
 
@@ -52,6 +51,26 @@ suite("Test Explorer Suite", function () {
     let workspaceContext: WorkspaceContext;
     let testExplorer: TestExplorer;
 
+    activateExtensionForSuite({
+        async setup(ctx) {
+            workspaceContext = ctx;
+            const packageFolder = testAssetUri("defaultPackage");
+            const targetFolder = workspaceContext.folders.find(
+                folder => folder.folder.path === packageFolder.path
+            );
+
+            if (!targetFolder) {
+                throw new Error("Unable to find test explorer");
+            }
+
+            testExplorer = targetFolder.addTestExplorer();
+
+            // Set up the listener before bringing the text explorer in to focus,
+            // which starts searching the workspace for tests.
+            await waitForTestExplorerReady(testExplorer);
+        },
+    });
+
     suite("Debugging", function () {
         async function runXCTest() {
             const suiteId = "PackageTests.PassingXCTestSuite";
@@ -81,27 +100,22 @@ suite("Test Explorer Suite", function () {
         }
 
         suite("lldb-dap", () => {
-            activateExtensionForTest({
-                async setup(ctx) {
-                    // lldb-dap is only present/functional in the toolchain in 6.0.2 and up.
-                    if (ctx.swiftVersion.isLessThan(new Version(6, 0, 2))) {
-                        this.skip();
-                    }
-
-                    workspaceContext = ctx;
-                    testExplorer = testExplorerFor(
-                        workspaceContext,
-                        testAssetUri("defaultPackage")
-                    );
+            let resetSettings: (() => Promise<void>) | undefined;
+            beforeEach(async function () {
+                // lldb-dap is only present/functional in the toolchain in 6.0.2 and up.
+                if (workspaceContext.swiftVersion.isLessThan(new Version(6, 0, 2))) {
+                    this.skip();
+                }
 
-                    // Set up the listener before bringing the text explorer in to focus,
-                    // which starts searching the workspace for tests.
-                    await waitForTestExplorerReady(testExplorer);
+                resetSettings = await updateSettings({
+                    "swift.debugger.useDebugAdapterFromToolchain": true,
+                });
+            });
 
-                    return await updateSettings({
-                        "swift.debugger.useDebugAdapterFromToolchain": true,
-                    });
-                },
+            afterEach(async () => {
+                if (resetSettings) {
+                    await resetSettings();
+                }
             });
 
             test("Debugs specified XCTest test", runXCTest);
@@ -122,34 +136,28 @@ suite("Test Explorer Suite", function () {
                 }
             }
 
-            activateExtensionForTest({
-                async setup(ctx) {
-                    // CodeLLDB on windows doesn't print output and so cannot be parsed
-                    if (process.platform === "win32") {
-                        this.skip();
-                        return;
-                    }
-
-                    workspaceContext = ctx;
-                    testExplorer = testExplorerFor(
-                        workspaceContext,
-                        testAssetUri("defaultPackage")
-                    );
+            let resetSettings: (() => Promise<void>) | undefined;
+            beforeEach(async function () {
+                // CodeLLDB on windows doesn't print output and so cannot be parsed
+                if (process.platform === "win32") {
+                    this.skip();
+                }
 
-                    // Set up the listener before bringing the text explorer in to focus,
-                    // which starts searching the workspace for tests.
-                    await waitForTestExplorerReady(testExplorer);
+                const lldbPath =
+                    process.env["CI"] === "1"
+                        ? { "lldb.library": await getLLDBDebugAdapterPath() }
+                        : {};
 
-                    const lldbPath =
-                        process.env["CI"] === "1"
-                            ? { "lldb.library": await getLLDBDebugAdapterPath() }
-                            : {};
+                resetSettings = await updateSettings({
+                    "swift.debugger.useDebugAdapterFromToolchain": false,
+                    ...lldbPath,
+                });
+            });
 
-                    return await updateSettings({
-                        "swift.debugger.useDebugAdapterFromToolchain": false,
-                        ...lldbPath,
-                    });
-                },
+            afterEach(async () => {
+                if (resetSettings) {
+                    await resetSettings();
+                }
             });
 
             test("Debugs specified XCTest test", async function () {
@@ -170,26 +178,6 @@ suite("Test Explorer Suite", function () {
     });
 
     suite("Standard", () => {
-        activateExtensionForTest({
-            async setup(ctx) {
-                workspaceContext = ctx;
-                const packageFolder = testAssetUri("defaultPackage");
-                const targetFolder = workspaceContext.folders.find(
-                    folder => folder.folder.path === packageFolder.path
-                );
-
-                if (!targetFolder) {
-                    throw new Error("Unable to find test explorer");
-                }
-
-                testExplorer = targetFolder.addTestExplorer();
-
-                // Set up the listener before bringing the text explorer in to focus,
-                // which starts searching the workspace for tests.
-                await waitForTestExplorerReady(testExplorer);
-            },
-        });
-
         test("Finds Tests", async function () {
             if (workspaceContext.swiftVersion.isGreaterThanOrEqual(new Version(6, 0, 0))) {
                 // 6.0 uses the LSP which returns tests in the order they're declared.

test/integration-tests/testexplorer/utilities.ts

@@ -239,12 +239,16 @@ export async function gatherTests(
     const testItems = tests.map(test => {
         const testItem = getTestItem(controller, test);
         if (!testItem) {
-            const testsInController: string[] = [];
-            controller.items.forEach(item => {
-                testsInController.push(
-                    `${item.id}: ${item.label} ${item.error ? `(error: ${item.error})` : ""}`
-                );
-            });
+            const testsInController = reduceTestItemChildren(
+                controller.items,
+                (acc, item) => {
+                    acc.push(
+                        `${item.id}: ${item.label} ${item.error ? `(error: ${item.error})` : ""}`
+                    );
+                    return acc;
+                },
+                [] as string[]
+            );
 
             assert.fail(
                 `Unable to find ${test} in Test Controller. Items in test controller are: ${testsInController.join(", ")}`