froth-webdriverio-framework 6.0.7 → 6.0.9

package/froth_configs/commonconfig.js

@@ -8,7 +8,6 @@ const exeDetails = require("../froth_api_calls/getexecutionDetails")
 const getBSSessionDetails = require("../froth_api_calls/browsersatckSessionInfo").getBSSessionDetails;
 const { fail } = require("assert");
 const { error } = require('console');
-const browserstack = require("browserstack-local");
 //const isBrowserStackEnabled = process.env.BROWSERSTACK;
 let starttime;
 let endtime;
@@ -19,7 +18,6 @@ const resultdetails = {
     excution_status: null,        // Pass/Fail
     excution_time: null,   // Execution time in milliseconds
 };
-let bsLocal;
 // Description: This file contains the common configuration for the webdriverio framework.
 const commonconfig = {
 
@@ -84,42 +82,22 @@ const commonconfig = {
                 console.log("====> BROWSERSTACK_LOCAL : " + process.env.BROWSERSTACK_LOCAL);
                 console.log("Local enabled? →", capabilities['bstack:options']?.local);
 
-                // const isLocalEnabled = process.env.BROWSERSTACK_LOCAL === "true";
-
-                // if (isLocalEnabled) {
-                //     bsLocal = new browserstack.Local();
-                //     const localArgs = {
-                //         key: process.env.BROWSERSTACK_ACCESS_KEY,
-                //         forceLocal: true,
-                //         localIdentifier: capabilities.localIdentifier || 'wdioLocal'
-                //     };
-
-                //     await new Promise((resolve, reject) => {
-                //         bsLocal.start(localArgs, function (error) {
-                //             if (error) return reject(error);
-                //             console.log("====> BrowserStack Local started successfully.");
-                //             resolve();
-                //         });
-                //     });
-
-                //     // Add Local settings into capabilities dynamically
-                //     capabilities['browserstack.local'] = true;
-                //     capabilities['browserstack.localIdentifier'] = localArgs.localIdentifier || 'ExecuteLocal';
-                // }
-                // else {
-                //     console.log("====> BROWSERSTACK_LOCAL not set. Skipping BrowserStack Local startup." + process.env.BROWSERSTACK_LOCAL);
-                //     // Make sure no stale values from config remain
-                //     delete capabilities['browserstack.local'];
-                //     delete capabilities['browserstack.localIdentifier'];
-                // }
+                const isLocalEnabled = process.env.BROWSERSTACK_LOCAL === "true";
+
+                if (isLocalEnabled) {
+                    console.log("====> Starting BrowserStack Local...");
+                    if (!capabilities['bstack:options']) capabilities['bstack:options'] = {};
+                    capabilities['bstack:options'].browserstackLocal = true;
+                    console.log("✔ BrowserStack Local enabled dynamically");
+                }
 
                 // capabilities.accessKey = Buffer.from(capabilities.accessKey, 'base64').toString('utf-8');
                 if (capabilities.platformName === 'android' || capabilities.platformName === 'ios') {
                     capabilities['appium:app'] = process.env.BROWSERSTACK_APP_PATH;
-
                     // capabilities.app = process.env.BROWSERSTACK_APP_PATH;
                     const appValue = capabilities['appium:app'];
-                    console.log("App Value:", appValue);
+                    console.log("App Value=====>", appValue);
+                    
                     if (appValue === undefined || appValue === null || appValue === '') {
                         console.error("🚨 Error: BROWSERSTACK_APP_PATH is not defined or empty.");
                         resultdetails.excution_status = 'FAILED';

package/froth_configs/wdio.common.conf.js

@@ -20,11 +20,13 @@ const resultdetails = {
 // Load YAML file
 //const capabilities = yaml.load(fs.readFileSync(path.join(path.resolve(process.cwd(), configFile)), 'utf8'));
 
-let capabilities;
+let rawCaps;
 
 try {
-    capabilities = yaml.load(fs.readFileSync(path.join(path.resolve(process.cwd(), configFile)), 'utf8'));
+    rawCaps = yaml.load(fs.readFileSync(path.join(path.resolve(process.cwd(), configFile)), 'utf8'));
     // Merge chrome-specific options if applicable
+    console.log("==== RAW YAML ====", rawCaps);
+
 
 } catch (e) {
     const errorMsg = `The capability file does not exist in the currently configured repository at path: ${path.resolve(process.cwd(), configFile)}: ${e.message},Please update the Capability by editing the file`;
@@ -49,20 +51,16 @@ try {
     }
     process.exit(1);
 }
-console.log('====>capabilities:', capabilities);
 
+console.log('====>capabilities:', rawCaps);
 const SUITE_FILE = path.resolve(process.cwd(), process.env.SUITE);
 console.log('====>SUITE_FILE:', SUITE_FILE);
 
 if (!SUITE_FILE || !fs.existsSync(SUITE_FILE)) {
     let errorMsg = `The suite file does not exist in the currently configured repository at path: ${SUITE_FILE}. Please update the SUITE by editing the file`;
-
     console.error(errorMsg);
     resultdetails.comments.push(errorMsg);
     resultdetails.excution_status = 'FAIL';
-
-    // Fire API call in background (non-blocking)
-
     try {
         exeDetails.updateExecuitonDetails(
             process.env.ORGANISATION_DOMAIN_URL,
@@ -72,7 +70,6 @@ if (!SUITE_FILE || !fs.existsSync(SUITE_FILE)) {
         );
         setTimeout(() => {
             console.log("30 seconds passed.");
-            // You can call your API or exit the process here
         }, 30000);
         console.log('Execution details updated successfully.');
     } catch (err) {
@@ -81,86 +78,88 @@ if (!SUITE_FILE || !fs.existsSync(SUITE_FILE)) {
     process.exit(1);
 }
 
-function setupPrerequisites() {
-    console.log("inside this fuction first ");
+function setupPrerequisites(rawCaps) {
+    console.log("==== Running setupPrerequisites() ====");
     if (PLATFORM === 'browserstack') {
-        process.env.BROWSERSTACK_USERNAME = capabilities.userName;
-        capabilities.accessKey = Buffer.from(capabilities.accessKey, 'base64').toString('utf-8');
-        process.env.BROWSERSTACK_ACCESS_KEY = capabilities.accessKey
-        console.log('capabilities.platformName:', capabilities.platformName ?? 'web');
-
-        // Determine session type automatically
-        const isMobile =
-            capabilities.platformName &&
-            (capabilities.platformName.toLowerCase() === "android" ||
-                capabilities.platformName.toLowerCase() === "ios");
-
-        if (isMobile) {
-            process.env.BS_SESSION_TYPE = "app-automate";
-        } else {
-            process.env.BS_SESSION_TYPE = "automate";
-        }
-        // process.env.BS_SESSION_TYPE = capabilities.platformName === 'android' || capabilities.platformName === 'ios' ? 'app-automate' : 'automate';
-        capabilities.buildName = process.env.FROTH_TESTOPS_BUILD_NAME;
+        process.env.BROWSERSTACK_USERNAME = rawCaps.userName;
+        rawCaps.accessKey = Buffer.from(rawCaps.accessKey, 'base64').toString('utf-8');
+        process.env.BROWSERSTACK_ACCESS_KEY = rawCaps.accessKey
+
+        console.log('capabilities.platformName:', rawCaps.platformName ?? 'web');
+        const isMobile = rawCaps.platformName === "android" || rawCaps.platformName === "ios";
+        process.env.BS_SESSION_TYPE = isMobile ? 'app-automate' : 'automate';
+
+        rawCaps.buildName = process.env.FROTH_TESTOPS_BUILD_NAME;
+        console.log("SessionType=====>:", process.env.BS_SESSION_TYPE);
 
     }
 
 }
 
-setupPrerequisites();
-
-// =====================================================
-// IMPORTANT: NORMALIZE CAPABILITY FUNCTION
-// =====================================================
-function normalizeCapabilities(rawCaps, sessionType, platform) {
-    if (platform === "browserstack") {
-        // ----------------------------------
-        // BrowserStack Automate (Web)
-        // ----------------------------------
-        if (sessionType === "automate") {
-            return {
-                browserName: rawCaps.browserName,
-                browserVersion: rawCaps.browserVersion,
-                'bstack:options': {
-                    os: rawCaps.os,
-                    osVersion: rawCaps.osVersion,
-                    consoleLogs: rawCaps.consoleLogs,
-                    networkLogs: rawCaps.networkLogs,
-                    debug: rawCaps.debug,
-                    interactiveDebugging: rawCaps.interactiveDebugging,
-                    buildIdentifier: rawCaps.buildIdentifier,
-                    // userName: rawCaps.userName,
-                    // accessKey: process.env.BROWSERSTACK_ACCESS_KEY
-                }
-            };
-        }
+setupPrerequisites(rawCaps);
+// ---------------------------------------------
+// NORMALIZER — WEB + MOBILE (AUTODETECTION)
+// ---------------------------------------------
+function normalizeCapabilities(raw) {
+    const isMobile =
+        raw.platformName === "android" || raw.platformName === "ios";
+    const isWeb = !!raw.browserName;
+
+    // --------------------------
+    // 1. MOBILE – App Automate
+    // --------------------------
+    if (isMobile) {
+
+        return {
+            platformName: raw.platformName,
+            "appium:platformVersion": raw.platformVersion,
+            "appium:deviceName": raw.deviceName,
+            "appium:deviceOrientation": raw.deviceOrientation,
+            "bstack:options": {
+                userName: raw.userName,
+                accessKey: Buffer.from(raw.accessKey, "base64").toString("utf8"),
+                debug: raw.debug,
+                networkLogs: raw.networkLogs,
+                interactiveDebugging: raw.interactiveDebugging,
+               // appProfiling: raw.appProfiling,
+                buildIdentifier: raw.buildIdentifier,
+               // sessionType: "app",
+                appiumVersion: "2.0",
+                projectName: process.env.BS_PROJECT_NAME || "Automation",
+                buildName: process.env.FROTH_TESTOPS_BUILD_NAME || "Mobile Build",
+            }
+        };
+    } 
+    if (isWeb) {
+
+        // --------------------------
+        // 2. WEB – Browser Automate
+        // --------------------------
 
-        // ----------------------------------
-        // BrowserStack APP-Automate (Mobile)
-        // ----------------------------------
         return {
-            platformName: rawCaps.platformName,
-            'appium:platformVersion': rawCaps.platformVersion,
-            'appium:deviceName': rawCaps.deviceName,
-            'appium:deviceOrientation': rawCaps.deviceOrientation,
-            'appium:app': rawCaps.app || "",
-            'bstack:options': {
-                // appProfiling: rawCaps.appProfiling,
-                networkLogs: rawCaps.networkLogs,
-                debug: rawCaps.debug,
-                interactiveDebugging: rawCaps.interactiveDebugging,
-                buildIdentifier: rawCaps.buildIdentifier,
-
-                // userName: rawCaps.userName,
-                // accessKey: process.env.BROWSERSTACK_ACCESS_KEY
+            browserName: raw.browserName,
+            browserVersion: raw.browserVersion || "latest",
+            "bstack:options": {
+                os: raw.os || "Windows",
+                osVersion: raw.osVersion || "11",
+                userName: raw.userName,
+                accessKey: Buffer.from(raw.accessKey, "base64").toString("utf8"),
+                debug: raw.debug !== false,
+                networkLogs: raw.networkLogs !== false,
+               // sessionType: "automate",
+                projectName: process.env.BS_PROJECT_NAME || "Automation",
+                buildName: process.env.FROTH_TESTOPS_BUILD_NAME || "Web Build",
             }
         };
     }
-    return rawCaps;
 
+    throw new Error("❌ YAML does not look like web or mobile capability");
 }
-const normalizedCaps = normalizeCapabilities(capabilities, process.env.BS_SESSION_TYPE, PLATFORM);
-console.log("====> Final WDIO Normalised Capabilities:", normalizedCaps);
+const finalCaps =
+    PLATFORM === "browserstack" ? normalizeCapabilities(rawCaps) : rawCaps;
+
+console.log("==== FINAL CAPS SENT TO BROWSERSTACK ====");
+console.log(JSON.stringify(finalCaps, null, 2));
 
 exports.config = deepmerge(commonconfig,
 
@@ -169,23 +168,17 @@ exports.config = deepmerge(commonconfig,
         key: process.env.BROWSERSTACK_ACCESS_KEY,
         // debug: true,
         // execArgv: ['--inspect-brk'],
-        // services: PLATFORM === 'browserstack'
-        //     ? [['browserstack', { browserstackLocal: false }]]
-        //     : PLATFORM === 'saucelabs'
-        //         ? ['sauce']
-        //         : [],
-
-        services: [
-            [
-                'browserstack',
-                { browserstackLocal: false, opts: { forcelocal: false } },
-            ],
-        ],
+        services: PLATFORM === 'browserstack'
+            ? [['browserstack', { browserstackLocal: false }]]
+            : PLATFORM === 'saucelabs'
+                ? ['sauce']
+                : [],
+
         //runner: 'local',
         specs: require(SUITE_FILE).tests,
 
         maxInstances: 1,
-        capabilities: [normalizedCaps],
+        capabilities: [finalCaps],
 
         logLevel: 'info',
         coloredLogs: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "froth-webdriverio-framework",
-  "version": "6.0.7",
+  "version": "6.0.9",
   "readme": "WebdriverIO Integration",
   "description": "WebdriverIO and BrowserStack App Automate",
   "license": "MIT",