@testomatio/reporter 2.0.1-beta.3 → 2.0.1-beta.5-timestamp

package/lib/pipe/csv.d.ts

@@ -1,47 +0,0 @@
-export default CsvPipe;
-export type Pipe = import("../../types/types.js").Pipe;
-export type TestData = import("../../types/types.js").TestData;
-/**
- * @typedef {import('../../types/types.js').Pipe} Pipe
- * @typedef {import('../../types/types.js').TestData} TestData
- * @class CsvPipe
- * @implements {Pipe}
- */
-declare class CsvPipe implements Pipe {
-    constructor(params: any, store: any);
-    store: any;
-    title: any;
-    results: any[];
-    outputDir: string;
-    defaultReportName: string;
-    csvFilename: string;
-    isEnabled: boolean;
-    outputFile: string;
-    prepareRun(): Promise<void>;
-    createRun(): Promise<void>;
-    updateRun(): void;
-    /**
-     * Create a folder that will contain the exported files
-     */
-    checkExportDir(): void;
-    /**
-     * Save data to the csv file.
-     * @param {Object} data - data that will be added to the CSV file.
-     * Example: [{suite_title: "Suite #1", test: "Test-case-1", message: "Test msg"}]
-     * @param {Object} headers - csv file headers. Example: [{ id: 'suite_title', title: 'Suite_title' }]
-     */
-    saveToCsv(data: any, headers: any): Promise<void>;
-    /**
-     * Add test data to the result array for saving. As a result of this function, we get a result object to save.
-     * @param {Object} test - object which includes each test entry.
-     */
-    addTest(test: any): void;
-    /**
-     * @param {{ tests?: TestData[] }} runParams
-     * @returns {Promise<void>}
-     */
-    finishRun(runParams: {
-        tests?: TestData[];
-    }): Promise<void>;
-    toString(): string;
-}

package/lib/pipe/debug.d.ts

@@ -1,29 +0,0 @@
-export class DebugPipe {
-    constructor(params: any, store: any);
-    params: any;
-    store: any;
-    isEnabled: boolean;
-    batch: {
-        isEnabled: any;
-        intervalFunction: any;
-        intervalTime: number;
-        tests: any[];
-        batchIndex: number;
-    };
-    logFilePath: string;
-    testomatioEnvVars: {};
-    batchUpload(): Promise<void>;
-    /**
-     * Logs data to a file if logging is enabled.
-     *
-     * @param {Object} logData - The data to be logged.
-     * @returns {Promise<void>} A promise that resolves when the log data has been appended to the file.
-     */
-    logToFile(logData: any): Promise<void>;
-    lastActionTimestamp: number;
-    prepareRun(opts: any): Promise<any[]>;
-    createRun(params?: {}): Promise<{}>;
-    addTest(data: any): Promise<void>;
-    finishRun(params: any): Promise<void>;
-    toString(): string;
-}

package/lib/pipe/github.d.ts

@@ -1,30 +0,0 @@
-export default GitHubPipe;
-export type Pipe = import("../../types/types.js").Pipe;
-export type TestData = import("../../types/types.js").TestData;
-/**
- * @typedef {import('../../types/types.js').Pipe} Pipe
- * @typedef {import('../../types/types.js').TestData} TestData
- * @class GitHubPipe
- * @implements {Pipe}
- */
-declare class GitHubPipe implements Pipe {
-    constructor(params: any, store?: {});
-    isEnabled: boolean;
-    store: {};
-    tests: any[];
-    token: any;
-    ref: string;
-    repo: string;
-    jobKey: string;
-    hiddenCommentData: string;
-    issue: number;
-    start: Date;
-    prepareRun(): Promise<void>;
-    createRun(): Promise<void>;
-    addTest(test: any): void;
-    finishRun(runParams: any): Promise<void>;
-    octokit: import("@octokit/core").Octokit & import("@octokit/plugin-rest-endpoint-methods/dist-types/generated/method-types.js").RestEndpointMethods & import("@octokit/plugin-rest-endpoint-methods").Api & {
-        paginate: import("@octokit/plugin-paginate-rest").PaginateInterface;
-    };
-    toString(): string;
-}

