Merge pull request #295 from browserstack/CYP-1100-cli-changes-record-flag

rahuln-bs · web-flow · commit 5c9f47590c61 · 2022-04-27T13:07:04.000+05:30
Add code to output custom error messages on CLI from backend
diff --git a/bin/helpers/constants.js b/bin/helpers/constants.js
@@ -245,6 +245,8 @@ const REDACTED_AUTH =`auth: { "username": ${REDACTED}, "access_key": ${REDACTED}
 
 const SPEC_TIMEOUT_LIMIT = 120 // IN MINS 
 
+const CYPRESS_CUSTOM_ERRORS_TO_PRINT_KEY = "custom_errors_to_print";
+
 module.exports = Object.freeze({
   syncCLI,
   userMessages,
@@ -269,5 +271,6 @@ module.exports = Object.freeze({
   REDACTED_AUTH,
   REDACTED,
   BUILD_FAILED_EXIT_CODE,
-  SPEC_TIMEOUT_LIMIT
+  SPEC_TIMEOUT_LIMIT,
+  CYPRESS_CUSTOM_ERRORS_TO_PRINT_KEY
 });
diff --git a/bin/helpers/sync/specsSummary.js b/bin/helpers/sync/specsSummary.js
@@ -1,4 +1,5 @@
 const logger = require("../logger").syncCliLogger;
+const winstonlogger = require("../logger").winstonLogger;
 
 /**
  *
@@ -16,7 +17,7 @@ const logger = require("../logger").syncCliLogger;
 //   {specName: 'spec8.alias.js', status: 'Skipped', combination: 'Win 10 / Chrome 78', sessionId: '3d3rdf3r...'}
 // ]
 //
-let printSpecsRunSummary = (data, machines) => {
+let printSpecsRunSummary = (data, machines, customErrorsToPrint) => {
   return new Promise((resolve, _reject) => {
     let summary = {
       total: 0,
@@ -32,6 +33,21 @@ let printSpecsRunSummary = (data, machines) => {
     logger.info(`Total tests: ${summary.total}, passed: ${summary.passed}, failed: ${summary.failed}, skipped: ${summary.skipped}`);
     logger.info(`Done in ${data.duration/1000} seconds using ${machines} machines\n`);
 
+    if (customErrorsToPrint && customErrorsToPrint.length > 0) {
+      for (const error of customErrorsToPrint) {
+        switch(error.level) {
+          case 'info':
+            winstonlogger.info(error.message);
+            break;
+          case 'error':
+            winstonlogger.error(error.message);
+            break;
+          default:
+            winstonlogger.warn(error.message);
+        }
+      }
+    }
+
     resolve(data.exitCode);
   })
 };
diff --git a/bin/helpers/sync/syncSpecsLogs.js b/bin/helpers/sync/syncSpecsLogs.js
@@ -13,8 +13,10 @@ let whileLoop = true, whileTries = config.retries, options, timeout = 3000, n =
 let specSummary = {
   "buildError": null,
   "specs": [],
-  "duration": null
+  "duration": null,
+  "customErrorsToPrint": []
 }
+
 let noWrap = false;
 let terminalWidth = (process.stdout.columns) * 0.9;
 let lineSeparator = Constants.syncCLI.DEFAULT_LINE_SEP;
@@ -166,18 +168,22 @@ let getStackTraceUrl = () => {
 let showSpecsStatus = (data) => {
   let specData = JSON.parse(data);
   specData.forEach(specDetails => {
-    if (specDetails == "created") {
-      return;
-    } else if (specDetails["stacktrace_url"]) {
-      specSummary.exitCode = Constants.BUILD_FAILED_EXIT_CODE;
-      specSummary.buildError = specDetails["stacktrace_url"]
-      winstonLogger.error(chalk.red(specDetails["message"]));
+    if (specDetails.type === Constants.CYPRESS_CUSTOM_ERRORS_TO_PRINT_KEY) {
+      addCustomErrorToPrint(specDetails);
     } else {
-      if(!buildStarted) {
-        buildStarted = true
-        printInitialLog();
+      if (specDetails == "created") {
+        return;
+      } else if (specDetails["stacktrace_url"]) {
+        specSummary.exitCode = Constants.BUILD_FAILED_EXIT_CODE;
+        specSummary.buildError = specDetails["stacktrace_url"]
+        winstonLogger.error(chalk.red(specDetails["message"]));
+      } else {
+        if(!buildStarted) {
+          buildStarted = true
+          printInitialLog();
+        }
+        printSpecData(JSON.parse(specDetails));
       }
-      printSpecData(JSON.parse(specDetails));
     }
   });
 }
@@ -200,6 +206,17 @@ let writeToTable = (combination, specName, status) => {
   stream.write([combination , ":", `${specName} ${status}`]);
 }
 
+let addCustomErrorToPrint = (error_object) => {
+  if (error_object["should_be_unique"]) {
+    for (const error of specSummary.customErrorsToPrint) {
+      if (error.id === error_object.id) {
+        return;
+      }
+    }
+  }
+  specSummary.customErrorsToPrint.push(error_object);
+}
+
 let addSpecToSummary = (specName, status, combination, session_id) => {
   // Format for part 3: {specName: 'spec1.failed.js', status: 'Failed', combination: 'Win 10 / Chrome 78', sessionId: '3d3rdf3r...'},
   specSummary["specs"].push({
diff --git a/bin/helpers/syncRunner.js b/bin/helpers/syncRunner.js
@@ -4,11 +4,15 @@ const syncSpecsLogs = require('./sync/syncSpecsLogs'),
   specsSummary = require('./sync/specsSummary');
 
 exports.pollBuildStatus = (bsConfig, buildDetails) => {
+  let customErrorsToPrint;
   return new Promise((resolve, reject) => {
     syncSpecsLogs.printSpecsStatus(bsConfig, buildDetails).then((data) => {
+      if(data.customErrorsToPrint && data.customErrorsToPrint.length > 0) {
+        customErrorsToPrint = data.customErrorsToPrint;
+      }
       return specDetails.failedSpecsDetails(data);
     }).then((data) => {
-      return specsSummary.printSpecsRunSummary(data, buildDetails.machines);
+      return specsSummary.printSpecsRunSummary(data, buildDetails.machines, customErrorsToPrint);
     }).then((successExitCode) => {
       resolve(successExitCode); // exit code 0
     }).catch((nonZeroExitCode) => {
diff --git a/test/unit/bin/helpers/sync/specSummary.js b/test/unit/bin/helpers/sync/specSummary.js
@@ -6,6 +6,7 @@ const chai = require("chai"),
 
 chai.use(chaiAsPromised);
 var logger = require("../../../../../bin/helpers/logger").syncCliLogger;
+var winstonLogger = require("../../../../../bin/helpers/logger").winstonLogger;
 var specSummary = require('../../../../../bin/helpers/sync/specsSummary');
 
 describe("printSpecsRunSummary", () => {
@@ -52,4 +53,36 @@ describe("printSpecsRunSummary", () => {
       loggerInfoSpy.restore();
     });
   });
+
+  context("with custom error data", () => {
+    let time = 6000,
+        machines = 2,
+        specs = [
+          {specName: 'spec2.name.js', status: 'Failed', combination: 'Win 10 / Chrome 78', sessionId: '3d3rdf3r...'},
+          {specName: 'spec2.name.js', status: 'Skipped', combination: 'Win 10 / Chrome 78', sessionId: '3d3rdf3r...'},
+          {specName: 'spec2.name.js', status: 'Failed', combination: 'Win 10 / Chrome 78', sessionId: '3d3rdf3r...'},
+          {specName: 'spec2.name.js', status: 'Passed', combination: 'Win 10 / Chrome 78', sessionId: '3d3rdf3r...'}
+        ],
+        data = {
+          specs: specs,
+          duration: time,
+          exitCode: 0
+        },
+        customErrorsToPrint = [
+          { id: "custom_error", type: "custom_errors_to_print", level: "warn", should_be_unique: true, message: "custom error message" }
+        ];
+
+    it('prints the custom error message along with build details', () => {
+      var loggerInfoSpy = sinon.spy(logger, 'info');
+      var loggerWarnSpy = sinon.spy(winstonLogger, 'warn');
+
+      specSummary.printSpecsRunSummary(data, machines, customErrorsToPrint);
+      sinon.assert.calledWith(loggerInfoSpy, 'Total tests: 4, passed: 1, failed: 2, skipped: 1');
+      sinon.assert.calledWith(loggerInfoSpy, `Done in ${time / 1000} seconds using ${machines} machines\n`);
+      sinon.assert.calledWith(loggerWarnSpy, `custom error message`);
+
+      loggerInfoSpy.restore();
+      loggerWarnSpy.restore();
+    });
+  });
 });
diff --git a/test/unit/bin/helpers/sync/syncSpecsLogs.js b/test/unit/bin/helpers/sync/syncSpecsLogs.js
@@ -87,6 +87,42 @@ describe("syncSpecsLogs", () => {
     });
   });
 
+  context("addCustomErrorToPrint", () => {
+    const addCustomErrorToPrint = syncSpecsLogs.__get__("addCustomErrorToPrint");
+    let specSummary = {
+      "buildError": null,
+      "specs": [],
+      "duration": null,
+      "customErrorsToPrint": [
+        { id: "custom_error_1", type: "custom_errors_to_print", level: "warn", should_be_unique: true, message: "custom error message" }
+      ]
+    }
+    const uniqueError = { id: "custom_error_1", type: "custom_errors_to_print", level: "warn", should_be_unique: true, message: "custom error message" };
+    const notUniqueError = { id: "custom_error_2", type: "custom_errors_to_print", level: "warn", should_be_unique: false, message: "custom error message" };
+
+    it('should add a new Error if its meant to be unique and not added to the error list', () => {
+      addCustomErrorToPrint(uniqueError);
+      expect(JSON.stringify(syncSpecsLogs.__get__("specSummary"))).to.equal(JSON.stringify(specSummary));
+    });
+
+    it('should not add a new Error if its meant to be unique and already added to the error list', () => {
+      addCustomErrorToPrint(uniqueError);
+      expect(JSON.stringify(syncSpecsLogs.__get__("specSummary"))).to.equal(JSON.stringify(specSummary));
+    });
+
+    it('should add a new Error if its not meant to be unique and not added to the error list', () => {
+      addCustomErrorToPrint(notUniqueError);
+      specSummary.customErrorsToPrint.push(notUniqueError);
+      expect(JSON.stringify(syncSpecsLogs.__get__("specSummary"))).to.equal(JSON.stringify(specSummary));
+    });
+
+    it('should not add a new Error if its not meant to not be unique and already added to the error list', () => {
+      addCustomErrorToPrint(notUniqueError);
+      specSummary.customErrorsToPrint.push(notUniqueError);
+      expect(JSON.stringify(syncSpecsLogs.__get__("specSummary"))).to.equal(JSON.stringify(specSummary));
+    });
+  });
+
   context("getTableConfig", () => {
     const getTableConfig = syncSpecsLogs.__get__("getTableConfig");
 
@@ -212,6 +248,23 @@ describe("syncSpecsLogs", () => {
       expect(printSpecData.calledOnce).to.be.true;
       expect(printInitialLog.calledOnce).to.be.true;
     });
+
+    it('should add custom error, print initial and spec details when spec related data is sent in polling response', () => {
+      let specResult = JSON.stringify({"path": "path"})
+      let customError = { id: "custom_error_1", type: "custom_errors_to_print", level: "warn", should_be_unique: true, message: "custom error message" }
+      syncSpecsLogs.__set__('buildStarted', false)
+      let data = JSON.stringify(["created", specResult, customError])
+      var printSpecData = sandbox.stub();
+      syncSpecsLogs.__set__('printSpecData', printSpecData);
+      var printInitialLog = sandbox.stub();
+      syncSpecsLogs.__set__('printInitialLog', printInitialLog);
+      var addCustomErrorToPrint = sandbox.stub();
+      syncSpecsLogs.__set__('addCustomErrorToPrint', addCustomErrorToPrint);
+      showSpecsStatus(data);
+      expect(printSpecData.calledOnce).to.be.true;
+      expect(printInitialLog.calledOnce).to.be.true;
+      expect(addCustomErrorToPrint.calledOnce).to.be.true;
+    });
   });
 
   context("printSpecsStatus", () => {
