Migrate minimal-workspace integration tests to Jest (#1786)

Author: charisk

extensions/ql-vscode/jest.config.js

@@ -9,5 +9,6 @@ module.exports = {
     "<rootDir>/src/view",
     "<rootDir>/test",
     "<rootDir>/out/vscode-tests/no-workspace",
+    "<rootDir>/out/vscode-tests/minimal-workspace",
   ],
 };

extensions/ql-vscode/package.json

@@ -1274,7 +1274,7 @@
     "test:view": "jest --projects src/view",
     "integration": "npm-run-all integration:*",
     "integration:no-workspace": "jest --projects out/vscode-tests/no-workspace",
-    "integration:minimal-workspace": "node ./out/vscode-tests/run-integration-tests.js minimal-workspace",
+    "integration:minimal-workspace": "jest --projects out/vscode-tests/minimal-workspace",
     "cli-integration": "node ./out/vscode-tests/run-integration-tests.js cli-integration",
     "update-vscode": "node ./node_modules/vscode/bin/install",
     "format": "prettier --write **/*.{ts,tsx} && eslint . --ext .ts,.tsx --fix",

extensions/ql-vscode/src/vscode-tests/minimal-workspace/activation.test.ts

@@ -1,35 +1,36 @@
-import * as assert from "assert";
 import * as path from "path";
 import * as vscode from "vscode";
 import * as determiningSelectedQueryTest from "./determining-selected-query-test";
 
-describe("launching with a minimal workspace", async () => {
+// Temporary until Mocha is fully removed. This is necessary for passing timeouts to `it`.
+declare let it: jest.It;
+
+describe("launching with a minimal workspace", () => {
   const ext = vscode.extensions.getExtension("GitHub.vscode-codeql");
   it("should install the extension", () => {
-    assert(ext);
+    expect(ext).toBeDefined();
   });
 
   // Note, this test will only pass in pristine workspaces. This means that when run locally and you
   // reuse an existing workspace that starts with an open ql file, this test will fail. There is
   // no need to make any changes since this will still pass on CI.
   it("should not activate the extension at first", () => {
-    assert(ext!.isActive === false);
+    expect(ext!.isActive).toEqual(false);
   });
 
-  it("should activate the extension when a .ql file is opened", async function () {
-    this.timeout(60000);
+  it("should activate the extension when a .ql file is opened", async () => {
     await delay();
 
     const folders = vscode.workspace.workspaceFolders;
-    assert(folders && folders.length === 1);
+    expect(folders?.length).toEqual(1);
     const folderPath = folders![0].uri.fsPath;
     const documentPath = path.resolve(folderPath, "query.ql");
     const document = await vscode.workspace.openTextDocument(documentPath);
-    assert(document.languageId === "ql");
+    expect(document.languageId).toEqual("ql");
     // Delay slightly so that the extension has time to activate.
     await delay();
-    assert(ext!.isActive);
-  });
+    expect(ext!.isActive).toBeTruthy();
+  }, 60_000);
 
   async function delay() {
     await new Promise((resolve) => setTimeout(resolve, 4000));

extensions/ql-vscode/src/vscode-tests/minimal-workspace/config.test.ts

@@ -1,28 +1,15 @@
-import * as Sinon from "sinon";
-import { expect } from "chai";
 import { workspace } from "vscode";
 
 import {
   CliConfigListener,
+  ConfigListener,
   QueryHistoryConfigListener,
   QueryServerConfigListener,
 } from "../../config";
 
-describe("config listeners", function () {
-  // Because we are adding some extra waiting, need to bump the test timeouts.
-  this.timeout(5000);
-
-  let sandbox: Sinon.SinonSandbox;
-  beforeEach(() => {
-    sandbox = Sinon.createSandbox();
-  });
-
-  afterEach(() => {
-    sandbox.restore();
-  });
-
+describe("config listeners", () => {
   interface TestConfig<T> {
-    clazz: new () => unknown;
+    clazz: new () => ConfigListener;
     settings: {
       name: string;
       property: string;
@@ -95,23 +82,14 @@ describe("config listeners", function () {
 
   testConfig.forEach((config) => {
     describe(config.clazz.name, () => {
-      let listener: any;
-      let spy: Sinon.SinonSpy;
-      beforeEach(() => {
-        listener = new config.clazz();
-        spy = Sinon.spy();
-        listener.onDidChangeConfiguration(spy);
-      });
-
       config.settings.forEach((setting) => {
-        let origValue: any;
+        let origValue: string | number | boolean | undefined;
         beforeEach(async () => {
           origValue = workspace.getConfiguration().get(setting.name);
           await workspace
             .getConfiguration()
             .update(setting.name, setting.values[0]);
           await wait();
-          spy.resetHistory();
         });
 
         afterEach(async () => {
@@ -120,12 +98,17 @@ describe("config listeners", function () {
         });
 
         it(`should listen for changes to '${setting.name}'`, async () => {
+          const listener = new config.clazz();
+          const onDidChangeConfiguration = jest.fn();
+          listener.onDidChangeConfiguration(onDidChangeConfiguration);
+
           await workspace
             .getConfiguration()
             .update(setting.name, setting.values[1]);
           await wait();
-          expect(listener[setting.property]).to.eq(setting.values[1]);
-          expect(spy).to.have.been.calledOnce;
+          const newValue = listener[setting.property as keyof typeof listener];
+          expect(newValue).toEqual(setting.values[1]);
+          expect(onDidChangeConfiguration).toHaveBeenCalledTimes(1);
         });
       });
     });