@testomatio/reporter 2.0.0-beta-esm → 2.0.0-beta.1-xml

package/lib/pipe/debug.d.ts

@@ -0,0 +1,29 @@
+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/debug.js

@@ -0,0 +1,108 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DebugPipe = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const os_1 = __importDefault(require("os"));
+const debug_1 = __importDefault(require("debug"));
+const constants_js_1 = require("../constants.js");
+const pretty_ms_1 = __importDefault(require("pretty-ms"));
+const debug = (0, debug_1.default)('@testomatio/reporter:pipe:debug');
+class DebugPipe {
+    constructor(params, store) {
+        this.params = params || {};
+        this.store = store || {};
+        this.isEnabled = !!process.env.TESTOMATIO_DEBUG || !!process.env.DEBUG;
+        if (this.isEnabled) {
+            this.batch = {
+                isEnabled: this.params.isBatchEnabled ?? !process.env.TESTOMATIO_DISABLE_BATCH_UPLOAD ?? true,
+                intervalFunction: null,
+                intervalTime: 5000,
+                tests: [],
+                batchIndex: 0,
+            };
+            this.logFilePath = path_1.default.join(os_1.default.tmpdir(), `testomatio.debug.${Date.now()}.json`);
+            debug('Creating debug file:', this.logFilePath);
+            fs_1.default.writeFileSync(this.logFilePath, '');
+            console.log(constants_js_1.APP_PREFIX, '🪲. Debug created:');
+            this.testomatioEnvVars = Object.keys(process.env)
+                .filter(key => key.startsWith('TESTOMATIO_'))
+                .reduce((acc, key) => {
+                acc[key] = process.env[key];
+                return acc;
+            }, {});
+            this.logToFile({ datetime: new Date().toISOString(), timestamp: Date.now() });
+            this.logToFile({ data: 'variables', testomatioEnvVars: this.testomatioEnvVars });
+            this.logToFile({ data: 'store', store: this.store || {} });
+            // Bind batchUpload to the instance
+            this.batchUpload = this.batchUpload.bind(this);
+        }
+    }
+    /**
+     * 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) {
+        if (!this.isEnabled)
+            return;
+        const timePassedFromLastAction = Date.now() - (this.lastActionTimestamp || Date.now());
+        this.lastActionTimestamp = Date.now();
+        const logLine = JSON.stringify({ t: `+${(0, pretty_ms_1.default)(timePassedFromLastAction)}`, ...logData });
+        fs_1.default.appendFileSync(this.logFilePath, `${logLine}\n`);
+    }
+    async prepareRun(opts) {
+        if (!this.isEnabled)
+            return [];
+        this.logToFile({ action: 'prepareRun', data: opts });
+    }
+    async createRun(params = {}) {
+        if (!this.isEnabled)
+            return;
+        if (params.isBatchEnabled === true || params.isBatchEnabled === false)
+            this.batch.isEnabled = params.isBatchEnabled;
+        if (!this.isEnabled)
+            return {};
+        if (this.batch.isEnabled)
+            this.batch.intervalFunction = setInterval(this.batchUpload, this.batch.intervalTime);
+        this.logToFile({ action: 'createRun', params });
+    }
+    async addTest(data) {
+        if (!this.isEnabled)
+            return;
+        if (!this.batch.isEnabled)
+            this.logToFile({ action: 'addTest', testId: data });
+        else
+            this.batch.tests.push(data);
+        if (!this.batch.intervalFunction)
+            await this.batchUpload();
+    }
+    async batchUpload() {
+        this.batch.batchIndex++;
+        if (!this.batch.isEnabled)
+            return;
+        if (!this.batch.tests.length)
+            return;
+        const testsToSend = this.batch.tests.splice(0);
+        this.logToFile({ action: 'addTestsBatch', tests: testsToSend });
+    }
+    async finishRun(params) {
+        if (!this.isEnabled)
+            return;
+        this.logToFile({ actions: 'finishRun', params });
+        await this.batchUpload();
+        if (this.batch.intervalFunction)
+            clearInterval(this.batch.intervalFunction);
+        console.log(constants_js_1.APP_PREFIX, '🪲. Debug Saved to', this.logFilePath);
+    }
+    toString() {
+        return 'Debug Reporter';
+    }
+}
+exports.DebugPipe = DebugPipe;
+
+module.exports.DebugPipe = DebugPipe;

package/lib/pipe/github.d.ts

@@ -0,0 +1,30 @@
+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/github.js

@@ -1,4 +1,37 @@
 "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 };
 };
@@ -8,14 +41,13 @@ const path_1 = __importDefault(require("path"));
 const picocolors_1 = __importDefault(require("picocolors"));
 const humanize_duration_1 = __importDefault(require("humanize-duration"));
 const lodash_merge_1 = __importDefault(require("lodash.merge"));
-const rest_1 = require("@octokit/rest");
 const constants_js_1 = require("../constants.js");
 const utils_js_1 = require("../utils/utils.js");
 const pipe_utils_js_1 = require("../utils/pipe_utils.js");
 const debug = (0, debug_1.default)('@testomatio/reporter:pipe:github');
 /**
- * @typedef {import('../../types').Pipe} Pipe
- * @typedef {import('../../types').TestData} TestData
+ * @typedef {import('../../types/types.js').Pipe} Pipe
+ * @typedef {import('../../types/types.js').TestData} TestData
  * @class GitHubPipe
  * @implements {Pipe}
  */
@@ -62,7 +94,8 @@ class GitHubPipe {
             return;
         if (runParams.tests)
             runParams.tests.forEach(t => this.addTest(t));
-        this.octokit = new rest_1.Octokit({
+        const { Octokit } = await Promise.resolve().then(() => __importStar(require('@octokit/rest')));
+        this.octokit = new Octokit({
             auth: this.token,
         });
         const [owner, repo] = (this.repo || '').split('/');
@@ -130,7 +163,6 @@ class GitHubPipe {
         if (this.tests.length > 0) {
             body += '\n<details>\n<summary><h3>🐢 Slowest Tests</h3></summary>\n\n';
             body += this.tests
-                // eslint-disable-next-line no-unsafe-optional-chaining
                 .sort((a, b) => b?.run_time - a?.run_time)
                 .slice(0, 5)
                 .map(t => `* ${(0, pipe_utils_js_1.fullName)(t)} (${(0, humanize_duration_1.default)(parseFloat(t.run_time))})`)

package/lib/pipe/gitlab.d.ts

@@ -0,0 +1,23 @@
+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;
+    prepareRun(): Promise<void>;
+    createRun(): Promise<void>;
+    addTest(test: any): void;
+    finishRun(runParams: any): Promise<void>;
+    toString(): string;
+    updateRun(): void;
+}

package/lib/pipe/gitlab.js

@@ -17,8 +17,8 @@ const debug = (0, debug_1.default)('@testomatio/reporter:pipe:gitlab');
 //! and your pipeline trigger should be merge_request
 /**
  * @class GitLabPipe
- * @typedef {import('../../types').Pipe} Pipe
- * @typedef {import('../../types').TestData} TestData
+ * @typedef {import('../../types/types.js').Pipe} Pipe
+ * @typedef {import('../../types/types.js').TestData} TestData
  */
 class GitLabPipe {
     constructor(params, store = {}) {
@@ -119,7 +119,6 @@ class GitLabPipe {
         if (this.tests.length > 0) {
             body += '\n<details>\n<summary><h3>🐢 Slowest Tests</h3></summary>\n\n';
             body += this.tests
-                // eslint-disable-next-line no-unsafe-optional-chaining
                 .sort((a, b) => b?.run_time - a?.run_time)
                 .slice(0, 5)
                 .map(t => `* ${(0, pipe_utils_js_1.fullName)(t)} (${(0, humanize_duration_1.default)(parseFloat(t.run_time))})`)

package/lib/pipe/html.d.ts

@@ -0,0 +1,35 @@
+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/html.js

@@ -53,12 +53,13 @@ class HtmlPipe {
     async createRun() {
         // empty
     }
+    async prepareRun() { }
     updateRun() {
         // empty
     }
     /**
      * 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').RunData} test - object which includes each test entry.
+     * @param {import('../../types/types.js').RunData} test - object which includes each test entry.
      */
     addTest(test) {
         if (!this.isEnabled)
@@ -106,6 +107,13 @@ class HtmlPipe {
             console.log(picocolors_1.default.blue(msg));
         }
         tests.forEach(test => {
+            // steps could be an array or a string
+            test.steps = Array.isArray(test.steps)
+                ? (test.steps = test.steps
+                    .map(step => (0, utils_js_1.formatStep)(step))
+                    .flat()
+                    .join('\n'))
+                : test.steps;
             if (!test.message?.trim()) {
                 test.message = "This test has no 'message' code";
             }
@@ -185,7 +193,6 @@ class HtmlPipe {
           <option value="1">25</option>
           <option value="2">50</option>
         </select>`));
-        /* eslint-disable */
         handlebars_1.default.registerHelper('emptyDataComponent', () => {
             const svgFilePath = path_1.default.join(__dirname, '..', 'template', 'emptyData.svg');
             const svgContent = fs_1.default.readFileSync(svgFilePath, 'utf8');
@@ -199,7 +206,6 @@ class HtmlPipe {
           </div>
           <div>`);
         });
-        /* eslint-enable */
         handlebars_1.default.registerHelper('pageDispleyElements', tests => {
             // We wrapp the lines to the HTML format we need
             const totalTests = JSON.parse(JSON.stringify(tests)
@@ -227,7 +233,6 @@ class HtmlPipe {
             }
             statuses.forEach(status => {
                 for (const option in paginationOptions) {
-                    // eslint-disable-next-line no-prototype-builtins
                     if (paginationOptions.hasOwnProperty(option)) {
                         const pageSize = paginationOptions[option];
                         let filteredItems = totalTests;

package/lib/pipe/index.d.ts

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

package/lib/pipe/index.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+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 };
 };
@@ -37,6 +47,7 @@ const gitlab_js_1 = __importDefault(require("./gitlab.js"));
 const csv_js_1 = __importDefault(require("./csv.js"));
 const html_js_1 = __importDefault(require("./html.js"));
 const bitbucket_js_1 = require("./bitbucket.js");
+const debug_js_1 = require("./debug.js");
 async function pipesFactory(params, opts) {
     const extraPipes = [];
     // Add extra pipes into package.json file:
@@ -72,12 +83,11 @@ async function pipesFactory(params, opts) {
         new csv_js_1.default(params, opts),
         new html_js_1.default(params, opts),
         new bitbucket_js_1.BitbucketPipe(params, opts),
+        new debug_js_1.DebugPipe(params, opts),
         ...extraPipes,
     ];
     const pipesEnabled = pipes.filter(p => p.isEnabled);
-    console.log(constants_js_1.APP_PREFIX, picocolors_1.default.cyan('Pipes:'), picocolors_1.default.cyan(pipesEnabled
-        .map(p => p.toString())
-        .join(', ') || 'No pipes enabled'));
+    console.log(constants_js_1.APP_PREFIX, picocolors_1.default.cyan('Pipes:'), picocolors_1.default.cyan(pipesEnabled.map(p => p.toString()).join(', ') || 'No pipes enabled'));
     if (!pipesEnabled.length) {
         console.log(constants_js_1.APP_PREFIX, picocolors_1.default.dim('If you want to use Testomatio reporter, pass your token as TESTOMATIO env variable'));
     }

package/lib/pipe/testomatio.d.ts

@@ -0,0 +1,70 @@
+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;
+    axios: import("axios").AxiosInstance;
+    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): void;
+    /**
+     * @param {import('../../types/types.js').RunData} params
+     * @returns
+     */
+    finishRun(params: import("../../types/types.js").RunData): Promise<void>;
+    toString(): string;
+    #private;
+}