Refactor to use inline action buttons

plemarquand · plemarquand · commit 9ddd56b7c20e · 2025-02-21T09:56:52.000-05:00
diff --git a/assets/test/.vscode/settings.json b/assets/test/.vscode/settings.json
@@ -8,5 +8,9 @@
         "-DTEST_ARGUMENT_SET_VIA_TEST_BUILD_ARGUMENTS_SETTING"
     ],
     "lldb.verboseLogging": true,
-    "swift.backgroundCompilation": false
+    "swift.backgroundCompilation": false,
+    "swift.debugger.useDebugAdapterFromToolchain": false,
+    "lldb.library": "/usr/lib/liblldb.so",
+    "lldb.launch.expressions": "native",
+    "swift.pluginPermissions": {}
 }
diff --git a/assets/test/targets/Package.swift b/assets/test/targets/Package.swift
@@ -40,5 +40,9 @@ let package = Package(
             name: "TargetsTests",
             dependencies: ["LibraryTarget"]
         ),
+        .testTarget(
+            name: "AnotherTests",
+            dependencies: ["LibraryTarget"]
+        ),
     ]
 )
diff --git a/assets/test/targets/Sources/LibraryTarget/Targets.swift b/assets/test/targets/Sources/LibraryTarget/Targets.swift
@@ -1,6 +1,9 @@
 // The Swift Programming Language
 // https://docs.swift.org/swift-book
 
-func foo() {
+public func foo() {
     print("foo")
+}
+public func bar() {
+    print("bar")
 }
diff --git a/assets/test/targets/Tests/AnotherTests/AnotherTests.swift b/assets/test/targets/Tests/AnotherTests/AnotherTests.swift
@@ -0,0 +1,8 @@
+import LibraryTarget
+import XCTest
+
+class AnotherTests: XCTestCase {
+    func testExample() {
+        bar()
+    }
+}
diff --git a/assets/test/targets/Tests/TargetsTests/TargetsTests.swift b/assets/test/targets/Tests/TargetsTests/TargetsTests.swift
@@ -1,6 +1,8 @@
+import LibraryTarget
 import XCTest
 
 class TargetsTests: XCTestCase {
     func testExample() {
+        foo()
     }
 }
diff --git a/package.json b/package.json
@@ -222,12 +222,14 @@
       {
         "command": "swift.runSnippet",
         "title": "Run Swift Snippet",
-        "category": "Swift"
+        "category": "Swift",
+        "icon": "$(play)"
       },
       {
         "command": "swift.debugSnippet",
         "title": "Debug Swift Snippet",
-        "category": "Swift"
+        "category": "Swift",
+        "icon": "$(debug)"
       },
       {
         "command": "swift.runPluginTask",
@@ -266,13 +268,27 @@
       },
       {
         "command": "swift.runAllTestsParallel",
-        "title": "Run All Tests in Parallel",
-        "category": "Test"
+        "title": "Run Tests in Parallel",
+        "category": "Test",
+        "icon": "$(testing-run-all-icon)"
       },
       {
         "command": "swift.runAllTests",
-        "title": "Run All Tests",
-        "category": "Test"
+        "title": "Run Tests",
+        "category": "Test",
+        "icon": "$(testing-run-icon)"
+      },
+      {
+        "command": "swift.debugAllTests",
+        "title": "Debug Tests",
+        "category": "Test",
+        "icon": "$(testing-debug-icon)"
+      },
+      {
+        "command": "swift.coverAllTests",
+        "title": "Run Tests with Coverage",
+        "category": "Test",
+        "icon": "$(debug-coverage)"
       }
     ],
     "configuration": [
@@ -915,6 +931,18 @@
         {
           "command": "swift.runAllTestsParallel",
           "when": "swift.isActivated"
+        },
+        {
+          "command": "swift.runAllTests",
+          "when": "false"
+        },
+        {
+          "command": "swift.debugAllTests",
+          "when": "false"
+        },
+        {
+          "command": "swift.coverAllTests",
+          "when": "false"
         }
       ],
       "editor/context": [
@@ -1020,6 +1048,46 @@
         {
           "command": "swift.openExternal",
           "when": "view == projectPanel && (viewItem == 'editing' || viewItem == 'remote')"
+        },
+        {
+          "command": "swift.run",
+          "when": "view == projectPanel && viewItem == 'runnable'",
+          "group": "inline@0"
+        },
+        {
+          "command": "swift.debug",
+          "when": "view == projectPanel && viewItem == 'runnable'",
+          "group": "inline@1"
+        },
+        {
+          "command": "swift.runSnippet",
+          "when": "view == projectPanel && viewItem == 'snippet_runnable'",
+          "group": "inline@0"
+        },
+        {
+          "command": "swift.debugSnippet",
+          "when": "view == projectPanel && viewItem == 'snippet_runnable'",
+          "group": "inline@1"
+        },
+        {
+          "command": "swift.runAllTests",
+          "when": "view == projectPanel && viewItem == 'test_runnable'",
+          "group": "inline@0"
+        },
+        {
+          "command": "swift.debugAllTests",
+          "when": "view == projectPanel && viewItem == 'test_runnable'",
+          "group": "inline@1"
+        },
+        {
+          "command": "swift.runAllTestsParallel",
+          "when": "view == projectPanel && viewItem == 'test_runnable'",
+          "group": "inline@2"
+        },
+        {
+          "command": "swift.coverAllTests",
+          "when": "view == projectPanel && viewItem == 'test_runnable'",
+          "group": "inline@3"
         }
       ]
     },
