Fix vscode run main task when executable is at workspace root

For eng/ide/ada_language_server#1439

Author: eliericha

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';
@@ -406,11 +406,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: [],
                         },
                     };

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

@@ -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

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

@@ -175,17 +175,19 @@ export async function runTaskAndGetResult(task: vscode.Task): Promise<number | u
  * @param exec - a ShellExecution
  * @returns the command line of the ShellExecution as a string
  */
-export function getCmdLine(exec: vscode.ShellExecution) {
-    return [exec.command]
-        .concat(exec.args)
-        .map((s) => {
-            if (typeof s == 'object') {
-                return s.value;
-            } else {
-                return s;
-            }
-        })
-        .join(' ');
+export function getCmdLine(exec: vscode.ShellExecution): string {
+    return exec.command
+        ? [exec.command]
+              .concat(exec.args)
+              .map((s) => {
+                  if (typeof s == 'object') {
+                      return s.value;
+                  } else {
+                      return s;
+                  }
+              })
+              .join(' ')
+        : (exec.commandLine ?? '');
 }
 
 /**

integration/vscode/ada/test/workspaces/general/.gitignore

@@ -3,3 +3,7 @@
 
 # Generated when testing gnatsas tasks
 /report.sarif
+
+# Executables produced at the root of the workspace
+/main1exec
+/main1exec.exe

integration/vscode/ada/test/workspaces/general/default_without_obj_dir/.gitignore

@@ -0,0 +1 @@
+/obj/

integration/vscode/ada/test/workspaces/general/prj_exec_at_root/.gitignore

@@ -1,12 +1,18 @@
-project Default_Without_Obj_Dir is
+project Prj_Exec_At_Root is
 
     Tools_Mains :=
      ("main1.adb",
       "test.adb");
 
     for Source_Dirs use ("../src/**");
+    for Object_Dir use "obj";
     for Main use Tools_Mains;
 
+    --  Use this to produce the executable at the root of the workspace to test
+    --  that the run main task will prepend './' to make it executable by the
+    --  underlying shell.
+    for Exec_Dir use "..";
+
     package Builder is
       for Executable ("main1.adb") use "main1exec";
    end Builder;
@@ -15,4 +21,4 @@ project Default_Without_Obj_Dir is
       for Default_Switches ("Ada") use ("-g", "-O0");
    end Compiler;
 
-end Default_Without_Obj_Dir;
+end Prj_Exec_At_Root;