@testomatio/reporter 1.6.13 → 2.0.1-beta-esm

package/lib/bin/startTest.js

@@ -1,118 +1,105 @@
 #!/usr/bin/env node
-const spawn = require('cross-spawn');
-const { program } = require('commander');
-const chalk = require('chalk');
-const TestomatClient = require('../client');
-const { APP_PREFIX, STATUS } = require('../constants');
-const { version } = require('../../package.json');
-const config = require('../config');
-
-console.log(chalk.cyan.bold(` 🤩 Testomat.io Reporter v${version}`));
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const cross_spawn_1 = require("cross-spawn");
+const commander_1 = require("commander");
+const picocolors_1 = __importDefault(require("picocolors"));
+const client_js_1 = __importDefault(require("../client.js"));
+const constants_js_1 = require("../constants.js");
+const package_json_1 = require("../../package.json");
+const config_js_1 = require("../config.js");
+const dotenv_1 = __importDefault(require("dotenv"));
+console.log(picocolors_1.default.cyan(picocolors_1.default.bold(` 🤩 Testomat.io Reporter v${package_json_1.version}`)));
+const program = new commander_1.Command();
 program
-  .option('-c, --command <cmd>', 'Test runner command')
-  .option('--launch', 'Start a new run and return its ID')
-  .option('--finish', 'Finish Run by its ID')
-  .option('--env-file <envfile>', 'Load environment variables from env file')
-  .option('--filter <filter>', 'Additional execution filter')
-  .action(async opts => {
+    .option('-c, --command <cmd>', 'Test runner command')
+    .option('--launch', 'Start a new run and return its ID')
+    .option('--finish', 'Finish Run by its ID')
+    .option('--env-file <envfile>', 'Load environment variables from env file')
+    .option('--filter <filter>', 'Additional execution filter')
+    .action(async (opts) => {
     const { launch, finish, filter } = opts;
     let { command } = opts;
-
-    if (opts.envFile) require('dotenv').config(opts.envFile); // eslint-disable-line
-
-    const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || config.TESTOMATIO;
+    if (opts.envFile)
+        dotenv_1.default.config({ path: opts.envFile });
+    const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || config_js_1.config.TESTOMATIO;
     const title = process.env.TESTOMATIO_TITLE;
-
     if (launch) {
-      console.log('Starting a new Run on Testomat.io...');
-      const client = new TestomatClient({ apiKey });
-
-      client.createRun().then(() => {
-        console.log(process.env.runId);
-        process.exit(0);
-      });
-      return;
+        console.log('Starting a new Run on Testomat.io...');
+        const client = new client_js_1.default({ apiKey });
+        client.createRun().then(() => {
+            console.log(process.env.runId);
+            process.exit(0);
+        });
+        return;
     }
-
     if (finish) {
-      if (!process.env.TESTOMATIO_RUN) {
-        console.log('TESTOMATIO_RUN environment variable must be set.');
-        return process.exit(1);
-      }
-
-      console.log('Finishing Run on Testomat.io...');
-
-      const client = new TestomatClient({ apiKey });
-
-      client.updateRunStatus(STATUS.FINISHED).then(() => {
-        console.log(chalk.yellow(`Run ${process.env.TESTOMATIO_RUN} was finished`));
-        process.exit(0);
-      });
-      return;
+        // TODO: add error in case of TESTOMATIO environment variable is not set
+        // because command is fine in console, but actually (on testomat.io) run is not finished
+        if (!process.env.TESTOMATIO_RUN) {
+            console.log('TESTOMATIO_RUN environment variable must be set.');
+            return process.exit(1);
+        }
+        console.log('Finishing Run on Testomat.io...');
+        const client = new client_js_1.default({ apiKey });
+        // @ts-ignore
+        client.updateRunStatus(constants_js_1.STATUS.FINISHED).then(() => {
+            console.log(picocolors_1.default.yellow(`Run ${process.env.TESTOMATIO_RUN} was finished`));
+            process.exit(0);
+        });
+        return;
     }
-
     let exitCode = 0;
-
     if (!command.split) {
-      process.exitCode = 255;
-      console.log(APP_PREFIX, `No command provided. Use -c option to launch a test runner.`);
-      return;
+        process.exitCode = 255;
+        console.log(constants_js_1.APP_PREFIX, `No command provided. Use -c option to launch a test runner.`);
+        return;
     }
-
-    const client = new TestomatClient({ apiKey, title, parallel: true });
-
+    const client = new client_js_1.default({ apiKey, title, parallel: true });
     if (filter) {
-      const [pipe, ...optsArray] = filter.split(':');
-      const pipeOptions = optsArray.join(':');
-
-      try {
-        const tests = await client.prepareRun({ pipe, pipeOptions });
-
-        if (!tests || tests.length === 0) {
-          return;
+        const [pipe, ...optsArray] = filter.split(':');
+        const pipeOptions = optsArray.join(':');
+        try {
+            const tests = await client.prepareRun({ pipe, pipeOptions });
+            if (!tests || tests.length === 0) {
+                return;
+            }
+            const grep = ` --grep (${tests.join('|')})`;
+            command += grep;
+        }
+        catch (err) {
+            console.log(constants_js_1.APP_PREFIX, err);
         }
-
-        const grep = ` --grep (${tests.join('|')})`;
-        command += grep;
-      } catch (err) {
-        console.log(APP_PREFIX, err);
-      }
     }
-
     const testCmds = command.split(' ');
-    console.log(APP_PREFIX, `🚀 Running`, chalk.green(command));
-
+    console.log(constants_js_1.APP_PREFIX, `🚀 Running`, picocolors_1.default.green(command));
     if (!apiKey) {
-      const cmd = spawn(testCmds[0], testCmds.slice(1), { stdio: 'inherit' });
-
-      cmd.on('close', code => {
-        console.log(APP_PREFIX, '⚠️ ', `Runner exited with ${chalk.bold(code)}, report is ignored`);
-
-        if (code > exitCode) exitCode = code;
-        process.exitCode = exitCode;
-      });
-
-      return;
+        const cmd = (0, cross_spawn_1.spawn)(testCmds[0], testCmds.slice(1), { stdio: 'inherit' });
+        cmd.on('close', code => {
+            console.log(constants_js_1.APP_PREFIX, '⚠️ ', `Runner exited with ${picocolors_1.default.bold(code)}, report is ignored`);
+            if (code > exitCode)
+                exitCode = code;
+            process.exitCode = exitCode;
+        });
+        return;
     }
-
     client.createRun().then(() => {
-      const cmd = spawn(testCmds[0], testCmds.slice(1), { stdio: 'inherit' });
-
-      cmd.on('close', code => {
-        const emoji = code === 0 ? '🟢' : '🔴';
-        console.log(APP_PREFIX, emoji, `Runner exited with ${chalk.bold(code)}`);
-        const status = code === 0 ? 'passed' : 'failed';
-        client.updateRunStatus(status, true);
-
-        if (code > exitCode) exitCode = code;
-        process.exitCode = exitCode;
-      });
+        const cmd = (0, cross_spawn_1.spawn)(testCmds[0], testCmds.slice(1), { stdio: 'inherit' });
+        cmd.on('close', code => {
+            const emoji = code === 0 ? '🟢' : '🔴';
+            console.log(constants_js_1.APP_PREFIX, emoji, `Runner exited with ${picocolors_1.default.bold(code)}`);
+            const status = code === 0 ? 'passed' : 'failed';
+            client.updateRunStatus(status, true);
+            if (code > exitCode)
+                exitCode = code;
+            process.exitCode = exitCode;
+        });
     });
-  });
-
+});
 if (process.argv.length <= 2) {
-  program.outputHelp();
+    program.outputHelp();
 }
-
 program.parse(process.argv);

package/lib/bin/uploadArtifacts.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/lib/bin/uploadArtifacts.js

@@ -1,87 +1,81 @@
 #!/usr/bin/env node
-const { program } = require('commander');
-const chalk = require('chalk');
-const debug = require('debug')('@testomatio/reporter:upload-cli');
-const TestomatClient = require('../client');
-const { APP_PREFIX } = require('../constants');
-const { version } = require('../../package.json');
-const config = require('../config');
-const { readLatestRunId } = require('../utils/utils');
-
-console.log(chalk.cyan.bold(` 🤩 Testomat.io Reporter v${version}`));
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const picocolors_1 = __importDefault(require("picocolors"));
+const debug_1 = __importDefault(require("debug"));
+const client_js_1 = __importDefault(require("../client.js"));
+const constants_js_1 = require("../constants.js");
+const package_json_1 = require("../../package.json");
+const config_js_1 = require("../config.js");
+const utils_js_1 = require("../utils/utils.js");
+const dotenv_1 = __importDefault(require("dotenv"));
+const debug = (0, debug_1.default)('@testomatio/reporter:upload-cli');
+console.log(picocolors_1.default.cyan(picocolors_1.default.bold(` 🤩 Testomat.io Reporter v${package_json_1.version}`)));
+const program = new commander_1.Command();
 program
-  .option('--env-file <envfile>', 'Load environment variables from env file')
-  .option('--force', 'Re-upload artifacts even if they were uploaded before')
-  .action(async opts => {
+    .option('--env-file <envfile>', 'Load environment variables from env file')
+    .option('--force', 'Re-upload artifacts even if they were uploaded before')
+    .action(async (opts) => {
     if (opts.envFile) {
-      require('dotenv').config(opts.envFile); // eslint-disable-line
-    } else {
-      // try to load from env file
-      require('dotenv').config(); // eslint-disable-line
+        dotenv_1.default.config({ path: opts.envFile });
     }
-
-    const apiKey = config.TESTOMATIO;
+    else {
+        dotenv_1.default.config();
+    }
+    const apiKey = config_js_1.config.TESTOMATIO;
     process.env.TESTOMATIO_DISABLE_ARTIFACTS = '';
-    const runId = process.env.TESTOMATIO_RUN || process.env.runId || readLatestRunId();
-
+    const runId = process.env.TESTOMATIO_RUN || process.env.runId || (0, utils_js_1.readLatestRunId)();
     if (!runId) {
-      console.log('TESTOMATIO_RUN environment variable must be set or restored from a previous run.');
-      return process.exit(1);
+        console.log('TESTOMATIO_RUN environment variable must be set or restored from a previous run.');
+        return process.exit(1);
     }
-
-    const client = new TestomatClient({
-      apiKey,
-      runId,
-      isBatchEnabled: false,
+    const client = new client_js_1.default({
+        apiKey,
+        runId,
+        isBatchEnabled: false,
     });
     let testruns = client.uploader.readUploadedFiles(process.env.TESTOMATIO_RUN);
-
     const numTotalArtifacts = testruns.length;
-
     debug('Found testruns:', testruns);
-
-    if (!opts.force) testruns = testruns.filter(tr => !tr.uploaded);
-
+    if (!opts.force)
+        testruns = testruns.filter(tr => !tr.uploaded);
     if (!testruns.length) {
-      console.log(APP_PREFIX, 'Total artifacts:', numTotalArtifacts);
-      if (numTotalArtifacts) {
-        console.log(APP_PREFIX, 'No new artifacts to upload');
-        console.log(APP_PREFIX, 'To re-upload artifacts run this command with --force flag');
-      }
-      process.exit(0);
+        console.log(constants_js_1.APP_PREFIX, 'Total artifacts:', numTotalArtifacts);
+        if (numTotalArtifacts) {
+            console.log(constants_js_1.APP_PREFIX, 'No new artifacts to upload');
+            console.log(constants_js_1.APP_PREFIX, 'To re-upload artifacts run this command with --force flag');
+        }
+        process.exit(0);
     }
-
     const testrunsByRid = testruns.reduce((acc, { rid, file }) => {
-      if (!acc[rid]) {
-        acc[rid] = [];
-      }
-      if (!acc[rid].includes(file)) acc[rid].push(file);
-      return acc;
+        if (!acc[rid]) {
+            acc[rid] = [];
+        }
+        if (!acc[rid].includes(file))
+            acc[rid].push(file);
+        return acc;
     }, {});
-
     // we need to obtain S3 credentials
     await client.createRun();
-
     client.uploader.checkEnabled();
     client.uploader.disableLogStorage();
-
     for (const rid in testrunsByRid) {
-      const files = testrunsByRid[rid];
-      await client.addTestRun(undefined, {
-        rid,
-        files,
-      });
+        const files = testrunsByRid[rid];
+        await client.addTestRun(undefined, {
+            rid,
+            files,
+        });
     }
-
-    console.log(APP_PREFIX, client.uploader.successfulUploads.length, 'artifacts uploaded');
+    console.log(constants_js_1.APP_PREFIX, client.uploader.successfulUploads.length, 'artifacts uploaded');
     if (client.uploader.failedUploads.length) {
-      console.log(APP_PREFIX, client.uploader.failedUploads.length, 'artifacts failed to upload');
+        console.log(constants_js_1.APP_PREFIX, client.uploader.failedUploads.length, 'artifacts failed to upload');
     }
-  });
-
+});
 if (process.argv.length <= 1) {
-  program.outputHelp();
+    program.outputHelp();
 }
-
 program.parse(process.argv);

package/lib/client.d.ts

@@ -0,0 +1,76 @@
+export default Client;
+export type TestData = import("../types/types.js").TestData;
+export type PipeResult = import("../types/types.js").PipeResult;
+/**
+ * @typedef {import('../types/types.js').TestData} TestData
+ * @typedef {import('../types/types.js').PipeResult} PipeResult
+ */
+export class Client {
+    /**
+     * Create a Testomat client instance
+     * @returns
+     */
+    constructor(params?: {});
+    paramsForPipesFactory: {};
+    pipeStore: {};
+    runId: `${string}-${string}-${string}-${string}-${string}`;
+    queue: Promise<void>;
+    version: any;
+    executionList: Promise<void>;
+    uploader: S3Uploader;
+    /**
+     * Asynchronously prepares the execution list for running tests through various pipes.
+     * Each pipe in the client is checked for enablement,
+     * and if all pipes are disabled, the function returns a resolved Promise.
+     * Otherwise, it executes the `prepareRun` method for each enabled pipe and collects the results.
+     * The results are then filtered to remove any undefined values.
+     * If no valid results are found, the function returns undefined.
+     * Otherwise, it returns the first non-empty array from the filtered results.
+     *
+     * @param {Object} params - The options for preparing the test execution list.
+     * @param {string} params.pipe - Name of the executed pipe.
+     * @param {string} params.pipeOptions - Filter option.
+     * @returns {Promise<any>} - A Promise that resolves to an
+     * array containing the prepared execution list,
+     * or resolves to undefined if no valid results are found or if all pipes are disabled.
+     */
+    prepareRun(params: {
+        pipe: string;
+        pipeOptions: string;
+    }): Promise<any>;
+    pipes: any[];
+    /**
+     * Used to create a new Test run
+     *
+     * @returns {Promise<any>} - resolves to Run id which should be used to update / add test
+     */
+    createRun(params: any): Promise<any>;
+    /**
+     * Updates test status and its data
+     *
+     * @param {string|undefined} status
+     * @param {TestData} [testData]
+     * @returns {Promise<PipeResult[]>}
+     */
+    addTestRun(status: string | undefined, testData?: TestData): Promise<PipeResult[]>;
+    /**
+     *
+     * Updates the status of the current test run and finishes the run.
+     * @param {'passed' | 'failed' | 'skipped' | 'finished'} status - The status of the current test run.
+     * Must be one of "passed", "failed", or "finished"
+     * @param {boolean} [isParallel] - Whether the current test run was executed in parallel with other tests.
+     * @returns {Promise<any>} - A Promise that resolves when finishes the run.
+     */
+    updateRunStatus(status: "passed" | "failed" | "skipped" | "finished", isParallel?: boolean): Promise<any>;
+    /**
+     * Returns the formatted stack including the stack trace, steps, and logs.
+     * @returns {string}
+     */
+    formatLogs({ error, steps, logs }: {
+        error: any;
+        steps: any;
+        logs: any;
+    }): string;
+    formatError(error: any, message: any): string;
+}
+import { S3Uploader } from './uploader.js';