@auxcode/auxta 0.5.3 → 0.5.4

package/build/cjs/AuxTA.d.ts

@@ -0,0 +1,43 @@
+import { Puppeteer } from "./puppeteer/puppeteer";
+import { FunctionHelper } from "./macros/helpers/code.helper";
+import StatusOfStep from "./auxta/enums/status-of.step";
+import { UploadModel } from "./auxta/models/upload.model";
+declare class AuxTA extends FunctionHelper {
+    puppeteer: Puppeteer;
+    config: {
+        auxtaURL: string;
+        baseURL: string;
+        siteURL: string;
+        organization: string;
+        netlifyPath: string;
+        digitalProduct: string;
+        token: string;
+        screenWidth: number;
+        screenHeight: number;
+        timeout: number;
+        suitesList: never[];
+        auxtaCredentials: {
+            email: string;
+            password: string;
+        };
+    };
+    private readonly uploadModel;
+    constructor();
+    run(event: any, overrideConfig?: any): Promise<{
+        statusCode: number;
+        message: string;
+    } | {
+        statusCode: number;
+        message?: undefined;
+    }>;
+    private changeModelData;
+    startBrowser(event: any, callback: any, feature: string, scenario: string, overrideConfig?: any, singleFeature?: boolean): Promise<void | {
+        statusCode: number;
+        message: string;
+    }>;
+    startBrowserRPA(event: any, callback: any, baseURL: string): Promise<any>;
+    getUploadModel(): UploadModel;
+}
+export declare const StepStatus: typeof StatusOfStep;
+declare const auxta: AuxTA;
+export default auxta;

package/build/cjs/AuxTA.js

@@ -0,0 +1,122 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __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.StepStatus = void 0;
+const puppeteer_1 = __importDefault(require("./puppeteer/puppeteer"));
+const code_helper_1 = require("./macros/helpers/code.helper");
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const status_of_step_1 = __importDefault(require("./auxta/enums/status-of.step"));
+const upload_model_1 = require("./auxta/models/upload.model");
+const dotenv = __importStar(require("dotenv"));
+const config_1 = require("./auxta/configs/config");
+const start_suite_helper_1 = require("./auxta/utilities/start-suite.helper");
+const report_service_1 = require("./auxta/services/report.service");
+dotenv.config();
+class AuxTA extends code_helper_1.FunctionHelper {
+    constructor() {
+        super();
+        this.puppeteer = puppeteer_1.default;
+        this.config = config_1.config;
+        let file;
+        if (!process.env.RPA) {
+            try {
+                let currentDir = "";
+                while (true) {
+                    file = path_1.default.join(__dirname, currentDir, "auxta.json");
+                    if (!fs_1.default.existsSync(file)) {
+                        currentDir += "../";
+                        if (currentDir.length >= 30) {
+                            console.log("auxta.json file not found!");
+                            process.exit(1);
+                            return;
+                        }
+                        continue;
+                    }
+                    break;
+                }
+                const jsonConfig = JSON.parse(fs_1.default.readFileSync(file).toString());
+                try {
+                    this.config = (0, config_1.setupConfig)(jsonConfig);
+                }
+                catch (e) {
+                    console.log("Missing field in auxta.json:", e);
+                }
+                this.uploadModel = new upload_model_1.UploadModel(jsonConfig.organization, jsonConfig.baseURL, jsonConfig.digitalProduct, jsonConfig.environment);
+            }
+            catch (e) {
+                console.log("Missing or corrupted config: auxta.json. Searching in location:", file);
+                console.log(e);
+                process.exit(1);
+            }
+        }
+        else {
+            this.uploadModel = new upload_model_1.UploadModel('', '', '', '');
+        }
+    }
+    async run(event, overrideConfig) {
+        this.changeModelData(overrideConfig);
+        let reportId = event.queryStringParameters.reportId;
+        if (process.env.ENVIRONMENT === 'LIVE' && event.queryStringParameters.token !== this.config.token)
+            return { statusCode: 401, message: 'Unauthorized' };
+        const suites = this.config.suitesList.slice(0);
+        await (0, start_suite_helper_1.startSuite)(suites, reportId || await (0, report_service_1.createEmptyReport)(this.uploadModel));
+        return { statusCode: 204 };
+    }
+    changeModelData(overrideConfig) {
+        if (overrideConfig) {
+            if (overrideConfig.digitalProduct)
+                this.uploadModel.digitalProduct = overrideConfig.digitalProduct;
+            if (overrideConfig.environment)
+                this.uploadModel.environment = overrideConfig.environment;
+            if (overrideConfig.baseURL)
+                this.uploadModel.baseUrl = overrideConfig.baseURL;
+            this.config = (0, config_1.setupOverrideConfig)(overrideConfig);
+        }
+    }
+    async startBrowser(event, callback, feature, scenario, overrideConfig, singleFeature = false) {
+        this.changeModelData(overrideConfig);
+        if (singleFeature && process.env.ENVIRONMENT !== 'LOCAL') {
+            if (process.env.ENVIRONMENT === 'LIVE' && event.queryStringParameters.token !== this.config.token)
+                return { statusCode: 401, message: 'Unauthorized' };
+            this.uploadModel.reportId = await (0, report_service_1.createEmptyReport)(this.uploadModel);
+            this.uploadModel.nextSuites = [];
+        }
+        return this.puppeteer.run(event, callback, feature, scenario);
+    }
+    async startBrowserRPA(event, callback, baseURL) {
+        this.changeModelData({
+            baseURL: baseURL,
+            environment: '',
+            digitalProduct: ''
+        });
+        return this.puppeteer.runRPA(event, callback);
+    }
+    getUploadModel() {
+        return this.uploadModel;
+    }
+}
+exports.StepStatus = status_of_step_1.default;
+const auxta = new AuxTA();
+exports.default = auxta;

