Add preLaunchTask option for TestRunner

Author: JaneySprings

README.md

@@ -94,4 +94,12 @@ Lightweight and efficient, DotRush is designed to be fast and responsive.
 
  You can change the debugger options in the VSCode settings.
 
-![image](https://github.com/JaneySprings/DotRush/raw/main/assets/image4.jpg)
+![image](https://github.com/JaneySprings/DotRush/raw/main/assets/image4.jpg)
+
+## Profiling .NET Core Applications
+ To profile your .NET Core applications, you can use the built-in **dotnet-trace** and **dotnet-gcdump** tools. You can attach the profiler to a running process by executing the `DotRush: Attach Trace Profiler` or `DotRush: Create Heap Dump` commands. Also you can use the following buttons in the debugger toolbar if you have the **.NET Core Debugger** running:
+
+![image](https://github.com/JaneySprings/DotRush/raw/main/assets/image7.jpg)
+
+- For the `trace` report, you can use the [Speedscope in VSCode](https://marketplace.visualstudio.com/items?itemName=sransara.speedscope-in-vscode) extension to view it. Alternatively, you can upload it directly to the [speedscope](https://www.speedscope.app) site.
+- For the `gcdump` report, you can use the [dotnet-heapview](https://github.com/1hub/dotnet-heapview) or _Visual Studio for Windows_.

assets/image7.jpg

@@ -503,11 +503,6 @@
             "default": true,
             "description": "%configuration.description.debugger.automaticSourcelinkDownload%"
           },
-          "dotrush.debugger.automaticLaunchSettingsLoad": {
-            "type": "boolean",
-            "default": true,
-            "description": "%configuration.description.debugger.automaticLaunchSettingsLoad%"
-          },
           "dotrush.debugger.symbolSearchPaths": {
             "type": "array",
             "description": "%configuration.description.debugger.symbolSearchPaths%",
@@ -576,6 +571,10 @@
               "experimental"
             ],
             "description": "%configuration.description.testExplorer.skipInitialPauseEvent%"
+          },
+          "dotrush.testExplorer.preLaunchTask": {
+            "type": "string",
+            "description": "%configuration.description.testExplorer.preLaunchTask%"
           }
         }
       }

package.json

@@ -32,7 +32,6 @@
 	"configuration.description.debugger.stepOverPropertiesAndOperators": "Step over properties and operators.",
 	"configuration.description.debugger.searchMicrosoftSymbolServer": "Search Microsoft Symbol Server for missing PDBs.",
 	"configuration.description.debugger.automaticSourcelinkDownload": "Automatically download source files from SourceLink.",
-	"configuration.description.debugger.automaticLaunchSettingsLoad": "Automatically load launchSettings.json file from the Properties folder of the startup project.",
 	"configuration.description.debugger.symbolSearchPaths": "Additional symbol search paths.",
 	"configuration.description.debugger.console": "Console to use for debugging console applications.",
 
@@ -42,5 +41,6 @@
 	"configuration.description.msbuild.additionalTestArguments": "Additional arguments to pass to the test command.",
 
 	"configuration.description.testExplorer.autoRefreshTests": "Automatically refresh tests on source code save.",
-	"configuration.description.testExplorer.skipInitialPauseEvent": "Skip the initial pause event when starting the tests debugging. This option will be ignored for netcoredbg."
+	"configuration.description.testExplorer.skipInitialPauseEvent": "Skip the initial pause event when starting the tests debugging. This option will be ignored for netcoredbg.",
+	"configuration.description.testExplorer.preLaunchTask": "Task to run before launching the test run."
 }

package.nls.json

@@ -1,3 +1,4 @@
+import { ProcessArgumentBuilder } from '../interop/processArgumentBuilder';
 import { DotNetTaskProvider } from '../providers/dotnetTaskProvider';
 import { TestExtensions } from '../models/test';
 import { Interop } from '../interop/interop';
