Fixup several test issues

Author: plemarquand

src/BackgroundCompilation.ts

@@ -26,6 +26,7 @@ export class BackgroundCompilation implements vscode.Disposable {
     private workspaceFileWatcher?: vscode.FileSystemWatcher;
     private configurationEventDisposable?: vscode.Disposable;
     private disposables: vscode.Disposable[] = [];
+    private _disposed = false;
 
     constructor(private folderContext: FolderContext) {
         // We only want to configure the file watcher if background compilation is enabled.
@@ -59,7 +60,9 @@ export class BackgroundCompilation implements vscode.Disposable {
             this.workspaceFileWatcher.onDidChange(
                 debounce(
                     () => {
-                        void this.runTask();
+                        if (!this._disposed) {
+                            void this.runTask();
+                        }
                     },
                     100 /* 10 times per second */,
                     { trailing: true }
@@ -73,6 +76,7 @@ export class BackgroundCompilation implements vscode.Disposable {
     }
 
     dispose() {
+        this._disposed = true;
         this.configurationEventDisposable?.dispose();
         this.disposables.forEach(disposable => disposable.dispose());
     }

src/FolderContext.ts

@@ -70,6 +70,7 @@ export class FolderContext implements vscode.Disposable {
         this.packageWatcher.dispose();
         this.testExplorer?.dispose();
         this.backgroundCompilation.dispose();
+        this.taskQueue.dispose();
     }
 
     /**

src/debugger/buildConfig.ts

@@ -414,6 +414,7 @@ export class TestingConfigurationFactory {
                         if (xcTestPath === undefined) {
                             return null;
                         }
+                        const toolchain = this.ctx.toolchain;
                         return {
                             ...baseConfig,
                             program: path.join(xcTestPath, "xctest"),
@@ -423,6 +424,16 @@ export class TestingConfigurationFactory {
                             env: {
                                 ...this.testEnv,
                                 ...this.sanitizerRuntimeEnvironment,
+                                ...(toolchain.swiftVersion.isGreaterThanOrEqual(
+                                    new Version(6, 2, 0)
+                                )
+                                    ? {
+                                          // Starting in 6.2 we need to provide libTesting.dylib for xctests
+                                          DYLD_FRAMEWORK_PATH:
+                                              toolchain.swiftTestingFrameworkPath(),
+                                          DYLD_LIBRARY_PATH: toolchain.swiftTestingLibraryPath(),
+                                      }
+                                    : {}),
                                 SWIFT_TESTING_ENABLED: "0",
                             },
                         };

src/tasks/TaskQueue.ts

@@ -163,7 +163,7 @@ class QueuedOperation {
  *
  * Queue swift task operations to be executed serially
  */
-export class TaskQueue {
+export class TaskQueue implements vscode.Disposable {
     queue: QueuedOperation[];
     activeOperation?: QueuedOperation;
     workspaceContext: WorkspaceContext;
@@ -176,6 +176,11 @@ export class TaskQueue {
         this.disabled = false;
     }
 
+    dispose() {
+        this.queue = [];
+        this.activeOperation = undefined;
+    }
+
     /**
      * Add operation to queue
      * @param operation Operation to queue

test/integration-tests/FolderContext.test.ts

@@ -26,6 +26,7 @@ import { activateExtensionForSuite, getRootWorkspaceFolder } from "./utilities/t
 
 suite("FolderContext Error Handling Test Suite", () => {
     let workspaceContext: WorkspaceContext;
+    let folderContext: FolderContext | undefined;
     let swiftToolchainCreateStub: MockedFunction<typeof SwiftToolchain.create>;
     const showToolchainError = mockGlobalValue(toolchain, "showToolchainError");
 
@@ -38,6 +39,7 @@ suite("FolderContext Error Handling Test Suite", () => {
     });
 
     afterEach(() => {
+        folderContext?.dispose();
         restore();
     });
 
@@ -52,11 +54,7 @@ suite("FolderContext Error Handling Test Suite", () => {
         const workspaceFolder = getRootWorkspaceFolder();
         const testFolder = testAssetUri("package2");
 
-        const folderContext = await FolderContext.create(
-            testFolder,
-            workspaceFolder,
-            workspaceContext
-        );
+        folderContext = await FolderContext.create(testFolder, workspaceFolder, workspaceContext);
 
         assert.ok(folderContext, "FolderContext should be created despite toolchain failure");
         assert.strictEqual(
@@ -99,11 +97,7 @@ suite("FolderContext Error Handling Test Suite", () => {
         const showToolchainErrorStub = stub().resolves(true);
         showToolchainError.setValue(showToolchainErrorStub);
 
-        const folderContext = await FolderContext.create(
-            testFolder,
-            workspaceFolder,
-            workspaceContext
-        );
+        folderContext = await FolderContext.create(testFolder, workspaceFolder, workspaceContext);
 
         // Assert: FolderContext should be created successfully
         assert.ok(folderContext, "FolderContext should be created after retry");
@@ -146,11 +140,7 @@ suite("FolderContext Error Handling Test Suite", () => {
         const showToolchainErrorStub = stub().resolves(true);
         showToolchainError.setValue(showToolchainErrorStub);
 
-        const folderContext = await FolderContext.create(
-            testFolder,
-            workspaceFolder,
-            workspaceContext
-        );
+        folderContext = await FolderContext.create(testFolder, workspaceFolder, workspaceContext);
 
         assert.ok(
             folderContext,

test/integration-tests/language/LanguageClientIntegration.test.ts

@@ -30,6 +30,7 @@ async function buildProject(ctx: WorkspaceContext, name: string) {
     await waitForNoRunningTasks();
     const folderContext = await folderInRootWorkspace(name, ctx);
     const task = await createBuildAllTask(folderContext);
+    task.definition.dontTriggerTestDiscovery = true;
     const { exitCode, output } = await executeTaskAndWaitForResult(task);
     expect(exitCode, `${output}`).to.equal(0);
     return folderContext;

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

@@ -39,6 +39,7 @@ import {
     activateExtensionForSuite,
     folderInRootWorkspace,
     updateSettings,
+    withLogging,
 } from "../utilities/testutilities";
 import {
     assertContains,
@@ -60,19 +61,29 @@ tag("large").suite("Test Explorer Suite", function () {
     activateExtensionForSuite({
         async setup(ctx) {
             workspaceContext = ctx;
-            folderContext = await folderInRootWorkspace("defaultPackage", workspaceContext);
+            const logger = withLogging(ctx.logger);
+            folderContext = await logger("Locating defaultPackage folder in root workspace", () =>
+                folderInRootWorkspace("defaultPackage", workspaceContext)
+            );
 
             if (!folderContext) {
                 throw new Error("Unable to find test explorer");
             }
 
-            testExplorer = await folderContext.resolvedTestExplorer;
+            testExplorer = await logger(
+                "Waiting for test explorer to resolve",
+                () => folderContext.resolvedTestExplorer
+            );
 
-            await executeTaskAndWaitForResult(await createBuildAllTask(folderContext));
+            await logger("Executing build all task", async () =>
+                executeTaskAndWaitForResult(await createBuildAllTask(folderContext))
+            );
 
             // Set up the listener before bringing the text explorer in to focus,
             // which starts searching the workspace for tests.
-            await waitForTestExplorerReady(testExplorer);
+            await logger("Waiting for test explorer to be ready", () =>
+                waitForTestExplorerReady(testExplorer)
+            );
         },
         requiresLSP: true,
         requiresDebugger: true,