package/lib/pipe/gitlab.d.ts

@@ -1,25 +0,0 @@
-export default GitLabPipe;
-export type Pipe = import("../../types/types.js").Pipe;
-export type TestData = import("../../types/types.js").TestData;
-/**
- * @class GitLabPipe
- * @typedef {import('../../types/types.js').Pipe} Pipe
- * @typedef {import('../../types/types.js').TestData} TestData
- */
-declare class GitLabPipe {
-    constructor(params: any, store?: {});
-    isEnabled: boolean;
-    ENV: NodeJS.ProcessEnv;
-    store: {};
-    tests: any[];
-    token: any;
-    hiddenCommentData: string;
-    client: Gaxios;
-    prepareRun(): Promise<void>;
-    createRun(): Promise<void>;
-    addTest(test: any): void;
-    finishRun(runParams: any): Promise<void>;
-    toString(): string;
-    updateRun(): void;
-}
-import { Gaxios } from 'gaxios';

package/lib/pipe/html.d.ts

@@ -1,35 +0,0 @@
-export default HtmlPipe;
-declare class HtmlPipe {
-    constructor(params: any, store?: {});
-    store: {};
-    title: any;
-    apiKey: any;
-    isHtml: string;
-    isEnabled: boolean;
-    htmlOutputPath: string;
-    fullHtmlOutputPath: string;
-    filenameMsg: string;
-    tests: any[];
-    htmlReportDir: string;
-    htmlReportName: string;
-    templateFolderPath: string;
-    templateHtmlPath: string;
-    createRun(): Promise<void>;
-    prepareRun(): Promise<void>;
-    updateRun(): void;
-    /**
-     * Add test data to the result array for saving. As a result of this function, we get a result object to save.
-     * @param {import('../../types/types.js').RunData} test - object which includes each test entry.
-     */
-    addTest(test: import("../../types/types.js").RunData): void;
-    finishRun(runParams: any): Promise<void>;
-    /**
-     * Generates an HTML report based on provided test data and a template.
-     * @param {object} opts - Test options used to generate the HTML report:
-     * runParams, tests, outputPath, templatePath
-     * @returns {void} - This function does not return anything.
-     */
-    buildReport(opts: object): void;
-    toString(): string;
-    #private;
-}

package/lib/pipe/index.d.ts

@@ -1 +0,0 @@
-export function pipesFactory(params: any, opts: any): Promise<any[]>;

package/lib/pipe/testomatio.d.ts

