Add support for cpputestTestAdapter.preLaunchTask setting

The configured task will be run at the beginning of load(), run(), and
debug(). This can be used to rebuild the test executable.

Addresses issue bneumann#42

Author: malsyned

README.md

@@ -19,6 +19,8 @@ To let this plugin know where your tests are set the ```cpputestTestAdapter.test
 ```
 They will be executed in the ```cpputestTestAdapter.testExecutablePath``` path.
 
+To arrange for a task to be run prior to running tests or refreshing the test list, set ```cpputestTestAdapter.preLaunchTask``` to the name of a task from tasks.json. This can be used to rebuild the test executable, for example.
+
 If you want to use the debugging functions you will also need to setup a launch.json file with your debugger path and arguments etc. The adapter will take care of the rest. Hopefully.
 
 

package.json

@@ -83,6 +83,12 @@
           "type": "string",
           "scope": "resource"
         },
+        "cpputestTestAdapter.preLaunchTask": {
+          "description": "Task to run before running the test executable",
+          "default": "",
+          "type": "string",
+          "scope": "resource"
+        },
         "cpputestTestAdapter.testLocationFetchMode": {
           "description": "",
           "default": "auto",

src/Infrastructure/SettingsProvider.ts

@@ -11,6 +11,7 @@ export interface SettingsProvider {
   GetObjDumpPath(): string;
   GetTestRunners(): string[];
   GetTestPath(): string;
+  GetPreLaunchTask(): string;
   get TestLocationFetchMode(): TestLocationFetchMode;
   GetDebugConfiguration(): (DebugConfiguration | string);
   GetWorkspaceFolders(): readonly WorkspaceFolder[] | undefined

src/Infrastructure/VscodeSettingsProvider.ts

@@ -33,6 +33,10 @@ export default class VscodeSettingsProvider implements SettingsProvider {
     return this.ResolveSettingsVariable(this.config.testExecutablePath);
   }
 
+  public GetPreLaunchTask(): string {
+    return this.config.preLaunchTask;
+  }
+
   public get TestLocationFetchMode(): TestLocationFetchMode {
     switch(this.config.testLocationFetchMode) {
       case 'test query':

src/adapter.ts

@@ -100,12 +100,47 @@ export class CppUTestAdapter implements TestAdapter {
 	}
 
 	private async updateTests(): Promise<void> {
+		const preLaunchTask = await this.getPreLaunchTask();
+		if (preLaunchTask) {
+			const errorCode = await this.runTask(preLaunchTask);
+			if (errorCode) {
+				this.mainSuite.children = [];
+				this.testsEmitter.fire(<TestLoadFinishedEvent>{
+					type: 'finished',
+					errorMessage: `preLaunchTask "${preLaunchTask.name}" Failed [exit code: ${errorCode}]`,
+				});
+				return;
+			}
+		}
 		this.root.ClearTests();
 		const runners = this.settingsProvider.GetTestRunners().map(runner => new ExecutableRunner(this.processExecuter, runner, this.log, this.GetExecutionOptions()));
 		const loadedTests = await this.root.LoadTests(runners);
 		this.mainSuite.children = loadedTests;
 		this.testsEmitter.fire(<TestLoadFinishedEvent>{ type: 'finished', suite: this.mainSuite });
 	}
+
+	private async getPreLaunchTask(): Promise<vscode.Task | undefined> {
+		const preLaunchTaskName = this.settingsProvider.GetPreLaunchTask();
+		if (!preLaunchTaskName)
+			return undefined;
+		const tasks = await vscode.tasks.fetchTasks();
+		return tasks.find((value, ..._) => value.name == preLaunchTaskName);
+	}
+
+	private async runTask(task: vscode.Task): Promise<number> {
+		const taskProcessEnded: Promise<number> = new Promise((resolve, _) => {
+			const hook_disposable = vscode.tasks.onDidEndTaskProcess((e) => {
+				if (e.execution.task !== task)
+					return;
+				hook_disposable.dispose();
+				resolve(e.exitCode);
+			}, this, this.disposables)
+		});
+
+		await vscode.tasks.executeTask(task);
+		return await taskProcessEnded;
+	}
+
 	private GetExecutionOptions(): ExecutableRunnerOptions | undefined {
 		return {
 			objDumpExecutable: this.settingsProvider.GetObjDumpPath(),