@testomatio/reporter 2.3.8 → 2.3.9-beta-bin-fix

package/README.md

@@ -13,7 +13,7 @@ Testomat.io Reporter (this npm package) supports:
 - 🔎 [Stack traces](./docs/stacktrace.md) and error messages
 - 🐙 [GitHub](./docs/pipes/github.md), [GitLab](./docs/pipes/gitlab.md) & [Bitbucket](./docs/pipes/bitbucket.md) integration
 - 🚅 Realtime reports
-- 🗃️ Other test frameworks supported via [JUnit XML](./docs/junit.md) with [XML import configuration](./docs/xml-imports.md)
+- 🗃️ Other test frameworks supported via [JUNit XML](./docs/junit.md)
 - 🚶‍♀️ Steps _(work in progress)_
 - 📄 [Logger](./docs/logger.md) _(work in progress, supports Jest for now)_
 - ☁️ Custom properties and metadata _(work in progress)_
@@ -129,7 +129,6 @@ Bring this reporter on CI and never lose test results again!
   - [CSV](./docs/pipes/csv.md)
   - [HTML report](./docs/pipes/html.md)
   - [Bitbucket](./docs/pipes/bitbucket.md)
-- 🔗 [Linking Tests](./docs/linking-tests.md)
 - 📓 [JUnit](./docs/junit.md)
 - 🗄️ [Artifacts](./docs/artifacts.md)
 - 🔂 [Workflows](./docs/workflows.md)

package/lib/bin/cli.js

@@ -37,17 +37,12 @@ program
 program
     .command('start')
     .description('Start a new run and return its ID')
