add code changes to parse and validate node version

Author: pranavj1001

bin/commands/runs.js

@@ -94,6 +94,9 @@ module.exports = function run(args, rawArgs) {
     // set record feature caps
     utils.setRecordCaps(bsConfig, args);
 
+    // set node version
+    utils.setNodeVersion(bsConfig, args);
+
     //set browsers
     await utils.setBrowsers(bsConfig, args);
 

bin/helpers/capabilityHelper.js

@@ -254,6 +254,9 @@ const validate = (bsConfig, args) => {
       }
     }
 
+    if (!Utils.isUndefined(bsConfig.run_settings.nodeVersion) && typeof(bsConfig.run_settings.nodeVersion) === 'string' && !bsConfig.run_settings.nodeVersion.match(/^(\d+\.)?(\d+\.)?(\*|\d+)$/))
+        logger.warn(Constants.validationMessages.NODE_VERSION_PARSING_ERROR);
+
     resolve(cypressJson);
   });
 }

bin/helpers/constants.js

@@ -104,7 +104,8 @@ const validationMessages = {
   SPEC_TIMEOUT_LIMIT_ERROR: "The maximum allowed value of 'spec_timeout' is 120. Read more on https://browserstack.com/docs/automate/cypress/spec-timeout ",
   SPEC_TIMEOUT_NOT_PASSED_ERROR: "'spec_timeout' key not specified. Going ahead with 30 mins as the default spec timeout. Read more about how to specify the option in https://browserstack.com/docs/automate/cypress/spec-timeout ",
   PROJECT_ID_MISSING: "You have specified '--record' flag but you've not provided the 'projectId' in cypress.json or in browserstack.json. Your record functionality on cypress.io dashboard might not work as it needs both the key and the projectId",
-  RECORD_KEY_MISSING: "You have specified '--record' flag but you've not provided the '--record-key' and we could not find any value in 'CYPRESS_RECORD_KEY' environment variable. Your record functionality on cypress.io dashboard might not work as it needs the key and projectId"
+  RECORD_KEY_MISSING: "You have specified '--record' flag but you've not provided the '--record-key' and we could not find any value in 'CYPRESS_RECORD_KEY' environment variable. Your record functionality on cypress.io dashboard might not work as it needs the key and projectId",
+  NODE_VERSION_PARSING_ERROR: "We weren't able to successfully parse the specified nodeVersion. We will be using the default nodeVersion to run your tests."
 };
 
 const cliMessages = {
@@ -151,7 +152,8 @@ const cliMessages = {
     SPEC_TIMEOUT: "Specify a value for a hard timeout for each spec execution in the 1-120 mins range. Read https://browserstack.com/docs/automate/cypress/spec-timeout for more details.",
     RECORD: "Pass the --record flag to record your Cypress runs on Cypress.io dashboard. Note: You also need to specify '--record-key' and '--projectId' arguments either in CLI or in browserstack.json.",
     RECORD_KEY: "You can specify the 'key' that is needed to record your runs on Cypress.io dashboard using the '--record-key' argument. Alternatively, you can also pass it on browserstack.json",
-    PROJECT_ID: "You can pass the 'projectId' of your Cypress.io project where you want to record your runs if specifying the '--record' key. You can also specify this in your cypress.json or in your browserstack.json."
+    PROJECT_ID: "You can pass the 'projectId' of your Cypress.io project where you want to record your runs if specifying the '--record' key. You can also specify this in your cypress.json or in your browserstack.json.",
+    NODE_VERSION: "Pass the node version that you want BrowserStack to use to run your Cypress tests on."
   },
   COMMON: {
     DISABLE_USAGE_REPORTING: "Disable usage reporting",

bin/helpers/usageReporting.js

@@ -291,4 +291,5 @@ function send(args) {
 module.exports = {
   send,
   cli_version_and_path,
+  get_version
 };

bin/helpers/utils.js

@@ -371,6 +371,36 @@ exports.setRecordCaps = (bsConfig, args) => {
   bsConfig.run_settings["projectId"] = this.setProjectId(bsConfig, args);
 }
 
+exports.verifyNodeVersionOption = () => {
+  let nvOptionsSet = (this.searchForOption('-nv') || this.searchForOption('--nv'));
+  let nodeVersionHyphenLocationOptionsSet = (this.searchForOption('-node-version') || this.searchForOption('--node-version'));
+  let nodeVersionOptionsSet = (this.searchForOption('-nodeVersion') || this.searchForOption('--nodeVersion'));
+  return (nvOptionsSet || nodeVersionHyphenLocationOptionsSet || nodeVersionOptionsSet);
+}
+
+exports.setNodeVersion = (bsConfig, args) => {
+  let userProvidedNodeVersion = this.verifyNodeVersionOption();
+  bsConfig.run_settings.userProvidedNodeVersion = (userProvidedNodeVersion || (!this.isUndefined(bsConfig.run_settings.nodeVersion)) || (!this.isUndefined(bsConfig.run_settings.nodeversion)));
+
+  if (bsConfig.run_settings.userProvidedNodeVersion) {
+    if(!this.isUndefined(args.nodeVersion)) {
+      bsConfig.run_settings.nodeVersion = args.nodeVersion;
+    } else if (!this.isUndefined(bsConfig.run_settings.nodeversion)) {
+      bsConfig.run_settings.nodeVersion = bsConfig.run_settings.nodeversion;
+    }
+  }
+
+  if (this.isUndefined(bsConfig.run_settings.nodeVersion)) {
+    bsConfig.run_settings.nodeVersion = usageReporting.get_version('node') || '';
+  }
+
+  if (bsConfig.run_settings.nodeVersion && typeof(bsConfig.run_settings.nodeVersion) === 'string' && bsConfig.run_settings.nodeVersion.charAt(0).toLowerCase() === 'v') {
+    bsConfig.run_settings.nodeVersion = bsConfig.run_settings.nodeVersion.substr(1);
+  }
+
+  logger.debug(`Setting nodeVersion = ${bsConfig.run_settings.nodeVersion}`);
+}
+
 // specs can be passed from bstack configuration file
 // specs can be passed via command line args as a string
 // command line args takes precedence over config

bin/runner.js

@@ -265,6 +265,12 @@ var argv = yargs
           default: undefined,
           describe: Constants.cliMessages.RUN.PROJECT_ID,
           type: "string"
+        },
+        'nv': {
+          alias: ['node-version', 'nodeVersion'],
+          default: undefined,
+          describe: Constants.cliMessages.RUN.NODE_VERSION,
+          type: "string"
         }
       })
       .help('help')