Merge pull request #382 from browserstack/AFD-960-release-cypress-10-3-0

Add support for Cypress v10

Author: rahuln-bs

bin/commands/runs.js

@@ -61,6 +61,9 @@ module.exports = function run(args, rawArgs) {
     // set cypress config filename
     utils.setCypressConfigFilename(bsConfig, args);
 
+    // set cypress test suite type
+    utils.setCypressTestSuiteType(bsConfig);
+
     // set cypress geo location
     utils.setGeolocation(bsConfig, args);
 
@@ -119,15 +122,15 @@ module.exports = function run(args, rawArgs) {
     // Validate browserstack.json values and parallels specified via arguments
     markBlockStart('validateConfig');
     logger.debug("Started configs validation");
-    return capabilityHelper.validate(bsConfig, args).then(function (cypressJson) {
+    return capabilityHelper.validate(bsConfig, args).then(function (cypressConfigFile) {
       markBlockEnd('validateConfig');
       logger.debug("Completed configs validation");
       markBlockStart('preArchiveSteps');
       logger.debug("Started pre-archive steps");
       //get the number of spec files
-      let specFiles = utils.getNumberOfSpecFiles(bsConfig, args, cypressJson);
+      let specFiles = utils.getNumberOfSpecFiles(bsConfig, args, cypressConfigFile);
 
-      bsConfig['run_settings']['video_config'] = utils.getVideoConfig(cypressJson);
+      bsConfig['run_settings']['video_config'] = utils.getVideoConfig(cypressConfigFile);
 
       // return the number of parallels user specified
       let userSpecifiedParallels = utils.getParallels(bsConfig, args);

bin/helpers/archiver.js

@@ -81,11 +81,14 @@ const archiveSpecs = (runSettings, filePath, excludeFiles, md5data) => {
       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: `${cypressAppendFilesZipLocation}cypress.json`});
+      if (runSettings.cypressTestSuiteType === Constants.CYPRESS_V10_AND_ABOVE_TYPE) {
+        let cypressConfigFileString = fs.readFileSync(runSettings.cypressConfigFilePath, {encoding: "utf-8"});
+        archive.append(cypressConfigFileString, {name: `${cypressAppendFilesZipLocation}${runSettings.cypress_config_filename}`});
+      } else if (runSettings.cypressTestSuiteType === Constants.CYPRESS_V9_AND_OLDER_TYPE) {
+        let cypressJSON = JSON.parse(fs.readFileSync(runSettings.cypressConfigFilePath));
+        let cypressJSONString = JSON.stringify(cypressJSON, null, 4);
+        archive.append(cypressJSONString, {name: `${cypressAppendFilesZipLocation}cypress.json`});
+      }
     }
 
     archive.finalize();

bin/helpers/buildArtifacts.js

@@ -137,13 +137,13 @@ const unzipFile = async (filePath, fileName) => {
 const sendUpdatesToBstack = async (bsConfig, buildId, args, options, rawArgs, buildReportData) => {
   options.url = `${config.buildUrl}${buildId}/build_artifacts/status`;
 
-  let cypressJSON = utils.getCypressJSON(bsConfig);
+  let cypressConfigFile = utils.getCypressConfigFile(bsConfig);
 
   let reporter = null;
   if(!utils.isUndefined(args.reporter)) {
     reporter = args.reporter;
-  } else if(cypressJSON !== undefined){
-    reporter = cypressJSON.reporter;
+  } else if(cypressConfigFile !== undefined){
+    reporter = cypressConfigFile.reporter;
   }
 
   let data = {

bin/helpers/capabilityHelper.js

@@ -162,8 +162,8 @@ const validate = (bsConfig, args) => {
 
     if (!bsConfig.run_settings) reject(Constants.validationMessages.EMPTY_RUN_SETTINGS);
 
-    if (!bsConfig.run_settings.cypress_proj_dir && !bsConfig.run_settings.userProvidedCypessConfigFile) {
-      reject(Constants.validationMessages.EMPTY_CYPRESS_PROJ_DIR);
+    if (!bsConfig.run_settings.cypressConfigFilePath && !bsConfig.run_settings.userProvidedCypessConfigFile) {
+      reject(Constants.validationMessages.EMPTY_CYPRESS_CONFIG_FILE);
     }
 
     // validate parallels specified in browserstack.json if parallels are not specified via arguments
@@ -189,25 +189,39 @@ const validate = (bsConfig, args) => {
     // validate if config file provided exists or not when cypress_config_file provided
     // validate the cypressProjectDir key otherwise.
     let cypressConfigFilePath = bsConfig.run_settings.cypressConfigFilePath;
-    let cypressJson = {};
+    let cypressConfigFile = {};
 
     logger.debug(`Checking for cypress config file at ${cypressConfigFilePath}`);
     if (!fs.existsSync(cypressConfigFilePath) && bsConfig.run_settings.cypress_config_filename !== 'false') reject(Constants.validationMessages.INVALID_CYPRESS_CONFIG_FILE);
 
-    logger.debug("Validating cypress.json");
-    try {
-      if (bsConfig.run_settings.cypress_config_filename !== 'false') {
-        let cypressJsonContent = fs.readFileSync(cypressConfigFilePath);
-        cypressJson = JSON.parse(cypressJsonContent);
+    if (bsConfig.run_settings.cypressTestSuiteType === Constants.CYPRESS_V10_AND_ABOVE_TYPE) {
+      logger.debug(`Validating ${bsConfig.run_settings.cypress_config_filename}`);
+      // TODO: add validations for cypress_config_filename
+    } else {
+      logger.debug("Validating cypress.json");
+      try {
+        if (bsConfig.run_settings.cypress_config_filename !== 'false') {
+          
+          if (bsConfig.run_settings.cypressTestSuiteType === Constants.CYPRESS_V10_AND_ABOVE_TYPE) {
+            if (cypressConfigFilePath.endsWith("cypress.config.js")) {
+              cypressConfigFile = require(cypressConfigFilePath);
+            } else {
+              cypressConfigFile = {};
+            }
+          } else {
+            let cypressJsonContent = fs.readFileSync(cypressConfigFilePath);
+            cypressConfigFile = 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.replace("<baseUrlValue>", cypressJson.baseUrl));
+          // Cypress Json Base Url & Local true check
+          if (!Utils.isUndefined(cypressConfigFile.baseUrl) && cypressConfigFile.baseUrl.includes("localhost") && !Utils.getLocalFlag(bsConfig.connection_settings)) reject(Constants.validationMessages.LOCAL_NOT_SET.replace("<baseUrlValue>", cypressConfigFile.baseUrl));
 
-        // 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.cypressProjectDir,cypressJson.integrationFolder)) reject(Constants.validationMessages.INCORRECT_DIRECTORY_STRUCTURE);
+          // Detect if the user is not using the right directory structure, and throw an error
+          if (!Utils.isUndefined(cypressConfigFile.integrationFolder) && !Utils.isCypressProjDirValid(bsConfig.run_settings.cypressProjectDir,cypressConfigFile.integrationFolder)) reject(Constants.validationMessages.INCORRECT_DIRECTORY_STRUCTURE);
+        }
+      } catch(error){
+        reject(Constants.validationMessages.INVALID_CYPRESS_JSON)
       }
-    } catch(error){
-      reject(Constants.validationMessages.INVALID_CYPRESS_JSON)
     }
 
     //check if home_directory is present or not in user run_settings
@@ -231,6 +245,24 @@ const validate = (bsConfig, args) => {
       addCypressZipStartLocation(bsConfig.run_settings);
     }
 
+    // check if two config files are present at the same location
+    let cypressFileDirectory = path.dirname(path.resolve(bsConfig.run_settings.cypressConfigFilePath));
+    let listOfFiles = fs.readdirSync(cypressFileDirectory);
+    let configFilesPresent = [];
+    for (const possibleCypressFileName of Constants.CYPRESS_CONFIG_FILE_NAMES) {
+      if (listOfFiles.includes(possibleCypressFileName)) {
+        configFilesPresent.push(possibleCypressFileName);
+      }
+    }
+
+    if (configFilesPresent.length === 0 && bsConfig.run_settings.cypress_config_filename !== 'false') {
+      reject(Constants.validationMessages.CYPRESS_CONFIG_FILE_NOT_FOUND.replace('<location>', cypressFileDirectory));
+    }
+    if (configFilesPresent.length > 1 && bsConfig.run_settings.cypress_config_filename !== 'false') {
+      logger.warn(`We found the following cypress config files ${configFilesPresent.join(', ')} at this location: ${cypressFileDirectory}`);
+      reject(Constants.validationMessages.MORE_THAN_ONE_CYPRESS_CONFIG_FILE_FOUND);
+    }
+
     if(!Utils.isUndefined(bsConfig.run_settings.spec_timeout)) {
       if(Utils.isPositiveInteger(bsConfig.run_settings.spec_timeout.toString().trim())) {
         if(Number(bsConfig.run_settings.spec_timeout) > Constants.SPEC_TIMEOUT_LIMIT) { 
@@ -257,7 +289,7 @@ 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);
+    resolve(cypressConfigFile);
   });
 }
 

bin/helpers/checkUploaded.js

@@ -37,11 +37,14 @@ const checkSpecsMd5 = (runSettings, args, instrumentBlocks) => {
         runSettings.cypress_config_file &&
         runSettings.cypress_config_filename !== 'false'
       ) {
-        let cypressJSON = JSON.parse(
-          fs.readFileSync(runSettings.cypressConfigFilePath)
-        );
-        let cypressJSONString = JSON.stringify(cypressJSON);
-        outputHash.update(cypressJSONString);
+        let cypressConfigFileString = "";
+        if (runSettings.cypressTestSuiteType === Constants.CYPRESS_V10_AND_ABOVE_TYPE) {
+          cypressConfigFileString = fs.readFileSync(runSettings.cypressConfigFilePath).toString();
+        } else {
+          let cypressJSON = JSON.parse(fs.readFileSync(runSettings.cypressConfigFilePath));
+          cypressConfigFileString = JSON.stringify(cypressJSON);
+        }
+        outputHash.update(cypressConfigFileString);
       }
       resolve(outputHash.digest(Constants.hashingOptions.encoding));
     }).catch(function (error) {

bin/helpers/constants.js

@@ -120,15 +120,19 @@ const validationMessages = {
   EMPTY_RUN_SETTINGS: "Empty run settings",
   EMPTY_CYPRESS_PROJ_DIR:
     "cypress_proj_dir is not set in run_settings. See https://www.browserstack.com/docs/automate/cypress/sample-tutorial to learn more.",
+  EMPTY_CYPRESS_CONFIG_FILE: 
+    "cypress_config_file is not set in run_settings. See https://www.browserstack.com/docs/automate/cypress/configuration-file to learn more.",
   VALIDATED: "browserstack.json file is validated",
   NOT_VALID: "browerstack.json is not valid",
   NOT_VALID_JSON: "browerstack.json is not a valid json",
   INVALID_EXTENSION: "Invalid files, please remove these files and try again.",
   INVALID_PARALLELS_CONFIGURATION:
     "Invalid value specified for parallels to use. Maximum parallels to use should be a number greater than 0.",
   INVALID_CYPRESS_CONFIG_FILE: "Invalid cypress_config_file",
-  CYPRESS_JSON_NOT_FOUND:
-    "cypress.json file is not found at cypress_proj_dir path ",
+  CYPRESS_CONFIG_FILE_NOT_FOUND: 
+    "No cypress config file was found at <location> directory.",
+  MORE_THAN_ONE_CYPRESS_CONFIG_FILE_FOUND: 
+    "Cypress does not allow more than one cypress config file.",
   INVALID_CYPRESS_JSON: "cypress.json is not a valid json",
   INVALID_DEFAULT_AUTH_PARAMS:
     "Your username and access key are required to run your tests on BrowserStack. Learn more at https://www.browserstack.com/docs/automate/cypress/authentication",
@@ -312,13 +316,17 @@ const filesToIgnoreWhileUploading = [
   "browserstack-package.json",
   "tests.zip",
   "cypress.json",
+  "cypress.config.js",
+  "cypress.config.ts",
+  "cypress.config.cjs",
+  "cypress.config.mjs",
   ".idea/**",
   ".vscode/**",
   ".npm/**",
   "bstackPackages.tar.gz",
   "tmpBstackPackages/**",
   ".yarn/**",
-  "build_artifacts/**",
+  "build_artifacts/**"
 ];
 
 const readDirOptions = {
@@ -376,6 +384,30 @@ const SPEC_TIMEOUT_LIMIT = 120; // IN MINS
 
 const CYPRESS_CUSTOM_ERRORS_TO_PRINT_KEY = "custom_errors_to_print";
 
+const CYPRESS_V9_AND_OLDER_TYPE = "CYPRESS_V9_AND_OLDER_TYPE";
+
+const CYPRESS_V10_AND_ABOVE_TYPE = "CYPRESS_V10_AND_ABOVE_TYPE";
+
+const CYPRESS_CONFIG_FILE_MAPPING = {
+  "cypress.json": {
+    type: CYPRESS_V9_AND_OLDER_TYPE
+  },
+  "cypress.config.js": {
+    type: CYPRESS_V10_AND_ABOVE_TYPE
+  },
+  "cypress.config.ts": {
+    type: CYPRESS_V10_AND_ABOVE_TYPE
+  },
+  "cypress.config.mjs": {
+    type: CYPRESS_V10_AND_ABOVE_TYPE
+  },
+  "cypress.config.cjs": {
+    type: CYPRESS_V10_AND_ABOVE_TYPE
+  }
+};
+
+const CYPRESS_CONFIG_FILE_NAMES = Object.keys(CYPRESS_CONFIG_FILE_MAPPING);
+
 module.exports = Object.freeze({
   syncCLI,
   userMessages,
@@ -402,4 +434,8 @@ module.exports = Object.freeze({
   BUILD_FAILED_EXIT_CODE,
   SPEC_TIMEOUT_LIMIT,
   CYPRESS_CUSTOM_ERRORS_TO_PRINT_KEY,
+  CYPRESS_V9_AND_OLDER_TYPE,
+  CYPRESS_V10_AND_ABOVE_TYPE,
+  CYPRESS_CONFIG_FILE_MAPPING,
+  CYPRESS_CONFIG_FILE_NAMES
 });

bin/helpers/usageReporting.js

@@ -61,9 +61,9 @@ function bstack_json_found_in_pwd() {
   }
 }
 
-function cypress_json_found_in_pwd() {
+function cypress_config_file_found_in_pwd(cypress_config_filename) {
   try {
-    if (fs.existsSync(path.join(process.cwd(), 'cypress.json'))) {
+    if (fs.existsSync(path.join(process.cwd(), cypress_config_filename))) {
       //file exists
       return true;
     }
@@ -244,7 +244,7 @@ function send(args) {
       os: _os(),
       os_version: os_version(),
       bstack_json_found_in_pwd: bstack_json_found_in_pwd(),
-      cypress_json_found_in_pwd: cypress_json_found_in_pwd(),
+      cypress_config_file_found_in_pwd: cypress_config_file_found_in_pwd(runSettings.cypress_config_filename),
       cli_version: cli_details.version,
       cli_path: cli_details.path,
       npm_version: npm_version(),