add code changes to capture, validate and send ip geolocation

Author: pranavj1001

bin/commands/runs.js

@@ -48,6 +48,9 @@ module.exports = function run(args, rawArgs) {
     // set cypress config filename
     utils.setCypressConfigFilename(bsConfig, args);
 
+    // set cypress geo location
+    utils.setGeoLocation(bsConfig, args);
+
     // accept the specs list from command line if provided
     utils.setUserSpecs(bsConfig, args);
 

bin/helpers/capabilityHelper.js

@@ -164,6 +164,8 @@ const validate = (bsConfig, args) => {
 
     if( Utils.searchForOption('--async') && ( !Utils.isUndefined(args.async) && bsConfig["connection_settings"]["local"])) reject(Constants.validationMessages.INVALID_LOCAL_ASYNC_ARGS);
 
+    if (bsConfig.run_settings.userProvidedGeoLocation && bsConfig.run_settings.geolocation.match(/^[A-Z]{2}$/g)) reject(Constants.validationMessages.INVALID_GEO_LOCATION);
+    
     // validate if config file provided exists or not when cypress_config_file provided
     // validate the cypressProjectDir key otherwise.
     let cypressConfigFilePath = bsConfig.run_settings.cypressConfigFilePath;

bin/helpers/constants.js

@@ -87,6 +87,10 @@ const validationMessages = {
   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",
   INVALID_LOCAL_ASYNC_ARGS: "Cannot run in --async mode when local is set to true. Please run the build after removing --async",
+  INVALID_GEO_LOCATION: "[BROWSERSTACK_INVALID_COUNTRY_CODE] The country code specified for 'browserstack.geoLocation' is invalid. For list of supported countries, refer to -  https://www.browserstack.com/ip-geolocation",
+  NOT_SUPPORTED_GEO_LOCATION: "The country code you have passed for IP Geolocation is currently not supported. Please refer the link https://www.browserstack.com/ip-geolocation for a list of supported countries.",
+  NOT_AVAILABLE_GEO_LOCATION: "The country code you have passed for IP Geolocation is not available at the moment. Please try again in a few hours.",
+  ACCESS_DENIED_GEO_LOCATION: "'geolocation' (IP Geolocation feature) capability is not supported in your account. It is only available under Enterprise plans, refer https://www.browserstack.com/ip-geolocation for more details."
 };
 
 const cliMessages = {
@@ -129,6 +133,7 @@ const cliMessages = {
     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",
+    CYPRESS_GEO_LOCATION: "Enterprise feature to simulate website and mobile behavior from different locations."
   },
   COMMON: {
     DISABLE_USAGE_REPORTING: "Disable usage reporting",

bin/helpers/utils.js

@@ -272,6 +272,28 @@ exports.setCypressConfigFilename = (bsConfig, args) => {
   }
 }
 
+exports.verifyGeoLocationOption = () => {
+  let glOptionsSet = (this.searchForOption('-gl') || this.searchForOption('--gl'));
+  let geoHyphenLocationOptionsSet = (this.searchForOption('-geo-location') || this.searchForOption('--geo-location'));
+  let geoLocationOptionsSet = (this.searchForOption('-geolocation') || this.searchForOption('--geolocation'));
+  return (glOptionsSet || geoHyphenLocationOptionsSet || geoLocationOptionsSet);
+}
+
+exports.setGeoLocation = (bsConfig, args) => {
+  let userProvidedGeoLocation = this.verifyGeoLocationOption();
+  bsConfig.run_settings.userProvidedGeoLocation = (userProvidedGeoLocation || (!this.isUndefined(bsConfig.run_settings.geolocation)));
+
+  if (userProvidedGeoLocation && !this.isUndefined(args.geolocation)) {
+      bsConfig.run_settings.geolocation = args.geolocation;
+  }
+
+  if (this.isUndefined(bsConfig.run_settings.geolocation)){
+    bsConfig.run_settings.geolocation = null;
+  } else {
+    bsConfig.run_settings.geolocation = bsConfig.run_settings.geolocation.toUpperCase();
+  }
+}
+
 // 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

@@ -133,6 +133,13 @@ var argv = yargs
           demand: true,
           demand: Constants.cliMessages.RUN.CYPRESS_CONFIG_DEMAND
         },
+        'gl': {
+          alias: 'geolocation',
+          describe: Constants.cliMessages.RUN.CYPRESS_GEO_LOCATION,
+          default: undefined,
+          type: 'string',
+          nargs: 1
+        },
         'p': {
           alias: ['parallels', 'parallel'],
           describe: Constants.cliMessages.RUN.PARALLEL_DESC,