Migrate vscode testing to newer framework

Author: eliericha

.vscode/settings.json.tmpl

@@ -88,5 +88,10 @@
       "**/node_modules/*/**": true,
       "**/.hg/store/**": true,
       ".obj/": true
+   },
+   "extension-test-runner.extractSettings": {
+      "suite": ["describe", "suite"],
+      "test": ["it", "test"],
+      "extractWith": "syntax"
    }
 }

doc/HACKING.md

@@ -142,10 +142,9 @@ To write a functional test for Ada Language Server:
 Run `make vscode-test` to run the VS Code testsuite.
 
 If you open the ALS repository in VS Code, it is also possible to run VS Code
-integration tests using the provided launch configurations:
-
-- `(vscode) Run testsuite 'general'`
-- `(vscode) Run testsuite 'gnattest'`
+integration tests using the Testing view.
+The `integration/vscode/ada/.vscode-test.mjs` contains a configuration allowing to load the tests in the Testing view.
+The UI offers ways to run all or a subset of the tests.
 
 ### Other tests
 

integration/vscode/ada/.vscode-test.mjs

@@ -0,0 +1,86 @@
+import { defineConfig } from '@vscode/test-cli';
+import { mkdtempSync } from 'fs';
+import * as os from 'os';
+import { join } from 'path';
+
+let baseMochaOptions = {
+    ui: 'tdd',
+    color: true,
+};
+
+if (process.env.MOCHA_REPORTER) {
+    // If a reporter was specified externally, use it. For example, the CI
+    // environment could set this to 'mocha-junit-reporter' to produce JUnit
+    // results.
+    baseMochaOptions.reporter = process.env.MOCHA_REPORTER;
+}
+
+if (!baseMochaOptions.reporterOptions) {
+    baseMochaOptions.reporterOptions = {
+        maxDiffSize: 0,
+    };
+}
+
+if (process.env['MOCHA_TIMEOUT']) {
+    baseMochaOptions.timeout = process.env['MOCHA_TIMEOUT'];
+} else {
+    /**
+     * Some tests involve calling gprbuild which takes time. So we disable test
+     * timeouts altogether.
+     */
+    baseMochaOptions.timeout = '0';
+}
+
+if (process.env['MOCHA_GREP']) {
+    baseMochaOptions.grep = process.env['MOCHA_GREP'];
+}
+
+const testsuites = ['general', 'gnattest', 'workspace_missing_dirs'];
+
+export default defineConfig(
+    testsuites.map((suiteName) => {
+        // --user-data-dir is set to a unique dirctory under the OS
+        // default tmp directory for temporary files to avoid
+        // warnings related to longs paths in IPC sockets created by
+        // VSCode. The directory is made unique to avoid
+        // interference between successive runs.
+        //
+        // It also allows multiple testsuites to run concurrently with each VS
+        // Code instance using a different User data directory. This can happen
+        // when tests are launched from the VS Code UI.
+        const tmpdir = mkdtempSync(`${os.tmpdir()}/vsc-ada-test-`);
+
+        // Create a mocha options objects by copying the base one
+        let mochaOptions = { ...baseMochaOptions };
+
+        if (process.env.MOCHA_REPORTER) {
+            /**
+             * Produce results for each testsuite separately
+             */
+            const mochaFile = process.env.MOCHA_RESULTS_DIR
+                ? join(process.env.MOCHA_RESULTS_DIR, `${suiteName}.xml`)
+                : `${suiteName}.xml`;
+            mochaOptions.reporterOptions = { mochaFile: mochaFile };
+        }
+
+        return {
+            label: `Ada extension testsuite: ${suiteName}`,
+            files: `out/test/suite/${suiteName}/**/*.test.js`,
+            workspaceFolder: `./test/workspaces/${suiteName}`,
+            mocha: mochaOptions,
+            env: {
+                // When working remotely on Linux, it is necessary to have "Xvfb
+                // :99" running in the background, and this env variable set for
+                // the VS Code instances spawned for testing.
+                //
+                // This may prevent running locally on Linux and having the test
+                // windows visible, but we consider this a minor use case for
+                // now. A workaround is to remove this line.
+                DISPLAY: ':99',
+            },
+            launchArgs: ['--user-data-dir', tmpdir],
+            // Use external installation if provided in the VSCODE env variable
+            useInstallation: process.env.VSCODE ? { fromPath: process.env.VSCODE } : undefined,
+        };
+    })
+);

integration/vscode/ada/.vscodeignore

@@ -1,4 +1,5 @@
 # This file contains patterns to exclude from the packaging into a .vsix
+.vscode-test.mjs
 .vscode-test/
 advanced/
 node_modules/

integration/vscode/ada/package.json

@@ -883,9 +883,9 @@
         "pretest": "npm run compile",
         "lint": "eslint \"./src/**/*.{js,ts,tsx}\" --quiet --fix",
         "cilint": "eslint \"./src/**/*.{js,ts,tsx}\"",
-        "test": "node ./out/test/runTest.js",
-        "vscode-test": "vscode-test",
-        "resolve-backtrace": "npx stacktracify"
+        "test": "vscode-test",
+        "resolve-backtrace": "npx stacktracify",
+        "clean": "node -e \"fs.rmSync('out',{force:true,recursive:true})\""
     },
     "dependencies": {
         "@types/command-exists": "1.2.0",

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

@@ -1,5 +1,4 @@
 import assert from 'assert';
-import { suite, test } from 'mocha';
 import { Uri, window, workspace } from 'vscode';
 import { adaExtState } from '../../../src/extension';
 import { activate } from '../utils';

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

@@ -1,5 +1,4 @@
 import assert from 'assert';
-import { suite, test } from 'mocha';
 import {
     AdaConfig,
     adaDynamicDebugConfigProvider,

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

@@ -1,5 +1,4 @@
 import assert from 'assert';
-import { suite, test } from 'mocha';
 import { setTerminalEnvironment } from '../../../src/helpers';
 
 suite('Environment init', () => {

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

@@ -1,6 +1,5 @@
 import * as assert from 'assert';
 import { adaExtState } from '../../../src/extension';
-import { suite, test } from 'mocha';
 import { getProjectFile, getObjectDir } from '../../../src/helpers';
 import { assertEqualToFileContent, activate } from '../utils';
 

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

@@ -1,7 +1,6 @@
 import assert from 'assert';
 import * as vscode from 'vscode';
 import { spawnSync } from 'child_process';
-import { suite, test } from 'mocha';
 import { existsSync, opendirSync, renameSync } from 'fs';
 import path, { basename, dirname } from 'path';
 import { SemanticTokensParams, SemanticTokensRequest, integer } from 'vscode-languageclient';