@dev-blinq/cucumber-js 1.0.98-dev → 1.0.98

package/lib/formatter/helpers/constants.d.ts

@@ -0,0 +1,44 @@
+export declare const LOCAL: {
+    SSO: string;
+    WORKSPACE: string;
+    RUNS: string;
+    STORAGE: string;
+};
+export declare const DEV: {
+    SSO: string;
+    WORKSPACE: string;
+    RUNS: string;
+    STORAGE: string;
+};
+export declare const PROD: {
+    SSO: string;
+    WORKSPACE: string;
+    RUNS: string;
+    STORAGE: string;
+};
+export declare const STAGE: {
+    SSO: string;
+    WORKSPACE: string;
+    RUNS: string;
+    STORAGE: string;
+};
+export declare const SERVICES_URI: {
+    SSO: string;
+    WORKSPACE: string;
+    RUNS: string;
+    STORAGE: string;
+};
+export declare enum ActionEvents {
+    record_scenario = "record_scenario",
+    download_editor = "download_editor",
+    launch_editor = "launch_editor",
+    click_start_recording = "click_start_recording",
+    click_run_scenario = "click_run_scenario",
+    publish_scenario = "publish_scenario",
+    click_ai_generate = "click_ai_generate",
+    click_run_all = "click_run_all",
+    click_open_vscode = "click_open_vscode",
+    error_open_vscode = "error_open_vscode",
+    cli_run_tests = "cli_run_tests",
+    upload_report = "upload_report"
+}

package/lib/formatter/helpers/constants.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActionEvents = exports.SERVICES_URI = exports.STAGE = exports.PROD = exports.DEV = exports.LOCAL = void 0;
+exports.LOCAL = {
+    SSO: 'http://localhost:5000/api/auth',
+    WORKSPACE: 'http://localhost:6000/api/workspace',
+    RUNS: 'http://localhost:5001/api/runs',
+    STORAGE: 'http://localhost:5050/api/storage',
+};
+exports.DEV = {
+    SSO: 'https://dev.api.blinq.io/api/auth',
+    WORKSPACE: 'https://dev.api.blinq.io/api/workspace',
+    RUNS: 'https://dev.api.blinq.io/api/runs',
+    STORAGE: 'https://dev.api.blinq.io/api/storage',
+};
+exports.PROD = {
+    SSO: 'https://api.blinq.io/api/auth',
+    WORKSPACE: 'https://api.blinq.io/api/workspace',
+    RUNS: 'https://api.blinq.io/api/runs',
+    STORAGE: 'https://api.blinq.io/api/storage',
+};
+exports.STAGE = {
+    SSO: 'https://stage.api.blinq.io/api/auth',
+    WORKSPACE: 'https://stage.api.blinq.io/api/workspace',
+    RUNS: 'https://stage.api.blinq.io/api/runs',
+    STORAGE: 'https://stage.api.blinq.io/api/storage',
+};
+exports.SERVICES_URI = process.env.NODE_ENV_BLINQ === 'local'
+    ? exports.LOCAL // eslint-disable-line
+    : process.env.NODE_ENV_BLINQ === 'dev'
+        ? exports.DEV // eslint-disable-line
+        : process.env.NODE_ENV_BLINQ === 'stage'
+            ? exports.STAGE
+            : exports.PROD; // eslint-disable-line
+var ActionEvents;
+(function (ActionEvents) {
+    ActionEvents["record_scenario"] = "record_scenario";
+    ActionEvents["download_editor"] = "download_editor";
+    ActionEvents["launch_editor"] = "launch_editor";
+    ActionEvents["click_start_recording"] = "click_start_recording";
+    ActionEvents["click_run_scenario"] = "click_run_scenario";
+    ActionEvents["publish_scenario"] = "publish_scenario";
+    ActionEvents["click_ai_generate"] = "click_ai_generate";
+    ActionEvents["click_run_all"] = "click_run_all";
+    ActionEvents["click_open_vscode"] = "click_open_vscode";
+    ActionEvents["error_open_vscode"] = "error_open_vscode";
+    ActionEvents["cli_run_tests"] = "cli_run_tests";
+    ActionEvents["upload_report"] = "upload_report";
+})(ActionEvents = exports.ActionEvents || (exports.ActionEvents = {}));
+//# sourceMappingURL=constants.js.map

