@testomatio/reporter 2.8.4 → 2.8.5-beta.1-remote

package/lib/bin/cli.js

@@ -91,7 +91,19 @@ program
     .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('--kind <type>', 'Specify run type: automated, manual, or mixed')
+    .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]), [])
     .action(async (command, opts) => {
+    if (opts.remote) {
+        if (opts.filterList) {
+            log_js_1.log.warn(picocolors_1.default.red('⚠️  --filter-list cannot be combined with --remote'));
+            process.exit(1);
+        }
+        process.env.TESTOMATIO_CI_PROFILE = opts.remote;
+        if (opts.remoteParam?.length) {
+            process.env.TESTOMATIO_CI_PARAMS = opts.remoteParam.join(',');
+        }
+    }
     const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || config_js_1.config.TESTOMATIO;
     const title = process.env.TESTOMATIO_TITLE;
     const client = new client_js_1.default({ apiKey, title });
@@ -127,7 +139,7 @@ program
                 }
                 return;
             }
-            if (command && command.split) {
+            if (command && command.split && !opts.remote) {
                 command = (0, utils_js_1.applyFilter)(command, tests);
             }
         }
@@ -138,6 +150,31 @@ program
             return;
         }
     }
+    if (opts.remote) {
+        if (!apiKey) {
+            log_js_1.log.warn(picocolors_1.default.red('⚠️  TESTOMATIO API key required for --remote'));
+            process.exit(1);
+        }
+        if (command) {
+            log_js_1.log.warn(picocolors_1.default.yellow('Note: positional command is ignored when --remote is set; CI runs the workflow.'));
+        }
+        const createRunParams = {};
+        if (title)
+            createRunParams.title = title;
+        if (opts.kind)
+            createRunParams.kind = opts.kind;
+        try {
+            await client.createRun(createRunParams);
+        }
+        catch (err) {
+            log_js_1.log.warn(picocolors_1.default.red(`CI launch failed: ${err.message || err}`));
+            process.exit(1);
+        }
+        log_js_1.log.info(`🚀 CI build triggered on profile ${picocolors_1.default.cyan(opts.remote)}`);
+        if (client.pipeStore.runUrl)
+            log_js_1.log.info(`📊 Report URL: ${picocolors_1.default.magenta(client.pipeStore.runUrl)}`);
+        return process.exit(0);
+    }
     // just create a run (wich tests which match filters) without executing tests
     if (!command || !command.split) {
         const createRunParams = {};

package/lib/client.js

@@ -92,6 +92,8 @@ class Client {
             // Run only the selected pipe
             const rawResult = await p.prepareRun(pipeOptions);
             const result = Array.isArray(rawResult) ? rawResult : [];
+            // Expose resolved test ids to other pipes (e.g. TestomatioPipe builds `ci.grep` from this).
+            this.pipeStore.preparedTestIds = result;
             debug('Execution tests list', result);
             return result;
         }

package/lib/pipe/testomatio.d.ts

@@ -31,6 +31,8 @@ declare class TestomatioPipe implements Pipe {
     env: string;
     label: string;
     description: any;
+    ciProfile: string;
+    ciParams: Record<string, string>;
     client: Gaxios;
     proceed: boolean;
     jiraId: string;

package/lib/pipe/testomatio.js

@@ -15,6 +15,26 @@ const log_js_1 = require("../utils/log.js");
 const debug = (0, debug_1.default)('@testomatio/reporter:pipe:testomatio');
 if (process.env.TESTOMATIO_RUN)
     process.env.runId = process.env.TESTOMATIO_RUN;
+/**
+ * Parse `TESTOMATIO_CI_PARAMS` (comma-separated `key=value` pairs) into an object.
+ * Entries without `=` or with empty keys are skipped. Returns undefined when input is empty.
+ *
+ * @param {string|undefined} raw
+ * @returns {Record<string, string>|undefined}
+ */
+function parseCiParams(raw) {
+    if (!raw)
+        return undefined;
+    /** @type {Record<string, string>} */
+    const result = {};
+    for (const entry of raw.split(',')) {
+        const idx = entry.indexOf('=');
+        if (idx <= 0)
+            continue;
+        result[entry.slice(0, idx).trim()] = entry.slice(idx + 1);
+    }
+    return Object.keys(result).length ? result : undefined;
+}
 /**
  * @typedef {import('../../types/types.js').Pipe} Pipe
  * @typedef {import('../../types/types.js').TestData} TestData
@@ -68,6 +88,12 @@ class TestomatioPipe {
         this.env = process.env.TESTOMATIO_ENV;
         this.label = process.env.TESTOMATIO_LABEL;
         this.description = params.description || process.env.TESTOMATIO_DESCRIPTION;
+        // Remote CI launch — when `TESTOMATIO_CI_PROFILE` is set the run will be created
+        // on the server *and* the named CI profile will be dispatched. Optional
+        // `TESTOMATIO_CI_PARAMS` is a comma-separated list of `key=value` pairs
+        // forwarded to the CI profile config (e.g. `branch=develop,REGION=eu`).
+        this.ciProfile = process.env.TESTOMATIO_CI_PROFILE;
+        this.ciParams = parseCiParams(process.env.TESTOMATIO_CI_PARAMS);
         // Create a new instance of gaxios with a custom config
         this.client = new gaxios_1.Gaxios({
             baseURL: `${this.url.trim()}`,
@@ -213,6 +239,19 @@ class TestomatioPipe {
                 this.store.configuration = { ...(this.store.configuration || {}), ...params.configuration };
             }
         }
+        // Assemble the `ci` block when the user asked for a remote CI launch via
+        // TESTOMATIO_CI_PROFILE (e.g. `--remote github`). Grep is taken from whatever
+        // `--filter` resolution already stashed in the shared pipeStore.
+        /** @type {{profile: string, grep?: string, override?: Record<string, any>}|null} */
+        let ci = null;
+        if (this.ciProfile) {
+            ci = { profile: this.ciProfile };
+            const grepIds = this.store?.preparedTestIds;
+            if (grepIds?.length)
+                ci.grep = grepIds.join('|');
+            if (this.ciParams)
+                ci.override = this.ciParams;
+        }
         const runParams = Object.fromEntries(Object.entries({
             ci_build_url: buildUrl,
             api_key: this.apiKey.trim(),
@@ -227,6 +266,7 @@ class TestomatioPipe {
             kind: params.kind,
             configuration,
             description,
+            ci,
         }).filter(([, value]) => !!value));
         debug(' >>>>>> Run params', JSON.stringify(runParams, null, 2));
         if (this.runId) {

package/package.json

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

package/src/bin/cli.js

@@ -97,7 +97,25 @@ program
   .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('--kind <type>', 'Specify run type: automated, manual, or mixed')
+  .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]),
+    [],
+  )
   .action(async (command, opts) => {
+    if (opts.remote) {
+      if (opts.filterList) {
+        log.warn(pc.red('⚠️  --filter-list cannot be combined with --remote'));
+        process.exit(1);
+      }
+      process.env.TESTOMATIO_CI_PROFILE = opts.remote;
+      if (opts.remoteParam?.length) {
+        process.env.TESTOMATIO_CI_PARAMS = opts.remoteParam.join(',');
+      }
+    }
+
     const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || config.TESTOMATIO;
     const title = process.env.TESTOMATIO_TITLE;
     const client = new TestomatClient({ apiKey, title });
@@ -137,7 +155,7 @@ program
           return;
         }
 
-        if (command && command.split) {
+        if (command && command.split && !opts.remote) {
           command = applyFilter(command, tests);
         }
       }
@@ -148,6 +166,31 @@ program
       }
     }
 
