Merge branch 'topic/testsUpdate' into 'master'

Reorganize VSCode Tests

Closes #1169

See merge request eng/ide/ada_language_server!1278

Author: joaopsazevedo

.vscode/launch.json

@@ -11,6 +11,14 @@
          "cwd": "${workspaceRoot}",
          "valuesFormatting": "parseText"
       },
+      {
+         "type": "gdb",
+         "request": "launch",
+         "name": "Launch Program",
+         "target": ".obj/server/ada_language_server",
+         "cwd": "${workspaceRoot}",
+         "valuesFormatting": "parseText"
+      },
       {
          "name": "Launch Extension",
          "type": "extensionHost",
@@ -47,40 +55,15 @@
          }
       },
       {
-         "name": "Extension Tests",
-         "type": "extensionHost",
+         "name": "Launch Extension Testsuite",
+         "type": "node",
          "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/index",
-            "${workspaceFolder}/integration/vscode/ada/test/TestWorkspace"
-         ],
-         // Below we make the executables of node modules visible to the tests.
-         // In particular, vscode-tmgrammar-snap is used for syntax highlighting
-         // tests.
-         "env": {
-            // 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"
-         },
-         "preLaunchTask": "npm: pretest",
-         // Switch to Debug Console to see test results
-         "internalConsoleOptions": "openOnSessionStart"
+         "cwd": "${workspaceFolder}/integration/vscode/ada/",
+         "runtimeExecutable": "npm",
+         "runtimeArgs": ["run-script", "test"]
       },
       {
-         "name": "Extension Tests (Update Test Refs)",
+         "name": "General Testsuite",
          "type": "extensionHost",
          "request": "launch",
          "runtimeExecutable": "${execPath}",
@@ -90,13 +73,14 @@
          ],
          "args": [
             "--extensionDevelopmentPath=${workspaceFolder}/integration/vscode/ada",
-            "--extensionTestsPath=${workspaceFolder}/integration/vscode/ada/out/test/suite/index",
-            "${workspaceFolder}/integration/vscode/ada/test/TestWorkspace"
+            "--extensionTestsPath=${workspaceFolder}/integration/vscode/ada/out/test/suite/general/index",
+            "${workspaceFolder}/integration/vscode/ada/test/workspaces/general"
          ],
          // 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
@@ -107,26 +91,13 @@
             // integration/vscode/ada/test/suite/index.ts to prevent timeouts in
             // tests when debugging
             "MOCHA_TIMEOUT": "0",
-            // Setting this environment variable causes the tests to overwrite
-            // previous test references when they are stored in files. See
-            // assertEqualToFileContent in
-            // integration/vscode/ada/test/suite/highlighting.test.ts
-            "MOCHA_ALS_UPDATE": "1"
+            "MOCHA_ALS_UPDATE": "${input:updateTestRefs}"
          },
          "preLaunchTask": "npm: pretest",
-         // Switch to Debug Console to see test results
          "internalConsoleOptions": "openOnSessionStart"
       },
       {
-         "type": "gdb",
-         "request": "launch",
-         "name": "Launch Program",
-         "target": ".obj/server/ada_language_server",
-         "cwd": "${workspaceRoot}",
-         "valuesFormatting": "parseText"
-      },
-      {
-         "name": "Extension Tests (Test Name Regexp)",
+         "name": "GNATtest Integration Testsuite",
          "type": "extensionHost",
          "request": "launch",
          "runtimeExecutable": "${execPath}",
@@ -136,8 +107,8 @@
          ],
          "args": [
             "--extensionDevelopmentPath=${workspaceFolder}/integration/vscode/ada",
-            "--extensionTestsPath=${workspaceFolder}/integration/vscode/ada/out/test/suite/index",
-            "${workspaceFolder}/integration/vscode/ada/test/TestWorkspace"
+            "--extensionTestsPath=${workspaceFolder}/integration/vscode/ada/out/test/suite/gnattest/index",
+            "${workspaceFolder}/integration/vscode/ada/test/workspaces/gnattest"
          ],
          // Below we make the executables of node modules visible to the tests.
          // In particular, vscode-tmgrammar-snap is used for syntax highlighting
