froth-webdriverio-framework 5.0.8 → 5.0.10

package/froth_api_calls/browsersatckSessionInfo.js

@@ -108,7 +108,7 @@ async function amend2Browserstack(annotationMessage, level) {
         console.log("Annotation message inside amend2Browserstack:" + annotationMessage)
         if (process.env.PLATFORM === 'browserstack')
             await driver.execute('browserstack_executor: {"action": "annotate", "arguments": {"data":"' + annotationMessage + '","level": "' + level + '"}}');
-
+            
     } catch (error) {
         console.error('Error occurred while annoting to BS :', error);
         throw error;

package/froth_api_calls/getexecutionDetails.js

@@ -34,7 +34,7 @@ async function getExecuitonDetails(frothUrl, token, id) {
 
                 return jsondata;
             } else if (response.status === 401) { // Unauthorized, token expired
-                
+
                 console.error("Unauthorized, token expired" + response.status);
 
             } else {
@@ -107,7 +107,10 @@ async function update_CICDRUNID_ReportUrl(frothUrl, token, id) {
 
         // formData.append('id', BUFFER.getItem("FROTH_EXECUTION_ID"))
         formData.append('updated_through_bot', true)
-        formData.append('run_id', process.env.CICD_RUN_ID)
+        if (process.env.CICD_RUN_ID === null)
+            console.log("CICD_RUN_ID is null")
+        else
+            formData.append('run_id', process.env.CICD_RUN_ID)
 
 
         if (BUFFER.getItem("REPORT_URL") === null)

package/froth_common_actions/logData.js

@@ -1,5 +1,6 @@
 const amendToBrowserstack = require("../froth_api_calls/browsersatckSessionInfo").amend2Browserstack;
 
+
 async function logJsonData2Table(jsonData) {
     try {
         console.log("Logging JSON data to table format in BrowserStack:");
@@ -56,19 +57,15 @@ module.exports = {
 // 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 }
-//         ];
+//         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");
+//         // 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);
 //     }

package/froth_configs/commonconfig.js

@@ -5,9 +5,12 @@ const { LocalStorage } = require('node-localstorage');
 global.BUFFER = new LocalStorage('./storage');
 const setAllDetails = require("./setallDatailinBuffer")
 const exeDetails = require("../froth_api_calls/getexecutionDetails")
-const getBSSessionDetails = require("../froth_api_calls/browsersatckSessionInfo").getBSSessionDetails;
+//const getBSSessionDetails = require("../froth_api_calls/browsersatckSessionInfo").getBSSessionDetails;
 const { fail } = require("assert");
 const { error } = require('console');
+const HTMLReportGenerator = require('wdio-json-html-reporter').HTMLReportGenerator;
+let Util;
+
 //const isBrowserStackEnabled = process.env.BROWSERSTACK;
 let starttime;
 let endtime;
@@ -31,7 +34,6 @@ const commonconfig = {
             await setAllDetails.setSuiteDetails();
             await setAllDetails.setTestDataDetails();
             console.log("on prepare:", JSON.stringify(capabilities))
-
             //  console.log("ALL JSON DATA in env variable :" + JSON.stringify(process.env));
         } catch (e) {
             console.log("====> Error in onPrepare:", e);
@@ -135,7 +137,13 @@ const commonconfig = {
 
             if (process.env.PLATFORM === 'browserstack')
                 await getBSSessionDetails(process.env.BS_SESSION_TYPE, process.env.BROWSERSTACK_USERNAME, process.env.BROWSERSTACK_ACCESS_KEY);
+            else {
+                console.log("Local execution - no BrowserStack session details to fetch.");
+                // BUFFER.setItem("SESSION_ID", "local-session");
+                BUFFER.setItem("REPORT_URL", `./reports/${process.env.EXECUTION_ID}/test-report.html`);
+                //BUFFER.setItem("FROTH_TOTAL_DURATION", 0);
 
+            }
 
             // const resultdetails = {};
             await exeDetails.update_CICDRUNID_ReportUrl(BUFFER.getItem("ORGANISATION_DOMAIN_URL"), BUFFER.getItem("FROTH_LOGIN_TOKEN"), BUFFER.getItem("FROTH_EXECUTION_ID"))
@@ -155,6 +163,36 @@ const commonconfig = {
             console.log('==== BEFORE HOOK FOR MOBILE ====');
         }
 
+        console.log("🔧 Initializing environment setup...");
+
+        // Define all possible locations of Utils.js
+        const possiblePaths = [
+            // 🟢 Cloud setup — npm installed inside project
+            path.resolve(process.cwd(), 'node_modules/froth-webdriverio-framework/froth_common_actions/Utils'),
+
+            // 🟢 Local setup — dependency folder outside project
+            path.resolve(process.cwd(), '../DEPENDENCY/node_modules/froth-webdriverio-framework/froth_common_actions/Utils'),
+
+            // 🟢 Another possible relative structure (if nested differently)
+            path.resolve(process.cwd(), '../../DEPENDENCY/node_modules/froth-webdriverio-framework/froth_common_actions/Utils'),
+        ];
+
+        // Try to locate and load the Utils module
+        for (const filePath of possiblePaths) {
+            if (fs.existsSync(filePath + '.js')) {
+                Util = require(filePath);
+                global.Util = Util;
+                console.log(`✅ Utils loaded successfully from: ${filePath}`);
+                break;
+            }
+        }
+
+        if (!global.Util) {
+            console.error('❌ Could not find froth_common_actions/Utils in expected paths:');
+            possiblePaths.forEach(p => console.error('   - ' + p));
+            throw new Error('Failed to load Utils. Check dependency installation path.');
+        }
+
     },
 
     /**
@@ -339,7 +377,48 @@ const commonconfig = {
         console.log('Exit Code:', exitCode);
 
         console.log('==== ALL TESTS ARE COMPLETED ====');
-        return exitCode;
+
+        const outputFilePath = `./reports/${process.env.EXECUTION_ID}/test-report.html`;
+        const jsonFolder = `./reports/${process.env.EXECUTION_ID}/`; // Directory where JSON reports are saved
+        // Find latest JSON file (if multiple exist)
+        // const jsonFiles = fs
+        //     .readdirSync(jsonFolder)
+        //     .filter(file => file.endsWith('.json'))
+        //     .map(file => ({
+        //         name: file,
+        //         time: fs.statSync(path.join(jsonFolder, file)).mtime.getTime(),
+        //     }))
+        //     .sort((a, b) => b.time - a.time);
+
+        // if (jsonFiles.length === 0) {
+        //     console.warn('⚠️ No JSON file found, HTML not generated.');
+        //     return;
+        // }
+
+        // const latestJson = path.join(jsonFolder, jsonFiles[0].name);
+        //console.log(`🧩 Using JSON report: ${latestJson}`);
+
+        // const reportGenerator = new HTMLReportGenerator(outputFilePath, jsonFolder);
+
+        // Call your method (you can rename "generate" to whatever method your class exposes)
+        // reportGenerator.generate({
+        //     jsonFile: latestJson,
+        //     reportPath: jsonFolder,
+        //     reportName: `Execution Report - ${process.env.EXECUTION_ID}`,
+        //     outputFile: outputFilePath,
+        // });
+
+
+        console.log(`✅ HTML report generated: ${outputFilePath}`);
+        // If you want to include historical data, specify the history JSON file path here.
+        const historyFile = `./reports/${process.env.EXECUTION_ID}/history.json`; // Optional
+
+        // Optionally, generate aggregated history data before generating the HTML report.
+        // JSONReporter.generateAggregateHistory({ reportPaths: jsonFolder, historyPath: historyFile });
+
+        const reportGenerator = new HTMLReportGenerator(outputFilePath, historyFile);
+        await reportGenerator.convertJSONFolderToHTML(jsonFolder);
+        // return exitCode;
     }
 
 };

package/froth_configs/wdio.common.conf.js

@@ -4,13 +4,14 @@ const yaml = require('js-yaml');
 const path = require('path');
 const commonconfig = require('./commonconfig');
 console.log('=====wdios common config===== ');
+const { JSONReporter, HTMLReportGenerator } = require('wdio-json-html-reporter');
 
 // Select platform at runtime
 const PLATFORM = process.env.PLATFORM || 'browserstack';
 console.log('====>PLATFORM:', PLATFORM);
 
 const configFile = process.env.YML_NAME;
-
+const timestamp = new Date().toISOString().replace(/[-:.TZ]/g, '').slice(0, 14); // e.g., 20251014_121532
 const resultdetails = {
     comments: [],
     excution_status: null,        // Pass/Fail
@@ -25,7 +26,7 @@ let capabilities;
 try {
     capabilities = yaml.load(fs.readFileSync(path.join(path.resolve(process.cwd(), configFile)), 'utf8'));
     // Merge chrome-specific options if applicable
-   
+
 } 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);
@@ -92,27 +93,37 @@ function setupPrerequisites() {
         process.env.BS_SESSION_TYPE = capabilities.platformName === 'android' || capabilities.platformName === 'ios' ? 'app-automate' : 'automate';
         capabilities.buildName = process.env.FROTH_TESTOPS_BUILD_NAME;
 
+    } else {
+        console.log("inside this fuction for local setup ");
+        console.log('capabilities.platformName:', capabilities.platformName ?? 'web');
+        capabilities.buildName = process.env.FROTH_TESTOPS_BUILD_NAME;
+
     }
 
 }
 
 const specificConfig = setupPrerequisites();
 
+// Create per-execution report folder
+const reportDir = path.resolve(process.cwd(), `./reports/${process.env.EXECUTION_ID}`);
+if (!fs.existsSync(reportDir)) {
+    fs.mkdirSync(reportDir, { recursive: true });
+}
 
 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']
-            : PLATFORM === 'saucelabs'
-                ? ['sauce']
-                : [],
+        // services: PLATFORM === 'browserstack'
+        //     ? ['browserstack']
+        //     : PLATFORM === 'saucelabs'
+        //         ? ['sauce']
+        //         : [''],
 
-        //runner: 'local',
+        runner: 'local',
         specs: require(SUITE_FILE).tests,
 
         maxInstances: 1,
@@ -128,11 +139,15 @@ exports.config = deepmerge(commonconfig,
         connectionRetryCount: 3,
 
         framework: 'mocha',
-        reporters: ['spec'],
+        reporters: ['spec',
+           [JSONReporter, { outputDir: reportDir,outputFile: `./reports/${process.env.EXECUTION_ID}/test-results-${timestamp}.json`, screenshotOption: 'OnFailure' }],
+        ],
+
         maxInstances: 10,
         updateJob: false,
         mochaOpts: {
             ui: 'bdd',
             timeout: 300000
         }
+
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "froth-webdriverio-framework",
-  "version": "5.0.8",
+  "version": "5.0.10",
   "readme": "WebdriverIO Integration",
   "description": "WebdriverIO and BrowserStack App Automate",
   "license": "MIT",
@@ -25,12 +25,14 @@
     "appium"
   ],
   "dependencies": {
+    "@wdio/allure-reporter": "^9.20.0",
     "@wdio/appium-service": "^9.0.9",
     "@wdio/browserstack-service": "^9.0.9",
     "@wdio/cli": "^9.0.9",
     "@wdio/local-runner": "^9.0.9",
     "@wdio/mocha-framework": "^8.36.1",
     "@wdio/spec-reporter": "^8.36.1",
+    "allure-commandline": "^2.34.1",
     "appium": "^2.15.0",
     "appium-uiautomator2-driver": "^4.0.1",
     "assert": "^2.1.0",
@@ -41,6 +43,7 @@
     "deepmerge": "^4.3.1",
     "express": "^5.1.0",
     "form-data": "^4.0.0",
+    "froth-webdriverio-framework": "^5.0.9",
     "fs": "^0.0.1-security",
     "js-yaml": "^4.1.0",
     "mysql2": "^3.10.2",
@@ -48,6 +51,7 @@
     "node-localstorage": "^3.0.5",
     "randexp": "^0.5.3",
     "ts-node": "^10.9.2",
-    "typescript": "^5.4.5"
+    "typescript": "^5.4.5",
+    "wdio-json-html-reporter": "^1.5.14"
   }
 }