Adding cypressConfigFilePath and userProvidedCypressConfigFile options

cypressConfigFilePath has cypress_config_file or proj_dir + cypress.json based on userProvidedCypressConfigFile value.
This enables the current users to use cypress_proj_dir as is for now until we remove it.

Author: suryart

bin/helpers/archiver.js

@@ -2,13 +2,14 @@
 const fs = require("fs");
 
 const archiver = require("archiver"),
-  logger = require("./logger").winstonLogger;
+  logger = require("./logger").winstonLogger,
+  path = require('path');
 
 const archiveSpecs = (runSettings, filePath) => {
   return new Promise(function (resolve, reject) {
     var output = fs.createWriteStream(filePath);
 
-    var cypressFolderPath = runSettings.cypress_proj_dir;
+    var cypressFolderPath = path.dirname(runSettings.cypressConfigFilePath);
 
     var archive = archiver('zip', {
       zlib: { level: 9 } // Sets the compression level.
@@ -38,7 +39,7 @@ const archiveSpecs = (runSettings, filePath) => {
 
     let allowedFileTypes = [ 'js', 'json', 'txt', 'ts', 'feature', 'features' ];
     allowedFileTypes.forEach(fileType => {
-      archive.glob(`**/*.${fileType}`, { cwd: cypressFolderPath, matchBase: true, ignore: ['node_modules/**', 'package-lock.json', 'package.json', 'browserstack-package.json'] });
+      archive.glob(`**/*.${fileType}`, { cwd: cypressFolderPath, matchBase: true, ignore: ['node_modules/**', 'package-lock.json', 'package.json', 'browserstack-package.json', 'cypress.json'] });
     });
 
     let packageJSON = {};
@@ -56,6 +57,13 @@ const archiveSpecs = (runSettings, filePath) => {
       archive.append(packageJSONString, { name: 'browserstack-package.json' });
     }
 
+    // do not add cypress.json if arg provided is false
+    if (runSettings.cypress_config_file && runSettings.cypress_config_filename !== 'false') {
+      let cypressJSON = JSON.parse(fs.readFileSync(runSettings.cypressConfigFilePath));
+      let cypressJSONString = JSON.stringify(cypressJSON, null, 4);
+      archive.append(cypressJSONString, { name: 'cypress.json' });
+    }
+
     archive.finalize();
   });
 }

bin/helpers/capabilityHelper.js

@@ -67,10 +67,14 @@ const caps = (bsConfig, zip) => {
       obj.callbackURL = bsConfig.run_settings.callback_url;
       obj.projectNotifyURL = bsConfig.run_settings.project_notify_URL;
       obj.parallels = bsConfig.run_settings.parallels;
+
+      if (bsConfig.run_settings.cypress_config_filename) {
+        obj.cypress_config_filename = bsConfig.run_settings.cypress_config_filename;
+      }
     }
 
     if(obj.parallels === Constants.constants.DEFAULT_PARALLEL_MESSAGE) obj.parallels = undefined
-    
+
     if (obj.project) logger.log(`Project name is: ${obj.project}`);
 
     if (obj.customBuildName) logger.log(`Build name is: ${obj.customBuildName}`);
@@ -106,18 +110,24 @@ const validate = (bsConfig, args) => {
     // if parallels specified via arguments validate only arguments
     if (!Utils.isUndefined(args) && !Utils.isUndefined(args.parallels) && !Utils.isParallelValid(args.parallels)) reject(Constants.validationMessages.INVALID_PARALLELS_CONFIGURATION);
 
-    if (!fs.existsSync(path.join(bsConfig.run_settings.cypress_proj_dir, 'cypress.json'))) reject(Constants.validationMessages.CYPRESS_JSON_NOT_FOUND + bsConfig.run_settings.cypress_proj_dir);
+    // validate if config file provided exists or not when cypress_config_file provided
+    // validate existing cypress_proj_dir key otherwise.
+    let cypressConfigFilePath = bsConfig.run_settings.cypressConfigFilePath;
+
+    if (!fs.existsSync(cypressConfigFilePath) && bsConfig.run_settings.cypress_config_filename !== 'false') reject(Constants.validationMessages.CYPRESS_JSON_NOT_FOUND + cypressConfigFilePath);
 
     try {
-      let cypressJson = fs.readFileSync(path.join(bsConfig.run_settings.cypress_proj_dir, 'cypress.json'));
-      cypressJson = JSON.parse(cypressJson);
-      // Cypress Json Base Url & Local true check
-      if (!Utils.isUndefined(cypressJson.baseUrl) && cypressJson.baseUrl.includes("localhost") && !Utils.getLocalFlag(bsConfig.connection_settings)) reject(Constants.validationMessages.LOCAL_NOT_SET);
-      
-      // Detect if the user is not using the right directory structure, and throw an error
-      if (!Utils.isUndefined(cypressJson.integrationFolder) && !Utils.isCypressProjDirValid(bsConfig.run_settings.cypress_proj_dir,cypressJson.integrationFolder)) reject(Constants.validationMessages.INCORRECT_DIRECTORY_STRUCTURE);
-
-    } catch (error) {
+      if (bsConfig.run_settings.cypress_config_filename !== 'false') {
+        let cypressJsonContent = fs.readFileSync(cypressConfigFilePath);
+        cypressJson = JSON.parse(cypressJsonContent);
+
+        // Cypress Json Base Url & Local true check
+        if (!Utils.isUndefined(cypressJson.baseUrl) && cypressJson.baseUrl.includes("localhost") && !Utils.getLocalFlag(bsConfig.connection_settings)) reject(Constants.validationMessages.LOCAL_NOT_SET);
+
+        // Detect if the user is not using the right directory structure, and throw an error
+        if (!Utils.isUndefined(cypressJson.integrationFolder) && !Utils.isCypressProjDirValid(bsConfig.run_settings.cypress_proj_dir,cypressJson.integrationFolder)) reject(Constants.validationMessages.INCORRECT_DIRECTORY_STRUCTURE);
+      }
+    } catch(error){
       reject(Constants.validationMessages.INVALID_CYPRESS_JSON)
     }
 

bin/helpers/utils.js

@@ -122,12 +122,15 @@ exports.verifyCypressConfigFileOption = () => {
 }
 
 exports.setCypressConfigFilename = (bsConfig, args) => {
-  let userPassedCypessConfigFile = this.verifyCypressConfigFileOption();
+  let userProvidedCypessConfigFile = this.verifyCypressConfigFileOption();
 
-  if (userPassedCypessConfigFile || this.isUndefined(bsConfig.run_settings.cypress_config_file)) {
+  if (userProvidedCypessConfigFile || this.isUndefined(bsConfig.run_settings.cypress_config_file)) {
     bsConfig.run_settings.cypress_config_filename = path.basename(args.cypressConfigFile);
     bsConfig.run_settings.cypress_config_file = args.cypressConfigFile;
+    bsConfig.run_settings.userProvidedCypessConfigFile = userProvidedCypessConfigFile;
   }
+
+  bsConfig.run_settings.cypressConfigFilePath = userProvidedCypessConfigFile ? bsConfig.run_settings.cypress_config_file : path.join(bsConfig.run_settings.cypress_proj_dir, 'cypress.json');
 }
 
 exports.isUndefined = value => (value === undefined || value === null);