Merge branch 'sync-cli' of github.com:browserstack/browserstack-cypress-cli into CYP_442_sync_cli_part_1

Author: nagpalkaran95

bin/helpers/constants.js

@@ -1,9 +1,13 @@
+const syncCLI = {
+  FAILED_SPEC_DETAILS_COL_HEADER: ['Spec', 'Status', 'Browser', 'BrowserStack Session ID']
+};
+
 const userMessages = {
   BUILD_FAILED: "Build creation failed.",
   BUILD_CREATED: "Build created",
   BUILD_INFO_FAILED: "Failed to get build info.",
   BUILD_STOP_FAILED: "Failed to stop build.",
-  BUILD_REPORT_MESDSAGE: "See the entire build report here:",
+  BUILD_REPORT_MESSAGE: "See the entire build report here:",
   ZIP_UPLOADER_NOT_REACHABLE: "Could not reach to zip uploader.",
   ZIP_UPLOAD_FAILED: "Zip Upload failed.",
   CONFIG_FILE_CREATED: "BrowserStack Config File created, you can now run browserstack-cypress --config-file run",
@@ -95,6 +99,7 @@ const allowedFileTypes = ['js', 'json', 'txt', 'ts', 'feature', 'features', 'pdf
 const filesToIgnoreWhileUploading = ['node_modules/**', 'package-lock.json', 'package.json', 'browserstack-package.json', 'tests.zip', 'cypress.json']
 
 module.exports = Object.freeze({
+  syncCLI,
   userMessages,
   cliMessages,
   validationMessages,

bin/helpers/logger.js

@@ -21,6 +21,16 @@ const winstonLoggerParams = {
   ],
 };
 
+const winstonSyncCliLoggerParams = {
+  transports: [
+    new (winston.transports.Console)({
+      formatter: (options) => {
+        return  (options.message ? options.message : '');
+      }
+    }),
+  ]
+}
+
 const winstonFileLoggerParams = {
   transports: [
     new winston.transports.File({
@@ -31,3 +41,4 @@ const winstonFileLoggerParams = {
 
 exports.winstonLogger = new winston.Logger(winstonLoggerParams);
 exports.fileLogger = new winston.Logger(winstonFileLoggerParams);
+exports.syncCliLogger = new winston.Logger(winstonSyncCliLoggerParams);

bin/helpers/sync/failedSpecsDetails.js

@@ -0,0 +1,69 @@
+const tablePrinter = require('table'), // { table, getBorderCharacters }
+      chalk = require('chalk'),
+      Constants = require("../constants"),
+      logger = require("../logger").syncCliLogger;
+
+/**
+ *
+ * @param {Array.<{specName: string, status: string, combination: string, sessionId: string}>} data
+ * @returns {Promise.resolve || Promise.reject}
+ */
+// Example:
+// [
+//   {specName: 'spec1.failed.js', status: 'Failed', combination: 'Win 10 / Chrome 78', sessionId: '3d3rdf3r...'},
+//   {specName: 'spec2.name.js', status: 'Skipped', combination: 'Win 10 / Chrome 78', sessionId: '3d3rdf3r...'},
+//   {specName: 'spec3.network.js', status: 'Failed', combination: 'Win 10 / Chrome 78', sessionId: '3d3rdf3r...'},
+//   {specName: 'spec6.utils.js', status: 'Failed', combination: 'Win 10 / Chrome 78', sessionId: '3d3rdf3r...'},
+//   {specName: 'spec8.alias.js', status: 'Skipped', combination: 'Win 10 / Chrome 78', sessionId: '3d3rdf3r...'}
+// ]
+//
+let failedSpecsDetails = (data) => {
+  return new Promise((resolve, reject) => {
+    if (data.length === 0) resolve(0); // return if no failed/skipped tests.
+
+    let failedSpecs = false;
+    let specResultHeader = Constants.syncCLI.FAILED_SPEC_DETAILS_COL_HEADER.map((col) => {
+      return chalk.blueBright(col);
+    });
+
+    let specData = [specResultHeader]; // 2-D array
+
+    data.forEach((spec) => {
+      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);
+      specData.push([spec.specName, specStatus, spec.combination, spec.sessionId]);
+    });
+
+    let config = {
+      border: tablePrinter.getBorderCharacters('ramac'),
+      columns: {
+        0: { alignment: 'left' },
+        1: { alignment: 'left' },
+        2: { alignment: 'left' },
+        3: { alignment: 'left' },
+      },
+      /**
+      * @typedef {function} drawHorizontalLine
+      * @param {number} index
+      * @param {number} size
+      * @return {boolean}
+      */
+      drawHorizontalLine: (index, size) => {
+        return (index === 0 || index === 1 ||  index === size);
+      }
+    }
+
+    let result = tablePrinter.table(specData, config);
+
+    logger.info('Failed / skipped test report');
+    logger.info(result);
+
+    if (failedSpecs) reject(1); // specs failed, send exitCode as 1
+    resolve(0); // No Specs failed, maybe skipped, but not failed, send exitCode as 0
+  });
+}
+
+exports.failedSpecsDetails = failedSpecsDetails;

bin/helpers/syncRunner.js

@@ -1,30 +1,27 @@
 'use strict';
-const config = require("./config"),
-  logger = require("./logger").winstonLogger,
+const Config = require("./config"),
+  logger = require("./logger").syncCliLogger,
   Constants = require("./constants"),
   utils = require("./utils"),
-  request = require('request');
+  request = require('request'),
+  specDetails = require('./sync/failedSpecsDetails'),
+  { table, getBorderCharacters } = require('table'),
+  chalk = require('chalk');
 
 exports.pollBuildStatus = (bsConfig, buildDetails) => {
-  return new Promise(function (resolve, reject) {
-    logBuildDetails(bsConfig, buildDetails);
-    printSpecsStatus()
-      .then((data) => {
-        printSpecsRunSummary();
-      })
-      .then((data) => {
-        printFailedSpecsDetails();
-      })
-      .then((data) => {
-        printBuildDashboardLink(buildDetails.dashboard_url);
-        // success case!
-        resolve(0); // exit code 0
-      })
-      .catch((err) => {
-        // failed case!
-        reject(err); // exit code 1
-      });
-    });
+  logBuildDetails(bsConfig, buildDetails);
+  printSpecsStatus().then((data) => {
+    printSpecsRunSummary();
+  }).then((data) => {
+    return specDetails.failedSpecsDetails(data);
+  }).then((successExitCode) => {
+    return resolveExitCode(successExitCode); // exit code 0
+  }).catch((nonZeroExitCode) => {
+    return resolveExitCode(nonZeroExitCode); // exit code 1
+  }).finally(() => {
+    logger.info(Constants.userMessages.BUILD_REPORT_MESSAGE);
+    logger.info(`${Config.dashboardUrl}${buildDetails.dashboard_url}`);
+  });
 };
 
 let logBuildDetails = (bsConfig, buildDetails) => {
@@ -52,12 +49,6 @@ let printSpecsRunSummary = () => {
   });
 };
 
-let printFailedSpecsDetails = () => {
-  return new Promise(function (resolve, reject) {
-    resolve();
-  });
-};
-
-let printBuildDashboardLink = (dashboardUrl) => {
-  logger.info(`${Constants.cliMessages.RUN.BUILD_REPORT_MESSAGE}: ${dashboardUrl}`);
+let resolveExitCode = (exitCode) => {
+  return new Promise((resolve, _reject) => { resolve(exitCode) });
 };

bin/helpers/utils.js

@@ -219,7 +219,7 @@ exports.isParallelValid = (value) => {
 }
 
 exports.getUserAgent = () => {
-  return `BStack-Cypress-CLI/1.4.0 (${os.arch()}/${os.platform()}/${os.release()})`;
+  return `BStack-Cypress-CLI/1.5.0 (${os.arch()}/${os.platform()}/${os.release()})`;
 };
 
 exports.isAbsolute = (configPath) => {

bin/templates/configTemplate.js

@@ -8,47 +8,47 @@ module.exports = function () {
       {
         "browser": "chrome",
         "os": "Windows 10",
-        "versions": ["78", "77"]
+        "versions": ["latest", "latest-1"]
       },
       {
         "browser": "firefox",
         "os": "Windows 10",
-        "versions": ["74", "75"]
+        "versions": ["latest", "latest-1"]
       },
       {
         "browser": "edge",
         "os": "Windows 10",
-        "versions": ["80", "81"]
+        "versions": ["latest", "latest-1"]
       },
       {
         "browser": "chrome",
         "os": "OS X Mojave",
-        "versions": ["78", "77"]
+        "versions": ["latest", "latest-1"]
       },
       {
         "browser": "firefox",
         "os": "OS X Mojave",
-        "versions": ["74", "75"]
+        "versions": ["latest", "latest-1"]
       },
       {
         "browser": "edge",
         "os": "OS X Mojave",
-        "versions": ["80", "81"]
+        "versions": ["latest", "latest-1"]
       },
       {
         "browser": "chrome",
         "os": "OS X Catalina",
-        "versions": ["78", "77"]
+        "versions": ["latest", "latest-1"]
       },
       {
         "browser": "firefox",
         "os": "OS X Catalina",
-        "versions": ["74", "75"]
+        "versions": ["latest", "latest-1"]
       },
       {
         "browser": "edge",
         "os": "OS X Catalina",
-        "versions": ["80", "81"]
+        "versions": ["latest", "latest-1"]
       }
     ],
     "run_settings": {

package.json

@@ -13,6 +13,7 @@
   },
   "dependencies": {
     "archiver": "^3.1.1",
+    "chalk": "^4.1.0",
     "fs-extra": "^8.1.0",
     "mkdirp": "^1.0.3",
     "request": "^2.88.0",

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

@@ -0,0 +1,46 @@
+'use strict';
+const chai = require("chai"),
+  expect = chai.expect,
+  chaiAsPromised = require("chai-as-promised");
+
+chai.use(chaiAsPromised);
+const specDetails = require('../../../../../bin/helpers/sync/failedSpecsDetails');
+
+describe("failedSpecsDetails", () => {
+  context("data is empty", () => {
+    let data = [];
+    it('returns 0 exit code', () => {
+      return specDetails.failedSpecsDetails(data).then((status) => {
+        expect(status).to.equal(0);
+      });
+    });
+  });
+
+  context("data does not have failed specs", () => {
+    let data = [
+      {specName: 'spec2.name.js', status: 'Skipped', combination: 'Win 10 / Chrome 78', sessionId: '3d3rdf3r...'}
+    ];
+
+    it("returns 0 exit code", () => {
+      return specDetails.failedSpecsDetails(data).then((status) => {
+        expect(status).to.equal(0);
+      });
+    });
+  });
+
+  context("data has failed specs", () => {
+    let data = [
+      {specName: 'spec2.name.js', status: 'Failed', combination: 'Win 10 / Chrome 78', sessionId: '3d3rdf3r...'}
+    ];
+
+    it("returns 1 exit code", () => {
+      return specDetails.failedSpecsDetails(data)
+        .then((status) => {
+          chai.assert.equal(status, 1);
+          expect(status).to.equal(1);
+        }).catch((status) => {
+          expect(status).to.equal(1);
+      });
+    });
+  });
+});