refactor

Author: rev-doshi

bin/accessibility-automation/cypress/index.js

@@ -7,9 +7,7 @@ Cypress.on('test:before:run', () => {
   if (extensionPath !== undefined) {
     new Promise((resolve, reject) => {
       window.parent.addEventListener('A11Y_TAP_STARTED', () => {
-        console.log("A11Y_TAP_STARTED !!!! resolving")
         resolve("A11Y_TAP_STARTED");
-        console.log("A11Y_TAP_STARTED !!!! after resolve")
       });
       const e = new CustomEvent('A11Y_FORCE_START');
       window.parent.dispatchEvent(e);

bin/accessibility-automation/helper.js

@@ -89,6 +89,8 @@ exports.createAccessibilityTestRun = async (user_config, framework) => {
 
     this.setAccessibilityCypressCapabilities(user_config, response.data);
     setAccessibilityEventListeners();
+          // setEventListeners();
+
 
   } catch (error) {
     if (error.response) {
@@ -115,7 +117,9 @@ exports.createAccessibilityTestRun = async (user_config, framework) => {
           }`
         );
       }
-      user_config.accessibility = false; // since create accessibility session failed
+      // since create accessibility session failed
+      process.env.BROWSERSTACK_TEST_ACCESSIBILITY = 'false';
+      user_config.run_settings.accessibility = false; 
     }
   }
 }

bin/accessibility-automation/plugin/index.js

@@ -34,6 +34,8 @@ const browserstackAccessibility = (on, config) => {
   })
   config.env.ACCESSIBILITY_EXTENSION_PATH = process.env.ACCESSIBILITY_EXTENSION_PATH
   config.env.OS_VERSION = process.env.OS_VERSION
+  config.env.OS = process.env.SESSION_OS 
+
   config.env.IS_ACCESSIBILITY_EXTENSION_LOADED = browser_validation.toString()
 
   config.env.INCLUDE_TAGS_FOR_ACCESSIBILITY = process.env.ACCESSIBILITY_INCLUDETAGSINTESTINGSCOPE
@@ -42,4 +44,4 @@ const browserstackAccessibility = (on, config) => {
   return config;
 }
 
-module.exports = browserstackAccessibility;
+module.exports = browserstackAccessibility;

bin/helpers/helper.js

@@ -15,6 +15,16 @@ const gitconfig = require('gitconfiglocal');
 const { spawn, execSync } = require('child_process');
 const glob = require('glob');
 const pGitconfig = promisify(gitconfig);
+const CrashReporter = require('../testObservability/crashReporter');
+
+exports.debug = (text, shouldReport = false, throwable = null) => {
+  if (process.env.BROWSERSTACK_OBSERVABILITY_DEBUG === "true" || process.env.BROWSERSTACK_OBSERVABILITY_DEBUG === "1") {
+    logger.info(`[ OBSERVABILITY ] ${text}`);
+  }
+  if(shouldReport) {
+    CrashReporter.getInstance().uploadCrashReport(text, throwable ? throwable && throwable.stack : null);
+  }
+}
 
 exports.getFileSeparatorData = () => {
   return /^win/.test(process.platform) ? "\\" : "/";
@@ -45,7 +55,7 @@ exports.getPackageVersion = (package_, bsConfig = null) => {
     logger.info(`Getting ${package_} package version from module path = ${packages[package_]}`);
     packageVersion = packages[package_];
   } catch(e) {
-    logger.debug(`Unable to find package ${package_} at module path with error ${e}`);
+    exports.debug(`Unable to find package ${package_} at module path with error ${e}`);
   }
 
   /* Read package version from npm_dependencies in browserstack.json file if present */
@@ -87,13 +97,15 @@ exports.getGitMetaData = () => {
       var info = getRepoInfo();
       if(!info.commonGitDir) {
         logger.debug(`Unable to find a Git directory`);
+        exports.debug(`Unable to find a Git directory`);
         resolve({});
       }
       if(!info.author && exports.findGitConfig(process.cwd())) {
         /* commit objects are packed */
         gitLastCommit.getLastCommit(async (err, commit) => {
           if(err) {
             logger.debug(`Exception in populating Git Metadata with error : ${err}`, true, err);
+            exports.debug(`Exception in populating Git Metadata with error : ${err}`, true, err);
             return resolve({});
           }
           try {
@@ -124,6 +136,7 @@ exports.getGitMetaData = () => {
               "remotes": remotes
             });
           } catch(e) {
+            exports.debug(`Exception in populating Git Metadata with error : ${e}`, true, e);
             logger.debug(`Exception in populating Git Metadata with error : ${e}`, true, e);
             return resolve({});
           }
@@ -151,12 +164,12 @@ exports.getGitMetaData = () => {
         });
       }
     } catch(err) {
+      exports.debug(`Exception in populating Git metadata with error : ${err}`, true, err);
       logger.debug(`Exception in populating Git metadata with error : ${err}`, true, err);
       resolve({});
     }
   })
 }
-
 exports.getCiInfo = () => {
   var env = process.env;
   // Jenkins

bin/testObservability/helper/helper.js

@@ -55,7 +55,6 @@ const httpsScreenshotsKeepAliveAgent = new https.Agent({
 });
 
 const supportFileCleanup = () => {
-  return;
   Object.keys(supportFileContentMap).forEach(file => {
     try {
       fs.writeFileSync(file, supportFileContentMap[file], {encoding: 'utf-8'});
@@ -163,244 +162,6 @@ exports.getTestEnv = () => {
   }
 }
 
-exports.getFileSeparatorData = () => {
-  return /^win/.test(process.platform) ? "\\" : "/";
-}
-
-exports.findGitConfig = (filePath) => {
-  const fileSeparator = exports.getFileSeparatorData();
-  if(filePath == null || filePath == '' || filePath == fileSeparator) {
-    return null;
-  }
-  try {
-    fs.statSync(filePath + fileSeparator + '.git' + fileSeparator + 'config');
-    return filePath;
-  } catch(e) {
-    let parentFilePath = filePath.split(fileSeparator);
-    parentFilePath.pop();
-    return exports.findGitConfig(parentFilePath.join(fileSeparator));
-  }
-}
-
-const getGitMetaData = () => {
-  return new Promise(async (resolve, reject) => {
-    try {
-      var info = getRepoInfo();
-      if(!info.commonGitDir) {
-        exports.debug(`Unable to find a Git directory`);
-        resolve({});
-      }
-      if(!info.author && exports.findGitConfig(process.cwd())) {
-        /* commit objects are packed */
-        gitLastCommit.getLastCommit(async (err, commit) => {
-          if(err) {
-            exports.debug(`Exception in populating Git Metadata with error : ${err}`, true, err);
-            return resolve({});
-          }
-          try {
-            info["author"] = info["author"] || `${commit["author"]["name"].replace(/[“]+/g, '')} <${commit["author"]["email"].replace(/[“]+/g, '')}>`;
-            info["authorDate"] = info["authorDate"] || commit["authoredOn"];
-            info["committer"] = info["committer"] || `${commit["committer"]["name"].replace(/[“]+/g, '')} <${commit["committer"]["email"].replace(/[“]+/g, '')}>`;
-            info["committerDate"] = info["committerDate"] || commit["committedOn"];
-            info["commitMessage"] = info["commitMessage"] || commit["subject"];
-
-            const { remote } = await pGitconfig(info.commonGitDir);
-            const remotes = Object.keys(remote).map(remoteName =>  ({name: remoteName, url: remote[remoteName]['url']}));
-            resolve({
-              "name": "git",
-              "sha": info["sha"],
-              "short_sha": info["abbreviatedSha"],
-              "branch": info["branch"],
-              "tag": info["tag"],
-              "committer": info["committer"],
-              "committer_date": info["committerDate"],
-              "author": info["author"],
-              "author_date": info["authorDate"],
-              "commit_message": info["commitMessage"],
-              "root": info["root"],
-              "common_git_dir": info["commonGitDir"],
-              "worktree_git_dir": info["worktreeGitDir"],
-              "last_tag": info["lastTag"],
-              "commits_since_last_tag": info["commitsSinceLastTag"],
-              "remotes": remotes
-            });
-          } catch(e) {
-            exports.debug(`Exception in populating Git Metadata with error : ${e}`, true, e);
-            return resolve({});
-          }
-        }, {dst: exports.findGitConfig(process.cwd())});
-      } else {
-        const { remote } = await pGitconfig(info.commonGitDir);
-        const remotes = Object.keys(remote).map(remoteName =>  ({name: remoteName, url: remote[remoteName]['url']}));
-        resolve({
-          "name": "git",
-          "sha": info["sha"],
-          "short_sha": info["abbreviatedSha"],
-          "branch": info["branch"],
-          "tag": info["tag"],
-          "committer": info["committer"],
-          "committer_date": info["committerDate"],
-          "author": info["author"],
-          "author_date": info["authorDate"],
-          "commit_message": info["commitMessage"],
-          "root": info["root"],
-          "common_git_dir": info["commonGitDir"],
-          "worktree_git_dir": info["worktreeGitDir"],
-          "last_tag": info["lastTag"],
-          "commits_since_last_tag": info["commitsSinceLastTag"],
-          "remotes": remotes
-        });
-      }
-    } catch(err) {
-      exports.debug(`Exception in populating Git metadata with error : ${err}`, true, err);
-      resolve({});
-    }
-  })
-}
-
-const getCiInfo = () => {
-  var env = process.env;
-  // Jenkins
-  if ((typeof env.JENKINS_URL === "string" && env.JENKINS_URL.length > 0) || (typeof env.JENKINS_HOME === "string" && env.JENKINS_HOME.length > 0)) {
-    return {
-      name: "Jenkins",
-      build_url: env.BUILD_URL,
-      job_name: env.JOB_NAME,
-      build_number: env.BUILD_NUMBER
-    }
-  }
-  // CircleCI
-  if (env.CI === "true" && env.CIRCLECI === "true") {
-    return {
-      name: "CircleCI",
-      build_url: env.CIRCLE_BUILD_URL,
-      job_name: env.CIRCLE_JOB,
-      build_number: env.CIRCLE_BUILD_NUM
-    }
-  }
-  // Travis CI
-  if (env.CI === "true" && env.TRAVIS === "true") {
-    return {
-      name: "Travis CI",
-      build_url: env.TRAVIS_BUILD_WEB_URL,
-      job_name: env.TRAVIS_JOB_NAME,
-      build_number: env.TRAVIS_BUILD_NUMBER
-    }
-  }
-  // Codeship
-  if (env.CI === "true" && env.CI_NAME === "codeship") {
-    return {
-      name: "Codeship",
-      build_url: null,
-      job_name: null,
-      build_number: null
-    }
-  }
-  // Bitbucket
-  if (env.BITBUCKET_BRANCH && env.BITBUCKET_COMMIT) {
-    return {
-      name: "Bitbucket",
-      build_url: env.BITBUCKET_GIT_HTTP_ORIGIN,
-      job_name: null,
-      build_number: env.BITBUCKET_BUILD_NUMBER
-    }
-  }
-  // Drone
-  if (env.CI === "true" && env.DRONE === "true") {
-    return {
-      name: "Drone",
-      build_url: env.DRONE_BUILD_LINK,
-      job_name: null,
-      build_number: env.DRONE_BUILD_NUMBER
-    }
-  }
-  // Semaphore
-  if (env.CI === "true" && env.SEMAPHORE === "true") {
-    return {
-      name: "Semaphore",
-      build_url: env.SEMAPHORE_ORGANIZATION_URL,
-      job_name: env.SEMAPHORE_JOB_NAME,
-      build_number: env.SEMAPHORE_JOB_ID
-    }
-  }
-  // GitLab
-  if (env.CI === "true" && env.GITLAB_CI === "true") {
-    return {
-      name: "GitLab",
-      build_url: env.CI_JOB_URL,
-      job_name: env.CI_JOB_NAME,
-      build_number: env.CI_JOB_ID
-    }
-  }
-  // Buildkite
-  if (env.CI === "true" && env.BUILDKITE === "true") {
-    return {
-      name: "Buildkite",
-      build_url: env.BUILDKITE_BUILD_URL,
-      job_name: env.BUILDKITE_LABEL || env.BUILDKITE_PIPELINE_NAME,
-      build_number: env.BUILDKITE_BUILD_NUMBER
-    }
-  }
-  // Visual Studio Team Services
-  if (env.TF_BUILD === "True") {
-    return {
-      name: "Visual Studio Team Services",
-      build_url: `${env.SYSTEM_TEAMFOUNDATIONSERVERURI}${env.SYSTEM_TEAMPROJECTID}`,
-      job_name: env.SYSTEM_DEFINITIONID,
-      build_number: env.BUILD_BUILDID
-    }
-  }
-  // if no matches, return null
-  return null;
-}
-
-let packages = {};
-
-exports.getPackageVersion = (package_, bsConfig = null) => {
-  if(packages[package_]) return packages[package_];
-  let packageVersion;
-  /* Try to find version from module path */
-  try {
-    packages[package_] = this.requireModule(`${package_}/package.json`).version;
-    logger.info(`Getting ${package_} package version from module path = ${packages[package_]}`);
-    packageVersion = packages[package_];
-  } catch(e) {
-    exports.debug(`Unable to find package ${package_} at module path with error ${e}`);
-  }
-
-  /* Read package version from npm_dependencies in browserstack.json file if present */
-  if(utils.isUndefined(packageVersion) && bsConfig && (process.env.BROWSERSTACK_AUTOMATION == "true" || process.env.BROWSERSTACK_AUTOMATION == "1")) {
-    const runSettings = bsConfig.run_settings;
-    if (runSettings && runSettings.npm_dependencies !== undefined && 
-      Object.keys(runSettings.npm_dependencies).length !== 0 &&
-      typeof runSettings.npm_dependencies === 'object') {
-      if (package_ in runSettings.npm_dependencies) {
-        packages[package_] = runSettings.npm_dependencies[package_];
-        logger.info(`Getting ${package_} package version from browserstack.json = ${packages[package_]}`);
-        packageVersion = packages[package_];
-      }
-    }
-  }
-
-  /* Read package version from project's package.json if present */
-  const packageJSONPath = path.join(process.cwd(), 'package.json');
-  if(utils.isUndefined(packageVersion) && fs.existsSync(packageJSONPath)) {
-    const packageJSONContents = require(packageJSONPath);
-    if(packageJSONContents.devDependencies && !utils.isUndefined(packageJSONContents.devDependencies[package_])) packages[package_] = packageJSONContents.devDependencies[package_];
-    if(packageJSONContents.dependencies && !utils.isUndefined(packageJSONContents.dependencies[package_])) packages[package_] = packageJSONContents.dependencies[package_];
-    logger.info(`Getting ${package_} package version from package.json = ${packages[package_]}`);
-    packageVersion = packages[package_];
-  }
-
-  return packageVersion;
-}
-
-exports.getAgentVersion = () => {
-  let _path = path.join(__dirname, '../../../package.json');
-  if(fs.existsSync(_path))
-    return require(_path).version;
-}
-
 const setEnvironmentVariablesForRemoteReporter = (BS_TESTOPS_JWT, BS_TESTOPS_BUILD_HASHED_ID, BS_TESTOPS_ALLOW_SCREENSHOTS, OBSERVABILITY_LAUNCH_SDK_VERSION) => {
   process.env.BS_TESTOPS_JWT = BS_TESTOPS_JWT;
   process.env.BS_TESTOPS_BUILD_HASHED_ID = BS_TESTOPS_BUILD_HASHED_ID;
@@ -483,7 +244,7 @@ const setBrowserstackCypressCliDependency = (bsConfig) => {
     typeof runSettings.npm_dependencies === 'object') {
     if (!("browserstack-cypress-cli" in runSettings.npm_dependencies)) {
       logger.warn("Missing browserstack-cypress-cli not found in npm_dependencies");        
-      runSettings.npm_dependencies['browserstack-cypress-cli'] = exports.getAgentVersion() || "latest";
+      runSettings.npm_dependencies['browserstack-cypress-cli'] = helper.getAgentVersion() || "latest";
       logger.warn(`Adding browserstack-cypress-cli version ${runSettings.npm_dependencies['browserstack-cypress-cli']} in npm_dependencies`);
     }
   }
@@ -567,14 +328,14 @@ exports.launchTestSession = async (user_config, bsConfigPath) => {
           version: os.version(),
           arch: os.arch()
         },
-        'ci_info': getCiInfo(),
+        'ci_info': helper.getCiInfo(),
         'build_run_identifier': process.env.BROWSERSTACK_BUILD_RUN_IDENTIFIER,
         'failed_tests_rerun': process.env.BROWSERSTACK_RERUN || false,
-        'version_control': await getGitMetaData(),
+        'version_control': await helper.getGitMetaData(),
         'observability_version': {
           frameworkName: "Cypress",
-          frameworkVersion: exports.getPackageVersion('cypress', user_config),
-          sdkVersion: exports.getAgentVersion()
+          frameworkVersion: helper.getPackageVersion('cypress', user_config),
+          sdkVersion: helper.getAgentVersion()
         }
       };
       const config = {
@@ -592,7 +353,7 @@ exports.launchTestSession = async (user_config, bsConfigPath) => {
       exports.debug('Build creation successfull!');
       process.env.BS_TESTOPS_BUILD_COMPLETED = true;
       setEnvironmentVariablesForRemoteReporter(response.data.jwt, response.data.build_hashed_id, response.data.allow_screenshots, data.observability_version.sdkVersion);
-      setEventListeners();
+      // setEventListeners();
       if(this.isBrowserstackInfra()) setBrowserstackCypressCliDependency(user_config);
     } catch(error) {
       if(!error.errorType) {