froth-webdriverio-framework 7.0.118 → 7.0.119-dev1.0

package/froth_api_calls/browsersatckSessionInfo.js

@@ -64,8 +64,10 @@ async function getBSSessionDetails(sessionType, bsUsername, bsPassword) {
 
             BUFFER.setItem("REPORT_URL", publicUrl);
             BUFFER.setItem("FROTH_TOTAL_DURATION", duration);
+            BUFFER.setItem("BS_BUILD_HASH_ID", hashId);
 
             console.log(`Public URL: ${publicUrl}`);
+            console.log(`Build Hash ID: ${hashId}`);
         } else if (response.status === 401) {
             console.error("Unauthorized: token expired to login Browserstack");
         } else {
@@ -160,11 +162,78 @@ async function escapeForBrowserStack(message) {
         .replace(/\r/g, "\\r");
 }
 
+/* ===================== BROWSERSTACK REPORT API ===================== */
+
+/**
+ * Updates BrowserStack report details in Froth TestOps database
+ * @param {string} frothUrl - Froth TestOps API base URL
+ * @param {string} token - Authentication token
+ * @param {string} bsBuildId - BrowserStack build ID (e.g., "frothtestops-coderepo_1286_20260211")
+ * @param {number} executionId - Test execution ID
+ * @param {string} status - BrowserStack status: "in_progress" (updates public URL only) or "completed"
+ */
+async function updateBrowserStackReport(frothUrl, token, bsBuildId, executionId, status) {
+    if (!frothUrl || !token || !bsBuildId || !executionId || !status) {
+        console.error('❌ Missing required parameters for updateBrowserStackReport');
+        console.error(`frothUrl: ${frothUrl}, token: ${!!token}, bsBuildId: ${bsBuildId}, executionId: ${executionId}, status: ${status}`);
+        return null;
+    }
+
+    const validStatuses = ['in_progress', 'completed'];
+    if (!validStatuses.includes(status)) {
+        console.error(`❌ Invalid browserstack_status: ${status}. Must be one of: ${validStatuses.join(', ')}`);
+        return null;
+    }
 
+    const url = `${frothUrl}/api/download-browserstack-report/`;
+    console.log(`📤 Updating BrowserStack report [${status}]:`, url);
 
+    const payload = {
+        BS_BUILD_ID: bsBuildId,
+        execution_id: executionId,
+        browserstack_status: status
+    };
+
+    try {
+        const response = await fetch(url, {
+            method: 'POST',
+            headers: {
+                'Authorization': `Bearer ${token}`,
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify(payload)
+        });
+
+        const contentType = response.headers.get('content-type') || '';
+        let data;
+        if (contentType.includes('application/json')) {
+            data = await response.json();
+        } else {
+            data = await response.text();
+        }
+
+        console.log('📥 Response in updateBrowserStackReport:', data);
+
+        if (response.ok) {
+            console.log(`✅ BrowserStack report updated successfully [${status}]`);
+            return data;
+        } else if (response.status === 401) {
+            console.error('🔒 Unauthorized (401) - Token may be expired');
+            return null;
+        } else {
+            console.error(`❌ Failed to update BrowserStack report [${response.status}]:`, data);
+            return null;
+        }
+
+    } catch (error) {
+        console.error('❌ updateBrowserStackReport error:', error.message);
+        return null;
+    }
+}
 
 module.exports = {
     getBSSessionDetails,
     getBSBuildDetails,
     amend2Browserstack,
+    updateBrowserStackReport,
 };

package/froth_api_calls/getexecutionDetails.js

@@ -17,7 +17,9 @@ function isValidId(id) {
 async function handleResponse(response, context) {
 
     if (response.ok) {
-        return response.json();
+        const data = await response.json();
+        console.log('📥 Response in', context, ':', data);
+        return data;
     }
 
     if (response.status === 401) {
@@ -139,12 +141,12 @@ async function updateExecuitonDetails(frothUrl, token, id, resultdetails) {
             formData.append('excution_status', resultdetails.excution_status);
         }
 
-        if (
-            resultdetails.excution_time &&
-            resultdetails.excution_time !== 'NaN:NaN:NaN'
-        ) {
-            formData.append('excution_time', resultdetails.excution_time);
-        }
+        // if (
+        //     resultdetails.excution_time &&
+        //     resultdetails.excution_time !== 'NaN:NaN:NaN'
+        // ) {
+        //     formData.append('excution_time', resultdetails.excution_time);
+        // }
 
         if (resultdetails.comments === null)
             console.log("Comments is null")
@@ -170,9 +172,7 @@ async function updateExecuitonDetails(frothUrl, token, id, resultdetails) {
             data = await response.text();
         }
 
-       // console.log('📤 API Response Status:', response.status);
-       // console.log('📤 API Response Headers:', Array.from(response.headers.entries()));
-       // console.log('📤 API Response Body:', data);
+        console.log('📥 Response from updateExecuitonDetails:', data);
 
         if (!response.ok) {
             console.error(`❌ Failed to update execution details, status ${response.status}`);

package/froth_common_actions/assert.js

@@ -1,5 +1,5 @@
 // Function to verify text in Android app
-import assert from 'assert';
+const assert = require('assert');
 const amendToBrowserstack = require("../froth_api_calls/browsersatckSessionInfo").amend2Browserstack;
 
 async function assertText(elementSelector, expectedText) {

package/froth_common_actions/dbValidator.js

@@ -75,7 +75,70 @@ async function validateDbFields(actualData, expectedData, context = 'DB Validati
     }
 
     // -----------------------------
-    // AUTO-DETECT TIMESTAMP VALIDATION
+    // NULLABLE VALIDATION (allow null/empty)
+    // -----------------------------
+    if (typeof expectedConfig === "object" && expectedConfig.type === "nullable") {
+      const isNullOrEmpty = actual === null || actual === undefined || actual === "" || actual === "null";
+      status = isNullOrEmpty ? "PASS" : "PASS"; // Always pass - just validates field exists
+      results.push({
+        key,
+        actual,
+        expected: "(nullable - any value allowed)",
+        status
+      });
+      continue;
+    }
+
+    // -----------------------------
+    // NUMBER WITH TOLERANCE
+    // -----------------------------
+    if (typeof expectedConfig === "object" && expectedConfig.type === "number") {
+      expected = expectedConfig.value;
+      const tolerance = expectedConfig.tolerance || 0;
+
+      const actualNum = parseFloat(actual);
+      const expectedNum = parseFloat(expected);
+
+      if (isNaN(actualNum) || isNaN(expectedNum)) {
+        status = "FAIL";
+      } else {
+        const diff = Math.abs(actualNum - expectedNum);
+        status = diff <= tolerance ? "PASS" : "FAIL";
+      }
+
+      results.push({
+        key,
+        actual,
+        expected: `${expected} (±${tolerance})`,
+        status
+      });
+
+      if (status === "FAIL") allPassed = false;
+      continue;
+    }
+
+    // -----------------------------
+    // PARTIAL STRING MATCH
+    // -----------------------------
+    if (typeof expectedConfig === "object" && expectedConfig.type === "partial") {
+      const substring = expectedConfig.contains;
+      const actualStr = String(actual || "");
+
+      status = actualStr.includes(substring) ? "PASS" : "FAIL";
+
+      results.push({
+        key,
+        actual,
+        expected: `(contains "${substring}")`,
+        status
+      });
+
+      if (status === "FAIL") allPassed = false;
+      continue;
+    }
+
+    // -----------------------------
+    // TIMESTAMP VALIDATION
     // -----------------------------
     if (typeof expectedConfig === "object" && expectedConfig.type === "timestamp") {
       expected = expectedConfig.value;
@@ -124,13 +187,13 @@ async function validateDbFields(actualData, expectedData, context = 'DB Validati
   // -----------------------------
   // BROWSERSTACK LOGGING
   // -----------------------------
-//   const chunkSize = 800;
-//   const combined = results
-//     .map(r => `${r.key} => Expected: ${r.expected}, Actual: ${r.actual}, Status: ${r.status}`)
-//     .join(" | ");
+  //   const chunkSize = 800;
+  const combined = results
+    .map(r => `${r.key} => Expected: ${r.expected}, Actual: ${r.actual}, Status: ${r.status}`)
+    .join(" | ");
 
-//   const chunks = combined.match(new RegExp(`.{1,${chunkSize}}`, "g")) || [];
-//   for (const c of chunks) await amendBrowserStackLog(c, "info");
+  //   const chunks = combined.match(new RegExp(`.{1,${chunkSize}}`, "g")) || [];
+  //   for (const c of chunks) await amendBrowserStackLog(c, "info");
 
   await amendBrowserStackLog(combined, "info");
   // -----------------------------
@@ -147,4 +210,10 @@ async function validateDbFields(actualData, expectedData, context = 'DB Validati
 module.exports = {
   parseTimestamp,
   validateDbFields
-};
+};
+
+// async function main(){
+
+// }
+
+// main()

package/froth_configs/base.config.js

@@ -4,6 +4,9 @@ console.log('====>SUITE_FILE:', SUITE_FILE);
 const { LocalStorage } = require('node-localstorage');
 global.BUFFER = new LocalStorage('./buffer_storage');
 
+// Make Util globally available across all test files
+global.Util = require('../froth_common_actions/Utils');
+
 module.exports = {
     specs: require(SUITE_FILE).tests,
     exclude: [],

package/froth_configs/commonhook.js

@@ -1,7 +1,7 @@
 
 const setAllDetails = require('./setallDatailinBuffer');
 const exeDetails = require('../froth_api_calls/getexecutionDetails');
-const { getBSSessionDetails } = require('../froth_api_calls/browsersatckSessionInfo');
+const { getBSSessionDetails, updateBrowserStackReport } = require('../froth_api_calls/browsersatckSessionInfo');
 let globalErrorHandled = false;
 let suiteStartTime = 0;
 let totalTestDuration = 0;
@@ -14,7 +14,7 @@ let executionUpdated = false;
 const resultdetails = {
   comments: [],
   excution_status: null,
-  excution_time: null
+ // excution_time: null
 };
 
 /* ----------------- GLOBAL ERROR HANDLERS ----------------- */
@@ -187,37 +187,49 @@ const commonHooks = {
     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 getBSSessionDetails(
+      //   process.env.BS_SESSION_TYPE,
+      //   process.env.BROWSERSTACK_USERNAME,
+      //   process.env.BROWSERSTACK_ACCESS_KEY
+      // );
+
+      // Update BrowserStack report with in_progress status
+      const buildName = process.env.FROTH_TESTOPS_BUILD_NAME;
+      if (buildName) {
+        await updateBrowserStackReport(
+          BUFFER.getItem('ORGANISATION_DOMAIN_URL'),
+          BUFFER.getItem('FROTH_LOGIN_TOKEN'),
+          buildName,
+          BUFFER.getItem('FROTH_EXECUTION_ID'),
+          'in_progress'
+        );
+      }
     }
 
-    await exeDetails.update_CICDRUNID_ReportUrl(
-      BUFFER.getItem('ORGANISATION_DOMAIN_URL'),
-      BUFFER.getItem('FROTH_LOGIN_TOKEN'),
-      BUFFER.getItem('FROTH_EXECUTION_ID')
-    );
+    // 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}`);
 
-    // Get suite details and script info
-    const fileName = path.basename(test.file);
-    const suiteDetails = JSON.parse(BUFFER.getItem('FROTHE_SUITE_DETAILS'));
-    const script = suiteDetails.find(s => s.scriptName === fileName.replace('.js', ''));
-
-    if (script) {
-      await exeDetails.updateScriptExecutionStatus(
-        BUFFER.getItem('ORGANISATION_DOMAIN_URL'),
-        BUFFER.getItem('FROTH_LOGIN_TOKEN'),
-        script.scriptId,
-        script.platform.toLowerCase(),
-        "IN PROGRESS"
-      );
-    }
+    // Update script status to IN_PROGRESS
+    // const fileName = path.basename(test.file);
+    // const suiteDetails = JSON.parse(BUFFER.getItem('FROTHE_SUITE_DETAILS'));
+    // const script = suiteDetails.find(s => s.scriptName === fileName.replace('.js', ''));
+
+    // if (script) {
+    //   await exeDetails.updateScriptExecutionStatus(
+    //     BUFFER.getItem('ORGANISATION_DOMAIN_URL'),
+    //     BUFFER.getItem('FROTH_LOGIN_TOKEN'),
+    //     script.scriptId,
+    //     script.platform.toLowerCase(),
+    //     'IN_PROGRESS'
+    //   );
+    // }
   },
 
   /* ========== AFTER TEST ========== */
@@ -273,7 +285,7 @@ const commonHooks = {
     console.log('⏱ ==== Execution time calculation ==== ');
     const endTime = Date.now();
     const totalTime = endTime - suiteStartTime; // Full WDIO+CI elapsed time
-    resultdetails.excution_time = await msToTime(totalTime);
+   // resultdetails.excution_time = await msToTime(totalTime);
 
     console.log("Exit code after session===>" + exitCode)
     if (exitCode === undefined || exitCode === null) {
@@ -284,9 +296,24 @@ const commonHooks = {
     console.log('Comments being sent:', resultdetails.comments);
     //resultdetails.comments.push(BUFFER.getItem('ALL_COMMENTS'))
     console.log('⏱ Final execution time (ms):', totalTime);
-    console.log('⏱ Final execution time (hh:mm:ss):', resultdetails.excution_time);
+   // console.log('⏱ Final execution time (hh:mm:ss):', resultdetails.excution_time);
     await safeUpdateExecution();
 
+    // Update BrowserStack report with completed status
+    if (process.env.PLATFORM === 'browserstack' || process.env.PLATFORM === 'browserstacklocal') {
+      const buildName = process.env.FROTH_TESTOPS_BUILD_NAME;
+      if (buildName) {
+        await updateBrowserStackReport(
+          BUFFER.getItem('ORGANISATION_DOMAIN_URL'),
+          BUFFER.getItem('FROTH_LOGIN_TOKEN'),
+          buildName,
+          BUFFER.getItem('FROTH_EXECUTION_ID'),
+          'completed'
+        );
+      }
+      
+    }
+
 
   },
 
@@ -306,28 +333,14 @@ const commonHooks = {
       );
     }
 
-    // Mark all scripts as SKIPPED if error causes all scripts to be skipped
-    try {
-      const suiteDetails = JSON.parse(BUFFER.getItem('FROTHE_SUITE_DETAILS'));
-      for (const script of suiteDetails) {
-        await exeDetails.updateScriptExecutionStatus(
-          BUFFER.getItem('ORGANISATION_DOMAIN_URL'),
-          BUFFER.getItem('FROTH_LOGIN_TOKEN'),
-          script.scriptId,
-          script.platform.toLowerCase(),
-          'SKIPPED'
-        );
-      }
-    } catch (e) {
-      console.error('Failed to mark scripts as SKIPPED:', e.message);
-    }
-
     await safeUpdateExecution();
   },
   /* ========== ON COMPLETE ========== */
   onComplete: async (exitCode, _, __, results) => {
     console.log('==== ON COMPLETE ====');
     console.log(`Total: ${results.total || 0}, Passed: ${results.passed || 0}, Failed: ${results.failed || 0}`);
+    //console.log("Exit code onComplete===>" + exitCode)
+
     if (exitCode === undefined || exitCode === null) {
       exitCode = 1   // treat as failure
     }
@@ -385,7 +398,7 @@ async function validateSyntax(specs) {
     let syntaxFailed = false;
 
     for (const fileUrl of specs) {
-      console.log("file path ", fileUrl)
+      console.log("file path ",fileUrl)
       const filePath = url.fileURLToPath(fileUrl);
       const code = fs.readFileSync(filePath, 'utf8');
 

package/froth_configs/local/web.config.js

@@ -1,8 +1,58 @@
-module.exports = () => ({
-    services: ['chromedriver'],
+module.exports = (bsCaps) => {
+    const browserName = (bsCaps.browserName || 'chrome').toLowerCase();
+    //const browserVersion = bsCaps.browserVersion;
 
+    // Map browser names to their WebdriverIO services
+    const browserServiceMap = {
+        chrome: 'chromedriver',
+        firefox: 'geckodriver',
+        edge: 'edgedriver',
+        ie: 'iedriver',
+        'internet explorer': 'iedriver',
+        safari: 'safaridriver'
+    };
 
-    capabilities: [{
-        browserName: 'chrome'
-    }]
-});
+    const service = browserServiceMap[browserName] || 'chromedriver';
+
+    const config = {
+        services: [service]
+    };
+
+    // Add browser-specific capabilities
+    if (browserName === 'chrome') {
+        config.capabilities = [{
+            browserName: 'chrome',
+            'goog:chromeOptions': {
+               // args: browserVersion ? [`--version=${browserVersion}`] : []
+            }
+        }];
+    } else if (browserName === 'firefox') {
+        config.capabilities = [{
+            browserName: 'firefox',
+            'moz:firefoxOptions': {
+                // Add Firefox-specific options if needed
+            }
+        }];
+    } else if (browserName === 'edge') {
+        config.capabilities = [{
+            browserName: 'MicrosoftEdge'
+        }];
+    } else if (browserName === 'safari') {
+        config.capabilities = [{
+            browserName: 'safari'
+        }];
+    } else if (browserName === 'ie' || browserName === 'internet explorer') {
+        config.capabilities = [{
+            browserName: 'internet explorer'
+        }];
+    } else {
+        // Default to Chrome for unsupported browsers
+        config.capabilities = [{
+            browserName: 'chrome'
+        }];
+    }
+
+    console.log(`🌐 Local execution configured for: ${browserName}${browserVersion ? ` (v${browserVersion})` : ''} using service: ${service}`);
+
+    return config;
+};

package/froth_configs/wdio.common.conf.js

@@ -22,7 +22,7 @@ try {
   process.env.BROWSERSTACK_ACCESS_KEY = Buffer.from(bsCaps.accessKey, 'base64').toString('utf-8')
   // Merge chrome-specific options if applicable
 
-} catch (e) {
+} catch (err) {
   console.error('❌ Failed to load capability YAML:', err.message);
   process.exit(1);
 }

package/package.json

@@ -1,19 +1,10 @@
-{
-  "name": "froth-webdriverio-framework",
-  "version": "7.0.118",
+{ "name": "froth-webdriverio-framework",
+  "version": "7.0.119-dev1.0",
   "readme": "WebdriverIO Integration",
   "description": "WebdriverIO and BrowserStack App Automate",
   "license": "MIT",
  
   "scripts": {
-    "wdio:ios": "npx wdio ./ios.conf.js",
-    "wdio:android": "npx wdio ./android.conf.js",
-    "wdio:web": "npx wdio ./web.conf.js",
-    "wdio:webbs": "npx wdio ./web.conf.bs.js",
-    "wdio:ios:local": "npx wdio ./ios.local.conf.js",
-    "android:generate-allure-report": "allure generate ./mobile/androidReports/allure-results --clean && allure open",
-    "ios:generate-allure-report": "allure generate  ./mobile/iosReports/allure-results --clean && allure open",
-    "web:generate-allure-report": "allure generate ./webReports/allure-results --clean && allure open",
     "lint": "eslint ."
   },
   "repository": {
@@ -26,16 +17,17 @@
     "appium"
   ],
   "dependencies": {
-    "@wdio/appium-service": "^9.23.0",
-    "@wdio/browserstack-service": "^9.23.0",
-    "@wdio/cli": "^9.23.0",
-    "@wdio/local-runner": "^9.23.0",
-    "@wdio/mocha-framework": "^9.23.0",
+
+    "@wdio/appium-service": "9.23.0",
+    "@wdio/browserstack-service": "9.23.0",
+    "@wdio/cli": "9.23.0",
+    "@wdio/local-runner": "9.23.0",
+    "@wdio/mocha-framework": "9.23.0",
     "@wdio/spec-reporter": "^9.20.0",
     "appium": "^3.1.2",
     "appium-uiautomator2-driver": "^6.7.8",
     "assert": "^2.1.0",
-    "axios": "^1.13.2",
+    "axios": "1.14.0",
     "browserstack-local": "^1.5.8",
     "chai": "^6.2.2",
     "crypto-js": "^4.2.0",
@@ -52,6 +44,8 @@
     "randexp": "^0.5.3",
     "ts-node": "^10.9.2",
     "typescript": "^5.9.3",
+
     "vm": "^0.1.0"
+
   }
-}
+}