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

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

@@ -0,0 +1,197 @@
+const fs = require('fs');
+const path = require('path');
+const { execSync } = require('child_process');
+
+/**
+ * Generate Allure HTML report automatically after test execution
+ * Uses BROWSERSTACK_BUILD_NAME environment variable for report naming
+ */
+
+const REPORTS_DIR = './reports/allure';
+const OUTPUT_DIR = './allure-report';
+
+function findLatestReportDir() {
+    if (!fs.existsSync(REPORTS_DIR)) {
+        console.log('❌ No Allure reports directory found.');
+        console.log('💡 Reports are generated in: ./reports/allure/');
+        return null;
+    }
+
+    const directories = fs.readdirSync(REPORTS_DIR)
+        .map(file => path.join(REPORTS_DIR, file))
+        .filter(file => {
+            const stat = fs.statSync(file);
+            return stat.isDirectory();
+        })
+        .sort((a, b) => {
+            // Sort by modification time, newest first
+            return fs.statSync(b).mtimeMs - fs.statSync(a).mtimeMs;
+        });
+
+    return directories.length > 0 ? directories[0] : null;
+}
+
+function generateAllureReport(reportDir) {
+    try {
+        console.log('🎯 Allure Report Generator');
+        console.log('================================\n');
+        console.log(`📁 Using results from: ${reportDir}`);
+        console.log(`🏷️  Build Name: ${process.env.BROWSERSTACK_BUILD_NAME || 'local-build'}\n`);
+
+        // Get directory name and extract build name (remove timestamp)
+        const dirName = path.basename(reportDir);
+        const timestampIndex = dirName.lastIndexOf('-');
+        const buildName = timestampIndex > 0 ? dirName.substring(0, timestampIndex) : dirName;
+
+        // Generate HTML report folder named after build name
+        const reportFolderName = buildName + '_report';
+        const outputDir = path.join(reportDir, reportFolderName);
+
+        // Clean existing report directory if it exists
+        if (fs.existsSync(outputDir)) {
+            console.log('🧹 Cleaning existing report directory...');
+            fs.rmSync(outputDir, { recursive: true, force: true });
+        }
+
+        // Generate Allure HTML report
+        console.log('📊 Generating Allure HTML report...');
+        console.log(`📂 Report folder: ${reportFolderName}\n`);
+        const historyPath = path.join(reportDir, 'history');
+
+        let command = `npx allure generate ${reportDir} -o ${outputDir} --clean`;
+
+        // Add history if available
+        if (fs.existsSync(historyPath)) {
+            command = `npx allure generate ${reportDir} -o ${outputDir} --clean --history ${historyPath}`;
+        }
+
+        execSync(command, { stdio: 'inherit' });
+
+        // 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: $(pwd)"
+echo "🔗 Open in browser: http://localhost:8080"
+echo ""
+echo "💡 Press Ctrl+C to stop the server"
+echo ""
+
+# 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: %REPORT_DIR%
+echo 🔗 Open in browser: http://localhost:8080
+echo.
+echo 💡 Press Ctrl+C to stop the server
+echo.
+
+cd /d "%PROJECT_ROOT%"
+call npx allure open "%REPORT_DIR%" --port 8080
+pause
+`;
+        fs.writeFileSync(batchScriptPath, batchScriptContent);
+
+        // Create a README
+        const readmePath = path.join(outputDir, 'README.md');
+        const readmeContent = `# Allure Test Report
+
+## 🌐 How to View This Report
+
+### Option 1: Double-click the start script (Easiest)
+- **Mac/Linux:** Double-click \`start-server.sh\`
+- **Windows:** Double-click \`start-server.bat\`
+- Report will open at: http://localhost:8080
+
+### Option 2: Use npm script
+From the project root, run:
+\`\`\`bash
+npm run report:open
+\`\`\`
+
+### Option 3: Manual command
+\`\`\`bash
+npx allure open "${outputDir}" --port 8080
+\`\`\`
+
+## ❗ Why can't I just open index.html?
+
+Allure reports use JavaScript to dynamically load test data from JSON files.
+When you open index.html directly (file:// protocol), browsers block this for security reasons (CORS).
+
+You need a web server to view the report properly - that's what the start scripts do!
+
+## 📊 Test Results
+
+- **Build Name:** ${process.env.BROWSERSTACK_BUILD_NAME || 'local-build'}
+- **Generated:** ${new Date().toISOString()}
+- **Report Location:** ${outputDir}
+`;
+
+        fs.writeFileSync(readmePath, readmeContent);
+
+        console.log('\n✅ Allure report generated successfully!');
+        console.log(`📍 Location: ${path.resolve(outputDir)}`);
+        console.log(`📂 Results directory: ${path.resolve(reportDir)}`);
+        console.log('\n🌐 To view the report:');
+        console.log('   1. Run: npx froth-report open');
+        console.log('   2. Or double-click: start-server.sh (Mac/Linux) / start-server.bat (Windows)');
+        console.log('   3. Report opens at: http://localhost:8080');
+        console.log('\n💡 Press Ctrl+C to stop the server when done viewing.');
+
+        return true;
+    } catch (error) {
+        console.error(`❌ Error generating report: ${error.message}`);
+        return false;
+    }
+}
+
+function main() {
+    const reportDir = findLatestReportDir();
+
+    if (!reportDir) {
+        console.log('❌ No Allure results found. Please run tests first.');
+        console.log('💡 Results are saved in: ./reports/allure/');
+        process.exit(1);
+    }
+
+    generateAllureReport(reportDir);
+}
+
+// Run the script
+if (require.main === module) {
+    main();
+}
+
+module.exports = { generateAllureReport, findLatestReportDir };

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

