[CYP-175] Parallelisation support in cli

Author: pawanpanjwani

bin/commands/runs.js

@@ -34,6 +34,9 @@ function runCypress(args) {
     capabilityHelper.validate(bsConfig).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,6 +56,9 @@ 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);
   })

bin/helpers/constants.js

@@ -46,6 +46,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 && (bsConfig['run_settings']['parallels'] === undefined || bsConfig['run_settings']['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)