@@ -57,24 +58,28 @@ export class TestExplorerController {
     }
     private static async runTests(request: vscode.TestRunRequest, token: vscode.CancellationToken): Promise<void> {
         TestExplorerController.convertTestRequest(request).forEach(async (filters, project) => {
+            const preLaunchTask = await Extensions.getTask(Extensions.getSetting<string>(res.configIdTestExplorerPreLaunchTask));
             const testReport = path.join(TestExplorerController.testsResultDirectory, `${project.label}.trx`);
             if (fs.existsSync(testReport))
                 vscode.workspace.fs.delete(vscode.Uri.file(testReport));
 
-            const testArguments: string[] = ['--logger', `'trx;LogFileName=${testReport}'`];
-            if (filters.length > 0) {
-                testArguments.push('--filter');
-                testArguments.push(`'${filters.join('|')}'`);
-            }
+            const testArguments = new ProcessArgumentBuilder('test')
+                .append('--logger').append(`'trx;LogFileName=${testReport}'`);
+                
+            testArguments.conditional('--no-build', () => preLaunchTask !== undefined);
+            testArguments.conditional('--filter', () => filters.length > 0);
+            testArguments.conditional(`'${filters.join('|')}'`, () => filters.length > 0);
 
             const testRun = TestExplorerController.controller.createTestRun(request);
+            await Extensions.waitForTask(preLaunchTask);
             await Extensions.waitForTask(DotNetTaskProvider.getTestTask(project.uri!.fsPath, testArguments));
             await TestExplorerController.publishTestResults(testRun, project, testReport);
         });
     }
     private static async debugTests(request: vscode.TestRunRequest, token: vscode.CancellationToken): Promise<void> {
         TestExplorerController.convertTestRequest(request).forEach(async (filters, project) => {
-            const executionSuccess = await Extensions.waitForTask(DotNetTaskProvider.getBuildTask(project.uri!.fsPath));
+            const preLaunchTask = await Extensions.getTask(Extensions.getSetting<string>(res.configIdTestExplorerPreLaunchTask));
+            const executionSuccess = await Extensions.waitForTask(preLaunchTask ?? DotNetTaskProvider.getBuildTask(project.uri!.fsPath));
             if (!executionSuccess || token.isCancellationRequested)
                 return;
 

src/VSCode/controllers/testExplorerController.ts

@@ -96,7 +96,10 @@ export class Extensions {
             await Promise.all(slice.map(action));
         }
     }
-    public static async waitForTask(task: vscode.Task): Promise<boolean> {
+    public static async waitForTask(task: vscode.Task | undefined): Promise<boolean> {
+        if (task === undefined)
+            return false;
+
         const execution = await vscode.tasks.executeTask(task);
         const executionExitCode = await new Promise<number>((resolve) => {
             const disposable = vscode.tasks.onDidEndTaskProcess(e => {
@@ -108,6 +111,13 @@ export class Extensions {
         });
         return executionExitCode === 0;
     }
+    public static async getTask(taskName: string | undefined): Promise<vscode.Task | undefined> {
+        if (taskName === undefined)
+            return undefined;
+
+        const tasks = await vscode.tasks.fetchTasks();
+        return tasks.find(task => task.name === taskName);
+    }
     public static getCurrentWorkingDirectory(): string | undefined {
         if (vscode.workspace.workspaceFile !== undefined)
             return path.dirname(vscode.workspace.workspaceFile.fsPath);

src/VSCode/extensions.ts

@@ -31,10 +31,9 @@ export class DotNetDebugConfigurationProvider implements vscode.DebugConfigurati
 	}
 
 	private static provideDebuggerConfiguration(config: vscode.DebugConfiguration) {
-        // https://github.com/JaneySprings/DotRush/issues/22
-        if (config.launchSettingsFilePath === undefined && Extensions.getSetting<boolean>(res.configIdDebuggerAutomaticLaunchSettingsLoad))
+        if (config.launchSettingsFilePath === undefined)
             config.launchSettingsFilePath = DebugAdapterController.getLaunchSettingsPath();
-        if (config.launchSettingsFilePath !== undefined && Extensions.onVSCode(false, true /* netcoredbg only */)) {
+        if (config.launchSettingsFilePath !== undefined && Extensions.onVSCode(false, true /* https://github.com/JaneySprings/DotRush/issues/22 */)) {
             const profile = DebugAdapterController.getLaunchProfile(config.launchSettingsFilePath, config.launchSettingsProfile);
             DotNetDebugConfigurationProvider.provideDebuggerConfigurationFromProfile(config, profile);
         }
@@ -61,7 +60,7 @@ export class DotNetDebugConfigurationProvider implements vscode.DebugConfigurati
 
         config.cwd = profile.workingDirectory;
         config.program = profile.executablePath;
-        config.args = profile.commandLineArgs;
+        config.args = [profile.commandLineArgs]; //TODO: We need to split the command line args
         config.env = profile.environmentVariables;
 
         if (profile.applicationUrl !== undefined)

src/VSCode/providers/dotnetDebugConfigurationProvider.ts

@@ -31,8 +31,8 @@ export class DotNetTaskProvider implements vscode.TaskProvider {
         ];
     }
 
-    public static getTestTask(projectFile: string, args: string[] | undefined = undefined): vscode.Task {
-        return DotNetTaskProvider.getTask({ type: res.taskDefinitionId, args: args }, projectFile, DotNetTarget.Test, StatusBarController.activeConfiguration);
+    public static getTestTask(projectFile: string, builder: ProcessArgumentBuilder | undefined = undefined): vscode.Task {
+        return DotNetTaskProvider.getTask({ type: res.taskDefinitionId, args: builder?.getArguments() }, projectFile, DotNetTarget.Test, StatusBarController.activeConfiguration);
     }
     public static getBuildTask(projectFile: string): vscode.Task {
         return DotNetTaskProvider.getTask({ type: res.taskDefinitionId }, projectFile, DotNetTarget.Build, StatusBarController.activeConfiguration);

src/VSCode/providers/dotnetTaskProvider.ts

@@ -58,10 +58,10 @@ export const configIdDebuggerConsole = "debugger.console";
 export const configIdDebuggerSymbolSearchPaths = "debugger.symbolSearchPaths";
 export const configIdDebuggerSearchMicrosoftSymbolServer = "debugger.searchMicrosoftSymbolServer";
 export const configIdDebuggerAutomaticSourcelinkDownload = "debugger.automaticSourcelinkDownload";
-export const configIdDebuggerAutomaticLaunchSettingsLoad = "debugger.automaticLaunchSettingsLoad";
 export const configIdMSBuildNoRestore = "msbuild.noRestore";
 export const configIdMSBuildNoDependencies = "msbuild.noDependencies";
 export const configIdMSBuildAdditionalBuildArguments = "msbuild.additionalBuildArguments";
 export const configIdMSBuildAdditionalTestArguments = "msbuild.additionalTestArguments";
 export const configIdTestExplorerAutoRefreshTests = "testExplorer.autoRefreshTests";
-export const configIdTestExplorerSkipInitialPauseEvent = "testExplorer.skipInitialPauseEvent";
+export const configIdTestExplorerSkipInitialPauseEvent = "testExplorer.skipInitialPauseEvent";
+export const configIdTestExplorerPreLaunchTask = "testExplorer.preLaunchTask";