@testomatio/reporter 2.7.8 → 2.7.9-beta.2-markdown

package/lib/replay.js

@@ -6,7 +6,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Replay = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
-const os_1 = __importDefault(require("os"));
 const client_js_1 = __importDefault(require("./client.js"));
 const constants_js_1 = require("./constants.js");
 const config_js_1 = require("./config.js");
@@ -19,11 +18,12 @@ class Replay {
         this.onError = options.onError || console.error;
     }
     /**
-     * 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_1.default.join(os_1.default.tmpdir(), 'testomatio.debug.latest.json');
+        return path_1.default.join(process.cwd(), `${constants_js_1.DEBUG_FILE}.json`);
     }
     /**
      * Parse a debug file and extract test data
@@ -125,8 +125,11 @@ class Replay {
                         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) {
@@ -197,22 +200,25 @@ class Replay {
                 dryRun: true,
             };
         }
-        // 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 client_js_1.default({
             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;
+            client.pipeStore.runId = runId;
         }
-        else {
-            this.onLog('Publishing to run...');
-            await client.createRun(runParams);
-        }
-        // Send each test result
+        await client.createRun(runParams);
         let successCount = 0;
         let failureCount = 0;
         for (const [index, test] of tests.entries()) {
@@ -239,7 +245,8 @@ class Replay {
             }
         }
         await client.updateRunStatus(finishParams.status || constants_js_1.STATUS.FINISHED);
-        const result = {
+        this.onLog(`Successfully replayed ${successCount}/${tests.length} tests from debug file`);
+        return {
             success: true,
             testsCount: tests.length,
             successCount,
@@ -249,8 +256,6 @@ class Replay {
             envVars,
             runId: runId || client.runId,
         };
-        this.onLog(`Successfully replayed ${successCount}/${tests.length} tests from debug file`);
-        return result;
     }
 }
 exports.Replay = Replay;

package/lib/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/lib/utils/debug.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 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?: string): {
+    root: string;
+    tmp: string;
+};

package/lib/utils/debug.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDebugFilePath = getDebugFilePath;
+const path_1 = __importDefault(require("path"));
+const os_1 = __importDefault(require("os"));
+const constants_js_1 = require("../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)
+ */
+function getDebugFilePath(suffix = '') {
+    const dateTime = new Date().toISOString().slice(0, 19).replace(/[:.]/g, '-');
+    const baseName = suffix ? `${constants_js_1.DEBUG_FILE}-${suffix}` : constants_js_1.DEBUG_FILE;
+    return {
+        root: path_1.default.join(process.cwd(), `${baseName}.json`),
+        tmp: path_1.default.join(os_1.default.tmpdir(), `${baseName}.${dateTime}.json`),
+    };
+}
+
+module.exports.getDebugFilePath = getDebugFilePath;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "2.7.8",
+  "version": "2.7.9-beta.2-markdown",
   "description": "Testomatio Reporter Client",
   "engines": {
     "node": ">=18"

package/src/bin/cli.js

@@ -6,7 +6,7 @@ import { glob } from 'glob';
 import createDebugMessages from 'debug';
 import TestomatClient from '../client.js';
 import XmlReader from '../xmlReader.js';
-import { APP_PREFIX, STATUS } from '../constants.js';
+import { APP_PREFIX, STATUS, DEBUG_FILE } from '../constants.js';
 import { cleanLatestRunId, getPackageVersion, applyFilter } from '../utils/utils.js';
 import { config } from '../config.js';
 import { readLatestRunId } from '../utils/utils.js';
@@ -370,7 +370,7 @@ program
 program
   .command('replay')
   .description('Replay test data from debug file and re-send to Testomat.io')
-  .argument('[debug-file]', 'Path to debug file (defaults to /tmp/testomatio.debug.latest.json)')
+  .argument('[debug-file]', `Path to debug file. Defaults to ./${DEBUG_FILE}.json`)
   .option('--dry-run', 'Preview the data without sending to Testomat.io')
   .action(async (debugFile, opts) => {
     try {

package/src/client.js

@@ -215,6 +215,10 @@ class Client {
     const { rid, error = null, steps: originalSteps, title, suite_title } = testData;
     let steps = originalSteps;
 
+    // Capture step artifact paths BEFORE uploadStepArtifacts mutates them to URLs,
+    // so we can exclude them from the test-level artifacts list later.
+    const stepArtifactPaths = collectStepArtifactPaths(steps);
+
     // Upload artifacts from steps
     try {
       await this.uploadStepArtifacts(steps, rid);
@@ -228,7 +232,6 @@ class Client {
     const {
       time = 0,
       example = null,
-      files = [],
       filesBuffers = [],
       code = null,
       file,
@@ -236,11 +239,17 @@ class Client {
       test_id,
       timestamp,
       links,
-      manuallyAttachedArtifacts,
       overwrite,
       tags,
     } = testData;
-    let { message = '', meta = {} } = testData;
+    let { files = [], manuallyAttachedArtifacts, message = '', meta = {} } = testData;
+
+    if (stepArtifactPaths.size) {
+      files = files.filter(f => !isStepArtifact(f, stepArtifactPaths));
+      if (Array.isArray(manuallyAttachedArtifacts)) {
+        manuallyAttachedArtifacts = manuallyAttachedArtifacts.filter(a => !isStepArtifact(a, stepArtifactPaths));
+      }
+    }
 
     meta = Object.entries(meta)
       .filter(([, value]) => value !== null && value !== undefined)
@@ -450,6 +459,43 @@ class Client {
   }
 }
 
+/**
+ * Walks the step tree and returns the set of artifact path/url values
+ * referenced by `step.artifacts` at any depth.
+ *
+ * @param {any} steps
+ * @returns {Set<string>}
+ */
+function collectStepArtifactPaths(steps) {
+  const paths = new Set();
+  if (!Array.isArray(steps)) return paths;
+  const walk = arr => {
+    for (const step of arr) {
+      if (!step) continue;
+      if (Array.isArray(step.artifacts)) {
+        for (const a of step.artifacts) {
+          if (typeof a === 'string') paths.add(a);
+          else if (a && typeof a === 'object' && typeof a.path === 'string') paths.add(a.path);
+        }
+      }
+      if (Array.isArray(step.steps)) walk(step.steps);
+    }
+  };
+  walk(steps);
+  return paths;
+}
+
+/**
+ * @param {string|{path?: string}|null|undefined} item
+ * @param {Set<string>} paths
+ * @returns {boolean}
+ */
+function isStepArtifact(item, paths) {
+  if (!item) return false;
+  const p = typeof item === 'object' ? item.path : item;
+  return typeof p === 'string' && paths.has(p);
+}
+
 /**
  *
  * @param {TestData} testData

package/src/constants.js

@@ -35,6 +35,12 @@ const HTML_REPORT = {
   TEMPLATE_NAME: 'testomatio.hbs',
 };
 
+// markdown pipe var
+const MARKDOWN_REPORT = {
+  FOLDER: 'md-report',
+  REPORT_DEFAULT_NAME: 'testomatio-report.md',
+};
+
 const testomatLogoURL = 'https://avatars.githubusercontent.com/u/59105116?s=36&v=4';
 
 const REPORTER_REQUEST_RETRIES = {
@@ -44,6 +50,8 @@ const REPORTER_REQUEST_RETRIES = {
   withinTimeSeconds: Number(process.env.TESTOMATIO_MAX_REQUEST_RETRIES_WITHIN_TIME_SECONDS) || 60,
 };
 
+const DEBUG_FILE = 'testomatio.debug';
+
 function getCreateRunRequestTimeout() {
   return Math.max(REQUEST_TIMEOUT, 80 * 1000);
 }
@@ -54,9 +62,11 @@ export {
   CSV_HEADERS,
   STATUS,
   HTML_REPORT,
+  MARKDOWN_REPORT,
   REQUEST_TIMEOUT,
   getCreateRunRequestTimeout,
   testomatLogoURL,
   REPORTER_REQUEST_RETRIES,
   SCREENSHOTS_ON_STEPS,
+  DEBUG_FILE,
 };

package/src/pipe/debug.js

@@ -1,9 +1,9 @@
 import fs from 'fs';
 import path from 'path';
-import os from 'os';
 import createDebugMessages from 'debug';
 import prettyMs from 'pretty-ms';
 import { log } from '../utils/log.js';
+import { getDebugFilePath } from '../utils/debug.js';
 
 const debug = createDebugMessages('@testomatio/reporter:pipe:debug');
 
@@ -21,23 +21,33 @@ export class DebugPipe {
         tests: [],
         batchIndex: 0,
       };
-      this.logFilePath = path.join(os.tmpdir(), `testomatio.debug.${Date.now()}.json`);
+      const suffix = process.env.TESTOMATIO_REPLAY ? 'replay' : '';
+      const paths = getDebugFilePath(suffix);
+      this.logFilePath = paths.tmp;
+      this.rootPath = paths.root;
+      this.historyDir = path.dirname(paths.tmp);
 
       debug('Creating debug file:', this.logFilePath);
       fs.writeFileSync(this.logFilePath, '');
 
-      // Create symlink to ensure consistent path to latest debug file
-      const symlinkPath = path.join(os.tmpdir(), 'testomatio.debug.latest.json');
+      // Create symlink in project root pointing to the timestamped debug file.
+      // Symlinks may fail on Windows without admin / on filesystems that don't support them;
+      // fall back to printing the actual tmp path so the user-facing log isn't misleading.
       try {
-        // Remove existing symlink if it exists
-        if (fs.existsSync(symlinkPath)) {
-          fs.unlinkSync(symlinkPath);
+        // Use lstatSync (not existsSync) so we also detect dangling symlinks —
+        // existsSync follows links and returns false when the target is gone,
+        // which would leave a stale symlink in place and make symlinkSync fail with EEXIST.
+        try {
+          fs.lstatSync(paths.root);
+          fs.unlinkSync(paths.root);
+        } catch (e) {
+          if (e.code !== 'ENOENT') throw e;
         }
-        // Create new symlink pointing to the timestamped debug file
-        fs.symlinkSync(this.logFilePath, symlinkPath);
-        debug('Created symlink:', symlinkPath, '->', this.logFilePath);
+        fs.symlinkSync(this.logFilePath, paths.root);
+        debug('Created symlink:', paths.root, '->', this.logFilePath);
       } catch (err) {
-        debug('Failed to create symlink:', err.message);
+        debug('Failed to create symlink, using tmp path directly:', err.message);
+        this.rootPath = this.logFilePath;
       }
 
       log.info('🪲 Debug file created');
@@ -114,8 +124,12 @@ export class DebugPipe {
     if (!this.isEnabled) return;
     await this.sync();
     if (this.batch.intervalFunction) clearInterval(this.batch.intervalFunction);
-    this.logToFile({ action: 'finishRun', params });
-    log.info('🪲 Debug Saved to', this.logFilePath);
+    const logData = { action: 'finishRun', params };
+    if (this.store.runId) logData.runId = this.store.runId;
+    this.logToFile(logData);
+
+    log.info(`🪲 Debug file: ${this.rootPath}`);
+    log.info(`History: ${this.historyDir}`);
   }
 
   async sync() {

package/src/pipe/html.js

@@ -906,121 +906,31 @@ function dropISayEcho(lines) {
   return out;
 }
 
-/**
- * Collects all Testomatio and S3 environment variables
- * Uses hardcoded list to avoid file system dependencies for end users
- * @returns {Object} Object with TESTOMATIO_ and S3_ variables grouped
- */
-function collectEnvironmentVariables() {
-  return getHardcodedEnvVars();
-}
+const SENSITIVE_ENV_PATTERNS = [/TOKEN/, /SECRET/, /PASSWORD/, /KEY/, /^TESTOMATIO$/];
 
-/**
- * Process environment variables configuration and collect their values
- * @param {Object} varConfigs - Object with variable configurations { [key]: { description } }
- * @param {Set} sensitiveVars - Set of sensitive variable names
- * @returns {Object} Processed environment variables with metadata
- */
-function processEnvironmentVariables(varConfigs, sensitiveVars) {
-  const result = {};
+function isSensitiveEnvName(name) {
+  return SENSITIVE_ENV_PATTERNS.some(re => re.test(name));
+}
 
-  for (const [key, config] of Object.entries(varConfigs)) {
-    const value = process.env[key];
-    const isSensitive = sensitiveVars.has(key);
+function collectEnvironmentVariables() {
+  const groups = { testomatio: {}, s3: {} };
 
-    if (isSensitive) {
-      if (value !== undefined) {
-        result[key] = { value: '***', description: config.description, isSet: true, isSensitive: true };
-      } else {
-        result[key] = { value: '', description: config.description, isSet: false, isSensitive: true };
-      }
-    } else {
-      if (value !== undefined) {
-        result[key] = { value, description: config.description, isSet: true };
-      } else {
-        result[key] = { value: '', description: config.description, isSet: false };
-      }
-    }
-  }
+  for (const [name, value] of Object.entries(process.env)) {
+    if (value === undefined) continue;
 
-  return result;
-}
+    let group = null;
+    if (name === 'TESTOMATIO' || name.startsWith('TESTOMATIO_')) group = 'testomatio';
+    else if (name.startsWith('S3_')) group = 's3';
+    if (!group) continue;
 
-/**
- * Hardcoded environment variables stored in code
- * This is the main source of truth for env vars to avoid file system dependencies
- * @returns {Object} Object with TESTOMATIO_ and S3_ variables
- */
-function getHardcodedEnvVars() {
-  const allVars = {
-    testomatio: {
-      TESTOMATIO: { description: 'API Key for Testomat.io' },
-      TESTOMATIO_API_KEY: { description: 'API Key (alias for TESTOMATIO)' },
-      TESTOMATIO_CREATE: { description: 'Create new tests in Testomat.io' },
-      TESTOMATIO_DEBUG: { description: 'Enable debug mode' },
-      TESTOMATIO_DISABLE_BATCH_UPLOAD: { description: 'Disable batch upload' },
-      TESTOMATIO_ENV: { description: 'Environment label (e.g., "Windows, Chrome")' },
-      TESTOMATIO_EXCLUDE_FILES_FROM_REPORT_GLOB_PATTERN: { description: 'Glob pattern to exclude files' },
-      TESTOMATIO_EXCLUDE_SKIPPED: { description: 'Exclude skipped tests from report' },
-      TESTOMATIO_FILENAME: { description: 'HTML report filename' },
-      TESTOMATIO_HTML_FILENAME: { description: 'HTML report filename' },
-      TESTOMATIO_HTML_REPORT_FOLDER: { description: 'Folder for HTML report' },
-      TESTOMATIO_HTML_REPORT_SAVE: { description: 'Save HTML report' },
-      TESTOMATIO_INTERCEPT_CONSOLE_LOGS: { description: 'Intercept console logs' },
-      TESTOMATIO_MARK_DETACHED: { description: 'Mark tests as detached' },
-      TESTOMATIO_MAX_REQUEST_FAILURES: { description: 'Max request failures' },
-      TESTOMATIO_MAX_REQUEST_FAILURES_COUNT: { description: 'Max request failures count' },
-      TESTOMATIO_MAX_REQUEST_RETRIES_WITHIN_TIME_SECONDS: { description: 'Max retries within time period' },
-      TESTOMATIO_NO_STEPS: { description: 'Disable steps reporting' },
-      TESTOMATIO_NO_TIMESTAMP: { description: 'Remove timestamps from logs' },
-      TESTOMATIO_PROCEED: { description: 'Proceed even if tests fail' },
-      TESTOMATIO_PUBLISH: { description: 'Publish results to Testomat.io' },
-      TESTOMATIO_REQUEST_TIMEOUT: { description: 'Request timeout in milliseconds' },
-      TESTOMATIO_RUN: { description: 'Run ID to report tests to' },
-      TESTOMATIO_RUNGROUP_TITLE: { description: 'Title for run group' },
-      TESTOMATIO_SHARED_RUN: { description: 'Share run for parallel execution' },
-      TESTOMATIO_SHARED_RUN_TIMEOUT: { description: 'Timeout for shared run (in seconds)' },
-      TESTOMATIO_STACK_ARTIFACTS: { description: 'Stack artifacts in report' },
-      TESTOMATIO_STACK_FILTER: { description: 'Filter stack traces' },
-      TESTOMATIO_STACK_PASSED: { description: 'Report stack for passed tests' },
-      TESTOMATIO_STEPS_PASSED: { description: 'Report steps for passed tests' },
-      TESTOMATIO_SUITE: { description: 'Suite ID for new tests' },
-      TESTOMATIO_TOKEN: { description: 'API Token (alias for TESTOMATIO)' },
-      TESTOMATIO_TITLE: { description: 'Title for the test run' },
-      TESTOMATIO_URL: { description: 'Testomat.io URL (custom instance)' },
-      TESTOMATIO_WORKDIR: { description: 'Working directory for relative paths' },
-    },
-    s3: {
-      S3_ACCESS_KEY_ID: { description: 'S3 access key ID' },
-      S3_BUCKET: { description: 'S3 bucket name' },
-      S3_ENDPOINT: { description: 'S3 endpoint URL' },
-      S3_FORCE_PATH_STYLE: { description: 'S3 force path style' },
-      S3_KEY: { description: 'S3 access key' },
-      S3_PREFIX: { description: 'S3 key prefix' },
-      S3_REGION: { description: 'S3 region' },
-      S3_SECRET: { description: 'S3 secret key' },
-      S3_SECRET_ACCESS_KEY: { description: 'S3 secret access key' },
-      S3_SESSION_TOKEN: { description: 'S3 session token' },
-    },
-  };
+    const isSensitive = isSensitiveEnvName(name);
+    let displayValue = value;
+    if (isSensitive) displayValue = '***';
 
-  const sensitiveVars = new Set([
-    'TESTOMATIO',
-    'TESTOMATIO_TOKEN',
-    'TESTOMATIO_API_KEY',
-    'S3_KEY',
-    'S3_SECRET',
-    'S3_ACCESS_KEY_ID',
-    'S3_SECRET_ACCESS_KEY',
-    'S3_SESSION_TOKEN',
-  ]);
-
-  const envVars = {
-    testomatio: processEnvironmentVariables(allVars.testomatio, sensitiveVars),
-    s3: processEnvironmentVariables(allVars.s3, sensitiveVars),
-  };
+    groups[group][name] = { value: displayValue, isSet: true, isSensitive };
+  }
 
-  return envVars;
+  return groups;
 }
 
 /**

package/src/pipe/index.js

@@ -6,6 +6,7 @@ import GitHubPipe from './github.js';
 import GitLabPipe from './gitlab.js';
 import CsvPipe from './csv.js';
 import HtmlPipe from './html.js';
+import MarkdownPipe from './markdown.js';
 import CoveragePipe from './coverage.js';
 import { BitbucketPipe } from './bitbucket.js';
 import { DebugPipe } from './debug.js';
@@ -48,6 +49,7 @@ export async function pipesFactory(params, opts) {
     new GitLabPipe(params, opts),
     new CsvPipe(params, opts),
     new HtmlPipe(params, opts),
+    new MarkdownPipe(params, opts),
     new BitbucketPipe(params, opts),
     new CoveragePipe(params, opts),
     new DebugPipe(params, opts),