Merge branch 'topic/workspace_pop' into 'master'

Add all the missing workspace directories at once

See merge request eng/ide/ada_language_server!1471

Author: AnthonyLeonardoGracio

.vscode/launch.json

@@ -107,6 +107,41 @@
          // Switch to Debug Console to see test results
          "internalConsoleOptions": "openOnSessionStart"
       },
+      {
+         "name": "(vscode) Run testsuite 'workspace_missing_dirs'",
+         "type": "extensionHost",
+         "request": "launch",
+         "runtimeExecutable": "${execPath}",
+         "outFiles": [
+            "${workspaceFolder}/integration/vscode/ada/out/**/*.js",
+            "!**/node_modules/**"
+         ],
+         "args": [
+            "--extensionDevelopmentPath=${workspaceFolder}/integration/vscode/ada",
+            "--extensionTestsPath=${workspaceFolder}/integration/vscode/ada/out/test/suite/workspace_missing_dirs/index",
+            "${workspaceFolder}/integration/vscode/ada/test/workspaces/workspace_missing_dirs"
+         ],
+         // Below we make the executables of node modules visible to the tests.
+         // In particular, vscode-tmgrammar-snap is used for syntax highlighting
+         // tests.
+         "env": {
+            "MOCHA_GREP": "${input:testPattern}",
+            // This is necessary to make the "child" vscode inherit the PATH
+            // variable set in the workspace settings. Without it in some setups
+            // (e.g. vscode remote) the child vscode does not get visibility
+            // over the Ada toolchain available in the parent vscode
+            // environment.
+            "PATH": "${env:PATH}",
+            // This is custom env var that we use in
+            // integration/vscode/ada/test/suite/index.ts to prevent timeouts in
+            // tests when debugging
+            "MOCHA_TIMEOUT": "0",
+            "MOCHA_ALS_UPDATE": "${input:updateTestRefs}"
+         },
+         "preLaunchTask": "npm: pretest - integration/vscode/ada",
+         // Switch to Debug Console to see test results
+         "internalConsoleOptions": "openOnSessionStart"
+      },
       {
          "name": "(npm) Launch all vscode tests with npm",
          "type": "node",

integration/vscode/ada/package.json

@@ -693,6 +693,11 @@
                 "title": "Ada: Show GPR Language Server output",
                 "when": "ADA_PROJECT_CONTEXT"
             },
+            {
+                "command": "ada.addMissingDirsToWorkspace",
+                "title": "Ada: Add missing source directories to workspace",
+                "when": "ADA_PROJECT_CONTEXT"
+            },
             {
                 "command": "ada.runMainAsk",
                 "title": "Ada: Build and run project main...",

integration/vscode/ada/src/commands.ts

@@ -9,6 +9,7 @@ import { getOrAskForProgram } from './debugConfigProvider';
 import { adaExtState, mainOutputChannel } from './extension';
 import { getProjectFileRelPath } from './helpers';
 import { CustomTaskDefinition, getEnclosingSymbol } from './taskProviders';
+import { LanguageClient } from 'vscode-languageclient/node';
 
 export function registerCommands(context: vscode.ExtensionContext, clients: ExtensionState) {
     context.subscriptions.push(vscode.commands.registerCommand('ada.otherFile', otherFileHandler));
@@ -45,6 +46,24 @@ export function registerCommands(context: vscode.ExtensionContext, clients: Exte
             return p;
         })
     );
