[CYP-175] Parallelisation support in cli

Author: pawanpanjwani

bin/commands/runs.js

@@ -31,9 +31,12 @@ function runCypress(args) {
     util.setUsageReportingFlag(bsConfig, args.disableUsageReporting);
 
     // Validate browserstack.json values
-    capabilityHelper.validate(bsConfig).then(function (validated) {
+    capabilityHelper.validate(bsConfig, args).then(function (validated) {
       logger.info(validated);
 
+      // accept the number of parallels
+      util.setParallels(bsConfig, args);
+
       // Archive the spec files
       archiver.archive(bsConfig.run_settings, config.fileName).then(function (data) {
 

bin/helpers/capabilityHelper.js

@@ -56,12 +56,15 @@ const caps = (bsConfig, zip) => {
     obj.projectNotifyURL = bsConfig.run_settings.project_notify_URL
     if (obj.projectNotifyURL) logger.info(`Project notify URL is: ${obj.projectNotifyURL}`);
 
+    obj.parallels = bsConfig.run_settings.parallels;
+    if (obj.parallels) logger.info(`Parallels specified are: ${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);
 
@@ -73,6 +76,11 @@ const validate = (bsConfig) => {
 
     if(!bsConfig.run_settings.cypress_proj_dir) reject(Constants.validationMessages.EMPTY_SPEC_FILES);
 
+    if (!args.parallels) {
+      if (Number.isNaN(bsConfig.run_settings.parallels) || (parseInt(bsConfig.run_settings.parallels, 10) < 0 && parseInt(bsConfig.run_settings.parallels, 10) != -1))
+        reject(Constants.validationMessages.INVALID_PARALLES_CONFIGURATION)
+    };
+
     resolve(Constants.validationMessages.VALIDATED);
   });
 }

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_PARALLES_CONFIGURATION: "Invalid type of parallel, accepted values are positive or -1",
 };
 
 const cliMessages = {
@@ -46,6 +47,7 @@ const cliMessages = {
         STOP_MESSAGE: "Stopping build with given buildId "
     },
     RUN: {
+        PARALLEL_DESC: "Maximum number of parallels to run",
         INFO: "Run your tests on BrowserStack.",
         DESC: "Path to BrowserStack config",
         CONFIG_DEMAND: "config file is required"

bin/helpers/util.js

@@ -70,6 +70,12 @@ exports.setUsageReportingFlag = (bsConfig, disableUsageReporting) => {
   }
 }
 
+exports.setParallels = (bsConfig, args) => {
+  if ((args.parallels !== undefined && !Number.isNaN(args.parallels))) {
+    bsConfig['run_settings']['parallels'] = args.parallels;
+  }
+}
+
 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)