@dev-blinq/cucumber-js 1.0.117-dev → 1.0.117-stage

package/lib/formatter/helpers/report_generator.js

@@ -1,19 +1,50 @@
 "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");
+// type JsonException = messages.Exception
+const object_path_1 = __importDefault(require("object-path"));
 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';
+            : process.env.NODE_ENV_BLINQ === 'prod'
+                ? 'https://api.blinq.io/api/runs'
+                : !process.env.NODE_ENV_BLINQ
+                    ? 'https://api.blinq.io/api/runs'
+                    : `${process.env.NODE_ENV_BLINQ}/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;
@@ -40,12 +71,20 @@ class ReportGenerator {
         this.scenarioIterationCountMap = new Map();
         this.logs = [];
         this.networkLog = [];
+        this.stepLogs = [];
+        this.stepNetworkLogs = [];
         this.runName = '';
+        this.ariaSnapshot = '';
+        this.initialAriaSnapshot = '';
+        this.testCaseLog = [];
+        this.loggingOverridden = false; // Flag to track if logging is overridden
         this.reportFolder = null;
         this.uploadService = new upload_serivce_1.RunUploadService(REPORT_SERVICE_URL, REPORT_SERVICE_TOKEN);
+        this.retryTestCaseId = null;
+        this.retryCount = 3;
     }
-    async handleMessage(envelope) {
-        if (envelope.meta && envelope.meta.runName) {
+    async handleMessage(envelope, reRunId) {
+        if (envelope.meta && 'runName' in envelope.meta) {
             this.runName = envelope.meta.runName;
         }
         const type = Object.keys(envelope)[0];
@@ -72,14 +111,35 @@ class ReportGenerator {
             case 'testRunStarted': {
                 const testRunStarted = envelope[type];
                 this.onTestRunStarted(testRunStarted);
+                await this.uploadService.createStatus('running');
                 break;
             }
             case 'testCase': {
                 const testCase = envelope[type];
+                // Initialize the log storage
+                this.testCaseLog = [];
+                if (!this.loggingOverridden) {
+                    this.loggingOverridden = true;
+                    // Store the original process.stdout.write, and process.stderr.write
+                    const originalStdoutWrite = process.stdout.write;
+                    const originalStderrWrite = process.stderr.write;
+                    // Override process.stdout.write
+                    process.stdout.write = (chunk, ...args) => {
+                        this.testCaseLog.push(chunk.toString());
+                        return originalStdoutWrite.call(process.stdout, chunk, ...args);
+                    };
+                    // Override process.stderr.write
+                    process.stderr.write = (chunk, ...args) => {
+                        this.testCaseLog.push(chunk.toString());
+                        return originalStderrWrite.call(process.stderr, chunk, ...args);
+                    };
+                }
+                // Call the onTestCase method
                 this.onTestCase(testCase);
                 break;
             }
             case 'testCaseStarted': {
+                this.retryTestCaseId = envelope[type].retryTestCaseId;
                 const testCaseStarted = envelope[type];
                 this.onTestCaseStarted(testCaseStarted);
                 break;
@@ -101,13 +161,18 @@ class ReportGenerator {
             }
             case 'testCaseFinished': {
                 const testCaseFinished = envelope[type];
-                await this.onTestCaseFinished(testCaseFinished);
-                break;
+                let reRunIdFinal = this.retryTestCaseId;
+                if (reRunId) {
+                    reRunIdFinal = reRunId;
+                }
+                // Call the onTestCaseFinished method
+                const result = await this.onTestCaseFinished(testCaseFinished, reRunIdFinal);
+                return result;
             }
             // case "hook": { break} // After Hook
             case 'testRunFinished': {
                 const testRunFinished = envelope[type];
-                this.onTestRunFinished(testRunFinished);
+                await this.onTestRunFinished(testRunFinished);
                 break;
             }
             // case "parameterType" : { break}
@@ -238,6 +303,10 @@ class ReportGenerator {
                 result: {
                     status: 'UNKNOWN',
                 },
+                networkData: [],
+                webLog: [],
+                data: {},
+                ariaSnapshot: this.ariaSnapshot,
             });
             return this.stepReportMap.get(pickleStep.id);
         });
@@ -280,6 +349,14 @@ 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;
@@ -290,13 +367,16 @@ class ReportGenerator {
         }
         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)
@@ -306,16 +386,102 @@ class ReportGenerator {
             const command = JSON.parse(body);
             stepProgess.commands.push(command);
         }
+        else if (mediaType === 'application/json+trace') {
+            const data = JSON.parse(body);
+            stepProgess.traceFilePath = data.traceFilePath;
+        }
+        if (mediaType === 'application/json+bruno') {
+            try {
+                const data = JSON.parse(body);
+                stepProgess.brunoData = data;
+            }
+            catch (error) {
+                console.error('Error parsing bruno data:', error);
+            }
+        }
+        if (mediaType === 'application/json+intercept-results') {
+            try {
+                const data = JSON.parse(body);
+                stepProgess.interceptResults = data;
+            }
+            catch (error) {
+                console.error('Error parsing intercept results:', error);
+            }
+        }
+    }
+    getFailedTestStepResult({ commands, startTime, endTime, result, stepName, }) {
+        for (const command of commands) {
+            if (command.result.status === 'FAILED') {
+                return {
+                    status: 'FAILED',
+                    message: command.result.message,
+                    name: stepName,
+                    startTime,
+                    endTime,
+                };
+            }
+        }
+        return {
+            status: 'FAILED',
+            startTime,
+            endTime,
+            message: result.message,
+            name: stepName,
+        };
     }
     onTestStepFinished(testStepFinished) {
         const { testStepId, testStepResult, timestamp } = testStepFinished;
         const testStep = this.testStepMap.get(testStepId);
         if (testStep.pickleStepId === undefined) {
             if (testStepResult.status === 'FAILED') {
+                const testCase = this.testCaseReportMap.get(testStepFinished.testCaseStartedId);
+                const type = testCase.steps[0].result.status === 'UNKNOWN' ? 'Before' : 'After';
+                const hookStep = {
+                    ariaSnapshot: null,
+                    commands: [],
+                    keyword: type,
+                    data: {},
+                    networkData: [],
+                    result: {
+                        status: 'FAILED',
+                        message: testStepResult.message,
+                        startTime: this.getTimeStamp(timestamp),
+                        endTime: this.getTimeStamp(timestamp),
+                    },
+                    text: 'Failed hook',
+                    type,
+                    webLog: [],
+                };
+                if (type === 'Before') {
+                    testCase.steps = [hookStep, ...testCase.steps];
+                }
+                else {
+                    testCase.steps = [...testCase.steps, hookStep];
+                }
+                this.testCaseReportMap.set(testStepFinished.testCaseStartedId, testCase);
                 console.error(`Before/After hook failed with message: ${testStepResult.message}`);
             }
             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 = {};
@@ -331,16 +497,74 @@ 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,
+                stepName: stepProgess.text,
+            });
+        }
+        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;
+            const id = testStepFinished.testCaseStartedId;
+            const parameters = this.testCaseReportMap.get(id).parameters;
+            const _parameters = {};
+            Object.keys(parameters).map((key) => {
+                var _a;
+                const valueParam = parameters[key].toString();
+                if (valueParam.startsWith('{{') && valueParam.endsWith('}}')) {
+                    const path = valueParam.slice(2, -2).split('.');
+                    let value = String((_a = object_path_1.default.get(data, path)) !== null && _a !== void 0 ? _a : valueParam);
+                    if (value) {
+                        if (value.startsWith('secret:')) {
+                            value = 'secret:****';
+                        }
+                        else if (value.startsWith('totp:')) {
+                            value = 'totp:****';
+                        }
+                        else if (value.startsWith('mask:')) {
+                            value = 'mask:****';
+                        }
+                        _parameters[key] = value;
+                    }
+                }
+                else {
+                    _parameters[key] = parameters[key];
+                }
+            });
+            this.report.testCases.find((testCase) => {
+                return testCase.id === id;
+            }).parameters = _parameters;
         }
+        // if (process.env.TESTCASE_REPORT_FOLDER_PATH) {
+        //   this.reportFolder = process.env.TESTCASE_REPORT_FOLDER_PATH
+        //   if (!fs.existsSync(this.reportFolder)) {
+        //     fs.mkdirSync(this.reportFolder)
+        //   }
+        //   const reportFilePath = path.join(
+        //     this.reportFolder,
+        //     `report.json`
+        //   )
+        //   writeFileSync(reportFilePath, JSON.stringify(this.report, null, 2))
+        //   return undefined
+        //   // } else {
+        //   // return await this.uploadTestCase(testProgress, reRunId)
+        // }
     }
     getLogFileContent() {
         let projectPath = process.cwd();
@@ -367,6 +591,12 @@ class ReportGenerator {
         }
     }
     getTestCaseResult(steps) {
+        if (steps[0] && steps[0].result.status === 'SKIPPED') {
+            return {
+                status: 'FAILED',
+                message: 'Test skipped due to failure in before hooks',
+            };
+        }
         for (const step of steps) {
             switch (step.result.status) {
                 case 'FAILED':
@@ -388,24 +618,79 @@ class ReportGenerator {
             status: 'PASSED',
         };
     }
-    async 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);
+        if (result.status === 'PASSED' && reRunId) {
+            this.uploadService.updateProjectAnalytics(process.env.PROJECT_ID);
+        }
+        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;
+        if (process.env.TRACE) {
+            testProgress.traceFileId = path_1.default.join(`trace-${testCaseStartedId}.zip`);
+        }
+        this.initialAriaSnapshot = '';
         this.networkLog = [];
         this.logs = [];
-        await this.uploadTestCase(testProgress);
+        if (this.testCaseLog &&
+            this.testCaseLog.length > 0 &&
+            !testProgress.logFileId) {
+            // Create the logs directory
+            const logsDir = path_1.default.join(this.reportFolder, 'editorLogs');
+            const fileName = `testCaseLog_${testCaseStartedId}.log`;
+            const filePath = path_1.default.join(logsDir, fileName);
+            // Ensure the logs directory exists
+            fs_1.default.mkdirSync(logsDir, { recursive: true });
+            // Write the logs to the file
+            fs_1.default.writeFileSync(filePath, this.testCaseLog.join('\n'), 'utf8');
+            // Store this ID in the testProgress object so it can be accessed later
+            testProgress.logFileId = testCaseStartedId;
+        }
+        this.testCaseLog = [];
+        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) {
+    async uploadTestCase(testCase, rerunId) {
+        let data = null;
+        for (let attempt = 1; attempt <= this.retryCount; attempt++) {
+            try {
+                data = await this.tryUpload(testCase, rerunId);
+                break;
+            }
+            catch (e) {
+                console.error(`Attempt ${attempt} to upload testcase failed:`, e);
+                if (attempt === this.retryCount) {
+                    console.error('All retry attempts failed, failed to upload testcase.');
+                }
+                else {
+                    const waitTime = 1000 * 2 ** (attempt - 1); //? exponential backoff: 1s, 2s, 4s...
+                    await new Promise((r) => setTimeout(r, waitTime));
+                }
+            }
+        }
+        return data;
+    }
+    async tryUpload(testCase, rerunId) {
         let runId = '';
         let projectId = '';
         if (!process.env.UPLOADING_TEST_CASE) {
@@ -416,21 +701,24 @@ class ReportGenerator {
         anyRemArr.push(randomID);
         process.env.UPLOADING_TEST_CASE = JSON.stringify(anyRemArr);
         try {
-            if (process.env.RUN_ID && process.env.PROJECT_ID) {
+            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);
+                const runDoc = await this.uploadService.createRunDocument(this.runName, testCase.env);
                 runId = runDoc._id;
                 projectId = runDoc.project_id;
-                process.env.RUN_ID = runId;
-                process.env.PROJECT_ID = projectId;
+                if (!process.env.IGNORE_ENV_VARIABLES) {
+                    process.env.RUN_ID = runId;
+                    process.env.PROJECT_ID = projectId;
+                }
             }
-            await this.uploadService.uploadTestCase(testCase, runId, projectId, this.reportFolder);
-        }
-        catch (e) {
-            console.error('Error uploading test case:', e);
+            const data = await this.uploadService.uploadTestCase(testCase, runId, projectId, this.reportFolder, rerunId);
+            this.writeTestCaseReportToDisk(testCase);
+            return data;
         }
         finally {
             const arrRem = JSON.parse(process.env.UPLOADING_TEST_CASE);
@@ -438,7 +726,30 @@ class ReportGenerator {
             process.env.UPLOADING_TEST_CASE = JSON.stringify(arrRem);
         }
     }
-    onTestRunFinished(testRunFinished) {
+    writeTestCaseReportToDisk(testCase) {
+        var _a;
+        const reportFolder = (_a = this.reportFolder) !== null && _a !== void 0 ? _a : process.env.TESTCASE_REPORT_FOLDER_PATH;
+        if (!reportFolder) {
+            console.error('Report folder is not defined');
+            return;
+        }
+        try {
+            let i = 0;
+            while (fs_1.default.existsSync(path_1.default.join(reportFolder, `${i}`))) {
+                i++;
+            }
+            fs_1.default.mkdirSync(path_1.default.join(reportFolder, `${i}`));
+            //exclude network log from the saved report
+            const networkLog = testCase.networkLog;
+            delete testCase.networkLog;
+            fs_1.default.writeFileSync(path_1.default.join(reportFolder, `${i}`, `report.json`), JSON.stringify(testCase, null, 2));
+            fs_1.default.writeFileSync(path_1.default.join(reportFolder, `${i}`, `network.json`), JSON.stringify(networkLog, null, 2));
+        }
+        catch (error) {
+            console.error('Error writing test case report to disk:', error);
+        }
+    }
+    async onTestRunFinished(testRunFinished) {
         const { timestamp, success, message } = testRunFinished;
         const prevResult = this.report.result;
         this.report.result = {
@@ -448,6 +759,7 @@ class ReportGenerator {
             message,
             // exception,
         };
+        await this.uploadService.createStatus(success ? 'passed' : 'failed');
     }
 }
 exports.default = ReportGenerator;