Improved support of config options in cli

Author: karanshah-browserstack

bin/commands/runs.js

@@ -22,7 +22,7 @@ module.exports = function run(args) {
   markBlockEnd('deleteOldResults');
 
   markBlockStart('validateBstackJson');
-  return utils.validateBstackJson(bsConfigPath).then(function (bsConfig) {
+  return utils.validateBstackJson(bsConfigPath).then(async function (bsConfig) {
     markBlockEnd('validateBstackJson');
     markBlockStart('setConfig');
     utils.setUsageReportingFlag(bsConfig, args.disableUsageReporting);
@@ -67,6 +67,12 @@ module.exports = function run(args) {
 
     // set the no-wrap
     utils.setNoWrap(bsConfig, args);
+
+    //set browsers
+    await utils.setBrowsers(bsConfig, args);
+
+    //set config (--config)
+    utils.setConfig(bsConfig, args);
     markBlockEnd('setConfig');
 
     // Validate browserstack.json values and parallels specified via arguments

bin/helpers/capabilityHelper.js

@@ -1,8 +1,7 @@
 const logger = require("./logger").winstonLogger,
   Constants = require("./constants"),
   Utils = require("./utils"),
-  fs = require('fs'),
-  path = require('path');
+  fs = require('fs');
 
 const caps = (bsConfig, zip) => {
   return new Promise(function (resolve, reject) {

bin/helpers/constants.js

@@ -68,7 +68,8 @@ const validationMessages = {
   INVALID_CLI_LOCAL_IDENTIFIER: "When using --local-identifier, a value needs to be supplied. \n--local-identifier <String>.\nFor more info, check out https://www.browserstack.com/docs/automate/cypress/cli-reference",
   INVALID_LOCAL_MODE: "When using --local-mode, a value needs to be supplied. \n--local-mode (\"always-on\" | \"on-demand\").\nFor more info, check out https://www.browserstack.com/docs/automate/cypress/cli-reference",
   INVALID_LOCAL_CONFIG_FILE: "Using --local-config-file requires an input of the form /path/to/config-file.yml.\nFor more info, check out https://www.browserstack.com/docs/automate/cypress/cli-reference",
-  INVALID_LOCAL_IDENTIFIER: "Invalid value specified for local_identifier. For more info, check out https://www.browserstack.com/docs/automate/cypress/cli-reference"
+  INVALID_LOCAL_IDENTIFIER: "Invalid value specified for local_identifier. For more info, check out https://www.browserstack.com/docs/automate/cypress/cli-reference",
+  INVALID_BROWSER_ARGS: "Aborting as an unacceptable value was passed for --browser. Read more at https://www.browserstack.com/docs/automate/cypress/cli-reference"
 };
 
 const cliMessages = {
@@ -109,7 +110,9 @@ const cliMessages = {
     LOCAL_MODE: 'Accepted values: ("always-on" | "on-demand") - if you choose to keep the binary "always-on", it will speed up your tests by keeping the Local connection warmed up in the background; otherwise, you can choose to have it spawn and killed for every build',
     LOCAL_IDENTIFIER: "Accepted values: String - assign an identifier to your Local process instance",
     LOCAL_CONFIG_FILE: "Accepted values: String - path to local config-file to your Local process instance. Learn more at https://www.browserstack.com/local-testing/binary-params",
-    SYNC_NO_WRAP: "Wrap the spec names in --sync mode in case of smaller terminal window size pass --no-wrap"
+    SYNC_NO_WRAP: "Wrap the spec names in --sync mode in case of smaller terminal window size pass --no-wrap",
+    BROWSER_DESCRIPTION: "Specify the browsers you need to run your tests on.",
+    CONFIG_DESCRIPTION: "Set configuration values. Separate multiple values with a comma. The values set here override any values set in your configuration file."
   },
   COMMON: {
     DISABLE_USAGE_REPORTING: "Disable usage reporting",

bin/helpers/utils.js

@@ -739,3 +739,32 @@ exports.deleteBaseUrlFromError = (err) => {
   return err.replace(/To test ([\s\S]*)on BrowserStack/g, 'To test on BrowserStack');
 }
 
+exports.setBrowsers = async (bsConfig, args) => {
+  return new Promise((resolve, reject) => {
+    if(!this.isUndefined(args.browser)){
+      try{
+        bsConfig["browsers"] = []
+        let browsersList = args.browser.split(',')
+        browsersList.forEach((browser)=>{
+          let browserHash = {}
+          let osBrowserDetails =  browser.split(':')
+          browserHash['os'] = osBrowserDetails[1]
+          let browserDetails = osBrowserDetails[0].split('@')
+          browserHash['browser'] = browserDetails[0]
+          browserHash['versions'] = []
+          browserHash['versions'].push(this.isUndefined(browserDetails[1]) ? "latest" : browserDetails[1])
+          bsConfig["browsers"].push(browserHash)
+        });
+      } catch(err){
+        reject(Constants.validationMessages.INVALID_BROWSER_ARGS)
+      }
+    }
+    resolve()
+  });
+}
+
+exports.setConfig = (bsConfig, args) => {
+  if (!this.isUndefined(args.config)) {
+    bsConfig["run_settings"]["config"] = args.config
+  }
+}

bin/runner.js

@@ -151,7 +151,7 @@ var argv = yargs
           type: "boolean"
         },
         'p': {
-          alias: 'parallels',
+          alias: ['parallels', 'parallel'],
           describe: Constants.cliMessages.RUN.PARALLEL_DESC,
           type: "number",
           default: undefined
@@ -169,7 +169,7 @@ var argv = yargs
           default: undefined
         },
         'b': {
-          alias: 'build-name',
+          alias: ['build-name', 'ci-build-id'],
           describe: Constants.cliMessages.RUN.BUILD_NAME,
           type: "string",
           default: undefined
@@ -231,6 +231,17 @@ var argv = yargs
           default: false,
           describe: Constants.cliMessages.RUN.SYNC_NO_WRAP,
           type: "boolean"
+        },
+        'browser': {
+          describe: Constants.cliMessages.RUN.BROWSER_DESCRIPTION,
+          type: "string",
+          default: undefined
+        },
+        'c': {
+          alias: 'config',
+          describe: Constants.cliMessages.RUN.CONFIG_DESCRIPTION,
+          type: "string",
+          default: undefined
         }
       })
       .help('help')