-    .option('--kind <type>', 'Specify run type: automated, manual, or mixed')
-    .action(async (opts) => {
+    .action(async () => {
     (0, utils_js_1.cleanLatestRunId)();
     console.log('Starting a new Run on Testomat.io...');
     const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || config_js_1.config.TESTOMATIO;
     const client = new client_js_1.default({ apiKey });
-    const createRunParams = {};
-    if (opts.kind) {
-        createRunParams.kind = opts.kind;
-    }
-    client.createRun(createRunParams).then(() => {
+    client.createRun().then(() => {
         console.log(process.env.runId);
         process.exit(0);
     });
@@ -75,7 +70,6 @@ program
     .description('Run tests with the specified command')
     .argument('<command>', 'Test runner command')
     .option('--filter <filter>', 'Additional execution filter')
-    .option('--kind <type>', 'Specify run type: automated, manual, or mixed')
     .action(async (command, opts) => {
     const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || config_js_1.config.TESTOMATIO;
     const title = process.env.TESTOMATIO_TITLE;
@@ -114,12 +108,8 @@ program
             process.exit(code);
         });
     };
-    const createRunParams = {};
-    if (opts.kind) {
-        createRunParams.kind = opts.kind;
-    }
     if (apiKey) {
-        await client.createRun(createRunParams).then(runTests);
+        await client.createRun().then(runTests);
     }
     else {
         await runTests();
@@ -155,7 +145,7 @@ program
     .option('--lang <lang>', 'Language used (python, ruby, java)')
     .option('--timelimit <time>', 'default time limit in seconds to kill a stuck process')
     .action(async (pattern, opts) => {
-    if (!pattern.endsWith('.xml') && !pattern.includes('*')) {
+    if (!pattern.endsWith('.xml')) {
         pattern += '.xml';
     }
     let { javaTests, lang } = opts;

package/lib/bin/reportXml.js

@@ -25,7 +25,7 @@ program
     .option('--timelimit <time>', 'default time limit in seconds to kill a stuck process')
     .option('--env-file <envfile>', 'Load environment variables from env file')
     .action(async (pattern, opts) => {
-    if (!pattern.endsWith('.xml') && !pattern.includes('*')) {
+    if (!pattern.endsWith('.xml')) {
         pattern += '.xml';
     }
     let { javaTests, lang } = opts;
@@ -37,10 +37,7 @@ program
     lang = lang?.toLowerCase();
     if (javaTests === true || (lang === 'java' && !javaTests))
         javaTests = 'src/test/java';
-    const runReader = new xmlReader_js_1.default({
-        javaTests,
-        lang,
-    });
+    const runReader = new xmlReader_js_1.default({ javaTests, lang });
     const files = glob_1.glob.sync(pattern, { cwd: opts.dir || process.cwd() });
     if (!files.length) {
         console.log(constants_js_1.APP_PREFIX, `Report can't be created. No XML files found 😥`);

package/lib/client.d.ts

@@ -44,7 +44,7 @@ export class Client {
      *
      * @returns {Promise<any>} - resolves to Run id which should be used to update / add test
      */
-    createRun(params?: {}): Promise<any>;
+    createRun(params: any): Promise<any>;
     /**
      * Updates test status and its data
      *

package/lib/client.js

@@ -51,9 +51,7 @@ const node_url_1 = require("node:url");
 const uploader_js_1 = require("./uploader.js");
 const utils_js_1 = require("./utils/utils.js");
 const filesize_1 = require("filesize");
-const util_1 = require("util");
 const debug = (0, debug_1.default)('@testomatio/reporter:client');
-const stripColors = util_1.stripVTControlCharacters || ((str) => str?.replace(/\x1b\[[0-9;]*m/g, '') || '');
 // removed __dirname usage, because:
 // 1. replaced with ESM syntax (import.meta.url), but it throws an error on tsc compilation;
 // 2. got error "__dirname already defined" in compiles js code (cjs dir)
@@ -131,7 +129,7 @@ class Client {
      *
      * @returns {Promise<any>} - resolves to Run id which should be used to update / add test
      */
-    async createRun(params = {}) {
+    async createRun(params) {
         if (!this.pipes || !this.pipes.length)
             this.pipes = await (0, index_js_1.pipesFactory)(params || this.paramsForPipesFactory || {}, this.pipeStore);
         debug('Creating run...');
@@ -139,7 +137,7 @@ class Client {
         if (!this.pipes?.filter(p => p.isEnabled).length)
             return Promise.resolve();
         this.queue = this.queue
-            .then(() => Promise.all(this.pipes.map(p => p.createRun(params))))
+            .then(() => Promise.all(this.pipes.map(p => p.createRun())))
             .catch(err => console.log(constants_js_1.APP_PREFIX, err))
             .then(() => {
             const runId = this.pipeStore?.runId;
@@ -160,6 +158,17 @@ class Client {
      * @returns {Promise<PipeResult[]>}
      */
     async addTestRun(status, testData) {
+        if (!this.pipes || !this.pipes.length)
+            this.pipes = await (0, index_js_1.pipesFactory)(this.paramsForPipesFactory || {}, this.pipeStore);
+        // all pipes disabled, skipping
+        if (!this.pipes?.filter(p => p.isEnabled).length)
+            return [];
+        if (isTestShouldBeExculedFromReport(testData))
+            return [];
+        if (status === constants_js_1.STATUS.SKIPPED && process.env.TESTOMATIO_EXCLUDE_SKIPPED) {
+            debug('Skipping test from report', testData?.title);
+            return []; // do not log skipped tests
+        }
         if (!testData)
             testData = {
                 title: 'Unknown test',
@@ -172,12 +181,9 @@ class Client {
         /**
          * @type {TestData}
          */
-        const { rid, error = null, steps: originalSteps, title, suite_title, } = testData;
-        let steps = originalSteps;
-        const uploadedFiles = [];
-        const stackArtifactsEnabled = (0, utils_js_1.transformEnvVarToBoolean)(process.env.TESTOMATIO_STACK_ARTIFACTS);
-        const { time = 0, example = null, files = [], filesBuffers = [], code = null, file, suite_id, test_id, timestamp, links, manuallyAttachedArtifacts, overwrite, tags, } = testData;
+        const { rid, error = null, time = 0, example = null, files = [], filesBuffers = [], steps, code = null, title, file, suite_title, suite_id, test_id, timestamp, links, manuallyAttachedArtifacts, overwrite, tags, } = testData;
         let { message = '', meta = {} } = testData;
+        // stringify meta values and limit keys and values length to 255
         meta = Object.entries(meta)
             .filter(([, value]) => value !== null && value !== undefined)
             .reduce((acc, [key, value]) => {
@@ -185,34 +191,19 @@ class Client {
                 acc[key] = value;
             return acc;
         }, {});
+        // Get links from storage using the test context
         const testContext = suite_title ? `${suite_title} ${title}` : title;
         let errorFormatted = '';
         if (error) {
             errorFormatted += this.formatError(error) || '';
             message = error?.message;
         }
-        let fullLogs = this.formatLogs({ error: errorFormatted, steps, logs: testData.logs });
-        if (stackArtifactsEnabled && fullLogs?.trim()?.length > 0) {
-            uploadedFiles.push(this.uploader.uploadFileAsBuffer(Buffer.from(stripColors(fullLogs), 'utf8'), [this.runId, rid, `logs_${+new Date}.log`]));
-            fullLogs = '';
-            steps = null;
-        }
-        if (!this.pipes || !this.pipes.length)
-            this.pipes = await (0, index_js_1.pipesFactory)(this.paramsForPipesFactory || {}, this.pipeStore);
-        if (!this.pipes?.filter(p => p.isEnabled).length) {
-            if (uploadedFiles.length > 0) {
-                await Promise.all(uploadedFiles);
-            }
-            return [];
-        }
-        if (isTestShouldBeExculedFromReport(testData))
-            return [];
-        if (status === constants_js_1.STATUS.SKIPPED && process.env.TESTOMATIO_EXCLUDE_SKIPPED) {
-            debug('Skipping test from report', testData?.title);
-            return [];
-        }
+        // Attach logs
+        const fullLogs = this.formatLogs({ error: errorFormatted, steps, logs: testData.logs });
+        // add artifacts
         if (manuallyAttachedArtifacts?.length)
             files.push(...manuallyAttachedArtifacts);
+        const uploadedFiles = [];
         for (let f of files) {
             if (!f)
                 continue; // f === null
@@ -294,7 +285,7 @@ class Client {
                 const uploadedArtifacts = this.uploader.successfulUploads.map(file => ({
                     relativePath: file.path.replace(process.cwd(), ''),
                     link: file.link,
-                    sizePretty: file.size == null ? 'unknown' : (0, filesize_1.filesize)(file.size, { round: 0 }).toString(),
+                    sizePretty: (0, filesize_1.filesize)(file.size, { round: 0 }).toString(),
                 }));
                 uploadedArtifacts.forEach(upload => {
                     debug(`🟢Uploaded artifact`, `${upload.relativePath},`, 'size:', `${upload.sizePretty},`, 'link:', `${upload.link}`);
@@ -304,7 +295,7 @@ class Client {
                 console.log(constants_js_1.APP_PREFIX, `🗄️ ${this.uploader.failedUploads.length} artifacts 🔴${picocolors_1.default.bold('failed')} to upload`);
                 const failedUploads = this.uploader.failedUploads.map(file => ({
                     relativePath: file.path.replace(process.cwd(), ''),
-                    sizePretty: file.size == null ? 'unknown' : (0, filesize_1.filesize)(file.size, { round: 0 }).toString(),
+                    sizePretty: (0, filesize_1.filesize)(file.size, { round: 0 }).toString(),
                 }));
                 const pathPadding = Math.max(...failedUploads.map(upload => upload.relativePath.length)) + 1;
                 failedUploads.forEach(upload => {

package/lib/junit-adapter/csharp.d.ts

@@ -1,4 +1,5 @@
 export default CSharpAdapter;
 declare class CSharpAdapter extends Adapter {
+    getFilePath(t: any): string;
 }
 import Adapter from './adapter.js';

package/lib/junit-adapter/csharp.js

@@ -7,57 +7,24 @@ const path_1 = __importDefault(require("path"));
 const adapter_js_1 = __importDefault(require("./adapter.js"));
 class CSharpAdapter extends adapter_js_1.default {
     formatTest(t) {
-        // Extract example from title if not already present
-        if (!t.example) {
-            const exampleMatch = t.title.match(/\((.*?)\)/);
-            if (exampleMatch) {
-                // Extract parameters as object with numeric keys for API
-                const params = exampleMatch[1].split(',').map(param => param.trim()).filter(param => param !== '');
-                t.example = {};
-                params.forEach((param, index) => {
-                    t.example[index] = param;
-                });
-            }
-        }
-        // Remove parameters from title to avoid duplicates in Test Suite
-        // The example field will be used for grouping on import
-        t.title = t.title.replace(/\(.*?\)/, '').trim();
+        const title = t.title.replace(/\(.*?\)/, '').trim();
+        const example = t.title.match(/\((.*?)\)/);
+        if (example)
+            t.example = { ...example[1].split(',') };
         const suite = t.suite_title.split('.');
         t.suite_title = suite.pop();
         t.file = namespaceToFileName(t.file);
+        t.title = title.trim();
         return t;
     }
     getFilePath(t) {
-        if (!t.file)
-            return null;
-        // Normalize path separators for cross-platform compatibility
-        let filePath = t.file.replace(/\\/g, '/');
-        // If file already has .cs extension, use it directly
-        if (filePath.endsWith('.cs')) {
-            // Make relative path if it's absolute
-            if (path_1.default.isAbsolute(filePath)) {
-                // Try to find project-relative path
-                const cwd = process.cwd().replace(/\\/g, '/');
-                if (filePath.startsWith(cwd)) {
-                    filePath = path_1.default.relative(cwd, filePath).replace(/\\/g, '/');
-                }
-            }
-            return filePath;
-        }
-        // Convert namespace path to file path
-        const fileName = namespaceToFileName(filePath);
+        const fileName = namespaceToFileName(t.file);
         return fileName;
     }
 }
 module.exports = CSharpAdapter;
 function namespaceToFileName(fileName) {
-    if (!fileName)
-        return '';
-    // If already a .cs file path, clean it up
-    if (fileName.endsWith('.cs')) {
-        return fileName.replace(/\\/g, '/');
-    }
     const fileParts = fileName.split('.');
     fileParts[fileParts.length - 1] = fileParts[fileParts.length - 1]?.replace(/\$.*/, '');
-    return `${fileParts.join('/')}.cs`;
+    return `${fileParts.join(path_1.default.sep)}.cs`;
 }

package/lib/pipe/testomatio.d.ts

@@ -47,12 +47,11 @@ declare class TestomatioPipe implements Pipe {
     prepareRun(opts: any): Promise<string[]>;
     /**
      * Creates a new run on Testomat.io
-     * @param {{isBatchEnabled?: boolean, kind?: string}} params
+     * @param {{isBatchEnabled?: boolean}} params
      * @returns Promise<void>
      */
     createRun(params?: {
         isBatchEnabled?: boolean;
-        kind?: string;
     }): Promise<void>;
     runUrl: string;
     runPublicUrl: any;

package/lib/pipe/testomatio.js

@@ -148,7 +148,7 @@ class TestomatioPipe {
     }
     /**
      * Creates a new run on Testomat.io
-     * @param {{isBatchEnabled?: boolean, kind?: string}} params
+     * @param {{isBatchEnabled?: boolean}} params
      * @returns Promise<void>
      */
     async createRun(params = {}) {
@@ -184,7 +184,6 @@ class TestomatioPipe {
             label: this.label,
             shared_run: this.sharedRun,
             shared_run_timeout: this.sharedRunTimeout,
-            kind: params.kind,
         }).filter(([, value]) => !!value));
         debug(' >>>>>> Run params', JSON.stringify(runParams, null, 2));
         if (this.runId) {

package/lib/reporter.d.ts

@@ -1,10 +1,3 @@
-export { Client };
-export const STATUS: {
-    PASSED: string;
-    FAILED: string;
-    SKIPPED: string;
-    FINISHED: string;
-};
 export const artifact: (data: string | {
     path: string;
     type: string;
@@ -87,7 +80,7 @@ export const label: (key: string, value?: string | null) => void;
 export const linkTest: (...testIds: string[]) => void;
 export const linkJira: (...jiraIds: string[]) => void;
 declare namespace _default {
-    export let testomatioLogger: {
+    let testomatioLogger: {
         "__#13@#originalUserLogger": {
             assert(condition?: boolean, ...data: any[]): void;
             assert(value: any, message?: string, ...optionalParams: any[]): void;
@@ -155,13 +148,13 @@ declare namespace _default {
         }): void;
         prettyObjects: boolean;
     };
-    export let artifact: (data: string | {
+    let artifact: (data: string | {
         path: string;
         type: string;
         name: string;
     }, context?: any) => void;
-    export let log: (...args: any[]) => void;
-    export let logger: {
+    let log: (...args: any[]) => void;
+    let logger: {
         "__#13@#originalUserLogger": {
             assert(condition?: boolean, ...data: any[]): void;
             assert(value: any, message?: string, ...optionalParams: any[]): void;
@@ -229,15 +222,13 @@ declare namespace _default {
         }): void;
         prettyObjects: boolean;
     };
-    export let meta: (keyValue: {
+    let meta: (keyValue: {
         [key: string]: string;
     } | string, value?: string | null) => void;
-    export let step: (message: string) => void;
-    export let label: (key: string, value?: string | null) => void;
-    export let linkTest: (...testIds: string[]) => void;
-    export let linkJira: (...jiraIds: string[]) => void;
-    export { Client as TestomatioClient };
-    export { STATUS };
+    let step: (message: string) => void;
+    let label: (key: string, value?: string | null) => void;
+    let linkTest: (...testIds: string[]) => void;
+    let linkJira: (...jiraIds: string[]) => void;
 }
 export default _default;
 export type ArtifactFunction = typeof import("./reporter-functions.js").default.artifact;
@@ -246,4 +237,3 @@ export type LoggerService = typeof import("./services/index.js").services.logger
 export type MetaFunction = typeof import("./reporter-functions.js").default.keyValue;
 export type StepFunction = typeof import("./reporter-functions.js").default.step;
 export type LabelFunction = typeof import("./reporter-functions.js").default.label;
-import Client from './client.js';

package/lib/reporter.js

@@ -1,48 +1,13 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.linkJira = exports.linkTest = exports.label = exports.step = exports.meta = exports.logger = exports.log = exports.artifact = exports.STATUS = exports.Client = void 0;
-const client_js_1 = __importDefault(require("./client.js"));
-exports.Client = client_js_1.default;
-const TestomatioConstants = __importStar(require("./constants.js"));
+exports.linkJira = exports.linkTest = exports.label = exports.step = exports.meta = exports.logger = exports.log = exports.artifact = void 0;
+// import TestomatClient from './client.js';
+// import * as TRConstants from './constants.js';
 const index_js_1 = require("./services/index.js");
 const reporter_functions_js_1 = __importDefault(require("./reporter-functions.js"));
-exports.STATUS = TestomatioConstants.STATUS;
 exports.artifact = reporter_functions_js_1.default.artifact;
 exports.log = reporter_functions_js_1.default.log;
 exports.logger = index_js_1.services.logger;
@@ -72,6 +37,6 @@ module.exports = {
     label: reporter_functions_js_1.default.label,
     linkTest: reporter_functions_js_1.default.linkTest,
     linkJira: reporter_functions_js_1.default.linkJira,
-    TestomatioClient: client_js_1.default,
-    STATUS: exports.STATUS,
+    // TestomatClient,
+    // TRConstants,
 };

package/lib/uploader.js

@@ -170,10 +170,6 @@ class S3Uploader {
         if (typeof filePath === 'string' && !path_1.default.isAbsolute(filePath)) {
             filePath = path_1.default.join(process.cwd(), filePath);
         }
-        // Normalize path separators for cross-platform compatibility
-        if (typeof filePath === 'string') {
-            filePath = filePath.replace(/\\/g, '/');
-        }
         const data = { rid, file: filePath, uploaded };
         const jsonLine = `${JSON.stringify(data)}\n`;
         fs_1.default.appendFileSync(tempFilePath, jsonLine);