@testomatio/reporter 2.6.0-beta.1.allure → 2.6.1

package/lib/utils/log-formatter.d.ts

@@ -25,5 +25,4 @@ export function formatError(error: Error & {
     actual?: any;
     expected?: any;
 }, message?: string): string;
-export const stripColors: typeof stripVTControlCharacters;
-import { stripVTControlCharacters } from 'util';
+export function stripColors(str: string): string;

package/lib/utils/log-formatter.js

@@ -114,10 +114,14 @@ function formatError(error, message) {
  * @returns {boolean}
  */
 function isNotInternalFrame(frame) {
-    return (frame.getFileName() &&
-        frame.getFileName().includes(path_1.sep) &&
-        !frame.getFileName().includes('node_modules') &&
-        !frame.getFileName().includes('internal'));
+    const fileName = frame.getFileName();
+    if (!fileName)
+        return false;
+    const isFileUrl = fileName.startsWith('file://');
+    const hasPathSeparator = fileName.includes(path_1.sep) || fileName.includes('/') || isFileUrl;
+    return (hasPathSeparator &&
+        !fileName.includes('node_modules') &&
+        !fileName.includes('internal'));
 }
 
 module.exports.formatLogs = formatLogs;

package/lib/utils/utils.js

@@ -311,15 +311,6 @@ const fetchSourceCode = (contents, opts = {}) => {
             if (lineIndex === -1)
                 lineIndex = lines.findIndex(l => l.includes(`${title}(`));
         }
-        else if (opts.lang === 'kotlin') {
-            lineIndex = lines.findIndex(l => l.includes(`fun test${title}`));
-            if (lineIndex === -1)
-                lineIndex = lines.findIndex(l => l.includes(`@DisplayName("${title}`));
-            if (lineIndex === -1)
-                lineIndex = lines.findIndex(l => l.includes(`fun ${title}`));
-            if (lineIndex === -1)
-                lineIndex = lines.findIndex(l => l.includes(`${title}(`));
-        }
         else if (opts.lang === 'csharp') {
             // Find the method declaration line
             let methodLineIndex = lines.findIndex(l => l.includes(`public void ${title}(`));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "2.6.0-beta.1.allure",
+  "version": "2.6.1",
   "description": "Testomatio Reporter Client",
   "engines": {
     "node": ">=18"
@@ -24,7 +24,7 @@
     "csv-writer": "^1.6.0",
     "debug": "4.3.4",
     "dotenv": "^16.0.1",
-    "fast-xml-parser": "^4.4.1",
+    "fast-xml-parser": "^5.3.4",
     "file-url": "3.0.0",
     "filesize": "^10.1.6",
     "gaxios": ">=6.0 || >=7.0.0-rc.4 || <8",

package/src/adapter/playwright.js

@@ -1,4 +1,3 @@
-import pc from 'picocolors';
 import crypto from 'crypto';
 import os from 'os';
 import path from 'path';
@@ -10,6 +9,8 @@ import { getTestomatIdFromTestTitle, fileSystem } from '../utils/utils.js';
 import { services } from '../services/index.js';
 import { dataStorage } from '../data-storage.js';
 import { extensionMap } from '../utils/constants.js';
+import pc from 'picocolors';
+import { fetchLinksFromLogs } from './utils/playwright.js';
 
 const reportTestPromises = [];
 
@@ -41,6 +42,16 @@ class PlaywrightReporter {
 
     const { title } = test;
     const { error, duration } = result;
+    const pwAttachments = (result.attachments || []).filter(a => a.body || a.path);
+
+    const files = pwAttachments
+      .map(att => ({
+        path: this.#getArtifactPath(att),
+        title: att.name || title,
+        type: att.contentType,
+      }))
+      .filter(f => f.path);
+
     const suite_title = test.parent ? test.parent?.title : path.basename(test?.location?.file);
 
     const steps = [];
@@ -55,13 +66,26 @@ class PlaywrightReporter {
     const tags = extractTags(test);
 
     const fullTestTitle = getTestContextName(test);
+
     let logs = '';
-    if (result.stderr.length || result.stdout.length) {
-      logs = `\n\n${pc.bold('Logs:')}\n${pc.red(result.stderr.join(''))}\n${result.stdout.join('')}`;
+    // get links along with filtered logs (liks related logs removed)
+    const { stdout: filteredStdout, links, meta } = fetchLinksFromLogs(result.stdout);
+    if (filteredStdout?.length || result.stderr?.length) {
+      logs = `\n\n${pc.bold('Logs:')}\n${pc.red(result.stderr.join(''))}\n${filteredStdout.join('')}`;
     }
+
+    /*
+      All services fucntions work different for Playwright.
+      We don't have access to test title (as result, to test id) when calling this functions inside a test.
+      Thus, when user calls services functions inside a test, we just log this data to console.
+      Playwright intercepts the console.log on it's end and we just get this data from it.
+      Thus, we have a tiny drawback: all data from services functions inside a test will be logged to console.
+      And this requires a condition to be added for each service function – if its Playwright, then log to console.
+
+      "get" method of services will not return data for Playwright, we should parse stdout.
+    */
     const manuallyAttachedArtifacts = services.artifacts.get(fullTestTitle);
     const testMeta = services.keyValues.get(fullTestTitle);
-    const links = services.links.get(fullTestTitle);
     const rid = test.id || test.testId || uuidv4();
 
     /**
@@ -102,12 +126,14 @@ class PlaywrightReporter {
       logs,
       links,
       manuallyAttachedArtifacts,
+      files: files.length ? files : undefined,
       meta: {
         browser: project.browser,
         isMobile: project.isMobile,
         project: project.name,
         projectDependencies: project.dependencies?.length ? project.dependencies : null,
         ...testMeta,
+        ...meta,
         ...project.metadata, // metadata has any type (in playwright), but we will stringify it in client.js
         ...test.annotations?.reduce((acc, annotation) => {
           acc[annotation.type] = annotation.description;
@@ -120,7 +146,7 @@ class PlaywrightReporter {
     this.uploads.push({
       rid: `${rid}-${project.name}`,
       title: test.title,
-      files: result.attachments.filter(a => a.body || a.path),
+      files: pwAttachments,
       file: test.location?.file,
     });
     // remove empty uploads
@@ -289,4 +315,4 @@ function getTestContextName(test) {
 }
 
 export default PlaywrightReporter;
-export { extractTags };
+export { extractTags, fetchLinksFromLogs };

package/src/adapter/utils/playwright.js

@@ -0,0 +1,121 @@
+import createDebugMessages from 'debug';
+const debug = createDebugMessages('@testomatio/reporter:adapter-playwright-utils');
+
+export const playwrightLogsMarkers = {
+  label: '[TESTOMATIO-LABEL]',
+  meta: '[TESTOMATIO-META]',
+  linkTest: '[TESTOMATIO-LINK-TEST]',
+  linkJira: '[TESTOMATIO-LINK-JIRA]',
+};
+
+/**
+ * Fetches links from stdout. Returns links and filtered stdout (without data containing markers)
+ *
+ * @param {(string | Buffer)[]} stdout
+ * @returns {{
+ *   links: { [key: 'test' | 'jira' | 'label']: string }[],
+ *   meta: { [key: string]: any },
+ *   stdout: (string | Buffer)[]
+ * }}
+ */
+export function fetchLinksFromLogs(stdout) {
+  const links = [];
+  const meta = {};
+
+  const markers = [
+    { key: playwrightLogsMarkers.linkTest, type: 'test' },
+    { key: playwrightLogsMarkers.linkJira, type: 'jira' },
+    { key: playwrightLogsMarkers.label, type: 'label' },
+    { key: playwrightLogsMarkers.meta, type: 'meta' },
+  ];
+
+  const filteredStdout = [];
+
+  stdout.forEach(entry => {
+    if (typeof entry !== 'string') {
+      filteredStdout.push(entry);
+      return;
+    }
+
+    // check if entry contains any of markers
+    if (!markers.some(m => entry.includes(m.key))) {
+      filteredStdout.push(entry);
+      return;
+    }
+
+    const newEntryLines = [];
+    entry.split('\n').forEach(line => {
+      line = line.trim();
+      let hasMarker = false;
+      for (const marker of markers) {
+        // links (test/jira/label) stored as array of objects
+        if (line.includes(marker.key)) {
+          hasMarker = true;
+          try {
+            const rawData = line.split(marker.key)[1]?.trim();
+            if (!rawData) continue;
+
+            let data;
+            try {
+              data = JSON.parse(rawData);
+            } catch (e) {
+              // Try to extract JSON from the beginning of the string (to handle trailing text)
+              const jsonMatch = rawData.match(/^\s*(\[.*?\]|\{.*?\})/);
+              if (jsonMatch) {
+                try {
+                  data = JSON.parse(jsonMatch[1]);
+                } catch (jsonError) {
+                  // If JSON extraction fails, skip this entry
+                  debug('Error parsing links from string:', line, '\n', jsonError);
+                  continue;
+                }
+              } else {
+                // No JSON found, skip this entry
+                debug('No valid JSON found in:', line);
+                continue;
+              }
+            }
+
+            if (marker.type === 'meta') {
+              // meta stored as an object, thus make it similar to links
+              Object.assign(meta, data);
+            } else {
+              const ids = Array.isArray(data) ? data : [data];
+              links.push(
+                ...ids
+                  // filter non-truthy ids
+                  .filter(id => !!id)
+                  .map(id => {
+                    // If id is already an object with the marker type key, return it as is
+                    if (typeof id === 'object' && id !== null && marker.type in id) {
+                      return id;
+                    }
+                    // Otherwise, wrap it with the marker type key
+                    return {
+                      // marker type is either 'test' or 'jira' or 'label'
+                      [marker.type]: id,
+                    };
+                  }),
+              );
+            }
+          } catch (e) {
+            debug('Error parsing links from string:', line, '\n', e);
+          }
+        }
+      }
+      if (!hasMarker && line) {
+        newEntryLines.push(line);
+      }
+    });
+
+    if (newEntryLines.length) {
+      filteredStdout.push(newEntryLines.join('\n'));
+    }
+  });
+
+  return {
+    stdout: filteredStdout,
+    links,
+    meta,
+  };
+}

package/src/adapter/vitest.js

@@ -101,7 +101,7 @@ class VitestReporter {
    *
    * @param {VitestTest} test
    *
-   * @returns {TestData & {status: string}}
+   * @returns {TestData & {status: 'passed' | 'failed' | 'skipped'}}
    */
   #getDataFromTest(test) {
     return {
@@ -109,6 +109,7 @@ class VitestReporter {
       file: test.file.name,
       logs: test.logs ? transformLogsToString(test.logs) : '',
       meta: test.meta,
+      // @ts-ignore - STATUS values are string literals but type system sees them as string
       status: getTestStatus(test),
       suite_title: test.suite.name || test.file?.name,
       test_id: getTestomatIdFromTestTitle(test.name),

package/src/bin/cli.js

@@ -6,7 +6,6 @@ import { glob } from 'glob';
 import createDebugMessages from 'debug';
 import TestomatClient from '../client.js';
 import XmlReader from '../xmlReader.js';
-import AllureReader from '../allureReader.js';
 import { APP_PREFIX, STATUS } from '../constants.js';
 import { cleanLatestRunId, getPackageVersion, applyFilter } from '../utils/utils.js';
 import { config } from '../config.js';
@@ -16,7 +15,7 @@ import { filesize as prettyBytes } from 'filesize';
 import dotenv from 'dotenv';
 import Replay from '../replay.js';
 
-const debug = createDebugMessages('@testomatio/reporter:xml-cli');
+const debug = createDebugMessages('@testomatio/reporter:cli');
 const version = getPackageVersion();
 console.log(pc.cyan(pc.bold(` 🤩 Testomat.io Reporter v${version}`)));
 const program = new Command();
@@ -80,22 +79,17 @@ program
   .command('run')
   .alias('test')
   .description('Run tests with the specified command')
-  .argument('<command>', 'Test runner command')
+  .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('--kind <type>', 'Specify run type: automated, manual, or mixed')
   .action(async (command, opts) => {
     const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || config.TESTOMATIO;
     const title = process.env.TESTOMATIO_TITLE;
-
-    if (!command || !command.split) {
-      console.log(APP_PREFIX, `No command provided. Use -c option to launch a test runner.`);
-      return process.exit(255);
-    }
-
     const client = new TestomatClient({ apiKey, title });
 
     if (opts.filter || opts.filterList) {
+      console.log(APP_PREFIX,'Filtering tests...');
       // Example of use: npx @testomatio/reporter run "npx jest" --filter "testomatio:tag-name=frontend"
       // Example of use: npx @testomatio/reporter run "npx jest" --filter "coverage:file=coverage.yml"
       // Example of use: npx @testomatio/reporter run "npx jest" --filter-list "coverage:file=coverage.yml"
@@ -103,6 +97,9 @@ program
       const pipeOptions = optsArray.join(':');
 
       const prepareRunParams = { pipe, pipeOptions };
+      if (opts.filterList) {
+        client.pipeStore.filterList = true;
+      }
 
       try {
         const tests = await client.prepareRun(prepareRunParams);
@@ -117,19 +114,48 @@ program
 
         debug(`Execution pattern: "${pattern}"`);
 
-        if (opts.filterList) {
+        if(opts.filterList) {
           console.log(APP_PREFIX, pc.blue(`Matched test/suite IDs: ${tests.join(', ')}`));
-          console.log(APP_PREFIX, pc.green(`Full Running Command: ${filteredCommand}`));
+          if (command) console.log(APP_PREFIX, pc.green(`Full Running Command: ${filteredCommand}`));
           return;
         }
 
-        command = filteredCommand;
-      } catch (err) {
+        if (command && command.split) {
+          command = filteredCommand;
+        }
+      }
+      catch (err) {
         console.log(APP_PREFIX, err.message || err);
         return;
       }
     }
 
+    // just create a run (wich tests which match filters) without executing tests
+    if (!command || !command.split) {
+      const createRunParams = {};
+      if (title) {
+        createRunParams.title = title;
+      }
+      if (opts.kind) {
+        createRunParams.kind = opts.kind;
+      }
+
+      if (apiKey) {
+        await client.createRun(createRunParams);
+        const runId = process.env.TESTOMATIO_RUN || process.env.runId;
+        if (client.pipeStore.runUrl) console.log(APP_PREFIX, `📊 Report URL: ${pc.magenta(client.pipeStore.runUrl)}`);
+
+        if (opts.kind !== 'manual') {
+          console.log(APP_PREFIX, `No command passed, so you need to run tests yourself:`);
+          console.log(APP_PREFIX, `TESTOMATIO_RUN=${runId} <command>`);
+        }
+      } else {
+        console.log(APP_PREFIX, '⚠️  No API key provided. Cannot create run without TESTOMATIO key.');
+        process.exit(1);
+      }
+      return process.exit(0);
+    }
+
     console.log(APP_PREFIX, `🚀 Running`, pc.green(command));
 
     const runTests = async () => {
@@ -237,40 +263,6 @@ program
     if (timeoutTimer) clearTimeout(timeoutTimer);
   });
 
-program
-  .command('allure')
-  .description('Parse Allure result files and upload to Testomat.io')
-  .argument('<pattern>', 'Allure result directory pattern')
-  .option('-d, --dir <dir>', 'Project directory')
-  .option('--timelimit <time>', 'default time limit in seconds to kill a stuck process')
-  .option('--with-package', 'Keep full package path in file names (default: strip package prefix)')
-  .action(async (pattern, opts) => {
-    const runReader = new AllureReader({ withPackage: opts.withPackage });
-
-    let timeoutTimer;
-    if (opts.timelimit) {
-      timeoutTimer = setTimeout(
-        () => {
-          console.log(
-            `⚠️  Reached timeout of ${opts.timelimit}s. Exiting... (Exit code is 0 to not fail the pipeline)`,
-          );
-          process.exit(0);
-        },
-        parseInt(opts.timelimit, 10) * 1000,
-      );
-    }
-
-    try {
-      await runReader.parse(pattern);
-      await runReader.createRun();
-      await runReader.uploadData();
-    } catch (err) {
-      console.log(APP_PREFIX, 'Error uploading Allure results:', err);
-    }
-
-    if (timeoutTimer) clearTimeout(timeoutTimer);
-  });
-
 program
   .command('upload-artifacts')
   .description('Upload artifacts to Testomat.io')

package/src/data-storage.js

@@ -139,6 +139,7 @@ class DataStorage {
         const testDataAsText = fs.readFileSync(filepath, 'utf-8');
         if (testDataAsText) debug('<=', dataType, 'file', context, testDataAsText);
         const testDataArr = testDataAsText?.split(os.EOL) || [];
+        debug('<=', dataType, 'file', context, testDataArr);
         return testDataArr;
       }
       // debug(`No ${this.dataType} data for ${context} in <file> storage`);

package/src/junit-adapter/index.js

@@ -4,7 +4,6 @@ import JavaAdapter from './java.js';
 import PythonAdapter from './python.js';
 import RubyAdapter from './ruby.js';
 import CSharpAdapter from './csharp.js';
-import KotlinAdapter from './kotlin.js';
 
 function AdapterFactory(lang, opts) {
   if (lang === 'java') {
@@ -22,9 +21,6 @@ function AdapterFactory(lang, opts) {
   if (lang === 'c#' || lang === 'csharp') {
     return new CSharpAdapter(opts);
   }
-  if (lang === 'kotlin') {
-    return new KotlinAdapter(opts);
-  }
 
   return new Adapter(opts);
 }