@testomatio/reporter 2.17.0-beta → 2.17.0-beta.1

package/lib/adapter/codecept.js

@@ -317,16 +317,31 @@ function stripExampleFromTitle(title) {
     }
     let baseTitle = title.slice(0, res.index).trim();
     if (exampleParsed) {
+        const placeholderKeys = [...new Set([...baseTitle.matchAll(PLACEHOLDER_REGEXP)].map(match => match[1]))];
         baseTitle = baseTitle.replace(PLACEHOLDER_REGEXP, (placeholder, key) => {
+            // a placeholder matching a key of an object row resolves to that key's value
+            if (Object.hasOwn(example ?? {}, key))
+                return formatExample(example[key]);
             if (key === 'current')
                 return formatExample(example);
-            if (!Object.hasOwn(example ?? {}, key))
-                return placeholder;
-            return formatExample(example[key]);
+            return placeholder;
         });
+        example = reduceExample(example, placeholderKeys);
     }
     return { title: `${baseTitle}${res[2]}`, example };
 }
+// When the title uses only some keys of an object row, report just those values,
+// the way Playwright shows only the parameters referenced in the title
+function reduceExample(example, placeholderKeys) {
+    if (example === null || typeof example !== 'object' || Array.isArray(example))
+        return example;
+    const usedKeys = placeholderKeys.filter(key => Object.hasOwn(example, key));
+    if (!usedKeys.length)
+        return example;
+    if (usedKeys.length === 1)
+        return example[usedKeys[0]];
+    return Object.fromEntries(usedKeys.map(key => [key, example[key]]));
+}
 function formatExample(example) {
     if (example !== null && typeof example === 'object')
         return JSON.stringify(example);

package/lib/bin/cli.js

@@ -26,6 +26,8 @@ const path_1 = __importDefault(require("path"));
 const debug = (0, debug_1.default)('@testomatio/reporter:cli');
 const version = (0, utils_js_1.getPackageVersion)();
 const program = new commander_1.Command();
+const FETCH_RUNS_DEFAULT_LIMIT = 30;
+const FETCH_RUNS_MAX_LIMIT = 100;
 program
     .version(version)
     .option('--env-file <envfile>', 'Load environment variables from env file')
@@ -116,6 +118,46 @@ program
         process.exit(0);
     });
 });
+program
+    .command('fetch')
+    .description('Fetch runs from Testomat.io API v2')
+    .option('--project <slug>', 'Project slug (or set TESTOMATIO_PROJECT)')
+    .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) => {
+    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;
+    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 response = await fetch(url, { headers: { Authorization: `Bearer ${apiKey}` } });
+    const body = await response.json();
+    if (!response.ok) {
+        log_js_1.log.error(picocolors_1.default.red(`Failed to fetch runs: ${response.status} ${body.error || response.statusText}`));
+        process.exit(1);
+    }
+    console.log((0, pipe_utils_js_1.formatFetchRunsOutput)(body, opts.format));
+});
 program
     .command('run')
     .alias('test')

package/lib/utils/pipe_utils.d.ts

