@testomatio/reporter 2.14.0 → 2.15.0-beta.1-json-output

package/lib/bin/cli.js

@@ -55,7 +55,7 @@ program
     .description('Start a new run and return its ID')
     .option('--kind <type>', 'Specify run type: automated, manual, mixed, or detect')
     .option('--filter <filter>', 'Scope the prepared run to tests matching the filter (no execution)')
-    .option('--format <format>', 'Machine-readable output: print only the run id to stdout (e.g. --format id)')
+    .option('--format <format>', 'Machine-readable output: the run id (--format id) or run details (--format json)')
     .option('--warn', 'Exit 0 instead of 1 when the filter matches no tests (warn only)')
     .action(async (opts) => {
     (0, utils_js_1.cleanLatestRunId)();
@@ -89,8 +89,8 @@ program
     // pipes add their report now and replace it when the run is finished
     const plannedTests = (client.pipeStore.preparedTestIds || []).map(id => ({ test_id: id, title: id }));
     await client.updateRunStatus('pending', { tests: plannedTests });
-    // stdout carries ONLY the run id so it can be captured: RUN_ID=$(reporter start)
-    console.log(runId);
+    // stdout carries ONLY the run data so it can be captured: RUN_ID=$(reporter start)
+    console.log((0, pipe_utils_js_1.formatRunOutput)({ ...client.pipeStore, runId }, opts.format));
     process.exit(0);
 });
 program
@@ -120,7 +120,7 @@ program
     .argument('[command]', 'Test runner command')
     .option('--filter <filter>', 'Additional execution filter')
     .option('--filter-list <filter>', 'Get a list of all tests by filter before running')
-    .option('--format <format>', 'Machine-readable output format for --filter-list (grep, json, newline, ids)')
+    .option('--format <format>', 'Machine-readable output: test ids for --filter-list (grep, json, newline, ids), or the run created (id, json)')
     .option('--kind <type>', 'Specify run type: automated, manual, mixed, or detect')
     .option('--remote <profile>', 'Trigger run on the named Testomat.io CI profile instead of executing locally')
     .option('--remote-param <kv>', 'key=value pair forwarded to the CI profile config (repeat for multiple)', (value, prev) => prev.concat([value]), [])
@@ -210,6 +210,9 @@ program
         }
         log_js_1.log.info(`🚀 CI build triggered on profile ${picocolors_1.default.cyan(opts.remote)}`);
         log_js_1.log.info(`📊 Report URL: ${picocolors_1.default.magenta(client.pipeStore.runUrl)}`);
+        const remoteOutput = (0, pipe_utils_js_1.formatRunOutput)(client.pipeStore, opts.format);
+        if (opts.format && remoteOutput)
+            console.log(remoteOutput);
         return process.exit(0);
     }
     // just create a run (wich tests which match filters) without executing tests
@@ -230,6 +233,9 @@ program
                 log_js_1.log.info(`No command passed, so you need to run tests yourself:`);
                 log_js_1.log.info(`TESTOMATIO_RUN=${runId} <command>`);
             }
