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

package/lib/pipe/csv.js

@@ -1,126 +1,139 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const debug_1 = __importDefault(require("debug"));
-const path_1 = __importDefault(require("path"));
-const fs_1 = __importDefault(require("fs"));
-const csv_writer_1 = require("csv-writer");
-const picocolors_1 = __importDefault(require("picocolors"));
-const lodash_merge_1 = __importDefault(require("lodash.merge"));
-const utils_js_1 = require("../utils/utils.js");
-const constants_js_1 = require("../constants.js");
-const debug = (0, debug_1.default)('@testomatio/reporter:pipe:csv');
+const debug = require('debug')('@testomatio/reporter:pipe:csv');
+const path = require('path');
+const fs = require('fs');
+const csvWriter = require('csv-writer');
+const chalk = require('chalk');
+const merge = require('lodash.merge');
+const { isSameTest, getCurrentDateTime, ansiRegExp } = require('../utils/utils');
+const { CSV_HEADERS } = require('../constants');
+
 /**
- * @typedef {import('../../types/types.js').Pipe} Pipe
- * @typedef {import('../../types/types.js').TestData} TestData
+ * @typedef {import('../../types').Pipe} Pipe
+ * @typedef {import('../../types').TestData} TestData
  * @class CsvPipe
  * @implements {Pipe}
  */
 class CsvPipe {
-    constructor(params, store) {
-        this.store = store || {};
-        this.title = params.title || process.env.TESTOMATIO_TITLE;
-        this.results = [];
-        this.outputDir = 'export';
-        this.defaultReportName = 'report.csv';
-        this.csvFilename = process.env.TESTOMATIO_CSV_FILENAME;
-        this.isEnabled = false;
-        if (this.csvFilename) {
-            const filenameParts = this.csvFilename.split('.');
-            if (filenameParts.length > 0) {
-                this.isEnabled = true;
-                const baseFilename = filenameParts[0];
-                const defaultOutputFile = path_1.default.resolve(process.cwd(), this.outputDir, this.defaultReportName);
-                const outputFile = baseFilename === this.defaultReportName.split('.')[0] // = 'report'
-                    ? defaultOutputFile
-                    : path_1.default.resolve(process.cwd(), this.outputDir, `${(0, utils_js_1.getCurrentDateTime)()}_${baseFilename}.csv`);
-                this.outputFile = outputFile;
-            }
-        }
+  constructor(params, store) {
+    this.store = store || {};
+    this.title = params.title || process.env.TESTOMATIO_TITLE;
+    this.results = [];
+
+    this.outputDir = 'export';
+    this.defaultReportName = 'report.csv';
+    this.csvFilename = process.env.TESTOMATIO_CSV_FILENAME;
+    this.isEnabled = false;
+
+    if (this.csvFilename) {
+      const filenameParts = this.csvFilename.split('.');
+
+      if (filenameParts.length > 0) {
+        this.isEnabled = true;
+        const baseFilename = filenameParts[0];
+        const defaultOutputFile = path.resolve(process.cwd(), this.outputDir, this.defaultReportName);
+
+        const outputFile =
+          baseFilename === this.defaultReportName.split('.')[0] // = 'report'
+            ? defaultOutputFile
+            : path.resolve(process.cwd(), this.outputDir, `${getCurrentDateTime()}_${baseFilename}.csv`);
+
+        this.outputFile = outputFile;
+      }
     }
-    // TODO: to using SET opts as argument => prepareRun(opts)
-    async prepareRun() { }
-    async createRun() {
-        // empty
+  }
+
+  // TODO: to using SET opts as argument => prepareRun(opts)
+  async prepareRun() {}
+
+  async createRun() {
+    // empty
+  }
+
+  updateRun() {}
+
+  /**
+   * Create a folder that will contain the exported files
+   */
+  checkExportDir() {
+    if (!fs.existsSync(this.outputDir)) {
+      return fs.mkdirSync(this.outputDir);
     }
-    updateRun() { }
-    /**
-     * Create a folder that will contain the exported files
-     */
-    checkExportDir() {
-        if (!fs_1.default.existsSync(this.outputDir)) {
-            return fs_1.default.mkdirSync(this.outputDir);
-        }
+  }
+
+  /**
+   * 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' }]
+   */
+  async saveToCsv(data, headers) {
+    debug('Data', data);
+    // First, we check whether the export directory exists: if yes - OK, no - create it.
+    this.checkExportDir();
+
+    if (!this.outputFile) {
+      console.log(chalk.yellow(`⚠️  CSV file is not set, ignoring`));
+      return;
     }
-    /**
-     * 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' }]
-     */
-    async saveToCsv(data, headers) {
-        debug('Data', data);
-        // First, we check whether the export directory exists: if yes - OK, no - create it.
-        this.checkExportDir();
-        if (!this.outputFile) {
-            console.log(picocolors_1.default.yellow(`⚠️  CSV file is not set, ignoring`));
-            return;
-        }
-        console.log(picocolors_1.default.yellow(`⏳ The test results will be added to the csv. It will take some time...`));
-        try {
-            // Create csv writer object
-            const writer = (0, csv_writer_1.createObjectCsvWriter)({
-                path: this.outputFile,
-                header: headers,
-            });
-            // Save csv file based on the current data
-            return await writer.writeRecords(data);
-        }
-        catch (e) {
-            console.log('Unknown csv error: ', e);
-        }
+
+    console.log(chalk.yellow(`⏳ The test results will be added to the csv. It will take some time...`));
+
+    try {
+      // Create csv writer object
+      const writer = csvWriter.createObjectCsvWriter({
+        path: this.outputFile,
+        header: headers,
+      });
+      // Save csv file based on the current data
+      return await writer.writeRecords(data);
+    } catch (e) {
+      console.log('Unknown csv error: ', e);
     }
-    /**
-     * 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) {
-        if (!this.isEnabled)
-            return;
-        const index = this.results.findIndex(t => (0, utils_js_1.isSameTest)(t, test));
-        // update if they were already added
-        if (index >= 0) {
-            this.results[index] = (0, lodash_merge_1.default)(this.results[index], test);
-            return;
-        }
-        const { suite_title, title, status, message, stack } = test;
-        this.results.push({
-            suite_title,
-            title,
-            status,
-            message: message.replace((0, utils_js_1.ansiRegExp)(), ''),
-            stack: stack.replace((0, utils_js_1.ansiRegExp)(), ''),
-        });
+  }
+
+  /**
+   * 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) {
+    if (!this.isEnabled) return;
+
+    const index = this.results.findIndex(t => isSameTest(t, test));
+    // update if they were already added
+    if (index >= 0) {
+      this.results[index] = merge(this.results[index], test);
+      return;
     }
-    /**
-     * @param {{ tests?: TestData[] }} runParams
-     * @returns {Promise<void>}
-     */
-    async finishRun(runParams) {
-        if (!this.isEnabled)
-            return;
-        if (runParams.tests)
-            runParams.tests.forEach(t => this.addTest(t));
-        // Save results based on the default headers
-        if (this.isEnabled) {
-            await this.saveToCsv(this.results, constants_js_1.CSV_HEADERS);
-            console.log(picocolors_1.default.green(`🗃️  Recording completed! You can check the result in file = ${this.outputFile}`));
-        }
-    }
-    toString() {
-        return 'csv exporter';
+
+    const { suite_title, title, status, message, stack } = test;
+
+    this.results.push({
+      suite_title,
+      title,
+      status,
+      message: message.replace(ansiRegExp(), ''),
+      stack: stack.replace(ansiRegExp(), ''),
+    });
+  }
+
+  /**
+   * @param {{ tests?: TestData[] }} runParams
+   * @returns {Promise<void>}
+   */
+  async finishRun(runParams) {
+    if (!this.isEnabled) return;
+
+    if (runParams.tests) runParams.tests.forEach(t => this.addTest(t));
+    // Save results based on the default headers
+    if (this.isEnabled) {
+      await this.saveToCsv(this.results, CSV_HEADERS);
+      console.log(chalk.green(`🗃️  Recording completed! You can check the result in file = ${this.outputFile}`));
     }
+  }
+
+  toString() {
+    return 'csv exporter';
+  }
 }
+
 module.exports = CsvPipe;

package/lib/pipe/debug.js

@@ -1,122 +1,103 @@
-"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');
+const fs = require('fs');
+const path = require('path');
+const os = require('os');
+const { APP_PREFIX } = require('../constants');
+const debug = require('debug')('@testomatio/reporter:pipe:debug');
+// upgrade to latest for ESM
+const prettyMs = require('pretty-ms');
+
 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, '');
-            // Create symlink to ensure consistent path to latest debug file
-            const symlinkPath = path_1.default.join(os_1.default.tmpdir(), 'testomatio.debug.latest.json');
-            try {
-                // Remove existing symlink if it exists
-                if (fs_1.default.existsSync(symlinkPath)) {
-                    fs_1.default.unlinkSync(symlinkPath);
-                }
-                // Create new symlink pointing to the timestamped debug file
-                fs_1.default.symlinkSync(this.logFilePath, symlinkPath);
-                debug('Created symlink:', symlinkPath, '->', this.logFilePath);
-            }
-            catch (err) {
-                debug('Failed to create symlink:', err.message);
-            }
-            console.log(constants_js_1.APP_PREFIX, '🪲 Debug file 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;
-        await this.batchUpload();
-        if (this.batch.intervalFunction)
-            clearInterval(this.batch.intervalFunction);
-        this.logToFile({ action: 'finishRun', params });
-        console.log(constants_js_1.APP_PREFIX, '🪲 Debug Saved to', this.logFilePath);
-    }
-    toString() {
-        return 'Debug Reporter';
+  constructor(params, store) {
+    this.isEnabled = !!process.env.TESTOMATIO_DEBUG || !!process.env.DEBUG;
+    if (this.isEnabled) {
+      this.batch = {
+        isEnabled: params.isBatchEnabled ?? !process.env.TESTOMATIO_DISABLE_BATCH_UPLOAD ?? true,
+        intervalFunction: null,
+        intervalTime: 5000,
+        tests: [],
+        batchIndex: 0,
+      };
+      this.logFilePath = path.join(os.tmpdir(), `testomatio.debug.${Date.now()}.json`);
+      this.store = store || {};
+
+      debug('Creating debug file:', this.logFilePath);
+      fs.writeFileSync(this.logFilePath, '');
+      console.log(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: `+${prettyMs(timePassedFromLastAction)}`, ...logData });
+    fs.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(APP_PREFIX, '🪲. Debug Saved to', this.logFilePath);
+  }
+
+  toString() {
+    return 'Debug Reporter';
+  }
 }
-exports.DebugPipe = DebugPipe;
 
-module.exports.DebugPipe = DebugPipe;
+module.exports = DebugPipe;