@testomatio/reporter 2.19.0 → 2.20.0

package/lib/allureReader.d.ts

@@ -35,7 +35,10 @@ declare class AllureReader {
         steps: any;
         message: any;
         stack: any;
-        meta: {};
+        meta: {
+            reporterVersion: any;
+            adapter: string;
+        };
         links: {
             label: string;
         }[];

package/lib/allureReader.js

@@ -163,7 +163,8 @@ class AllureReader {
             steps: this.convertSteps(result.steps || [], resultsDir),
             message: result.statusDetails?.message || '',
             stack: result.statusDetails?.trace || '',
-            meta: this.extractMeta(result),
+            // meta must always include reporter version and adapter used
+            meta: { ...this.extractMeta(result), reporterVersion: this.version, adapter: 'allure' },
             links: this.extractLinks(result),
             artifacts: [],
             create: true,

package/lib/bin/cli.js

@@ -121,35 +121,54 @@ program
 program
     .command('fetch')
     .description('Fetch runs from Testomat.io API v2')
+    .argument('[url]', 'URL of a run or of a (filtered) runs page in Testomat.io')
     .option('--project <slug>', 'Project slug (or set TESTOMATIO_PROJECT)')
+    .option('--run <id>', 'Fetch a single run by its id')
     .option('--title <text>', 'Filter by run title')
     .option('--tql <query>', 'Filter using Testomat Query Language')
     .option('--rungroup <uid>', 'Filter by rungroup id')
     .option('--limit <number>', `Max number of runs to return (max ${FETCH_RUNS_MAX_LIMIT})`, String(FETCH_RUNS_DEFAULT_LIMIT))
     .option('--latest', 'Only fetch the most recent run (shorthand for --limit 1)')
     .option('--format <format>', 'Machine-readable output: run ids, one per line (--format id) or run details (--format json)')
-    .action(async (opts) => {
+    .action(async (pageUrl, opts) => {
     const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || config_js_1.config.TESTOMATIO;
     if (!apiKey) {
         log_js_1.log.error(picocolors_1.default.red('⚠️  TESTOMATIO API key required'));
         process.exit(1);
     }
-    const project = opts.project || process.env.TESTOMATIO_PROJECT;
+    let page = {};
+    if (pageUrl) {
+        page = (0, pipe_utils_js_1.parseRunsUrl)(pageUrl);
+        if (!page) {
+            log_js_1.log.error(picocolors_1.default.red(`⚠️  Not a Testomat.io run or runs page URL: ${pageUrl}`));
+            process.exit(1);
+        }
+    }
+    const project = opts.project || page.project || process.env.TESTOMATIO_PROJECT;
     if (!project) {
         log_js_1.log.error(picocolors_1.default.red('⚠️  --project (or TESTOMATIO_PROJECT) is required'));
         process.exit(1);
     }
-    const baseUrl = process.env.TESTOMATIO_URL || 'https://app.testomat.io';
-    const url = new URL(`/api/v2/${project}/runs`, baseUrl);
-    if (opts.title)
-        url.searchParams.set('search', opts.title);
-    if (opts.tql)
-        url.searchParams.set('tql', opts.tql);
-    if (opts.rungroup)
-        url.searchParams.set('groupId', opts.rungroup);
-    const requestedLimit = opts.latest ? 1 : parseInt(opts.limit, 10) || FETCH_RUNS_DEFAULT_LIMIT;
-    const limit = Math.min(Math.max(requestedLimit, 1), FETCH_RUNS_MAX_LIMIT);
-    url.searchParams.set('per_page', String(limit));
+    const baseUrl = page.baseUrl || process.env.TESTOMATIO_URL || 'https://app.testomat.io';
+    const runId = opts.run || page.runId;
+    let url;
+    if (runId) {
+        url = new URL(`/api/v2/${project}/runs/${runId}`, baseUrl);
+    }
+    else {
+        url = new URL(`/api/v2/${project}/runs`, baseUrl);
+        for (const [key, value] of page.params || [])
+            url.searchParams.append(key, value);
+        if (opts.title)
+            url.searchParams.set('search', opts.title);
+        if (opts.tql)
+            url.searchParams.set('tql', opts.tql);
+        if (opts.rungroup)
+            url.searchParams.set('groupId', opts.rungroup);
+        const requestedLimit = opts.latest ? 1 : parseInt(opts.limit, 10) || FETCH_RUNS_DEFAULT_LIMIT;
+        const limit = Math.min(Math.max(requestedLimit, 1), FETCH_RUNS_MAX_LIMIT);
+        url.searchParams.set('per_page', String(limit));
+    }
     const response = await fetch(url, { headers: { Authorization: `Bearer ${apiKey}` } });
     const body = await response.json();
     if (!response.ok) {

package/lib/client.d.ts

@@ -15,6 +15,7 @@ export class Client {
     pipeStore: {};
     runId: string;
     queue: Promise<void>;
+    adapterName: any;
     version: any;
     executionList: Promise<void>;
     uploader: S3Uploader;

package/lib/client.js

@@ -37,6 +37,8 @@ class Client {
         this.pipeStore = {};
         this.runId = '';
         this.queue = Promise.resolve();
+        // adapter name is set by the adapter module itself on load (global.TESTOMATIO_ADAPTER)
+        this.adapterName = params.adapter || global.TESTOMATIO_ADAPTER;
         // @ts-ignore this line will be removed in compiled code, because __dirname is defined in commonjs
         const pathToPackageJSON = path_1.default.join(__dirname, '../package.json');
         try {
@@ -214,7 +216,9 @@ class Client {
         const uploadedFiles = [];
         const stackArtifactsEnabled = (0, utils_js_1.transformEnvVarToBoolean)(process.env.TESTOMATIO_STACK_ARTIFACTS);
         const { time = 0, example = null, filesBuffers = [], code = null, file, suite_id, test_id, timestamp, links, overwrite, tags, } = testData;
-        let { files = [], manuallyAttachedArtifacts, message = '', meta = {} } = testData;
+        let { files = [], manuallyAttachedArtifacts, message = '' } = testData;
+        /** @type {Record<string, any>} */
+        let meta = testData.meta || {};
         if (stepArtifactPaths.size) {
             const isStepArtifact = item => stepArtifactPaths.has(typeof item === 'object' ? item?.path : item);
             files = files.filter(f => !isStepArtifact(f));
@@ -229,6 +233,11 @@ class Client {
                 acc[key] = value;
             return acc;
         }, {});
+        // meta must always include reporter version and adapter used
+        if (this.version)
+            meta.reporterVersion = this.version;
+        if (this.adapterName)
+            meta.adapter = this.adapterName;
         const testContext = suite_title ? `${suite_title} ${title}` : title;
         let errorFormatted = '';
         if (error) {
@@ -335,8 +344,8 @@ class Client {
         this.queue = this.queue
             .then(() => Promise.all(this.pipes.map(p => p.finishRun(runParams))))
             .then(() => {
-            if (!this.uploader.isEnabled)
-                return;
+            // no early return when uploading is disabled:
+            // skipped artifacts (e.g. no S3 credentials obtained) must still be reported to the user
             const filesizeStrMaxLength = 7;
             if (this.uploader.successfulUploads.length) {
                 debug('\n', constants_js_1.APP_PREFIX, `🗄️ ${this.uploader.successfulUploads.length} artifacts uploaded to S3 bucket`);

package/lib/data-storage.js

@@ -220,9 +220,10 @@ class DataStorage {
     }
 }
 function stringToMD5Hash(str) {
-    const md5 = crypto_1.default.createHash('md5');
-    md5.update(str);
-    const hash = md5.digest('hex');
+    // sha256 instead of md5 for FIPS-enabled hosts compatibility
+    const sha256 = crypto_1.default.createHash('sha256');
+    sha256.update(str);
+    const hash = sha256.digest('hex');
     return `${process.env.runId || 'run'}_${hash}`;
 }
 exports.dataStorage = DataStorage.getInstance();

package/lib/pipe/testomatio.js

@@ -317,6 +317,9 @@ class TestomatioPipe {
                 (0, pipe_utils_js_1.setS3Credentials)(resp.data.artifacts);
                 this.#startS3CredentialsRefresh(runParams);
             }
+            else {
+                this.#warnNoS3Credentials();
+            }
             if (resp.data.url) {
                 const respUrl = new URL(resp.data.url);
                 this.runUrl = `${this.url}${respUrl.pathname}`;
@@ -345,6 +348,9 @@ class TestomatioPipe {
                 (0, pipe_utils_js_1.setS3Credentials)(resp.data.artifacts);
                 this.#startS3CredentialsRefresh(runParams);
             }
+            else {
+                this.#warnNoS3Credentials();
+            }
             this.store.runUrl = this.runUrl;
             this.store.runPublicUrl = this.runPublicUrl;
             this.store.runId = this.runId;
@@ -403,9 +409,19 @@ class TestomatioPipe {
             }
         }
         catch (err) {
-            debug('Failed to refresh S3 credentials:', err.message || err);
+            log_js_1.log.warn('⚠️ Failed to refresh S3 credentials:', err.message || err, '\nArtifact uploads may fail once the current credentials expire.');
         }
     };
+    /**
+     * Warns the user when Testomat.io did not return S3 credentials for artifacts upload.
+     * Skipped when artifacts uploading was intentionally disabled or a custom S3 storage is configured via env.
+     */
+    #warnNoS3Credentials() {
+        if (process.env.TESTOMATIO_DISABLE_ARTIFACTS || process.env.S3_BUCKET)
+            return;
+        const command = `TESTOMATIO=<your_api_key> TESTOMATIO_RUN=${this.runId || '<run_id>'} npx @testomatio/reporter upload-artifacts`;
+        log_js_1.log.warn(`⚠️ ${picocolors_1.default.yellow('Testomat.io did not return S3 credentials for artifacts upload.')}`, 'Artifacts will not be uploaded.', 'Please check the artifact sharing settings of your project.', `\nRun "${picocolors_1.default.magenta(command)}" later with valid S3 credentials to re-upload artifacts to this run.`);
+    }
     #stopS3CredentialsRefresh() {
         if (this.s3CredentialsRefreshTimer) {
             clearInterval(this.s3CredentialsRefreshTimer);

package/lib/replay.js

@@ -231,6 +231,7 @@ class Replay {
         process.env.TESTOMATIO_REPLAY = '1';
         const client = new client_js_1.default({
             apiKey: this.apiKey,
+            adapter: 'replay',
             batchMode: constants_js_1.BATCH_MODE.AUTO,
             ...runParams,
             ...(runId && { runId }),

package/lib/uploader.d.ts

@@ -10,6 +10,7 @@ export class S3Uploader {
         size: number;
     }[];
     failedUploads: any[];
+    warnedDisabledUpload: boolean;
     /**
      * @type {{path: string, size: number, link: string}[]}
      */

package/lib/uploader.js

@@ -26,6 +26,7 @@ class S3Uploader {
          */
         this.skippedUploads = [];
         this.failedUploads = [];
+        this.warnedDisabledUpload = false;
         /**
          * @type {{path: string, size: number, link: string}[]}
          */
@@ -84,6 +85,22 @@ class S3Uploader {
     disableLogStorage() {
         this.storeEnabled = false;
     }
+    /**
+     * Warns once when artifact uploading is disabled not intentionally by the user,
+     * e.g. S3 credentials were not obtained from Testomat.io and no custom S3 storage is configured.
+     * Without this warning artifacts are skipped silently.
+     */
+    #warnDisabledUpload(runId) {
+        if (this.warnedDisabledUpload)
+            return;
+        const { S3_BUCKET, TESTOMATIO_DISABLE_ARTIFACTS } = this.getConfig();
+        // uploading was intentionally disabled by the user or a custom S3 storage is used, nothing to warn about
+        if (TESTOMATIO_DISABLE_ARTIFACTS || S3_BUCKET)
+            return;
+        this.warnedDisabledUpload = true;
+        const command = `TESTOMATIO=<your_api_key> TESTOMATIO_RUN=${runId || '<run_id>'} npx @testomatio/reporter upload-artifacts`;
+        log_js_1.log.warn(`🗄️ ${picocolors_1.default.yellow('Artifacts uploading is disabled: S3 credentials were not obtained from Testomat.io')}`, picocolors_1.default.yellow('(and no custom S3 storage is configured).'), 'Artifacts will not be uploaded.', `\nRun "${picocolors_1.default.magenta(command)}" later with valid S3 credentials to re-upload artifacts to this run.`);
+    }
     /**
      *
      * @param {*} Body
@@ -202,6 +219,7 @@ class S3Uploader {
             debug(`File ${filePath} does not exist`);
         }
         if (!this.isEnabled) {
+            this.#warnDisabledUpload(runId);
             this.storeUploadedFile(filePath, runId, rid, false);
             this.skippedUploads.push({ path: filePath, size: fileSize });
             return;
@@ -239,8 +257,10 @@ class S3Uploader {
         /* WDIO: some artifacts uploading started before createRun function completion
         probably, the reason is that run is NOT created in adapter (but via cli) */
         this.isEnabled = this.isEnabled ?? this.checkEnabled();
-        if (!this.isEnabled)
+        if (!this.isEnabled) {
+            this.#warnDisabledUpload(pathInS3[0]);
             return;
+        }
         let Key = pathInS3.filter(p => !!p).join('/');
         const ext = this.#getFileExtBase64(buffer.toString('base64'));
         if (ext) {

package/lib/utils/pipe_utils.d.ts

@@ -139,16 +139,29 @@ export function formatRunOutput(store: {
 }, format?: string): string;
 /**
  * Format the runs fetched via the `fetch` command for machine-readable output.
- * `json` prints the full array of run objects; `id` prints one run id per line;
+ * `json` prints the full array of run objects (a single object for one run); `id` prints one run id per line;
  * any other format prints a human-readable multi-line summary per run.
  *
- * @param {{data?: Array}} body - Parsed response body from GET /api/v2/:project/runs.
+ * @param {{data?: Array|Object}} body - Parsed response body from GET /api/v2/:project/runs[/:id].
  * @param {string} [format] - Value of the CLI `--format` option.
  * @returns {string}
  */
 export function formatFetchRunsOutput(body: {
-    data?: any[];
+    data?: any[] | any;
 }, format?: string): string;
+/**
+ * Parse a Testomat.io app URL of a run (/projects/:project/runs/:id)
+ * or of a runs page (/projects/:project/runs?filterParam=...) into API v2 request parts.
+ *
+ * @param {string} pageUrl
+ * @returns {{baseUrl: string, project: string, runId?: string, params: string[][]}|null}
+ */
+export function parseRunsUrl(pageUrl: string): {
+    baseUrl: string;
+    project: string;
+    runId?: string;
+    params: string[][];
+} | null;
 /**
  * Calculate the approximate size of data in bytes (JSON stringified, UTF-8 encoded length).
  * @param {Object} data - Data to measure

package/lib/utils/pipe_utils.js

@@ -18,6 +18,7 @@ exports.parsePipeOptions = parsePipeOptions;
 exports.formatFilterListIds = formatFilterListIds;
 exports.formatRunOutput = formatRunOutput;
 exports.formatFetchRunsOutput = formatFetchRunsOutput;
+exports.parseRunsUrl = parseRunsUrl;
 exports.getObjectSize = getObjectSize;
 exports.splitTestsIntoChunks = splitTestsIntoChunks;
 const humanize_duration_1 = __importDefault(require("humanize-duration"));
@@ -362,17 +363,18 @@ function formatRunOutput(store, format) {
 }
 /**
  * Format the runs fetched via the `fetch` command for machine-readable output.
- * `json` prints the full array of run objects; `id` prints one run id per line;
+ * `json` prints the full array of run objects (a single object for one run); `id` prints one run id per line;
  * any other format prints a human-readable multi-line summary per run.
  *
- * @param {{data?: Array}} body - Parsed response body from GET /api/v2/:project/runs.
+ * @param {{data?: Array|Object}} body - Parsed response body from GET /api/v2/:project/runs[/:id].
  * @param {string} [format] - Value of the CLI `--format` option.
  * @returns {string}
  */
 function formatFetchRunsOutput(body, format) {
-    const runs = body?.data || [];
+    const data = body?.data || [];
+    const runs = [data].flat();
     if (format === 'json')
-        return JSON.stringify(runs, null, 2);
+        return JSON.stringify(data, null, 2);
     if (format === 'id')
         return runs.map(run => run.id).filter(Boolean).join('\n');
     return runs
@@ -380,6 +382,8 @@ function formatFetchRunsOutput(body, format) {
         const lines = [`* ID: ${run.id}`];
         if (run.title)
             lines.push(`  title: ${run.title}`);
+        if (run.rungroup_id)
+            lines.push(`  rungroup: ${run.rungroup_id}`);
         if (run.launched_at)
             lines.push(`  started at: ${run.launched_at}`);
         if (run.finished_at)
@@ -400,6 +404,41 @@ function formatFetchRunsOutput(body, format) {
     })
         .join('\n');
 }
+// filterParam keys of the runs page which are API params on their own; the rest go under filter[...]
+const RUNS_PAGE_PARAMS = ['search', 'tql', 'groupId'];
+/**
+ * Parse a Testomat.io app URL of a run (/projects/:project/runs/:id)
+ * or of a runs page (/projects/:project/runs?filterParam=...) into API v2 request parts.
+ *
+ * @param {string} pageUrl
+ * @returns {{baseUrl: string, project: string, runId?: string, params: string[][]}|null}
+ */
+function parseRunsUrl(pageUrl) {
+    let url;
+    try {
+        url = new URL(pageUrl);
+    }
+    catch (e) {
+        return null;
+    }
+    const match = url.pathname.match(/\/projects\/([^/]+)\/runs(?:\/([^/]+))?\/?$/);
+    if (!match)
+        return null;
+    const [, project, runId] = match;
+    const params = [];
+    for (const [key, value] of new URLSearchParams(url.searchParams.get('filterParam') || '')) {
+        // "groups" only switches the page to the grouped view
+        if (!value || key === 'groups')
+            continue;
+        if (RUNS_PAGE_PARAMS.includes(key)) {
+            params.push([key, value]);
+            continue;
+        }
+        const [name, ...nested] = key.split('[');
+        params.push([`filter[${name}]${nested.map(part => `[${part}`).join('')}`, value]);
+    }
+    return { baseUrl: url.origin, project, runId, params };
+}
 
 module.exports.updateFilterType = updateFilterType;
 
@@ -431,6 +470,8 @@ module.exports.formatRunOutput = formatRunOutput;
 
 module.exports.formatFetchRunsOutput = formatFetchRunsOutput;
 
+module.exports.parseRunsUrl = parseRunsUrl;
+
 module.exports.getObjectSize = getObjectSize;
 
 module.exports.splitTestsIntoChunks = splitTestsIntoChunks;

package/lib/xmlReader.js

@@ -432,6 +432,8 @@ class XmlReader {
             }
             this.adapter.formatTest(t);
             t.title = (0, utils_js_1.humanize)(t.title);
+            // meta must always include reporter version and adapter used
+            t.meta = { ...t.meta, reporterVersion: this.version, adapter: 'xml' };
         });
     }
     formatErrors() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "2.19.0",
+  "version": "2.20.0",
   "description": "Testomatio Reporter Client",
   "engines": {
     "node": ">=22"
@@ -65,7 +65,8 @@
     "test:playwright": "mocha tests/adapter/playwright.test.js",
     "test:codecept": "mocha tests/adapter/codecept.test.js tests/adapter/codecept_comprehensive.test.js tests/adapter/codecept_steps_sections.test.js",
     "test:vitest": "mocha tests/adapter/vitest.test.js",
-    "test:frameworks": "npm run test:playwright && npm run test:codecept && npm run test:vitest",
+    "test:e2e": "mocha tests/adapter/e2e.test.js",
+    "test:frameworks": "npm run test:playwright && npm run test:codecept && npm run test:vitest && npm run test:e2e",
     "test:all": "npm run test && npm run test:frameworks",
     "test:adapters": "mocha tests/adapter/*.test.js",
     "test:codecept:bug948": "mocha tests/adapter/codecept_aftersuite_failure.test.js",
@@ -129,6 +130,10 @@
     "./lib/adapter/cypress-plugin": "./lib/adapter/cypress-plugin/index.js",
     "./cypress-plugin": "./lib/adapter/cypress-plugin/index.js",
     "./cypress": "./lib/adapter/cypress-plugin/index.js",
+    "./e2e": {
+      "import": "./src/adapter/e2e.js",
+      "require": "./lib/adapter/e2e.js"
+    },
     "./lib/adapter/jasmine.js": "./lib/adapter/jasmine.js",
     "./jasmine": "./lib/adapter/jasmine.js",
     "./lib/adapter/jest.js": "./lib/adapter/jest.js",

package/src/adapter/codecept.js

@@ -11,6 +11,8 @@ import codeceptjs from 'codeceptjs';
 import { log } from '../utils/log.js';
 
 const debug = createDebugMessages('@testomatio/reporter:adapter:codeceptjs');
+
+global.TESTOMATIO_ADAPTER = 'codeceptjs';
 // @ts-ignore
 if (!global.codeceptjs) {
   // @ts-ignore

package/src/adapter/cucumber/current.js

@@ -8,6 +8,8 @@ import { getTestomatIdFromTestTitle, fileSystem } from '../../utils/utils.js';
 import { config } from '../../config.js';
 import { services } from '../../services/index.js';
 
+global.TESTOMATIO_ADAPTER = 'cucumber';
+
 const { GherkinDocumentParser, PickleParser } = formatterHelpers;
 const { getGherkinScenarioLocationMap, getGherkinStepMap } = GherkinDocumentParser;
 const { getPickleStepMap } = PickleParser;

package/src/adapter/cypress-plugin/index.js

@@ -3,6 +3,8 @@ import { getTestomatIdFromTestTitle, parseSuite } from '../../utils/utils.js';
 import TestomatClient from '../../client.js';
 import { config } from '../../config.js';
 
+global.TESTOMATIO_ADAPTER = 'cypress';
+
 const testomatioReporter = on => {
   if (!config.TESTOMATIO) {
     console.log('TESTOMATIO key is empty, ignoring reports');