@testomatio/reporter 1.2.0-beta-1 → 1.2.0-beta-3

package/lib/pipe/html.js

@@ -4,8 +4,9 @@ const fs = require('fs');
 const path = require('path');
 const chalk = require('chalk');
 const handlebars = require('handlebars');
+const fileUrl = require('file-url');
 
-const { fileSystem, isSameTest } = require('../utils/utils');
+const { fileSystem, isSameTest, ansiRegExp } = require('../utils/utils');
 const { HTML_REPORT } = require('../constants');
 
 class HtmlPipe {
@@ -23,6 +24,7 @@ class HtmlPipe {
 
         this.isEnabled = false;
         this.htmlOutputPath = "";
+        this.fullHtmlOutputPath = "";
         this.tests = [];
         this.data = {};
 
@@ -35,9 +37,6 @@ class HtmlPipe {
             }
 
             if (process.env.TESTOMATIO_HTML_FILENAME && !process.env.TESTOMATIO_HTML_FILENAME.endsWith(".html")) {
-                console.log(
-                    chalk.blue(`The name must include the extension ".html". The default report name is used!`)
-                );
                 this.htmlReportName = HTML_REPORT.REPORT_DEFAULT_NAME;
             }
 
@@ -74,6 +73,8 @@ class HtmlPipe {
     addTest(test) {
         if (!this.isEnabled) return;
 
+        if (!test.steps || !test.status) return;
+
         const index = this.tests.findIndex(t => isSameTest(t, test));
         // update if they were already added
         if (index >= 0) {
@@ -88,6 +89,37 @@ class HtmlPipe {
         if (!this.isEnabled) return;
 
         if (this.isHtml) {
+
+            this.tests.forEach(test => {
+
+                if (!test.message || test.message.trim() === "") {
+                    test.message = "This test has no 'message' code";
+                }
+    
+                if (!test.suite_title || test.suite_title.trim() === "") {
+                    test.suite_title = "Unknown suite";
+                }
+
+                if (!test.title || test.title.trim() === "") {
+                    test.title = "Unknown test title";
+                }
+
+                if (!test.files || test.files.length === 0) {
+                    test.files = "This test has no files";
+                }
+
+                if (test.steps) {
+                    if (!test.steps || test.steps.trim() === "") {
+                        test.steps = "This test has no 'steps' code";
+                    }
+                    else {
+                        test.steps = this.#removeAnsiColorCodes(test.steps);
+                    }
+                }
+                
+                // TODO: u can added an additional test values to this checks in the future
+            });
+
             this.data = {
                 runId: this.store.runId,
                 status: runParams.status,
@@ -107,20 +139,41 @@ class HtmlPipe {
         debug('HTML tests data:', data);
 
         if (!this.htmlOutputPath && this.htmlOutputPath !== "") {
-            console.log(chalk.yellow(`HTML export path is not set, ignoring...`));
+            console.log(chalk.yellow(`🚨 HTML export path is not set, ignoring...`));
             return;
         }
 
-        console.log(chalk.yellow(`The test results will be added to the HTML report. It will take some time...`));
+        console.log(chalk.yellow(`⏳ The test results will be added to the HTML report. It will take some time...`));
         // generate output HTML based on the template
         const html = this.#generateHTMLReport(data);
 
+        if (process.env.TESTOMATIO_HTML_FILENAME && !process.env.TESTOMATIO_HTML_FILENAME.endsWith(".html")) {
+            console.log(
+                chalk.blue("HTML filename must include the extension \".html\"." +
+                           ` The default report name "${this.htmlOutputPath}" is used!`)
+            );
+        }
+
         fs.writeFileSync(this.htmlOutputPath, html, 'utf-8');
+
+        // Check if the file exists
+        if (fs.existsSync(this.htmlOutputPath)) {
+            // Get the absolute path of the file
+            const absolutePath = path.resolve(this.htmlOutputPath);
+            // Convert the file path to a file URL
+            const fileUrlPath = fileUrl(absolutePath, {resolve: true});
+
+            debug('HTML tests data:', fileUrlPath);
+
+            console.log(chalk.green(`📊 The HTML report was successfully generated. Full filepath: ${fileUrlPath}`));
+        } else {
+            console.log(chalk.red(`🚨 Failed to generate the HTML report.`));
+        }
     }
 
     #generateHTMLReport(data) {
         if (!this.templateHtmlPath) {
-            console.log(chalk.red(`HTML template not found. Report generation is impossible!`))
+            console.log(chalk.red(`🚨 HTML template not found. Report generation is impossible!`))
             return;
         }
 
@@ -129,7 +182,6 @@ class HtmlPipe {
         try {
             const template = handlebars.compile(templateSource);
 
-            console.log(chalk.green(`Generated HTML report saved in file: ${this.htmlOutputPath}`));
             return template(data);
         }
         catch (e) {
@@ -142,7 +194,49 @@ class HtmlPipe {
             tests.filter(test => test.status.toLowerCase() === status.toLowerCase()).length
         );
 
-        handlebars.registerHelper('json', (obj) => JSON.stringify(obj));
+        handlebars.registerHelper('json', (tests) => {
+            function replaceScriptTagsInArray(array) {
+                return array.map(obj => {
+                    const keysToCheck = ["steps", "stack", "title", "suite_title", "message", "code"];
+                    const newObj = {};
+            
+                    for (const key in obj) {
+                        if (Object.prototype.hasOwnProperty.call(obj, key)) {
+                            if (key === "example") {
+                                newObj[key] = {};
+                                for (const subKey in obj[key]) {
+                                    if (Object.prototype.hasOwnProperty.call(obj[key], subKey)) {
+                                        newObj[key][subKey] = typeof obj[key][subKey] === "string"
+                                            ? obj[key][subKey]
+                                                .replace(/<script>/g, "<$cript>")
+                                                .replace(/<\/script>/g, "</$cript>")
+                                            : obj[key][subKey];
+                                    }
+                                }
+                            } else if (keysToCheck.includes(key)) {
+                                newObj[key] = typeof obj[key] === "string"
+                                    ? obj[key].replace(/<script>/g, "<$cript>").replace(/<\/script>/g, "</$cript>")
+                                    : obj[key];
+                            } else {
+                                newObj[key] = obj[key];
+                            }
+                        }
+                    }
+            
+                    return newObj;
+                });
+            }
+
+            // Remove ANSI escape codes
+            return JSON.stringify(replaceScriptTagsInArray(tests));
+        });
+    }
+
+    #removeAnsiColorCodes(str) {
+        let updatedStr = str.replace(ansiRegExp(), "");        
+        updatedStr = updatedStr.replace(/\n/g, '<br>');
+
+        return updatedStr;
     }
 
     toString() {

package/lib/template/testomatio.hbs

@@ -245,6 +245,29 @@
             font-size: 14px;
             white-space: pre-line;
         }
+        /* Passed TAB*/
+        #passedTest:not(:checked) + .btn-outline-dark {
+            background-color: #39BD2F;
+        }
+        #passedTest:checked + .btn-outline-dark {
+            background-color: #68cf61;
+            color: white;
+        }
+        /* Failed TAB*/
+        #failedTest:not(:checked) + .btn-outline-dark {
+            background-color: #F2230C;
+        }
+        #failedTest:checked + .btn-outline-dark {
+            background-color: #FA6E5E;
+            color: white;
+        }
+        /* Skipped TAB*/
+        #skippedTest:not(:checked) + .btn-outline-dark {
+            background-color: #F2C00C;
+        }
+        #skippedTest:checked + .btn-outline-dark {
+            background-color: #dfc155;
+        }
     </style>
 </head>
 
@@ -471,8 +494,8 @@
         }        
 
         // processing and adding test data to the template
-        function addOneTest(category,testInfo = {}){
-            const { suite, title, steps, message, files } = testInfo;
+        function addOneTest(category,testData = {}){
+            const { suite_title, title, steps, message, files } = testData;
             // radio btn test's count
             function incrementCount(element) {
                 let count = parseInt(element.textContent);
@@ -562,7 +585,7 @@
 
             const testitem__name = clone.querySelector('.testitem__name');
 
-            const fullTestName = suite ? suite + " - " + title : title;
+            const fullTestName = suite_title ? suite_title + " - " + title : title;
             testitem__name.textContent = fullTestName;
 
             const body = clone.querySelector('.testitem__body');
@@ -579,11 +602,16 @@
 
             let content_files = content.querySelector('div[type="files"]').querySelector('span');
 
-            if (files && files.length > 0) {
+            if (files.includes("This test has no files")) {
+                content_files.innerHTML = files;
+            }
+
+            if (!files.includes("This test has no files")) {
                 const filesList = document.createElement('ul');
                 content_files.innerHTML = "";
 
-                files.forEach((file) => {
+                if (Array.isArray(files) && files.length > 0) {
+                    files.forEach((file) => {
                     const listItem = document.createElement('li');
                     const fileLink = document.createElement('a');
                     fileLink.href = file.path;
@@ -594,10 +622,9 @@
                     filesList.appendChild(listItem);
                 });
 
-                content_files.appendChild(filesList);                
-            }
-            else {
-                content_files.innerHTML = "Files are not found for this test";
+                content_files.appendChild(filesList);
+
+                }                
             }
 
             const testitem__top = clone.querySelector('.testitem__top');
@@ -680,40 +707,11 @@
         search();        
 
         const executedTests = {{{ json tests }}};
-
-        // TODO: move to HTML pipe
-        function removeAnsiColorCodes(text) {
-            text = text.replace(/\u001b\[[0-9;]*m/g, '');
-            text = text.replace(/\n/g, '<br>');
-            
-            return text;
-        }
         
         for (let i = 0; i < executedTests.length; i++) {
             const status = executedTests[i].status;
-            const testInfo = {
-                suite: executedTests[i].suite_title,
-                title: executedTests[i].title,
-                steps: removeAnsiColorCodes(executedTests[i].steps),
-                message: executedTests[i].message,
-                files: executedTests[i].files,
-                status: status,
-            }
-
-            if (!testInfo.steps && testInfo.steps.trim() === "") {
-                testInfo.steps = "Step code is not found for this test";
-            }
-
-            if (!testInfo.message && testInfo.message.trim() === "") {
-                testInfo.message = "Message code is not found for this test";
-            }
-
-            if (!testInfo.suite && testInfo.suite.trim() === "") {
-                testInfo.suite = "Unknown suite";
-            }
 
-            // call the addOneTest() function for each test
-            addOneTest(status, testInfo);
+            addOneTest(status, executedTests[i]);
         }
     </script>
 </body>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "1.2.0-beta-1",
+  "version": "1.2.0-beta-3",
   "description": "Testomatio Reporter Client",
   "main": "./lib/reporter.js",
   "typings": "typings/index.d.ts",
@@ -20,6 +20,7 @@
     "debug": "^4.3.4",
     "dotenv": "^16.0.1",
     "fast-xml-parser": "^4.0.8",
+    "file-url": "3.0.0",
     "glob": "^10.3",
     "handlebars": "^4.7.8",
     "has-flag": "^5.0.1",