Cyp 175 parallelisation support

bin/commands/runs.js

@@ -15,10 +15,13 @@ module.exports = function run(args) {
   return utils.validateBstackJson(bsConfigPath).then(function (bsConfig) {
     utils.setUsageReportingFlag(bsConfig, args.disableUsageReporting);
 
-    // Validate browserstack.json values
-    return capabilityHelper.validate(bsConfig).then(function (validated) {
+    // Validate browserstack.json values and parallels specified via arguments
+    return capabilityHelper.validate(bsConfig, args).then(function (validated) {
       logger.info(validated);
 
+      // accept the number of parallels
+      utils.setParallels(bsConfig, args);
+
       // Archive the spec files
       return archiver.archive(bsConfig.run_settings, config.fileName).then(function (data) {
 
@@ -57,7 +60,12 @@ module.exports = function run(args) {
     }).catch(function (err) {
       // browerstack.json is not valid
       logger.error(err);
-      logger.error(Constants.validationMessages.NOT_VALID);
+
+      // display browserstack.json is not valid only if validation of browserstack.json field has failed, otherwise display just the error message
+      // If parallels specified in arguments are invalid do not display browserstack.json is invalid message
+      if (!(err === Constants.validationMessages.INVALID_PARALLELS_CONFIGURATION && !utils.isUndefined(args.parallels))) {
+        logger.error(Constants.validationMessages.NOT_VALID);
+      }
 
       let error_code = utils.getErrorCodeFromMsg(err);
       utils.sendUsageReport(bsConfig, args, `${err}\n${Constants.validationMessages.NOT_VALID}`, Constants.messageTypes.ERROR, error_code);

bin/helpers/capabilityHelper.js

@@ -1,5 +1,6 @@
 const logger = require("./logger").winstonLogger,
   Constants = require("./constants"),
+  Utils = require("./utils"),
   fs = require('fs'),
   path = require('path');
 
@@ -66,6 +67,7 @@ const caps = (bsConfig, zip) => {
       obj.customBuildName = bsConfig.run_settings.customBuildName || bsConfig.run_settings.build_name;
       obj.callbackURL = bsConfig.run_settings.callback_url;
       obj.projectNotifyURL = bsConfig.run_settings.project_notify_URL;
+      obj.parallels = bsConfig.run_settings.parallels;
     }
 
     if (obj.project) logger.log(`Project name is: ${obj.project}`);
@@ -76,12 +78,14 @@ const caps = (bsConfig, zip) => {
 
     if (obj.projectNotifyURL) logger.info(`Project notify URL is: ${obj.projectNotifyURL}`);
 
+    if (obj.parallels) logger.info(`Parallels limit specified: ${obj.parallels}`);
+
     var data = JSON.stringify(obj);
     resolve(data);
   })
 }
 
-const validate = (bsConfig) => {
+const validate = (bsConfig, args) => {
   return new Promise(function(resolve, reject){
     if (!bsConfig) reject(Constants.validationMessages.EMPTY_BROWSERSTACK_JSON);
 
@@ -91,7 +95,13 @@ const validate = (bsConfig) => {
 
     if (!bsConfig.run_settings) reject(Constants.validationMessages.EMPTY_RUN_SETTINGS);
 
-    if(!bsConfig.run_settings.cypress_proj_dir) reject(Constants.validationMessages.EMPTY_SPEC_FILES);
+    if (!bsConfig.run_settings.cypress_proj_dir) reject(Constants.validationMessages.EMPTY_SPEC_FILES);
+
+    // validate parallels specified in browserstack.json if parallels are not specified via arguments
+    if (!Utils.isUndefined(args) && Utils.isUndefined(args.parallels) && !Utils.isParallelValid(bsConfig.run_settings.parallels)) reject(Constants.validationMessages.INVALID_PARALLELS_CONFIGURATION);
+
+    // if parallels specified via arguments validate only arguments
+    if (!Utils.isUndefined(args) && !Utils.isUndefined(args.parallels) && !Utils.isParallelValid(args.parallels)) reject(Constants.validationMessages.INVALID_PARALLELS_CONFIGURATION);
 
     if (!fs.existsSync(path.join(bsConfig.run_settings.cypress_proj_dir, 'cypress.json'))) reject(Constants.validationMessages.CYPRESS_JSON_NOT_FOUND + bsConfig.run_settings.cypress_proj_dir);
 

bin/helpers/constants.js

@@ -24,6 +24,7 @@ const validationMessages = {
   NOT_VALID: "browerstack.json is not valid",
   NOT_VALID_JSON: "browerstack.json is not a valid json",
   INVALID_EXTENSION: "Invalid files, please remove these files and try again.",
+  INVALID_PARALLELS_CONFIGURATION: "Invalid value specified for parallels to use. Maximum parallels to use should be a number greater than 0.",
   CYPRESS_JSON_NOT_FOUND: "cypress.json file is not found at cypress_proj_dir path ",
   INVALID_CYPRESS_JSON: "cypress.json is not a valid json"
 };
@@ -48,6 +49,7 @@ const cliMessages = {
         STOP_MESSAGE: "Stopping build with given buildId "
     },
     RUN: {
+        PARALLEL_DESC: "The maximum number of parallels to use to run your test suite",
         INFO: "Run your tests on BrowserStack.",
         DESC: "Path to BrowserStack config",
         CONFIG_DEMAND: "config file is required"

bin/helpers/utils.js

@@ -70,6 +70,20 @@ exports.setUsageReportingFlag = (bsConfig, disableUsageReporting) => {
   }
 }
 
+exports.setParallels = (bsConfig, args) => {
+  if (!this.isUndefined(args.parallels)) {
+    bsConfig['run_settings']['parallels'] = args.parallels;
+  }
+}
+
+exports.isUndefined = value => (value === undefined || value === null);
+
+exports.isFloat = value => (Number(value) && Number(value) % 1 !== 0);
+
+exports.isParallelValid = (value) => {
+  return this.isUndefined(value) || !(isNaN(value) || this.isFloat(value) || parseInt(value, 10) === 0 || parseInt(value, 10) < -1);
+}
+
 exports.getUserAgent = () => {
   return `BStack-Cypress-CLI/1.x (${os.arch()}/${os.platform()}/${os.release()})`;
 }

bin/runner.js

@@ -101,7 +101,7 @@ var argv = yargs
   })
   .command('run', Constants.cliMessages.RUN.INFO, function(yargs) {
     argv = yargs
-      .usage('usage: $0 build')
+      .usage('usage: $0 run <options>')
       .options({
         'cf': {
           alias: 'config-file',
@@ -117,6 +117,12 @@ var argv = yargs
           description: Constants.cliMessages.COMMON.DISABLE_USAGE_REPORTING,
           type: "boolean"
         },
+        'p': {
+          alias: 'parallels',
+          describe: Constants.cliMessages.RUN.PARALLEL_DESC,
+          type: "number",
+          default: undefined
+        }
       })
       .help('help')
       .wrap(null)

bin/templates/configTemplate.js

@@ -15,6 +15,7 @@ module.exports = function () {
       "cypress_proj_dir" : "/path/to/cypress.json",
       "project_name": "project-name",
       "build_name": "build-name",
+      "parallels": "Here goes the number of parallels you want to run",
       "npm_dependencies": {
       }
     },

test/unit/bin/commands/runs.js

@@ -134,6 +134,7 @@ describe("runs", () => {
 
     beforeEach(() => {
       sandbox = sinon.createSandbox();
+      setParallelsStub = sandbox.stub();
       validateBstackJsonStub = sandbox.stub();
       setUsageReportingFlagStub = sandbox.stub().returns(undefined);
       sendUsageReportStub = sandbox.stub().callsFake(function () {
@@ -158,6 +159,7 @@ describe("runs", () => {
         "../helpers/utils": {
           validateBstackJson: validateBstackJsonStub,
           sendUsageReport: sendUsageReportStub,
+          setParallels: setParallelsStub,
           setUsageReportingFlag: setUsageReportingFlagStub,
         },
         "../helpers/capabilityHelper": {
@@ -180,6 +182,7 @@ describe("runs", () => {
           chai.assert.fail("Promise error");
         })
         .catch((error) => {
+          sinon.assert.calledOnce(setParallelsStub)
           sinon.assert.calledOnce(validateBstackJsonStub);
           sinon.assert.calledOnce(capabilityValidatorStub);
           sinon.assert.calledOnce(archiverStub);
@@ -203,6 +206,7 @@ describe("runs", () => {
     beforeEach(() => {
       sandbox = sinon.createSandbox();
       validateBstackJsonStub = sandbox.stub();
+      setParallelsStub = sandbox.stub();
       setUsageReportingFlagStub = sandbox.stub().returns(undefined);
       sendUsageReportStub = sandbox.stub().callsFake(function () {
         return "end";
@@ -227,6 +231,7 @@ describe("runs", () => {
         "../helpers/utils": {
           validateBstackJson: validateBstackJsonStub,
           sendUsageReport: sendUsageReportStub,
+          setParallels: setParallelsStub,
           setUsageReportingFlag: setUsageReportingFlagStub,
         },
         "../helpers/capabilityHelper": {
@@ -253,6 +258,7 @@ describe("runs", () => {
           chai.assert.fail("Promise error");
         })
         .catch((error) => {
+          sinon.assert.calledOnce(setParallelsStub);
           sinon.assert.calledOnce(validateBstackJsonStub);
           sinon.assert.calledOnce(capabilityValidatorStub);
           sinon.assert.calledOnce(archiverStub);
@@ -280,6 +286,7 @@ describe("runs", () => {
     beforeEach(() => {
       sandbox = sinon.createSandbox();
       validateBstackJsonStub = sandbox.stub();
+      setParallelsStub = sandbox.stub();
       setUsageReportingFlagStub = sandbox.stub().returns(undefined);
       sendUsageReportStub = sandbox.stub().callsFake(function () {
         return "end";
@@ -305,6 +312,7 @@ describe("runs", () => {
         "../helpers/utils": {
           validateBstackJson: validateBstackJsonStub,
           sendUsageReport: sendUsageReportStub,
+          setParallels: setParallelsStub,
           setUsageReportingFlag: setUsageReportingFlagStub,
         },
         "../helpers/capabilityHelper": {
@@ -339,6 +347,7 @@ describe("runs", () => {
         .catch((error) => {
           sinon.assert.calledOnce(validateBstackJsonStub);
           sinon.assert.calledOnce(capabilityValidatorStub);
+          sinon.assert.calledOnce(setParallelsStub);
           sinon.assert.calledOnce(archiverStub);
           sinon.assert.calledOnce(setUsageReportingFlagStub);
           sinon.assert.calledOnce(zipUploadStub);
@@ -368,6 +377,7 @@ describe("runs", () => {
     beforeEach(() => {
       sandbox = sinon.createSandbox();
       validateBstackJsonStub = sandbox.stub();
+      setParallelsStub = sandbox.stub();
       setUsageReportingFlagStub = sandbox.stub().returns(undefined);
       sendUsageReportStub = sandbox.stub().callsFake(function () {
         return "end";
@@ -394,6 +404,7 @@ describe("runs", () => {
           validateBstackJson: validateBstackJsonStub,
           sendUsageReport: sendUsageReportStub,
           setUsageReportingFlag: setUsageReportingFlagStub,
+          setParallels: setParallelsStub,
         },
         "../helpers/capabilityHelper": {
           validate: capabilityValidatorStub,
@@ -427,6 +438,7 @@ describe("runs", () => {
         .catch((error) => {
           sinon.assert.calledOnce(validateBstackJsonStub);
           sinon.assert.calledOnce(capabilityValidatorStub);
+          sinon.assert.calledOnce(setParallelsStub);
           sinon.assert.calledOnce(archiverStub);
           sinon.assert.calledOnce(setUsageReportingFlagStub);
           sinon.assert.calledOnce(zipUploadStub);