froth-webdriverio-framework 6.0.68 → 6.0.70

package/froth_configs/commonhook.js

@@ -1,3 +1,4 @@
+
 const setAllDetails = require('./setallDatailinBuffer');
 const exeDetails = require('../froth_api_calls/getexecutionDetails');
 const { getBSSessionDetails } = require('../froth_api_calls/browsersatckSessionInfo');
@@ -7,7 +8,7 @@ let totalTestDuration = 0;
 const url = require('url');
 const fs = require('fs');
 const path = require('path');
-
+let executionUpdated = false;
 const resultdetails = {
   comments: [],
   excution_status: null,
@@ -39,12 +40,19 @@ function registerGlobalErrorHandlers() {
 
 async function safeUpdateExecution() {
   try {
-    await exeDetails.updateExecuitonDetails(
-      BUFFER.getItem('ORGANISATION_DOMAIN_URL'),
-      BUFFER.getItem('FROTH_LOGIN_TOKEN'),
-      BUFFER.getItem('FROTH_EXECUTION_ID'),
-      resultdetails
-    );
+    if (executionUpdated) return;
+    executionUpdated = true;
+
+    try {
+      await exeDetails.updateExecuitonDetails(
+        BUFFER.getItem('ORGANISATION_DOMAIN_URL'),
+        BUFFER.getItem('FROTH_LOGIN_TOKEN'),
+        BUFFER.getItem('FROTH_EXECUTION_ID'),
+        resultdetails
+      );
+    } catch (e) {
+      console.error('❌ Failed to update execution details:', e.message);
+    }
   } catch (e) {
     console.error('❌ Failed to update execution details:', e.message);
   }
@@ -52,8 +60,19 @@ async function safeUpdateExecution() {
 
 /* ----------------- HELPER FUNCTIONS ----------------- */
 function msToTime(ms) {
-  const sec = Math.floor(ms / 1000);
-  return new Date(sec * 1000).toISOString().substr(11, 8);
+  if (!ms || isNaN(ms)) return '00:00:00';
+
+  let seconds = Math.floor(ms / 1000);
+  let hours = Math.floor(seconds / 3600);
+  seconds %= 3600;
+  let minutes = Math.floor(seconds / 60);
+  seconds %= 60;
+
+  return [
+    hours.toString().padStart(2, '0'),
+    minutes.toString().padStart(2, '0'),
+    seconds.toString().padStart(2, '0')
+  ].join(':');
 }
 
 async function failExecution(reason) {
@@ -138,288 +157,122 @@ const commonHooks = {
       console.error('🚨 Error in beforeSession:', error.message);
     }
   },
-   /**
-       * Gets executed before the suite starts (in Mocha/Jasmine only).
-       * @param {object} suite suite details
-       */
-      beforeSuite: async function (suite) {
-          try {
-              console.log('==== BEFORE SUITE HOOK ====');
-              console.log(`====> Test suite has been started ' ${suite.title}' `,);
-  
-              starttime = new Date().getTime();
-  
-              if (process.env.PLATFORM === 'browserstack')
-                  await getBSSessionDetails(process.env.BS_SESSION_TYPE, process.env.BROWSERSTACK_USERNAME, process.env.BROWSERSTACK_ACCESS_KEY);
-  
-  
-              // const resultdetails = {};
-              await exeDetails.update_CICDRUNID_ReportUrl(BUFFER.getItem("ORGANISATION_DOMAIN_URL"), BUFFER.getItem("FROTH_LOGIN_TOKEN"), BUFFER.getItem("FROTH_EXECUTION_ID"))
-              BUFFER.setItem("UPDATE_EXECUTION", 'FALSE') //i need to recall 
-  
-          } catch (e) {
-              console.log("Error in beforeSuite:", e);
-          }
-      },
-  
-      before: async function (capabilities, specs) {
-          if (process.env.BS_SESSION_TYPE === 'automate') {
-              console.log('==== BEFORE HOOK ====')
-              await browser.maximizeWindow()
-          }
-          else {
-              console.log('==== BEFORE HOOK FOR MOBILE ====');
-          }
-  
-      },
-  
-      /**
-      * Function to be executed before a test (in Mocha/Jasmine only)
-      * @param {object} test    test object
-      * @param {object} context scope object the test was executed with
-      */
-      beforeTest: async function (test, context) {
-  
-          console.log('==== BEFORE TEST HOOK ====');
-          console.log(`====> Test Started '${test.title}'`);
-  
-      },
-  
-  
-      /**
-       * Function to be executed after a test (in Mocha/Jasmine only)
-       * @param {object}  test             test object
-       * @param {object}  context          scope object the test was executed with
-       * @param {Error}   result.error     error object in case the test fails, otherwise `undefined`
-       * @param {*}       result.result    return object of test function
-       * @param {number}  result.duration  duration of test
-       * @param {boolean} result.passed    true if test has passed, otherwise false
-       * @param {object}  result.retries   information about spec related retries, e.g. `{ attempts: 0, limit: 0 }`
-       */
-      afterTest: async function (test, _, { error, duration, passed }) {
-          console.log('==== AFTER TEST HOOK ====');
-          console.log(`====> Test name finished '${test.title}'`);
-  
-          const fileName = path.basename(test.file);
-          console.log('====> Test File Name:', fileName);
-          // BUFFER.setItem("FROTH_TOTAL_DURATION", Number(BUFFER.getItem("FROTH_TOTAL_DURATION")) + duration)
-          console.log(`====> Total Duration for this test: ${duration}ms`);
-          totalTestDuration += duration;
-          console.log(`====> Total Duration for all tests: ${totalTestDuration}ms`);
-          console.log(`====> Status of test: ${passed}`);
-  
-          let scriptresult = "NOT RUN";
-          // Default assumption: test passed (unless soft assertion failed)
-          let finalPassed = passed;
-  
-          if (passed) {
-              scriptresult = "PASSED"
-              resultdetails.comments.push(`${test.title} - passed`);
-              console.log(`====> resultdetails comments: ${resultdetails.comments}`);
-          }
-          else if (!finalPassed || error) {
-              scriptresult = "FAILED"
-              console.log(`====> Failed or error while executing the test: ${error ? error.message : "Test failed"}`);
-              if (!resultdetails.comments.some(comment => typeof comment === 'string' && comment.includes(test.title)))
-                  resultdetails.comments.push(`${test.title} - failed: ${error ? error.message : "Test failed"}`);
-  
-          }
-  
-          let scriptDetails = BUFFER.getItem("FROTHE_SUITE_DETAILS");
-          if (typeof scriptDetails === "string") {
-              scriptDetails = JSON.parse(scriptDetails);
-          }
-          const jwtScript = scriptDetails.find(s => s.scriptName === fileName.replace(".js", ""));
-          console.log("jwtScript:", jwtScript);
-  
-          await exeDetails.updateScriptExecutionStatus(
-              BUFFER.getItem("ORGANISATION_DOMAIN_URL"),
-              BUFFER.getItem("FROTH_LOGIN_TOKEN"),
-              jwtScript.scriptId,
-              jwtScript.platform.toLowerCase(),
-              scriptresult)
-  
-  
-      },
-      /**
-      * Hook that gets executed after the suite has ended (in Mocha/Jasmine only).
-      * @param {object} suite suite details
-      */
-      afterSuite: async function (suite) {
-          console.log('==== AFTER SUITE HOOK ====');
-          console.log(`====> Test suite has completed '${suite.title}'`);
-      },
-      /**
-      * Gets executed after all tests are done. You still have access to all global variables from
-      * the test.
-      * @param {number} result 0 - test pass, 1 - test fail
-      * @param {Array.<Object>} capabilities list of capabilities details
-      * @param {Array.<String>} specs List of spec file paths that ran
-      */
-      after: async function (result, config, capabilities, specs) {
-          console.log('==== AFTER HOOK ====');
-          console.log('====> All tests are completed.' + result);
-          BUFFER.setItem("RESULT_DATA", result);
-          console.log("====> Result data :" + BUFFER.getItem("RESULT_DATA"))
-          resultdetails.excution_status = BUFFER.getItem("RESULT_DATA") == 0 ? 'PASSED' : 'FAILED'
-          console.log("====> Total Duration taken for the suite:" + BUFFER.getItem("FROTH_TOTAL_DURATION"));
-          console.log("====> Execution Status from results" + resultdetails.excution_status);
-          // Capture WebDriver session errors
-  
-          if (result !== 0) {
-              if (resultdetails.comments.length === 0) {
-                  resultdetails.comments.push("❌ WebDriver session failed or timed out.");
-              }
-              resultdetails.comments.push(`Execution failed with exit code: ${result}`);
-  
-              process.on('uncaughtException', (err) => {
-                  console.error("Uncaught Exception:", err);
-                  resultdetails.comments.push(`Execution failed : ${err}`);
-              });
-  
-          }
-  
-      },
-  
-      onError: async function (error) {
-          console.error('==== ON ERROR HOOK ====');
-          console.error('====> Error occurred:', error.message);
-          if (error.message.includes('Automate testing time expired')) {
-              console.log('❌ Global error: Session timed out on BrowserStack.');
-              resultdetails.excution_status = 'FAILED';
-              resultdetails.comments.push(`Global error: Session timed out on BrowserStack.Please check ths session: ${result}`);
-  
-              await exeDetails.updateExecuitonDetails(BUFFER.getItem("ORGANISATION_DOMAIN_URL"), BUFFER.getItem("FROTH_LOGIN_TOKEN"), BUFFER.getItem("FROTH_EXECUTION_ID"), resultdetails)
-              process.exit(1); // Stop execution if session timed out
-          }
-      },
-      afterSession: async function (config, capabilities, specs) {
-          console.log('==== AFTER SESSION HOOK ====');
-          console.log('====> This is the aftersession hook');
-          // console.log("Capabilities:", capabilities);
-          console.log("Specs:", specs);
-          //console.log("Config:", config);
-  
-          process.on('uncaughtException', (err) => {
-              console.error("Uncaught Exception:", err);
-              resultdetails.comments.push(`Execution failed with exit code: ${err}`);
-          });
-  
-          // Capture unhandled promise rejections
-          process.on('unhandledRejection', (reason, promise) => {
-              console.error("Unhandled Promise Rejection:", reason);
-              resultdetails.comments.push(`Execution failed with exit code: ${reason}`);
-          });
-  
-          endtime = new Date().getTime();
-          let totalDuration = endtime - starttime;
-          console.log("====> Total Duration taken for :" + BUFFER.getItem("FROTH_TOTAL_DURATION"));
-          console.log("====> Total Duration in after session based on start time and end time:" + totalDuration);
-          console.log("====> Total Duration in after session based on summing up the test execution times:" + totalTestDuration);
-  
-          resultdetails.excution_status = BUFFER.getItem("RESULT_DATA") == 0 ? 'PASSED' : 'FAILED'
-          const frothDuration = BUFFER.getItem("FROTH_TOTAL_DURATION");
-  
-          if (await isInvalidDuration(frothDuration)) {
-              //  console.log("inside froth duration");
-              if (await isInvalidDuration(totalTestDuration)) {
-                  console.log("inside froth totalTestDuration");
-                  resultdetails.excution_time = await millisecondsToTime(totalDuration);
-              } else {
-                  console.log("inside froth totalTestDuration comparision");
-                  if (totalDuration > totalTestDuration)
-                      resultdetails.excution_time = await millisecondsToTime(totalDuration);
-                  else
-                      resultdetails.excution_time = await millisecondsToTime(totalTestDuration);
-              }
-          } else {
-              console.log("inside froth duration else");
-              resultdetails.excution_time = await secondsToTime(frothDuration);
-          }
-  
-          console.log("====> Total Duration calculation:" + resultdetails.excution_time);
-  
-          await exeDetails.updateExecuitonDetails(BUFFER.getItem("ORGANISATION_DOMAIN_URL"), BUFFER.getItem("FROTH_LOGIN_TOKEN"), BUFFER.getItem("FROTH_EXECUTION_ID"), resultdetails)
-  
-          // Perform any cleanup or post-test actions here
-          BUFFER.clear();
-      },
-  
-      onComplete: async function (exitCode, config, capabilities, results) {
-          console.log('==== ON COMPLETE HOOK ====');
-          console.log('====> Results:', results);
-          console.log('==== Test Results Summary ======');
-          console.log('Total Tests:', results.total);
-          console.log('Passed:', results.passed);
-          console.log('Failed:', results.failed);
-          console.log('Exit Code:', exitCode);
-  
-          console.log('==== ALL TESTS ARE COMPLETED ====');
-          return exitCode;
-      }
-  
-  };
-  async function isInvalidDuration(val) {
-      console.log("val in isValidDuration:" + val);
-      // Check if the value is null, 0, or undefined
-      let isValid;
-      if (typeof val === 'string') {
-          val = val.trim().toLowerCase();
-          isValid = val === "null" || val === "0" || val === "undefined";
-  
-      } else
-          isValid = val === null || val === 0 || val === undefined;
-  
-      console.log("isValid in isValidDuration:" + isValid);
-  
-      return isValid;
-  }
-  async function secondsToTime(secs) {
-      console.log("secs in secondsToTime :" + secs);
-      let hours = Math.floor(secs / 3600);
-      let minutes = Math.floor((secs % 3600) / 60);
-      let seconds = secs % 60;
-  
-      // Adding leading zeros if the value is less than 10
-      if (hours < 10) hours = '0' + hours;
-      if (minutes < 10) minutes = '0' + minutes;
-      if (seconds < 10) seconds = '0' + seconds;
-      console.log("Time:" + hours + ':' + minutes + ':' + seconds);
-      return hours + ':' + minutes + ':' + seconds;
-  }
-  async function millisecondsToTime(ms) {
-      console.log("ms in millisecondsToTime: " + ms);
-  
-      // Ensure input is a number
-      ms = Number(ms);
-      if (isNaN(ms)) {
-          return '00:00:00';
-      }
-  
-      let totalSeconds = Math.floor(ms / 1000);
-      let hours = Math.floor(totalSeconds / 3600);
-      let minutes = Math.floor((totalSeconds % 3600) / 60);
-      let seconds = totalSeconds % 60;
-  
-      // Pad with leading zeros
-      hours = hours < 10 ? '0' + hours : hours;
-      minutes = minutes < 10 ? '0' + minutes : minutes;
-      seconds = seconds < 10 ? '0' + seconds : seconds;
-  
-      const timeStr = `${hours}:${minutes}:${seconds}`;
-      console.log("Formatted time:", timeStr);
-      return timeStr;
-  }
-  
-  async function convertTimetoHHMMSS(time) {
-      const seconds = Math.floor((time / 1000) % 60);
-      const minutes = Math.floor((time / (1000 * 60)) % 60);
-      const hours = Math.floor((time / (1000 * 60 * 60)) % 24);
-      const formattedTime = `${String(hours).padStart(2, '0')}:${String(minutes).padStart(2, '0')}:${String(seconds).padStart(2, '0')}`;
-  
-      console.log("Time:" + hours + ':' + minutes + ':' + seconds);
-  
-      return formattedTime;
-  }
-  
-  module.exports = commonHooks;
+  /* ========== BEFORE SUITE ========== */
+  beforeSuite: async (suite) => {
+    console.log(`==== BEFORE SUITE: ${suite.title} ====`);
+    suiteStartTime = Date.now();
+
+    if (process.env.PLATFORM === 'browserstack' || process.env.PLATFORM === 'browserstacklocal') {
+      await getBSSessionDetails(
+        process.env.BS_SESSION_TYPE,
+        process.env.BROWSERSTACK_USERNAME,
+        process.env.BROWSERSTACK_ACCESS_KEY
+      );
+    }
+
+    await exeDetails.update_CICDRUNID_ReportUrl(
+      BUFFER.getItem('ORGANISATION_DOMAIN_URL'),
+      BUFFER.getItem('FROTH_LOGIN_TOKEN'),
+      BUFFER.getItem('FROTH_EXECUTION_ID')
+    );
+  },
+  /* ========== BEFORE TEST ========== */
+  beforeTest: async (test) => {
+    console.log(`▶️ START TEST: ${test.title}`);
+  },
+
+  /* ========== AFTER TEST ========== */
+  afterTest: async (test, _, { error, duration, passed }) => {
+    console.log(`==== AFTER TEST HOOK ===='${test.title}'`);
+    totalTestDuration += duration;
+
+    const fileName = path.basename(test.file);
+    const status = passed ? 'PASSED' : 'FAILED';
+
+    if (!passed) {
+      resultdetails.comments.push(`${test.title} - ${error?.message || 'Failed'}`);
+    }
+
+    const suiteDetails = JSON.parse(BUFFER.getItem('FROTHE_SUITE_DETAILS'));
+    const script = suiteDetails.find(s => s.scriptName === fileName.replace('.js', ''));
+    console.log("Script Details:", script);
+
+    await exeDetails.updateScriptExecutionStatus(
+      BUFFER.getItem('ORGANISATION_DOMAIN_URL'),
+      BUFFER.getItem('FROTH_LOGIN_TOKEN'),
+      script.scriptId,
+      script.platform.toLowerCase(),
+      status
+    );
+  },
+
+  /**
+     * Hook that gets executed after the suite has ended (in Mocha/Jasmine only).
+     * @param {object} suite suite details
+     */
+  afterSuite: async function (suite) {
+    console.log('==== AFTER SUITE HOOK ====');
+    console.log(`====> Test suite has completed '${suite.title}'`);
+  },
+
+  /* ==== AFTER SESSION ==== */
+  afterSession: async (config, capabilities, specs,exitCode) => {
+    console.log('==== AFTER SESSION ====');
+    const endTime = Date.now();
+    if (!suiteStartTime) suiteStartTime = endTime;
+
+    const totalTime = Math.max(endTime - suiteStartTime, totalTestDuration);
+   // resultdetails.excution_status = exitCode === 0 ? 'PASSED' : 'FAILED';
+    resultdetails.excution_time = msToTime(totalTime);
+
+    console.log('⏱ Final execution time:', resultdetails.excution_time);
+
+    // console.log('📤 Updating DB with final execution details');
+    // console.log('Status:', resultdetails.excution_status);
+    // console.log('Duration:', resultdetails.excution_time);
+
+    // await safeUpdateExecution();
+    // BUFFER.clear();
+  },
+
+  /* ========== ON ERROR ========== */
+
+  onError: async function (error) {
+    console.error('==== ON ERROR HOOK ====');
+    console.error('Error occurred:', error.message);
+
+    // Normalize all framework-level failures
+    resultdetails.excution_status = 'FAILED';
+    resultdetails.comments.push(`WDIO Error: ${error.message}`);
+
+    // Special handling for BrowserStack timeout
+    if (error.message?.includes('Automate testing time expired')) {
+      resultdetails.comments.push(
+        'BrowserStack session timed out (Automate testing time expired)'
+      );
+    }
+
+    await safeUpdateExecution();
+  },
+  /* ========== ON COMPLETE ========== */
+  onComplete: async (exitCode, _, __, results) => {
+    cconsole.log('==== ON COMPLETE ====');
+    console.log(`Total: ${results.total}, Passed: ${results.passed}, Failed: ${results.failed}`);
+
+    resultdetails.excution_status = exitCode === 0 ? 'PASSED' : 'FAILED';
+
+    if (exitCode !== 0 && resultdetails.comments.length === 0) {
+      resultdetails.comments.push(`Execution failed with exit code ${exitCode}`);
+    }
+
+    await safeUpdateExecution();
+    BUFFER.clear();
+
+    return exitCode;
+  },
+
+
+
+};
+
+module.exports = commonHooks;