approvals/lib/Reporting/GenericDiffReporterBase.js

Approval Tests Library - Capturing Human Intelligence

"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    var desc = Object.getOwnPropertyDescriptor(m, k);
    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
      desc = { enumerable: true, get: function() { return m[k]; } };
    }
    Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
    Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
    o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
    var ownKeys = function(o) {
        ownKeys = Object.getOwnPropertyNames || function (o) {
            var ar = [];
            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
            return ar;
        };
        return ownKeys(o);
    };
    return function (mod) {
        if (mod && mod.__esModule) return mod;
        var result = {};
        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
        __setModuleDefault(result, mod);
        return result;
    };
})();
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.GenericDiffReporterBase = void 0;
const childProcess = __importStar(require("child_process"));
const fs = __importStar(require("fs"));
const autils = __importStar(require("../AUtils"));
const ReportLaunchingCircuitBreaker_1 = __importDefault(require("./ReportLaunchingCircuitBreaker"));
class GenericDiffReporterBase {
    constructor(name) {
        this.exePath = "";
        this.setCommandArgs = (a, r) => [r, a];
        this.modifyCommandOptions = (c) => c;
        if (!name) {
            throw new Error("Argument name missing");
        }
        this.name = name;
        this._reporterFileLookedUp = false;
        this._reporterFileLookedUpAndFound = false;
    }
    isReporterAvailable() {
        if (this._reporterFileLookedUp) {
            return this._reporterFileLookedUpAndFound;
        }
        this._reporterFileLookedUp = true;
        if (!fs.existsSync(this.exePath)) {
            return false;
        }
        this._reporterFileLookedUpAndFound = true;
        return true;
    }
    canImageDiff() {
        return false;
    }
    canReportOn(fileName) {
        if (!this.isReporterAvailable()) {
            return false;
        }
        autils.assertFileExists(fileName);
        if (this.canImageDiff()) {
            return true;
        }
        const isBinary = autils.isBinaryFile(fileName);
        return !isBinary;
    }
    spawn(exe, args, cmdOptions) {
        const process = childProcess.spawn(exe, args, cmdOptions);
        let stdout = "";
        let stderr = "";
        process.stdout.on("data", (data) => {
            stdout += data;
        });
        process.stderr.on("data", (data) => {
            stderr += data;
        });
        process.on("close", () => {
            if (stdout) {
                console.log("\n============\nstdout:\n============\n" +
                    stdout +
                    "\n============\n");
            }
            if (stderr) {
                console.log("\n============\nstderr:\n============\n" +
                    stderr +
                    "\n============\n");
            }
        });
        return process;
    }
    spawnSync(exe, args, cmdOptions) {
        const result = childProcess.spawnSync(exe, args, cmdOptions);
        const stdout = result.stdout.toString();
        const stderr = result.stderr.toString();
        if (stdout) {
            console.log("\n============\nstdout:\n============\n" + stdout + "\n============\n");
        }
        if (stderr) {
            console.log("\n============\nstderr:\n============\n" + stderr + "\n============\n");
        }
    }
    report(approved, received, options = {}) {
        if (!options.blockUntilReporterExits) {
            if (ReportLaunchingCircuitBreaker_1.default.check(approved, received, options)) {
                return;
            }
        }
        const spawnMethod = options.blockUntilReporterExits
            ? this.spawnSync.bind(this)
            : this.spawn.bind(this);
        autils.createEmptyFileIfNotExists(approved);
        const { cmdOptions, args } = this.getCommandArguments(approved, received, options);
        console.log("CMD: ", this.exePath, args.join(" "));
        spawnMethod(this.exePath, args, cmdOptions);
    }
    getCommandArguments(approved, received, options = {}) {
        const cmdOptions = this.modifyCommandOptions(options.cmdOptionOverrides);
        const args = options.cmdArgs || this.setCommandArgs(approved, received);
        return { cmdOptions, args };
    }
}
exports.GenericDiffReporterBase = GenericDiffReporterBase;