+    if (opts.remote) {
+      if (!apiKey) {
+        log.warn(pc.red('⚠️  TESTOMATIO API key required for --remote'));
+        process.exit(1);
+      }
+      if (command) {
+        log.warn(pc.yellow('Note: positional command is ignored when --remote is set; CI runs the workflow.'));
+      }
+
+      const createRunParams = {};
+      if (title) createRunParams.title = title;
+      if (opts.kind) createRunParams.kind = opts.kind;
+
+      try {
+        await client.createRun(createRunParams);
+      } catch (err) {
+        log.warn(pc.red(`CI launch failed: ${err.message || err}`));
+        process.exit(1);
+      }
+
+      log.info(`🚀 CI build triggered on profile ${pc.cyan(opts.remote)}`);
+      if (client.pipeStore.runUrl) log.info(`📊 Report URL: ${pc.magenta(client.pipeStore.runUrl)}`);
+      return process.exit(0);
+    }
+
     // just create a run (wich tests which match filters) without executing tests
     if (!command || !command.split) {
       const createRunParams = {};

package/src/client.js

@@ -102,6 +102,9 @@ class Client {
       const rawResult = await p.prepareRun(pipeOptions);
       const result = Array.isArray(rawResult) ? rawResult : [];
 
+      // Expose resolved test ids to other pipes (e.g. TestomatioPipe builds `ci.grep` from this).
+      this.pipeStore.preparedTestIds = result;
+
       debug('Execution tests list', result);
 
       return result;

package/src/pipe/testomatio.js

@@ -24,6 +24,25 @@ const debug = createDebugMessages('@testomatio/reporter:pipe:testomatio');
 
 if (process.env.TESTOMATIO_RUN) process.env.runId = process.env.TESTOMATIO_RUN;
 
+/**
+ * Parse `TESTOMATIO_CI_PARAMS` (comma-separated `key=value` pairs) into an object.
+ * Entries without `=` or with empty keys are skipped. Returns undefined when input is empty.
+ *
+ * @param {string|undefined} raw
+ * @returns {Record<string, string>|undefined}
+ */
+function parseCiParams(raw) {
+  if (!raw) return undefined;
+  /** @type {Record<string, string>} */
+  const result = {};
+  for (const entry of raw.split(',')) {
+    const idx = entry.indexOf('=');
+    if (idx <= 0) continue;
+    result[entry.slice(0, idx).trim()] = entry.slice(idx + 1);
+  }
+  return Object.keys(result).length ? result : undefined;
+}
+
 /**
  * @typedef {import('../../types/types.js').Pipe} Pipe
  * @typedef {import('../../types/types.js').TestData} TestData
@@ -85,6 +104,13 @@ class TestomatioPipe {
     this.label = process.env.TESTOMATIO_LABEL;
     this.description = params.description || process.env.TESTOMATIO_DESCRIPTION;
 
+    // Remote CI launch — when `TESTOMATIO_CI_PROFILE` is set the run will be created
+    // on the server *and* the named CI profile will be dispatched. Optional
+    // `TESTOMATIO_CI_PARAMS` is a comma-separated list of `key=value` pairs
+    // forwarded to the CI profile config (e.g. `branch=develop,REGION=eu`).
+    this.ciProfile = process.env.TESTOMATIO_CI_PROFILE;
+    this.ciParams = parseCiParams(process.env.TESTOMATIO_CI_PARAMS);
+
     // Create a new instance of gaxios with a custom config
     this.client = new Gaxios({
       baseURL: `${this.url.trim()}`,
@@ -248,6 +274,18 @@ class TestomatioPipe {
         this.store.configuration = { ...(this.store.configuration || {}), ...params.configuration };
       }
     }
+
+    // Assemble the `ci` block when the user asked for a remote CI launch via
+    // TESTOMATIO_CI_PROFILE (e.g. `--remote github`). Grep is taken from whatever
+    // `--filter` resolution already stashed in the shared pipeStore.
+    /** @type {{profile: string, grep?: string, override?: Record<string, any>}|null} */
+    let ci = null;
+    if (this.ciProfile) {
+      ci = { profile: this.ciProfile };
+      const grepIds = this.store?.preparedTestIds;
+      if (grepIds?.length) ci.grep = grepIds.join('|');
+      if (this.ciParams) ci.override = this.ciParams;
+    }
     const runParams = Object.fromEntries(
       Object.entries({
         ci_build_url: buildUrl,
@@ -263,6 +301,7 @@ class TestomatioPipe {
         kind: params.kind,
         configuration,
         description,
+        ci,
       }).filter(([, value]) => !!value),
     );
     debug(' >>>>>> Run params', JSON.stringify(runParams, null, 2));

package/types/types.d.ts

@@ -293,7 +293,7 @@ export interface Pipe {
   store: {};
 
   /** starts run  */
-  createRun(): Promise<void>;
+  createRun(params?: CreateRunParams): Promise<void>;
 
   /** adds a test to the current run */
   addTest(test: TestData): any;
@@ -316,6 +316,28 @@ export interface PipeResult {
   result?: any;
 }
 
+/**
+ * Parameters accepted by `Client.createRun`.
+ *
+ * Remote CI launch (via `--remote <profile>` / matching `TESTOMATIO_CI_PROFILE`
+ * env var) is **not** passed through this object — `TestomatioPipe` reads the
+ * env vars directly and assembles the request body. See
+ * `TESTOMATIO_CI_PROFILE` and `TESTOMATIO_CI_OVERRIDE`.
+ */
+export interface CreateRunParams {
+  /** Run kind. Defaults to `automated` server-side. */
+  kind?: 'automated' | 'manual' | 'mixed';
+
+  /** Run title. */
+  title?: string;
+
+  /** Run configuration merged into the server-side run configuration. */
+  configuration?: Record<string, any>;
+
+  /** Override batch upload on/off. */
+  isBatchEnabled?: boolean;
+}
+
 /**
  * Represents a step in a test.
  */