package/build/cjs/auxta/configs/config.d.ts

@@ -0,0 +1,51 @@
+export declare function setupConfig(jsonConfig: any): {
+    auxtaURL: string;
+    baseURL: string;
+    siteURL: string;
+    organization: string;
+    netlifyPath: string;
+    digitalProduct: string;
+    token: string;
+    screenWidth: number;
+    screenHeight: number;
+    timeout: number;
+    suitesList: never[];
+    auxtaCredentials: {
+        email: string;
+        password: string;
+    };
+};
+export declare function setupOverrideConfig(overrideConfig: any): {
+    auxtaURL: string;
+    baseURL: string;
+    siteURL: string;
+    organization: string;
+    netlifyPath: string;
+    digitalProduct: string;
+    token: string;
+    screenWidth: number;
+    screenHeight: number;
+    timeout: number;
+    suitesList: never[];
+    auxtaCredentials: {
+        email: string;
+        password: string;
+    };
+};
+export declare let config: {
+    auxtaURL: string;
+    baseURL: string;
+    siteURL: string;
+    organization: string;
+    netlifyPath: string;
+    digitalProduct: string;
+    token: string;
+    screenWidth: number;
+    screenHeight: number;
+    timeout: number;
+    suitesList: never[];
+    auxtaCredentials: {
+        email: string;
+        password: string;
+    };
+};

