Merge pull request #1782 from github/jest-migration/no-workspace

Migrate no-workspace integration tests to Jest

Author: koesie10

extensions/ql-vscode/jest.config.js

@@ -3,6 +3,11 @@
  * https://jestjs.io/docs/configuration
  */
 
+/** @type {import('@jest/types').Config.InitialOptions} */
 module.exports = {
-  projects: ["<rootDir>/src/view", "<rootDir>/test"],
+  projects: [
+    "<rootDir>/src/view",
+    "<rootDir>/test",
+    "<rootDir>/out/vscode-tests/no-workspace",
+  ],
 };

extensions/ql-vscode/package.json

@@ -1272,8 +1272,8 @@
     "test": "npm-run-all -p test:*",
     "test:unit": "jest --projects test",
     "test:view": "jest --projects src/view",
-    "integration": "node ./out/vscode-tests/run-integration-tests.js no-workspace,minimal-workspace",
-    "integration:no-workspace": "node ./out/vscode-tests/run-integration-tests.js no-workspace",
+    "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",
     "cli-integration": "node ./out/vscode-tests/run-integration-tests.js cli-integration",
     "update-vscode": "node ./node_modules/vscode/bin/install",

extensions/ql-vscode/src/vscode-tests/factories/local-queries/local-query-history-item.ts

@@ -66,7 +66,6 @@ export function createMockLocalQueryInfo({
 }
 
 export function createMockQueryWithResults({
-  sandbox = undefined,
   didRunSuccessfully = true,
   hasInterpretedResults = true,
   hasMetadata = undefined,
@@ -76,16 +75,8 @@ export function createMockQueryWithResults({
   hasInterpretedResults?: boolean;
   hasMetadata?: boolean;
 }): QueryWithResults {
-  const dispose = sandbox
-    ? sandbox.spy()
-    : () => {
-        /**/
-      };
-  const deleteQuery = sandbox
-    ? sandbox.stub()
-    : () => {
-        /**/
-      };
+  const dispose = jest.fn();
+  const deleteQuery = jest.fn();
   const metadata = hasMetadata
     ? ({ name: "query-name" } as QueryMetadata)
     : undefined;

extensions/ql-vscode/src/vscode-tests/jest-runner-vscode.config.base.ts

@@ -0,0 +1,19 @@
+import * as path from "path";
+import * as tmp from "tmp-promise";
+import { RunnerOptions } from "jest-runner-vscode";
+
+export const tmpDir = tmp.dirSync({ unsafeCleanup: true });
+
+export const rootDir = path.resolve(__dirname, "../..");
+
+const config: RunnerOptions = {
+  version: "stable",
+  launchArgs: [
+    "--disable-extensions",
+    "--disable-gpu",
+    "--user-data-dir=" + path.join(tmpDir.name, "user-data"),
+  ],
+  extensionDevelopmentPath: rootDir,
+};
+
+export default config;

extensions/ql-vscode/src/vscode-tests/jest.config.base.ts

@@ -0,0 +1,205 @@
+import type { Config } from "jest";
+
+/*
+ * For a detailed explanation regarding each configuration property and type check, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+const config: Config = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/6m/1394pht172qgd7dmw1fwjk100000gn/T/jest_dx",
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  // clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  // collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  // coverageDirectory: undefined,
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: "v8",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // The default configuration for fake timers
+  // fakeTimers: {
+  //   "enableGlobally": false
+  // },
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // Insert Jest's globals (expect, test, describe, beforeEach etc.) into the global environment. If you set this to false, you should import from @jest/globals.
+  // injectGlobals: false,
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: 1,
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  moduleFileExtensions: ["js", "mjs", "cjs", "jsx", "ts", "tsx", "json"],
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  modulePathIgnorePatterns: [".vscode-test/"],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: 'ts-jest',
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  resetMocks: true,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  runner: "vscode",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  setupFilesAfterEnv: ["<rootDir>/../jest.setup.js"],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  // testEnvironment: 'jsdom',
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  testMatch: ["**/*.test.[jt]s"],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // A map from regular expressions to paths to transformers
+  // transform: {
+  //   '^.+\\.tsx?$': [
+  //     'ts-jest',
+  //     {
+  //       tsconfig: 'src/view/tsconfig.spec.json',
+  //     },
+  //   ],
+  //   'node_modules': [
+  //     'babel-jest',
+  //     {
+  //       presets: [
+  //         '@babel/preset-env'
+  //       ],
+  //       plugins: [
+  //         '@babel/plugin-transform-modules-commonjs',
+  //       ]
+  //     }
+  //   ]
+  // },
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // 'transformIgnorePatterns': [
+  //   // These use ES modules, so need to be transformed
+  //   'node_modules/(?!(?:@vscode/webview-ui-toolkit|@microsoft/.+|exenv-es6)/.*)'
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};
+
+export default config;

extensions/ql-vscode/src/vscode-tests/jest.setup.ts

@@ -0,0 +1,5 @@
+import { env } from "vscode";
+
+(env as any).openExternal = () => {
+  /**/
+};

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

@@ -0,0 +1,17 @@
+// This file needs to be located in a separate directory from all other tests. The jest-runner-vscode will
+// create a new VSCode instance for every directory containing tests, so this will ensure that this
+// test is run at the start-up of a new VSCode instance. No other files should be located in this directory since
+// those may activate the extension before this test is run.
+
+import * as vscode from "vscode";
+
+// Note that this may open the most recent VSCode workspace.
+describe("launching with no specified workspace", () => {
+  const ext = vscode.extensions.getExtension("GitHub.vscode-codeql");
+  it("should install the extension", () => {
+    expect(ext).not.toBeUndefined();
+  });
+  it("should not activate the extension at first", () => {
+    expect(ext!.isActive).toBeFalsy();
+  });
+});