Merge pull request #78 from browserstack/sync-cli-part-2

Sync cli part 2

Author: karanshah-browserstack

bin/commands/runs.js

@@ -69,6 +69,8 @@ module.exports = function run(args) {
             if (args.sync) {
               syncRunner.pollBuildStatus(bsConfig, data).then((exitCode) => {
                 utils.sendUsageReport(bsConfig, args, `${message}\n${dashboardLink}`, Constants.messageTypes.SUCCESS, null);
+                logger.info(Constants.userMessages.BUILD_REPORT_MESSAGE);
+                logger.info(data.dashboard_url)
                 process.exit(exitCode);
               });
             }

bin/helpers/constants.js

@@ -1,5 +1,9 @@
 const syncCLI = {
-  FAILED_SPEC_DETAILS_COL_HEADER: ['Spec', 'Status', 'Browser', 'BrowserStack Session ID']
+  FAILED_SPEC_DETAILS_COL_HEADER: ['Spec', 'Status', 'Browser', 'BrowserStack Session ID'],
+  LOGS: {
+    INIT_LOG: "Running Tests: ..."
+  },
+  INITIAL_DELAY_MULTIPLIER: 10
 };
 
 const userMessages = {

bin/helpers/sync/failedSpecsDetails.js

@@ -29,6 +29,9 @@ let failedSpecsDetails = (data) => {
     let specData = [specResultHeader]; // 2-D array
 
     data.forEach((spec) => {
+      if (spec.status.toLowerCase() === 'passed') {
+        return;
+      }
       if (spec.status && spec.status.toLowerCase() === 'failed' && !failedSpecs)
         failedSpecs = true;
 

bin/helpers/sync/specsSummary.js

@@ -30,7 +30,7 @@ let printSpecsRunSummary = (data, time, machines) => {
     });
 
     logger.info(`Total tests: ${summary.total}, passed: ${summary.passed}, failed: ${summary.failed}, skipped: ${summary.skipped}`);
-    logger.info(`Done in ${time} using ${machines} machines\n`);
+    logger.info(`Done in ${time/1000} seconds using ${machines} machines\n`);
 
     resolve(data);
   })

bin/helpers/sync/syncSpecsLogs.js

@@ -0,0 +1,169 @@
+"use strict";
+const request = require("request"),
+  config = require("../config"),
+  utils = require("../utils"),
+  logger = require("../logger").syncCliLogger,
+  async = require('async'),
+  Constants = require("../constants"),
+  tableStream = require('table').createStream,
+  chalk = require('chalk');
+
+let whileLoop = true, whileTries = 40, options, timeout = 3000, n = 10, tableConfig, stream, startTime, endTime;
+let specSummary = {
+  "specs": [],
+  "duration": null
+}
+
+
+let  getOptions = (auth, build_id) => {
+  return {
+    url: `${config.buildUrl}${build_id}`,
+    auth: {
+      user: auth.username,
+      password: auth.access_key
+    },
+    headers: {
+      "Content-Type": "application/json",
+      "User-Agent": utils.getUserAgent()
+    }
+  };
+}
+
+let getTableConfig = () => {
+  return {
+    border: getBorderConfig(),
+    singleLine: true,
+    columns: {
+      0: { alignment: 'right' }
+    },
+    columnDefault: {
+      width: 50
+    },
+    columnCount: 2
+  };
+}
+
+let getBorderConfig = () => {
+  return {
+    topBody: `-`,
+    topJoin: ``,
+    topLeft: ``,
+    topRight: ``,
+
+    bottomBody: `-`,
+    bottomJoin: ``,
+    bottomLeft: ``,
+    bottomRight: ``,
+
+    bodyLeft: ``,
+    bodyRight: ``,
+    bodyJoin: ``,
+
+    joinBody: ``,
+    joinLeft: ``,
+    joinRight: ``,
+    joinJoin: ``
+  }
+}
+
+let printSpecsStatus = (bsConfig, buildDetails) => {
+  return new Promise((resolve, reject) => {
+    options = getOptions(bsConfig.auth, buildDetails.build_id)
+    tableConfig = getTableConfig();
+    stream = tableStream(tableConfig);
+
+    async.whilst(
+      function() { // condition for loop
+        return whileLoop;
+      },
+      function(callback) { // actual loop
+        whileProcess(callback)
+      },
+      function(err, result) { // when loop ends
+        specSummary.duration =  endTime - startTime
+        logger.info();
+        resolve(specSummary)
+      }
+    );
+  });
+};
+
+let whileProcess = (whilstCallback) => {
+  request.post(options, function(error, response, body) {
+    if (error) {
+      return whilstCallback(error);
+    }
+    switch (response.statusCode) {
+      case 202: // get data here and print it
+        n = 2
+        showSpecsStatus(body);
+        return setTimeout(whilstCallback, timeout * n, null);
+      case 204: // No data available, wait for some time and ask again
+        n = 1
+        return setTimeout(whilstCallback, timeout * n, null);
+      case 200: // Build is completed.
+        whileLoop = false;
+        endTime = Date.now();
+        showSpecsStatus(body);
+        return whilstCallback(null, body);
+      default:
+        whileLoop = false;
+        return whilstCallback({ status: response.statusCode, message: body });
+    }
+  });
+}
+
+let showSpecsStatus = (data) => {
+  let specData = JSON.parse(data);
+  specData.forEach(specDetails => {
+    if (specDetails == "created") {
+      printInitialLog();
+    } else {
+      printSpecData(JSON.parse(specDetails))
+    }
+  });
+}
+
+let printInitialLog = () => {
+  startTime = Date.now();
+  logger.info(Constants.syncCLI.LOGS.INIT_LOG)
+  n = Constants.syncCLI.INITIAL_DELAY_MULTIPLIER
+}
+
+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 writeToTable = (combination, specName, status) => {
+  stream.write([combination + ":", `${specName} ${status}`]);
+}
+
+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({
+    "specName": specName,
+    "status": status,
+    "combination": combination,
+    "sessionId": session_id
+  })
+}
+
+let getCombinationName = (spec) => {
+  return `${spec["os"]} ${spec["osVersion"]} / ${spec["browser"]} ${spec["browserVersion"]}`
+}
+
+let getStatus = (status) => {
+  switch(status) {
+    case "passed":
+      return chalk.green("✔");
+    case "failed":
+      return chalk.red("✘");
+    default:
+      return chalk.blue(`[${status}]`);
+  }
+}
+
+exports.printSpecsStatus = printSpecsStatus;

bin/helpers/syncRunner.js

@@ -4,24 +4,24 @@ const Config = require("./config"),
   Constants = require("./constants"),
   utils = require("./utils"),
   request = require('request'),
+  syncSpecsLogs = require('./sync/syncSpecsLogs'),
   specDetails = require('./sync/failedSpecsDetails'),
   specsSummary = require('./sync/specsSummary'),
   { table, getBorderCharacters } = require('table'),
   chalk = require('chalk');
 
 exports.pollBuildStatus = (bsConfig, buildDetails) => {
-  logBuildDetails(bsConfig, buildDetails);
-  printSpecsStatus().then((data) => {
-    return specsSummary.printSpecsRunSummary(data.specs, data.time, data.machines);
-  }).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}`);
+  return new Promise((resolve, reject) => {
+    logBuildDetails(bsConfig, buildDetails);
+    syncSpecsLogs.printSpecsStatus(bsConfig, buildDetails).then((data) => {
+      return specsSummary.printSpecsRunSummary(data.specs, data.duration, buildDetails.machines);
+    }).then((data) => {
+      return specDetails.failedSpecsDetails(data);
+    }).then((successExitCode) => {
+      resolve(successExitCode); // exit code 0
+    }).catch((nonZeroExitCode) => {
+      resolve(nonZeroExitCode); // exit code 1
+    })
   });
 };
 
@@ -37,19 +37,3 @@ let logBuildDetails = (bsConfig, buildDetails) => {
   logger.info(parallelMessage);
   logger.info(`BrowserStack Dashboard: ${buildDetails.dashboard_url}`);
 };
-
-let printSpecsStatus = () => {
-  return new Promise(function (resolve, reject) {
-    resolve();
-  });
-};
-
-let printSpecsRunSummary = () => {
-  return new Promise(function (resolve, reject) {
-    resolve();
-  });
-};
-
-let resolveExitCode = (exitCode) => {
-  return new Promise((resolve, _reject) => { resolve(exitCode) });
-};

test/unit/bin/commands/runs.js

@@ -517,7 +517,7 @@ describe("runs", () => {
       let messageType = Constants.messageTypes.SUCCESS;
       let errorCode = null;
       let message = `Success! ${Constants.userMessages.BUILD_CREATED} with build id: random_build_id`;
-      let dashboardLink = `${Constants.userMessages.VISIT_DASHBOARD} ${dashboardUrl}random_build_id`;
+      let dashboardLink = `${Constants.userMessages.VISIT_DASHBOARD} ${dashboardUrl}`;
 
       const runs = proxyquire("../../../../bin/commands/runs", {
         "../helpers/utils": {
@@ -564,7 +564,7 @@ describe("runs", () => {
       );
       archiverStub.returns(Promise.resolve("Zipping completed"));
       zipUploadStub.returns(Promise.resolve("zip uploaded"));
-      createBuildStub.returns(Promise.resolve({ message: 'Success', build_id: 'random_build_id' }));
+      createBuildStub.returns(Promise.resolve({ message: 'Success', build_id: 'random_build_id', dashboard_url: dashboardUrl }));
 
       return runs(args)
         .then(function (_bsConfig) {

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

@@ -3,10 +3,23 @@ const chai = require("chai"),
   expect = chai.expect,
   chaiAsPromised = require("chai-as-promised");
 
+const sinon = require("sinon");
 chai.use(chaiAsPromised);
 const specDetails = require('../../../../../bin/helpers/sync/failedSpecsDetails');
+var logger = require("../../../../../bin/helpers/logger").syncCliLogger;
 
 describe("failedSpecsDetails", () => {
+  var sandbox;
+
+  beforeEach(() => {
+    sandbox = sinon.createSandbox();
+    sandbox.stub(logger, 'info');
+  });
+
+  afterEach(() => {
+    sandbox.restore();
+  });
+
   context("data is empty", () => {
     let data = [];
     it('returns 0 exit code', () => {
@@ -30,7 +43,8 @@ describe("failedSpecsDetails", () => {
 
   context("data has failed specs", () => {
     let data = [
-      {specName: 'spec2.name.js', status: 'Failed', 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 1 exit code", () => {

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

@@ -10,7 +10,7 @@ var specSummary = require('../../../../../bin/helpers/sync/specsSummary');
 
 describe("printSpecsRunSummary", () => {
   context("data is empty", () => {
-    let data = [], time = '2 minutes', machines = 2;
+    let data = [], time = 6000, machines = 2;
     it('returns passed specs data', () => {
       return specSummary.printSpecsRunSummary(data, time, machines).then((specsData) => {
         expect(data).to.equal(specsData);
@@ -19,7 +19,7 @@ describe("printSpecsRunSummary", () => {
   });
 
   context("with data", () => {
-    let time = '2 minutes',
+    let time = 6000,
         machines = 2,
         data = [
           {specName: 'spec2.name.js', status: 'Failed', combination: 'Win 10 / Chrome 78', sessionId: '3d3rdf3r...'},
@@ -33,7 +33,7 @@ describe("printSpecsRunSummary", () => {
 
       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`);
+      sinon.assert.calledWith(loggerInfoSpy, `Done in ${time / 1000} seconds using ${machines} machines\n`);
 
       loggerInfoSpy.restore();
     });