@testomatio/reporter 1.1.0-beta-2 → 1.1.0-beta.artifact-count-retry-msg-1

package/lib/pipe/html.js

@@ -0,0 +1,316 @@
+const debug = require('debug')('@testomatio/reporter:pipe:html');
+const merge = require('lodash.merge');
+const fs = require('fs');
+const path = require('path');
+const chalk = require('chalk');
+const handlebars = require('handlebars');
+const fileUrl = require('file-url');
+
+const { fileSystem, isSameTest, ansiRegExp } = require('../utils/utils');
+const { HTML_REPORT } = require('../constants');
+
+class HtmlPipe {
+    constructor(params, store = {}) {
+        this.store = store || {};
+        this.title = params.title || process.env.TESTOMATIO_TITLE;
+        this.apiKey = params.apiKey || process.env.TESTOMATIO;
+        this.isHtml = process.env.TESTOMATIO_HTML_REPORT_SAVE;
+
+        debug('HTML Pipe: ', this.apiKey ? 'API KEY' : '*no api key provided*');
+
+        this.isEnabled = false;
+        this.htmlOutputPath = "";
+        this.fullHtmlOutputPath = "";
+        this.filenameMsg = "";
+        this.tests = [];
+
+        if (this.isHtml) {
+            this.isEnabled = true;
+            this.htmlReportDir = process.env.TESTOMATIO_HTML_REPORT_FOLDER || HTML_REPORT.FOLDER;
+
+            if (process.env.TESTOMATIO_HTML_FILENAME && process.env.TESTOMATIO_HTML_FILENAME.endsWith(".html")) {
+                this.htmlReportName = process.env.TESTOMATIO_HTML_FILENAME
+            }
+
+            if (process.env.TESTOMATIO_HTML_FILENAME && !process.env.TESTOMATIO_HTML_FILENAME.endsWith(".html")) {
+                this.htmlReportName = HTML_REPORT.REPORT_DEFAULT_NAME;
+                this.filenameMsg = "HTML filename must include the extension \".html\"." +
+                    ` The default report name "${this.htmlReportDir}/${HTML_REPORT.REPORT_DEFAULT_NAME}" is used!`;
+            }
+
+            if (!process.env.TESTOMATIO_HTML_FILENAME) {
+                this.htmlReportName = HTML_REPORT.REPORT_DEFAULT_NAME;
+            }
+
+            this.templateFolderPath = path.resolve(__dirname, '..', 'template');
+            this.templateHtmlPath = path.resolve(this.templateFolderPath, HTML_REPORT.TEMPLATE_NAME);
+            this.htmlOutputPath = path.join(this.htmlReportDir, this.htmlReportName);
+            // create a new folder for the HTML reports
+            fileSystem.createDir(this.htmlReportDir);
+
+            debug(
+                chalk.yellow('HTML Pipe:'),
+                `Save HTML report: ${this.isEnabled}`,
+                `HTML report folder: ${this.htmlReportDir}, report name: ${this.htmlReportName}`
+            );
+        }
+    }
+
+    async createRun() {
+        // empty
+    }
+
+    updateRun() {
+        // empty
+    }
+
+    /**
+     * Add test data to the result array for saving. As a result of this function, we get a result object to save.
+     * @param {Object} test - object which includes each test entry.
+     */
+    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) {
+            this.tests[index] = merge(this.tests[index], test);
+            return;
+        }
+
+        this.tests.push(test);
+    }
+
+    async finishRun(runParams) {
+        if (!this.isEnabled) return;
+
+        if (this.isHtml) {
+            // GENERATE HTML reports based on the results data
+            this.buildReport({
+                runParams,
+                tests: this.tests, 
+                outputPath: this.htmlOutputPath, 
+                templatePath: this.templateHtmlPath, 
+                warningMsg: this.filenameMsg
+            });
+        }
+    }
+    /**
+     * Generates an HTML report based on provided test data and a template.
+     * @param {object} opts - Test options used to generate the HTML report: 
+     * runParams, tests, outputPath, templatePath
+     * @returns {void} - This function does not return anything.
+     */
+
+    buildReport(opts) {
+        const { runParams, tests, outputPath, templatePath, warningMsg: msg } = opts;
+        
+        debug('HTML tests data:', tests);
+
+        if (!outputPath) {
+            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...`));
+
+        if (msg) {
+            console.log(chalk.blue(msg));
+        }
+
+        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 = removeAnsiColorCodes(test.steps);
+                }
+            }
+            
+            // TODO: u can added an additional test values to this checks in the future
+        });
+
+        const data = {
+            runId: this.store.runId || "",
+            status: runParams.status || "No status info",
+            parallel: runParams.isParallel || "No parallel info",
+            runUrl: this.store.runUrl || "",
+            executionTime: testExecutionSumTime(tests),
+            executionDate: getCurrentDateTimeFormatted(),
+            tests
+        };
+        // generate output HTML based on the template
+        const html = this.#generateHTMLReport(data, templatePath);
+
+        if (!html) return;
+
+        fs.writeFileSync(outputPath, html, 'utf-8');
+        // Check if the file exists
+        if (fs.existsSync(outputPath)) {
+            // Get the absolute path of the file
+            const absolutePath = path.resolve(outputPath);
+            // 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.`));
+        }
+    }
+
+    /**
+     * Generates an HTML report based on provided test data and a template path.
+     * @param {any} data - Test data used to generate the HTML report.
+     * @param {string} [templatePath=""] - The path to the HTML template used for generating the report.
+     * @returns {string | void} - The generated HTML report as a string or void if templatePath is not provided.
+     */
+    #generateHTMLReport(data, templatePath = "") {
+        if (!templatePath) {
+            console.log(chalk.red(`🚨 HTML template not found. Report generation is impossible!`))
+            return;
+        }
+
+        const templateSource = fs.readFileSync(templatePath, 'utf8');
+        this.#loadReportHelpers();
+        try {
+            const template = handlebars.compile(templateSource);
+
+            return template(data);
+        }
+        catch (e) {
+            console.log('Unknown HTML report generation error: ', e);
+        }
+    }
+
+    #loadReportHelpers() {
+        handlebars.registerHelper('getTestsByStatus', (tests, status) => 
+            tests.filter(test => test.status.toLowerCase() === status.toLowerCase()).length
+        );
+
+        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));
+        });
+    }
+
+    toString() {
+        return 'HTML Reporter';
+    }
+}
+
+/**
+ * Calculates the total execution time for an array of tests.
+ * @param {Object[]} tests - An array of test objects.
+ * @param {number} tests[].run_time - The execution time of each test in milliseconds.
+ * @returns {string} - The total execution time in a formatted duration string.
+ */
+function testExecutionSumTime(tests) {
+    const totalMilliseconds = tests.reduce((sum, test) => {
+        if (typeof test.run_time === 'number') {
+            return sum + test.run_time;
+        }
+        return sum;
+    }, 0);
+
+    return formatDuration(totalMilliseconds);
+}
+
+/**
+ * Removes ANSI color codes and converts newline characters to HTML line breaks in a given string.
+ * @param {string} str - The input string containing ANSI color codes.
+ * @returns {string} - The updated string with removed ANSI color codes and replaced newline characters.
+ */
+function removeAnsiColorCodes(str) {
+    let updatedStr = str.replace(ansiRegExp(), "");        
+    updatedStr = updatedStr.replace(/\n/g, '<br>');
+
+    return updatedStr;
+}
+
+/**
+ * Formats duration in milliseconds into a human-readable string representation.
+ * @param {number} duration - The duration in milliseconds.
+ * @returns {string} - The formatted duration string (e.g., "2h 30m 15s 500ms").
+ */
+function formatDuration(duration) {
+    const milliseconds = duration % 1000;
+    duration = (duration - milliseconds) / 1000;
+    const seconds = duration % 60;
+    duration = (duration - seconds) / 60;
+    const minutes = duration % 60;
+    const hours = (duration - minutes) / 60;
+
+    return `${hours}h ${minutes}m ${seconds}s ${milliseconds}ms`;
+}
+
+/**
+ * Retrieves the current date and time in a formatted string.
+ * @returns {string} - The formatted date and time string (e.g., "(01/01/2023 12:00:00)").
+ */
+function getCurrentDateTimeFormatted() {
+    const currentDate = new Date();
+    const day = currentDate.getDate().toString().padStart(2, '0');
+    const month = (currentDate.getMonth() + 1).toString().padStart(2, '0');
+    const year = currentDate.getFullYear();
+    const hours = currentDate.getHours().toString().padStart(2, '0');
+    const minutes = currentDate.getMinutes().toString().padStart(2, '0');
+    const seconds = currentDate.getSeconds().toString().padStart(2, '0');
+
+    return `(${day}/${month}/${year} ${hours}:${minutes}:${seconds})`;
+}
+
+module.exports = HtmlPipe;