package/lib/formatter/helpers/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/formatter/helpers/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,KAAK,GAAG;IACnB,GAAG,EAAE,gCAAgC;IACrC,SAAS,EAAE,qCAAqC;IAChD,IAAI,EAAE,gCAAgC;IACtC,OAAO,EAAE,mCAAmC;CAC7C,CAAA;AACY,QAAA,GAAG,GAAG;IACjB,GAAG,EAAE,mCAAmC;IACxC,SAAS,EAAE,wCAAwC;IACnD,IAAI,EAAE,mCAAmC;IACzC,OAAO,EAAE,sCAAsC;CAChD,CAAA;AACY,QAAA,IAAI,GAAG;IAClB,GAAG,EAAE,+BAA+B;IACpC,SAAS,EAAE,oCAAoC;IAC/C,IAAI,EAAE,+BAA+B;IACrC,OAAO,EAAE,kCAAkC;CAC5C,CAAA;AACY,QAAA,KAAK,GAAG;IACnB,GAAG,EAAE,qCAAqC;IAC1C,SAAS,EAAE,0CAA0C;IACrD,IAAI,EAAE,qCAAqC;IAC3C,OAAO,EAAE,wCAAwC;CAClD,CAAA;AAEY,QAAA,YAAY,GACvB,OAAO,CAAC,GAAG,CAAC,cAAc,KAAK,OAAO;IACpC,CAAC,CAAC,aAAK,CAAC,sBAAsB;IAC9B,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,KAAK,KAAK;QACtC,CAAC,CAAC,WAAG,CAAC,sBAAsB;QAC5B,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,KAAK,OAAO;YACxC,CAAC,CAAC,aAAK;YACP,CAAC,CAAC,YAAI,CAAA,CAAC,sBAAsB;AAEjC,IAAY,YAaX;AAbD,WAAY,YAAY;IACtB,mDAAmC,CAAA;IACnC,mDAAmC,CAAA;IACnC,+CAA+B,CAAA;IAC/B,+DAA+C,CAAA;IAC/C,yDAAyC,CAAA;IACzC,qDAAqC,CAAA;IACrC,uDAAuC,CAAA;IACvC,+CAA+B,CAAA;IAC/B,uDAAuC,CAAA;IACvC,uDAAuC,CAAA;IACvC,+CAA+B,CAAA;IAC/B,+CAA+B,CAAA;AACjC,CAAC,EAbW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAavB","sourcesContent":["export const LOCAL = {\n  SSO: 'http://localhost:5000/api/auth',\n  WORKSPACE: 'http://localhost:6000/api/workspace',\n  RUNS: 'http://localhost:5001/api/runs',\n  STORAGE: 'http://localhost:5050/api/storage',\n}\nexport const DEV = {\n  SSO: 'https://dev.api.blinq.io/api/auth',\n  WORKSPACE: 'https://dev.api.blinq.io/api/workspace',\n  RUNS: 'https://dev.api.blinq.io/api/runs',\n  STORAGE: 'https://dev.api.blinq.io/api/storage',\n}\nexport const PROD = {\n  SSO: 'https://api.blinq.io/api/auth',\n  WORKSPACE: 'https://api.blinq.io/api/workspace',\n  RUNS: 'https://api.blinq.io/api/runs',\n  STORAGE: 'https://api.blinq.io/api/storage',\n}\nexport const STAGE = {\n  SSO: 'https://stage.api.blinq.io/api/auth',\n  WORKSPACE: 'https://stage.api.blinq.io/api/workspace',\n  RUNS: 'https://stage.api.blinq.io/api/runs',\n  STORAGE: 'https://stage.api.blinq.io/api/storage',\n}\n\nexport const SERVICES_URI =\n  process.env.NODE_ENV_BLINQ === 'local'\n    ? LOCAL // eslint-disable-line\n    : process.env.NODE_ENV_BLINQ === 'dev'\n    ? DEV // eslint-disable-line\n    : process.env.NODE_ENV_BLINQ === 'stage'\n    ? STAGE\n    : PROD // eslint-disable-line\n\nexport enum ActionEvents {\n  record_scenario = 'record_scenario',\n  download_editor = 'download_editor',\n  launch_editor = 'launch_editor',\n  click_start_recording = 'click_start_recording',\n  click_run_scenario = 'click_run_scenario',\n  publish_scenario = 'publish_scenario',\n  click_ai_generate = 'click_ai_generate',\n  click_run_all = 'click_run_all',\n  click_open_vscode = 'click_open_vscode',\n  error_open_vscode = 'error_open_vscode',\n  cli_run_tests = 'cli_run_tests',\n  upload_report = 'upload_report',\n}\n"]}

package/lib/formatter/helpers/report_generator.d.ts

