@auxcode/auxta 0.5.3 → 0.5.7

package/build/esm/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/{src/AuxTA.ts → build/esm/AuxTA.js}

@@ -1,34 +1,29 @@
-import puppeteer, {Puppeteer} from "./puppeteer/puppeteer";
-import {FunctionHelper} from "./macros/helpers/code.helper";
+import puppeteer from "./puppeteer/puppeteer";
+import { FunctionHelper } from "./macros/helpers/code.helper";
 import path from "path";
 import fs from "fs";
 import StatusOfStep from "./auxta/enums/status-of.step";
-import {UploadModel} from "./auxta/models/upload.model";
+import { UploadModel } from "./auxta/models/upload.model";
 import * as dotenv from "dotenv";
-import {setupConfig, config as c, setupOverrideConfig} from "./auxta/configs/config";
-import {startSuite} from "./auxta/utilities/start-suite.helper";
-import {createEmptyReport} from "./auxta/services/report.service";
-
+import { setupConfig, config as c, setupOverrideConfig } from "./auxta/configs/config";
+import { startSuite } from "./auxta/utilities/start-suite.helper";
+import { createEmptyReport } from "./auxta/services/report.service";
 dotenv.config();
-
 class AuxTA extends FunctionHelper {
-    public puppeteer: Puppeteer = puppeteer;
-    public config = c;
-
-    private readonly uploadModel: UploadModel;
-
     constructor() {
         super();
+        this.puppeteer = puppeteer;
+        this.config = c;
         let file;
         if (!process.env.RPA) {
             try {
-                let currentDir = ""
+                let currentDir = "";
                 while (true) {
                     file = path.join(__dirname, currentDir, "auxta.json");
                     if (!fs.existsSync(file)) {
-                        currentDir += "../"
+                        currentDir += "../";
                         if (currentDir.length >= 30) {
-                            console.log("auxta.json file not found!")
+                            console.log("auxta.json file not found!");
                             process.exit(1);
                             return;
                         }
@@ -38,67 +33,65 @@ class AuxTA extends FunctionHelper {
                 }
                 const jsonConfig = JSON.parse(fs.readFileSync(file).toString());
                 try {
-                    this.config = setupConfig(jsonConfig)
-                } catch (e) {
-                    console.log("Missing field in auxta.json:", e)
+                    this.config = setupConfig(jsonConfig);
+                }
+                catch (e) {
+                    console.log("Missing field in auxta.json:", e);
                 }
                 this.uploadModel = new UploadModel(jsonConfig.organization, jsonConfig.baseURL, jsonConfig.digitalProduct, jsonConfig.environment);
-            } catch (e) {
-                console.log("Missing or corrupted config: auxta.json. Searching in location:", file)
+            }
+            catch (e) {
+                console.log("Missing or corrupted config: auxta.json. Searching in location:", file);
                 console.log(e);
                 process.exit(1);
             }
-        } else {
+        }
+        else {
             this.uploadModel = new UploadModel('', '', '', '');
         }
     }
-
-    public async run(event: any, overrideConfig?: any) {
+    async run(event, overrideConfig) {
         this.changeModelData(overrideConfig);
-        let reportId: string | undefined = event.queryStringParameters.reportId;
+        let reportId = event.queryStringParameters.reportId;
         if (process.env.ENVIRONMENT === 'LIVE' && event.queryStringParameters.token !== this.config.token)
-            return {statusCode: 401, message: 'Unauthorized'}
+            return { statusCode: 401, message: 'Unauthorized' };
         const suites = this.config.suitesList.slice(0);
         await startSuite(suites, reportId || await createEmptyReport(this.uploadModel));
-        return {statusCode: 204}
+        return { statusCode: 204 };
     }
-
-    private changeModelData(overrideConfig?: any) {
+    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 = setupOverrideConfig(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 = setupOverrideConfig(overrideConfig);
         }
     }
-
-    public async startBrowser(event: any, callback: any, feature: string, scenario: string, overrideConfig?: any, singleFeature = false) {
+    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'}
+                return { statusCode: 401, message: 'Unauthorized' };
             this.uploadModel.reportId = await createEmptyReport(this.uploadModel);
             this.uploadModel.nextSuites = [];
         }
-        return this.puppeteer.run(event, callback, feature, scenario)
+        return this.puppeteer.run(event, callback, feature, scenario);
     }
-
-    public async startBrowserRPA(event: any, callback: any, baseURL: string) {
+    async startBrowserRPA(event, callback, baseURL) {
         this.changeModelData({
             baseURL: baseURL,
             environment: '',
             digitalProduct: ''
         });
-        return this.puppeteer.runRPA(event, callback)
+        return this.puppeteer.runRPA(event, callback);
     }
-
-    public getUploadModel(): UploadModel {
+    getUploadModel() {
         return this.uploadModel;
     }
 }
-
 export const StepStatus = StatusOfStep;
-
-const auxta: AuxTA = new AuxTA();
-
+const auxta = new AuxTA();
 export default auxta;

package/build/esm/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/esm/auxta/configs/config.js

@@ -0,0 +1,61 @@
+export function setupConfig(jsonConfig) {
+    if (!jsonConfig.baseURL)
+        throw new Error("baseURL");
+    config.baseURL = jsonConfig.baseURL;
+    if (!jsonConfig.digitalProduct)
+        throw new Error("digitalProduct");
+    config.digitalProduct = jsonConfig.digitalProduct;
+    if (!jsonConfig.testsURL)
+        throw new Error("testsURL");
+    config.netlifyPath = (process.env.ENVIRONMENT == 'LOCAL') ? 'http://localhost:9999/' : jsonConfig.testsURL;
+    if (!jsonConfig.organization)
+        throw new Error("organization");
+    config.organization = jsonConfig.organization;
+    if (!jsonConfig.token)
+        throw new Error("token");
+    config.token = jsonConfig.token;
+    if (!jsonConfig.email)
+        throw new Error("email");
+    config.auxtaCredentials.email = jsonConfig.email;
+    if (!jsonConfig.password)
+        throw new Error("password");
+    config.auxtaCredentials.password = jsonConfig.password;
+    if (!jsonConfig.suitesList)
+        throw new Error("suitesList");
+    config.suitesList = jsonConfig.suitesList;
+    if (jsonConfig.timeout)
+        config.timeout = jsonConfig.timeout;
+    if (jsonConfig.screenWidth)
+        config.screenWidth = jsonConfig.screenWidth;
+    if (jsonConfig.screenHeight)
+        config.screenHeight = jsonConfig.screenHeight;
+    return config;
+}
+export function setupOverrideConfig(overrideConfig) {
+    if (overrideConfig.baseURL)
+        config.baseURL = overrideConfig.baseURL;
+    if (overrideConfig.digitalProduct)
+        config.digitalProduct = overrideConfig.digitalProduct;
+    if (overrideConfig.screenWidth)
+        config.screenWidth = overrideConfig.screenWidth;
+    if (overrideConfig.screenHeight)
+        config.screenHeight = overrideConfig.screenHeight;
+    return config;
+}
+export let 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/esm/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/esm/auxta/enums/status-of.step.js

@@ -0,0 +1,8 @@
+export var StatusOfStep;
+(function (StatusOfStep) {
+    StatusOfStep["PASSED"] = "passed";
+    StatusOfStep["FAILED"] = "failed";
+    StatusOfStep["SKIPPED"] = "skipped";
+    StatusOfStep["SUGGESTION"] = "suggestion";
+})(StatusOfStep || (StatusOfStep = {}));
+export default StatusOfStep;

package/build/esm/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/{src/auxta/helpers/response.helper.ts → build/esm/auxta/helpers/response.helper.js}

@@ -1,4 +1,4 @@
-export function returnImage(code: number, screenshot: Buffer) {
+export function returnImage(code, screenshot) {
     return {
         isBase64Encoded: true,
         statusCode: code,

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

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

package/{src/auxta/helpers/start.helper.ts → build/esm/auxta/helpers/start.helper.js}

@@ -1,14 +1,15 @@
 import { join } from 'path';
-
 (async () => {
     const r = /^--params\.suite=(.*)$/g;
     let suite = process.argv.find(el => !!el.match(r));
-    if (!suite) throw `Locale is undefined`;
+    if (!suite)
+        throw `Locale is undefined`;
     let suites = suite.replace('--params.suite=', '');
     let suitesArr = suites.split(',');
-    if (!suitesArr) suitesArr = [ suites ];
+    if (!suitesArr)
+        suitesArr = [suites];
     for (const suite of suitesArr) {
-        let f = require(join(process.cwd(), 'build', 'functions', 'controllers',  suite));
+        let f = require(join(process.cwd(), 'build', 'functions', 'controllers', suite));
         await f.handler();
     }
-})();
+})();

package/build/esm/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/{src/auxta/hooks/report.hook.ts → build/esm/auxta/hooks/report.hook.js}

@@ -1,19 +1,10 @@
-import { basename } from 'path'
+import { basename } from 'path';
 import log from "../services/log.service";
-import {
-    Feature,
-    postNotifications,
-    Steps,
-    updateReport,
-    uploadFeature,
-    uploadScenario
-} from '../services/report.service';
+import { postNotifications, updateReport, uploadFeature, uploadScenario } from '../services/report.service';
 import { startSuite } from '../utilities/start-suite.helper';
 import { StatusOfStep } from "../enums/status-of.step";
-import { UploadModel } from "../models/upload.model";
-
-export async function onTestEnd(body: any, featureName: string, scenarioName: string, statusCode: number, screenshotBuffer?: Buffer, errMessage?: object) {
-    let isFinal: boolean = false;
+export 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 ---');
@@ -21,32 +12,34 @@ export async function onTestEnd(body: any, featureName: string, scenarioName: st
         try {
             const scenarioRes = await uploadScenario(stepsArr, scenarioName, screenshotBuffer, errMessage);
             const featureRes = await uploadFeature(scenarioRes, featureName, basename(__filename), (statusCode != 200));
-            const feature: Feature = {
+            const feature = {
                 featureId: featureRes.featureRef,
                 featureName: featureRes.name,
                 featureUri: featureRes.uri,
                 status: featureRes.status,
                 scenariosCount: featureRes.scenariosCount
-            }
-            const stepCounts: Steps = {
+            };
+            const stepCounts = {
                 failedSteps: log.getStatusCount(StatusOfStep.FAILED),
                 passedSteps: log.getStatusCount(StatusOfStep.PASSED),
                 skippedSteps: log.getStatusCount(StatusOfStep.SKIPPED),
                 suggestedSteps: log.getStatusCount(StatusOfStep.SUGGESTION)
-            }
+            };
             isFinal = (!(body.nextSuites && body.nextSuites.length > 0));
             await 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)
+        }
+        catch (error) {
+            console.log('--- Failed to update report in AUXTA ---');
+            console.log(error);
         }
     }
-    if (isFinal) await afterComplete(body);
-    else if (body && body.nextSuites) await startSuite(body.nextSuites, body.reportId);
+    if (isFinal)
+        await afterComplete(body);
+    else if (body && body.nextSuites)
+        await startSuite(body.nextSuites, body.reportId);
 }
-
-export async function afterComplete(body: UploadModel) {
+export async function afterComplete(body) {
     if (process.env.ENVIRONMENT == "LIVE")
         await postNotifications(body);
 }

package/build/esm/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/esm/auxta/models/upload.model.js

@@ -0,0 +1,43 @@
+export 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;
+    }
+}

package/build/esm/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/esm/auxta/services/log.service.js

@@ -0,0 +1,43 @@
+import { StatusOfStep } from "../enums/status-of.step";
+export class LogSteps {
+    constructor() {
+        this.stepLog = [];
+        this.lastStepTime = new Date().getTime();
+        this.statusCounter = {
+            [StatusOfStep.PASSED]: 0,
+            [StatusOfStep.FAILED]: 0,
+            [StatusOfStep.SKIPPED]: 0,
+            [StatusOfStep.SUGGESTION]: 0,
+        };
+    }
+    addSuggestion(text) {
+        this.statusCounter[StatusOfStep.SUGGESTION]++;
+        this.stepLog.push({
+            keyword: 'Suggestion', name: text, result: { status: StatusOfStep.SUGGESTION, duration: 0 }
+        });
+    }
+    clear() {
+        this.stepLog = [];
+        this.statusCounter = {
+            [StatusOfStep.PASSED]: 0,
+            [StatusOfStep.FAILED]: 0,
+            [StatusOfStep.SKIPPED]: 0,
+            [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];
+    }
+}
+const log = new LogSteps();
+export default log;

package/build/esm/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>;