@auxcode/auxta 0.5.1 → 0.5.5

package/build/puppeteer/puppeteer.js

@@ -0,0 +1,136 @@
+import chromium from 'chrome-aws-lambda';
+import log from "../auxta/services/log.service";
+import { captureScreenshot } from "../auxta/utilities/screenshot.helper";
+import { onTestEnd } from "../auxta/hooks/report.hook";
+import auxta from "../AuxTA";
+import { StatusOfStep } from "../auxta/enums/status-of.step";
+import { config } from "./../auxta/configs/config";
+import { postNotificationsOnFail } from "../auxta/services/report.service";
+export class Puppeteer {
+    async startBrowser() {
+        let args = [
+            '--start-maximized',
+            '--no-sandbox',
+            '--disable-setuid-sandbox',
+            '--disable-dev-shm-usage',
+            '--single-process'
+        ];
+        if (process.env.ENVIRONMENT != 'LOCAL')
+            args.push(`--window-size=${config.screenWidth},${config.screenHeight}`);
+        this.browser = await chromium.puppeteer.launch({
+            executablePath: process.env.ENVIRONMENT === 'LOCAL' ? undefined : await chromium.executablePath,
+            args,
+            ignoreDefaultArgs: ["--enable-automation"],
+            defaultViewport: process.env.ENVIRONMENT === 'LOCAL' ? null : {
+                width: config.screenWidth,
+                height: config.screenHeight
+            },
+            headless: process.env.ENVIRONMENT == 'LOCAL' ? false : chromium.headless
+        });
+        this.defaultPage = (await this.browser.pages())[0];
+        await this.defaultPage.goto(config.baseURL, { waitUntil: 'networkidle0' });
+        await this.defaultPage.waitForNetworkIdle();
+    }
+    async close() {
+        if (this.browser) {
+            let pages = await this.browser.pages();
+            await Promise.all(pages.map((page) => page.close()));
+            await this.browser.close();
+        }
+    }
+    async run(event, callback, featureName = 'Test feature', scenarioName = 'Test scenario', uploadModel, close) {
+        try {
+            if (uploadModel === undefined)
+                uploadModel = auxta.getUploadModel();
+            if (close === undefined)
+                close = Puppeteer.setupHeader(event, uploadModel);
+            let screenshotBuffer;
+            let errMessage;
+            let statusCode = 200;
+            let consoleStack = [];
+            try {
+                await log.push('When', `Starting puppeteer process`, StatusOfStep.PASSED);
+                await this.startBrowser();
+                this.defaultPage.on('console', message => consoleStack.push(`${message.type().substr(0, 3).toUpperCase()} ${message.text()}`))
+                    .on('pageerror', ({ message }) => consoleStack.push(message))
+                    .on('response', response => consoleStack.push(`${response.status()} ${response.url()}`))
+                    .on('requestfailed', request => consoleStack.push(`${request.failure() !== null ? request.failure()?.errorText : ""} ${request.url()}`));
+                await callback(event);
+                log.push('When', `Finished puppeteer process`, StatusOfStep.PASSED);
+            }
+            catch (err) {
+                console.log("Error", err);
+                errMessage = err;
+                statusCode = 500;
+                screenshotBuffer = await captureScreenshot();
+                log.push('When', `Finished puppeteer process`, StatusOfStep.FAILED);
+                await postNotificationsOnFail(uploadModel);
+            }
+            let url = this.defaultPage.url();
+            if (close)
+                await this.close();
+            await onTestEnd(uploadModel, featureName, scenarioName, statusCode, screenshotBuffer, !errMessage ? undefined : {
+                currentPageUrl: url,
+                console: consoleStack,
+                error: errMessage
+            });
+        }
+        catch (e) {
+            console.log("Lib error:", e);
+        }
+        finally {
+            log.clear();
+        }
+    }
+    async runRPA(event, callback, close) {
+        let errMessage;
+        try {
+            if (close === undefined) {
+                if (event.queryStringParameters.close) {
+                    close = event.queryStringParameters.close === "true";
+                }
+                else {
+                    close = true;
+                }
+            }
+            let consoleStack = [];
+            try {
+                await log.push('When', `Starting puppeteer process`, StatusOfStep.PASSED);
+                await this.startBrowser();
+                this.defaultPage.on('console', message => consoleStack.push(`${message.type().substr(0, 3).toUpperCase()} ${message.text()}`))
+                    .on('pageerror', ({ message }) => consoleStack.push(message))
+                    .on('response', response => consoleStack.push(`${response.status()} ${response.url()}`))
+                    .on('requestfailed', request => consoleStack.push(`${request.failure() !== null ? request.failure()?.errorText : ""} ${request.url()}`));
+                await callback(event);
+                log.push('When', `Finished puppeteer process`, StatusOfStep.PASSED);
+            }
+            catch (err) {
+                errMessage = err;
+                log.push('When', `Finished puppeteer process`, StatusOfStep.FAILED);
+                return errMessage;
+            }
+            if (close)
+                await this.close();
+        }
+        catch (e) {
+            console.log("Lib error:", e);
+        }
+        finally {
+            log.clear();
+        }
+        return true;
+    }
+    static setupHeader(event, uploadModel) {
+        let close = true;
+        if (process.env.ENVIRONMENT !== 'LOCAL' && event.body) {
+            const body = JSON.parse(event.body);
+            uploadModel.reportId = body.reportId;
+            uploadModel.nextSuites = body.nextSuites;
+        }
+        else if (event.queryStringParameters.close) {
+            close = event.queryStringParameters.close === "true";
+        }
+        return close;
+    }
+}
+export default new Puppeteer();

