Merge pull request #159 from browserstack/config_options

Improved support of config options in cli

Author: karanshah-browserstack

bin/commands/runs.js

@@ -23,7 +23,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);
@@ -69,6 +69,11 @@ 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);
     // set other cypress configs e.g. reporter and reporter-options
     utils.setOtherConfigs(bsConfig, args);
     markBlockEnd('setConfig');

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

@@ -72,7 +72,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 = {
@@ -110,6 +111,8 @@ const cliMessages = {
     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",
+    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.",
     REPORTER: "Specify the custom reporter to use",
     REPORTER_OPTIONS: "Specify reporter options for custom reporter",
   },

bin/helpers/utils.js

@@ -754,6 +754,36 @@ 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].trim()
+          let browserDetails = osBrowserDetails[0].split('@')
+          browserHash['browser'] = browserDetails[0].trim()
+          browserHash['versions'] = []
+          browserHash['versions'].push(this.isUndefined(browserDetails[1]) ? "latest" : browserDetails[1].trim())
+          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
+  }
+}
+
 // blindly send other passed configs with run_settings and handle at backend
 exports.setOtherConfigs = (bsConfig, args) => {
   if (!this.isUndefined(args.reporter)) {

bin/runner.js

@@ -130,13 +130,13 @@ var argv = yargs
           demand: Constants.cliMessages.RUN.CYPRESS_CONFIG_DEMAND
         },
         'p': {
-          alias: 'parallels',
+          alias: ['parallels', 'parallel'],
           describe: Constants.cliMessages.RUN.PARALLEL_DESC,
           type: "number",
           default: undefined
         },
         'b': {
-          alias: 'build-name',
+          alias: ['build-name', 'ci-build-id'],
           describe: Constants.cliMessages.RUN.BUILD_NAME,
           type: "string",
           default: undefined
@@ -199,6 +199,17 @@ var argv = yargs
           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
+        },
         'r': {
           alias: 'reporter',
           default: undefined,

test/unit/bin/commands/runs.js

@@ -5,7 +5,7 @@ const chai = require("chai"),
 const Constants = require("../../../../bin/helpers/constants"),
   logger = require("../../../../bin/helpers/logger").winstonLogger,
   testObjects = require("../../support/fixtures/testObjects");
-
+ 
 const proxyquire = require("proxyquire").noCallThru();
 
 chai.use(chaiAsPromised);
@@ -107,6 +107,8 @@ describe("runs", () => {
       setDefaultsStub = sandbox.stub();
       setLocalModeStub = sandbox.stub();
       setLocalConfigFileStub = sandbox.stub();
+      setBrowsersStub = sandbox.stub();
+      setConfigStub = sandbox.stub();
     });
 
     afterEach(() => {
@@ -143,7 +145,9 @@ describe("runs", () => {
           isJSONInvalid: isJSONInvalidStub,
           setLocalMode: setLocalModeStub,
           setLocalConfigFile: setLocalConfigFileStub,
-          setSystemEnvs: setSystemEnvsStub
+          setSystemEnvs: setSystemEnvsStub,
+          setBrowsers: setBrowsersStub,
+          setConfig: setConfigStub
         },
         '../helpers/capabilityHelper': {
           validate: capabilityValidatorStub
@@ -176,6 +180,7 @@ describe("runs", () => {
           sinon.assert.calledOnce(setLocalConfigFileStub);
           sinon.assert.calledOnce(setHeadedStub);
           sinon.assert.calledOnce(setNoWrapStub);
+          sinon.assert.calledOnce(setConfigStub);
           sinon.assert.calledOnce(setOtherConfigsStub);
           sinon.assert.calledOnce(capabilityValidatorStub);
           sinon.assert.calledOnce(getErrorCodeFromMsgStub);
@@ -228,6 +233,8 @@ describe("runs", () => {
       getNumberOfSpecFilesStub = sandbox.stub().returns([]);
       setDefaultsStub = sandbox.stub();
       setLocalConfigFileStub = sandbox.stub();
+      setBrowsersStub = sandbox.stub();
+      setConfigStub = sandbox.stub();
     });
 
     afterEach(() => {
@@ -265,7 +272,9 @@ describe("runs", () => {
           setDefaults: setDefaultsStub,
           getNumberOfSpecFiles: getNumberOfSpecFilesStub,
           setLocalConfigFile: setLocalConfigFileStub,
-          setSystemEnvs: setSystemEnvsStub
+          setSystemEnvs: setSystemEnvsStub,
+          setBrowsers: setBrowsersStub,
+          setConfig: setConfigStub
         },
         '../helpers/capabilityHelper': {
           validate: capabilityValidatorStub,
@@ -364,6 +373,8 @@ describe("runs", () => {
       getNumberOfSpecFilesStub = sandbox.stub().returns([]);
       setDefaultsStub = sandbox.stub();
       setLocalConfigFileStub = sandbox.stub();
+      setConfigStub = sandbox.stub();
+      setBrowsersStub = sandbox.stub();
     });
 
     afterEach(() => {
@@ -401,7 +412,9 @@ describe("runs", () => {
           deleteResults: deleteResultsStub,
           getNumberOfSpecFiles: getNumberOfSpecFilesStub,
           setDefaults: setDefaultsStub,
-          setLocalConfigFile: setLocalConfigFileStub
+          setLocalConfigFile: setLocalConfigFileStub,
+          setBrowsers: setBrowsersStub,
+          setConfig: setConfigStub
         },
         '../helpers/capabilityHelper': {
           validate: capabilityValidatorStub,
@@ -505,6 +518,8 @@ describe("runs", () => {
       setDefaultsStub = sandbox.stub();
       stopLocalBinaryStub = sandbox.stub();
       setLocalConfigFileStub = sandbox.stub();
+      setConfigStub = sandbox.stub();
+      setBrowsersStub = sandbox.stub();
     });
 
     afterEach(() => {
@@ -543,7 +558,9 @@ describe("runs", () => {
           getNumberOfSpecFiles: getNumberOfSpecFilesStub,
           setDefaults: setDefaultsStub,
           stopLocalBinary: stopLocalBinaryStub,
-          setLocalConfigFile: setLocalConfigFileStub
+          setLocalConfigFile: setLocalConfigFileStub,
+          setBrowsers: setBrowsersStub,
+          setConfig: setConfigStub
         },
         '../helpers/capabilityHelper': {
           validate: capabilityValidatorStub,
@@ -663,6 +680,8 @@ describe("runs", () => {
       initTimeComponentsStub = sandbox.stub();
       markBlockStartStub = sandbox.stub();
       markBlockEndStub = sandbox.stub();
+      setConfigStub = sandbox.stub();
+      setBrowsersStub = sandbox.stub();
       stopLocalBinaryStub = sandbox.stub();
       nonEmptyArrayStub = sandbox.stub();
     });
@@ -707,6 +726,8 @@ describe("runs", () => {
           isUndefined: isUndefinedStub,
           getNumberOfSpecFiles: getNumberOfSpecFilesStub,
           setLocalConfigFile: setLocalConfigFileStub,
+          setBrowsers: setBrowsersStub,
+          setConfig: setConfigStub,
           stopLocalBinary: stopLocalBinaryStub,
           nonEmptyArray: nonEmptyArrayStub,
         },

test/unit/bin/helpers/fileHelpers.js

@@ -45,6 +45,22 @@ describe("fileHelpers", () => {
     expect(dataMock).to.eql(1);
   });
 
+  it("callback fn is executed after file write", () => {
+    let dataMock = 0;
+
+    let callbackStub = sandbox.stub().callsFake(() => {
+      dataMock = 1;
+    });
+
+    const fileExtraStub = sinon.stub(fs,'writeFile');
+    fileExtraStub.yields(true);
+    fileHelpers.write({path: "./random_path", file: "random"}, "writing successful", {}, callbackStub);
+    
+    sinon.assert.calledOnce(callbackStub);
+    sinon.assert.calledOnce(fileExtraStub);
+    expect(dataMock).to.eql(1);
+  });
+
   it("callback fn is executed after fileExists returns error", () => {
     let dataMock = undefined;