Added spec failure/skipped message with table.

- Print an ASCII table with Failed / Skipped specs in it.
- Details include spec name, status, combiantion, and session id in the order.
- The status and header are colour printed for better readability.
- Handle the resolve and reject which bubble up the exit code to main run.
- process will now exit as zero or non zero code.
- Fixed typo in constant.

Author: suryart

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",
@@ -94,6 +98,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/syncRunner.js

@@ -1,25 +1,26 @@
 'use strict';
-const config = require("./config"),
+const Config = require("./config"),
   logger = require("./logger").syncCliLogger,
   Constants = require("./constants"),
   utils = require("./utils"),
-  request = require('request');
+  request = require('request'),
+  { table, getBorderCharacters } = require('table'),
+  chalk = require('chalk');
 
 exports.pollBuildStatus = (bsConfig, buildId) => {
   logBuildDetails().then((data) => {
     printSpecsStatus();
   }).then((data) => {
     printSpecsRunSummary();
   }).then((data) => {
-    printFailedSpecsDetails();
-  }).then((data) => {
-    printBuildDashboardLink(buildId);
-  }).then((data) => {
-    // success case!
-    return 0; // exit code 0
-  }).catch((err) => {
-    // failed case!
-    return 1; // exit code 1
+    printFailedSpecsDetails(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}${buildId}`);
   });
 };
 
@@ -35,13 +36,68 @@ let printSpecsRunSummary = () => {
 
 };
 
-let printFailedSpecsDetails = () => {
+/**
+ *
+ * @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 printFailedSpecsDetails = (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 printBuildDashboardLink = (buildId) => {
-  new Promise((resolve, reject) => {
-    logger.info(Constants.userMessages.BUILD_REPORT_MESSAGE);
-    logger.info(`${config.dashboardUrl}${buildId}`);
+    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: getBorderCharacters('ramac'),
+      columns: {
+        0: { alignment: 'center' },
+        1: { alignment: 'center' },
+        2: { alignment: 'center' },
+        3: { alignment: 'center' },
+      },
+      /**
+      * @typedef {function} drawHorizontalLine
+      * @param {number} index
+      * @param {number} size
+      * @return {boolean}
+      */
+      drawHorizontalLine: (index, size) => {
+        return (index === 0 || index === 1 ||  index === size);
+      }
+    }
+
+    let result = 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
   });
 };
+
+let resolveExitCode = (exitCode) => {
+  return new Promise((resolve, _reject) => { resolve(exitCode) });
+};

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",