+            const runOutput = (0, pipe_utils_js_1.formatRunOutput)({ ...client.pipeStore, runId }, opts.format);
+            if (opts.format && runOutput)
+                console.log(runOutput);
         }
         else {
             log_js_1.log.info('⚠️  No API key provided. Cannot create run without TESTOMATIO key.');
@@ -262,7 +268,12 @@ program
         createRunParams.kind = opts.kind;
     }
     if (apiKey) {
-        await client.createRun(createRunParams).then(runTests);
+        await client.createRun(createRunParams);
+        // the runner inherits stdout, so the run data is printed first, on its own line
+        const createdOutput = (0, pipe_utils_js_1.formatRunOutput)(client.pipeStore, opts.format);
+        if (opts.format && createdOutput)
+            console.log(createdOutput);
+        await runTests();
     }
     else {
         await runTests();

package/lib/utils/pipe_utils.d.ts

@@ -108,6 +108,19 @@ export function parsePipeOptions(optionsStr?: string): any;
  * @returns {string} Empty string if no ids; otherwise the formatted output.
  */
 export function formatFilterListIds(ids: string[], format: "grep" | "json" | "newline" | "ids"): string;
+/**
+ * Format the created run for machine-readable output of `start` and `run`.
+ * `json` prints an object with the run details, any other format prints the bare run id.
+ *
+ * @param {{runId?: string, runUrl?: string, runPublicUrl?: string}} store - Pipe store of the client.
+ * @param {string} [format] - Value of the CLI `--format` option.
+ * @returns {string} Empty string if there is no run id.
+ */
+export function formatRunOutput(store: {
+    runId?: string;
+    runUrl?: string;
+    runPublicUrl?: string;
+}, 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

@@ -15,6 +15,7 @@ exports.totalDuration = totalDuration;
 exports.plannedTestsLabel = plannedTestsLabel;
 exports.parsePipeOptions = parsePipeOptions;
 exports.formatFilterListIds = formatFilterListIds;
+exports.formatRunOutput = formatRunOutput;
 exports.getObjectSize = getObjectSize;
 exports.splitTestsIntoChunks = splitTestsIntoChunks;
 const humanize_duration_1 = __importDefault(require("humanize-duration"));
@@ -302,6 +303,27 @@ function plannedTestsLabel(tests, testsCount) {
         return `**${suitesCount}** suites planned`;
     return `**${knownTestsCount}** tests and **${suitesCount}** suites planned`;
 }
+/**
+ * Format the created run for machine-readable output of `start` and `run`.
+ * `json` prints an object with the run details, any other format prints the bare run id.
+ *
+ * @param {{runId?: string, runUrl?: string, runPublicUrl?: string}} store - Pipe store of the client.
+ * @param {string} [format] - Value of the CLI `--format` option.
+ * @returns {string} Empty string if there is no run id.
+ */
+function formatRunOutput(store, format) {
+    const runId = store?.runId;
+    if (!runId)
+        return '';
+    if (format !== 'json')
+        return runId;
+    const output = { runId };
+    if (store.runUrl)
+        output.runUrl = store.runUrl;
+    if (store.runPublicUrl)
+        output.runPublicUrl = store.runPublicUrl;
+    return JSON.stringify(output);
+}
 
 module.exports.updateFilterType = updateFilterType;
 
@@ -327,6 +349,8 @@ module.exports.parsePipeOptions = parsePipeOptions;
 
 module.exports.formatFilterListIds = formatFilterListIds;
 
+module.exports.formatRunOutput = formatRunOutput;
+
 module.exports.getObjectSize = getObjectSize;
 
 module.exports.splitTestsIntoChunks = splitTestsIntoChunks;

package/package.json

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

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 } from '../utils/pipe_utils.js';
+import { formatFilterListIds, formatRunOutput } from '../utils/pipe_utils.js';
 import fs from 'fs';
 import path from 'path';
 
@@ -53,7 +53,7 @@ program
   .description('Start a new run and return its ID')
   .option('--kind <type>', 'Specify run type: automated, manual, mixed, or detect')
   .option('--filter <filter>', 'Scope the prepared run to tests matching the filter (no execution)')
-  .option('--format <format>', 'Machine-readable output: print only the run id to stdout (e.g. --format id)')
+  .option('--format <format>', 'Machine-readable output: the run id (--format id) or run details (--format json)')
   .option('--warn', 'Exit 0 instead of 1 when the filter matches no tests (warn only)')
   .action(async opts => {
     cleanLatestRunId();
@@ -93,8 +93,8 @@ program
     const plannedTests = (client.pipeStore.preparedTestIds || []).map(id => ({ test_id: id, title: id }));
     await client.updateRunStatus('pending', { tests: plannedTests });
 
-    // stdout carries ONLY the run id so it can be captured: RUN_ID=$(reporter start)
-    console.log(runId);
+    // stdout carries ONLY the run data so it can be captured: RUN_ID=$(reporter start)
+    console.log(formatRunOutput({ ...client.pipeStore, runId }, opts.format));
     process.exit(0);
   });
 
@@ -129,7 +129,10 @@ program
   .argument('[command]', 'Test runner command')
   .option('--filter <filter>', 'Additional execution filter')
   .option('--filter-list <filter>', 'Get a list of all tests by filter before running')
-  .option('--format <format>', 'Machine-readable output format for --filter-list (grep, json, newline, ids)')
+  .option(
+    '--format <format>',
+    'Machine-readable output: test ids for --filter-list (grep, json, newline, ids), or the run created (id, json)',
+  )
   .option('--kind <type>', 'Specify run type: automated, manual, mixed, or detect')
   .option('--remote <profile>', 'Trigger run on the named Testomat.io CI profile instead of executing locally')
   .option(
@@ -230,6 +233,8 @@ program
 
       log.info(`🚀 CI build triggered on profile ${pc.cyan(opts.remote)}`);
       log.info(`📊 Report URL: ${pc.magenta(client.pipeStore.runUrl)}`);
+      const remoteOutput = formatRunOutput(client.pipeStore, opts.format);
+      if (opts.format && remoteOutput) console.log(remoteOutput);
       return process.exit(0);
     }
 
@@ -252,6 +257,8 @@ program
           log.info( `No command passed, so you need to run tests yourself:`);
           log.info( `TESTOMATIO_RUN=${runId} <command>`);
         }
+        const runOutput = formatRunOutput({ ...client.pipeStore, runId }, opts.format);
+        if (opts.format && runOutput) console.log(runOutput);
       } else {
         log.info( '⚠️  No API key provided. Cannot create run without TESTOMATIO key.');
         process.exit(1);
@@ -288,7 +295,11 @@ program
     }
 
     if (apiKey) {
-      await client.createRun(createRunParams).then(runTests);
+      await client.createRun(createRunParams);
+      // the runner inherits stdout, so the run data is printed first, on its own line
+      const createdOutput = formatRunOutput(client.pipeStore, opts.format);
+      if (opts.format && createdOutput) console.log(createdOutput);
+      await runTests();
     } else {
       await runTests();
     }

package/src/utils/pipe_utils.js

@@ -304,6 +304,27 @@ function plannedTestsLabel(tests, testsCount) {
   return `**${knownTestsCount}** tests and **${suitesCount}** suites planned`;
 }
 
+/**
+ * Format the created run for machine-readable output of `start` and `run`.
+ * `json` prints an object with the run details, any other format prints the bare run id.
+ *
+ * @param {{runId?: string, runUrl?: string, runPublicUrl?: string}} store - Pipe store of the client.
+ * @param {string} [format] - Value of the CLI `--format` option.
+ * @returns {string} Empty string if there is no run id.
+ */
+function formatRunOutput(store, format) {
+  const runId = store?.runId;
+  if (!runId) return '';
+
+  if (format !== 'json') return runId;
+
+  const output = { runId };
+  if (store.runUrl) output.runUrl = store.runUrl;
+  if (store.runPublicUrl) output.runPublicUrl = store.runPublicUrl;
+
+  return JSON.stringify(output);
+}
+
 export {
   updateFilterType,
   parseFilterParams,
@@ -317,6 +338,7 @@ export {
   plannedTestsLabel,
   parsePipeOptions,
   formatFilterListIds,
+  formatRunOutput,
   getObjectSize,
   splitTestsIntoChunks,
 };