@maibornwolff/alt-core-js/lib/index.js

"use strict";
var __assign = (this && this.__assign) || function () {
    __assign = Object.assign || function(t) {
        for (var s, i = 1, n = arguments.length; i < n; i++) {
            s = arguments[i];
            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
                t[p] = s[p];
        }
        return t;
    };
    return __assign.apply(this, arguments);
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
    return new (P || (P = Promise))(function (resolve, reject) {
        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
        step((generator = generator.apply(thisArg, _arguments || [])).next());
    });
};
var __generator = (this && this.__generator) || function (thisArg, body) {
    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
    function verb(n) { return function (v) { return step([n, v]); }; }
    function step(op) {
        if (f) throw new TypeError("Generator is already executing.");
        while (_) try {
            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
            if (y = 0, t) op = [op[0] & 2, t.value];
            switch (op[0]) {
                case 0: case 1: t = op; break;
                case 4: _.label++; return { value: op[1], done: false };
                case 5: _.label++; y = op[1]; op = [0]; continue;
                case 7: op = _.ops.pop(); _.trys.pop(); continue;
                default:
                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
                    if (t[2]) _.ops.pop();
                    _.trys.pop(); continue;
            }
            op = body.call(thisArg, _);
        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
    }
};
Object.defineProperty(exports, "__esModule", { value: true });
var pad = require("pad");
var querystring_1 = require("querystring");
var actionLoading_1 = require("./actionLoading");
var diagramDrawing_1 = require("./diagramDrawing");
var logging_1 = require("./logging");
var ActionType_1 = require("./model/ActionType");
var TestResult_1 = require("./model/TestResult");
var scenarioLoading_1 = require("./scenarioLoading");
var yamlParsing_1 = require("./yamlParsing");
var RESULTS = new Map();
var OUT_DIR = '';
// increase the pixel-size (width/height) limit of PlantUML (the default is 4096 which is not enough for some diagrams)
process.env.PLANTUML_LIMIT_SIZE = '16384';
/**
 * @deprecated since 1.8.0, use {@link runMultipleScenariosWithConfig} instead
 */
exports.runMultipleSceanriosWithConfig = function (actionDir, outDir, envConfigDir, runConfig, scenarioPaths) {
    if (outDir === void 0) { outDir = 'out'; }
    return exports.runMultipleScenariosWithConfig(actionDir, outDir, envConfigDir, runConfig, scenarioPaths);
};
exports.runMultipleScenariosWithConfig = function (actionDir, outDir, envConfigDir, runConfig, scenarioPaths) {
    if (outDir === void 0) { outDir = 'out'; }
    exports.runMultipleScenariosWithConfigAsync(actionDir, outDir, envConfigDir, runConfig, scenarioPaths).then(function (result) {
        if (!result)
            process.exit(1);
    });
};
exports.runMultipleScenariosWithConfigAsync = function (actionDir, outDir, envConfigDir, runConfig, scenarioPaths) {
    if (outDir === void 0) { outDir = 'out'; }
    return __awaiter(void 0, void 0, void 0, function () {
        var _a, numberOfScenariosRunInParallel, _b, environmentNameToBeUsed, _c, drawDiagrams, envConfig, actions_1, resultPromises_1, results, e_1;
        return __generator(this, function (_d) {
            switch (_d.label) {
                case 0:
                    // TODO: global variables should be avoided
                    RESULTS.clear();
                    _a = runConfig.numberOfScenariosRunInParallel, numberOfScenariosRunInParallel = _a === void 0 ? 10 : _a, _b = runConfig.environmentNameToBeUsed, environmentNameToBeUsed = _b === void 0 ? 'none' : _b, _c = runConfig.drawDiagrams, drawDiagrams = _c === void 0 ? true : _c;
                    _d.label = 1;
                case 1:
                    _d.trys.push([1, 3, , 4]);
                    if (typeof scenarioPaths === 'undefined' ||
                        scenarioPaths.length === 0) {
                        logging_1.getLogger().error('Please provide correct path(s) to the SCENARIO file!');
                        process.exit(1);
                    }
                    if (typeof actionDir === 'undefined' || actionDir === '') {
                        logging_1.getLogger().error('Please provide correct path to the ACTION files!');
                        process.exit(1);
                    }
                    logging_1.getLogger('setup').info("RUNNING: scenario(s): " + scenarioPaths + " (actions: " + actionDir + ", out: " + outDir + ", envDir: " + envConfigDir + ", numberOfScenariosRunInParallel: " + numberOfScenariosRunInParallel + ", environmentNameToBeUsed: " + environmentNameToBeUsed + ")");
                    OUT_DIR = outDir;
                    envConfig = envConfigDir
                        ? yamlParsing_1.loadYamlConfiguration(envConfigDir + "/" + environmentNameToBeUsed + ".yaml")
                        : {};
                    logging_1.getLogger('setup').debug("Using '" + environmentNameToBeUsed + "' configuration: " + querystring_1.stringify(envConfig));
                    actions_1 = actionLoading_1.loadAllActions(actionDir, envConfig);
                    logging_1.getLogger('setup').debug("Successfully loaded " + actions_1.length + " actions");
                    resultPromises_1 = [];
                    scenarioPaths.forEach(function (scenarioPath) {
                        logging_1.getLogger('setup').debug("Loading: " + scenarioPath + " ...");
                        var scenarios = scenarioPath.endsWith('yaml')
                            ? scenarioLoading_1.loadScenariosById(scenarioPath, actions_1)
                            : scenarioLoading_1.loadAllScenarios(scenarioPath, actions_1);
                        logging_1.getLogger('setup').debug("Successfully loaded " + scenarios.length + " scenario(s): " + scenarioPath);
                        resultPromises_1.push(processScenarios(scenarios, numberOfScenariosRunInParallel, drawDiagrams));
                    });
                    return [4 /*yield*/, Promise.all(resultPromises_1)];
                case 2:
                    results = _d.sent();
                    return [2 /*return*/, results.every(function (result) { return result; })];
                case 3:
                    e_1 = _d.sent();
                    logging_1.getLogger('setup').error(e_1);
                    return [2 /*return*/, false];
                case 4: return [2 /*return*/];
            }
        });
    });
};
/**
 * @deprecated since 1.5.0, use {@link runMultipleSceanriosWithConfig} or
 * {@link runMultipleSceanriosWithConfigAsync} instead
 */
exports.runScenario = function (scenarioPath, actionDir, outDir, envConfigFile) {
    if (outDir === void 0) { outDir = 'out'; }
    exports.runMultipleSceanriosWithConfig(actionDir, outDir, envConfigFile.substring(0, envConfigFile.length - 12) /* substracting '/config.yaml' from the string */, { environmentNameToBeUsed: 'config' }, [scenarioPath]);
};
function processScenarios(scenarios, numberOfScenariosRunInParallel, drawDiagrams) {
    return __awaiter(this, void 0, void 0, function () {
        var i;
        return __generator(this, function (_a) {
            switch (_a.label) {
                case 0:
                    i = 0;
                    _a.label = 1;
                case 1:
                    if (!(i < scenarios.length)) return [3 /*break*/, 4];
                    // eslint-disable-next-line no-await-in-loop
                    return [4 /*yield*/, Promise.all(scenarios
                            .slice(i, i + numberOfScenariosRunInParallel)
                            .map(invokeActionsSynchronously))];
                case 2:
                    // eslint-disable-next-line no-await-in-loop
                    _a.sent();
                    _a.label = 3;
                case 3:
                    i += numberOfScenariosRunInParallel;
                    return [3 /*break*/, 1];
                case 4:
                    printResults();
                    return [2 /*return*/, generateDiagramsAndDetermineSuccess(drawDiagrams)];
            }
        });
    });
}
function invokeActionsSynchronously(scenario) {
    return __awaiter(this, void 0, void 0, function () {
        var scenarioName, ctx, MSG_WIDTH, timeDiffInMs, successful, actionsToCancel, actionsToAwaitAtEnd, handleError, _loop_1, _i, _a, action;
        return __generator(this, function (_b) {
            switch (_b.label) {
                case 0:
                    scenarioName = scenario.name;
                    RESULTS.set(scenarioName, []);
                    ctx = { scenario: scenarioName };
                    MSG_WIDTH = 100;
                    logging_1.getLogger(scenarioName).debug(pad(MSG_WIDTH, '#', '#'), ctx);
                    logging_1.getLogger(scenarioName).debug(pad("#### (S): " + scenarioName + ": " + scenario.description + " ", MSG_WIDTH, '#'), ctx);
                    logging_1.getLogger(scenarioName).debug(pad(MSG_WIDTH, '#', '#'), ctx);
                    diagramDrawing_1.initDiagramCreation(scenarioName);
                    timeDiffInMs = function (stop) {
                        return (stop[0] * 1e9 + stop[1]) * 1e-6;
                    };
                    successful = true;
                    actionsToCancel = [];
                    actionsToAwaitAtEnd = [];
                    handleError = function (reason, action, start, context) {
                        var duration = timeDiffInMs(process.hrtime(start)).toFixed(2);
                        var scenarioResults = RESULTS.get(scenarioName);
                        if (scenarioResults)
                            scenarioResults.push(new TestResult_1.TestResult(action.description, duration, false, action.allowFailure));
                        if (reason)
                            logging_1.getLogger(scenario.name).error(reason instanceof Error
                                ? reason.toString()
                                : JSON.stringify(reason), context);
                        logging_1.getLogger(scenario.name).info(pad(MSG_WIDTH, " Time: " + duration + " ms ###########", '#'), context);
                        if (action.allowFailure !== true) {
                            successful = false;
                        }
                    };
                    _loop_1 = function (action) {
                        var context_1, start, actionCallback, actionPromise;
                        return __generator(this, function (_a) {
                            switch (_a.label) {
                                case 0:
                                    if (!successful) {
                                        // after first ERROR skip further actions unless 'Action#invokeEvenOnFail' is set to TRUE
                                        if (!action.invokeEvenOnFail)
                                            return [2 /*return*/, "continue"];
                                    }
                                    context_1 = __assign(__assign({}, ctx), { action: action.name });
                                    logging_1.getLogger(scenarioName).info(pad("#### (A): " + action.description + " ", MSG_WIDTH, '#'), context_1);
                                    start = process.hrtime();
                                    actionCallback = action.invoke(scenario);
                                    actionPromise = actionCallback.promise
                                        .then(function (result) {
                                        var duration = timeDiffInMs(process.hrtime(start)).toFixed(2);
                                        var scenarioResults = RESULTS.get(scenarioName);
                                        if (scenarioResults)
                                            scenarioResults.push(new TestResult_1.TestResult(action.description, duration, true, action.allowFailure));
                                        if (result)
                                            logging_1.getLogger(scenario.name).debug(JSON.stringify(result), context_1);
                                        logging_1.getLogger(scenario.name).info(pad(MSG_WIDTH, " Time: " + duration + " ms ###########", '#'), context_1);
                                    })
                                        .catch(function (reason) { return handleError(reason, action, start, context_1); });
                                    if (action.type === ActionType_1.ActionType.WEBSOCKET ||
                                        action.type === ActionType_1.ActionType.AMQP_LISTEN) {
                                        actionsToCancel.push(actionCallback);
                                    }
                                    if (!(action.type === ActionType_1.ActionType.MQTT ||
                                        action.type === ActionType_1.ActionType.WEBSOCKET ||
                                        action.type === ActionType_1.ActionType.AMQP_LISTEN)) return [3 /*break*/, 1];
                                    actionsToAwaitAtEnd.push(actionPromise);
                                    return [3 /*break*/, 3];
                                case 1: return [4 /*yield*/, actionPromise];
                                case 2:
                                    _a.sent(); // eslint-disable-line no-await-in-loop
                                    _a.label = 3;
                                case 3: return [2 /*return*/];
                            }
                        });
                    };
                    _i = 0, _a = scenario.actions;
                    _b.label = 1;
                case 1:
                    if (!(_i < _a.length)) return [3 /*break*/, 4];
                    action = _a[_i];
                    return [5 /*yield**/, _loop_1(action)];
                case 2:
                    _b.sent();
                    _b.label = 3;
                case 3:
                    _i++;
                    return [3 /*break*/, 1];
                case 4:
                    // stop all async running actions
                    actionsToCancel.forEach(function (callback) { return callback.cancel(); });
                    return [4 /*yield*/, Promise.all(actionsToAwaitAtEnd)];
                case 5:
                    _b.sent();
                    return [2 /*return*/];
            }
        });
    });
}
function printResults() {
    RESULTS.forEach(function (result, scenario) {
        var ctx = { scenario: scenario };
        var MSG_WIDTH = 100;
        logging_1.getLogger(scenario).info(pad("#### SUMMARY: " + scenario + " ", MSG_WIDTH, '#'), ctx);
        result.forEach(function (res) {
            if (res.successful) {
                logging_1.getLogger(scenario).info(" OK: " + pad(res.action, 50) + " " + res.duration + " ms", ctx);
            }
            else if (res.allowFailure) {
                logging_1.getLogger(scenario).info("IGN: " + pad(res.action, 50) + " " + res.duration + " ms", ctx);
            }
            else {
                logging_1.getLogger(scenario).info("NOK: " + pad(res.action, 50) + " " + res.duration + " ms", ctx);
            }
        });
        logging_1.getLogger(scenario).info(pad(MSG_WIDTH, '#', '#'), ctx);
    });
}
function generateDiagramsAndDetermineSuccess(drawDiagrams) {
    return __awaiter(this, void 0, void 0, function () {
        var anyError, diagrams;
        return __generator(this, function (_a) {
            switch (_a.label) {
                case 0:
                    anyError = false;
                    diagrams = [];
                    RESULTS.forEach(function (results, scenario) {
                        if (drawDiagrams) {
                            diagrams.push(diagramDrawing_1.generateSequenceDiagram(scenario));
                        }
                        anyError =
                            anyError || results.some(function (result) { return result.isConsideredFailure(); });
                    });
                    return [4 /*yield*/, Promise.all(diagrams)];
                case 1:
                    _a.sent();
                    return [2 /*return*/, !anyError];
            }
        });
    });
}
exports.OUTPUT_DIR = function () { return OUT_DIR; };