package/package.json

@@ -1,11 +1,15 @@
 {
   "name": "@auxcode/auxta",
-  "version": "0.5.1",
+  "version": "0.5.5",
   "description": "",
-  "main": "src/AuxTA.ts",
+  "main": "./build/AuxTA.js",
+  "files": [
+    "build/"
+  ],
   "scripts": {
-    "build": "tsc",
-    "test": "npm run build & node ./build/AuxTA.js"
+    "tsc": "tsc -p tsconfig.json",
+    "prepublish": "npm run tsc",
+    "test": "npm run prepublish & node ./build/AuxTA.js"
   },
   "author": "auxcode",
   "license": "ISC",

package/src/auxta/configs/config.ts

@@ -1,48 +0,0 @@
-export function setupConfig(jsonConfig: any) {
-    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: any){
-    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/src/auxta/enums/status-of.step.ts

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

package/src/auxta/models/upload.model.ts

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

package/src/auxta/services/log.service.ts

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

package/src/auxta/services/report.service.ts

@@ -1,189 +0,0 @@
-import axios from "axios";
-import { Step } from "./log.service";
-import { config } from "../configs/config";
-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
-}
-
-function headers(token: string) {
-    return {
-        headers: {
-            'Content-Type': 'application/json',
-            'cookie': `authToken=${token}`
-        }
-    }
-}
-
-async function auth() {
-    return axios.post(
-        config.auxtaURL + 'login',
-        config.auxtaCredentials,
-        {
-            headers: {
-                'Content-Type': 'application/json',
-            }
-        })
-        .then(({data}) => {
-            return data.token
-        })
-        .catch(() => {
-            throw new Error("Invalid login credentials")
-        });
-}
-
-export async function createEmptyReport(body: any): Promise<string> {
-    const token = await auth();
-    return (await axios.post(
-        config.auxtaURL + "create-empty-report",
-        {
-            environment: body.environment,
-            digitalProductName: body.digitalProduct,
-            start: new Date(),
-            url: body.baseUrl
-        },
-        headers(token)
-    )).data.reportId;
-}
-
-export async function uploadScenario(stepLog: Step[], scenarioName: string, screenshot?: Buffer, errMessage?: object) {
-    let scenarios = [];
-    let token = await auth();
-    let lastStep = stepLog[stepLog.length - 1];
-    const stepLogFormat = JSON.parse(JSON.stringify(stepLog));
-    stepLogFormat.pop();
-    let output = (await axios.post(
-        config.auxtaURL + "create-scenario",
-        {
-            json: {
-                name: scenarioName,
-                steps: [
-                    ...stepLogFormat,
-                    (lastStep!.result.status == 'failed')
-                        ? Object.assign(lastStep, {
-                            result: {
-                                ...lastStep!.result,
-                                error_message: JSON.stringify(errMessage)
-                            }
-                        })
-                        : lastStep,
-                    {
-                        keyword: "After",
-                        result: {
-                            status: "passed",
-                            duration: 2678000000
-                        },
-                        embeddings: (screenshot) ? [{
-                            data: screenshot.toString("base64"),
-                            mime_type: "image/png"
-                        }] : undefined,
-                    }
-                ],
-            }
-        },
-        headers(token)
-    )).data.scenarios;
-    scenarios.push({
-        scenarioRef: output.scenarioRef,
-        name: output.name,
-        status: output.status,
-        stepsCount: output.stepsCount
-    });
-    return scenarios;
-}
-
-export async function uploadFeature(scenarioId: any[], scenarioName: string, uri: string, hasFailed: boolean) {
-    let token = await auth();
-    return (await axios.post(
-        config.auxtaURL + "create-feature",
-        {
-            json: {
-                name: scenarioName,
-                uri: uri
-            },
-            scenarios: scenarioId,
-            hasFailed: hasFailed
-        },
-        headers(token)
-    )).data;
-}
-
-export async function updateReport(reportId: string, feature: Feature, steps: Steps, isFinal: boolean) {
-    let token = await auth();
-    await axios.post(
-        config.auxtaURL + "update-inprogress-report",
-        {
-            reportId: reportId,
-            isFinal: isFinal,
-            data: {
-                feature: {
-                    featureRef: feature.featureId,
-                    name: feature.featureName,
-                    uri: feature.featureUri,
-                    status: feature.status,
-                    scenariosCount: feature.scenariosCount
-                },
-                ...steps
-            }
-        },
-        headers(token)
-    );
-}
-
-export async function getReport(reportId: string): Promise<any> {
-    let token = await auth();
-    return (await axios.post(
-        config.auxtaURL + "get-report",
-        {reportId: reportId},
-        headers(token)
-    )).data;
-}
-
-export async function getLastDayResults(): Promise<any> {
-    let token = await auth();
-    return (await axios.get(
-        config.auxtaURL + `get-last-day-results?url=${config.baseURL}`,
-        headers(token)
-    )).data.results;
-}
-
-export async function postNotifications( body: UploadModel) {
-    let token = await auth();
-    await axios.post(`${config.auxtaURL}post-notification-after-run-background`, {
-        environmentName: body.environment,
-        digitalProductName: body.digitalProduct,
-        organizationName: body.organization,
-        reportId: body.reportId,
-    }, headers(token));
-}
-
-
-export async function postNotificationsOnFail( body: UploadModel) {
-    let token = await auth();
-    await axios.post(`${config.auxtaURL}post-notifications-after-case-fail-background`, {
-        environmentName: body.environment,
-        digitalProductName: body.digitalProduct,
-        organizationName: body.organization,
-        reportId: body.reportId,
-    }, headers(token));
-}

package/src/auxta/utilities/start-suite.helper.ts

@@ -1,16 +0,0 @@
-import axios from 'axios';
-import { config } from "../configs/config";
-
-export async function startSuite(suites: string[], reportId?: string) {
-    if (suites.length === 0) return;
-    const next = suites.shift();
-    console.log('Starting next suite: ' + next);
-    try{
-        await axios.post(
-            `${config.netlifyPath}.netlify/functions/${next}?token=${config.token}`,
-            {nextSuites: suites, reportId: reportId})
-    } catch (e){
-        // skip the suite if not found
-        await startSuite(suites, reportId);
-    }
-}

package/src/puppeteer/puppeteer.ts

@@ -1,145 +0,0 @@
-import chromium from 'chrome-aws-lambda';
-import log from "../auxta/services/log.service";
-import {captureScreenshot} from "../auxta/utilities/screenshot.helper";
-import {onTestEnd} from "../auxta/hooks/report.hook";
-import auxta from "../AuxTA";
-import {StatusOfStep} from "../auxta/enums/status-of.step";
-import {UploadModel} from "../auxta/models/upload.model";
-import puppeteer_core from 'puppeteer-core';
-import {config} from "./../auxta/configs/config";
-import {postNotificationsOnFail} from "../auxta/services/report.service";
-
-
-export class Puppeteer {
-    public defaultPage!: puppeteer_core.Page;
-    private browser!: puppeteer_core.Browser;
-
-    public async startBrowser() {
-        let args = [
-            '--start-maximized',
-            '--no-sandbox',
-            '--disable-setuid-sandbox',
-            '--disable-dev-shm-usage',
-            '--single-process'
-        ];
-        if (process.env.ENVIRONMENT != 'LOCAL')
-            args.push(`--window-size=${config.screenWidth},${config.screenHeight}`)
-        this.browser = await chromium.puppeteer.launch({
-            executablePath: process.env.ENVIRONMENT === 'LOCAL' ? undefined : await chromium.executablePath,
-            args,
-            ignoreDefaultArgs: ["--enable-automation"],
-            defaultViewport: process.env.ENVIRONMENT === 'LOCAL' ? null : {
-                width: config.screenWidth,
-                height: config.screenHeight
-            },
-            // Return back to headless for netlify
-            headless: process.env.ENVIRONMENT == 'LOCAL' ? false : chromium.headless
-        });
-        this.defaultPage = (await this.browser.pages())[0];
-        await this.defaultPage.goto(config.baseURL, {waitUntil: 'networkidle0'})
-        await this.defaultPage.waitForNetworkIdle();
-    }
-
-    public async close() {
-        if (this.browser) {
-            let pages = await this.browser.pages();
-            await Promise.all(pages.map((page: { close: () => any; }) => page.close()));
-            await this.browser.close();
-        }
-    }
-
-    public async run(event: any, callback: any, featureName = 'Test feature', scenarioName = 'Test scenario', uploadModel?: UploadModel, close?: boolean) {
-        try {
-            if (uploadModel === undefined) uploadModel = auxta.getUploadModel();
-            if (close === undefined) close = Puppeteer.setupHeader(event, uploadModel)
-            let screenshotBuffer: Buffer | undefined;
-            let errMessage: any;
-            let statusCode: number = 200;
-
-            let consoleStack: any[] = [];
-            try {
-                await log.push('When', `Starting puppeteer process`, StatusOfStep.PASSED);
-                await this.startBrowser()
-                this.defaultPage.on('console', message =>
-                    consoleStack.push(`${message.type().substr(0, 3).toUpperCase()} ${message.text()}`))
-                    .on('pageerror', ({message}) => consoleStack.push(message))
-                    .on('response', response =>
-                        consoleStack.push(`${response.status()} ${response.url()}`))
-                    .on('requestfailed', request =>
-                        consoleStack.push(`${request.failure() !== null ? request.failure()?.errorText : ""} ${request.url()}`))
-                await callback(event)
-                log.push('When', `Finished puppeteer process`, StatusOfStep.PASSED);
-            } catch (err) {
-                console.log("Error", err);
-                errMessage = err;
-                statusCode = 500;
-                screenshotBuffer = await captureScreenshot();
-                log.push('When', `Finished puppeteer process`, StatusOfStep.FAILED);
-                await postNotificationsOnFail(uploadModel)
-            }
-            let url = this.defaultPage.url();
-            if (close) await this.close();
-
-            await onTestEnd(uploadModel, featureName, scenarioName, statusCode, screenshotBuffer, !errMessage ? undefined : {
-                currentPageUrl: url,
-                console: consoleStack,
-                error: errMessage
-            });
-        } catch (e) {
-            console.log("Lib error:", e);
-        } finally {
-            log.clear();
-        }
-    }
-
-    public async runRPA(event: any, callback: any, close?: boolean) {
-        let errMessage: any;
-        try {
-            if (close === undefined) {
-                if (event.queryStringParameters.close) {
-                    close = event.queryStringParameters.close === "true";
-                } else {
-                    close = true
-                }
-            }
-            let consoleStack: any[] = [];
-            try {
-                await log.push('When', `Starting puppeteer process`, StatusOfStep.PASSED);
-                await this.startBrowser()
-                this.defaultPage.on('console', message =>
-                    consoleStack.push(`${message.type().substr(0, 3).toUpperCase()} ${message.text()}`))
-                    .on('pageerror', ({message}) => consoleStack.push(message))
-                    .on('response', response =>
-                        consoleStack.push(`${response.status()} ${response.url()}`))
-                    .on('requestfailed', request =>
-                        consoleStack.push(`${request.failure() !== null ? request.failure()?.errorText : ""} ${request.url()}`))
-                await callback(event)
-                log.push('When', `Finished puppeteer process`, StatusOfStep.PASSED);
-            } catch (err) {
-                errMessage = err;
-                log.push('When', `Finished puppeteer process`, StatusOfStep.FAILED);
-                return errMessage;
-            }
-            if (close) await this.close();
-        } catch (e) {
-            console.log("Lib error:", e);
-        } finally {
-            log.clear();
-        }
-        return true;
-    }
-
-    private static setupHeader(event: any, uploadModel: UploadModel) {
-        let close = true;
-        if (process.env.ENVIRONMENT !== 'LOCAL' && event.body) {
-            const body = JSON.parse(event.body)
-            uploadModel.reportId = body.reportId;
-            uploadModel.nextSuites = body.nextSuites;
-        } else if (event.queryStringParameters.close) {
-            close = event.queryStringParameters.close === "true";
-        }
-        return close;
-    }
-}
-
-export default new Puppeteer();