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

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;
@@ -5,7 +12,7 @@ export const artifact: (data: string | {
 }, context?: any) => void;
 export const log: (...args: any[]) => void;
 export const logger: {
-    "__#13@#originalUserLogger": {
+    "__#14@#originalUserLogger": {
         assert(condition?: boolean, ...data: any[]): void;
         assert(value: any, message?: string, ...optionalParams: any[]): void;
         clear(): void;
@@ -50,13 +57,13 @@ export const logger: {
         profile(label?: string): void;
         profileEnd(label?: string): void;
     };
-    "__#13@#userLoggerWithOverridenMethods": any;
+    "__#14@#userLoggerWithOverridenMethods": any;
     logLevel: string;
     step(strings: any, ...values: any[]): void;
     getLogs(context: string): string[];
-    "__#13@#stringifyLogs"(...args: any[]): string;
+    "__#14@#stringifyLogs"(...args: any[]): string;
     _templateLiteralLog(strings: any, ...args: any[]): void;
-    "__#13@#logWrapper"(argsArray: any, level: any): void;
+    "__#14@#logWrapper"(argsArray: any, level: any): void;
     assert(...args: any[]): void;
     debug(...args: any[]): void;
     error(...args: any[]): void;
@@ -80,8 +87,8 @@ 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: {
-        "__#13@#originalUserLogger": {
+    export let testomatioLogger: {
+        "__#14@#originalUserLogger": {
             assert(condition?: boolean, ...data: any[]): void;
             assert(value: any, message?: string, ...optionalParams: any[]): void;
             clear(): void;
@@ -126,13 +133,13 @@ declare namespace _default {
             profile(label?: string): void;
             profileEnd(label?: string): void;
         };
-        "__#13@#userLoggerWithOverridenMethods": any;
+        "__#14@#userLoggerWithOverridenMethods": any;
         logLevel: string;
         step(strings: any, ...values: any[]): void;
         getLogs(context: string): string[];
-        "__#13@#stringifyLogs"(...args: any[]): string;
+        "__#14@#stringifyLogs"(...args: any[]): string;
         _templateLiteralLog(strings: any, ...args: any[]): void;
-        "__#13@#logWrapper"(argsArray: any, level: any): void;
+        "__#14@#logWrapper"(argsArray: any, level: any): void;
         assert(...args: any[]): void;
         debug(...args: any[]): void;
         error(...args: any[]): void;
@@ -148,14 +155,14 @@ 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: {
-        "__#13@#originalUserLogger": {
+    export let log: (...args: any[]) => void;
+    export let logger: {
+        "__#14@#originalUserLogger": {
             assert(condition?: boolean, ...data: any[]): void;
             assert(value: any, message?: string, ...optionalParams: any[]): void;
             clear(): void;
@@ -200,13 +207,13 @@ declare namespace _default {
             profile(label?: string): void;
             profileEnd(label?: string): void;
         };
-        "__#13@#userLoggerWithOverridenMethods": any;
+        "__#14@#userLoggerWithOverridenMethods": any;
         logLevel: string;
         step(strings: any, ...values: any[]): void;
         getLogs(context: string): string[];
-        "__#13@#stringifyLogs"(...args: any[]): string;
+        "__#14@#stringifyLogs"(...args: any[]): string;
         _templateLiteralLog(strings: any, ...args: any[]): void;
-        "__#13@#logWrapper"(argsArray: any, level: any): void;
+        "__#14@#logWrapper"(argsArray: any, level: any): void;
         assert(...args: any[]): void;
         debug(...args: any[]): void;
         error(...args: 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,
 };

package/lib/services/artifacts.d.ts

@@ -3,7 +3,7 @@ export const artifactStorage: ArtifactStorage;
  * Artifact storage is supposed to store file paths
  */
 declare class ArtifactStorage {
-    static "__#14@#instance": any;
+    static "__#15@#instance": any;
     /**
      * Singleton
      * @returns {ArtifactStorage}

package/lib/services/key-values.d.ts

@@ -1,6 +1,6 @@
 export const keyValueStorage: KeyValueStorage;
 declare class KeyValueStorage {
-    static "__#15@#instance": any;
+    static "__#16@#instance": any;
     /**
      *
      * @returns {KeyValueStorage}

package/lib/services/links.d.ts

@@ -1,6 +1,6 @@
 export const linkStorage: LinkStorage;
 declare class LinkStorage {
-    static "__#16@#instance": any;
+    static "__#17@#instance": any;
     /**
      *
      * @returns {LinkStorage}

package/lib/services/logger.d.ts

@@ -5,7 +5,7 @@ export const logger: Logger;
  * Supports different syntaxes to satisfy any user preferences.
  */
 declare class Logger {
-    static "__#13@#instance": any;
+    static "__#14@#instance": any;
     /**
      *
      * @returns {Logger}

package/lib/uploader.js

@@ -170,6 +170,10 @@ 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);

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

@@ -0,0 +1,28 @@
+/**
+ * Returns the formatted stack including the stack trace, steps, and logs.
+ * @param {Object} params - Parameters for formatting logs
+ * @param {string} params.error - Error message
+ * @param {Array|any} params.steps - Test steps (array or other types)
+ * @param {string} params.logs - Test logs
+ * @returns {string}
+ */
+export function formatLogs({ error, steps, logs }: {
+    error: string;
+    steps: any[] | any;
+    logs: string;
+}): string;
+/**
+ * Formats an error with stack trace and diff information
+ * @param {Error & {inspect?: () => string, operator?: string, diff?: string, actual?: any, expected?: any}} error
+ *   The error object to format
+ * @param {string} [message] - Optional error message override
+ * @returns {string}
+ */
+export function formatError(error: Error & {
+    inspect?: () => string;
+    operator?: string;
+    diff?: string;
+    actual?: any;
+    expected?: any;
+}, message?: string): string;
+export function stripColors(str: string): string;

package/lib/utils/log-formatter.js

@@ -0,0 +1,127 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stripColors = void 0;
+exports.formatLogs = formatLogs;
+exports.formatError = formatError;
+const callsite_record_1 = __importDefault(require("callsite-record"));
+const minimatch_1 = require("minimatch");
+const picocolors_1 = __importDefault(require("picocolors"));
+const util_1 = require("util");
+const path_1 = require("path");
+const utils_js_1 = require("./utils.js");
+const stripColors = util_1.stripVTControlCharacters || (str => str?.replace(/\x1b\[[0-9;]*m/g, '') || '');
+exports.stripColors = stripColors;
+/**
+ * Returns the formatted stack including the stack trace, steps, and logs.
+ * @param {Object} params - Parameters for formatting logs
+ * @param {string} params.error - Error message
+ * @param {Array|any} params.steps - Test steps (array or other types)
+ * @param {string} params.logs - Test logs
+ * @returns {string}
+ */
+function formatLogs({ error, steps, logs }) {
+    error = error?.trim();
+    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))
+            .flat()
+            .join('\n');
+    }
+    else {
+        steps = null;
+    }
+    let testLogs = '';
+    if (steps)
+        testLogs += `${picocolors_1.default.bold(picocolors_1.default.blue('################[ Steps ]################'))}\n${steps}\n\n`;
+    if (logs)
+        testLogs += `${picocolors_1.default.bold(picocolors_1.default.gray('################[ Logs ]################'))}\n${logs}\n\n`;
+    if (error)
+        testLogs += `${picocolors_1.default.bold(picocolors_1.default.red('################[ Failure ]################'))}\n${error}`;
+    return testLogs;
+}
+/**
+ * Formats an error with stack trace and diff information
+ * @param {Error & {inspect?: () => string, operator?: string, diff?: string, actual?: any, expected?: any}} error
+ *   The error object to format
+ * @param {string} [message] - Optional error message override
+ * @returns {string}
+ */
+function formatError(error, message) {
+    if (!message)
+        message = error.message;
+    // @ts-ignore - inspect is a custom property added by some testing frameworks
+    if (error.inspect)
+        message = error.inspect() || '';
+    let stack = '';
+    if (error.name)
+        stack += `${picocolors_1.default.red(error.name)}`;
+    // @ts-ignore - operator is a custom property added by assertion libraries
+    if (error.operator)
+        stack += ` (${picocolors_1.default.red(error.operator)})`;
+    // add new line if something was added to stack
+    if (stack)
+        stack += ': ';
+    stack += `${message}\n`;
+    // @ts-ignore - diff is a custom property added by vitest
+    if (error.diff) {
+        // diff for vitest
+        stack += error.diff;
+        stack += '\n\n';
+    }
+    else if (error.actual && error.expected && error.actual !== error.expected) {
+        // diffs for mocha, cypress, codeceptjs style
+        stack += `\n\n${picocolors_1.default.bold(picocolors_1.default.green('+ expected'))} ${picocolors_1.default.bold(picocolors_1.default.red('- actual'))}`;
+        stack += `\n${picocolors_1.default.green(`+ ${error.expected.toString().split('\n').join('\n+ ')}`)}`;
+        stack += `\n${picocolors_1.default.red(`- ${error.actual.toString().split('\n').join('\n- ')}`)}`;
+        stack += '\n\n';
+    }
+    const customFilter = process.env.TESTOMATIO_STACK_IGNORE;
+    try {
+        let hasFrame = false;
+        const record = (0, callsite_record_1.default)({
+            forError: error,
+            isCallsiteFrame: frame => {
+                if (customFilter && (0, minimatch_1.minimatch)(frame.fileName, customFilter))
+                    return false;
+                if (hasFrame)
+                    return false;
+                if (isNotInternalFrame(frame))
+                    hasFrame = true;
+                return hasFrame;
+            },
+        });
+        // @ts-ignore
+        if (record && !record.filename.startsWith('http')) {
+            stack += record.renderSync({ stackFilter: isNotInternalFrame });
+        }
+        return stack;
+    }
+    catch (e) {
+        console.log(e);
+    }
+}
+/**
+ * Checks if a stack frame is not an internal frame (node_modules or internal)
+ * @param {Object} frame - Stack frame object
+ * @returns {boolean}
+ */
+function isNotInternalFrame(frame) {
+    return (frame.getFileName() &&
+        frame.getFileName().includes(path_1.sep) &&
+        !frame.getFileName().includes('node_modules') &&
+        !frame.getFileName().includes('internal'));
+}
+
+module.exports.formatLogs = formatLogs;
+
+module.exports.formatError = formatError;
+
+module.exports.stripColors = stripColors;

package/lib/utils/pipe_utils.d.ts

@@ -39,3 +39,18 @@ export function statusEmoji(status: string): string;
  * @returns {string} - A formatted full name string for the test object.
  */
 export function fullName(t: object): string;
+/**
+ * Parses a comma-separated list of key-value pairs into an options object.
+ *
+ * The input string should be formatted as `"key1=value1,key2=value2,..."`.
+ * Whitespace around keys and values is trimmed. If the input is empty or undefined,
+ * an empty object is returned.
+ *
+ * @param {string} [optionsStr] - A comma-separated string of key=value pairs.
+ * @returns {Object} An object mapping option keys to their string values.
+ *
+ * @example
+ * parsePipeOptions('foo=bar,baz=qux');
+ * => Returns: { foo: 'bar', baz: 'qux' }
+ */
+export function parsePipeOptions(optionsStr?: string): any;

package/lib/utils/pipe_utils.js

@@ -6,6 +6,7 @@ exports.generateFilterRequestParams = generateFilterRequestParams;
 exports.setS3Credentials = setS3Credentials;
 exports.statusEmoji = statusEmoji;
 exports.fullName = fullName;
+exports.parsePipeOptions = parsePipeOptions;
 const constants_js_1 = require("../constants.js");
 /**
  * Set S3 credentials from the provided artifacts object.
@@ -27,6 +28,8 @@ function setS3Credentials(artifacts) {
         process.env.S3_SESSION_TOKEN = artifacts.SESSION_TOKEN;
     if (artifacts.presign)
         process.env.TESTOMATIO_PRIVATE_ARTIFACTS = '1';
+    if (artifacts.stack_artifacts)
+        process.env.TESTOMATIO_STACK_ARTIFACTS = '1';
     // endpoint is not received from the server; and shuld be empty if IAM used (credentails obtained from the testomat)
     process.env.S3_ENDPOINT = artifacts.ENDPOINT || '';
 }
@@ -36,6 +39,11 @@ function setS3Credentials(artifacts) {
  * @returns {Object|null} - An object containing the generated request parameters, or null if the type is invalid.
  */
 function generateFilterRequestParams(params) {
+    // Defensive check: ensure params is an object
+    if (!params || typeof params !== 'object') {
+        console.error(constants_js_1.APP_PREFIX, `Invalid parameters provided. Expected an object, got: ${typeof params}`);
+        return;
+    }
     const { type, id, apiKey } = params;
     if (!type) {
         return;
@@ -60,8 +68,11 @@ function generateFilterRequestParams(params) {
  *                   The object has properties "type" and "id".
  */
 function parseFilterParams(opts) {
-    const [type, id] = opts.split('=');
+    const [type, ...idParts] = opts.split('=');
+    const id = idParts.join('=');
     const validType = updateFilterType(type);
+    if (!validType)
+        return undefined;
     return {
         type: validType,
         id,
@@ -74,6 +85,8 @@ function parseFilterParams(opts) {
  *                            Returns undefined if the type is not valid.
  */
 function updateFilterType(type) {
+    if (!type || typeof type !== 'string')
+        return;
     let typeLowerCase = type.toLowerCase();
     const filterTypes = ['tag-name', 'plan', 'label', 'jira-ticket'];
     if (typeLowerCase === 'plan-id') {
@@ -87,7 +100,7 @@ function updateFilterType(type) {
         // "ims-issue", //TODO: WIP
     ];
     if (!filterTypes.includes(typeLowerCase)) {
-        console.log(constants_js_1.APP_PREFIX, `❗❗❗ Invalid "filter=${type}" start settings! Available option list: ${filterTypes}`);
+        console.log(constants_js_1.APP_PREFIX, `❗❗❗ Invalid filter: "${type}" start settings! Available option list: ${filterTypes}`);
         return;
     }
     const index = filterTypes.indexOf(typeLowerCase);
@@ -121,6 +134,33 @@ function fullName(t) {
         line += ` \`[${Object.values(t.example)}]\``;
     return line;
 }
+/**
+ * Parses a comma-separated list of key-value pairs into an options object.
+ *
+ * The input string should be formatted as `"key1=value1,key2=value2,..."`.
+ * Whitespace around keys and values is trimmed. If the input is empty or undefined,
+ * an empty object is returned.
+ *
+ * @param {string} [optionsStr] - A comma-separated string of key=value pairs.
+ * @returns {Object} An object mapping option keys to their string values.
+ *
+ * @example
+ * parsePipeOptions('foo=bar,baz=qux');
+ * => Returns: { foo: 'bar', baz: 'qux' }
+ */
+function parsePipeOptions(optionsStr) {
+    const options = {};
+    if (!optionsStr)
+        return options;
+    const pairs = optionsStr.split(',');
+    for (const pair of pairs) {
+        const [key, value] = pair.split('=');
+        if (key && value) {
+            options[key.trim()] = value.trim();
+        }
+    }
+    return options;
+}
 
 module.exports.updateFilterType = updateFilterType;
 
@@ -133,3 +173,5 @@ module.exports.setS3Credentials = setS3Credentials;
 module.exports.statusEmoji = statusEmoji;
 
 module.exports.fullName = fullName;
+
+module.exports.parsePipeOptions = parsePipeOptions;

package/lib/utils/utils.d.ts

@@ -17,6 +17,11 @@ export namespace fileSystem {
 export function foundedTestLog(app: any, tests: any): void;
 export function formatStep(step: any, shift?: number): any;
 export function getCurrentDateTime(): string;
+/**
+ * Gets current git commit SHA
+ * @returns {String|null} git commit SHA or null if not available
+ */
+export function getGitCommitSha(): string | null;
 /**
  * @param {String} testTitle - Test title
  *
@@ -59,3 +64,4 @@ export function transformEnvVarToBoolean(value: any): boolean;
  * @returns {String|null} validated suite ID or null if invalid
  */
 export function validateSuiteId(suiteId: string): string | null;
+export function applyFilter(command: any, tests: any): any;