+
+    context.subscriptions.push(
+        vscode.commands.registerCommand(
+            'ada.addMissingDirsToWorkspace',
+            async (
+                // eslint-disable-next-line @typescript-eslint/no-inferrable-types
+                displayPopupWhenMissing: boolean = false,
+                // eslint-disable-next-line @typescript-eslint/no-inferrable-types
+                displayPopupOnSuccess: boolean = true
+            ) => {
+                await checkSrcDirectories(
+                    clients.adaClient,
+                    displayPopupWhenMissing,
+                    displayPopupOnSuccess
+                );
+            }
+        )
+    );
 }
 /**
  * Add a subprogram box above the subprogram enclosing the cursor's position, if any.
@@ -335,3 +354,110 @@ const otherFileHandler = () => {
         ],
     });
 };
+
+/**
+ *
+ * Check if we need to add some source directories to the workspace (e.g: when imported
+ * projects' source directories are not placed under the root project's directory).
+ * Do nothing if the user did not setup any workspace file.
+ *
+ * @param alsClient - the running ALS client
+ * @param displayPopupWhenMissing - whether or not we should display a yes/no popup
+ * when missing directories
+ * @param displayPopupOnSuccess - whether or not we should display a popup to notify
+ * the user that there is no missing directory
+ */
+export async function checkSrcDirectories(
+    alsClient: LanguageClient,
+    displayPopupWhenMissing = true,
+    displayPopupOnSuccess = true
+) {
+    type ALSSourceDirDescription = {
+        name: string;
+        uri: string;
+    };
+
+    const foldersInSettings = vscode.workspace.getConfiguration().get('folders');
+
+    //  Don't propose any popup if we multi-root workspace folders are already set
+    //  explicitly in the workspace's settings.
+    if (foldersInSettings === undefined) {
+        const sourceDirs: ALSSourceDirDescription[] = (await alsClient.sendRequest(
+            ExecuteCommandRequest.type,
+            {
+                command: 'als-source-dirs',
+            }
+        )) as ALSSourceDirDescription[];
+
+        const isSubdirectory = (dir: string, parent: string) => {
+            //  Use lower-case on Windows since drives can be specified in VS Code
+            //  either with lower or upper case characters.
+            if (process.platform == 'win32') {
+                dir = dir.toLowerCase();
+                parent = parent.toLowerCase();
+            }
+
+            return dir.startsWith(parent + '/');
+        };
+
+        const workspaceFolders = vscode.workspace.workspaceFolders ?? [];
+        const workspaceDirsToAdd: { uri: vscode.Uri; name?: string | undefined }[] = [];
+
+        for (const source_dir of sourceDirs) {
+            const sourceDirURI = vscode.Uri.parse(source_dir.uri);
+            const sourceDirPath = sourceDirURI.path;
+
+            //  If the source directory is not under one of the workspace folders and
+            //  if it's not already present in the workspace's folders, push
+            //  this source directory to the workspace folders to add later.
+            if (
+                !workspaceFolders.some(
+                    (workspaceFolder) =>
+                        workspaceFolder.uri.path == sourceDirPath ||
+                        isSubdirectory(sourceDirPath, workspaceFolder.uri.path)
+                )
+            ) {
+                workspaceDirsToAdd.push({
+                    name: source_dir.name,
+                    uri: sourceDirURI,
+                });
+            }
+        }
+
+        //  If there are some source directories missing in the workspace, ask the user
+        //  to add them in his workspace.
+        if (workspaceDirsToAdd.length > 0) {
+            let doAdd = true;
+
+            if (displayPopupWhenMissing) {
+                await vscode.window
+                    .showInformationMessage(
+                        'Some project source directories are not \
+                        listed in your workspace: do you want to add them?',
+                        'Yes',
+                        'No'
+                    )
+                    .then((answer) => {
+                        if (answer !== 'Yes') {
+                            doAdd = false;
+                        }
+                    });
+            }
+
+            if (doAdd) {
+                vscode.workspace.updateWorkspaceFolders(
+                    vscode.workspace.workspaceFolders
+                        ? vscode.workspace.workspaceFolders.length
+                        : 0,
+                    null,
+                    ...workspaceDirsToAdd
+                );
+            }
+        } else if (displayPopupOnSuccess) {
+            void vscode.window.showInformationMessage(
+                "All the project's source directories are already \
+                available in the current workspace."
+            );
+        }
+    }
+}

integration/vscode/ada/src/extension.ts

@@ -16,11 +16,10 @@
 -- of the license.                                                          --
 ----------------------------------------------------------------------------*/
 
-import * as process from 'process';
 import * as vscode from 'vscode';
 
 import { MESSAGE } from 'triple-beam';
-import { ExecuteCommandRequest, LanguageClient, Middleware } from 'vscode-languageclient/node';
+import { Middleware } from 'vscode-languageclient/node';
 import winston, { format, transports } from 'winston';
 import Transport from 'winston-transport';
 import { ExtensionState } from './ExtensionState';
