Merge branch 'master' of github.com:roshan04/browserstack-cypress-cli into build_stacktace_for_cli

Author: roshan04

bin/commands/runs.js

@@ -50,6 +50,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);
 
@@ -255,6 +258,9 @@ module.exports = function run(args, rawArgs) {
                 utils.sendUsageReport(bsConfig, args, `${message}\n${dashboardLink}`, Constants.messageTypes.SUCCESS, null, buildReportData, rawArgs);
                 return;
               }).catch(async function (err) {
+                if (err && err.includes('browserstack.geoLocation')) {
+                  err = err.replace(/browserstack.geoLocation/g, 'geolocation');
+                }
                 // Build creation failed
                 logger.error(err);
                 // stop the Local instance

bin/helpers/archiver.js

@@ -1,11 +1,11 @@
 'use strict';
-const fs = require("fs");
+const fs = require("fs"),
+    path = require("path");
 
 const archiver = require("archiver"),
   Constants = require('../helpers/constants'),
   logger = require("./logger").winstonLogger,
-  utils = require('../helpers/utils'),
-  path = require('path');
+  utils = require('../helpers/utils');
 
 const archiveSpecs = (runSettings, filePath, excludeFiles, md5data) => {
   return new Promise(function (resolve, reject) {
@@ -14,7 +14,17 @@ const archiveSpecs = (runSettings, filePath, excludeFiles, md5data) => {
     }
     var output = fs.createWriteStream(filePath);
 
-    var cypressFolderPath = path.dirname(runSettings.cypressConfigFilePath);
+    var cypressFolderPath = '';
+    let cypressAppendFilesZipLocation = '';
+    if (runSettings.home_directory) {
+      cypressFolderPath = runSettings.home_directory;
+      cypressAppendFilesZipLocation = runSettings.cypressZipStartLocation;
+      if (cypressAppendFilesZipLocation !== '') {
+        cypressAppendFilesZipLocation += '/';
+      }
+    } else {
+      cypressFolderPath = path.dirname(runSettings.cypressConfigFilePath);
+    }
 
     logger.info(`Creating tests.zip with files in ${cypressFolderPath}`);
 
@@ -61,7 +71,7 @@ const archiveSpecs = (runSettings, filePath, excludeFiles, md5data) => {
 
     if (Object.keys(packageJSON).length > 0) {
       let packageJSONString = JSON.stringify(packageJSON, null, 4);
-      archive.append(packageJSONString, {name: 'browserstack-package.json'});
+      archive.append(packageJSONString, {name: `${cypressAppendFilesZipLocation}browserstack-package.json`});
     }
 
     // do not add cypress.json if arg provided is false
@@ -73,7 +83,7 @@ const archiveSpecs = (runSettings, filePath, excludeFiles, md5data) => {
         fs.readFileSync(runSettings.cypressConfigFilePath)
       );
       let cypressJSONString = JSON.stringify(cypressJSON, null, 4);
-      archive.append(cypressJSONString, {name: 'cypress.json'});
+      archive.append(cypressJSONString, {name: `${cypressAppendFilesZipLocation}cypress.json`});
     }
 
     archive.finalize();

bin/helpers/capabilityHelper.js

@@ -1,7 +1,9 @@
+const fs = require('fs'),
+  path = require('path');
+
 const logger = require("./logger").winstonLogger,
   Constants = require("./constants"),
-  Utils = require("./utils"),
-  fs = require('fs');
+  Utils = require("./utils");
 
 const caps = (bsConfig, zip) => {
   return new Promise(function (resolve, reject) {
@@ -129,6 +131,13 @@ const caps = (bsConfig, zip) => {
   })
 }
 
+const addCypressZipStartLocation = (runSettings) => {
+  let resolvedHomeDirectoryPath = path.resolve(runSettings.home_directory);
+  let resolvedCypressConfigFilePath = path.resolve(runSettings.cypressConfigFilePath);
+  runSettings.cypressZipStartLocation = path.dirname(resolvedCypressConfigFilePath.split(resolvedHomeDirectoryPath)[1]);
+  runSettings.cypressZipStartLocation = runSettings.cypressZipStartLocation.substring(1);
+}
+
 const validate = (bsConfig, args) => {
   return new Promise(function (resolve, reject) {
     logger.info(Constants.userMessages.VALIDATING_CONFIG);
@@ -164,6 +173,10 @@ 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);
+
+    if (bsConfig["connection_settings"]["local"] && bsConfig.run_settings.userProvidedGeolocation) reject(Constants.validationMessages.NOT_ALLOWED_GEO_LOCATION_AND_LOCAL_MODE);
+    
     // validate if config file provided exists or not when cypress_config_file provided
     // validate the cypressProjectDir key otherwise.
     let cypressConfigFilePath = bsConfig.run_settings.cypressConfigFilePath;
@@ -185,11 +198,33 @@ const validate = (bsConfig, args) => {
     } catch(error){
       reject(Constants.validationMessages.INVALID_CYPRESS_JSON)
     }
+
+    //check if home_directory is present or not in user run_settings
+    if (!Utils.isUndefined(bsConfig.run_settings.home_directory)) {
+      // check if home_directory exists or not
+      if (!fs.existsSync(bsConfig.run_settings.home_directory)) {
+        reject(Constants.validationMessages.HOME_DIRECTORY_NOT_FOUND);
+      }
+
+      // check if home_directory is a directory or not
+      if (!fs.statSync(bsConfig.run_settings.home_directory).isDirectory()) {
+        reject(Constants.validationMessages.HOME_DIRECTORY_NOT_A_DIRECTORY);
+      }
+
+      // check if cypress config file (cypress.json) is a part of home_directory or not
+      if (!path.resolve(bsConfig.run_settings.cypressConfigFilePath).includes(path.resolve(bsConfig.run_settings.home_directory))) {
+        reject(Constants.validationMessages.CYPRESS_CONFIG_FILE_NOT_PART_OF_HOME_DIRECTORY);
+      }
+
+      addCypressZipStartLocation(bsConfig.run_settings);
+    }
+
     resolve(cypressJson);
   });
 }
 
 module.exports = {
   caps,
+  addCypressZipStartLocation,
   validate
 }

bin/helpers/checkUploaded.js

@@ -15,7 +15,12 @@ const checkSpecsMd5 = (runSettings, args, instrumentBlocks) => {
     if (args["force-upload"]) {
       return resolve("force-upload");
     }
-    let cypressFolderPath = path.dirname(runSettings.cypressConfigFilePath);
+    let cypressFolderPath = undefined;
+    if (runSettings.home_directory) {
+      cypressFolderPath = runSettings.home_directory;
+    } else {
+      cypressFolderPath = path.dirname(runSettings.cypressConfigFilePath);
+    }
     let ignoreFiles = utils.getFilesToIgnore(runSettings, args.exclude, false);
     let options = {
       cwd: cypressFolderPath,

bin/helpers/constants.js

@@ -89,6 +89,14 @@ 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 '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.",
+  NOT_ALLOWED_GEO_LOCATION_AND_LOCAL_MODE: "IP Geolocation feature is not available in conjunction with BrowserStack Local.",
+  HOME_DIRECTORY_NOT_FOUND: "Specified home directory could not be found. Please make sure the path of the home directory is correct.",
+  HOME_DIRECTORY_NOT_A_DIRECTORY: "Specified home directory is not a directory. The home directory can only be a directory and not a file.",
+  CYPRESS_CONFIG_FILE_NOT_PART_OF_HOME_DIRECTORY: "Could not find cypress.json within the specified home directory. Please make sure cypress.json resides within the home directory."
 };
 
 const cliMessages = {
@@ -131,6 +139,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/packageInstaller.js

@@ -63,7 +63,7 @@ const packageInstall = (packageDir) => {
       logger.error(`Some error occurred while installing packages: ${error}`);
       reject(`Packages were not installed successfully.`);
     };
-    nodeProcess = spawn('npm', ['install'], {cwd: packageDir});
+    nodeProcess = spawn(/^win/.test(process.platform) ? 'npm.cmd' : 'npm', ['install'], {cwd: packageDir});
     nodeProcess.on('close', nodeProcessCloseCallback);
     nodeProcess.on('error', nodeProcessErrorCallback);
   });

bin/helpers/utils.js

@@ -85,6 +85,21 @@ exports.getErrorCodeFromMsg = (errMsg) => {
     case Constants.validationMessages.INVALID_LOCAL_ASYNC_ARGS:
       errorCode = 'invalid_local_async_args';
       break;
+    case Constants.validationMessages.INVALID_GEO_LOCATION:
+      errorCode = 'invalid_geo_location';
+      break;
+    case Constants.validationMessages.NOT_ALLOWED_GEO_LOCATION_AND_LOCAL_MODE:
+      errorCode = 'not_allowed_geo_location_and_local_mode';
+      break;
+    case Constants.validationMessages.HOME_DIRECTORY_NOT_FOUND:
+      errorCode = 'home_directory_not_found';
+      break;
+    case Constants.validationMessages.HOME_DIRECTORY_NOT_A_DIRECTORY:
+      errorCode = 'home_directory_not_a_directory';
+      break;
+    case Constants.validationMessages.CYPRESS_CONFIG_FILE_NOT_PART_OF_HOME_DIRECTORY:
+      errorCode = 'cypress_config_file_not_part_of_home_directory';
+      break;
   }
   if (
     errMsg.includes("Please use --config-file <path to browserstack.json>.")
@@ -272,6 +287,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/helpers/zipUpload.js

@@ -10,9 +10,18 @@ const config = require("./config"),
   Constants = require("./constants"),
   utils = require("./utils");
 
-const uploadSuits = (bsConfig, filePath, opts) => {
+
+const purgeUploadBar = (obj) => {
+  obj.bar1.update(100, {
+    speed: ((obj.size / (Date.now() - obj.startTime)) / 125).toFixed(2) //kbits per sec
+  });
+  obj.bar1.stop();
+  clearInterval(obj.zipInterval);
+}
+
+const uploadSuits = (bsConfig, filePath, opts, obj) => {
   return new Promise(function (resolve, reject) {
-    let startTime = Date.now();
+    obj.startTime = Date.now();
 
     if (opts.urlPresent) {
       return resolve({ [opts.md5ReturnKey]: opts.url });
@@ -21,28 +30,26 @@ const uploadSuits = (bsConfig, filePath, opts) => {
       return resolve({});
     }
 
-    let size = fs.lstatSync(filePath).size;
+    let size = obj.size;
 
     // create new progress bar
-    let bar1 = new cliProgress.SingleBar({
-      format: `${filePath} [{bar}] {percentage}% | ETA: {eta}s | Speed: {speed} kbps | Duration: {duration}s [${(size / 1000000).toFixed(2)} MB]`,
-      hideCursor: true,
+    obj.bar1 = new cliProgress.SingleBar({
+      format: `${filePath} [{bar}] {percentage}% | ETA: {eta}s | Speed: {speed} kbps | Duration: {duration}s [${(size / 1000000).toFixed(2)} MB]`
     });
 
-    bar1.start(100, 0, {
+    obj.bar1.start(100, 0, {
       speed: "N/A"
     });
 
-    bar1.on('start', () => {
+    obj.bar1.on('start', () => {
     });
 
-    bar1.on('stop', () => {
+    obj.bar1.on('stop', () => {
     });
 
     let options = utils.generateUploadParams(bsConfig, filePath, opts.md5Data, opts.fileDetails)
     let responseData = null;
     var r = request.post(options, function (err, resp, body) {
-      clearInterval(q);
 
       if (err) {
         reject(err);
@@ -55,7 +62,7 @@ const uploadSuits = (bsConfig, filePath, opts) => {
         if (resp.statusCode != 200) {
           if (resp.statusCode == 401) {
             if (responseData && responseData["error"]) {
-              responseData["time"] = Date.now() - startTime;
+              responseData["time"] = Date.now() - obj.startTime;
               return reject(responseData["error"]);
             } else {
               return reject(Constants.validationMessages.INVALID_DEFAULT_AUTH_PARAMS);
@@ -65,7 +72,7 @@ const uploadSuits = (bsConfig, filePath, opts) => {
             return resolve({});
           }
           if(responseData && responseData["error"]){
-            responseData["time"] = Date.now() - startTime;
+            responseData["time"] = Date.now() - obj.startTime;
             reject(responseData["error"]);
           } else {
             if (resp.statusCode == 413) {
@@ -75,30 +82,26 @@ const uploadSuits = (bsConfig, filePath, opts) => {
             }
           }
         } else {
-          bar1.update(100, {
-            speed: ((size / (Date.now() - startTime)) / 125).toFixed(2) //kbits per sec
-          });
-          bar1.stop();
+          purgeUploadBar(obj);
           logger.info(`${opts.messages.uploadingSuccess} (${responseData[opts.md5ReturnKey]})`);
           opts.cleanupMethod();
-          responseData["time"] = Date.now() - startTime;
+          responseData["time"] = Date.now() - obj.startTime;
           resolve(responseData);
         }
       }
     });
 
-    var q = setInterval(function () {
+    obj.zipInterval = setInterval(function () {
       let dispatched = r.req.connection._bytesDispatched;
       let percent = dispatched * 100.0 / size;
-      bar1.update(percent, {
-        speed: ((dispatched / (Date.now() - startTime)) / 125).toFixed(2) //kbits per sec
+      obj.bar1.update(percent, {
+        speed: ((dispatched / (Date.now() - obj.startTime)) / 125).toFixed(2) //kbits per sec
       });
     }, 150);
 
   });
 }
 
-
 const uploadCypressZip = (bsConfig, md5data, packageData) => {
   return new Promise(function (resolve, reject) {
     let obj = {}
@@ -116,8 +119,22 @@ const uploadCypressZip = (bsConfig, md5data, packageData) => {
       logger.info(npmOptions.messages.uploading);
     }
 
-    let zipUpload = uploadSuits(bsConfig, config.fileName, zipOptions);
-    let npmPackageUpload = uploadSuits(bsConfig, config.packageFileName, npmOptions);
+    var testZipUploadObj = {
+      bar1: null,
+      zipInterval: null,
+      size: fs.existsSync(config.fileName) ? fs.lstatSync(config.fileName).size : 0,
+      startTime: null
+    }
+
+    var npmPackageZipUploadObj = {
+      bar1: null,
+      zipInterval: null,
+      size: fs.existsSync(config.packageFileName) ? fs.lstatSync(config.packageFileName).size : 0,
+      startTime: null
+    }
+
+    let zipUpload = uploadSuits(bsConfig, config.fileName, zipOptions, testZipUploadObj);
+    let npmPackageUpload = uploadSuits(bsConfig, config.packageFileName, npmOptions, npmPackageZipUploadObj);
     Promise.all([zipUpload, npmPackageUpload]).then(function (uploads) {
       uploads.forEach(upload => {
         if(upload.zip_url && upload.time) {
@@ -130,6 +147,8 @@ const uploadCypressZip = (bsConfig, md5data, packageData) => {
       });
       return resolve(obj);
     }).catch((error) => {
+      purgeUploadBar(testZipUploadObj);
+      purgeUploadBar(npmPackageZipUploadObj);
       return reject(error);
     })
   })

bin/runner.js

@@ -133,6 +133,12 @@ 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'
+        },
         'p': {
           alias: ['parallels', 'parallel'],
           describe: Constants.cliMessages.RUN.PARALLEL_DESC,