package/build/cjs/auxta/configs/config.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.config = exports.setupOverrideConfig = exports.setupConfig = void 0;
+function setupConfig(jsonConfig) {
+    if (!jsonConfig.baseURL)
+        throw new Error("baseURL");
+    exports.config.baseURL = jsonConfig.baseURL;
+    if (!jsonConfig.digitalProduct)
+        throw new Error("digitalProduct");
+    exports.config.digitalProduct = jsonConfig.digitalProduct;
+    if (!jsonConfig.testsURL)
+        throw new Error("testsURL");
+    exports.config.netlifyPath = (process.env.ENVIRONMENT == 'LOCAL') ? 'http://localhost:9999/' : jsonConfig.testsURL;
+    if (!jsonConfig.organization)
+        throw new Error("organization");
+    exports.config.organization = jsonConfig.organization;
+    if (!jsonConfig.token)
+        throw new Error("token");
+    exports.config.token = jsonConfig.token;
+    if (!jsonConfig.email)
+        throw new Error("email");
+    exports.config.auxtaCredentials.email = jsonConfig.email;
+    if (!jsonConfig.password)
+        throw new Error("password");
+    exports.config.auxtaCredentials.password = jsonConfig.password;
+    if (!jsonConfig.suitesList)
+        throw new Error("suitesList");
+    exports.config.suitesList = jsonConfig.suitesList;
+    if (jsonConfig.timeout)
+        exports.config.timeout = jsonConfig.timeout;
+    if (jsonConfig.screenWidth)
+        exports.config.screenWidth = jsonConfig.screenWidth;
+    if (jsonConfig.screenHeight)
+        exports.config.screenHeight = jsonConfig.screenHeight;
+    return exports.config;
+}
+exports.setupConfig = setupConfig;
+function setupOverrideConfig(overrideConfig) {
+    if (overrideConfig.baseURL)
+        exports.config.baseURL = overrideConfig.baseURL;
+    if (overrideConfig.digitalProduct)
+        exports.config.digitalProduct = overrideConfig.digitalProduct;
+    if (overrideConfig.screenWidth)
+        exports.config.screenWidth = overrideConfig.screenWidth;
+    if (overrideConfig.screenHeight)
+        exports.config.screenHeight = overrideConfig.screenHeight;
+    return exports.config;
+}
+exports.setupOverrideConfig = setupOverrideConfig;
+exports.config = {
+    auxtaURL: "https://auxta.live/.netlify/functions/",
+    baseURL: "",
+    siteURL: "",
+    organization: "",
+    netlifyPath: "",
+    digitalProduct: "",
+    token: "",
+    screenWidth: 1920,
+    screenHeight: 1080,
+    timeout: 10000,
+    suitesList: [],
+    auxtaCredentials: {
+        email: "",
+        password: "",
+    },
+};

package/build/cjs/auxta/enums/status-of.step.d.ts

@@ -0,0 +1,7 @@
+export declare enum StatusOfStep {
+    PASSED = "passed",
+    FAILED = "failed",
+    SKIPPED = "skipped",
+    SUGGESTION = "suggestion"
+}
+export default StatusOfStep;

package/build/cjs/auxta/enums/status-of.step.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StatusOfStep = void 0;
+var StatusOfStep;
+(function (StatusOfStep) {
+    StatusOfStep["PASSED"] = "passed";
+    StatusOfStep["FAILED"] = "failed";
+    StatusOfStep["SKIPPED"] = "skipped";
+    StatusOfStep["SUGGESTION"] = "suggestion";
+})(StatusOfStep = exports.StatusOfStep || (exports.StatusOfStep = {}));
+exports.default = StatusOfStep;

package/build/cjs/auxta/helpers/response.helper.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="node" />
+export declare function returnImage(code: number, screenshot: Buffer): {
+    isBase64Encoded: boolean;
+    statusCode: number;
+    headers: {
+        "Content-Type": string;
+        "Content-Length": string;
+    };
+    body: string;
+};

package/build/cjs/auxta/helpers/response.helper.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.returnImage = void 0;
+function returnImage(code, screenshot) {
+    return {
+        isBase64Encoded: true,
+        statusCode: code,
+        headers: {
+            "Content-Type": "image/png",
+            "Content-Length": screenshot.length.toString()
+        },
+        body: screenshot.toString("base64")
+    };
+}
+exports.returnImage = returnImage;

package/build/cjs/auxta/helpers/start.helper.d.ts

@@ -0,0 +1 @@
+export {};

package/build/cjs/auxta/helpers/start.helper.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = require("path");
+(async () => {
+    const r = /^--params\.suite=(.*)$/g;
+    let suite = process.argv.find(el => !!el.match(r));
+    if (!suite)
+        throw `Locale is undefined`;
+    let suites = suite.replace('--params.suite=', '');
+    let suitesArr = suites.split(',');
+    if (!suitesArr)
+        suitesArr = [suites];
+    for (const suite of suitesArr) {
+        let f = require((0, path_1.join)(process.cwd(), 'build', 'functions', 'controllers', suite));
+        await f.handler();
+    }
+})();

package/build/cjs/auxta/hooks/report.hook.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="node" />
+import { UploadModel } from "../models/upload.model";
+export declare function onTestEnd(body: any, featureName: string, scenarioName: string, statusCode: number, screenshotBuffer?: Buffer, errMessage?: object): Promise<void>;
+export declare function afterComplete(body: UploadModel): Promise<void>;

package/build/cjs/auxta/hooks/report.hook.js

