Merge branch 'topic/run-main-root' into 'master'

Fix vscode run main task when executable is at workspace root

See merge request eng/ide/ada_language_server!1703

Author: AnthonyLeonardoGracio

integration/vscode/ada/src/taskProviders.ts

@@ -16,7 +16,7 @@
 ----------------------------------------------------------------------------*/
 
 import assert from 'assert';
-import { basename } from 'path';
+import path, { basename } from 'path';
 import * as vscode from 'vscode';
 import { CMD_GPR_PROJECT_ARGS } from './commands';
 import { adaExtState, logger } from './extension';
@@ -366,7 +366,10 @@ const predefinedTasks: PredefinedTask[] = [
  * both 'ada' and 'spark' tasks.
  */
 export class SimpleTaskProvider implements vscode.TaskProvider {
-    constructor(public taskType: string, private taskDecls: PredefinedTask[]) {}
+    constructor(
+        public taskType: string,
+        private taskDecls: PredefinedTask[],
+    ) {}
 
     async provideTasks(token?: vscode.CancellationToken): Promise<vscode.Task[]> {
         if (token?.isCancellationRequested) {
@@ -406,11 +409,19 @@ export class SimpleTaskProvider implements vscode.TaskProvider {
                         taskGroup: vscode.TaskGroup.Build,
                     };
 
+                    let execPath = main.execRelPath();
+                    /**
+                     * If the exec is directly at the root of the workspace,
+                     * prepend ./ to make it possible for shells to execute it.
+                     */
+                    if (!execPath.includes(path.sep)) {
+                        execPath = './' + execPath;
+                    }
                     const runTask: PredefinedTask = {
                         label: getRunTaskPlainName(main),
                         taskDef: {
                             type: this.taskType,
-                            command: main.execRelPath(),
+                            command: execPath,
                             args: [],
                         },
                     };
@@ -425,7 +436,7 @@ export class SimpleTaskProvider implements vscode.TaskProvider {
                     };
 
                     return [buildTask, runTask, buildAndRunTask];
-                })
+                }),
             );
         }
 
@@ -453,7 +464,7 @@ export class SimpleTaskProvider implements vscode.TaskProvider {
                 tDecl.label,
                 tDecl.taskDef.type,
                 undefined,
-                tDecl.problemMatchers
+                tDecl.problemMatchers,
             );
 
             /**
@@ -483,7 +494,7 @@ export class SimpleTaskProvider implements vscode.TaskProvider {
 
     async resolveTask(
         task: vscode.Task,
-        token?: vscode.CancellationToken
+        token?: vscode.CancellationToken,
     ): Promise<vscode.Task | undefined> {
         /**
          * Note that this method is never called for tasks created by the
@@ -525,9 +536,8 @@ export class SimpleTaskProvider implements vscode.TaskProvider {
              */
             const args = taskDef.args ?? [];
             try {
-                const evaluatedArgs: (string | vscode.ShellQuotedString)[] = await evaluateArgs(
-                    args
-                );
+                const evaluatedArgs: (string | vscode.ShellQuotedString)[] =
+                    await evaluateArgs(args);
                 execution = new vscode.ShellExecution(taskDef.command, evaluatedArgs);
             } catch (err) {
                 let msg = 'Error while evaluating task arguments.';
@@ -547,7 +557,7 @@ export class SimpleTaskProvider implements vscode.TaskProvider {
             task.name,
             task.source,
             execution,
-            task.problemMatchers
+            task.problemMatchers,
         );
     }
 
