Integration tests

.gitignore

@@ -3,3 +3,4 @@ node_modules
 node_modules
 *.vsix
 out/
+.vscode-test

it/runTest.ts

@@ -0,0 +1,23 @@
+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, "./suite/index");
+
+    // Download VS Code, unzip it and run the integration test
+    await runTests({ extensionDevelopmentPath, extensionTestsPath });
+  } catch (err) {
+    console.error("Failed to run tests");
+    process.exit(1);
+  }
+}
+
+main();

it/suite/extension.test.ts

@@ -0,0 +1,8 @@
+import * as vscode from "vscode";
+
+test("Sample test", () => {
+  vscode.window.showInformationMessage("Start all tests.");
+
+  expect([1, 2, 3].indexOf(5)).toEqual(-1);
+  expect([1, 2, 3].indexOf(0)).toEqual(-1);
+});

it/suite/index.ts

@@ -0,0 +1,40 @@
+import { runCLI } from "jest";
+
+interface ITestRunner {
+  run(testsRoot: string, clb: (error?: Error, failures?: number) => void): void;
+}
+const path = require("path");
+
+const jestTestRunnerForVSCodeE2E: ITestRunner = {
+  run(
+    testsRoot: string,
+    reportTestResults: (error?: Error, failures?: number) => void
+  ): void {
+    const projectRootPath = process.cwd();
+    const config = path.join(projectRootPath, "jest.e2e.config.js");
+
+    runCLI({ config } as any, [projectRootPath])
+      .then((jestCliCallResult) => {
+        jestCliCallResult.results.testResults.forEach((testResult) => {
+          testResult.testResults
+            .filter((assertionResult) => assertionResult.status === "passed")
+            .forEach(({ ancestorTitles, title, status }) => {
+              console.info(`  ● ${ancestorTitles} > ${title} (${status})`);
+            });
+        });
+
+        jestCliCallResult.results.testResults.forEach((testResult) => {
+          if (testResult.failureMessage) {
+            console.error(testResult.failureMessage);
+          }
+        });
+
+        reportTestResults(undefined, jestCliCallResult.results.numFailedTests);
+      })
+      .catch((errorCaughtByJestRunner) => {
+        reportTestResults(errorCaughtByJestRunner, 0);
+      });
+  },
+};
+
+module.exports = jestTestRunnerForVSCodeE2E;

it/vscode-environment.js

@@ -0,0 +1,21 @@
+// see https://github.com/microsoft/vscode-test/issues/37#issuecomment-700167820
+const NodeEnvironment = require("jest-environment-node");
+const vscode = require("vscode");
+
+class VsCodeEnvironment extends NodeEnvironment {
+  async setup() {
+    await super.setup();
+    this.global.vscode = vscode;
+  }
+
+  async teardown() {
+    this.global.vscode = {};
+    await super.teardown();
+  }
+
+  runScript(script) {
+    return super.runScript(script);
+  }
+}
+
+module.exports = VsCodeEnvironment;

it/vscode.js

@@ -0,0 +1,2 @@
+// see https://github.com/microsoft/vscode-test/issues/37#issuecomment-700167820
+module.exports = global.vscode;

jest.config.js

@@ -11,4 +11,5 @@ module.exports = {
   moduleNameMapper: {
     "^(\\.{1,2}/.*)\\.js$": "$1",
   },
+  testMatch: ["<rootDir>/tests/**/*.spec.ts"],
 };

jest.e2e.config.js

@@ -0,0 +1,11 @@
+const path = require("path");
+
+module.exports = {
+  moduleFileExtensions: ["js"],
+  testMatch: ["<rootDir>/out/it/suite/**.test.js"],
+  testEnvironment: "./it/vscode-environment.js",
+  verbose: true,
+  moduleNameMapper: {
+    vscode: path.join(__dirname, "it", "vscode.js"),
+  },
+};

package.json

@@ -77,6 +77,7 @@
     "watch": "tsc -watch -p ./",
     "clean": "rm -rf node_modules/ out/",
     "test": "jest",
+    "test:it": "yarn run compile && node ./out/it/runTest.js",
     "test:watch": "yarn run test --watch",
     "build": "vsce package --yarn",
     "format": "prettier --write '**/*.{ts,js,json,yml}'",
@@ -87,7 +88,7 @@
     "extension.vsix"
   ],
   "engines": {
-    "vscode": "^1.43.0"
+    "vscode": "^1.70.0"
   },
   "dependencies": {
     "follow-redirects": "^1.14.9",
@@ -97,14 +98,15 @@
     "@types/follow-redirects": "^1.14.1",
     "@types/jest": "^27.4.0",
     "@types/node": "^17.0.21",
-    "@types/vscode": "1.43.0",
+    "@types/vscode": "^1.70.0",
     "@typescript-eslint/parser": "^2.3.0",
+    "@vscode/test-electron": "^2.1.5",
     "eslint": "^8.10.0",
     "jest": "^27.5.1",
+    "jest-environment-node": "^27.5.1",
     "prettier": "^2.5.1",
     "ts-jest": "^27.1.3",
     "typescript": "^4.6.2",
-    "vsce": "^2.10.0",
-    "vscode-test": "^1.6.1"
+    "vsce": "^2.10.0"
   }
 }

tsconfig.json

@@ -4,9 +4,9 @@
     "target": "es2019",
     "lib": ["ES2019"],
     "outDir": "out",
-    "rootDirs": ["src", "tests"],
+    "rootDirs": ["src", "tests", "it"],
     "sourceMap": true
   },
-  "include": ["src"],
+  "include": ["src", "tests", "it"],
   "exclude": ["node_modules", ".vscode-test"]
 }