@@ -0,0 +1,53 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.afterComplete = exports.onTestEnd = void 0;
+const path_1 = require("path");
+const log_service_1 = __importDefault(require("../services/log.service"));
+const report_service_1 = require("../services/report.service");
+const start_suite_helper_1 = require("../utilities/start-suite.helper");
+const status_of_step_1 = require("../enums/status-of.step");
+async function onTestEnd(body, featureName, scenarioName, statusCode, screenshotBuffer, errMessage) {
+    let isFinal = false;
+    if (process.env.ENVIRONMENT == "LIVE") {
+        console.log('asc ' + errMessage);
+        console.log('--- Uploading scenario and feature for AUXTA report ---');
+        const stepsArr = log_service_1.default.returnScenarioReport();
+        try {
+            const scenarioRes = await (0, report_service_1.uploadScenario)(stepsArr, scenarioName, screenshotBuffer, errMessage);
+            const featureRes = await (0, report_service_1.uploadFeature)(scenarioRes, featureName, (0, path_1.basename)(__filename), (statusCode != 200));
+            const feature = {
+                featureId: featureRes.featureRef,
+                featureName: featureRes.name,
+                featureUri: featureRes.uri,
+                status: featureRes.status,
+                scenariosCount: featureRes.scenariosCount
+            };
+            const stepCounts = {
+                failedSteps: log_service_1.default.getStatusCount(status_of_step_1.StatusOfStep.FAILED),
+                passedSteps: log_service_1.default.getStatusCount(status_of_step_1.StatusOfStep.PASSED),
+                skippedSteps: log_service_1.default.getStatusCount(status_of_step_1.StatusOfStep.SKIPPED),
+                suggestedSteps: log_service_1.default.getStatusCount(status_of_step_1.StatusOfStep.SUGGESTION)
+            };
+            isFinal = (!(body.nextSuites && body.nextSuites.length > 0));
+            await (0, report_service_1.updateReport)(body.reportId, feature, stepCounts, isFinal);
+            console.log('--- Finished uploading report data to AUXTA ---');
+        }
+        catch (error) {
+            console.log('--- Failed to update report in AUXTA ---');
+            console.log(error);
+        }
+    }
+    if (isFinal)
+        await afterComplete(body);
+    else if (body && body.nextSuites)
+        await (0, start_suite_helper_1.startSuite)(body.nextSuites, body.reportId);
+}
+exports.onTestEnd = onTestEnd;
+async function afterComplete(body) {
+    if (process.env.ENVIRONMENT == "LIVE")
+        await (0, report_service_1.postNotifications)(body);
+}
+exports.afterComplete = afterComplete;

package/build/cjs/auxta/models/upload.model.d.ts

@@ -0,0 +1,20 @@
+export declare class UploadModel {
+    private _reportId;
+    private _nextSuites;
+    private _digitalProduct;
+    private _baseUrl;
+    private readonly _organization;
+    private _environment;
+    constructor(org: string, baseUrl: string, digitalProduct: string, environment: string);
+    get reportId(): string;
+    set reportId(value: string);
+    get nextSuites(): [];
+    set nextSuites(value: []);
+    get digitalProduct(): string;
+    set digitalProduct(value: string);
+    get organization(): string;
+    get baseUrl(): string;
+    set baseUrl(value: string);
+    get environment(): string;
+    set environment(value: string);
+}

package/build/cjs/auxta/models/upload.model.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UploadModel = void 0;
+class UploadModel {
+    constructor(org, baseUrl, digitalProduct, environment) {
+        this._reportId = '';
+        this._nextSuites = [];
+        this._organization = org;
+        this._digitalProduct = digitalProduct;
+        this._environment = environment;
+        this._baseUrl = baseUrl;
+    }
+    get reportId() {
+        return this._reportId;
+    }
+    set reportId(value) {
+        this._reportId = value;
+    }
+    get nextSuites() {
+        return this._nextSuites;
+    }
+    set nextSuites(value) {
+        this._nextSuites = value;
+    }
+    get digitalProduct() {
+        return this._digitalProduct;
+    }
+    set digitalProduct(value) {
+        this._digitalProduct = value;
+    }
+    get organization() {
+        return this._organization;
+    }
+    get baseUrl() {
+        return this._baseUrl;
+    }
+    set baseUrl(value) {
+        this._baseUrl = value;
+    }
+    get environment() {
+        return this._environment;
+    }
+    set environment(value) {
+        this._environment = value;
+    }
+}
+exports.UploadModel = UploadModel;