diff --git a/src/TestExplorer/TestRunner.ts b/src/TestExplorer/TestRunner.ts
@@ -520,14 +520,27 @@ export class TestRunner {
         ];
     }
 
+    /**
+     * Extracts a list of unique test Targets from the list of test items.
+     */
+    private testTargets(items: vscode.TestItem[]): string[] {
+        const targets = new Set<string>();
+        for (const item of items) {
+            const target = item.id.split(".")[0];
+            targets.add(target);
+        }
+        return Array.from(targets);
+    }
+
     /**
      * Test run handler. Run a series of tests and extracts the results from the output
      * @param shouldDebug Should we run the debugger
      * @param token Cancellation token
      * @returns When complete
      */
     async runHandler() {
-        this.workspaceContext.testsStarted(this.folderContext, this.testKind);
+        const testTargets = this.testTargets(this.testArgs.testItems);
+        this.workspaceContext.testsStarted(this.folderContext, this.testKind, testTargets);
 
         const runState = new TestRunnerTestRunState(this.testRun);
 
@@ -554,7 +567,7 @@ export class TestRunner {
         cancellationDisposable.dispose();
         await this.testRun.end();
 
-        this.workspaceContext.testsFinished(this.folderContext, this.testKind);
+        this.workspaceContext.testsFinished(this.folderContext, this.testKind, testTargets);
     }
 
     /** Run test session without attaching to a debugger */
diff --git a/src/WorkspaceContext.ts b/src/WorkspaceContext.ts
@@ -348,12 +348,12 @@ export class WorkspaceContext implements vscode.Disposable {
         await this.fireEvent(folderContext, FolderOperation.focus);
     }
 
-    public testsFinished(folder: FolderContext, kind: TestKind) {
-        this.testFinishEmitter.fire({ kind, folder });
+    public testsFinished(folder: FolderContext, kind: TestKind, targets: string[]) {
+        this.testFinishEmitter.fire({ kind, folder, targets });
     }
 
-    public testsStarted(folder: FolderContext, kind: TestKind) {
-        this.testStartEmitter.fire({ kind, folder });
+    public testsStarted(folder: FolderContext, kind: TestKind, targets: string[]) {
+        this.testStartEmitter.fire({ kind, folder, targets });
     }
 
     public buildStarted(
@@ -634,6 +634,7 @@ export class WorkspaceContext implements vscode.Disposable {
 interface TestEvent {
     kind: TestKind;
     folder: FolderContext;
+    targets: string[];
 }
 
 /** Build events for build + run start/stop */
diff --git a/src/commands.ts b/src/commands.ts
@@ -38,7 +38,7 @@ import { updateDependencies } from "./commands/dependencies/update";
 import { runPluginTask } from "./commands/runPluginTask";
 import { runTestMultipleTimes } from "./commands/testMultipleTimes";
 import { newSwiftFile } from "./commands/newFile";
-import { runAllTests, runAllTestsParallel } from "./commands/runAllTests";
+import { runAllTests } from "./commands/runAllTests";
 import { updateDependenciesViewList } from "./commands/dependencies/updateDepViewList";
 import { runTask } from "./commands/runTask";
 import { TestKind } from "./TestExplorer/TestKind";
@@ -84,6 +84,10 @@ export enum Commands {
     RUN_SNIPPET = "swift.runSnippet",
     DEBUG_SNIPPET = "swift.debugSnippet",
     PREVIEW_DOCUMENTATION = "swift.previewDocumentation",
+    RUN_ALL_TESTS = "swift.runAllTests",
+    RUN_ALL_TESTS_PARALLEL = "swift.runAllTestsParallel",
+    DEBUG_ALL_TESTS = "swift.debugAllTests",
+    COVER_ALL_TESTS = "swift.coverAllTests",
 }
 
 /**
@@ -98,8 +102,12 @@ export function register(ctx: WorkspaceContext): vscode.Disposable[] {
         vscode.commands.registerCommand(Commands.UPDATE_DEPENDENCIES, () =>
             updateDependencies(ctx)
         ),
-        vscode.commands.registerCommand(Commands.RUN, target => runBuild(ctx, target)),
-        vscode.commands.registerCommand(Commands.DEBUG, target => debugBuild(ctx, target)),
+        vscode.commands.registerCommand(Commands.RUN, target =>
+            runBuild(ctx, ...unwrapTreeItem(target))
+        ),
+        vscode.commands.registerCommand(Commands.DEBUG, target =>
+            debugBuild(ctx, ...unwrapTreeItem(target))
+        ),
         vscode.commands.registerCommand(Commands.CLEAN_BUILD, () => cleanBuild(ctx)),
         vscode.commands.registerCommand(Commands.RUN_TESTS_MULTIPLE_TIMES, item => {
             if (ctx.currentFolder) {
@@ -120,9 +128,11 @@ export function register(ctx: WorkspaceContext): vscode.Disposable[] {
                 return openPackage(ctx.toolchain.swiftVersion, ctx.currentFolder.folder);
             }
         }),
-        vscode.commands.registerCommand(Commands.RUN_SNIPPET, target => runSnippet(ctx, target)),
+        vscode.commands.registerCommand(Commands.RUN_SNIPPET, target =>
+            runSnippet(ctx, ...unwrapTreeItem(target))
+        ),
         vscode.commands.registerCommand(Commands.DEBUG_SNIPPET, target =>
-            debugSnippet(ctx, target)
+            debugSnippet(ctx, ...unwrapTreeItem(target))
         ),
         vscode.commands.registerCommand(Commands.RUN_PLUGIN_TASK, () => runPluginTask()),
         vscode.commands.registerCommand(Commands.RUN_TASK, name => runTask(ctx, name)),
@@ -164,12 +174,20 @@ export function register(ctx: WorkspaceContext): vscode.Disposable[] {
         ),
         vscode.commands.registerCommand("swift.captureDiagnostics", () => captureDiagnostics(ctx)),
         vscode.commands.registerCommand(
-            "swift.runAllTestsParallel",
-            async () => await runAllTestsParallel(ctx)
+            Commands.RUN_ALL_TESTS_PARALLEL,
+            async item => await runAllTests(ctx, TestKind.parallel, ...unwrapTreeItem(item))
         ),
         vscode.commands.registerCommand(
-            "swift.runAllTests",
-            async (testKind: TestKind) => await runAllTests(ctx, testKind)
+            Commands.RUN_ALL_TESTS,
+            async item => await runAllTests(ctx, TestKind.standard, ...unwrapTreeItem(item))
+        ),
+        vscode.commands.registerCommand(
+            Commands.DEBUG_ALL_TESTS,
+            async item => await runAllTests(ctx, TestKind.debug, ...unwrapTreeItem(item))
+        ),
+        vscode.commands.registerCommand(
+            Commands.COVER_ALL_TESTS,
+            async item => await runAllTests(ctx, TestKind.coverage, ...unwrapTreeItem(item))
         ),
         vscode.commands.registerCommand(
             Commands.PREVIEW_DOCUMENTATION,
@@ -183,3 +201,16 @@ export function register(ctx: WorkspaceContext): vscode.Disposable[] {
         ),
     ];
 }
+
+/**
+ * Certain commands can be called via a vscode TreeView, which will pass a {@link CommandNode} object.
+ * If the command is called via a command palette or other means, the target will be a string.
+ */
+function unwrapTreeItem(target?: string | { args: string[] }): string[] {
+    if (typeof target === "object" && target !== null && "args" in target) {
+        return target.args ?? [];
+    } else if (typeof target === "string") {
+        return [target];
+    }
+    return [];
+}
diff --git a/src/commands/runAllTests.ts b/src/commands/runAllTests.ts
@@ -17,7 +17,7 @@ import { TestKind } from "../TestExplorer/TestKind";
 import { WorkspaceContext } from "../WorkspaceContext";
 import { flattenTestItemCollection } from "../TestExplorer/TestUtils";
 
-export async function runAllTests(ctx: WorkspaceContext, testKind: TestKind) {
+export async function runAllTests(ctx: WorkspaceContext, testKind: TestKind, target?: string) {
     const testExplorer = ctx.currentFolder?.testExplorer;
     if (testExplorer === undefined) {
         return;
@@ -28,7 +28,13 @@ export async function runAllTests(ctx: WorkspaceContext, testKind: TestKind) {
         return;
     }
 
-    const tests = flattenTestItemCollection(testExplorer.controller.items);
+    let tests = flattenTestItemCollection(testExplorer.controller.items);
+
+    // If a target is specified, filter the tests to only run those that match the target.
+    if (target) {
+        const targetRegex = new RegExp(`^${target}(\\.|$)`);
+        tests = tests.filter(test => targetRegex.test(test.id));
+    }
     const tokenSource = new vscode.CancellationTokenSource();
     await profile.runHandler(
         new vscode.TestRunRequest(tests, undefined, profile),
@@ -37,7 +43,3 @@ export async function runAllTests(ctx: WorkspaceContext, testKind: TestKind) {
 
     await vscode.commands.executeCommand("testing.showMostRecentOutput");
 }
-
-export async function runAllTestsParallel(ctx: WorkspaceContext) {
-    await runAllTests(ctx, TestKind.parallel);
-}
diff --git a/src/debugger/launch.ts b/src/debugger/launch.ts
@@ -181,6 +181,7 @@ export function createSnippetConfiguration(
         args: [],
         cwd: folder,
         env: swiftRuntimeEnv(true),
+        runType: "snippet",
         ...CI_DISABLE_ASLR,
     };
 }
diff --git a/src/ui/ProjectPanelProvider.ts b/src/ui/ProjectPanelProvider.ts
diff --git a/src/ui/StatusItem.ts b/src/ui/StatusItem.ts
diff --git a/test/integration-tests/ui/ProjectPanelProvider.test.ts b/test/integration-tests/ui/ProjectPanelProvider.test.ts
diff --git a/test/integration-tests/utilities/testutilities.ts b/test/integration-tests/utilities/testutilities.ts

Original file line number	Diff line number	Diff line change
`@@ -40,5 +40,9 @@ let package = Package(`
`40`	`40`	`name: "TargetsTests",`
`41`	`41`	`dependencies: ["LibraryTarget"]`
`42`	`42`	`),`
	`43`	`+ .testTarget(`
	`44`	`+ name: "AnotherTests",`
	`45`	`+ dependencies: ["LibraryTarget"]`
	`46`	`+ ),`
`43`	`47`	`]`
`44`	`48`	`)`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
	`1`	`+import LibraryTarget`
`1`	`2`	`import XCTest`
`2`	`3`
`3`	`4`	`class TargetsTests: XCTestCase {`
`4`	`5`	`func testExample() {`
	`6`	`+ foo()`
`5`	`7`	`}`
`6`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -348,12 +348,12 @@ export class WorkspaceContext implements vscode.Disposable {`
`348`	`348`	`await this.fireEvent(folderContext, FolderOperation.focus);`
`349`	`349`	`}`
`350`	`350`
`351`		`- public testsFinished(folder: FolderContext, kind: TestKind) {`
`352`		`- this.testFinishEmitter.fire({ kind, folder });`
	`351`	`+ public testsFinished(folder: FolderContext, kind: TestKind, targets: string[]) {`
	`352`	`+ this.testFinishEmitter.fire({ kind, folder, targets });`
`353`	`353`	`}`
`354`	`354`
`355`		`- public testsStarted(folder: FolderContext, kind: TestKind) {`
`356`		`- this.testStartEmitter.fire({ kind, folder });`
	`355`	`+ public testsStarted(folder: FolderContext, kind: TestKind, targets: string[]) {`
	`356`	`+ this.testStartEmitter.fire({ kind, folder, targets });`
`357`	`357`	`}`
`358`	`358`
`359`	`359`	`public buildStarted(`
`@@ -634,6 +634,7 @@ export class WorkspaceContext implements vscode.Disposable {`
`634`	`634`	`interface TestEvent {`
`635`	`635`	`kind: TestKind;`
`636`	`636`	`folder: FolderContext;`
	`637`	`+ targets: string[];`
`637`	`638`	`}`
`638`	`639`
`639`	`640`	`/** Build events for build + run start/stop */`