@@ -1,71 +0,0 @@
-export default TestomatioPipe;
-export type Pipe = import("../../types/types.js").Pipe;
-export type TestData = import("../../types/types.js").TestData;
-/**
- * @typedef {import('../../types/types.js').Pipe} Pipe
- * @typedef {import('../../types/types.js').TestData} TestData
- * @class TestomatioPipe
- * @implements {Pipe}
- */
-declare class TestomatioPipe implements Pipe {
-    constructor(params: any, store: any);
-    batch: {
-        isEnabled: any;
-        intervalFunction: any;
-        intervalTime: number;
-        tests: any[];
-        batchIndex: number;
-        numberOfTimesCalledWithoutTests: number;
-    };
-    retriesTimestamps: any[];
-    reportingCanceledDueToReqFailures: boolean;
-    notReportedTestsCount: number;
-    isEnabled: boolean;
-    url: any;
-    apiKey: any;
-    parallel: any;
-    store: any;
-    title: any;
-    sharedRun: boolean;
-    sharedRunTimeout: boolean;
-    groupTitle: any;
-    env: string;
-    label: string;
-    client: Gaxios;
-    proceed: string;
-    jiraId: string;
-    runId: any;
-    createNewTests: any;
-    hasUnmatchedTests: boolean;
-    requestFailures: number;
-    /**
-     * Asynchronously prepares and retrieves the Testomat.io test grepList based on the provided options.
-     * @param {Object} opts - The options for preparing the test grepList.
-     * @returns {Promise<string[]>} - An array containing the retrieved
-     * test grepList, or an empty array if no tests are found or the request is disabled.
-     * @throws {Error} - Throws an error if there was a problem while making the request.
-     */
-    prepareRun(opts: any): Promise<string[]>;
-    /**
-     * Creates a new run on Testomat.io
-     * @param {{isBatchEnabled?: boolean}} params
-     * @returns Promise<void>
-     */
-    createRun(params?: {
-        isBatchEnabled?: boolean;
-    }): Promise<void>;
-    runUrl: string;
-    runPublicUrl: any;
-    /**
-     * Adds a test to the batch uploader (or reports a single test if batch uploading is disabled)
-     */
-    addTest(data: any): Promise<void | import("gaxios").GaxiosResponse<any>>;
-    /**
-     * @param {import('../../types/types.js').RunData} params
-     * @returns
-     */
-    finishRun(params: import("../../types/types.js").RunData): Promise<void>;
-    toString(): string;
-    #private;
-}
-import { Gaxios } from 'gaxios';

package/lib/replay.d.ts

@@ -1,31 +0,0 @@
-export class Replay {
-    constructor(options?: {});
-    apiKey: any;
-    dryRun: any;
-    onProgress: any;
-    onLog: any;
-    onError: any;
-    /**
-     * Get the default debug file path
-     * @returns {string} Path to the latest debug file
-     */
-    getDefaultDebugFile(): string;
-    /**
-     * Parse a debug file and extract test data
-     * @param {string} debugFile - Path to the debug file
-     * @returns {Object} Parsed debug data
-     */
-    parseDebugFile(debugFile: string): any;
-    /**
-     * Restore environment variables from debug data
-     * @param {Object} envVars - Environment variables to restore
-     */
-    restoreEnvironmentVariables(envVars: any): void;
-    /**
-     * Replay test data to Testomat.io
-     * @param {string} debugFile - Path to debug file (optional, uses default if not provided)
-     * @returns {Promise<Object>} Replay results
-     */
-    replay(debugFile: string): Promise<any>;
-}
-export default Replay;

package/lib/replay.js