@@ -0,0 +1,97 @@
+const fs = require('fs');
+const path = require('path');
+const { execSync } = require('child_process');
+
+/**
+ * Find and open the latest Allure HTML report
+ */
+
+const REPORTS_DIR = './reports/allure';
+
+function findLatestReport() {
+    if (!fs.existsSync(REPORTS_DIR)) {
+        console.log('❌ No Allure reports directory found.');
+        console.log('💡 Reports are generated in: ./reports/allure/');
+        return null;
+    }
+
+    const directories = fs.readdirSync(REPORTS_DIR)
+        .map(file => path.join(REPORTS_DIR, file))
+        .filter(file => fs.statSync(file).isDirectory())
+        .filter(file => {
+            // Check if any subdirectory ending with _report exists
+            const subdirs = fs.readdirSync(file)
+                .map(sub => path.join(file, sub))
+                .filter(sub => {
+                    const stat = fs.statSync(sub);
+                    return stat.isDirectory() && path.basename(sub).endsWith('_report');
+                });
+            return subdirs.length > 0;
+        })
+        .sort((a, b) => {
+            return fs.statSync(b).mtimeMs - fs.statSync(a).mtimeMs;
+        });
+
+    return directories.length > 0 ? directories[0] : null;
+}
+
+function openReport(reportDir) {
+    // Find the report folder ending with _report
+    const reportSubdirs = fs.readdirSync(reportDir)
+        .map(sub => path.join(reportDir, sub))
+        .filter(sub => {
+            const stat = fs.statSync(sub);
+            return stat.isDirectory() && path.basename(sub).endsWith('_report');
+        });
+
+    if (reportSubdirs.length === 0) {
+        console.log('❌ No HTML report found in:', reportDir);
+        return false;
+    }
+
+    const htmlReportPath = reportSubdirs[0];
+    const indexPath = path.join(htmlReportPath, 'index.html');
+
+    if (!fs.existsSync(indexPath)) {
+        console.log('❌ No index.html found at:', indexPath);
+        return false;
+    }
+
+    try {
+        console.log('🎯 Opening Allure Report');
+        console.log('========================\n');
+        console.log(`📁 Report location: ${htmlReportPath}`);
+        console.log(`🏷️  Build: ${path.basename(reportDir)}\n`);
+
+        // Use Allure CLI to open the report
+        console.log('🌐 Opening report in browser on http://localhost:8080');
+        console.log('💡 Press Ctrl+C to stop the server\n');
+
+        execSync(`npx allure open ${htmlReportPath} --port 8080`, { stdio: 'inherit' });
+
+        return true;
+    } catch (error) {
+        console.error(`❌ Error opening report: ${error.message}`);
+        console.log(`\n💡 To view manually, open: file://${path.resolve(indexPath)}`);
+        return false;
+    }
+}
+
+function main() {
+    const reportDir = findLatestReport();
+
+    if (!reportDir) {
+        console.log('❌ No Allure HTML reports found. Please run tests first.');
+        console.log('💡 Reports are generated in: ./reports/allure/');
+        process.exit(1);
+    }
+
+    openReport(reportDir);
+}
+
+// Run the script
+if (require.main === module) {
+    main();
+}
+
+module.exports = { findLatestReport, openReport };

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

@@ -11,13 +11,11 @@ module.exports = {
     specs: require(SUITE_FILE).tests,
     exclude: [],
 
-
     logLevel: 'info',
     coloredLogs: true,
     screenshotPath: './errorShots/',
     baseUrl: '',
 
-
     waitforTimeout: 90000,
     connectionRetryTimeout: 90000,
     connectionRetryCount: 3,
@@ -27,5 +25,10 @@ module.exports = {
     mochaOpts: {
         ui: 'bdd',
         timeout: 300000
-    }
-};
+    },
+
+    // Enable screenshot capture for Allure (handled by screenshot-service)
+    // Screenshots stored ONLY in Allure report folder - no separate folders
+};
+
+

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 ----------------- */
@@ -90,6 +94,52 @@ async function pushComment(msg) {
   if (!global.TEST_COMMENTS) global.TEST_COMMENTS = [];
   global.TEST_COMMENTS.push(msg);
 }
