@itwin/certa/lib/utils/CoverageUtils.js

A mocha-based integration test runner

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.relaunchForCoverage = relaunchForCoverage;
exports.writeCoverageData = writeCoverageData;
/*---------------------------------------------------------------------------------------------
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
* See LICENSE.md in the project root for license terms and full copyright notice.
*--------------------------------------------------------------------------------------------*/
const fs = require("fs");
const path = require("path");
const SpawnUtils_1 = require("./SpawnUtils");
/**
 * Helper function for relaunching (as a child process) the current process running under `nyc` for measuring code coverage.
 * Once that completes, a second `nyc` child process will be spawned to report the coverage results.
 * Returns a promise that will be resolved with either 0 or the first non-zero child process exit code, once the reporter process terminates.
 */
async function relaunchForCoverage() {
    const nyc = require.resolve("nyc/bin/nyc");
    const relaunchArgs = [
        nyc,
        "--silent",
        "--",
        ...process.argv,
    ];
    // By splitting "instrument/runTests" and "report coverage" into two steps, we allow test runners the option of
    // running separate (concurrent) instrumented processes that also write to `nyc`'s temp directory.
    const instrumentedProcess = (0, SpawnUtils_1.spawnChildProcess)("node", relaunchArgs);
    const instrumentedStatus = await (0, SpawnUtils_1.onExit)(instrumentedProcess);
    // Now create a *combined* report for everything in `nyc`'s temp directory.
    const reporterProcess = (0, SpawnUtils_1.spawnChildProcess)("node", [require.resolve("nyc/bin/nyc"), "report"]);
    const reporterStatus = await (0, SpawnUtils_1.onExit)(reporterProcess);
    // Certa should exit with an error code if _either_ step failed.
    return instrumentedStatus || reporterStatus;
}
/** Gets the current effective nyc config from `process.env`. Assumes we're running as a child process of `nyc`. */
function getNycConfig() {
    const nycConfig = process.env.NYC_CONFIG;
    if (!nycConfig)
        throw new Error("NYC_CONFIG is not set in environment");
    return JSON.parse(nycConfig);
}
/**
 * Writes nyc or istanbul-generated coverage data to a uniquely-named file inside `nyc`'s temp directory.
 * All such files in the nyc temp directory are merged together when nyc reports are generated via `nyc report`.
 * @param coverageData The value of an nyc/istanbul-generated `__coverage__` object.
 */
function writeCoverageData(coverageData) {
    const nycConfig = getNycConfig();
    const nycCWD = nycConfig.cwd;
    const nycTempDir = nycConfig["temp-dir"] || nycConfig["temp-directory"];
    if (!nycCWD || !nycTempDir)
        throw new Error("Failed to determine nyc temp directory.");
    const nycTempDirAbsolute = path.resolve(nycCWD, nycTempDir);
    if (!fs.existsSync(nycTempDirAbsolute))
        throw new Error(`Cannot save coverage data - nyc temp directory "${nycTempDirAbsolute}" does not exist.`);
    // Generate a unique filename, just like `nyc` does.
    const coverageFileName = path.join(nycTempDirAbsolute, `${Math.random().toString(36).substring(2)}.json`);
    fs.writeFileSync(coverageFileName, JSON.stringify(coverageData));
}
//# sourceMappingURL=CoverageUtils.js.map