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

package/README.md

@@ -135,6 +135,7 @@ Bring this reporter on CI and never lose test results again!
   - [Gitlab](./docs/pipes/gitlab.md)
   - [CSV](./docs/pipes/csv.md)
   - [HTML report](./docs/pipes/html.md)
+  - [Markdown report](./docs/pipes/markdown.md)
   - [Bitbucket](./docs/pipes/bitbucket.md)
 - 🔗 [Linking Tests](./docs/linking-tests.md)
 - 📓 [JUnit](./docs/junit.md)

package/lib/bin/cli.js

@@ -310,7 +310,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 ./${constants_js_1.DEBUG_FILE}.json`)
     .option('--dry-run', 'Preview the data without sending to Testomat.io')
     .action(async (debugFile, opts) => {
     try {

package/lib/client.js

@@ -199,6 +199,9 @@ 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);
@@ -208,8 +211,14 @@ class Client {
         }
         const uploadedFiles = [];
         const stackArtifactsEnabled = (0, utils_js_1.transformEnvVarToBoolean)(process.env.TESTOMATIO_STACK_ARTIFACTS);
-        const { time = 0, example = null, files = [], filesBuffers = [], code = null, file, suite_id, test_id, timestamp, links, manuallyAttachedArtifacts, overwrite, tags, } = testData;
-        let { message = '', meta = {} } = testData;
+        const { time = 0, example = null, filesBuffers = [], code = null, file, suite_id, test_id, timestamp, links, overwrite, tags, } = 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)
             .reduce((acc, [key, value]) => {
@@ -371,6 +380,47 @@ class Client {
     }
 }
 exports.Client = 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/lib/constants.d.ts

@@ -15,6 +15,12 @@ export namespace HTML_REPORT {
     let REPORT_DEFAULT_NAME: string;
     let TEMPLATE_NAME: string;
 }
+export namespace MARKDOWN_REPORT {
+    let FOLDER_1: string;
+    export { FOLDER_1 as FOLDER };
+    let REPORT_DEFAULT_NAME_1: string;
+    export { REPORT_DEFAULT_NAME_1 as REPORT_DEFAULT_NAME };
+}
 export const REQUEST_TIMEOUT: number;
 export function getCreateRunRequestTimeout(): number;
 export const testomatLogoURL: "https://avatars.githubusercontent.com/u/59105116?s=36&v=4";
@@ -25,3 +31,4 @@ export namespace REPORTER_REQUEST_RETRIES {
     let withinTimeSeconds: number;
 }
 export const SCREENSHOTS_ON_STEPS: boolean;
+export const DEBUG_FILE: "testomatio.debug";

package/lib/constants.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SCREENSHOTS_ON_STEPS = exports.REPORTER_REQUEST_RETRIES = exports.testomatLogoURL = exports.REQUEST_TIMEOUT = exports.HTML_REPORT = exports.STATUS = exports.CSV_HEADERS = exports.TESTOMAT_TMP_STORAGE_DIR = exports.APP_PREFIX = void 0;
+exports.DEBUG_FILE = exports.SCREENSHOTS_ON_STEPS = exports.REPORTER_REQUEST_RETRIES = exports.testomatLogoURL = exports.REQUEST_TIMEOUT = exports.MARKDOWN_REPORT = exports.HTML_REPORT = exports.STATUS = exports.CSV_HEADERS = exports.TESTOMAT_TMP_STORAGE_DIR = exports.APP_PREFIX = void 0;
 exports.getCreateRunRequestTimeout = getCreateRunRequestTimeout;
 const picocolors_1 = __importDefault(require("picocolors"));
 const os_1 = __importDefault(require("os"));
@@ -44,6 +44,12 @@ const HTML_REPORT = {
     TEMPLATE_NAME: 'testomatio.hbs',
 };
 exports.HTML_REPORT = HTML_REPORT;
+// markdown pipe var
+const MARKDOWN_REPORT = {
+    FOLDER: 'md-report',
+    REPORT_DEFAULT_NAME: 'testomatio-report.md',
+};
+exports.MARKDOWN_REPORT = MARKDOWN_REPORT;
 const testomatLogoURL = 'https://avatars.githubusercontent.com/u/59105116?s=36&v=4';
 exports.testomatLogoURL = testomatLogoURL;
 const REPORTER_REQUEST_RETRIES = {
@@ -53,6 +59,8 @@ const REPORTER_REQUEST_RETRIES = {
     withinTimeSeconds: Number(process.env.TESTOMATIO_MAX_REQUEST_RETRIES_WITHIN_TIME_SECONDS) || 60,
 };
 exports.REPORTER_REQUEST_RETRIES = REPORTER_REQUEST_RETRIES;
+const DEBUG_FILE = 'testomatio.debug';
+exports.DEBUG_FILE = DEBUG_FILE;
 function getCreateRunRequestTimeout() {
     return Math.max(REQUEST_TIMEOUT, 80 * 1000);
 }
@@ -73,6 +81,10 @@ module.exports.STATUS = STATUS;
 
 module.exports.HTML_REPORT = HTML_REPORT;
 
+module.exports.MARKDOWN_REPORT = MARKDOWN_REPORT;
+
 module.exports.testomatLogoURL = testomatLogoURL;
 
 module.exports.REPORTER_REQUEST_RETRIES = REPORTER_REQUEST_RETRIES;
+
+module.exports.DEBUG_FILE = DEBUG_FILE;

package/lib/pipe/debug.d.ts

@@ -11,6 +11,8 @@ export class DebugPipe {
         batchIndex: number;
     };
     logFilePath: string;
+    rootPath: string;
+    historyDir: string;
     testomatioEnvVars: {};
     batchUpload(): Promise<void>;
     /**

package/lib/pipe/debug.js

@@ -6,10 +6,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DebugPipe = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
-const os_1 = __importDefault(require("os"));
 const debug_1 = __importDefault(require("debug"));
 const pretty_ms_1 = __importDefault(require("pretty-ms"));
 const log_js_1 = require("../utils/log.js");
+const debug_js_1 = require("../utils/debug.js");
 const debug = (0, debug_1.default)('@testomatio/reporter:pipe:debug');
 class DebugPipe {
     constructor(params, store) {
@@ -24,22 +24,34 @@ class DebugPipe {
                 tests: [],
                 batchIndex: 0,
             };
-            this.logFilePath = path_1.default.join(os_1.default.tmpdir(), `testomatio.debug.${Date.now()}.json`);
+            const suffix = process.env.TESTOMATIO_REPLAY ? 'replay' : '';
+            const paths = (0, debug_js_1.getDebugFilePath)(suffix);
+            this.logFilePath = paths.tmp;
+            this.rootPath = paths.root;
+            this.historyDir = path_1.default.dirname(paths.tmp);
             debug('Creating debug file:', this.logFilePath);
             fs_1.default.writeFileSync(this.logFilePath, '');
-            // Create symlink to ensure consistent path to latest debug file
-            const symlinkPath = path_1.default.join(os_1.default.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_1.default.existsSync(symlinkPath)) {
-                    fs_1.default.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_1.default.lstatSync(paths.root);
+                    fs_1.default.unlinkSync(paths.root);
                 }
-                // Create new symlink pointing to the timestamped debug file
-                fs_1.default.symlinkSync(this.logFilePath, symlinkPath);
-                debug('Created symlink:', symlinkPath, '->', this.logFilePath);
+                catch (e) {
+                    if (e.code !== 'ENOENT')
+                        throw e;
+                }
+                fs_1.default.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_js_1.log.info('🪲 Debug file created');
             this.testomatioEnvVars = Object.keys(process.env)
@@ -117,8 +129,12 @@ class DebugPipe {
         await this.sync();
         if (this.batch.intervalFunction)
             clearInterval(this.batch.intervalFunction);
-        this.logToFile({ action: 'finishRun', params });
-        log_js_1.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_js_1.log.info(`🪲 Debug file: ${this.rootPath}`);
+        log_js_1.log.info(`History: ${this.historyDir}`);
     }
     async sync() {
         if (!this.isEnabled)

package/lib/pipe/html.js

@@ -760,116 +760,29 @@ 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$/];
+function isSensitiveEnvName(name) {
+    return SENSITIVE_ENV_PATTERNS.some(re => re.test(name));
 }
-/**
- * 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 = {};
-    for (const [key, config] of Object.entries(varConfigs)) {
-        const value = process.env[key];
-        const isSensitive = sensitiveVars.has(key);
-        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 };
-            }
-        }
+function collectEnvironmentVariables() {
+    const groups = { testomatio: {}, s3: {} };
+    for (const [name, value] of Object.entries(process.env)) {
+        if (value === undefined)
+            continue;
+        let group = null;
+        if (name === 'TESTOMATIO' || name.startsWith('TESTOMATIO_'))
+            group = 'testomatio';
+        else if (name.startsWith('S3_'))
+            group = 's3';
+        if (!group)
+            continue;
+        const isSensitive = isSensitiveEnvName(name);
+        let displayValue = value;
+        if (isSensitive)
+            displayValue = '***';
+        groups[group][name] = { value: displayValue, isSet: true, isSensitive };
     }
-    return result;
-}
-/**
- * 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 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),
-    };
-    return envVars;
+    return groups;
 }
 /**
  * Prepares test steps for HTML report display

package/lib/pipe/index.js

@@ -45,6 +45,7 @@ const github_js_1 = __importDefault(require("./github.js"));
 const gitlab_js_1 = __importDefault(require("./gitlab.js"));
 const csv_js_1 = __importDefault(require("./csv.js"));
 const html_js_1 = __importDefault(require("./html.js"));
+const markdown_js_1 = __importDefault(require("./markdown.js"));
 const coverage_js_1 = __importDefault(require("./coverage.js"));
 const bitbucket_js_1 = require("./bitbucket.js");
 const debug_js_1 = require("./debug.js");
@@ -83,6 +84,7 @@ async function pipesFactory(params, opts) {
         new gitlab_js_1.default(params, opts),
         new csv_js_1.default(params, opts),
         new html_js_1.default(params, opts),
+        new markdown_js_1.default(params, opts),
         new bitbucket_js_1.BitbucketPipe(params, opts),
         new coverage_js_1.default(params, opts),
         new debug_js_1.DebugPipe(params, opts),

package/lib/pipe/markdown.d.ts

@@ -0,0 +1,25 @@
+export default MarkdownPipe;
+declare class MarkdownPipe {
+    constructor(params: any, store?: {});
+    store: {};
+    title: any;
+    apiKey: any;
+    isMarkdown: string;
+    isEnabled: boolean;
+    markdownOutputPath: string;
+    filenameMsg: string;
+    tests: any[];
+    markdownReportDir: string;
+    markdownReportName: string;
+    createRun(): Promise<void>;
+    prepareRun(): Promise<void>;
+    updateRun(): void;
+    /**
+     * @param {import('../../types/types.js').MarkdownTestData} test
+     */
+    addTest(test: import("../../types/types.js").MarkdownTestData): void;
+    finishRun(runParams: any): Promise<void>;
+    buildReport(opts: any): void;
+    sync(): Promise<void>;
+    toString(): string;
+}