@testomatio/reporter 2.7.6 → 2.7.9-beta.1-markdown

package/src/pipe/testomatio.js

@@ -2,7 +2,13 @@ import createDebugMessages from 'debug';
 import pc from 'picocolors';
 import { Gaxios } from 'gaxios';
 import JsonCycle from 'json-cycle';
-import { APP_PREFIX, STATUS, AXIOS_TIMEOUT, REPORTER_REQUEST_RETRIES } from '../constants.js';
+import {
+  APP_PREFIX,
+  STATUS,
+  REQUEST_TIMEOUT,
+  getCreateRunRequestTimeout,
+  REPORTER_REQUEST_RETRIES,
+} from '../constants.js';
 import {
   isValidUrl,
   foundedTestLog,
@@ -81,7 +87,7 @@ class TestomatioPipe {
     // Create a new instance of gaxios with a custom config
     this.client = new Gaxios({
       baseURL: `${this.url.trim()}`,
-      timeout: AXIOS_TIMEOUT,
+      timeout: REQUEST_TIMEOUT,
       proxy: proxy ? proxy.toString() : undefined,
       retry: true,
       retryConfig: {
@@ -256,6 +262,7 @@ class TestomatioPipe {
         method: 'PUT',
         url: `/api/reporter/${this.runId}`,
         data: runParams,
+        timeout: getCreateRunRequestTimeout(),
         responseType: 'json',
       });
       if (resp.data.artifacts) setS3Credentials(resp.data.artifacts);
@@ -277,6 +284,7 @@ class TestomatioPipe {
         method: 'POST',
         url: '/api/reporter',
         data: runParams,
+        timeout: getCreateRunRequestTimeout(),
         maxContentLength: Infinity,
         responseType: 'json',
       });
@@ -294,14 +302,13 @@ class TestomatioPipe {
       process.env.runId = this.runId;
       debug('Run created', this.runId);
     } catch (err) {
+      if (!this.apiKey) console.error('Testomat.io API key is not set');
       const errorText = err.response?.data?.message || err.message;
       debug('Error creating run', err);
-      console.log(errorText || err);
+      console.log(APP_PREFIX, errorText || err);
       if (err.response?.status === 403) this.#disablePipe();
-      if (!this.apiKey) console.error('Testomat.io API key is not set');
-      if (!this.apiKey?.startsWith('tstmt')) console.error('Testomat.io API key is invalid');
 
-      if (process.env.DEBUG || process.env.TESTOMATIO_DEBUG) this.#logFailedResponse(err);
+      this.#logFailedResponse(err);
 
       console.error(
         APP_PREFIX,
@@ -532,8 +539,8 @@ class TestomatioPipe {
         );
       }
     } catch (err) {
-      log.info('Error updating status, skipping...', err);
-      if (process.env.DEBUG || process.env.TESTOMATIO_DEBUG) this.#logFailedResponse(err);
+      console.log(APP_PREFIX, 'Error updating status, skipping...', err);
+      this.#logFailedResponse(err);
       printCreateIssue();
     }
     debug('Run finished');
@@ -558,19 +565,26 @@ class TestomatioPipe {
     responseBody = hideTestomatioToken(responseBody);
 
     const statusCode = error.status || error.code || error.response?.status || '<unknown status code>';
-    const method = error.response?.config.method || '<unknown method>';
-    const url = error.response?.config.url || '<unknown url>';
+    const method = error.response?.config?.method || '<unknown method>';
+    const url = String(error.response?.config?.url || '<unknown url>');
+
+    let message = pc.yellow('⚠️ Request to Testomat.io failed:\n');
+    message += pc.bold(`${pc.red(statusCode)} ${method} ${pc.gray(url)}\n`);
+
+    if (statusCode === 403) {
+      message += `\t${pc.red('Please check your API token. It might be invalid or expired.')}\n`;
+    }
 
-    let message = pc.yellow('\n⚠️ Request to Testomat.io failed:\n');
-    message += pc.bold(`${pc.red(statusCode)} ${method} ${url}\n`);
     message += `\t${pc.bold('response: ')}${pc.gray(responseBody)}\n`;
 
     const requestBody = hideTestomatioToken(stringify(error.response?.config?.data));
-    if (process.env.DEBUG || process.env.TESTOMATIO_DEBUG) {
+    if (process.env.DEBUG || process.env.TESTOMATIO_DEBUG || requestBody.length < 1000) {
+      // full body
       message += `\t${pc.bold('request: ')}${pc.gray(requestBody)}\n`;
     } else {
+      // cut body
       const requestBodyCut = requestBody.slice(0, 1000);
-      message += `\t${pc.bold('request: ')}${pc.gray(`${requestBodyCut}.....`)}\n`;
+      message += `\t${pc.bold('request: ')}${pc.gray(`${requestBodyCut}...`)}\n`;
       message += '\trequest body is cut, run with TESTOMATIO_DEBUG=1 to see full body\n';
     }
 

package/src/replay.js

@@ -1,8 +1,7 @@
 import fs from 'fs';
 import path from 'path';
-import os from 'os';
 import TestomatClient from './client.js';
-import { STATUS } from './constants.js';
+import { STATUS, DEBUG_FILE } from './constants.js';
 import { config } from './config.js';
 
 export class Replay {
@@ -15,11 +14,12 @@ export class Replay {
   }
 
   /**
-   * Get the default debug file path
+   * Get the default debug file path.
+   * Returns ./testomatio.debug.json (actual file in CI, symlink to tmp file in local).
    * @returns {string} Path to the latest debug file
    */
   getDefaultDebugFile() {
-    return path.join(os.tmpdir(), 'testomatio.debug.latest.json');
+    return path.join(process.cwd(), `${DEBUG_FILE}.json`);
   }
 
   /**
@@ -119,8 +119,11 @@ export class Replay {
             // Handle tests without rid (no deduplication)
             testsWithoutRid.push({ ...test });
           }
-        } else if (logEntry.actions === 'finishRun') {
+        } else if (logEntry.action === 'finishRun') {
           finishParams = logEntry.params || {};
+          if (logEntry.runId && !runId) {
+            runId = logEntry.runId;
+          }
         }
       } catch (err) {
         parseErrors++;
@@ -203,23 +206,28 @@ export class Replay {
       };
     }
 
-    // Create client and restore the run
+    if (runId) {
+      this.onLog(`Using existing run ID: ${runId}`);
+      process.env.TESTOMATIO_RUN = runId;
+    } else {
+      this.onLog('Publishing to run...');
+    }
+    process.env.TESTOMATIO_REPLAY = '1';
+
     const client = new TestomatClient({
       apiKey: this.apiKey,
       isBatchEnabled: true,
       ...runParams,
+      ...(runId && { runId }),
     });
 
-    // Use the stored runId if available, otherwise create a new run
     if (runId) {
-      this.onLog(`Using existing run ID: ${runId}`);
       client.runId = runId;
-    } else {
-      this.onLog('Publishing to run...');
-      await client.createRun(runParams);
+      client.pipeStore.runId = runId;
     }
 
-    // Send each test result
+    await client.createRun(runParams);
+
     let successCount = 0;
     let failureCount = 0;
 
@@ -248,7 +256,9 @@ export class Replay {
 
     await client.updateRunStatus(finishParams.status || STATUS.FINISHED);
 
-    const result = {
+    this.onLog(`Successfully replayed ${successCount}/${tests.length} tests from debug file`);
+
+    return {
       success: true,
       testsCount: tests.length,
       successCount,
@@ -258,10 +268,6 @@ export class Replay {
       envVars,
       runId: runId || client.runId,
     };
-
-    this.onLog(`Successfully replayed ${successCount}/${tests.length} tests from debug file`);
-
-    return result;
   }
 }
 

package/src/template/testomatio.hbs

@@ -2242,7 +2242,6 @@
                                     <div class='env-var-item {{#unless this.isSet}}env-var-unset{{/unless}}'>
                                         <div class='env-var-info'>
                                             <div class='env-var-key'>{{@key}}</div>
-                                            <div class='env-var-description'>{{this.description}}</div>
                                         </div>
                                         <div class='env-var-value {{#unless this.isSet}}env-var-empty{{/unless}} {{#if this.isSensitive}}env-var-confidential{{/if}}'>
                                             {{#if this.isSensitive}}
@@ -2267,7 +2266,6 @@
                                     <div class='env-var-item {{#unless this.isSet}}env-var-unset{{/unless}}'>
                                         <div class='env-var-info'>
                                             <div class='env-var-key'>{{@key}}</div>
-                                            <div class='env-var-description'>{{this.description}}</div>
                                         </div>
                                         <div class='env-var-value {{#unless this.isSet}}env-var-empty{{/unless}} {{#if this.isSensitive}}env-var-confidential{{/if}}'>
                                             {{#if this.isSensitive}}

package/src/utils/debug.js

@@ -0,0 +1,20 @@
+import path from 'path';
+import os from 'os';
+import { DEBUG_FILE } from '../constants.js';
+
+/**
+ * Get the debug file path(s).
+ *
+ * Always creates a timestamped file in tmp dir and a symlink in project root.
+ *
+ * @param {string} [suffix] - Optional suffix appended to the base name (e.g. 'replay').
+ * @returns {{root: string, tmp: string}} root path (symlink), tmp path (actual file)
+ */
+export function getDebugFilePath(suffix = '') {
+  const dateTime = new Date().toISOString().slice(0, 19).replace(/[:.]/g, '-');
+  const baseName = suffix ? `${DEBUG_FILE}-${suffix}` : DEBUG_FILE;
+  return {
+    root: path.join(process.cwd(), `${baseName}.json`),
+    tmp: path.join(os.tmpdir(), `${baseName}.${dateTime}.json`),
+  };
+}

package/src/xmlReader.js

@@ -39,18 +39,29 @@ const {
   TESTOMATIO_RUN,
   TESTOMATIO_MARK_DETACHED,
   TESTOMATIO_LEGACY_NUNIT,
+  TESTOMATIO_MAX_ENTITY_EXPANSIONS,
 } = process.env;
 
+const MAX_OUTPUT_LENGTH = parseInt(TESTOMATIO_MAX_STACK_TRACE, 10) || 10000;
+const MAX_ENTITY_EXPANSIONS = parseInt(TESTOMATIO_MAX_ENTITY_EXPANSIONS, 10) || 10000;
+const ENTITY_EXPANSION_LIMIT_REGEXP = /Entity expansion limit exceeded/i;
+
 const options = {
   ignoreDeclaration: true,
   ignoreAttributes: false,
   alwaysCreateTextNode: false,
   attributeNamePrefix: '',
   parseTagValue: true,
+  processEntities: {
+    enabled: true,
+    maxEntitySize: 10000,
+    maxExpansionDepth: 10,
+    maxTotalExpansions: MAX_ENTITY_EXPANSIONS,
+    maxExpandedLength: 100000,
+    maxEntityCount: 10000,
+  },
 };
 
-const MAX_OUTPUT_LENGTH = parseInt(TESTOMATIO_MAX_STACK_TRACE, 10) || 10000;
-
 const reduceOptions = {};
 
 class XmlReader {
@@ -113,7 +124,20 @@ class XmlReader {
       xmlData = xmlData.replace(regex, (_, p1, p2, p3) => `${p1}${p2.substring(0, MAX_OUTPUT_LENGTH)}${p3}`);
     }
 
-    const jsonResult = this.parser.parse(xmlData);
+    let jsonResult;
+    try {
+      jsonResult = this.parser.parse(xmlData);
+    } catch (error) {
+      if (ENTITY_EXPANSION_LIMIT_REGEXP.test(error.message)) {
+        throw new Error(
+          `${error.message}\n\n` +
+            `XML report contains more entity references than the current limit (${MAX_ENTITY_EXPANSIONS}). ` +
+            'If this XML report is trusted, increase the limit with TESTOMATIO_MAX_ENTITY_EXPANSIONS, for example:\n' +
+            `TESTOMATIO_MAX_ENTITY_EXPANSIONS=${MAX_ENTITY_EXPANSIONS * 2} npx report-xml "{pattern}" --lang={lang}`,
+        );
+      }
+      throw error;
+    }
     let jsonSuite;
 
     if (jsonResult.testsuites) {

package/types/types.d.ts

@@ -231,6 +231,11 @@ export interface HtmlTestData extends TestData {
   };
 }
 
+/**
+ * Extended test data for Markdown reporter.
+ */
+export interface MarkdownTestData extends HtmlTestData {}
+
 /**
  * Object representing a result of a Run.
  */