Merge pull request #67 from browserstack/sync-cli-part-3

Sync CLI Part 3

Author: suryart

bin/helpers/sync/specsSummary.js

@@ -0,0 +1,54 @@
+const logger = require("../logger").syncCliLogger;
+
+/**
+ *
+ * @param {Array.<{specName: string, status: string, combination: string, sessionId: string}>} data
+ * @param {String} time
+ * @param {Number} machines
+ * @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 printSpecsRunSummary = (data, time, machines) => {
+  return new Promise((resolve, _reject) => {
+    let summary = {
+      total: 0,
+      failed: 0,
+      passed: 0,
+      skipped: 0
+    };
+
+    data.forEach((spec) => {
+      specSummaryCount(summary, spec.status.toLowerCase());
+    });
+
+    logger.info(`Total tests: ${summary.total}, passed: ${summary.passed}, failed: ${summary.failed}, skipped: ${summary.skipped}`);
+    logger.info(`Done in ${time} using ${machines} machines\n`);
+
+    resolve(data);
+  })
+};
+
+let specSummaryCount = (summary, status) => {
+  switch (status) {
+    case 'failed':
+      summary.failed++;
+      break;
+    case 'skipped':
+      summary.skipped++;
+      break;
+    case 'passed':
+      summary.passed++;
+      break;
+  }
+  summary.total++;
+};
+
+exports.printSpecsRunSummary = printSpecsRunSummary;

bin/helpers/syncRunner.js

@@ -5,14 +5,15 @@ const Config = require("./config"),
   utils = require("./utils"),
   request = require('request'),
   specDetails = require('./sync/failedSpecsDetails'),
+  specsSummary = require('./sync/specsSummary'),
   { table, getBorderCharacters } = require('table'),
   chalk = require('chalk');
 
 exports.pollBuildStatus = (bsConfig, buildId) => {
   logBuildDetails().then((data) => {
     printSpecsStatus();
   }).then((data) => {
-    printSpecsRunSummary();
+    return specsSummary.printSpecsRunSummary(data.specs, data.time, data.machines);
   }).then((data) => {
     return specDetails.failedSpecsDetails(data);
   }).then((successExitCode) => {

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

@@ -0,0 +1,41 @@
+'use strict';
+const chai = require("chai"),
+  sinon = require("sinon"),
+  expect = chai.expect,
+  chaiAsPromised = require("chai-as-promised");
+
+chai.use(chaiAsPromised);
+var logger = require("../../../../../bin/helpers/logger").syncCliLogger;
+var specSummary = require('../../../../../bin/helpers/sync/specsSummary');
+
+describe("printSpecsRunSummary", () => {
+  context("data is empty", () => {
+    let data = [], time = '2 minutes', machines = 2;
+    it('returns passed specs data', () => {
+      return specSummary.printSpecsRunSummary(data, time, machines).then((specsData) => {
+        expect(data).to.equal(specsData);
+      });
+    });
+  });
+
+  context("with data", () => {
+    let time = '2 minutes',
+        machines = 2,
+        data = [
+          {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...'}
+        ];
+
+    it('returns passed specs data', () => {
+      var loggerInfoSpy = sinon.spy(logger, 'info');
+
+      specSummary.printSpecsRunSummary(data, time, machines);
+      sinon.assert.calledWith(loggerInfoSpy, 'Total tests: 4, passed: 1, failed: 2, skipped: 1');
+      sinon.assert.calledWith(loggerInfoSpy, `Done in ${time} using ${machines} machines\n`);
+
+      loggerInfoSpy.restore();
+    });
+  });
+});