@@ -164,14 +135,13 @@
    "inputs": [
       {
          "id": "testPattern",
-         "description": "A regexp of tests to run",
+         "description": "A regexp of tests to run. Keep empty for not filtering any",
          "type": "promptString"
       },
       {
          "id": "updateTestRefs",
          "description": "Update test references? Keep empty for no update",
-         "type": "promptString",
-         "default": ""
+         "type": "promptString"
       },
       {
          "id": "pid",

integration/vscode/ada/media/gnattest_integration.md

@@ -0,0 +1,26 @@
+# GNATtest for VSCODE
+
+## How to use it:
+- First go to the Test View in you editor.
+- Then you can generate tests using GNATtest by clicking on   `Configure Tests`
+- A pop-up must appear, so then you can select `GNATtest`.
+- You can then click on the refreash button to discover the tests in your project.
+- If your folder already have GNATtest generated tests then you should have the tests already visible to you in the View.
+
+** **
+
+## Support
+#### Running Tests
+
+You can either run tests, by unit or by test case or run them all at once.
+
+#### Revealing the test results
+
+The messages shown in the UI about the fail of a test are limited, if you want the full summary you can check the file in: `<object_dir>/gnattest/result.txt`
+
+** **
+
+### Limitations
+
+- Inheritence tests are ignored.
+-

integration/vscode/ada/src/gnattest.ts

@@ -6,10 +6,13 @@ import { ContextClients } from './clients';
 import { getProjectFile, getObjectDir } from './helpers';
 import { integer } from 'vscode-languageclient';
 
+export let controller: vscode.TestController;
+export let testRunProfile: vscode.TestRunProfile;
+
 /*
     Types definition for the Gnattest XML file structure
 */
-type Root = {
+export type Root = {
     tests_mapping: TestMapping;
 };
 
@@ -33,7 +36,6 @@ type Tested = {
     '@_line': string;
     '@_name': string;
     test_case: TestCase | [TestCase];
-    test: Test;
 };
 
 type TestCase = {
@@ -55,7 +57,7 @@ export async function initializeTestView(
     clients: ContextClients
 ) {
     if (vscode.workspace.workspaceFolders !== undefined) {
-        const controller = vscode.tests.createTestController(
+        controller = vscode.tests.createTestController(
             'gnattest-test-controller',
             'GNATtest Test Controller'
         );
@@ -65,8 +67,7 @@ export async function initializeTestView(
         // Getting Paths Information from the server
         const projectFile = await getProjectFile(clients.adaClient);
         const objectDir: string = await getObjectDir(clients.adaClient);
-        let gnattestPath = vscode.workspace.asRelativePath(objectDir);
-        gnattestPath = path.join(gnattestPath, 'gnattest');
+        const gnattestPath = path.join(objectDir, 'gnattest');
 
         startTestRun(controller, projectFile, gnattestPath);
         await discoverTests(controller, gnattestPath);
@@ -124,7 +125,7 @@ function startTestRun(
         }
     };
 
-    const testRunProfile = controller.createRunProfile(
+    testRunProfile = controller.createRunProfile(
         'GNATtest',
         vscode.TestRunProfileKind.Run,
         runHandler,
@@ -149,7 +150,7 @@ function startTestRun(
 /*
     Run all tests handler
 */
-function handleRunAll(
+export function handleRunAll(
     tests: vscode.TestItem[],
     run: vscode.TestRun,
     terminalName: string,
@@ -208,7 +209,7 @@ function handleUnitRun(
 /*
     Resolves Tests to run for a selected test item in the Explorer
 */
-function gatherChildTestItems(
+export function gatherChildTestItems(
     collection: vscode.TestItemCollection | readonly vscode.TestItem[]
 ): vscode.TestItem[] {
     let items: vscode.TestItem[] = [];
@@ -226,7 +227,7 @@ function gatherChildTestItems(
     Gets the Source file name for a test item
     Needed for the --routines switch
 */
-function getParentTestSourceName(item: vscode.TestItem) {
+export function getParentTestSourceName(item: vscode.TestItem) {
     let parent: vscode.TestItem = item;
     if (item.parent != undefined) {
         parent = getParentTestSourceName(item.parent);
@@ -237,12 +238,10 @@ function getParentTestSourceName(item: vscode.TestItem) {
 /*
     Return the test_runner output stored in the result.txt file
 */
-async function readResultFile(resultPath: string) {
+export async function readResultFile(resultPath: string) {
     if (vscode.workspace.workspaceFolders !== undefined) {
-        const main_path = vscode.workspace.workspaceFolders[0].uri.path;
-        const full_result_path = path.join(main_path, resultPath);
-        if (pathExists(full_result_path)) {
-            const file = await vscode.workspace.fs.readFile(vscode.Uri.file(full_result_path));
+        if (pathExists(resultPath)) {
+            const file = await vscode.workspace.fs.readFile(vscode.Uri.file(resultPath));
             return file.toString();
         }
     }
@@ -257,7 +256,11 @@ enum Test_State {
 /*
     Parses the result of the file 'result.txt'
 */
-function parseResults(tests: vscode.TestItem[], run: vscode.TestRun, file: string) {
+export function parseResults(
+    tests: vscode.TestItem[],
+    run: vscode.TestRun | undefined,
+    file: string
+): boolean {
     const matchs = file.match(
         /(^|\n)((\w|-)+).ad[b|s]:\d+:\d+: (info|error): corresponding test (\w+)/g
     );
@@ -271,7 +274,7 @@ function parseResults(tests: vscode.TestItem[], run: vscode.TestRun, file: strin
                 const test_line: integer = p ? p + 1 : 0;
                 const check_line = matchs[i].match(test_src.label + ':' + test_line.toString());
                 // update the state of the test
-                if (check_line != null) {
+                if (check_line != null && run != undefined) {
                     run.appendOutput(`Completed ${e.id}\r\n`);
                     const mm: string = matchs[i].substring(matchs[i].length - 6, matchs[i].length);
                     if (mm == Test_State.PASSED) {
@@ -282,13 +285,15 @@ function parseResults(tests: vscode.TestItem[], run: vscode.TestRun, file: strin
                 }
             }
         }
+        return true;
     }
+    return false;
 }
 
 /*
     Return the tests structure stored in gnattest.xml file
 */
-async function readXMLfile(harnessPath: string): Promise<string | undefined> {
+export async function readXMLfile(harnessPath: string): Promise<string | undefined> {
     if (vscode.workspace.workspaceFolders !== undefined) {
         const mainPath = vscode.workspace.workspaceFolders[0].uri.path;
         const fullHarnessPath = path.join(mainPath, harnessPath);
@@ -306,7 +311,7 @@ async function readXMLfile(harnessPath: string): Promise<string | undefined> {
 /*
     Discover tests by parsing the xml input
 */
-async function discoverTests(controller: vscode.TestController, gnattestPath: string) {
+export async function discoverTests(controller: vscode.TestController, gnattestPath: string) {
     if (vscode.workspace.workspaceFolders !== undefined) {
         const mainPath = vscode.workspace.workspaceFolders[0].uri.path;
         const file = await readXMLfile(path.join(gnattestPath, 'harness'));
@@ -325,8 +330,10 @@ async function discoverTests(controller: vscode.TestController, gnattestPath: st
             } else {
                 addUnitTestItems(rootNode.unit, controller, mainPath);
             }
+            return xmlDoc;
         }
     }
+    return undefined;
 }
 
 /*

integration/vscode/ada/src/gprTaskProvider.ts

@@ -51,11 +51,7 @@ export default class GprTaskProvider implements vscode.TaskProvider<vscode.Task>
         return this.glsTasks;
     }
 
-    async resolveTask(
-        task: vscode.Task,
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        _token: vscode.CancellationToken
-    ): Promise<vscode.Task | undefined> {
+    async resolveTask(task: vscode.Task): Promise<vscode.Task | undefined> {
         const definition = task.definition;
         // Make sure that this looks like a execute task by checking that there is a projectFile.
         if (definition.type == GprTaskProvider.gprTaskType) {
@@ -199,7 +195,7 @@ function getMainBuildArgs(projectFile?: string, mainFile?: string): string[] {
  * @param args - the list of arguments
  * @returns a string
  */
-function fullCommand(command: string, args: string[]) {
+export function fullCommand(command: string, args: string[]) {
     let cmd: string = command + ' ';
     for (const arg of args) {
         cmd += arg.replace(/^\s+|\s+$/g, '') + ' ';