@@ -121,6 +121,18 @@ export function formatRunOutput(store: {
     runUrl?: string;
     runPublicUrl?: string;
 }, 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;
+ * 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 {string} [format] - Value of the CLI `--format` option.
+ * @returns {string}
+ */
+export function formatFetchRunsOutput(body: {
+    data?: any[];
+}, format?: string): string;
 /**
  * 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

@@ -16,6 +16,7 @@ exports.plannedTestsLabel = plannedTestsLabel;
 exports.parsePipeOptions = parsePipeOptions;
 exports.formatFilterListIds = formatFilterListIds;
 exports.formatRunOutput = formatRunOutput;
+exports.formatFetchRunsOutput = formatFetchRunsOutput;
 exports.getObjectSize = getObjectSize;
 exports.splitTestsIntoChunks = splitTestsIntoChunks;
 const humanize_duration_1 = __importDefault(require("humanize-duration"));
@@ -324,6 +325,46 @@ function formatRunOutput(store, format) {
         output.runPublicUrl = store.runPublicUrl;
     return JSON.stringify(output);
 }
+/**
+ * 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;
+ * 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 {string} [format] - Value of the CLI `--format` option.
+ * @returns {string}
+ */
+function formatFetchRunsOutput(body, format) {
+    const runs = body?.data || [];
+    if (format === 'json')
+        return JSON.stringify(runs, null, 2);
+    if (format === 'id')
+        return runs.map(run => run.id).filter(Boolean).join('\n');
+    return runs
+        .map(run => {
+        const lines = [`* ID: ${run.id}`];
+        if (run.title)
+            lines.push(`  title: ${run.title}`);
+        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`);
+        if (run.failed_count != null)
+            lines.push(`  failed: ${run.failed_count} tests`);
+        if (run.skipped_count != null)
+            lines.push(`  skipped: ${run.skipped_count} tests`);
+        if (run.tests_count != null)
+            lines.push(`  tests_count: ${run.tests_count} tests`);
+        if (run.env)
+            lines.push(`  env: ${run.env}`);
+        if (run.ci_build_url)
+            lines.push(`  ci build url: ${run.ci_build_url}`);
+        return lines.join('\n');
+    })
+        .join('\n');
+}
 
 module.exports.updateFilterType = updateFilterType;
 
@@ -351,6 +392,8 @@ module.exports.formatFilterListIds = formatFilterListIds;
 
 module.exports.formatRunOutput = formatRunOutput;
 
+module.exports.formatFetchRunsOutput = formatFetchRunsOutput;
+
 module.exports.getObjectSize = getObjectSize;
 
 module.exports.splitTestsIntoChunks = splitTestsIntoChunks;

package/package.json

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

package/src/adapter/codecept.js

@@ -367,15 +367,30 @@ function stripExampleFromTitle(title) {
 
   let baseTitle = title.slice(0, res.index).trim();
   if (exampleParsed) {
+    const placeholderKeys = [...new Set([...baseTitle.matchAll(PLACEHOLDER_REGEXP)].map(match => match[1]))];
     baseTitle = baseTitle.replace(PLACEHOLDER_REGEXP, (placeholder, key) => {
+      // a placeholder matching a key of an object row resolves to that key's value
+      if (Object.hasOwn(example ?? {}, key)) return formatExample(example[key]);
       if (key === 'current') return formatExample(example);
-      if (!Object.hasOwn(example ?? {}, key)) return placeholder;
-      return formatExample(example[key]);
+      return placeholder;
     });
+    example = reduceExample(example, placeholderKeys);
   }
   return { title: `${baseTitle}${res[2]}`, example };
 }
 
+// When the title uses only some keys of an object row, report just those values,
+// the way Playwright shows only the parameters referenced in the title
+function reduceExample(example, placeholderKeys) {
+  if (example === null || typeof example !== 'object' || Array.isArray(example)) return example;
+
+  const usedKeys = placeholderKeys.filter(key => Object.hasOwn(example, key));
+  if (!usedKeys.length) return example;
+  if (usedKeys.length === 1) return example[usedKeys[0]];
+
+  return Object.fromEntries(usedKeys.map(key => [key, example[key]]));
+}
+
 function formatExample(example) {
   if (example !== null && typeof example === 'object') return JSON.stringify(example);
   return String(example);

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 } from '../utils/pipe_utils.js';
+import { formatFilterListIds, formatRunOutput, formatFetchRunsOutput } from '../utils/pipe_utils.js';
 import fs from 'fs';
 import path from 'path';
 
@@ -24,6 +24,9 @@ const debug = createDebugMessages('@testomatio/reporter:cli');
 const version = getPackageVersion();
 const program = new Command();
 
+const FETCH_RUNS_DEFAULT_LIMIT = 30;
+const FETCH_RUNS_MAX_LIMIT = 100;
+
 program
   .version(version)
   .option('--env-file <envfile>', 'Load environment variables from env file')
@@ -124,6 +127,56 @@ program
     });
   });
 
+program
+  .command('fetch')
+  .description('Fetch runs from Testomat.io API v2')
+  .option('--project <slug>', 'Project slug (or set TESTOMATIO_PROJECT)')
+  .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 => {
+    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;
+    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 response = await fetch(url, { headers: { Authorization: `Bearer ${apiKey}` } });
+    const body = await response.json();
+
+    if (!response.ok) {
+      log.error(pc.red(`Failed to fetch runs: ${response.status} ${body.error || response.statusText}`));
+      process.exit(1);
+    }
+
+    console.log(formatFetchRunsOutput(body, opts.format));
+  });
+
 program
   .command('run')
   .alias('test')

package/src/utils/pipe_utils.js

@@ -325,6 +325,39 @@ function formatRunOutput(store, format) {
   return JSON.stringify(output);
 }
 
+/**
+ * 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;
+ * 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 {string} [format] - Value of the CLI `--format` option.
+ * @returns {string}
+ */
+function formatFetchRunsOutput(body, format) {
+  const runs = body?.data || [];
+
+  if (format === 'json') return JSON.stringify(runs, null, 2);
+
+  if (format === 'id') return runs.map(run => run.id).filter(Boolean).join('\n');
+
+  return runs
+    .map(run => {
+      const lines = [`* ID: ${run.id}`];
+      if (run.title) lines.push(`  title: ${run.title}`);
+      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`);
+      if (run.failed_count != null) lines.push(`  failed: ${run.failed_count} tests`);
+      if (run.skipped_count != null) lines.push(`  skipped: ${run.skipped_count} tests`);
+      if (run.tests_count != null) lines.push(`  tests_count: ${run.tests_count} tests`);
+      if (run.env) lines.push(`  env: ${run.env}`);
+      if (run.ci_build_url) lines.push(`  ci build url: ${run.ci_build_url}`);
+      return lines.join('\n');
+    })
+    .join('\n');
+}
+
 export {
   updateFilterType,
   parseFilterParams,
@@ -339,6 +372,7 @@ export {
   parsePipeOptions,
   formatFilterListIds,
   formatRunOutput,
+  formatFetchRunsOutput,
   getObjectSize,
   splitTestsIntoChunks,
 };