package/build/cjs/auxta/services/log.service.d.ts

@@ -0,0 +1,26 @@
+import { StatusOfStep } from "../enums/status-of.step";
+export interface Step {
+    keyword: string;
+    name: string;
+    result: {
+        status: StatusOfStep;
+        duration: number;
+    };
+}
+export declare class LogSteps {
+    private stepLog;
+    private lastStepTime;
+    statusCounter: {
+        passed: number;
+        failed: number;
+        skipped: number;
+        suggestion: number;
+    };
+    addSuggestion(text: string): void;
+    clear(): void;
+    push(keyword: string, name: string, status: StatusOfStep): void;
+    returnScenarioReport(): Step[];
+    getStatusCount(status: StatusOfStep): number;
+}
+declare const log: LogSteps;
+export default log;

package/build/cjs/auxta/services/log.service.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogSteps = void 0;
+const status_of_step_1 = require("../enums/status-of.step");
+class LogSteps {
+    constructor() {
+        this.stepLog = [];
+        this.lastStepTime = new Date().getTime();
+        this.statusCounter = {
+            [status_of_step_1.StatusOfStep.PASSED]: 0,
+            [status_of_step_1.StatusOfStep.FAILED]: 0,
+            [status_of_step_1.StatusOfStep.SKIPPED]: 0,
+            [status_of_step_1.StatusOfStep.SUGGESTION]: 0,
+        };
+    }
+    addSuggestion(text) {
+        this.statusCounter[status_of_step_1.StatusOfStep.SUGGESTION]++;
+        this.stepLog.push({
+            keyword: 'Suggestion', name: text, result: { status: status_of_step_1.StatusOfStep.SUGGESTION, duration: 0 }
+        });
+    }
+    clear() {
+        this.stepLog = [];
+        this.statusCounter = {
+            [status_of_step_1.StatusOfStep.PASSED]: 0,
+            [status_of_step_1.StatusOfStep.FAILED]: 0,
+            [status_of_step_1.StatusOfStep.SKIPPED]: 0,
+            [status_of_step_1.StatusOfStep.SUGGESTION]: 0,
+        };
+    }
+    push(keyword, name, status) {
+        console.log(`System log -- status: ${status} -- : ${name} `);
+        this.statusCounter[status]++;
+        const currentStep = new Date().getTime();
+        this.stepLog.push({ keyword, name, result: { status, duration: currentStep - this.lastStepTime } });
+        this.lastStepTime = currentStep;
+    }
+    returnScenarioReport() {
+        return this.stepLog;
+    }
+    getStatusCount(status) {
+        return this.statusCounter[status];
+    }
+}
+exports.LogSteps = LogSteps;
+const log = new LogSteps();
+exports.default = log;

package/build/cjs/auxta/services/report.service.d.ts

@@ -0,0 +1,36 @@
+/// <reference types="node" />
+import { Step } from "./log.service";
+import { UploadModel } from "../models/upload.model";
+export interface Feature {
+    featureId: string;
+    featureName: string;
+    featureUri: string;
+    status: string;
+    scenariosCount: number;
+}
+export interface Scenario {
+    featureId: string;
+    featureName: string;
+    featureUri: string;
+    status: string;
+    scenariosCount: number;
+}
+export interface Steps {
+    failedSteps: number;
+    passedSteps: number;
+    skippedSteps: number;
+    suggestedSteps: number;
+}
+export declare function createEmptyReport(body: any): Promise<string>;
+export declare function uploadScenario(stepLog: Step[], scenarioName: string, screenshot?: Buffer, errMessage?: object): Promise<{
+    scenarioRef: any;
+    name: any;
+    status: any;
+    stepsCount: any;
+}[]>;
+export declare function uploadFeature(scenarioId: any[], scenarioName: string, uri: string, hasFailed: boolean): Promise<any>;
+export declare function updateReport(reportId: string, feature: Feature, steps: Steps, isFinal: boolean): Promise<void>;
+export declare function getReport(reportId: string): Promise<any>;
+export declare function getLastDayResults(): Promise<any>;
+export declare function postNotifications(body: UploadModel): Promise<void>;
+export declare function postNotificationsOnFail(body: UploadModel): Promise<void>;