Function runJestIntegrationTest

tasks/tests/testHelpers.ts:83–137

(
    testAssetName: string,
    testFolderName: string,
    workspaceFileName: string,
    suiteName: string,
    env: NodeJS.ProcessEnv = {},
    testFile: string | undefined = undefined
)

 * @param testFile the full path to a specific test file to run.
 */
export async function runJestIntegrationTest(
    testAssetName: string,
    testFolderName: string,
    workspaceFileName: string,
    suiteName: string,
    env: NodeJS.ProcessEnv = {},
    testFile: string | undefined = undefined
) {
    const logName = testFile ? `${suiteName}_${path.basename(testFile)}` : suiteName;

    // Set VSCode to produce logs in a unique directory for this test run.
    const userDataDir = path.join(outPath, 'userData', logName);

    // Test assets are always in a testAssets folder inside the integration test folder.
    const assetsPath = path.join(rootPath, testFolderName, 'testAssets');
    if (!fs.existsSync(assetsPath)) {
        throw new Error(`Could not find test assets at ${assetsPath}`);
    }
    const workspacePath = path.join(assetsPath, testAssetName, '.vscode', workspaceFileName);
    if (!fs.existsSync(workspacePath)) {
        throw new Error(`Could not find vscode workspace to open at ${workspacePath}`);
    }

    // The runner (that loads in the vscode process to run tests) is in the test folder in the *output* directory.
    const vscodeRunnerPath = path.join(outPath, testFolderName, 'index.js');
    if (!fs.existsSync(vscodeRunnerPath)) {
        throw new Error(`Could not find vscode runner in out/ at ${vscodeRunnerPath}`);
    }

    // Configure the file and suite name in CI to avoid having multiple test runs stomp on each other.
    env.JEST_JUNIT_OUTPUT_NAME = getJUnitFileName(logName);
    env.JEST_SUITE_NAME = suiteName;

    if (testFile) {
        console.log(`Setting test file filter to: ${testFile}`);
        process.env.TEST_FILE_FILTER = testFile;
    }

    try {
        const result = await prepareVSCodeAndExecuteTests(rootPath, vscodeRunnerPath, workspacePath, userDataDir, env);
        if (result > 0) {
            // The VSCode API will generally throw if jest fails the test, but we can get errors before the test runs (e.g. launching VSCode).
            // So here we make sure to error if we don't get a clean exit code.
            throw new Error(`Exit code: ${result}`);
        }

        return result;
    } finally {
        // Copy the logs VSCode produced to a directory that CI can find.
        const vscodeLogs = path.join(userDataDir, 'logs');
        const logOutputPath = path.join(outPath, 'logs', logName);
        console.log(`Copying logs from ${vscodeLogs} to ${logOutputPath}`);
        fs.cpSync(vscodeLogs, logOutputPath, { recursive: true, force: true });
    }
}

export function getJUnitFileName(logName: string) {
    return `${logName.replaceAll(' ', '_')}_junit.xml`;