froth-webdriverio-framework 7.0.119-dev1.10 → 7.0.119-dev1.11

package/allure-report-utils/allure-helper.js

@@ -41,32 +41,20 @@ class AllureHelper {
 
     /**
      * Capture and attach screenshot to Allure report
+     * Screenshots stored ONLY in Allure report folder (via addAttachment)
      * @param {string} screenshotName - Name for the screenshot
      */
     static async captureScreenshot(screenshotName = 'screenshot') {
         try {
-            // Ensure screenshot directory exists
-            const screenshotDir = './allure-screenshots';
-            if (!fs.existsSync(screenshotDir)) {
-                fs.mkdirSync(screenshotDir, { recursive: true });
-            }
-
-            // Take screenshot and save to file
-            const screenshotPath = path.join(screenshotDir, `${screenshotName}.png`);
-            await browser.saveScreenshot(screenshotPath);
-
-            // Read the screenshot
-            if (fs.existsSync(screenshotPath)) {
-                const imageBuffer = fs.readFileSync(screenshotPath);
-
-                // Attach to Allure using the proper method
-                const allure = require('@wdio/allure-reporter').default;
-                allure.addAttachment(screenshotName, imageBuffer, 'image/png');
-
-                console.log(`📸 Screenshot captured: ${screenshotName}`);
-            } else {
-                console.warn(`⚠️  Screenshot file not found: ${screenshotPath}`);
-            }
+            // Take screenshot to buffer (no separate file storage)
+            const screenshotBase64 = await browser.takeScreenshot();
+            const imageBuffer = Buffer.from(screenshotBase64, 'base64');
+
+            // Attach to Allure using the proper method (stored in report folder)
+            const allure = require('@wdio/allure-reporter').default;
+            allure.addAttachment(screenshotName, imageBuffer, 'image/png');
+
+            console.log(`📸 Screenshot captured: ${screenshotName}`);
         } catch (error) {
             console.error(`❌ Error capturing screenshot: ${error.message}`);
         }

package/allure-report-utils/generate-allure-report.js

@@ -67,29 +67,59 @@ function generateAllureReport(reportDir) {
 
         execSync(command, { stdio: 'inherit' });
 
-        // Create a simple server start script in the report folder
+        // Resolve absolute path to the report (for scripts that may run from anywhere)
+        const absOutputDir = path.resolve(outputDir);
+
+        // Create a start script for Mac/Linux (uses script's own directory)
         const startScriptPath = path.join(outputDir, 'start-server.sh');
         const startScriptContent = `#!/bin/bash
+# Allure Report Server Starter (Mac/Linux)
+# Double-click this file or run: ./start-server.sh
+
+# Change to this script's directory (so paths always resolve)
+cd "$(dirname "$0")"
+
 echo "🌐 Starting Allure Report Server..."
-echo "📁 Report: ${outputDir}"
-echo "🔗 Open: http://localhost:8080"
+echo "📁 Report: $(pwd)"
+echo "🔗 Open in browser: http://localhost:8080"
 echo ""
-echo "Press Ctrl+C to stop the server"
+echo "💡 Press Ctrl+C to stop the server"
 echo ""
-npx allure open "${outputDir}" --port 8080
+
+# Find npx (walk up to project root with node_modules)
+REPORT_DIR="$(pwd)"
+PARENT_DIR="$(cd ../.. && pwd)"
+
+# Try npx from project root, fall back to local
+cd "$PARENT_DIR"
+npx allure open "$REPORT_DIR" --port 8080
 `;
         fs.writeFileSync(startScriptPath, startScriptContent, { mode: 0o755 });
 
         // Create a Windows batch file
         const batchScriptPath = path.join(outputDir, 'start-server.bat');
         const batchScriptContent = `@echo off
+REM Allure Report Server Starter (Windows)
+REM Double-click this file to view the report
+
+REM Save report location (script's own directory)
+set "REPORT_DIR=%~dp0"
+REM Remove trailing backslash
+if "%REPORT_DIR:~-1%"=="\\" set "REPORT_DIR=%REPORT_DIR:~0,-1%"
+
+REM Project root is two levels up (reports/allure/build/report -> project)
+for %%i in ("%REPORT_DIR%\\..\\..\\..\\..") do set "PROJECT_ROOT=%%~fi"
+
 echo 🌐 Starting Allure Report Server...
-echo 📁 Report: ${outputDir}
-echo 🔗 Open: http://localhost:8080
+echo 📁 Report: %REPORT_DIR%
+echo 🔗 Open in browser: http://localhost:8080
 echo.
-echo Press Ctrl+C to stop the server
+echo 💡 Press Ctrl+C to stop the server
 echo.
-npx allure open "${outputDir}" --port 8080
+
+cd /d "%PROJECT_ROOT%"
+call npx allure open "%REPORT_DIR%" --port 8080
+pause
 `;
         fs.writeFileSync(batchScriptPath, batchScriptContent);
 

package/froth_api_calls/getexecutionDetails.js

@@ -126,8 +126,11 @@ async function updateExecuitonDetails(frothUrl, token, id, resultdetails) {
         return;
     }
 
-    if (BUFFER.getItem('FROTH_UPDATE_EXECUTION') === 'TRUE') {
-        console.log('ℹ️ Execution already updated — skipping');
+    // Only skip update if the flag is EXPLICITLY set to 'TRUE'
+    // Proceed with update in all other cases: not set, null, undefined, 'false', 'FALSE', or empty
+    const updateFlag = BUFFER.getItem('FROTH_UPDATE_EXECUTION');
+    if (updateFlag !== null && updateFlag !== undefined && String(updateFlag).toUpperCase() === 'TRUE') {
+        console.log('ℹ️ Execution already updated (FROTH_UPDATE_EXECUTION=TRUE) — skipping');
         return;
     }
 
@@ -141,12 +144,15 @@ 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);
-        // }
+        // Only include execution time for LOCAL runs
+        // (BrowserStack tracks its own time, so we don't override it there)
+        if (process.env.PLATFORM === 'local' &&
+            resultdetails.excution_time &&
+            resultdetails.excution_time !== 'NaN:NaN:NaN'
+        ) {
+            formData.append('excution_time', resultdetails.excution_time);
+            console.log(`⏱️ Sending local execution time: ${resultdetails.excution_time}`);
+        }
 
         if (resultdetails.comments === null)
             console.log("Comments is null")
@@ -187,37 +193,6 @@ async function updateExecuitonDetails(frothUrl, token, id, resultdetails) {
     }
 }
 
-/* ===================== UPDATE CICD / REPORT ===================== */
-
-async function update_CICDRUNID_ReportUrl(frothUrl, token, id) {
-    if (!isValidId(id)) return;
-
-    const url = `${frothUrl}/api/test-execution-update/${id}/`;
-    const formData = new FormData();
-
-    console.log('PUT:', url);
-
-    try {
-        formData.append('updated_through_bot', true);
-        formData.append('run_id', process.env.CICD_RUN_ID);
-
-        const reportUrl = BUFFER.getItem('REPORT_URL');
-        if (reportUrl) {
-            formData.append('report_url', reportUrl);
-        }
-
-        const response = await fetch(url, {
-            method: 'PUT',
-            headers: { 'Authorization': `Bearer ${token}` },
-            body: formData
-        });
-
-        await handleResponse(response, 'update_CICDRUNID_ReportUrl');
-
-    } catch (error) {
-        console.error('❌ update_CICDRUNID_ReportUrl error:', error.message);
-    }
-}
 
 /* ===================== UPDATE SCRIPT STATUS ===================== */
 
@@ -293,6 +268,5 @@ async function updateScriptExecutionStatus(
 module.exports = {
     getExecuitonDetails,
     updateExecuitonDetails,
-    updateScriptExecutionStatus,
-    update_CICDRUNID_ReportUrl
+    updateScriptExecutionStatus
 };

package/froth_configs/base.config.js

@@ -27,49 +27,8 @@ module.exports = {
         timeout: 300000
     },
 
-    // Enable screenshot capture for Allure (WDIO built-in)
-    screenshotOnSave: true,
-
-    // Test hooks
-    before: async function() {
-        console.log('🔧 BEFORE hook triggered in base config');
-    },
-
-    // Capture final screenshot directly in the report folder
-    after: async function(results) {
-        console.log('🔧 AFTER hook triggered in base config');
-
-        // Only process if running locally
-        if (process.env.PLATFORM === 'local') {
-            try {
-                const fs = require('fs');
-                const nodePath = require('path');
-
-                // Find the most recent Allure results directory
-                const reportsBaseDir = './reports/allure';
-                if (fs.existsSync(reportsBaseDir)) {
-                    const dirs = fs.readdirSync(reportsBaseDir)
-                        .map(file => nodePath.join(reportsBaseDir, file))
-                        .filter(file => fs.statSync(file).isDirectory())
-                        .sort((a, b) => fs.statSync(b).mtimeMs - fs.statSync(a).mtimeMs);
-
-                    if (dirs.length > 0) {
-                        const latestDir = dirs[0];
-                        console.log(`📁 Report directory: ${latestDir}`);
+    // Enable screenshot capture for Allure (handled by screenshot-service)
+    // Screenshots stored ONLY in Allure report folder - no separate folders
+};
 
-                        // Save final screenshot directly to the report directory
-                        const timestamp = new Date().toISOString().replace(/[:.]/g, '-');
-                        const screenshotName = `Test_Suite_Completion_${timestamp}.png`;
-                        const screenshotPath = nodePath.join(latestDir, screenshotName);
 
-                        console.log(`📸 Saving final screenshot directly to report: ${screenshotName}`);
-                        await browser.saveScreenshot(screenshotPath);
-                        console.log(`✅ Screenshot saved in report folder: ${screenshotName}`);
-                    }
-                }
-            } catch (error) {
-                console.error('❌ Error saving screenshot to report folder:', error.message);
-            }
-        }
-    }
-};

package/froth_configs/commonhook.js

@@ -5,6 +5,10 @@ const { getBSSessionDetails, updateBrowserStackReport } = require('../froth_api_
 let globalErrorHandled = false;
 let suiteStartTime = 0;
 let totalTestDuration = 0;
+// Track real pass/fail counts across tests (exitCode is unreliable in afterSession)
+let testsPassed = 0;
+let testsFailed = 0;
+let testsRun = 0;
 const url = require('url');
 const fs = require('fs');
 const path = require('path');
@@ -14,7 +18,7 @@ let executionUpdated = false;
 const resultdetails = {
   comments: [],
   excution_status: null,
- // excution_time: null
+  excution_time: null
 };
 
 /* ----------------- GLOBAL ERROR HANDLERS ----------------- */
@@ -148,6 +152,12 @@ const commonHooks = {
 
     console.log('==== ON PREPARE HOOK ====');
 
+    // Reset the "already updated" flag at the START of every run
+    // This prevents stale 'TRUE' values (persisted to disk by node-localstorage)
+    // from a previous run causing the current run to skip the execution update.
+    BUFFER.removeItem('FROTH_UPDATE_EXECUTION');
+    console.log('🧹 Reset FROTH_UPDATE_EXECUTION flag (fresh run)');
+
     await setAllDetails.setEnvVariables();
     await setAllDetails.setExecutionDetails();
     await setAllDetails.setSuiteDetails();
@@ -252,11 +262,6 @@ const commonHooks = {
       }
     }
 
-    // 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) => {
@@ -283,6 +288,7 @@ const commonHooks = {
     console.log(`==== AFTER TEST HOOK ===='${test.title}'`);
     if (!totalTestDuration) totalTestDuration = 0;
     totalTestDuration += duration;
+    testsRun++;
 
     const fileName = path.basename(test.file);
     let scriptresult = "NOT RUN";
@@ -291,11 +297,13 @@ const commonHooks = {
 
     if (passed) {
       scriptresult = "PASSED"
+      testsPassed++;
       resultdetails.comments.push(`${test.title} - passed`);
       console.log(`====> resultdetails comments: ${resultdetails.comments}`);
     }
     else if (!finalPassed || error) {
       scriptresult = "FAILED"
+      testsFailed++;
       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"}`);
@@ -331,13 +339,29 @@ 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);
 
-    console.log("Exit code after session===>" + exitCode)
-    if (exitCode === undefined || exitCode === null) {
-      exitCode = 1   // treat as failure
+    // Calculate execution time (HH:MM:SS) and attach it for local runs.
+    // getexecutionDetails.js will only send this to the API when PLATFORM === 'local'.
+    if (process.env.PLATFORM === 'local') {
+      resultdetails.excution_time = await msToTime(totalTime);
+      console.log(`⏱ Local execution time (hh:mm:ss): ${resultdetails.excution_time}`);
     }
-    resultdetails.excution_status = exitCode === 0 ? 'PASSED' : 'FAILED';
+
+    console.log(`📊 Tests run: ${testsRun}, Passed: ${testsPassed}, Failed: ${testsFailed}`);
+    console.log(`Exit code after session===> ${exitCode}`);
+
+    if (testsRun > 0) {
+      // Tests actually executed - use real results
+      resultdetails.excution_status = testsFailed > 0 ? 'FAILED' : 'PASSED';
+    } else {
+      // No tests ran (session/driver failure or empty suite) - use exitCode
+      if (exitCode === undefined || exitCode === null) {
+        exitCode = 1; // treat as failure
+      }
+      resultdetails.excution_status = exitCode === 0 ? 'PASSED' : 'FAILED';
+    }
+
+    console.log(`🏷️ Execution status determined: ${resultdetails.excution_status}`);
 
     console.log('Comments being sent:', resultdetails.comments);
     //resultdetails.comments.push(BUFFER.getItem('ALL_COMMENTS'))
@@ -357,7 +381,7 @@ const commonHooks = {
           'completed'
         );
       }
-      
+
     }
 
 

package/froth_configs/local/mobile.config.js

@@ -1,3 +1,5 @@
+const commonHooks = require('../commonhook');
+
 module.exports = () => {
     // Generate unique report directory using BROWSERSTACK_BUILD_NAME
     const buildName = process.env.BROWSERSTACK_BUILD_NAME || 'local-mobile-build';
@@ -11,6 +13,9 @@ module.exports = () => {
     console.log(`💡 Report will be generated automatically after execution completes`);
 
     return {
+        // Common hooks - enable DB status updates (execution + script status)
+        ...commonHooks,
+
         services: [
             'appium',
             // Real-time screenshot capture (works even if execution stopped mid-way)

package/froth_configs/local/web.config.js

@@ -1,3 +1,5 @@
+const commonHooks = require('../commonhook');
+
 module.exports = (bsCaps) => {
     const browserName = (bsCaps.browserName || 'chrome').toLowerCase();
 
@@ -108,6 +110,9 @@ module.exports = (bsCaps) => {
     }
 
     const config = {
+        // Common hooks - enable DB status updates (execution + script status)
+        ...commonHooks,
+
         // Use direct WebDriver connection without Selenium Grid/Hub
         // Opens Chrome/Firefox directly - no selenium-server
         protocol: 'webdriver',

package/froth_configs/screenshot-service.js

@@ -4,17 +4,15 @@
  * - After each KEY ACTION (click, input, navigation) - no duplicates
  * - After each TEST (afterTest) - final state per test
  * - Works even if execution is stopped mid-way
+ * - Screenshots stored ONLY in Allure report (via addAttachment) - no separate folders
  * - Deduplicates identical screenshots to avoid clutter
  */
 
-const fs = require('fs');
-const path = require('path');
 const crypto = require('crypto');
 
 class ScreenshotService {
     constructor(options = {}) {
         this.options = options;
-        this.screenshotDir = './allure-screenshots';
         this.actionCounter = 0;
         this.lastScreenshotHash = null;
         this.lastActionTime = 0;
@@ -22,10 +20,7 @@ class ScreenshotService {
 
     // Runs before test execution starts
     async onPrepare() {
-        if (!fs.existsSync(this.screenshotDir)) {
-            fs.mkdirSync(this.screenshotDir, { recursive: true });
-        }
-        console.log('📸 Screenshot Service initialized - deduplicated real-time capture');
+        console.log('📸 Screenshot Service initialized - Allure-only capture (no duplicate folders)');
     }
 
     // Runs after EACH KEY ACTION - captures screenshot (with deduplication)
@@ -57,7 +52,7 @@ class ScreenshotService {
         try {
             const allure = require('@wdio/allure-reporter').default;
 
-            // Take screenshot to memory (buffer) instead of file for dedup check
+            // Take screenshot to memory (buffer) - no separate file
             const screenshotBase64 = await browser.takeScreenshot();
             const imageBuffer = Buffer.from(screenshotBase64, 'base64');
 
@@ -73,12 +68,7 @@ class ScreenshotService {
             this.actionCounter++;
             const actionDesc = this.formatActionDescription(commandName, args);
 
-            // Save unique screenshot to file
-            const screenshotName = `action_${String(this.actionCounter).padStart(3, '0')}_${commandName}`;
-            const screenshotPath = path.join(this.screenshotDir, `${screenshotName}.png`);
-            fs.writeFileSync(screenshotPath, imageBuffer);
-
-            // Attach to Allure IMMEDIATELY (real-time)
+            // Attach to Allure IMMEDIATELY (Allure stores it in its report directory)
             allure.addAttachment(`📸 ${commandName} ${actionDesc}`.trim(), imageBuffer, 'image/png');
         } catch (err) {
             // Silent fail to avoid breaking tests
@@ -95,9 +85,6 @@ class ScreenshotService {
             if (commandName === 'setValue' && args && args[1] !== undefined) {
                 return `(input "${args[1].toString().substring(0, 25)}")`;
             }
-            if (commandName === 'addValue' && args && args[1] !== undefined) {
-                return `(added "${args[1].toString().substring(0, 25)}")`;
-            }
             if (commandName === 'click' && args && args[0]) {
                 return `(${args[0].toString().substring(0, 40)})`;
             }
@@ -115,12 +102,8 @@ class ScreenshotService {
 
         try {
             const allure = require('@wdio/allure-reporter').default;
-            const cleanTitle = test.title.replace(/[^a-zA-Z0-9]/g, '_');
-            const cleanParent = test.parent ? test.parent.replace(/[^a-zA-Z0-9]/g, '_') : 'test';
 
-            const status = passed ? 'success' : 'failure';
-
-            // Take screenshot to buffer
+            // Take screenshot to buffer - no separate file
             const screenshotBase64 = await browser.takeScreenshot();
             const imageBuffer = Buffer.from(screenshotBase64, 'base64');
 
@@ -133,13 +116,9 @@ class ScreenshotService {
                 return;
             }
 
-            const screenshotName = `${cleanParent}_${cleanTitle}_${status}`;
-            const screenshotPath = path.join(this.screenshotDir, `${screenshotName}.png`);
-            fs.writeFileSync(screenshotPath, imageBuffer);
-
             const attachmentName = passed ? '✅ Test Passed' : '❌ Test Failed';
             allure.addAttachment(attachmentName, imageBuffer, 'image/png');
-            console.log(`📸 [Real-time] Test screenshot attached: ${status}`);
+            console.log(`📸 [Real-time] Test screenshot attached: ${passed ? 'success' : 'failure'}`);
 
             // Reset for next test
             this.actionCounter = 0;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "froth-webdriverio-framework",
-    "version": "7.0.119-dev1.10",
+    "version": "7.0.119-dev1.11",
     "readme": "WebdriverIO Integration",
     "description": "WebdriverIO and BrowserStack App Automate",
     "license": "MIT",