add code changes to add support for home directory

Author: pranavj1001

bin/helpers/archiver.js

@@ -1,11 +1,10 @@
 'use strict';
-const fs = require("fs");
-
 const archiver = require("archiver"),
   Constants = require('../helpers/constants'),
   logger = require("./logger").winstonLogger,
   utils = require('../helpers/utils'),
-  path = require('path');
+  path = require('path'),
+  fs = require("fs");
 
 const archiveSpecs = (runSettings, filePath, excludeFiles, md5data) => {
   return new Promise(function (resolve, reject) {
@@ -14,7 +13,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 +70,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 +82,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,8 @@
 const logger = require("./logger").winstonLogger,
   Constants = require("./constants"),
   Utils = require("./utils"),
-  fs = require('fs');
+  fs = require('fs'),
+  path = require('path');
 
 const caps = (bsConfig, zip) => {
   return new Promise(function (resolve, reject) {
@@ -129,6 +130,16 @@ const caps = (bsConfig, zip) => {
   })
 }
 
+const addCypressZipStartLocation = (runSettings) => {
+  let resolvedHomeDirectoryPath = path.resolve(runSettings.home_directory);
+  let resolvedCypressConfigFilePath = path.resolve(runSettings.cypressConfigFilePath);
+  // For example
+  // resolvedHomeDirectoryPath -> '/Users/<user_name>/path'
+  // resolvedCypressConfigFilePath -> '/Users/<user_name>/path/cypress.json' or '/Users/<user_name>/path/more_path/cypress.json'
+  runSettings.cypressZipStartLocation = path.dirname(resolvedCypressConfigFilePath.split(resolvedHomeDirectoryPath)[1]); // cypressZipStartLocation -> '/' or '/more_path'
+  runSettings.cypressZipStartLocation = runSettings.cypressZipStartLocation.substring(1); // cypressZipStartLocation -> '' or 'more_path'
+}
+
 const validate = (bsConfig, args) => {
   return new Promise(function (resolve, reject) {
     logger.info(Constants.userMessages.VALIDATING_CONFIG);
@@ -185,6 +196,27 @@ 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);
   });
 }

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

@@ -84,6 +84,9 @@ 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",
+  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 = {

bin/helpers/utils.js

@@ -85,6 +85,15 @@ exports.getErrorCodeFromMsg = (errMsg) => {
     case Constants.validationMessages.INVALID_LOCAL_ASYNC_ARGS:
       errorCode = 'invalid_local_async_args';
       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>.")