@testomatio/reporter 2.3.7-beta.3-xml-import → 2.3.7-beta.4-stack-artifacts

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)_

package/lib/bin/cli.js

@@ -145,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/bin/startTest.js

@@ -35,7 +35,7 @@ while (i < args.length) {
         newArgs[0] = 'start';
     }
     else if (arg === '--finish') {
-        // Map --finish to finish command
+        // Map --finish to finish command  
         newArgs[0] = 'finish';
     }
     else {
@@ -46,8 +46,8 @@ while (i < args.length) {
 }
 // Execute the main CLI with mapped arguments
 const child = (0, node_child_process_1.spawn)(process.execPath, [cliPath, ...newArgs], {
-    stdio: 'inherit',
+    stdio: 'inherit'
 });
-child.on('exit', code => {
+child.on('exit', (code) => {
     process.exit(code);
 });

package/lib/client.js

@@ -70,8 +70,8 @@ class Client {
         this.pipeStore = {};
         this.runId = '';
         this.queue = Promise.resolve();
-        // Get package.json path - use a simple approach that works in both environments
-        const pathToPackageJSON = path_1.default.join(process.cwd(), 'package.json');
+        // @ts-ignore this line will be removed in compiled code, because __dirname is defined in commonjs
+        const pathToPackageJSON = path_1.default.join(__dirname, '../package.json');
         try {
             this.version = JSON.parse(fs_1.default.readFileSync(pathToPackageJSON).toString()).version;
             console.log(constants_js_1.APP_PREFIX, `Testomatio Reporter v${this.version}`);
@@ -158,17 +158,6 @@ 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',
@@ -181,9 +170,37 @@ class Client {
         /**
          * @type {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;
+        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);
+        let formattedSteps;
+        if (stackArtifactsEnabled) {
+            const timestamp = +new Date;
+            formattedSteps = Array.isArray(steps) ? steps.map(step => (0, utils_js_1.formatStep)(step)).flat().join('\n') : '';
+            if (error?.stack?.length > 5000) {
+                uploadedFiles.push(this.uploader.uploadFileAsBuffer(Buffer.from(error.stack, 'utf8'), [this.runId, rid, `stack_${timestamp}.log`]));
+            }
+            if (formattedSteps?.length > 10000) {
+                uploadedFiles.push(this.uploader.uploadFileAsBuffer(Buffer.from(JSON.stringify(steps, null, 2), 'utf8'), [this.runId, rid, `steps_${timestamp}.json`]));
+            }
+        }
+        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 [];
+        }
+        const { time = 0, example = null, files = [], filesBuffers = [], code = null, file, 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]) => {
@@ -191,19 +208,29 @@ 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;
         }
-        // Attach logs
-        const fullLogs = this.formatLogs({ error: errorFormatted, steps, logs: testData.logs });
-        // add artifacts
+        if (stackArtifactsEnabled) {
+            if (error?.stack?.length > 5000)
+                errorFormatted = `[Large stack saved as artifact]`;
+            if (formattedSteps?.length > 10000)
+                steps = null;
+        }
+        else {
+            formattedSteps = Array.isArray(steps) ? steps.map(step => (0, utils_js_1.formatStep)(step)).flat().join('\n') : '';
+        }
+        let fullLogs = this.formatLogs({ error: errorFormatted, steps, logs: testData.logs });
+        if (stackArtifactsEnabled && fullLogs.length > 5000) {
+            const timestamp = +new Date;
+            uploadedFiles.push(this.uploader.uploadFileAsBuffer(Buffer.from(fullLogs, 'utf8'), [this.runId, rid, `logs_${timestamp}.log`]));
+            fullLogs = fullLogs.slice(0, 5000) + '\n\n[Full logs saved as artifact]';
+        }
         if (manuallyAttachedArtifacts?.length)
             files.push(...manuallyAttachedArtifacts);
-        const uploadedFiles = [];
         for (let f of files) {
             if (!f)
                 continue; // f === null
@@ -329,11 +356,7 @@ class Client {
      */
     formatLogs({ error, steps, logs }) {
         error = error?.trim();
-        logs = logs
-            ?.trim()
-            .split('\n')
-            .map(l => (0, utils_js_1.truncate)(l))
-            .join('\n');
+        logs = logs?.trim().split('\n').map(l => (0, utils_js_1.truncate)(l)).join('\n');
         if (Array.isArray(steps)) {
             steps = steps
                 .map(step => (0, utils_js_1.formatStep)(step))

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());
-                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/debug.js

@@ -18,7 +18,7 @@ class DebugPipe {
         this.isEnabled = !!process.env.TESTOMATIO_DEBUG || !!process.env.DEBUG;
         if (this.isEnabled) {
             this.batch = {
-                isEnabled: this.params.isBatchEnabled ?? (process.env.TESTOMATIO_DISABLE_BATCH_UPLOAD ? false : true),
+                isEnabled: this.params.isBatchEnabled ?? !process.env.TESTOMATIO_DISABLE_BATCH_UPLOAD ?? true,
                 intervalFunction: null,
                 intervalTime: 5000,
                 tests: [],

package/lib/pipe/testomatio.js

@@ -23,7 +23,7 @@ if (process.env.TESTOMATIO_RUN)
 class TestomatioPipe {
     constructor(params, store) {
         this.batch = {
-            isEnabled: params?.isBatchEnabled ?? (process.env.TESTOMATIO_DISABLE_BATCH_UPLOAD ? false : true),
+            isEnabled: params?.isBatchEnabled ?? !process.env.TESTOMATIO_DISABLE_BATCH_UPLOAD ?? true,
             intervalFunction: null, // will be created in createRun by setInterval function
             intervalTime: 5000, // how often tests are sent
             tests: [], // array of tests in batch
@@ -60,7 +60,7 @@ class TestomatioPipe {
                 retry: constants_js_1.REPORTER_REQUEST_RETRIES.retriesPerRequest,
                 retryDelay: constants_js_1.REPORTER_REQUEST_RETRIES.retryTimeout,
                 httpMethodsToRetry: ['GET', 'PUT', 'HEAD', 'OPTIONS', 'DELETE', 'POST'],
-                shouldRetry: error => {
+                shouldRetry: (error) => {
                     if (!error.response)
                         return false;
                     switch (error.response?.status) {
@@ -73,8 +73,8 @@ class TestomatioPipe {
                             break;
                     }
                     return error.response?.status >= 401; // Retry on 401+ and 5xx
-                },
-            },
+                }
+            }
         });
         this.isEnabled = true;
         // do not finish this run (for parallel testing)
@@ -193,7 +193,7 @@ class TestomatioPipe {
                 method: 'PUT',
                 url: `/api/reporter/${this.runId}`,
                 data: runParams,
-                responseType: 'json',
+                responseType: 'json'
             });
             if (resp.data.artifacts)
                 (0, pipe_utils_js_1.setS3Credentials)(resp.data.artifacts);
@@ -206,7 +206,7 @@ class TestomatioPipe {
                 url: '/api/reporter',
                 data: runParams,
                 maxContentLength: Infinity,
-                responseType: 'json',
+                responseType: 'json'
             });
             this.runId = resp.data.uid;
             this.runUrl = `${this.url}/${resp.data.url.split('/').splice(3).join('/')}`;
@@ -259,17 +259,15 @@ class TestomatioPipe {
         this.#formatData(data);
         const json = json_cycle_1.default.stringify(data);
         debug('Adding test', json);
-        return this.client
-            .request({
+        return this.client.request({
             method: 'POST',
             url: `/api/reporter/${this.runId}/testrun`,
             data: json,
             headers: {
                 'Content-Type': 'application/json',
             },
-            maxContentLength: Infinity,
-        })
-            .catch(err => {
+            maxContentLength: Infinity
+        }).catch(err => {
             this.requestFailures++;
             this.notReportedTestsCount++;
             if (err.response) {
@@ -314,21 +312,19 @@ class TestomatioPipe {
         // get tests from batch and clear batch
         const testsToSend = this.batch.tests.splice(0);
         debug('📨 Batch upload', testsToSend.length, 'tests');
-        return this.client
-            .request({
+        return this.client.request({
             method: 'POST',
             url: `/api/reporter/${this.runId}/testrun`,
             data: {
                 api_key: this.apiKey,
                 tests: testsToSend,
-                batch_index: this.batch.batchIndex,
+                batch_index: this.batch.batchIndex
             },
             headers: {
                 'Content-Type': 'application/json',
             },
-            maxContentLength: Infinity,
-        })
-            .catch(err => {
+            maxContentLength: Infinity
+        }).catch(err => {
             this.requestFailures++;
             this.notReportedTestsCount += testsToSend.length;
             if (err.response) {
@@ -412,7 +408,7 @@ class TestomatioPipe {
                         status_event,
                         detach: params.detach,
                         tests: params.tests,
-                    },
+                    }
                 });
                 if (this.runUrl) {
                     console.log(constants_js_1.APP_PREFIX, '📊 Report Saved. Report URL:', picocolors_1.default.magenta(this.runUrl));
@@ -424,7 +420,7 @@ class TestomatioPipe {
             if (this.runUrl && this.proceed) {
                 const notFinishedMessage = picocolors_1.default.yellow(picocolors_1.default.bold('Run was not finished because of $TESTOMATIO_PROCEED'));
                 console.log(constants_js_1.APP_PREFIX, `📊 ${notFinishedMessage}. Report URL: ${picocolors_1.default.magenta(this.runUrl)}`);
-                console.log(constants_js_1.APP_PREFIX, `🛬 Run to finish it: TESTOMATIO_RUN=${this.runId} npx @testomatio/reporter finish`);
+                console.log(constants_js_1.APP_PREFIX, `🛬 Run to finish it: TESTOMATIO_RUN=${this.runId} npx start-test-run --finish`);
             }
             if (this.hasUnmatchedTests) {
                 console.log('');

package/lib/reporter.d.ts

@@ -1,3 +1,10 @@
+export { Client };
+export const STATUS: {
+    PASSED: string;
+    FAILED: string;
+    SKIPPED: string;
+    FINISHED: string;
+};
 export const artifact: (data: string | {
     path: string;
     type: string;
@@ -80,7 +87,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 {
-    let testomatioLogger: {
+    export let testomatioLogger: {
         "__#13@#originalUserLogger": {
             assert(condition?: boolean, ...data: any[]): void;
             assert(value: any, message?: string, ...optionalParams: any[]): void;
@@ -148,13 +155,13 @@ declare namespace _default {
         }): void;
         prettyObjects: boolean;
     };
-    let artifact: (data: string | {
+    export let artifact: (data: string | {
         path: string;
         type: string;
         name: string;
     }, context?: any) => void;
-    let log: (...args: any[]) => void;
-    let logger: {
+    export let log: (...args: any[]) => void;
+    export let logger: {
         "__#13@#originalUserLogger": {
             assert(condition?: boolean, ...data: any[]): void;
             assert(value: any, message?: string, ...optionalParams: any[]): void;
@@ -222,13 +229,15 @@ declare namespace _default {
         }): void;
         prettyObjects: boolean;
     };
-    let meta: (keyValue: {
+    export let meta: (keyValue: {
         [key: string]: string;
     } | string, value?: string | null) => void;
-    let step: (message: string) => void;
-    let label: (key: string, value?: string | null) => void;
-    let linkTest: (...testIds: string[]) => void;
-    let linkJira: (...jiraIds: string[]) => 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 };
 }
 export default _default;
 export type ArtifactFunction = typeof import("./reporter-functions.js").default.artifact;
@@ -237,3 +246,4 @@ 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,13 +1,48 @@
 "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 = void 0;
-// import TestomatClient from './client.js';
-// import * as TRConstants from './constants.js';
+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"));
 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;
@@ -37,6 +72,6 @@ module.exports = {
     label: reporter_functions_js_1.default.label,
     linkTest: reporter_functions_js_1.default.linkTest,
     linkJira: reporter_functions_js_1.default.linkJira,
-    // TestomatClient,
-    // TRConstants,
+    TestomatioClient: client_js_1.default,
+    STATUS: exports.STATUS,
 };