Merge branch 'master' into fix_cypress_v13_approach_2

Author: karanshah-browserstack

bin/accessibility-automation/cypress/index.js

@@ -3,7 +3,7 @@
 const browserStackLog = (message) => {
     if (!Cypress.env('BROWSERSTACK_LOGS')) return;
     cy.task('browserstack_log', message);
-  }
+}
 
 const commandsToWrap = ['visit', 'click', 'type', 'request', 'dblclick', 'rightclick', 'clear', 'check', 'uncheck', 'select', 'trigger', 'selectFile', 'scrollIntoView', 'scroll', 'scrollTo', 'blur', 'focus', 'go', 'reload', 'submit', 'viewport', 'origin'];
 // scroll is not a default function in cypress.

bin/accessibility-automation/helper.js

@@ -21,7 +21,7 @@ exports.checkAccessibilityPlatform = (user_config) => {
       }
     })
   } catch {}
-
+  
   return accessibility;
 }
 
@@ -113,35 +113,33 @@ exports.createAccessibilityTestRun = async (user_config, framework) => {
 
   } catch (error) {
     if (error.response) {
-      logger.error("Incorrect Cred")
+      logger.error("Incorrect Cred");
       logger.error(
         `Exception while creating test run for BrowserStack Accessibility Automation: ${
           error.response.status
-        } ${error.response.statusText} ${JSON.stringify(error.response.data)}`
+        } ${error.response.statusText} ${JSON.stringify(error.response.data)}
+        `
       );
-    } else {
-      if(error.message === 'Invalid configuration passed.') {
-        logger.error("Invalid configuration passed.")
-        logger.error(
-          `Exception while creating test run for BrowserStack Accessibility Automation: ${
-            error.message || error.stack
-          }`
-        );
-        for(const errorkey of error.errors){
-          logger.error(errorkey.message);
-        }
-
-      } else {
-        logger.error(
-          `Exception while creating test run for BrowserStack Accessibility Automation: ${
-            error.message || error.stack
-          }`
-        );
+    } else if (error.message === 'Invalid configuration passed.') {
+      logger.error("Invalid configuration passed.");
+      logger.error(
+        `Exception while creating test run for BrowserStack Accessibility Automation: ${
+          error.message || error.stack
+        }`
+      );
+      for (const errorkey of error.errors) {
+        logger.error(errorkey.message);
       }
-      // since create accessibility session failed
-      process.env.BROWSERSTACK_TEST_ACCESSIBILITY = 'false';
-      user_config.run_settings.accessibility = false; 
+    } else {
+      logger.error(
+        `Exception while creating test run for BrowserStack Accessibility Automation: ${
+          error.message || error.stack
+        }`
+      );
     }
+    // since create accessibility session failed
+    process.env.BROWSERSTACK_TEST_ACCESSIBILITY = 'false';
+    user_config.run_settings.accessibility = false; 
   }
 }
 
@@ -216,22 +214,52 @@ const getAccessibilityCypressCommandEventListener = (extName) => {
 
 exports.setAccessibilityEventListeners = (bsConfig) => {
   try {
-    // Searching form command.js recursively
+
     const supportFilesData = helper.getSupportFiles(bsConfig, true);
     if(!supportFilesData.supportFile) return;
-    glob(process.cwd() + supportFilesData.supportFile, {}, (err, files) => {
-      if(err) return logger.debug('EXCEPTION IN BUILD START EVENT : Unable to parse cypress support files');
+    
+    const isPattern = glob.hasMagic(supportFilesData.supportFile);
+    if(!isPattern) {
+      logger.debug(`Using user defined support file: ${supportFilesData.supportFile}`);
+      let file;
+      try {
+            file = process.cwd() + supportFilesData.supportFile;
+            const defaultFileContent = fs.readFileSync(file, {encoding: 'utf-8'});
+            let cypressCommandEventListener = getAccessibilityCypressCommandEventListener(path.extname(file));
+            const alreadyIncludes = defaultFileContent.includes(cypressCommandEventListener);
+            if(!alreadyIncludes) {
+              let newFileContent = defaultFileContent + 
+                                  '\n' +
+                                  cypressCommandEventListener +
+                                  '\n';
+              fs.writeFileSync(file, newFileContent, {encoding: 'utf-8'});
+              supportFileContentMap[file] = supportFilesData.cleanupParams ? supportFilesData.cleanupParams : defaultFileContent;
+            }
+          } catch(e) {
+              logger.debug(`Unable to modify file contents for ${file} to set event listeners with error ${e}`, true, e);
+            }
+      return;      
+    }
+    
+    const globPattern = process.cwd() + supportFilesData.supportFile;
+    glob(globPattern, {}, (err, files) => {
+      if(err) {
+        logger.debug('EXCEPTION IN BUILD START EVENT : Unable to parse cypress support files');
+        return;
+      }
+      
       files.forEach(file => {
         try {
-          if(!file.includes('commands.js') && !file.includes('commands.ts')) {
+          const fileName = path.basename(file);
+          if(['e2e.js', 'e2e.ts', 'component.ts', 'component.js'].includes(fileName) && !file.includes('node_modules')) {
+        
             const defaultFileContent = fs.readFileSync(file, {encoding: 'utf-8'});
-
             let cypressCommandEventListener = getAccessibilityCypressCommandEventListener(path.extname(file));
             if(!defaultFileContent.includes(cypressCommandEventListener)) {
-              let newFileContent =  defaultFileContent + 
+              let newFileContent = defaultFileContent + 
                                   '\n' +
                                   cypressCommandEventListener +
-                                  '\n'
+                                  '\n';
               fs.writeFileSync(file, newFileContent, {encoding: 'utf-8'});
               supportFileContentMap[file] = supportFilesData.cleanupParams ? supportFilesData.cleanupParams : defaultFileContent;
             }