testomatio-reporter-cli 2.19.0 → 2.21.0

package/src/utils/detectRunner.js

@@ -0,0 +1,151 @@
+import fs from 'fs';
+import path from 'path';
+import pc from 'picocolors';
+
+const LAUNCHER_PREFIXES = ['npx', 'npm', 'yarn', 'pnpm', 'bun', 'node', 'bunx'];
+
+const PLACEHOLDER_PHRASE_RE = /^<?-*(?:run|your|test)\s+(?:[\w-]+\s+)?(?:tests?|command|runner)>?$/i;
+
+const RUNNERS = [
+  {
+    name: 'Playwright',
+    configs: ['playwright.config.js', 'playwright.config.ts', 'playwright.config.mjs', 'playwright.config.cjs'],
+    dependencies: ['@playwright/test'],
+    command: 'npx playwright test',
+  },
+  {
+    name: 'CodeceptJS',
+    configs: ['codecept.conf.js', 'codecept.conf.ts'],
+    dependencies: ['codeceptjs'],
+    command: 'npx codeceptjs run',
+  },
+  {
+    name: 'WebdriverIO',
+    configs: ['wdio.conf.js', 'wdio.conf.ts'],
+    dependencies: ['@wdio/cli'],
+    dependencyPrefix: '@wdio/',
+    command: 'npx wdio run ./wdio.conf.js',
+  },
+  {
+    name: 'Cypress',
+    configs: ['cypress.config.js', 'cypress.config.ts'],
+    dependencies: ['cypress'],
+    command: 'npx cypress run',
+  },
+  {
+    name: 'Jest',
+    configs: ['jest.config.js', 'jest.config.ts', 'jest.config.mjs', 'jest.config.cjs', 'jest.config.json'],
+    dependencies: ['jest'],
+    command: 'npx jest',
+  },
+  {
+    name: 'Vitest',
+    configs: ['vitest.config.js', 'vitest.config.ts', 'vitest.config.mjs'],
+    dependencies: ['vitest'],
+    command: 'npx vitest run',
+  },
+  {
+    name: 'Mocha',
+    configs: ['.mocharc.js', '.mocharc.cjs', '.mocharc.json', '.mocharc.yml', '.mocharc.yaml'],
+    dependencies: ['mocha'],
+    command: 'npx mocha',
+  },
+  {
+    name: 'Cucumber',
+    configs: ['cucumber.js', 'cucumber.cjs'],
+    dependencies: ['@cucumber/cucumber'],
+    command: 'npx cucumber-js',
+  },
+];
+
+/**
+ * @param {string} command
+ * @returns {boolean}
+ */
+function isPlaceholderCommand(command) {
+  const cmd = (command || '').trim();
+  if (!cmd) return false;
+
+  if (cmd.includes('<') || cmd.includes('>')) return true;
+
+  const firstToken = cmd.split(/\s+/)[0].toLowerCase();
+  if (LAUNCHER_PREFIXES.includes(firstToken)) return false;
+
+  return PLACEHOLDER_PHRASE_RE.test(cmd);
+}
+
+/**
+ * @param {string} cwd
+ * @returns {Record<string, string>}
+ */
+function readPackageDependencies(cwd) {
+  try {
+    const pkg = JSON.parse(fs.readFileSync(path.join(cwd, 'package.json'), 'utf8'));
+    return { ...(pkg.dependencies || {}), ...(pkg.devDependencies || {}) };
+  } catch {
+    return {};
+  }
+}
+
+/**
+ * @param {string} [cwd]
+ * @returns {{ name: string, command: string } | null}
+ */
+function detectRunner(cwd = process.cwd()) {
+  const dependencies = readPackageDependencies(cwd);
+
+  for (const runner of RUNNERS) {
+    const config = runner.configs.find(file => fs.existsSync(path.join(cwd, file)));
+
+    const hasDependency = runner.dependencies?.some(dep => dependencies[dep])
+      || (runner.dependencyPrefix && Object.keys(dependencies).some(dep => dep.startsWith(runner.dependencyPrefix)));
+
+    if (!config && !hasDependency) continue;
+
+    let command = runner.command;
+    if (runner.name === 'WebdriverIO') {
+      command = `npx wdio run ./${config || 'wdio.conf.js'}`;
+    }
+
+    return { name: runner.name, command };
+  }
+
+  return null;
+}
+
+/**
+ * @param {string} [cwd]
+ * @returns {string}
+ */
+function runnerHint(cwd = process.cwd()) {
+  const runner = detectRunner(cwd);
+  if (runner) {
+    return `💡 Looks like this project uses ${runner.name}. Try: ${pc.green(runner.command)}`;
+  }
+  return `💡 Replace the placeholder with your test runner command, e.g. ${pc.green('npx playwright test')}`;
+}
+
+/**
+ * @param {string} command
+ * @returns {string[]}
+ */
+function buildFilterWarning(command) {
+  return [
+    '⚠️  The runner exited with a non-zero code while a Testomat.io filter was applied.',
+    'Your command was modified to run only tests matching Testomat IDs:',
+    `  ${pc.bold(command)}`,
+    'This usually means no local tests matched the filter:',
+    '  - tests are not annotated with the matching @Txxxxxx IDs in their titles',
+    '  - the filter selected tests from another repository or branch',
+    '  - the test runner does not support the appended --grep / --testNamePattern option',
+    '💡 Hint: run the printed command without the appended filter option to see all your tests,',
+    'then annotate them with Testomat IDs.',
+  ];
+}
+
+export {
+  isPlaceholderCommand,
+  detectRunner,
+  runnerHint,
+  buildFilterWarning,
+};

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;
     }
   }
 }