@@ -1,237 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Replay = void 0;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const os_1 = __importDefault(require("os"));
-const client_js_1 = __importDefault(require("./client.js"));
-const constants_js_1 = require("./constants.js");
-const config_js_1 = require("./config.js");
-class Replay {
-    constructor(options = {}) {
-        this.apiKey = options.apiKey || config_js_1.config.TESTOMATIO || undefined;
-        this.dryRun = options.dryRun || false;
-        this.onProgress = options.onProgress || (() => { });
-        this.onLog = options.onLog || console.log;
-        this.onError = options.onError || console.error;
-    }
-    /**
-     * Get the default debug file path
-     * @returns {string} Path to the latest debug file
-     */
-    getDefaultDebugFile() {
-        return path_1.default.join(os_1.default.tmpdir(), 'testomatio.debug.latest.json');
-    }
-    /**
-     * Parse a debug file and extract test data
-     * @param {string} debugFile - Path to the debug file
-     * @returns {Object} Parsed debug data
-     */
-    parseDebugFile(debugFile) {
-        if (!fs_1.default.existsSync(debugFile)) {
-            throw new Error(`Debug file not found: ${debugFile}`);
-        }
-        const fileContent = fs_1.default.readFileSync(debugFile, 'utf-8');
-        const lines = fileContent.trim().split('\n').filter(line => line.trim() !== '');
-        if (lines.length === 0) {
-            throw new Error('Debug file is empty');
-        }
-        let runParams = {};
-        let finishParams = {};
-        let parseErrors = 0;
-        const testsMap = new Map(); // Use Map to deduplicate by rid
-        const testsWithoutRid = []; // For tests without rid (backward compatibility)
-        const envVars = {};
-        // Parse debug file line by line
-        for (const [lineIndex, line] of lines.entries()) {
-            try {
-                const logEntry = JSON.parse(line);
-                if (logEntry.data === 'variables' && logEntry.testomatioEnvVars) {
-                    Object.assign(envVars, logEntry.testomatioEnvVars);
-                }
-                else if (logEntry.action === 'createRun') {
-                    runParams = logEntry.params || {};
-                }
-                else if (logEntry.action === 'addTestsBatch' && logEntry.tests) {
-                    // Process each test in the batch
-                    for (const test of logEntry.tests) {
-                        if (test.rid) {
-                            // Handle tests with rid (deduplicate)
-                            const existingTest = testsMap.get(test.rid);
-                            if (existingTest) {
-                                // Merge test data - prioritize non-null/non-empty values
-                                const mergedTest = { ...existingTest };
-                                Object.keys(test).forEach(key => {
-                                    if (test[key] !== null && test[key] !== undefined) {
-                                        if (key === 'files' && Array.isArray(test[key]) && test[key].length > 0) {
-                                            // Merge files arrays
-                                            mergedTest.files = [...(existingTest.files || []), ...test[key]];
-                                        }
-                                        else if (key === 'artifacts' && Array.isArray(test[key]) && test[key].length > 0) {
-                                            // Merge artifacts arrays
-                                            mergedTest.artifacts = [...(existingTest.artifacts || []), ...test[key]];
-                                        }
-                                        else if (existingTest[key] === null || existingTest[key] === undefined ||
-                                            (Array.isArray(existingTest[key]) && existingTest[key].length === 0)) {
-                                            // Use new value if existing is null/undefined/empty array
-                                            mergedTest[key] = test[key];
-                                        }
-                                    }
-                                });
-                                testsMap.set(test.rid, mergedTest);
-                            }
-                            else {
-                                testsMap.set(test.rid, { ...test });
-                            }
-                        }
-                        else {
-                            // Handle tests without rid (no deduplication)
-                            testsWithoutRid.push({ ...test });
-                        }
-                    }
-                }
-                else if (logEntry.action === 'addTest' && logEntry.testId) {
-                    const test = logEntry.testId;
-                    if (test.rid) {
-                        // Handle tests with rid (deduplicate)
-                        const existingTest = testsMap.get(test.rid);
-                        if (existingTest) {
-                            // Merge with existing test
-                            const mergedTest = { ...existingTest, ...test };
-                            testsMap.set(test.rid, mergedTest);
-                        }
-                        else {
-                            testsMap.set(test.rid, { ...test });
-                        }
-                    }
-                    else {
-                        // Handle tests without rid (no deduplication)
-                        testsWithoutRid.push({ ...test });
-                    }
-                }
-                else if (logEntry.actions === 'finishRun') {
-                    finishParams = logEntry.params || {};
-                }
-            }
-            catch (err) {
-                parseErrors++;
-                if (parseErrors <= 3) {
-                    // Only show first 3 parse errors
-                    this.onError(`Failed to parse line ${lineIndex + 1}: ${line.substring(0, 100)}...`);
-                }
-            }
-        }
-        if (parseErrors > 3) {
-            this.onError(`${parseErrors - 3} more parse errors occurred`);
-        }
-        // Combine tests with rid and tests without rid
-        const allTests = [...Array.from(testsMap.values()), ...testsWithoutRid];
-        return {
-            runParams,
-            finishParams,
-            tests: allTests,
-            envVars,
-            parseErrors,
-            totalLines: lines.length
-        };
-    }
-    /**
-     * Restore environment variables from debug data
-     * @param {Object} envVars - Environment variables to restore
-     */
-    restoreEnvironmentVariables(envVars) {
-        // Only restore env vars that aren't already set (don't override current values)
-        Object.keys(envVars).forEach(key => {
-            if (process.env[key] === undefined || process.env[key] === '') {
-                process.env[key] = envVars[key];
-            }
-        });
-    }
-    /**
-     * Replay test data to Testomat.io
-     * @param {string} debugFile - Path to debug file (optional, uses default if not provided)
-     * @returns {Promise<Object>} Replay results
-     */
-    async replay(debugFile) {
-        if (!debugFile) {
-            debugFile = this.getDefaultDebugFile();
-        }
-        if (!this.apiKey) {
-            throw new Error('TESTOMATIO API key not found. Set TESTOMATIO environment variable.');
-        }
-        this.onLog(`Replaying data from debug file: ${debugFile}`);
-        // Parse the debug file
-        const debugData = this.parseDebugFile(debugFile);
-        const { runParams, finishParams, tests, envVars } = debugData;
-        this.onLog(`Found ${tests.length} tests to replay`);
-        if (tests.length === 0) {
-            throw new Error('No test data found in debug file');
-        }
-        // Restore environment variables
-        this.restoreEnvironmentVariables(envVars);
-        if (this.dryRun) {
-            return {
-                success: true,
-                testsCount: tests.length,
-                runParams,
-                finishParams,
-                envVars,
-                dryRun: true
-            };
-        }
-        // Create client and restore the run
-        const client = new client_js_1.default({
-            apiKey: this.apiKey,
-            isBatchEnabled: true,
-            ...runParams,
-        });
-        this.onLog('Publishing to run...');
-        await client.createRun(runParams);
-        // Send each test result
-        let successCount = 0;
-        let failureCount = 0;
-        for (const [index, test] of tests.entries()) {
-            try {
-                await client.addTestRun(test.status, test);
-                successCount++;
-                this.onProgress({
-                    current: index + 1,
-                    total: tests.length,
-                    test,
-                    success: true
-                });
-            }
-            catch (err) {
-                failureCount++;
-                this.onError(`Failed to send test ${index + 1}: ${err.message}`);
-                this.onProgress({
-                    current: index + 1,
-                    total: tests.length,
-                    test,
-                    success: false,
-                    error: err.message
-                });
-            }
-        }
-        await client.updateRunStatus(finishParams.status || constants_js_1.STATUS.FINISHED, finishParams.parallel || false);
-        const result = {
-            success: true,
-            testsCount: tests.length,
-            successCount,
-            failureCount,
-            runParams,
-            finishParams,
-            envVars,
-            runId: client.runId
-        };
-        this.onLog(`Successfully replayed ${successCount}/${tests.length} tests from debug file`);
-        return result;
-    }
-}
-exports.Replay = Replay;
-module.exports = Replay;
-
-module.exports.Replay = Replay;

package/lib/reporter-functions.d.ts

@@ -1,34 +0,0 @@
-declare namespace _default {
-    export { saveArtifact as artifact };
-    export { logMessage as log };
-    export { addStep as step };
-    export { setKeyValue as keyValue };
-}
-export default _default;
-/**
- * Stores path to file as artifact and uploads it to the S3 storage
- * @param {string | {path: string, type: string, name: string}} data - path to file or object with path, type and name
- */
-declare function saveArtifact(data: string | {
-    path: string;
-    type: string;
-    name: string;
-}, context?: any): void;
-/**
- * Attach log message(s) to the test report
- * @param  string
- */
-declare function logMessage(...args: any[]): void;
-/**
- * Similar to "log" function but marks message in report as a step
- * @param {string} message
- */
-declare function addStep(message: string): void;
-/**
- * Add key-value pair(s) to the test report
- * @param {{[key: string]: string} | string} keyValue object { key: value } (multiple props allowed) or key (string)
- * @param {string?} value
- */
-declare function setKeyValue(keyValue: {
-    [key: string]: string;
-} | string, value?: string | null): void;