@testomatio/reporter 2.19.0 → 2.20.0

package/src/bin/cli.js

@@ -16,7 +16,7 @@ import { filesize as prettyBytes } from 'filesize';
 import dotenv from 'dotenv';
 import Replay from '../replay.js';
 import { log } from '../utils/log.js';
-import { formatFilterListIds, formatRunOutput, formatFetchRunsOutput } from '../utils/pipe_utils.js';
+import { formatFilterListIds, formatRunOutput, formatFetchRunsOutput, parseRunsUrl } from '../utils/pipe_utils.js';
 import fs from 'fs';
 import path from 'path';
 
@@ -130,7 +130,9 @@ 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')
@@ -144,27 +146,44 @@ program
     '--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.TESTOMATIO;
     if (!apiKey) {
       log.error(pc.red('⚠️  TESTOMATIO API key required'));
       process.exit(1);
     }
 
-    const project = opts.project || process.env.TESTOMATIO_PROJECT;
+    let page = {};
+    if (pageUrl) {
+      page = parseRunsUrl(pageUrl);
+      if (!page) {
+        log.error(pc.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.error(pc.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();

package/src/client.js

@@ -36,6 +36,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 __dirname = path.dirname(fileURLToPath(import.meta.url));
@@ -244,7 +246,9 @@ class Client {
       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);
@@ -261,6 +265,10 @@ class Client {
         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 = '';
@@ -389,8 +397,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) {

package/src/data-storage.js

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

package/src/pipe/testomatio.js

@@ -352,6 +352,8 @@ class TestomatioPipe {
       if (resp.data.artifacts) {
         setS3Credentials(resp.data.artifacts);
         this.#startS3CredentialsRefresh(runParams);
+      } else {
+        this.#warnNoS3Credentials();
       }
       if (resp.data.url) {
         const respUrl = new URL(resp.data.url);
@@ -383,6 +385,8 @@ class TestomatioPipe {
       if (resp.data.artifacts) {
         setS3Credentials(resp.data.artifacts);
         this.#startS3CredentialsRefresh(runParams);
+      } else {
+        this.#warnNoS3Credentials();
       }
 
       this.store.runUrl = this.runUrl;
@@ -442,10 +446,32 @@ class TestomatioPipe {
         debug('S3 credentials refreshed');
       }
     } catch (err) {
-      debug('Failed to refresh S3 credentials:', err.message || err);
+      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.warn(
+      `⚠️ ${pc.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 "${pc.magenta(command)}" later with valid S3 credentials to re-upload artifacts to this run.`,
+    );
+  }
+
   #stopS3CredentialsRefresh() {
     if (this.s3CredentialsRefreshTimer) {
       clearInterval(this.s3CredentialsRefreshTimer);

package/src/replay.js

@@ -237,6 +237,7 @@ export class Replay {
 
     const client = new TestomatClient({
       apiKey: this.apiKey,
+      adapter: 'replay',
       batchMode: BATCH_MODE.AUTO,
       ...runParams,
       ...(runId && { runId }),

package/src/uploader.js

@@ -23,6 +23,7 @@ export class S3Uploader {
      */
     this.skippedUploads = [];
     this.failedUploads = [];
+    this.warnedDisabledUpload = false;
     /**
      * @type {{path: string, size: number, link: string}[]}
      */
@@ -90,6 +91,30 @@ export class S3Uploader {
     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.warn(
+      `🗄️ ${pc.yellow('Artifacts uploading is disabled: S3 credentials were not obtained from Testomat.io')}`,
+      pc.yellow('(and no custom S3 storage is configured).'),
+      'Artifacts will not be uploaded.',
+      `\nRun "${pc.magenta(command)}" later with valid S3 credentials to re-upload artifacts to this run.`,
+    );
+  }
+
   /**
    *
    * @param {*} Body
@@ -231,6 +256,7 @@ export class S3Uploader {
     }
 
     if (!this.isEnabled) {
+      this.#warnDisabledUpload(runId);
       this.storeUploadedFile(filePath, runId, rid, false);
       this.skippedUploads.push({ path: filePath, size: fileSize });
       return;
@@ -281,7 +307,10 @@ export class S3Uploader {
     probably, the reason is that run is NOT created in adapter (but via cli) */
 
     this.isEnabled = this.isEnabled ?? this.checkEnabled();
-    if (!this.isEnabled) return;
+    if (!this.isEnabled) {
+      this.#warnDisabledUpload(pathInS3[0]);
+      return;
+    }
 
     let Key = pathInS3.filter(p => !!p).join('/');
     const ext = this.#getFileExtBase64(buffer.toString('base64'));

package/src/utils/pipe_utils.js

@@ -366,17 +366,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);
+  if (format === 'json') return JSON.stringify(data, null, 2);
 
   if (format === 'id') return runs.map(run => run.id).filter(Boolean).join('\n');
 
@@ -384,6 +385,7 @@ function formatFetchRunsOutput(body, format) {
     .map(run => {
       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) lines.push(`  finished at: ${run.finished_at}`);
       if (run.passed_count != null) lines.push(`  passed: ${run.passed_count} tests`);
@@ -397,6 +399,44 @@ 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 };
+}
+
 export {
   updateFilterType,
   parseFilterParams,
@@ -413,6 +453,7 @@ export {
   formatFilterListIds,
   formatRunOutput,
   formatFetchRunsOutput,
+  parseRunsUrl,
   getObjectSize,
   splitTestsIntoChunks,
 };

package/src/xmlReader.js

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

package/types/types.d.ts

@@ -374,6 +374,7 @@ declare global {
       testomatioDataStore?: any;
       TESTOMATIO_LOGGER_CONSOLE_INTERCEPTED?: boolean;
       testomatioTestTitle?: string;
+      TESTOMATIO_ADAPTER?: string;
     }
   }
 }