@@ -622,12 +632,12 @@ async function useAlire() {
  */
 async function evaluateArgs(args: (string | vscode.ShellQuotedString)[]) {
     const commandRegex = new RegExp(
-        `^\\\${command:\\s*((${TASK_TYPE_ADA}|${TASK_TYPE_SPARK})\\.[^}]*)\\s*}$`
+        `^\\\${command:\\s*((${TASK_TYPE_ADA}|${TASK_TYPE_SPARK})\\.[^}]*)\\s*}$`,
     );
     const evaluatedArgs: (string | vscode.ShellQuotedString)[] = (
         await Promise.all(
             args.flatMap(async function (
-                a: string | vscode.ShellQuotedString
+                a: string | vscode.ShellQuotedString,
             ): Promise<(string | vscode.ShellQuotedString)[]> {
                 if (typeof a == 'string') {
                     /**
@@ -667,7 +677,7 @@ async function evaluateArgs(args: (string | vscode.ShellQuotedString)[]) {
                 }
 
                 return [a];
-            })
+            }),
         )
     ).flat();
     return evaluatedArgs;
@@ -742,14 +752,14 @@ export function getBuildAndRunTaskName(main?: AdaMain) {
 export function createSparkTaskProvider(): SimpleTaskProvider {
     return new SimpleTaskProvider(
         TASK_TYPE_SPARK,
-        predefinedTasks.filter((v) => v.taskDef.type == TASK_TYPE_SPARK)
+        predefinedTasks.filter((v) => v.taskDef.type == TASK_TYPE_SPARK),
     );
 }
 
 export function createAdaTaskProvider(): SimpleTaskProvider {
     return new SimpleTaskProvider(
         TASK_TYPE_ADA,
-        predefinedTasks.filter((v) => v.taskDef.type == TASK_TYPE_ADA)
+        predefinedTasks.filter((v) => v.taskDef.type == TASK_TYPE_ADA),
     );
 }
 
@@ -849,7 +859,7 @@ abstract class SequentialExecution extends vscode.CustomExecution {
                                 } finally {
                                     closeEmitter.fire(2);
                                 }
-                            }
+                            },
                         );
                 },
                 close() {
@@ -883,7 +893,7 @@ abstract class SequentialExecution extends vscode.CustomExecution {
  */
 export async function findTaskByName(
     taskName: string,
-    tasks?: vscode.Task[]
+    tasks?: vscode.Task[],
 ): Promise<vscode.Task> {
     if (!tasks) {
         tasks = (
@@ -921,7 +931,10 @@ export async function findTaskByName(
  * of the tasks to run are given at construction.
  */
 class SequentialExecutionByName extends SequentialExecution {
-    constructor(private taskName: string, private taskNames: string[]) {
+    constructor(
+        private taskName: string,
+        private taskNames: string[],
+    ) {
         super();
     }
 
@@ -941,7 +954,7 @@ class SequentialExecutionByName extends SequentialExecution {
  */
 function runTaskSequence(
     tasks: vscode.Task[],
-    writeEmitter: vscode.EventEmitter<string>
+    writeEmitter: vscode.EventEmitter<string>,
 ): Promise<number> {
     let p = new Promise<number>((resolve) => resolve(0));
     for (const t of tasks) {
@@ -996,15 +1009,15 @@ export async function getBuildAndRunTasks(): Promise<vscode.Task[]> {
             .filter((t) => getConventionalTaskLabel(t).startsWith(getBuildAndRunTaskName()))
 
             // Return workspace-defined tasks first
-            .sort(workspaceTasksFirst)
+            .sort(workspaceTasksFirst),
     );
 }
 
 export async function findBuildAndRunTask(adaMain: AdaMain): Promise<vscode.Task | undefined> {
     return (await getBuildAndRunTasks()).find(
         // Tasks defined in tasks.json will have a leading 'ada: ' while the
         // ones auto-generated by the extension don't. We want to match both.
-        (t) => getConventionalTaskLabel(t) == getBuildAndRunTaskName(adaMain)
+        (t) => getConventionalTaskLabel(t) == getBuildAndRunTaskName(adaMain),
     );
 }
 
@@ -1039,15 +1052,15 @@ export async function getBuildMainTasks() {
         tasks
             .filter((t) => getConventionalTaskLabel(t).startsWith(getBuildTaskName()))
             // Return workspace-defined tasks first
-            .sort(workspaceTasksFirst)
+            .sort(workspaceTasksFirst),
     );
 }
 
 export async function findBuildMainTask(adaMain: AdaMain): Promise<vscode.Task | undefined> {
     return (await getBuildMainTasks()).find(
         // Tasks defined in tasks.json will have a leading 'ada: ' while the
         // ones auto-generated by the extension don't. We want to match both.
-        (t) => getConventionalTaskLabel(t) == getBuildTaskName(adaMain)
+        (t) => getConventionalTaskLabel(t) == getBuildTaskName(adaMain),
     );
 }
 

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

@@ -121,7 +121,7 @@ ada: Run main - src/test.adb - obj/test${exe}
         const testAdbUri = vscode.Uri.joinPath(
             vscode.workspace.workspaceFolders[0].uri,
             'src',
-            'test.adb'
+            'test.adb',
         );
 
         /**
@@ -134,7 +134,7 @@ ada: Run main - src/test.adb - obj/test${exe}
             (await getEnclosingSymbol(vscode.window.activeTextEditor, [vscode.SymbolKind.Function]))
                 ?.range,
             // The expected range is that of the inner-most subprogram P3
-            new vscode.Range(13, 9, 18, 16)
+            new vscode.Range(13, 9, 18, 16),
         );
         assert.equal(getSelectedRegion(vscode.window.activeTextEditor), '18:18');
 
@@ -185,7 +185,7 @@ ada: Run main - src/test.adb - obj/test${exe}
             assert(resolved.execution);
             assert(
                 isFromWorkspace(resolved),
-                'Build task does not come from workspace. Source is: ' + resolved.source
+                'Build task does not come from workspace. Source is: ' + resolved.source,
             );
 
             const exec = buildTask.execution as vscode.ShellExecution;
@@ -215,7 +215,7 @@ ada: Run main - src/test.adb - obj/test${exe}
             obsoleteTaskDef,
             vscode.TaskScope.Workspace,
             'Obsolete Task',
-            'Workspace'
+            'Workspace',
         );
 
         const prov = createAdaTaskProvider();
@@ -259,7 +259,7 @@ ada: Run main - src/test.adb - obj/test${exe}
                 t,
                 vscode.TaskScope.Workspace,
                 'Invalid Task',
-                'Workspace'
+                'Workspace',
             );
 
             /**
@@ -303,27 +303,46 @@ suite('Task Execution', function () {
 
     /**
      * Check that the 'buildAndRunMain' task works fine with projects that
-     * do not explicitly define an object directory.
+     * produce the executable at the root of the workspace. In that case it is
+     * necessary to use a leading `./` for the shell to be able to spawn the
+     * executable.
      */
-    test('Build and run main task without object directory', async () => {
+    test('Build and run main task when exec at workspace root', async () => {
         // Load a custom project that does not define any object dir by
         // changing the 'ada.projectFile' setting.
         const initialProjectFile = vscode.workspace.getConfiguration().get('ada.projectFile');
         try {
             await vscode.workspace
                 .getConfiguration()
-                .update(
-                    'ada.projectFile',
-                    'default_without_obj_dir' + path.sep + 'default_without_obj_dir.gpr'
-                );
+                .update('ada.projectFile', 'prj_exec_at_root' + path.sep + 'prj_exec_at_root.gpr');
+
             /**
              * Wait a bit until the ALS loads the new project
              */
             await new Promise((resolve) => setTimeout(resolve, 1000));
+
+            /**
+             * Check that the task command starts with ./
+             */
+            const runTask = (await vscode.tasks.fetchTasks({ type: 'ada' })).find((t) =>
+                t.name.includes('Run main'),
+            );
+            assert(runTask?.execution instanceof vscode.ShellExecution);
+            const cmdLine = getCmdLine(runTask.execution);
+            assert(
+                cmdLine.startsWith('.' + path.sep),
+                `Task command doesn't start with './': ${cmdLine}`,
+            );
+
+            /**
+             * Check that the build and run task work.
+             */
+            await testTask('Build main - src/main1.adb', testedTaskLabels, allProvidedTasks);
+            await testTask('Run main - src/main1.adb', testedTaskLabels, allProvidedTasks);
             await testTask(
                 'Build and run main - src/main1.adb',
                 testedTaskLabels,
-                allProvidedTasks
+                allProvidedTasks,
             );
         } finally {
             // Reset the 'ada.projectFile' setting. If the previous value was
@@ -334,7 +353,7 @@ suite('Task Execution', function () {
                 .getConfiguration()
                 .update(
                     'ada.projectFile',
-                    initialProjectFile === '' ? undefined : initialProjectFile
+                    initialProjectFile === '' ? undefined : initialProjectFile,
                 );
         }
     });
@@ -409,7 +428,7 @@ async function openSrcFile() {
     const testAdbUri = vscode.Uri.joinPath(
         vscode.workspace.workspaceFolders[0].uri,
         'src',
-        'test.adb'
+        'test.adb',
     );
 
     await vscode.window.showTextDocument(testAdbUri);