Add tests for the Swift snippets workflows

* Created some common utilities for dealing with debug sessions
* Add integration test for run command and debug variant, big difference
  being whether the breakpoint is hit or not

Issue: #1125

Author: award999

test/integration-tests/BackgroundCompilation.test.ts

@@ -16,7 +16,7 @@ import * as assert from "assert";
 import * as vscode from "vscode";
 import { WorkspaceContext } from "../../src/WorkspaceContext";
 import { testAssetUri } from "../fixtures";
-import { waitForNoRunningTasks } from "../utilities";
+import { waitForNoRunningTasks } from "../utilities/tasks";
 import { Workbench } from "../../src/utilities/commands";
 import { activateExtensionForTest, updateSettings } from "./utilities/testutilities";
 

test/integration-tests/DiagnosticsManager.test.ts

@@ -15,7 +15,7 @@
 import * as assert from "assert";
 import * as vscode from "vscode";
 import { SwiftToolchain } from "../../src/toolchain/toolchain";
-import { executeTaskAndWaitForResult, waitForNoRunningTasks } from "../utilities";
+import { executeTaskAndWaitForResult, waitForNoRunningTasks } from "../utilities/tasks";
 import { WorkspaceContext } from "../../src/WorkspaceContext";
 import { testAssetWorkspaceFolder, testSwiftTask } from "../fixtures";
 import { createBuildAllTask } from "../../src/tasks/SwiftTaskProvider";

test/integration-tests/SwiftSnippet.test.ts

@@ -0,0 +1,87 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the VS Code Swift open source project
+//
+// Copyright (c) 2024 the VS Code Swift project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of VS Code Swift project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+import * as vscode from "vscode";
+import { folderContextPromise } from "./extension.test";
+import { testAssetPath, testAssetUri } from "../fixtures";
+import { waitForNoRunningTasks } from "../utilities/tasks";
+import { expect } from "chai";
+import {
+    continueSession,
+    waitForDebugAdapterCommand,
+    waitForDebugAdapterExit,
+    waitUntilDebugSessionTerminates,
+} from "../utilities/debug";
+
+suite("SwiftSnippet Test Suite", () => {
+    const uri = testAssetUri("defaultPackage/Snippets/hello.swift");
+    const breakpoints = [
+        new vscode.SourceBreakpoint(new vscode.Location(uri, new vscode.Position(2, 0))),
+    ];
+
+    suiteSetup(async () => {
+        await folderContextPromise("defaultPackage");
+        await waitForNoRunningTasks();
+
+        // File needs to be open for command to be enabled
+        const doc = await vscode.workspace.openTextDocument(uri.fsPath);
+        await vscode.window.showTextDocument(doc);
+
+        // Set a breakpoint
+        vscode.debug.addBreakpoints(breakpoints);
+    });
+
+    suiteTeardown(async () => {
+        await vscode.commands.executeCommand("workbench.action.closeAllEditors");
+        vscode.debug.removeBreakpoints(breakpoints);
+    });
+
+    test("Run `Swift: Run Swift Snippet` command for snippet file", async () => {
+        const sessionPromise = waitUntilDebugSessionTerminates("Run hello");
+        const exitPromise = waitForDebugAdapterExit("Run hello");
+
+        await vscode.commands.executeCommand("swift.runSnippet");
+
+        const exitCode = await exitPromise;
+        expect(exitCode).to.equal(0);
+
+        const session = await sessionPromise;
+        expect(session.configuration).to.have.property(
+            "program",
+            `${testAssetPath("defaultPackage")}/.build/debug/hello`
+        );
+        expect(session.configuration).to.have.property("noDebug", true);
+    }).timeout(120000);
+
+    test("Run `Swift: Debug Swift Snippet` command for snippet file", async () => {
+        const bpPromise = waitForDebugAdapterCommand("Run hello", "stackTrace");
+        const sessionPromise = waitUntilDebugSessionTerminates("Run hello");
+        const exitPromise = waitForDebugAdapterExit("Run hello");
+
+        vscode.commands.executeCommand("swift.debugSnippet");
+
+        // Once bp is hit, continue
+        await bpPromise.then(() => continueSession());
+
+        const exitCode = await exitPromise;
+        expect(exitCode).to.equal(0);
+
+        const session = await sessionPromise;
+        expect(session.configuration).to.have.property(
+            "program",
+            `${testAssetPath("defaultPackage")}/.build/debug/hello`
+        );
+        expect(session.configuration).to.not.have.property("noDebug");
+    }).timeout(120000);
+});

test/integration-tests/tasks/SwiftExecution.test.ts

@@ -16,7 +16,7 @@ import * as vscode from "vscode";
 import * as assert from "assert";
 import { testSwiftTask } from "../../fixtures";
 import { WorkspaceContext } from "../../../src/WorkspaceContext";
-import { executeTaskAndWaitForResult, waitForNoRunningTasks } from "../../utilities";
+import { executeTaskAndWaitForResult, waitForNoRunningTasks } from "../../utilities/tasks";
 import { SwiftToolchain } from "../../../src/toolchain/toolchain";
 import { activateExtensionForSuite } from "../utilities/testutilities";
 

test/integration-tests/tasks/SwiftPluginTaskProvider.test.ts

@@ -19,12 +19,8 @@ import { WorkspaceContext } from "../../../src/WorkspaceContext";
 import { SwiftPluginTaskProvider } from "../../../src/tasks/SwiftPluginTaskProvider";
 import { FolderContext } from "../../../src/FolderContext";
 import { activateExtensionForSuite, folderInRootWorkspace } from "../utilities/testutilities";
