testRunner.ts

import * as path from "path";
import * as cp from "child_process";
import {
  runTests,
  downloadAndUnzipVSCode,
  resolveCliPathFromVSCodeExecutablePath,
} from "@vscode/test-electron";
import fs from "fs";

export const FIXTURES_BASE_PATH = path.join("test", "testFixtures");
export const ANSIBLE_COLLECTIONS_FIXTURES_BASE_PATH = path.resolve(
  FIXTURES_BASE_PATH,
  "common",
  "collections",
);
const PRETEST_ERR_RC = 2;

// display ansible-lint version and exit testing if ansible-lint is absent
const command = "ansible-lint --version";
try {
  const result = cp.execSync(command);
  console.info(`Detected: ${result}`);
} catch (e) {
  console.error(`error: test requisites not met, '${command}' returned ${e}`);
  process.exit(PRETEST_ERR_RC);
}

function getDownloadPlatform(platform: string): string {
  switch (platform) {
    case "darwin":
      return "darwin";
    case "win32":
      return "win32-archive";
    default:
      return "linux-x64";
  }
}

async function main(): Promise<void> {
  try {
    const executable = await downloadAndUnzipVSCode();
    const downloadPlatform = getDownloadPlatform(process.platform);
    const cliPath = resolveCliPathFromVSCodeExecutablePath(
      executable,
      downloadPlatform,
    );
    const userDataPath = path.resolve(__dirname, "../../userdata");
    const extPath = path.resolve(__dirname, "../../ext");
    // We want to avoid using developer data dir as this is likely to break
    // testing and make its outcome very hard to reproduce across machines.
    // https://code.visualstudio.com/docs/getstarted/settings#_settings-file-locations
    const cliArgs = [
      "--disable-gpu", // avoids misleading console messages during local or CI/CD test like VK_ERROR_INCOMPATIBLE_DRIVER
      `--user-data-dir=${userDataPath}`,
      `--extensions-dir=${extPath}`,
    ];
    const env = { ...process.env, NODE_NO_WARNINGS: "1" };

    // Copy default user settings.json
    const settings_src = path.join(
      __dirname,
      "..",
      "..",
      "..",
      "test",
      "testFixtures",
      "settings.json",
    );

    const settings_dst = path.join(
      __dirname,
      "..",
      "..",
      "..",
      "out",
      "userdata",
      "User",
      "settings.json",
    );
    fs.mkdirSync(path.dirname(settings_dst), { recursive: true });
    fs.copyFileSync(settings_src, settings_dst);

    // Install the dependent extensions
    const dependencies = ["ms-python.python", "redhat.vscode-yaml"];
    for (const dep of dependencies) {
      const installLog = cp.execSync(
        `"${cliPath}" ${cliArgs.join(" ")} --install-extension ${dep} --force`,
        { env: env },
      );
      console.log(installLog.toString());
    }

    // Display active extensions
    const cmd = `"${cliPath}" ${cliArgs.join(
      " ",
    )} --list-extensions --show-versions`;
    const extLog = cp.execSync(cmd);
    console.warn("%s\n%s", cmd, extLog.toString());

    // 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, "./index");

    // Download VS Code, unzip it and run the integration test
    await runTests({
      vscodeExecutablePath: executable,
      extensionDevelopmentPath,
      extensionTestsPath,
      launchArgs: cliArgs.concat([
        "--disable-extension=ritwickdey.liveserver",
        "--disable-extension=redhat.fabric8-analytics",
        "--disable-extension=lextudio.restructuredtext",
        "--disable-extension=ms-vsliveshare.vsliveshare",
        "--disable-extension=GitHub.vscode-pull-request-github",
        "--disable-extension=eamodio.gitlens",
        "--disable-extension=streetsidesoftware.code-spell-checker",
        "--disable-extension=alefragnani.project-manager",
        "--disable-extension=GitHub.copilot",
        "./test/testFixtures/",
      ]),
      extensionTestsEnv: {
        SKIP_PODMAN: process.env.SKIP_PODMAN ?? "0",
        SKIP_DOCKER: process.env.SKIP_DOCKER ?? "0",
        TEST_LIGHTSPEED_ACCESS_TOKEN: process.env.TEST_LIGHTSPEED_ACCESS_TOKEN,
        TEST_LIGHTSPEED_URL: process.env.TEST_LIGHTSPEED_URL,
      },
    });
  } catch (err) {
    console.error("Failed to run tests due to exception!\n%s", err);
    process.exit(1);
  }
}

main();