froth-webdriverio-framework 6.0.17 → 6.0.18

package/froth_configs/wdio.common.conf.js

@@ -7,175 +7,43 @@ console.log('=====wdios common config===== ');
 
 // Select platform at runtime
 const PLATFORM = process.env.PLATFORM || 'browserstack';
+const configFile = process.env.YML_NAME || '../ymls/browserstack/android/android_caps.yml';
 console.log('====>PLATFORM:', PLATFORM);
-
-const configFile = process.env.YML_NAME;
-
-const resultdetails = {
-    comments: [],
-    excution_status: null,        // Pass/Fail
-    excution_time: null,   // Execution time in milliseconds
-};
-
 // Load YAML file
-//const capabilities = yaml.load(fs.readFileSync(path.join(path.resolve(process.cwd(), configFile)), 'utf8'));
-
-let rawCaps;
-
-try {
-    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`;
-    console.error(errorMsg);
-    resultdetails.comments.push(errorMsg);
-    resultdetails.excution_status = 'FAIL';
-
-    try {
-        exeDetails.updateExecuitonDetails(
-            process.env.ORGANISATION_DOMAIN_URL,
-            process.env.API_TOKEN,
-            process.env.EXECUTION_ID,
-            resultdetails
-        );
-        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) {
-        console.error('Failed to update execution details:', err.message);
-    }
-    process.exit(1);
-}
-
-console.log('====>capabilities:', rawCaps);
+const capabilities = yaml.load(fs.readFileSync(path.join(path.resolve(process.cwd(), configFile)), 'utf8'));
+console.log('====>capabilities:', capabilities);
 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';
-    try {
-        exeDetails.updateExecuitonDetails(
-            process.env.ORGANISATION_DOMAIN_URL,
-            process.env.API_TOKEN,
-            process.env.EXECUTION_ID,
-            resultdetails
-        );
-        setTimeout(() => {
-            console.log("30 seconds passed.");
-        }, 30000);
-        console.log('Execution details updated successfully.');
-    } catch (err) {
-        console.error('Failed to update execution details:', err.message);
-    }
-    process.exit(1);
-}
 
-function setupPrerequisites(rawCaps) {
-    console.log("==== Running setupPrerequisites() ====");
+function setupPrerequisites() {
+    console.log("inside this fuction first ");
     if (PLATFORM === 'browserstack') {
-        process.env.BROWSERSTACK_USERNAME = rawCaps.userName;
-        rawCaps.accessKey = Buffer.from(rawCaps.accessKey, 'base64').toString('utf-8');
-        process.env.BROWSERSTACK_ACCESS_KEY = rawCaps.accessKey
+        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');
 
-        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);
+        process.env.BS_SESSION_TYPE = capabilities.platformName === 'android' || capabilities.platformName === 'ios' ? 'app-automate' : 'automate';
+        capabilities.buildName = process.env.FROTH_TESTOPS_BUILD_NAME;
 
     }
-
+    
 }
 
-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,
-                buildIdentifier: raw.buildIdentifier,
-                // appiumVersion: "2.0",
-                projectName: process.env.BS_PROJECT_NAME || "Automation",
-                buildName: process.env.FROTH_TESTOPS_BUILD_NAME || "Mobile Build",
-                local: false
-            }
-        };
-    }
-    if (isWeb) {
-
-        // --------------------------
-        // 2. WEB – Browser Automate
-        // --------------------------
+const specificConfig = setupPrerequisites();
 
-        return {
-            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",
-                local: false
-            }
-        };
-    }
-
-    throw new Error("❌ YAML does not look like web or mobile capability");
-}
-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,
 
     {
-        user: process.env.BROWSERSTACK_USERNAME,
-        key: process.env.BROWSERSTACK_ACCESS_KEY,
+        user:  process.env.BROWSERSTACK_USERNAME,
+        key:  process.env.BROWSERSTACK_ACCESS_KEY ,
         // debug: true,
         // execArgv: ['--inspect-brk'],
         services: PLATFORM === 'browserstack'
-            ? [
-                ['browserstack', {
-                    browserstackLocal: false,   // Prevent starting Local binary
-                    opts: { forcelocal: false }   // Ensure no fallback Local is triggered
-                   // forcedStop: true            // Kill any accidental extra process
-                }]
-            ]
+            ? ['browserstack']
             : PLATFORM === 'saucelabs'
                 ? ['sauce']
                 : [],
@@ -184,7 +52,7 @@ exports.config = deepmerge(commonconfig,
         specs: require(SUITE_FILE).tests,
 
         maxInstances: 1,
-        capabilities: [finalCaps],
+        capabilities: [capabilities],
 
         logLevel: 'info',
         coloredLogs: true,
@@ -203,4 +71,6 @@ exports.config = deepmerge(commonconfig,
             ui: 'bdd',
             timeout: 300000
         }
-    });
+    });
+
+

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "froth-webdriverio-framework",
-  "version": "6.0.17",
+  "version": "6.0.18",
+
   "readme": "WebdriverIO Integration",
   "description": "WebdriverIO and BrowserStack App Automate",
   "license": "MIT",
@@ -35,15 +36,13 @@
     "appium-uiautomator2-driver": "^4.0.1",
     "assert": "^2.1.0",
     "axios": "^1.7.7",
+    "browserstack-local": "^1.5.5",
     "chai": "^5.1.1",
     "crypto-js": "^4.2.0",
     "deepmerge": "^4.3.1",
-    "express": "^5.1.0",
     "form-data": "^4.0.0",
     "fs": "^0.0.1-security",
-    "imap-simple": "^5.1.0",
     "js-yaml": "^4.1.0",
-    "mailparser": "^3.9.0",
     "mysql2": "^3.10.2",
     "node-fetch": "^3.3.2",
     "node-localstorage": "^3.0.5",

package/workflows/pipeline.yml

@@ -0,0 +1,63 @@
+definitions:
+  steps:
+    - step: &manual-step
+        name: "Run WebDriverIO Tests"
+        image: node:20
+        size: 2x
+        script:
+          - echo "📥 Checkout code"
+          - git clone $BITBUCKET_GIT_HTTP_ORIGIN . || echo "Repo already cloned"
+
+          - echo "⬇️ Install framework dependency"
+          - npm install froth-webdriverio-framework@prod
+
+          - echo "⚙️ Generate unique build number"
+          - if [ -f generate-build-name.js ]; then node generate-build-name.js; else echo "Skipping build name generation"; fi
+
+          - echo "📡 Sending webhook to Django"
+          - |
+            RESPONSE=$(curl -s -o response.txt -w "%{http_code}" -X POST "https://$organisation_url/api/github-webhook-workflow/" \
+            -H "Content-Type: application/json" \
+            -d "{\"execution_id\": \"$execution_id\", \"run_number\": \"$BITBUCKET_BUILD_NUMBER\"}")
+            cat response.txt
+            echo "Webhook HTTP status: $RESPONSE"
+            if [ "$RESPONSE" -ne 200 ]; then
+              echo "❌ Webhook failed"
+              exit 1
+            else
+              echo "✅ Webhook succeeded"
+            fi
+
+          - echo "🧪 Run WDIO tests"
+          - |
+            export ORGANISATION_DOMAIN_URL="$organisation_url"
+            export EXECUTION_ID="$execution_id"
+            export FROTH_TESTOPS_BUILD_NAME="build-$BITBUCKET_BUILD_NUMBER"
+            export CICD_RUN_ID="$BITBUCKET_BUILD_NUMBER"
+            export YML_NAME="$yml_path"
+            export PLATFORM="$platform"
+            export SUITE="$filepath"
+            export API_TOKEN="$api_token"
+
+            echo "Running npx wdio..."
+            npx wdio ./node_modules/froth-webdriverio-framework/froth_configs/wdio.common.conf.js
+
+pipelines:
+  custom:
+    manual-execution:
+      - variables:
+          - name: organisation_url
+            default: "devapi.frothtestops.com"
+          - name: filepath
+            default: "default_username"
+          - name: execution_id
+            default: "0"
+          - name: api_token
+            default: "cscscs"
+          - name: execution_agent
+            default: "ubuntu"
+          - name: platform
+            default: "ubuntu"
+          - name: yml_path
+            default: "cascasca"
+      - step: *manual-step

package/froth_common_actions/captureNavigationTime.js

@@ -1,53 +0,0 @@
-
-const amendToBrowserstack = require("../froth_api_calls/browsersatckSessionInfo").amend2Browserstack;
-
-/**
- * Capture Navigation / Page Load time
- * @param {string} pageName - (Optional) Custom name for the page
- */
-async function captureLoadNavigationTime(pageName = '') {
-  let pageLoadTime;
-  try {
-    // Try modern API first
-    let perfEntries = await browser.execute(() => {
-      if (performance.getEntriesByType) {
-        const [nav] = performance.getEntriesByType('navigation');
-        return nav ? nav.toJSON() : null;
-      }
-      return null;
-    });
-
-
-    if (perfEntries && perfEntries.loadEventEnd) {
-      pageLoadTime = perfEntries.loadEventEnd;
-    } else {
-      // Fallback to old API
-      const perfTiming = await browser.execute(() => JSON.stringify(window.performance.timing));
-      const timing = JSON.parse(perfTiming);
-      pageLoadTime = timing.loadEventEnd - timing.navigationStart;
-    }
-
-    // If no custom name passed, use the page title
-    let title = pageName || await browser.getTitle();
-
-    // Clean title: remove special characters, keep words separated by space
-    title = title
-      .replace(/[^a-zA-Z0-9]+/g, ' ')  // replace non-alphanumeric with space
-      .replace(/\s+/g, ' ')            // collapse multiple spaces
-      .trim();                         // remove leading/trailing spaces
-
-    pageLoadTime = perfEntries.loadEventEnd; // Already relative to startTime
-    pageLoadTime = (pageLoadTime / 1000).toFixed(2); // Convert ms to seconds, keep 2 decimals
-    await amendToBrowserstack(`⏱ Page Load Time for ${title}: ${pageLoadTime} seconds`, "info");
-
-    console.log(`⏱ Page Load Time for ${title}: ${pageLoadTime} seconds`);
-  } catch (error) {
-    console.error('Error capturing navigation timing:', error);
-  }
-
-  return pageLoadTime;
-}
-
-
-module.exports = { captureLoadNavigationTime };
-

package/froth_common_actions/emailParsing.js

@@ -1,161 +0,0 @@
-//process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0";
-
-const Imap = require('imap');
-const { simpleParser } = require('mailparser');
-const cheerio = require('cheerio');
-
-/**
- * Connects to an IMAP inbox, parses emails, and extracts all unique links.
- * @param {Object} config - IMAP config { user, password, host, port, tls }
- * @param {Object} [filter] - Optional filter { subject, from }
- * @returns {Promise<Array<{link: string, text: string}>>}
- */
-async function getEmailLinks(username,app_password, subjectdetails,fromemail) {
-    const config = {
-        user: username,
-        password: app_password,
-        host: 'imap.gmail.com',
-        port: 993,
-        tls: true
-    };
-    const filter = {
-             subject: subjectdetails,
-             from: fromemail
-        };
-    const imap = new Imap(config);
-
-    function openInbox(cb) {
-        imap.openBox('INBOX', true, cb);
-    }
-
-    return new Promise((resolve, reject) => {
-        let results = new Map();
-        let allLinks = [];
-        let parseDone;
-        const parsePromise = new Promise(res => { parseDone = res; });
-
-        imap.once('ready', function () {
-            openInbox(function (err, box) {
-                if (err) return cleanup(err);
-
-                // Build search criteria
-                let searchCriteria = ['ALL'];
-                if (filter.subject) searchCriteria.push(['HEADER', 'SUBJECT', filter.subject]);
-                if (filter.from) searchCriteria.push(['FROM', filter.from]);
-
-                imap.search(searchCriteria, function (err, uids) {
-                    if (err) return cleanup(err);
-                    if (!uids.length) return cleanup(null, []);
-
-                    // Sort UIDs descending to get the latest email first
-                    uids = uids.sort((a, b) => b - a);
-                    // Only fetch the latest email
-                    const latestUid = uids[0];
-                    const fetch = imap.fetch([latestUid], { bodies: '' });
-                    fetch.on('message', function (msg) {
-                        let buffer = '';
-                        msg.on('body', function (stream) {
-                            stream.on('data', function (chunk) {
-                                buffer += chunk.toString('utf8');
-                            });
-                        });
-                        msg.once('end', async function () {
-                            try {
-                                const parsed = await simpleParser(buffer);
-                                let links = [];
-
-                                // Extract from HTML with element context
-                                if (parsed.html) {
-                                    const $ = cheerio.load(parsed.html);
-                                    $('a[href], button[href], [role="button"][href], img[src], area[href]').each((_, el) => {
-                                        let link = null;
-                                        let text = '';
-                                        let elementType = el.tagName;
-                                        if (elementType === 'a' || elementType === 'area') {
-                                            link = $(el).attr('href');
-                                            text = $(el).text().trim() || link;
-                                        } else if (elementType === 'img') {
-                                            link = $(el).attr('src');
-                                            text = $(el).attr('alt') || link;
-                                        } else if (elementType === 'button' || $(el).attr('role') === 'button') {
-                                            link = $(el).attr('href');
-                                            text = $(el).text().trim() || link;
-                                        }
-                                        if (link) {
-                                            links.push({ link, text, element: elementType });
-                                        }
-                                    });
-                                }
-
-                                // Extract from plaintext
-                                if (parsed.text) {
-                                    const urlRegex = /(https?:\/\/[^\s]+)/g;
-                                    let match;
-                                    while ((match = urlRegex.exec(parsed.text))) {
-                                        links.push({ link: match[1], text: match[1], element: 'text' });
-                                    }
-                                }
-
-                                // Deduplicate by link and element context
-                                for (const l of links) {
-                                    const key = l.link + '|' + l.element + '|' + l.text;
-                                    if (!results.has(key)) {
-                                        results.set(key, { link: l.link, text: l.text, element: l.element });
-                                    }
-                                }
-                                allLinks = Array.from(results.values());
-                                parseDone();
-                            } catch (e) {
-                                // Log and continue
-                                console.error('Parse error:', e);
-                                parseDone();
-                            }
-                        });
-                    });
-                    fetch.once('error', cleanup);
-                    fetch.once('end', async () => {
-                        await parsePromise;
-                        cleanup(null, allLinks);
-                    });
-                });
-            });
-        });
-
-        imap.once('error', cleanup);
-
-        function cleanup(err, data) {
-            imap.end();
-            if (err) reject(err);
-            else resolve(data);
-        }
-
-        imap.connect();
-    });
-}
-
-async function findLinks(links,searchText) {
-        const findLinkByText = (links, searchText) => {
-            return links.find(l => l.text && l.text.toLowerCase().includes(searchText.toLowerCase()));
-        };
-        // Example usage:
-        const found = findLinkByText(links, searchText);
-        return found ? found.link : null;
-}
-
-
-// Example main function for direct execution
-// if (require.main === module) {
-//     (async () => {
-        
-//         const links = await extractEmailLinks('gfntesting44@gmail.com','wtrd qfee dicr hpba', "GFN Testing, review your Google Account settings","no-reply@google.com");
-//         console.log('Extracted links in main:', links); 
-//         const foundLink = await findLinks(links,"Privacy Policy");
-//         console.log('Found Link: ', foundLink);
-        
-
-//     })();
-   
-// }
-
-module.exports = {  getEmailLinks ,findLinks}
-

package/froth_common_actions/logData.js

@@ -1,73 +0,0 @@
-const amendToBrowserstack = require("../froth_api_calls/browsersatckSessionInfo").amend2Browserstack;
-
-async function logJsonData2Table(jsonData) {
-    try {
-        console.log("Logging JSON data to table format in BrowserStack:");
-        console.log(JSON.stringify(jsonData, null, 2));
-
-        if (!Array.isArray(jsonData) || jsonData.length === 0) {
-            await amendToBrowserstack("No data to log", "info");
-            return;
-        }
-
-        // --- Extract keys dynamically (columns) ---
-        const keys = Object.keys(jsonData[0]);
-
-        // --- Calculate max width for each column ---
-        const colWidths = {};
-        keys.forEach(key => {
-            colWidths[key] = Math.max(
-                key.length,
-                ...jsonData.map(row => String(row[key] ?? "").length)
-            ) + 2;
-        });
-
-        // --- Build line separator ---
-        const line = "-".repeat(
-            keys.reduce((sum, key) => sum + colWidths[key], 0) + keys.length + 1
-        );
-
-        // --- Build header ---
-        let table = line + "\n";
-        table += "|" + keys.map(key => ` ${key.padEnd(colWidths[key])}`).join("|") + "|\n";
-        table += line + "\n";
-
-        // --- Build rows ---
-        jsonData.forEach(row => {
-            table += "|" + keys.map(key => ` ${String(row[key] ?? "").padEnd(colWidths[key])}`).join("|") + "|\n";
-        });
-
-        table += line;
-        console.log(table);
-        // --- Send to BrowserStack ---
-        await amendToBrowserstack(table, "info");
-
-    } catch (error) {
-        console.error('Error occurred while logging JSON data to table:', error);
-        // let annotationMessage = `Error occurred while logging JSON data to table: ${error.message}.`;
-        // await amendToBrowserstack(annotationMessage, "error");
-    }
-}
-module.exports = {
-    logJsonData2Table
-};
-
-// // Main function to execute the API call
-// async function main() {
-//     try {
-//         /// BUFFER.setItem("EXECUTION_SESSIONID","297666e2fd4195de98d7da3b359669072ff41a2a");
-//         const pageTimes = "[{ name: 'Homepage', time: 120 },{ name: 'Service Account Page', time: 250 },{ name: 'Search Results', time: 180 }]";
-
-//         await logJsonData2Table(pageTimes, "info");
-//         // const data = [
-//         //     { id: 1, score: 95.5, passed: true },
-//         //     { id: 2, score: 67.2, passed: false },
-//         //     { id: 3, score: null, passed: "N/A" }
-//         // ];
-//         // await logJsonData2Table(data, "info");
-//     } catch (error) {
-//         console.error('Error in main function:', error);
-//     }
-// }
-
-// main();

package/froth_common_actions/swicthWindowTab.js

@@ -1,36 +0,0 @@
-/**
- * Switches to a browser window/tab by its title using WebdriverIO.
- * @param {string} title - The title of the window/tab to switch to.
- */
-async function switch2WindowByTitle(title) {
-    const handles = await browser.getWindowHandles();
-    for (const handle of handles) {
-        await browser.switchToWindow(handle);
-        const currentTitle = await browser.getTitle();
-        if (currentTitle === title) {
-            return true; // Switched successfully
-        }
-    }
-    throw new Error(`No window with title "${title}" found.`);
-}
-
-/**
- * Switches to a browser window/tab by its index using WebdriverIO.
- * @param {number} index - The index of the window/tab to switch to (0-based).
- */
-async function switch2WindowByIndex(index) {
-    const handles = await browser.getWindowHandles();
-    console.log(`Total open windows: ${handles.length}`);
-    console.log(`Switching to window at index: ${index}`);
-    console.log(`Available handles: ${handles.join(', ')}`);
-    if (index < 0 || index >= handles.length) {
-        throw new Error(`Invalid window index: ${index}. There are only ${handles.length} windows open.`);
-    }
-    await browser.switchToWindow(handles[index]);
-    return true; // Switched successfully
-}
-
-
-// Example usage in a test
-// await switchToWindowByTitle('Your Window Title');
-module.exports = {switch2WindowByTitle,switch2WindowByIndex};