@@ -172,7 +171,7 @@ async function activateExtension(context: vscode.ExtensionContext) {
     /**
      * This can display a dialog to the User so don't wait on the result.
      */
-    void checkSrcDirectories(adaExtState.adaClient);
+    void vscode.commands.executeCommand('ada.addMissingDirsToWorkspace', true, false);
 }
 
 function setUpLogging(context: vscode.ExtensionContext) {
@@ -254,90 +253,3 @@ function setUpLogging(context: vscode.ExtensionContext) {
 export async function deactivate() {
     await vscode.commands.executeCommand('setContext', ADA_CONTEXT, undefined);
 }
-
-type ALSSourceDirDescription = {
-    name: string;
-    uri: string;
-};
-
-/**
- *
- * Check if we need to add some source directories to the workspace (e.g: when imported
- * projects' source directories are not placed under the root project's directory).
- * Do nothing is the user did not setup any workspace file.
- *
- */
-async function checkSrcDirectories(alsClient: LanguageClient) {
-    const foldersInSettings = vscode.workspace.getConfiguration().get('folders') ?? [];
-
-    //  Don't propose any popup if we multi-root workspace folders are already set
-    //  explicitly in the workspace's settings.
-    if (foldersInSettings !== undefined) {
-        const sourceDirs: ALSSourceDirDescription[] = (await alsClient.sendRequest(
-            ExecuteCommandRequest.type,
-            {
-                command: 'als-source-dirs',
-            }
-        )) as ALSSourceDirDescription[];
-
-        const isSubdirectory = (dir: string, parent: string) => {
-            //  Use lower-case on Windows since drives can be specified in VS Code
-            //  either with lower or upper case characters.
-            if (process.platform == 'win32') {
-                dir = dir.toLowerCase();
-                parent = parent.toLowerCase();
-            }
-
-            return dir.startsWith(parent + '/');
-        };
-
-        const workspaceFolders = vscode.workspace.workspaceFolders ?? [];
-        const workspaceDirsToAdd: { uri: vscode.Uri; name?: string | undefined }[] = [];
-
-        for (const source_dir of sourceDirs) {
-            const sourceDirURI = vscode.Uri.parse(source_dir.uri);
-            const sourceDirPath = sourceDirURI.path;
-
-            //  If the source directory is not under one of the workspace folders and
-            //  if it's not already present in the workspace's folders, push
-            //  this source directory to the workspace folders to add later.
-            if (
-                !workspaceFolders.some(
-                    (workspaceFolder) =>
-                        workspaceFolder.uri.path == sourceDirPath ||
-                        isSubdirectory(sourceDirPath, workspaceFolder.uri.path)
-                )
-            ) {
-                workspaceDirsToAdd.push({
-                    name: source_dir.name,
-                    uri: sourceDirURI,
-                });
-            }
-        }
-
-        //  If there are some source directories missing in the workspace, ask the user
-        //  to add them in his workspace.
-        if (workspaceDirsToAdd.length > 0) {
-            await vscode.window
-                .showInformationMessage(
-                    'Some project source directories are not \
-                    listed in your workspace: do you want to add them?',
-                    'Yes',
-                    'No'
-                )
-                .then((answer) => {
-                    if (answer === 'Yes') {
-                        for (const workspaceDir of workspaceDirsToAdd) {
-                            vscode.workspace.updateWorkspaceFolders(
-                                vscode.workspace.workspaceFolders
-                                    ? vscode.workspace.workspaceFolders.length
-                                    : 0,
-                                null,
-                                workspaceDir
-                            );
-                        }
-                    }
-                });
-        }
-    }
-}

integration/vscode/ada/test/runTest.ts

@@ -9,7 +9,7 @@ async function main() {
     // Passed to `--extensionDevelopmentPath`
     const extensionDevelopmentPath = path.resolve(__dirname, '../../');
 
-    const testsuites = ['general', 'gnattest'];
+    const testsuites = ['general', 'gnattest', 'workspace_missing_dirs'];
 
     let someTestsuiteFailed = false;
 
@@ -21,7 +21,7 @@ async function main() {
             `out/test/suite/${testsuite}`
         );
 
-        // The workspace that will be openned in VSCode
+        // The workspace that will be opened in VSCode
         // Passed as an argument
         const testWorkspace = path.resolve(
             extensionDevelopmentPath,

integration/vscode/ada/test/suite/workspace_missing_dirs/index.ts

@@ -0,0 +1,5 @@
+import { runMochaTestsuite } from '../utils';
+
+export function run(): Promise<void> {
+    return runMochaTestsuite('workspace_missing_dirs', __dirname);
+}

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

@@ -0,0 +1,30 @@
+import * as assert from 'assert';
+import { suite, test } from 'mocha';
+import { activate } from '../utils';
+
+import * as vscode from 'vscode';
+
+suite('Extensions Advanced Test Suite', function () {
+    // Make sure the extension is activated
+    this.beforeAll(async () => {
+        await activate();
+    });
+    test('Test Add Missing Source Dirs To Workspace', async () => {
+        if (vscode.workspace.workspaceFolders !== undefined) {
+            let folders = vscode.workspace.workspaceFolders;
+
+            // We should start with only one workspace folder (the root one)
+            assert.strictEqual(folders.length, 1);
+
+            // Execute the 'ada.addMissingDirsToWorkspace' command, that imports the missing
+            // source directories into the current workspace if needed
+            await vscode.commands.executeCommand('ada.addMissingDirsToWorkspace', false);
+
+            // Check that we have 3 workspace folders after executing the command
+            folders = vscode.workspace.workspaceFolders;
+            assert.strictEqual(folders.length, 3);
+        } else {
+            throw new Error('No workspace folder found for the specified URI');
+        }
+    });
+});

integration/vscode/ada/test/workspaces/workspace_missing_dirs/main.adb

@@ -0,0 +1,4 @@
+procedure Main is
+begin
+   null;
+end Main;

integration/vscode/ada/test/workspaces/workspace_missing_dirs/workspace.gpr

@@ -0,0 +1,5 @@
+--  This .gpr file is used to test the command that displays a popup
+--  to adds source directories not located under the workspace's root folder.
+project Workspace is
+   for Source_Dirs use (".", "../general/src/", "../gnattest/");
+end Workspace;