Merge branch 'master' of github.com:roshan04/browserstack-cypress-cli into improving_instrumentation

Author: roshan04

bin/helpers/sync/failedSpecsDetails.js

@@ -38,10 +38,7 @@ let failedSpecsDetails = (data) => {
       if (spec.status && spec.status.toLowerCase() === 'failed' && !failedSpecs)
         failedSpecs = true;
 
-      let specStatus =
-        spec.status && spec.status.toLowerCase() === 'failed'
-          ? chalk.red(spec.status)
-          : chalk.yellow(spec.status);
+      let specStatus = getSpecStatus(spec.status)
       specData.push([
         spec.specName,
         specStatus,
@@ -79,4 +76,15 @@ let failedSpecsDetails = (data) => {
   });
 }
 
+let getSpecStatus = (specStatus) => {
+  switch(specStatus.toLowerCase()) {
+    case 'failed': return chalk.red(specStatus);
+    case 'pending':
+    case 'skipped':
+    case 'passed_with_skipped': return chalk.blueBright(specStatus);
+    default: return chalk.yellow(specStatus);
+  }
+}
+
 exports.failedSpecsDetails = failedSpecsDetails;
+exports.getSpecStatus = getSpecStatus;

bin/helpers/sync/specsSummary.js

@@ -23,14 +23,16 @@ let printSpecsRunSummary = (data, machines, customErrorsToPrint) => {
       total: 0,
       failed: 0,
       passed: 0,
-      skipped: 0
+      skipped: 0,
+      passed_with_skipped: 0,
+      pending: 0
     };
 
     data.specs.forEach((spec) => {
       specSummaryCount(summary, spec.status.toLowerCase());
     });
 
-    logger.info(`Total tests: ${summary.total}, passed: ${summary.passed}, failed: ${summary.failed}, skipped: ${summary.skipped}`);
+    logger.info(`Total tests: ${summary.total}, passed: ${summary.passed}, failed: ${summary.failed}, skipped: ${summary.skipped}, passed_with_skipped: ${summary.passed_with_skipped}, pending: ${summary.pending}`);
     logger.info(`Done in ${data.duration/1000} seconds using ${machines} machines\n`);
 
     if (customErrorsToPrint && customErrorsToPrint.length > 0) {
@@ -57,9 +59,15 @@ let specSummaryCount = (summary, status) => {
     case 'failed':
       summary.failed++;
       break;
+    case "passed_with_skipped":
+      summary.passed_with_skipped++;
+      break;
     case 'skipped':
       summary.skipped++;
       break;
+    case "pending":
+      summary.pending++;
+      break;
     case 'passed':
       summary.passed++;
       break;

bin/helpers/sync/syncSpecsLogs.js

@@ -201,13 +201,14 @@ let printInitialLog = () => {
 
 let printSpecData = (data) => {
   let combination = getCombinationName(data["spec"]);
-  let status = getStatus(data["spec"]["status"]);
-  writeToTable(combination, data["path"], status)
-  addSpecToSummary(data["path"], data["spec"]["status"], combination, data["session_id"])
+  let status = data["spec"]["status"];
+  let statusMark = getStatus(status);
+  writeToTable(combination, data["path"], status, statusMark)
+  addSpecToSummary(data["path"], status, combination, data["session_id"])
 }
 
-let writeToTable = (combination, specName, status) => {
-  stream.write([combination , ":", `${specName} ${status}`]);
+let writeToTable = (combination, specName, status, statusMark) => {
+  stream.write([combination , ":", `${specName} ${statusMark} [${status}]`]);
 }
 
 let addCustomErrorToPrint = (error_object) => {
@@ -241,6 +242,8 @@ let getStatus = (status) => {
       return chalk.green("✔");
     case "failed":
       return chalk.red("✘");
+    case "passed_with_skipped":
+      return chalk.blueBright("✔");
     default:
       return chalk.blue(`[${status}]`);
   }

test/unit/bin/helpers/sync/failedSpecDetails.js

@@ -1,7 +1,8 @@
 'use strict';
 const chai = require("chai"),
   expect = chai.expect,
-  chaiAsPromised = require("chai-as-promised");
+  chaiAsPromised = require("chai-as-promised"),
+  chalk = require('chalk');
 
 const sinon = require("sinon");
 chai.use(chaiAsPromised);
@@ -74,3 +75,36 @@ describe("failedSpecsDetails", () => {
     });
   });
 });
+
+describe("#getSpecStatus", () => {
+  
+  it("returns failed in red if specStatus is failed", () => {
+    let specStatus = "failed";
+    let response = chalk.red(specStatus);
+    expect(specDetails.getSpecStatus(specStatus)).to.eq(response);
+  });
+
+  it("returns passed_with_skipped in blueBright if specStatus is passed_with_skipped", () => {
+    let specStatus = "passed_with_skipped";
+    let response = chalk.blueBright(specStatus);
+    expect(specDetails.getSpecStatus(specStatus)).to.eq(response);
+  });
+
+  it("returns pending in blueBright if specStatus is pending", () => {
+    let specStatus = "pending";
+    let response = chalk.blueBright(specStatus);
+    expect(specDetails.getSpecStatus(specStatus)).to.eq(response);
+  });
+
+  it("returns skipped in blueBright if specStatus is skipped", () => {
+    let specStatus = "skipped";
+    let response = chalk.blueBright(specStatus);
+    expect(specDetails.getSpecStatus(specStatus)).to.eq(response);
+  });
+
+  it("returns other statuses in yellow if specStatus is other than something known", () => {
+    let specStatus = "xyz";
+    let response = chalk.yellow(specStatus);
+    expect(specDetails.getSpecStatus(specStatus)).to.eq(response);
+  });
+});

test/unit/bin/helpers/sync/specSummary.js

@@ -47,7 +47,7 @@ describe("printSpecsRunSummary", () => {
       var loggerInfoSpy = sinon.spy(logger, 'info');
 
       specSummary.printSpecsRunSummary(data, machines);
-      sinon.assert.calledWith(loggerInfoSpy, 'Total tests: 4, passed: 1, failed: 2, skipped: 1');
+      sinon.assert.calledWith(loggerInfoSpy, 'Total tests: 4, passed: 1, failed: 2, skipped: 1, passed_with_skipped: 0, pending: 0');
       sinon.assert.calledWith(loggerInfoSpy, `Done in ${time / 1000} seconds using ${machines} machines\n`);
 
       loggerInfoSpy.restore();
@@ -77,7 +77,7 @@ describe("printSpecsRunSummary", () => {
       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, 'Total tests: 4, passed: 1, failed: 2, skipped: 1, passed_with_skipped: 0, pending: 0');
       sinon.assert.calledWith(loggerInfoSpy, `Done in ${time / 1000} seconds using ${machines} machines\n`);
       sinon.assert.calledWith(loggerWarnSpy, `custom error message`);
 

test/unit/bin/helpers/sync/syncSpecsLogs.js

@@ -172,9 +172,9 @@ describe("syncSpecsLogs", () => {
       const stream = sandbox.stub();
       stream.write = sandbox.stub();
       syncSpecsLogs.__set__('stream', stream);
-      let combination = "Windows 10", path = "path", status = "passed";
-      writeToTable(combination, path, status);
-      sinon.assert.calledOnceWithExactly(stream.write, [combination , ":", `${path} ${status}`]);
+      let combination = "Windows 10", path = "path", status = "passed", statusMark = "passed";
+      writeToTable(combination, path, status, statusMark);
+      sinon.assert.calledOnceWithExactly(stream.write, [combination , ":", `${path} ${statusMark} [${status}]`]);
     });
   });