package/lib/pipe/index.js

@@ -6,6 +6,7 @@ const TestomatioPipe = require('./testomatio');
 const GitHubPipe = require('./github');
 const GitLabPipe = require('./gitlab');
 const CsvPipe = require('./csv');
+const HtmlPipe = require('./html');
 
 function PipeFactory(params, opts) {
   const extraPipes = [];
@@ -43,6 +44,7 @@ function PipeFactory(params, opts) {
     new GitHubPipe(params, opts),
     new GitLabPipe(params, opts),
     new CsvPipe(params, opts),
+    new HtmlPipe(params, opts),
     ...extraPipes,
   ];
 

package/lib/pipe/testomatio.js

@@ -2,13 +2,14 @@ const debug = require('debug')('@testomatio/reporter:pipe:testomatio');
 const chalk = require('chalk');
 const axios = require('axios');
 const JsonCycle = require('json-cycle');
+const promiseRetry = require('promise-retry');
+
 const { APP_PREFIX, STATUS } = require('../constants');
 const { isValidUrl, foundedTestLog } = require('../utils/utils');
-const { parseFilterParams, generateFilterRequestParams, setS3Credentials, } = require('../utils/pipe_utils');
+const { parseFilterParams, generateFilterRequestParams, setS3Credentials } = require('../utils/pipe_utils');
 
-const { TESTOMATIO_RUN } = process.env;
-if (TESTOMATIO_RUN) {
-  process.env.runId = TESTOMATIO_RUN;
+if (process.env.TESTOMATIO_RUN) {
+  process.env.runId = process.env.TESTOMATIO_RUN;
 }
 
 /**
@@ -33,6 +34,7 @@ class TestomatioPipe {
     this.sharedRun = !!process.env.TESTOMATIO_SHARED_RUN;
     this.groupTitle = params.groupTitle || process.env.TESTOMATIO_RUNGROUP_TITLE;
     this.env = process.env.TESTOMATIO_ENV;
+    this.label = process.env.TESTOMATIO_LABEL;
 
     this.axios = axios.create({
       baseURL: `${this.url.trim()}`,
@@ -76,8 +78,14 @@ class TestomatioPipe {
         return;
       }
 
-      const resp = await this.axios.get('/api/test_grep', q);
-      const { data } = resp;
+      const response = await sendRequest(
+        this.axios,
+        "get",
+        '/api/test_grep',
+        q
+      );
+
+      const { data } = response;
 
       if (Array.isArray(data?.tests) && data?.tests?.length > 0) {
         foundedTestLog(APP_PREFIX, data.tests);
@@ -131,6 +139,7 @@ class TestomatioPipe {
         jira_id: this.jiraId,
         env: this.env,
         title: this.title,
+        label: this.label,
         shared_run: this.sharedRun,
       }).filter(([, value]) => !!value),
     );
@@ -138,25 +147,43 @@ class TestomatioPipe {
 
     if (this.runId) {
       debug(`Run with id ${this.runId} already created, updating...`);
-      const resp = await this.axios.put(`/api/reporter/${this.runId}`, runParams);
-      if (resp.data.artifacts) setS3Credentials(resp.data.artifacts);
+
+      const response = await sendRequest(
+        this.axios,
+        "put",
+        `/api/reporter/${this.runId}`,
+        runParams
+      );
+
+      if (response.data.artifacts) setS3Credentials(response.data.artifacts);
       return;
     }
 
     try {
-      const resp = await this.axios.post(`/api/reporter`, runParams, {
-        maxContentLength: Infinity,
-        maxBodyLength: Infinity,
-      });
-      this.runId = resp.data.uid;
-      this.runUrl = `${this.url}/${resp.data.url.split('/').splice(3).join('/')}`;
-      this.runPublicUrl = resp.data.public_url;
-      if (resp.data.artifacts) setS3Credentials(resp.data.artifacts);
+      const response = await sendRequest(
+        this.axios,
+        "post",
+        `/api/reporter`,
+        runParams,
+        {
+          maxContentLength: Infinity,
+          maxBodyLength: Infinity
+        }
+      )
+
+
+      this.runId = response.data.uid;
+      this.runUrl = `${this.url}/${response.data.url.split('/').splice(3).join('/')}`;
+      this.runPublicUrl = response.data.public_url;
+
+      if (response.data.artifacts) setS3Credentials(response.data.artifacts);
+
       this.store.runUrl = this.runUrl;
       this.store.runPublicUrl = this.runPublicUrl;
       this.store.runId = this.runId;
       console.log(APP_PREFIX, '📊 Report created. Report ID:', this.runId);
       process.env.runId = this.runId;
+
       debug('Run created', this.runId);
     } catch (err) {
       console.error(
@@ -181,14 +208,20 @@ class TestomatioPipe {
     data.create = this.createNewTests;
     const json = JsonCycle.stringify(data);
 
-    return this.axios.post(`/api/reporter/${this.runId}/testrun`, json, {
-      maxContentLength: Infinity,
-      maxBodyLength: Infinity,
-      headers: {
-        // Overwrite Axios's automatically set Content-Type
-        'Content-Type': 'application/json',
-      },
-    })
+    return sendRequest(
+      this.axios,
+      "post",
+      `/api/reporter/${this.runId}/testrun`,
+      json,
+      {
+        maxContentLength: Infinity,
+        maxBodyLength: Infinity,
+        headers: {
+          // Overwrite Axios's automatically set Content-Type
+          'Content-Type': 'application/json',
+        }
+      }
+    )
     .catch(err => {
       if (err.response) {
         if (err.response.status >= 400) {
@@ -233,11 +266,17 @@ class TestomatioPipe {
 
     try {
       if (this.runId && !this.proceed) {
-        await this.axios.put(`/api/reporter/${this.runId}`, {
-          api_key: this.apiKey,
-          status_event,
-          tests: params.tests,
-        });
+        await sendRequest(
+          this.axios,
+          "put",
+          `/api/reporter/${this.runId}`,
+          {
+            api_key: this.apiKey,
+            status_event,
+            tests: params.tests,
+          }
+        )
+
         if (this.runUrl) {
           console.log(APP_PREFIX, '📊 Report Saved. Report URL:', chalk.magenta(this.runUrl));
         }
@@ -286,4 +325,59 @@ class TestomatioPipe {
   }
 }
 
+async function sendRequest(sender, method, url, data = {}, opts = {}, attempts = 5, intervalMs = 1000) {
+  let send;
+  
+  switch(method) {
+    case "post":
+      send = async () => {
+        const resp = await sender.post(url, data, opts);
+    
+        if (resp.status === 200) {
+          return resp;
+        }
+    
+        throw new Error('POST request failed!');
+      };
+      break;
+    case "put":
+      send = async () => {
+        const resp = await sender.put(url, data);
+    
+        if (resp.status === 200) {
+          return resp;
+        }
+    
+        throw new Error('PUT request failed!');
+      };
+      break;
+    default:
+      send = async () => {
+        const resp = await sender.get(url, data);
+    
+        if (resp.status === 200) {
+          return resp;
+        }
+    
+        throw new Error('GET request failed!');
+      };
+  }
+
+  try {
+    const response = await promiseRetry(
+      {
+        retries: attempts,
+        minTimeout: intervalMs,
+      },
+      send
+    );
+
+    return response;
+  } 
+  catch (error) {
+    console.error('Request failed or timed out:', error.message);
+    throw error;
+  }
+};
+
 module.exports = TestomatioPipe;

package/lib/storages/key-value-storage.js

@@ -28,7 +28,7 @@ class KeyValueStorage {
   /**
    * Returns key-values pairs for the test as object
    * @param {*} context testId or test context from test runner
-   * @returns {Object} key-values pairs as object
+   * @returns {Object} key-values pairs as object, e.g. {priority: 'high', browser: 'chrome'}
    */
   get(context) {
     if (!context) return null;

package/lib/storages/logger.js

@@ -187,12 +187,12 @@ class Logger {
     /* prevent multiple console interceptions (cause of infinite loop)
     actual only for "console", because its used as default output and is intercepted by default */
     const isUserLoggerConsole = userLogger.toString?.().toLowerCase() === '[object console]';
-    if (isUserLoggerConsole && process.env.TESTOMATIO_LOGGER_CONSOLE_INTERCEPTED) {
+    if (isUserLoggerConsole && global.TESTOMATIO_LOGGER_CONSOLE_INTERCEPTED) {
       debug(`Try to intercept console, but it is already intercepted`);
       return;
     }
 
-    process.env.TESTOMATIO_LOGGER_CONSOLE_INTERCEPTED = 'true';
+    global.TESTOMATIO_LOGGER_CONSOLE_INTERCEPTED = true;
     debug(isUserLoggerConsole ? 'console intercepted' : 'User logger intercepted');
 
     // override user logger (any, e.g. console) methods to intercept log messages