+
+/* ----------------- AUTO REPORT GENERATION ----------------- */
+async function generateLocalReport() {
+  try {
+    const buildName = process.env.BROWSERSTACK_BUILD_NAME || 'local-build';
+    const timestamp = new Date().toISOString().replace(/[:.]/g, '-').split('T')[0];
+    const reportDir = `./reports/mochawesome/${buildName}-${timestamp}`;
+    const jsonFile = path.join(process.cwd(), reportDir, 'mochawesome.json');
+
+    // Check if JSON report exists
+    if (!fs.existsSync(jsonFile)) {
+      console.log(`⚠️  No JSON report found at: ${jsonFile}`);
+      console.log('💡 Skipping report generation. Ensure tests ran successfully.');
+      return;
+    }
+
+    console.log(`📊 Generating HTML report from: ${jsonFile}`);
+
+    // Use marge to generate HTML report
+    const { execSync } = require('child_process');
+    execSync(`npx marge "${jsonFile}" -o "${reportDir}"`, {
+      stdio: 'inherit',
+      cwd: process.cwd()
+    });
+
+    const htmlFile = path.join(reportDir, 'mochawesome.html');
+    console.log(`✅ HTML report generated successfully!`);
+    console.log(`📍 Location: ${htmlFile}`);
+
+    // Auto-open report in browser
+    if (fs.existsSync(htmlFile)) {
+      console.log(`🌐 Opening report in browser...`);
+      try {
+        const openCommand = process.platform === 'darwin' ? 'open' :
+                           process.platform === 'win32' ? 'start' :
+                           'xdg-open';
+        execSync(`${openCommand} "${htmlFile}"`, { stdio: 'ignore' });
+      } catch (error) {
+        console.log(`💡 To view report manually, open: ${htmlFile}`);
+      }
+    }
+  } catch (error) {
+    console.error(`❌ Error generating local report: ${error.message}`);
+    // Don't fail the entire process if report generation fails
+  }
+}
 /* ------------------ COMMON CONFIG ------------------ */
 
 const commonHooks = {
@@ -102,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();
@@ -206,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) => {
@@ -237,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";
@@ -245,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"}`);
@@ -285,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'))
@@ -311,7 +381,7 @@ const commonHooks = {
           'completed'
         );
       }
-      
+
     }
 
 
@@ -348,6 +418,13 @@ const commonHooks = {
 
     await safeUpdateExecution();
     BUFFER.clear();
+
+    // Auto-generate HTML report for local execution
+    if (process.env.PLATFORM === 'local') {
+      console.log('📊 Generating local test report...');
+      await generateLocalReport();
+    }
+
     return exitCode;
   },
 

package/froth_configs/local/mobile.config.js

@@ -1,11 +1,64 @@
-module.exports = () => ({
-    services: ['appium'],
+const commonHooks = require('../commonhook');
 
+module.exports = () => {
+    // Generate unique report directory using BROWSERSTACK_BUILD_NAME
+    const buildName = process.env.BROWSERSTACK_BUILD_NAME || 'local-mobile-build';
+    // Remove spaces and special characters from build name for folder name - use underscores
+    const cleanBuildName = buildName.replace(/[^a-zA-Z0-9_]/g, '_');
+    const timestamp = new Date().toISOString().replace(/[:.]/g, '-').split('T')[0]; // YYYY-MM-DD format
+    const uniqueReportDir = `./reports/allure/${cleanBuildName}-${timestamp}`;
 
-    capabilities: [{
-        platformName: 'Android',
-        'appium:deviceName': 'Android Emulator',
-        'appium:automationName': 'UiAutomator2',
-        'appium:app': process.env.LOCAL_APP_PATH
-    }]
-});
+    console.log(`📱 Mobile local execution configured`);
+    console.log(`📊 Allure results will be saved in: ${uniqueReportDir}`);
+    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)
+            [require('../screenshot-service').ScreenshotService]
+        ],
+
+        capabilities: [{
+            platformName: 'Android',
+            'appium:deviceName': 'Android Emulator',
+            'appium:automationName': 'UiAutomator2',
+            'appium:app': process.env.LOCAL_APP_PATH
+        }],
+
+        // Allure Reporter Configuration
+        reporters: [
+            ['allure', {
+                outputDir: uniqueReportDir,
+                disableWebdriverStepsReporting: false,  // Enable step reporting
+                disableWebdriverScreenshotsReporting: false,  // Enable automatic screenshot capture
+                useCucumberStepReporter: false,
+                disableMochaHooks: false,
+                allureCode: true,
+                captureAllureScreenshots: true
+            }]
+        ],
+
+        // Auto-generate report after execution completes
+        onComplete: async function(exitCode, config, capabilities, results) {
+            const { execSync } = require('child_process');
+            const nodePath = require('path');
+            try {
+                // Add a small delay to ensure Allure finishes writing all files
+                await new Promise(resolve => setTimeout(resolve, 1000));
+
+                // Resolve script path relative to framework package (works from any CWD)
+                const scriptPath = nodePath.resolve(__dirname, '../../allure-report-utils/generate-allure-report.js');
+
+                console.log('\n🎯 Generating Allure report...');
+                execSync(`node "${scriptPath}"`, { stdio: 'inherit', cwd: process.cwd() });
+                console.log('✅ Report generation complete!');
+            } catch (error) {
+                console.error('❌ Error generating report:', error.message);
+            }
+        }
+    };
+};