Build Unification changes for TRA and Accessibility

.eslintrc

@@ -102,6 +102,7 @@
     "Promise": true,
     "Proxy": true,
     "Set": true,
+    "Map": true,
     "Reflect": true,
     "element": "readonly",
     "by": "readonly",

nightwatch/globals.js

@@ -9,6 +9,7 @@ const path = require('path');
 const AccessibilityAutomation = require('../src/accessibilityAutomation');
 const eventHelper = require('../src/utils/eventHelper');
 const OrchestrationUtils = require('../src/testorchestration/orchestrationUtils');
+const TestMap = require('../src/utils/testMap');
 const localTunnel = new LocalTunnel();
 const testObservability = new TestObservability();
 const accessibilityAutomation = new AccessibilityAutomation();
@@ -19,6 +20,8 @@ const _tests = {};
 const _testCasesData = {};
 let currentTestUUID = '';
 let workerList = {};
+let testRunner = '';
+let testEventPromises = [];
 
 eventHelper.eventEmitter.on(EVENTS.LOG_INIT, (loggingData) => {
   const testCaseStartedId = loggingData.message.replace('TEST-OBSERVABILITY-PID-TESTCASE-MAPPING-', '').slice(1, -1);
@@ -65,8 +68,8 @@ module.exports = {
           promises.push(testObservability.processTestReportFile(JSON.parse(JSON.stringify(modulesWithEnv[testSetting][testFile]))));
         }
       }
-
       await Promise.all(promises);
+
       done();
     } catch (error) {
       CrashReporter.uploadCrashReport(error.message, error.stack);
@@ -92,7 +95,7 @@ module.exports = {
         const gherkinDocument = reportData?.gherkinDocument.find((document) => document.uri === pickleData.uri);
         const featureData = gherkinDocument.feature;
         const uniqueId = uuidv4();
-        process.env.TEST_OPS_TEST_UUID = uniqueId;
+        process.env.TEST_RUN_UUID = uniqueId;
 
         Object.values(workerList).forEach((worker) => {
           worker.process.on('message', async (data) => {
@@ -253,15 +256,37 @@ module.exports = {
 
     eventBroadcaster.on('ScreenshotCreated', async (args) => {
       if (!helper.isTestObservabilitySession()) {return}
-      handleScreenshotUpload({args: args, uuid: process.env.TEST_OPS_TEST_UUID});
+      handleScreenshotUpload({args: args, uuid: process.env.TEST_RUN_UUID});
     });
 
     eventBroadcaster.on('TestRunStarted', async (test) => {
+      process.env.VALID_ALLY_PLATFORM = accessibilityAutomation.validateA11yCaps(browser);
       await accessibilityAutomation.beforeEachExecution(test);
+      if (testRunner !== 'cucumber'){
+        const uuid = TestMap.storeTestDetails(test);
+        process.env.TEST_RUN_UUID = uuid;
+        testEventPromises.push(testObservability.sendTestRunEvent('TestRunStarted', test, uuid));
+      }
     });
 
     eventBroadcaster.on('TestRunFinished', async (test) => {
-      await accessibilityAutomation.afterEachExecution(test);
+      const uuid = process.env.TEST_RUN_UUID || TestMap.getUUID(test);
+      if (TestMap.hasTestFinished(uuid)) {
+        Logger.debug(`Test with UUID ${uuid} already marked as finished, skipping duplicate TestRunFinished event`);
+
+        return;
+      }
+      try {
+        await accessibilityAutomation.afterEachExecution(test, uuid);
+        if (testRunner !== 'cucumber'){
+          testEventPromises.push(testObservability.sendTestRunEvent('TestRunFinished', test, uuid));
+          TestMap.markTestFinished(uuid);
+        }
+
+      } catch (error) {
+        Logger.error(`Error in TestRunFinished event: ${error.message}`);
+        TestMap.markTestFinished(uuid);
+      }
     });
   },
 
@@ -272,10 +297,12 @@ module.exports = {
   },
 
   async before(settings, testEnvSettings) {
+    testRunner = settings.test_runner.type;
+    const pluginSettings = settings['@nightwatch/browserstack'];
     if (!settings.desiredCapabilities['bstack:options']) {
       settings.desiredCapabilities['bstack:options'] = {};
     }
-
+    process.env.BROWSERSTACK_APP_AUTOMATE = helper.checkTestEnvironmentForAppAutomate(testEnvSettings);
     // Plugin identifier
     settings.desiredCapabilities['bstack:options']['browserstackSDK'] = `nightwatch-plugin/${helper.getAgentVersion()}`;
 
@@ -295,6 +322,7 @@ module.exports = {
 
     try {
       testObservability.configure(settings);
+      accessibilityAutomation.configure(settings);
       if (helper.isTestObservabilitySession()) {
         if (settings.reporter_options) {
           if (settings.reporter_options['save_command_result_value'] !== true){
@@ -312,7 +340,7 @@ module.exports = {
           settings.test_runner.options['require'] = path.resolve(__dirname, 'observabilityLogPatcherHook.js');
         }
         settings.globals['customReporterCallbackTimeout'] = CUSTOM_REPORTER_CALLBACK_TIMEOUT;
-        if (testObservability._user && testObservability._key) {
+        if (helper.isTestHubBuild(pluginSettings, true)) {
           await testObservability.launchTestSession();
         }
         if (process.env.BROWSERSTACK_RERUN === 'true' && process.env.BROWSERSTACK_RERUN_TESTS && process.env.BROWSERSTACK_RERUN_TESTS!=='null') {
@@ -323,7 +351,17 @@ module.exports = {
     } catch (error) {
       Logger.error(`Could not configure or launch test reporting and analytics - ${error}`);
     }
-
+
+    try {
+      // In parallel mode, env-specific settings are passed to beforeChildProcess hook instead of before hook,
+      if (helper.isAccessibilitySession() && !settings.parallel_mode) {
+        accessibilityAutomation.setAccessibilityCapabilities(settings);
+        accessibilityAutomation.commandWrapper();
+        helper.patchBrowserTerminateCommand();
+      }
+    } catch (err){
+      Logger.debug(`Exception while setting Accessibility Automation capabilities. Error ${err}`);
+    }
     // Initialize and configure test orchestration
     try {
       if (helper.isTestObservabilitySession()) {        
@@ -408,22 +446,6 @@ module.exports = {
       Logger.error(`Could not configure test orchestration - ${error}`);
     }
 
-    try {
-      accessibilityAutomation.configure(settings);
-      if (helper.isAccessibilitySession()) {
-        if (accessibilityAutomation._user && accessibilityAutomation._key) {
-          const [jwtToken, testRunId] = await accessibilityAutomation.createAccessibilityTestRun();
-          process.env.BS_A11Y_JWT = jwtToken;
-          process.env.BS_A11Y_TEST_RUN_ID = testRunId;
-          if (helper.isAccessibilitySession()) {
-            accessibilityAutomation.setAccessibilityCapabilities(settings);
-          }
-        }
-      }
-    } catch (error) {
-      Logger.error(`Could not configure or launch accessibility automation - ${error}`);
-    }
-
     addProductMapAndbuildUuidCapability(settings);
   },
 
@@ -443,46 +465,40 @@ module.exports = {
     } catch (error) {
       Logger.error(`Error collecting build data for test orchestration: ${error}`);
     }
-    
-    if (helper.isTestObservabilitySession()) {
+
+    if (helper.isTestHubBuild()) {
       process.env.NIGHTWATCH_RERUN_FAILED = nightwatchRerun;
       process.env.NIGHTWATCH_RERUN_REPORT_FILE = nightwatchRerunFile;
       if (process.env.BROWSERSTACK_RERUN === 'true' && process.env.BROWSERSTACK_RERUN_TESTS) {
         await helper.deleteRerunFile();
       }
       try {
+        if (testEventPromises.length > 0) {
+          await Promise.all(testEventPromises);
+          testEventPromises.length = 0; // Clear the array
+        }
         await testObservability.stopBuildUpstream();
-        if (process.env.BS_TESTOPS_BUILD_HASHED_ID) {
-          Logger.info(`\nVisit https://automation.browserstack.com/builds/${process.env.BS_TESTOPS_BUILD_HASHED_ID} to view build report, insights, and many more debugging information all at one place!\n`);
+        if (process.env.BROWSERSTACK_TESTHUB_UUID) {
+          Logger.info(`\nVisit https://automation.browserstack.com/builds/${process.env.BROWSERSTACK_TESTHUB_UUID} to view build report, insights, and many more debugging information all at one place!\n`);
         }
       } catch (error) {
         Logger.error(`Something went wrong in stopping build session for test reporting and analytics - ${error}`);
       }
       process.exit();
     }
-    if (helper.isAccessibilitySession()){
-      try {
-        await accessibilityAutomation.stopAccessibilityTestRun();
-      } catch (error) {
-        Logger.error(`Exception in stop accessibility test run: ${error}`);
-      }
-
-    }
   },
 
   async beforeEach(settings) {
     browser.getAccessibilityResults = () =>  { return accessibilityAutomation.getAccessibilityResults() };
     browser.getAccessibilityResultsSummary = () => { return accessibilityAutomation.getAccessibilityResultsSummary() };
-    // await accessibilityAutomation.beforeEachExecution(browser);
   },
 
   // This will be run after each test suite is finished
   async afterEach(settings) {
-    // await accessibilityAutomation.afterEachExecution(browser);
   },
 
   beforeChildProcess(settings) {
-
+   
     if (!settings.desiredCapabilities['bstack:options']) {
       settings.desiredCapabilities['bstack:options'] = {};
     }
@@ -514,12 +530,23 @@ module.exports = {
     try {
       if (helper.isAccessibilitySession()) {
         accessibilityAutomation.setAccessibilityCapabilities(settings);
+        accessibilityAutomation.commandWrapper();
+        helper.patchBrowserTerminateCommand();
       }
     } catch (err){
       Logger.debug(`Exception while setting Accessibility Automation capabilities. Error ${err}`);
     }
     addProductMapAndbuildUuidCapability(settings);
 
+  },
+
+  async afterChildProcess() {
+
+    await helper.shutDownRequestHandler();
+    if (testEventPromises.length > 0) {
+      await Promise.all(testEventPromises);
+      testEventPromises.length = 0; // Clear the array
+    }
   }
 };
 
@@ -569,10 +596,10 @@ const addProductMapAndbuildUuidCapability = (settings) => {
 
     if (settings.desiredCapabilities['bstack:options']) {
       settings.desiredCapabilities['bstack:options']['buildProductMap'] = buildProductMap;
-      settings.desiredCapabilities['bstack:options']['testhubBuildUuid'] = process.env.BS_TESTOPS_BUILD_HASHED_ID ? process.env.BS_TESTOPS_BUILD_HASHED_ID : '' ;
+      settings.desiredCapabilities['bstack:options']['testhubBuildUuid'] = process.env.BROWSERSTACK_TESTHUB_UUID ? process.env.BROWSERSTACK_TESTHUB_UUID : '' ;
     } else {
       settings.desiredCapabilities['browserstack.buildProductMap'] = buildProductMap;
-      settings.desiredCapabilities['browserstack.testhubBuildUuid'] = process.env.BS_TESTOPS_BUILD_HASHED_ID ? process.env.BS_TESTOPS_BUILD_HASHED_ID : '' ;
+      settings.desiredCapabilities['browserstack.testhubBuildUuid'] = process.env.BROWSERSTACK_TESTHUB_UUID ? process.env.BROWSERSTACK_TESTHUB_UUID : '' ;
     }
   } catch (error) {
     Logger.debug(`Error while sending productmap and build capabilities ${error}`);