-import {
-    cleanOutput,
-    executeTaskAndWaitForResult,
-    mutable,
-    waitForEndTaskProcess,
-} from "../../utilities";
+import { cleanOutput, executeTaskAndWaitForResult, waitForEndTaskProcess } from "../../utilities/tasks";
+import { mutable } from "../../utilities/types";
 
 suite("SwiftPluginTaskProvider Test Suite", () => {
     let workspaceContext: WorkspaceContext;

test/integration-tests/tasks/SwiftPseudoterminal.test.ts

@@ -15,7 +15,7 @@
 import * as assert from "assert";
 import * as vscode from "vscode";
 import { TestSwiftProcess } from "../../fixtures";
-import { waitForClose, waitForWrite } from "../../utilities";
+import { waitForClose, waitForWrite } from "../../utilities/tasks";
 import { SwiftPseudoterminal } from "../../../src/tasks/SwiftPseudoterminal";
 
 suite("SwiftPseudoterminal Tests Suite", () => {

test/integration-tests/tasks/SwiftTaskProvider.test.ts

@@ -27,7 +27,7 @@ import {
     executeTaskAndWaitForResult,
     waitForEndTaskProcess,
     waitForNoRunningTasks,
-} from "../../utilities";
+} from "../../utilities/tasks";
 import { Version } from "../../../src/utilities/version";
 import { FolderContext } from "../../../src/FolderContext";
 import { mockGlobalObject } from "../../MockUtils";

test/integration-tests/tasks/TaskManager.test.ts

@@ -16,8 +16,8 @@ import * as vscode from "vscode";
 import * as assert from "assert";
 import { TaskManager } from "../../../src/tasks/TaskManager";
 import { WorkspaceContext } from "../../../src/WorkspaceContext";
-import { waitForNoRunningTasks } from "../../utilities";
 import { activateExtensionForSuite } from "../utilities/testutilities";
+import { waitForNoRunningTasks } from "../../utilities/tasks";
 
 suite("TaskManager Test Suite", () => {
     let workspaceContext: WorkspaceContext;

test/integration-tests/tasks/TaskQueue.test.ts

@@ -17,7 +17,7 @@ import * as assert from "assert";
 import { testAssetPath } from "../../fixtures";
 import { WorkspaceContext } from "../../../src/WorkspaceContext";
 import { SwiftExecOperation, TaskOperation, TaskQueue } from "../../../src/tasks/TaskQueue";
-import { waitForNoRunningTasks } from "../../utilities";
+import { waitForNoRunningTasks } from "../../utilities/tasks";
 import { activateExtensionForSuite } from "../utilities/testutilities";
 
 suite("TaskQueue Test Suite", () => {

test/utilities/debug.ts

@@ -31,11 +31,10 @@ export async function continueSession(): Promise<void> {
 export async function waitForDebugAdapterMessage(
     name: string,
     matches: (message: any) => boolean,
-    workspaceContext: WorkspaceContext
 ): Promise<any> {
     return await new Promise<any>(res => {
         const disposable = vscode.debug.registerDebugAdapterTrackerFactory(
-            DebugAdapter.getLaunchConfigType(workspaceContext.toolchain.swiftVersion),
+            "swift-lldb",
             {
                 createDebugAdapterTracker: function (
                     session: vscode.DebugSession
@@ -57,6 +56,22 @@ export async function waitForDebugAdapterMessage(
     });
 }
 
+/**
+ * Waits for a specific debug session to terminate.
+ *
+ * @param name The name of the debug session to wait for.
+ * @returns the terminated DebugSession
+ */
+export async function waitUntilDebugSessionTerminates(name: string): Promise<vscode.DebugSession> {
+    return await new Promise<vscode.DebugSession>(res =>
+        vscode.debug.onDidTerminateDebugSession(e => {
+            if (e.name === name) {
+                res(e);
+            }
+        })
+    );
+}
+
 /**
  * Waits for a specific command to be sent by the debug adapter.
  *
@@ -65,14 +80,28 @@ export async function waitForDebugAdapterMessage(
  * @param workspaceContext The workspace context containing toolchain information.
  * @returns A promise that resolves with the matching command message.
  */
-export async function waitForDebugAdapterCommand(
-    name: string,
-    command: string,
-    workspaceContext: WorkspaceContext
-): Promise<any> {
-    return await waitForDebugAdapterMessage(
-        name,
-        (m: any) => m.command === command,
-        workspaceContext
-    );
+export async function waitForDebugAdapterCommand(name: string, command: string): Promise<any> {
+    return await waitForDebugAdapterMessage(name, (m: any) => m.command === command);
+}
+
+/**
+ * Waits for a specific event to be sent by the debug adapter.
+ *
+ * @param name The name of the debug session to wait for.
+ * @param command The command to wait for.
+ * @param workspaceContext The workspace context containing toolchain information.
+ * @returns A promise that resolves with the matching command event.
+ */
+export async function waitForDebugAdapterEvent(name: string, event: string): Promise<any> {
+    return await waitForDebugAdapterMessage(name, (m: any) => m.event === event);
+}
+
+/**
+ * Waits for a debug adapter for the specified DebugSession name to terminate.
+ *
+ * @param name The name of the debug session to wait for.
+ * @returns exit code of the DAP
+ */
+export async function waitForDebugAdapterExit(name: string): Promise<number> {
+    return await waitForDebugAdapterEvent(name, "exited").then(m => m.body.exitCode);
 }