Add common integration tests and update workflows

- Introduced new integration tests for Server API autocomplete functionality.
- Added a new task for running common integration tests in tasks.json.
- Updated PullRequest.yml to include a job for running common integration tests.
- Enhanced gulpfile.mjs to support common integration tests.
- Created runTest.ts and index.ts for managing and executing integration tests.

Author: Amit Joshi

.github/workflows/PullRequest.yml

@@ -69,3 +69,9 @@ jobs:
       with:
         run: |
          npm run test-desktop-int
+
+    - name: Run Common integration tests
+      uses: coactions/setup-xvfb@v1
+      with:
+        run: |
+         npm run test-common-int

.vscode/tasks.json

@@ -29,6 +29,13 @@
       "problemMatcher": [],
       "label": "Run Integration Tests: VS Code Web"
     },
+    {
+      "type": "npm",
+      "script": "test-common-int",
+      "group": "test",
+      "problemMatcher": [],
+      "label": "Run Integration Tests: Common"
+    },
     {
       "type": "npm",
       "script": "test",

gulpfile.mjs

@@ -216,6 +216,8 @@ function compileIntegrationTests() {
         // since "dom" overlaps with "webworker" we need to overwrite the lib property.
         // This is a known ts issue (bot being able to have both webworker and dom): https://github.com/microsoft/TypeScript/issues/20595
         lib: ["es2019", "dom", "dom.iterable", "es2020"],
+        // Skip checking .d.ts files from dependencies that may require newer TS features
+        skipLibCheck: true,
     });
     return gulp.src(["src/**/*.ts"]).pipe(tsProject()).pipe(gulp.dest("out"));
 }
@@ -257,6 +259,17 @@ const testDesktopIntegration = gulp.series(copyTestNugetPackages, compileIntegra
 // tests that require vscode-electron (which requires a display or xvfb)
 const testDesktopInt = gulp.series(testDesktopIntegration);
 
+/**
+ * Tests the common integration tests after transpiling the source files to /out
+ */
+const testCommonIntegration = gulp.series(compileIntegrationTests, async () => {
+    const testRunner = require("./out/common/test/runTest");
+    await testRunner.main();
+});
+
+// tests that require vscode-electron (which requires a display or xvfb)
+const testCommonInt = gulp.series(testCommonIntegration);
+
 async function packageVsix() {
     fs.ensureDirSync(packagedir);
     await vsce.createVSIX({
@@ -421,6 +434,7 @@ export {
     testInt,
     testWebInt,
     testDesktopInt,
+    testCommonInt,
     packageVsix as package,
     dist as ci,
     dist,

package.json

@@ -25,7 +25,8 @@
     "test-integration": "node node_modules/gulp/bin/gulp.js testInt",
     "test-web-integration": "node node_modules/gulp/bin/gulp.js testWebInt",
     "test-desktop-int": "node node_modules/gulp/bin/gulp.js testDesktopInt",
-    "coverage": "nyc npm run test"
+    "coverage": "nyc npm run test",
+    "test-common-int": "node node_modules/gulp/bin/gulp.js testCommonInt"
   },
   "nyc": {
     "extends": "@istanbuljs/nyc-config-typescript",

…sense/test/ServerApiAutocomplete.test.ts …ntegration/ServerApiAutocomplete.test.tssrc/common/intellisense/test/ServerApiAutocomplete.test.ts renamed to src/common/test/integration/ServerApiAutocomplete.test.ts src/common/intellisense/test/ServerApiAutocomplete.test.ts renamed to src/common/test/integration/ServerApiAutocomplete.test.ts

@@ -5,7 +5,7 @@
 
 import * as assert from 'assert';
 import * as vscode from 'vscode';
-import { ServerApiCompletionProvider, ServerApiDefinitions } from '../ServerApiCompletionProvider';
+import { ServerApiCompletionProvider, ServerApiDefinitions } from '../../intellisense';
 
 /**
  * Test suite for Server API autocomplete functionality
@@ -233,7 +233,7 @@ suite('Server API Autocomplete Tests', () => {
                 language: 'javascript'
             });
 
-            const position = new vscode.Position(0, 33);
+            const position = new vscode.Position(0, document.lineAt(0).range.end.character);
             const completions = provider.provideCompletionItems(document, position);
 
             assert.ok(Array.isArray(completions));

src/common/test/integration/index.ts

@@ -0,0 +1,54 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ */
+
+import * as path from "path";
+import Mocha from "mocha";
+import glob from "glob";
+import * as vscode from "vscode";
+
+async function addTests(): Promise<void> {
+    // Ensure the dev-mode extension is activated
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    await vscode.extensions
+        .getExtension("microsoft-IsvExpTools.powerplatform-vscode")!
+        .activate();
+
+    // Create the mocha test
+    const mocha = new Mocha({
+        ui: "tdd",
+        color: true,
+    });
+
+    const testsRoot = path.resolve(__dirname, "..");
+
+    return new Promise((resolve, reject) => {
+        glob("**/**.test.js", { cwd: testsRoot }, (err, files) => {
+            if (err) {
+                return reject(err);
+            }
+
+            // Add files to the test suite
+            files.forEach((f) => mocha.addFile(path.resolve(testsRoot, f)));
+
+            try {
+                // Run the mocha test
+                mocha.run((failures) => {
+                    if (failures > 0) {
+                        reject(new Error(`${failures} tests failed.`));
+                    } else {
+                        resolve();
+                    }
+                });
+            } catch (err) {
+                console.error(err);
+                reject(err);
+            }
+        });
+    });
+}
+
+export async function run(): Promise<void> {
+    await addTests();
+}

src/common/test/runTest.ts

@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ */
+
+import * as path from "path";
+
+import { runTests } from "@vscode/test-electron";
+
+async function main() {
+    try {
+        // The folder containing the Extension Manifest package.json
+        // Passed to `--extensionDevelopmentPath`
+        const extensionDevelopmentPath = path.resolve(__dirname, "../../../../");
+
+        // The path to test runner
+        // Passed to --extensionTestsPath
+        const extensionTestsPath = path.resolve(
+            __dirname,
+            "./integration/index"
+        );
+
+        // Download VS Code, unzip it and run the integration test
+        await runTests({
+            version: 'insiders',
+            extensionDevelopmentPath,
+            extensionTestsPath
+        });
+    } catch (err) {
+        console.error("Failed to run tests");
+        process.exit(1);
+    }
+}
+
+exports.main = main;