@@ -48,7 +48,6 @@ type JsonCommand = {
     text: string;
     screenshotId?: string;
     result: JsonCommandResult;
-    webLog?: webLog[];
     netWorkLog?: any[];
 };
 type webLog = {
@@ -63,7 +62,10 @@ export type JsonStep = {
     text: string;
     commands: JsonCommand[];
     result: JsonStepResult;
+    webLog: webLog[];
+    networkData: any[];
     data?: any;
+    ariaSnapshot: string;
 };
 export type RetrainStats = {
     result: JsonTestResult;
@@ -80,8 +82,13 @@ export type JsonTestProgress = {
     steps: JsonStep[];
     result: JsonTestResult;
     retrainStats?: RetrainStats;
+    initialAriaSnapshot?: string;
     webLog: any;
     networkLog: any;
+    env: {
+        name: string;
+        baseUrl: string;
+    };
 };
 export type JsonReport = {
     testCases: JsonTestProgress[];
@@ -91,6 +98,12 @@ export type JsonReport = {
         baseUrl: string;
     };
 };
+interface MetaMessage extends messages.Meta {
+    runName: string;
+}
+interface EnvelopeWithMetaMessage extends messages.Envelope {
+    meta: MetaMessage;
+}
 export default class ReportGenerator {
     private report;
     private gherkinDocumentMap;
@@ -103,8 +116,14 @@ export default class ReportGenerator {
     private scenarioIterationCountMap;
     private logs;
     private networkLog;
+    private stepLogs;
+    private stepNetworkLogs;
+    private runName;
+    private ariaSnapshot;
+    private initialAriaSnapshot;
     reportFolder: null | string;
-    handleMessage(envelope: messages.Envelope): void;
+    private uploadService;
+    handleMessage(envelope: EnvelopeWithMetaMessage | messages.Envelope, reRunId?: string): Promise<any>;
     getReport(): JsonReport;
     private handleParseError;
     private onGherkinDocument;
@@ -117,10 +136,13 @@ export default class ReportGenerator {
     private onTestCaseStarted;
     private onTestStepStarted;
     private onAttachment;
+    private getFailedTestStepResult;
     private onTestStepFinished;
     getLogFileContent(): any;
     private getTestCaseResult;
     private onTestCaseFinished;
+    private uploadTestCase;
+    private writeTestCaseReportToDisk;
     private onTestRunFinished;
 }
 export {};

package/lib/formatter/helpers/report_generator.js

@@ -1,10 +1,48 @@
 "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 (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 };
 };
+var _a, _b;
 Object.defineProperty(exports, "__esModule", { value: true });
+const messages = __importStar(require("@cucumber/messages"));
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
+const upload_serivce_1 = require("./upload_serivce");
+const fs_extra_1 = require("fs-extra");
+const URL = process.env.NODE_ENV_BLINQ === 'dev'
+    ? 'https://dev.api.blinq.io/api/runs'
+    : process.env.NODE_ENV_BLINQ === 'local'
+        ? 'http://localhost:5001/api/runs'
+        : process.env.NODE_ENV_BLINQ === 'stage'
+            ? 'https://stage.api.blinq.io/api/runs'
+            : 'https://api.blinq.io/api/runs';
+const REPORT_SERVICE_URL = (_a = process.env.REPORT_SERVICE_URL) !== null && _a !== void 0 ? _a : URL;
+const BATCH_SIZE = 10;
+const MAX_RETRIES = 3;
+const REPORT_SERVICE_TOKEN = (_b = process.env.TOKEN) !== null && _b !== void 0 ? _b : process.env.REPORT_SERVICE_TOKEN;
 class ReportGenerator {
     constructor() {
         this.report = {
@@ -27,9 +65,18 @@ class ReportGenerator {
         this.scenarioIterationCountMap = new Map();
         this.logs = [];
         this.networkLog = [];
+        this.stepLogs = [];
+        this.stepNetworkLogs = [];
+        this.runName = '';
+        this.ariaSnapshot = '';
+        this.initialAriaSnapshot = '';
         this.reportFolder = null;
+        this.uploadService = new upload_serivce_1.RunUploadService(REPORT_SERVICE_URL, REPORT_SERVICE_TOKEN);
     }
-    handleMessage(envelope) {
+    async handleMessage(envelope, reRunId) {
+        if (envelope.meta && 'runName' in envelope.meta) {
+            this.runName = envelope.meta.runName;
+        }
         const type = Object.keys(envelope)[0];
         switch (type) {
             // case "meta": { break}
@@ -83,8 +130,7 @@ class ReportGenerator {
             }
             case 'testCaseFinished': {
                 const testCaseFinished = envelope[type];
-                this.onTestCaseFinished(testCaseFinished);
-                break;
+                return await this.onTestCaseFinished(testCaseFinished, reRunId);
             }
             // case "hook": { break} // After Hook
             case 'testRunFinished': {
@@ -220,6 +266,10 @@ class ReportGenerator {
                 result: {
                     status: 'UNKNOWN',
                 },
+                networkData: [],
+                webLog: [],
+                data: {},
+                ariaSnapshot: this.ariaSnapshot,
             });
             return this.stepReportMap.get(pickleStep.id);
         });
@@ -236,6 +286,10 @@ class ReportGenerator {
             },
             webLog: [],
             networkLog: [],
+            env: {
+                name: this.report.env.name,
+                baseUrl: this.report.env.baseUrl,
+            },
         });
         this.report.testCases.push(this.testCaseReportMap.get(id));
     }
@@ -258,19 +312,34 @@ class ReportGenerator {
             this.reportFolder = body.replaceAll('\\', '/');
             return;
         }
+        if (mediaType === 'application/json+snapshot-before') {
+            this.initialAriaSnapshot = body;
+            return;
+        }
+        if (mediaType === 'application/json+snapshot-after') {
+            this.ariaSnapshot = body;
+            return;
+        }
         if (mediaType === 'application/json+env') {
             const data = JSON.parse(body);
             this.report.env = data;
+            this.report.testCases.map((testCase) => {
+                testCase.env = data;
+                return testCase;
+            });
         }
         if (mediaType === 'application/json+log') {
             const log = JSON.parse(body);
-            if (this.logs.length < 1000)
+            if (this.logs.length < 1000) {
                 this.logs.push(log);
+                this.stepLogs.push(log);
+            }
         }
         if (mediaType === 'application/json+network') {
             const networkLog = JSON.parse(body);
             if (this.networkLog.length < 1000)
                 this.networkLog.push(networkLog);
+            this.stepNetworkLogs.push(networkLog);
         }
         const testStep = this.testStepMap.get(testStepId);
         if (testStep.pickleStepId === undefined)
@@ -281,6 +350,24 @@ class ReportGenerator {
             stepProgess.commands.push(command);
         }
     }
+    getFailedTestStepResult({ commands, startTime, endTime, result, }) {
+        for (const command of commands) {
+            if (command.result.status === 'FAILED') {
+                return {
+                    status: 'FAILED',
+                    message: command.result.message,
+                    startTime,
+                    endTime,
+                };
+            }
+        }
+        return {
+            status: 'FAILED',
+            startTime,
+            endTime,
+            message: result.message,
+        };
+    }
     onTestStepFinished(testStepFinished) {
         const { testStepId, testStepResult, timestamp } = testStepFinished;
         const testStep = this.testStepMap.get(testStepId);
@@ -290,6 +377,25 @@ class ReportGenerator {
             }
             return;
         }
+        if (testStepResult.status === 'UNDEFINED') {
+            const step = this.stepReportMap.get(testStep.pickleStepId);
+            const stepName = step ? step.keyword + ' ' + step.text : 'Undefined step';
+            const undefinedCommand = {
+                testStepId: testStepId,
+                body: JSON.stringify({
+                    type: 'error',
+                    text: 'Undefined step: ' + stepName,
+                    result: {
+                        status: 'FAILED',
+                        startTime: this.getTimeStamp(timestamp),
+                        endTime: this.getTimeStamp(timestamp),
+                    },
+                }),
+                mediaType: 'application/json',
+                contentEncoding: messages.AttachmentContentEncoding.IDENTITY,
+            };
+            this.onAttachment(undefinedCommand);
+        }
         const stepProgess = this.stepReportMap.get(testStep.pickleStepId);
         const prevStepResult = stepProgess.result;
         let data = {};
@@ -305,13 +411,27 @@ class ReportGenerator {
         catch (error) {
             console.log('Error reading data.json');
         }
-        stepProgess.result = {
-            status: testStepResult.status,
-            startTime: prevStepResult.startTime,
-            endTime: this.getTimeStamp(timestamp),
-            message: testStepResult.message,
-            // exception: testStepResult.exception,
-        };
+        if (testStepResult.status === 'FAILED') {
+            stepProgess.result = this.getFailedTestStepResult({
+                commands: stepProgess.commands,
+                startTime: prevStepResult.startTime,
+                endTime: this.getTimeStamp(timestamp),
+                result: testStepResult,
+            });
+        }
+        else {
+            stepProgess.result = {
+                status: testStepResult.status,
+                startTime: prevStepResult.startTime,
+                endTime: this.getTimeStamp(timestamp),
+            };
+        }
+        stepProgess.webLog = this.stepLogs;
+        stepProgess.networkData = this.stepNetworkLogs;
+        stepProgess.ariaSnapshot = this.ariaSnapshot;
+        this.ariaSnapshot = '';
+        this.stepNetworkLogs = [];
+        this.stepLogs = [];
         if (Object.keys(data).length > 0) {
             stepProgess.data = data;
         }
@@ -362,21 +482,93 @@ class ReportGenerator {
             status: 'PASSED',
         };
     }
-    onTestCaseFinished(testCaseFinished) {
+    async onTestCaseFinished(testCaseFinished, reRunId) {
         const { testCaseStartedId, timestamp } = testCaseFinished;
         const testProgress = this.testCaseReportMap.get(testCaseStartedId);
         const prevResult = testProgress.result;
         const steps = Object.values(testProgress.steps);
         const result = this.getTestCaseResult(steps);
+        const endTime = this.getTimeStamp(timestamp);
         testProgress.result = {
             ...result,
             startTime: prevResult.startTime,
-            endTime: this.getTimeStamp(timestamp),
+            endTime,
         };
         testProgress.webLog = this.logs;
         testProgress.networkLog = this.networkLog;
+        testProgress.initialAriaSnapshot = this.initialAriaSnapshot;
+        this.initialAriaSnapshot = '';
         this.networkLog = [];
         this.logs = [];
+        if (process.env.TESTCASE_REPORT_FOLDER_PATH) {
+            this.reportFolder = process.env.TESTCASE_REPORT_FOLDER_PATH;
+            if (!fs_1.default.existsSync(this.reportFolder)) {
+                fs_1.default.mkdirSync(this.reportFolder);
+            }
+            const reportFilePath = path_1.default.join(this.reportFolder, `${endTime}_${testProgress.scenarioName}.json`);
+            (0, fs_extra_1.writeFileSync)(reportFilePath, JSON.stringify(testProgress, null, 2));
+            return undefined;
+        }
+        else {
+            return await this.uploadTestCase(testProgress, reRunId);
+        }
+    }
+    async uploadTestCase(testCase, rerunId) {
+        let runId = '';
+        let projectId = '';
+        if (!process.env.UPLOADING_TEST_CASE) {
+            process.env.UPLOADING_TEST_CASE = '[]';
+        }
+        const anyRemArr = JSON.parse(process.env.UPLOADING_TEST_CASE);
+        const randomID = Math.random().toString(36).substring(7);
+        anyRemArr.push(randomID);
+        let data;
+        process.env.UPLOADING_TEST_CASE = JSON.stringify(anyRemArr);
+        try {
+            if (process.env.RUN_ID &&
+                process.env.PROJECT_ID &&
+                !process.env.IGNORE_ENV_VARIABLES) {
+                runId = process.env.RUN_ID;
+                projectId = process.env.PROJECT_ID;
+            }
+            else {
+                const runDoc = await this.uploadService.createRunDocument(this.runName);
+                runId = runDoc._id;
+                projectId = runDoc.project_id;
+                if (!process.env.IGNORE_ENV_VARIABLES) {
+                    process.env.RUN_ID = runId;
+                    process.env.PROJECT_ID = projectId;
+                }
+            }
+            data = await this.uploadService.uploadTestCase(testCase, runId, projectId, this.reportFolder, rerunId);
+            this.writeTestCaseReportToDisk(testCase);
+        }
+        catch (e) {
+            console.error('Error uploading test case:', e);
+        }
+        finally {
+            const arrRem = JSON.parse(process.env.UPLOADING_TEST_CASE);
+            arrRem.splice(arrRem.indexOf(randomID), 1);
+            process.env.UPLOADING_TEST_CASE = JSON.stringify(arrRem);
+        }
+        return data ? data : null;
+    }
+    writeTestCaseReportToDisk(testCase) {
+        try {
+            let i = 0;
+            while (fs_1.default.existsSync(path_1.default.join(this.reportFolder, `${i}`))) {
+                i++;
+            }
+            fs_1.default.mkdirSync(path_1.default.join(this.reportFolder, `${i}`));
+            //exclude network log from the saved report
+            const networkLog = testCase.networkLog;
+            delete testCase.networkLog;
+            fs_1.default.writeFileSync(path_1.default.join(this.reportFolder, `${i}`, `report.json`), JSON.stringify(testCase, null, 2));
+            fs_1.default.writeFileSync(path_1.default.join(this.reportFolder, `${i}`, `network.json`), JSON.stringify(networkLog, null, 2));
+        }
+        catch (error) {
+            console.error('Error writing test case report to disk:', error);
+        }
     }
     onTestRunFinished(testRunFinished) {
         const { timestamp, success, message } = testRunFinished;