Fix logic for testing tasks that depend on the current location

Author: eliericha

integration/vscode/ada/src/taskProviders.ts

@@ -823,19 +823,37 @@ abstract class SequentialExecution extends vscode.CustomExecution {
 }
 
 /**
- * Task names contributed by the extension don't have the task type prefix
- * while tasks coming from the workspace typically do since VS Code includes
- * the type prefix when converting an automatic extension task into a
- * configurable workspace task. getConventionalTaskLabel() takes care of
- * that fact.
+ * Finds and returns the task of the given name.
+ *
+ * Task names contributed by the extension don't have the task type prefix in
+ * the name while tasks coming from the workspace typically do since VS Code
+ * includes the type prefix when converting an automatic extension task into a
+ * configurable workspace task. This function accounts for that fact by search
+ * for the task with and without the type prefix.
+ *
+ * If an array of tasks is given, the search will applied to this array and the
+ * API will not be queried for tasks. This can be used to achieve a performance
+ * boost.
  *
  * @returns the task that has the given name, or the given name with the
- * prefix `ada: `.
+ * prefix `ada: ` or `spark: `.
  * @throws an Error if the task is not found.
  */
-export function findTaskByName(tasks: vscode.Task[], taskName: string): vscode.Task {
+export async function findTaskByName(
+    taskName: string,
+    tasks?: vscode.Task[]
+): Promise<vscode.Task> {
+    if (!tasks) {
+        tasks = (
+            await Promise.all([
+                vscode.tasks.fetchTasks({ type: 'ada' }),
+                vscode.tasks.fetchTasks({ type: 'spark' }),
+            ])
+        ).flat();
+    }
+
     if (tasks.length == 0) {
-        throw Error('The given task list is empty.' + ` Cannot find task '${taskName}'`);
+        throw Error('The task list is empty.' + ` Cannot find task '${taskName}'`);
     }
 
     const task = tasks.find((v) => {
@@ -862,7 +880,7 @@ class SequentialExecutionByName extends SequentialExecution {
 
     protected async getTasksToRun(): Promise<vscode.Task[]> {
         const adaTasks = await vscode.tasks.fetchTasks({ type: TASK_TYPE_ADA });
-        return this.taskNames.map((name) => findTaskByName(adaTasks, name));
+        return Promise.all(this.taskNames.map((name) => findTaskByName(name, adaTasks)));
     }
 }
 

integration/vscode/ada/test/suite/general/tasks.test.ts

@@ -55,7 +55,7 @@ ada: Clean current project - gprclean -P ${projectPath}
 ada: Build current project - gprbuild -P ${projectPath} -cargs:ada -gnatef
 ada: Check current file - gprbuild -q -f -c -u -gnatc -P ${projectPath} \${fileBasename} -cargs:ada -gnatef
 ada: Analyze the project with GNAT SAS - gnatsas analyze -P ${projectPath}
-ada: Analyze the current file with GNAT SAS - gnatsas analyze -P ${projectPath} \${fileBasename}
+ada: Analyze the current file with GNAT SAS - gnatsas analyze -P ${projectPath} --file=\${fileBasename}
 ada: Create a report after a GNAT SAS analysis - gnatsas report sarif -P ${projectPath}
 ada: Generate documentation from the project - gnatdoc -P ${projectPath}
 ada: Create/update test skeletons for the project - gnattest -P ${projectPath}
@@ -212,21 +212,21 @@ suite('Task Execution', function () {
         allProvidedTasks.push(...(await createAdaTaskProvider().provideTasks()));
     });
 
-    declTaskTest('ada: Build current project', testedTaskLabels);
-    declTaskTest('ada: Run main - src/main1.adb', testedTaskLabels);
-    declTaskTest('ada: Run main - src/test.adb', testedTaskLabels);
-    declTaskTest('ada: Check current file', testedTaskLabels, openSrcFile);
-    declTaskTest('ada: Clean current project', testedTaskLabels);
-    declTaskTest('ada: Build main - src/main1.adb', testedTaskLabels);
-    declTaskTest('ada: Build main - src/test.adb', testedTaskLabels);
-    declTaskTest('ada: Build and run main - src/main1.adb', testedTaskLabels);
-    declTaskTest('ada: Build and run main - src/test.adb', testedTaskLabels);
-    declTaskTest('ada: Analyze the project with GNAT SAS', testedTaskLabels);
-    declTaskTest('ada: Create a report after a GNAT SAS analysis', testedTaskLabels);
-    declTaskTest('ada: Analyze the project with GNAT SAS and produce a report', testedTaskLabels);
-    declTaskTest('ada: Analyze the current file with GNAT SAS', testedTaskLabels, openSrcFile);
-    declTaskTest('ada: Generate documentation from the project', testedTaskLabels);
-    declTaskTest('ada: Create/update test skeletons for the project', testedTaskLabels);
+    declTaskTest('ada: Build current project');
+    declTaskTest('ada: Run main - src/main1.adb');
+    declTaskTest('ada: Run main - src/test.adb');
+    declTaskTest('ada: Check current file', openSrcFile);
+    declTaskTest('ada: Clean current project');
+    declTaskTest('ada: Build main - src/main1.adb');
+    declTaskTest('ada: Build main - src/test.adb');
+    declTaskTest('ada: Build and run main - src/main1.adb');
+    declTaskTest('ada: Build and run main - src/test.adb');
+    declTaskTest('ada: Analyze the project with GNAT SAS');
+    declTaskTest('ada: Create a report after a GNAT SAS analysis');
+    declTaskTest('ada: Analyze the project with GNAT SAS and produce a report');
+    declTaskTest('ada: Analyze the current file with GNAT SAS', openSrcFile);
+    declTaskTest('ada: Generate documentation from the project');
+    declTaskTest('ada: Create/update test skeletons for the project');
 
     /**
      * Check that the 'buildAndRunMain' task works fine with projects that
@@ -249,8 +249,8 @@ suite('Task Execution', function () {
             await new Promise((resolve) => setTimeout(resolve, 1000));
             await testTask(
                 'Build and run main - src/main1.adb',
-                allProvidedTasks,
-                testedTaskLabels
+                testedTaskLabels,
+                allProvidedTasks
             );
         } finally {
             // Reset the 'ada.projectFile' setting. If the previous value was
@@ -314,20 +314,23 @@ suite('Task Execution', function () {
      * has to be defined in the same module as the testsuite in order for the
      * testing GUI to detect the tests in VS Code.
      */
-    function declTaskTest(
-        taskName: string,
-        testedTasks: Set<string>,
-        prolog?: () => void | Promise<void>
-    ): Mocha.Test {
+    function declTaskTest(taskName: string, prolog?: () => void | Promise<void>): Mocha.Test {
         return test(taskName, async function () {
             if (prolog) {
                 await prolog();
             }
 
-            await testTask(taskName, allProvidedTasks, testedTasks);
+            /**
+             * If there was a prolog, don't use the static task list computed at
+             * the beginning. Tasks are sensitive to the current cursor location
+             * so we recompute available tasks instead of using the static task
+             * list.
+             */
+            await testTask(taskName, testedTaskLabels, prolog ? undefined : allProvidedTasks);
         });
     }
 });
+
 async function openSrcFile() {
     assert(vscode.workspace.workspaceFolders);
     const testAdbUri = vscode.Uri.joinPath(

integration/vscode/ada/test/suite/utils.ts

@@ -2,12 +2,12 @@ import assert from 'assert';
 import { spawnSync } from 'child_process';
 import { existsSync, readFileSync, writeFileSync } from 'fs';
 import * as vscode from 'vscode';
+import { setTerminalEnvironment } from '../../src/helpers';
 import {
     SimpleTaskProvider,
     findTaskByName,
     getConventionalTaskLabel,
 } from '../../src/taskProviders';
-import { setTerminalEnvironment } from '../../src/helpers';
 
 /**
  * This function compares some actual output to an expected referenced stored in
@@ -142,12 +142,12 @@ export function getCmdLine(exec: vscode.ShellExecution) {
 
 export async function testTask(
     taskName: string,
-    allProvidedTasks: vscode.Task[],
-    testedTasks: Set<string>
+    testedTasks: Set<string>,
+    allProvidedTasks?: vscode.Task[]
 ) {
     assert(vscode.workspace.workspaceFolders);
 
-    const task = findTaskByName(allProvidedTasks, taskName);
+    const task = await findTaskByName(taskName, allProvidedTasks);
     assert(task);
     testedTasks.add(getConventionalTaskLabel(task));