@testomatio/reporter 2.0.0-beta-esm → 2.0.1-beta-esm

package/lib/bin/cli.js

@@ -0,0 +1,228 @@
+#!/usr/bin/env node
+"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 cross_spawn_1 = require("cross-spawn");
+const glob_1 = __importDefault(require("glob"));
+const debug_1 = __importDefault(require("debug"));
+const client_js_1 = __importDefault(require("../client.js"));
+const xmlReader_js_1 = __importDefault(require("../xmlReader.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 picocolors_1 = __importDefault(require("picocolors"));
+const filesize_1 = require("filesize");
+const dotenv_1 = __importDefault(require("dotenv"));
+const debug = (0, debug_1.default)('@testomatio/reporter:xml-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
+    .version(package_json_1.version)
+    .option('--env-file <envfile>', 'Load environment variables from env file')
+    .hook('preAction', thisCommand => {
+    const opts = thisCommand.opts();
+    if (opts.envFile) {
+        dotenv_1.default.config({ path: opts.envFile });
+    }
+    else {
+        dotenv_1.default.config();
+    }
+});
+program
+    .command('start')
+    .description('Start a new run and return its ID')
+    .action(async () => {
+    console.log('Starting a new Run on Testomat.io...');
+    const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || config_js_1.config.TESTOMATIO;
+    const client = new client_js_1.default({ apiKey });
+    client.createRun().then(() => {
+        console.log(process.env.runId);
+        process.exit(0);
+    });
+});
+program
+    .command('finish')
+    .description('Finish Run by its ID')
+    .action(async () => {
+    process.env.TESTOMATIO_RUN ||= (0, utils_js_1.readLatestRunId)();
+    if (!process.env.TESTOMATIO_RUN) {
+        console.log('TESTOMATIO_RUN environment variable must be set or restored from a previous run.');
+        return process.exit(1);
+    }
+    console.log('Finishing Run on Testomat.io...');
+    const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || config_js_1.config.TESTOMATIO;
+    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);
+    });
+});
+program
+    .command('run')
+    .description('Run tests with the specified command')
+    .argument('<command>', 'Test runner command')
+    .option('--filter <filter>', 'Additional execution filter')
+    .action(async (command, opts) => {
+    const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || config_js_1.config.TESTOMATIO;
+    const title = process.env.TESTOMATIO_TITLE;
+    if (!command || !command.split) {
+        console.log(constants_js_1.APP_PREFIX, `No command provided. Use -c option to launch a test runner.`);
+        return process.exit(255);
+    }
+    const client = new client_js_1.default({ apiKey, title, parallel: true });
+    if (opts.filter) {
+        const [pipe, ...optsArray] = opts.filter.split(':');
+        const pipeOptions = optsArray.join(':');
+        try {
+            const tests = await client.prepareRun({ pipe, pipeOptions });
+            if (tests && tests.length > 0) {
+                command += ` --grep (${tests.join('|')})`;
+            }
+        }
+        catch (err) {
+            console.log(constants_js_1.APP_PREFIX, err);
+        }
+    }
+    console.log(constants_js_1.APP_PREFIX, `🚀 Running`, picocolors_1.default.green(command));
+    const runTests = () => {
+        const testCmds = command.split(' ');
+        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)}`);
+            if (apiKey) {
+                const status = code === 0 ? 'passed' : 'failed';
+                client.updateRunStatus(status, true);
+            }
+            process.exit(code);
+        });
+    };
+    if (apiKey) {
+        client.createRun().then(runTests);
+    }
+    else {
+        runTests();
+    }
+});
+program
+    .command('xml')
+    .description('Parse XML reports and upload to Testomat.io')
+    .argument('<pattern>', 'XML file pattern')
+    .option('-d, --dir <dir>', 'Project directory')
+    .option('--java-tests [java-path]', 'Load Java tests from path, by default: src/test/java')
+    .option('--lang <lang>', 'Language used (python, ruby, java)')
+    .option('--timelimit <time>', 'default time limit in seconds to kill a stuck process')
+    .action(async (pattern, opts) => {
+    if (!pattern.endsWith('.xml')) {
+        pattern += '.xml';
+    }
+    let { javaTests, lang } = opts;
+    if (javaTests === true)
+        javaTests = 'src/test/java';
+    lang = lang?.toLowerCase();
+    const runReader = new xmlReader_js_1.default({ javaTests, lang });
+    const files = glob_1.default.sync(pattern, { cwd: opts.dir || process.cwd() });
+    if (!files.length) {
+        console.log(constants_js_1.APP_PREFIX, `Report can't be created. No XML files found 😥`);
+        process.exit(1);
+    }
+    for (const file of files) {
+        console.log(constants_js_1.APP_PREFIX, `Parsed ${file}`);
+        runReader.parse(file);
+    }
+    let timeoutTimer;
+    if (opts.timelimit) {
+        timeoutTimer = setTimeout(() => {
+            console.log(`⚠️  Reached timeout of ${opts.timelimit}s. Exiting... (Exit code is 0 to not fail the pipeline)`);
+            process.exit(0);
+        }, parseInt(opts.timelimit, 10) * 1000);
+    }
+    try {
+        await runReader.createRun();
+        await runReader.uploadData();
+    }
+    catch (err) {
+        console.log(constants_js_1.APP_PREFIX, 'Error updating status, skipping...', err);
+    }
+    if (timeoutTimer)
+        clearTimeout(timeoutTimer);
+});
+program
+    .command('upload-artifacts')
+    .description('Upload artifacts to Testomat.io')
+    .option('--force', 'Re-upload artifacts even if they were uploaded before')
+    .action(async (opts) => {
+    const apiKey = config_js_1.config.TESTOMATIO;
+    process.env.TESTOMATIO_DISABLE_ARTIFACTS = '';
+    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);
+    }
+    const client = new client_js_1.default({
+        apiKey,
+        runId,
+        isBatchEnabled: false,
+    });
+    let testruns = client.uploader.readUploadedFiles(runId);
+    const numTotalArtifacts = testruns.length;
+    debug('Found testruns:', testruns);
+    if (!opts.force)
+        testruns = testruns.filter(tr => !tr.uploaded);
+    if (!testruns.length) {
+        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;
+    }, {});
+    await client.createRun();
+    client.uploader.checkEnabled();
+    client.uploader.disableLogStorage();
+    for (const rid in testrunsByRid) {
+        const files = testrunsByRid[rid];
+        await client.addTestRun(undefined, { rid, files });
+    }
+    console.log(constants_js_1.APP_PREFIX, '🗄️', client.uploader.successfulUploads.length, 'artifacts 🟢uploaded');
+    if (client.uploader.successfulUploads.length) {
+        debug('\n', constants_js_1.APP_PREFIX, `🗄️ ${client.uploader.successfulUploads.length} artifacts uploaded to S3 bucket`);
+        const uploadedArtifacts = client.uploader.successfulUploads.map(file => ({
+            relativePath: file.path.replace(process.cwd(), ''),
+            link: file.link,
+            sizePretty: (0, filesize_1.filesize)(file.size, { round: 0 }).toString(),
+        }));
+        uploadedArtifacts.forEach(upload => {
+            debug(`🟢Uploaded artifact`, `${upload.relativePath},`, 'size:', `${upload.sizePretty},`, 'link:', `${upload.link}`);
+        });
+    }
+    const filesizeStrMaxLength = 7;
+    if (client.uploader.failedUploads.length) {
+        console.log('\n', constants_js_1.APP_PREFIX, '🗄️', client.uploader.failedUploads.length, `artifacts 🔴${picocolors_1.default.bold('failed')} to upload`);
+        const failedUploads = client.uploader.failedUploads.map(({ path, size }) => ({
+            relativePath: path.replace(process.cwd(), ''),
+            sizePretty: (0, filesize_1.filesize)(size, { round: 0 }).toString(),
+        }));
+        const pathPadding = Math.max(...failedUploads.map(upload => upload.relativePath.length)) + 1;
+        failedUploads.forEach(upload => {
+            console.log(`  ${picocolors_1.default.gray('|')} 🔴 ${upload.relativePath.padEnd(pathPadding)} ${picocolors_1.default.gray(`| ${upload.sizePretty.padStart(filesizeStrMaxLength)} |`)}`);
+        });
+    }
+});
+program.parse(process.argv);
+if (!process.argv.slice(2).length) {
+    program.outputHelp();
+}

package/lib/bin/reportXml.d.ts

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

package/lib/bin/reportXml.js

@@ -4,16 +4,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = __importDefault(require("commander"));
+const commander_1 = require("commander");
 const picocolors_1 = __importDefault(require("picocolors"));
-const glob_1 = __importDefault(require("glob"));
+const glob_1 = require("glob");
 const debug_1 = __importDefault(require("debug"));
 const constants_js_1 = require("../constants.js");
 const xmlReader_js_1 = __importDefault(require("../xmlReader.js"));
 const package_json_1 = require("../../package.json");
+const dotenv_1 = __importDefault(require("dotenv"));
 const debug = (0, debug_1.default)('@testomatio/reporter:xml-cli');
 console.log(picocolors_1.default.cyan(picocolors_1.default.bold(` 🤩 Testomat.io XML Reporter v${package_json_1.version}`)));
-commander_1.default
+const program = new commander_1.Command();
+program
     .arguments('<pattern>')
     .option('-d, --dir <dir>', 'Project directory')
     .option('--java-tests [java-path]', 'Load Java tests from path, by default: src/test/java')
@@ -28,13 +30,13 @@ commander_1.default
     if (opts.envFile) {
         console.log(constants_js_1.APP_PREFIX, 'Loading env file:', opts.envFile);
         debug('Loading env file: %s', opts.envFile);
-        require('dotenv').config({ path: opts.envFile }); // eslint-disable-line
+        dotenv_1.default.config({ path: opts.envFile });
     }
-    if (javaTests === true)
-        javaTests = 'src/test/java';
     lang = lang?.toLowerCase();
+    if (javaTests === true || (lang === 'java' && !javaTests))
+        javaTests = 'src/test/java';
     const runReader = new xmlReader_js_1.default({ javaTests, lang });
-    const files = glob_1.default.sync(pattern, { cwd: opts.dir || process.cwd() });
+    const files = glob_1.glob.sync(pattern, { cwd: opts.dir || process.cwd() });
     if (!files.length) {
         console.log(constants_js_1.APP_PREFIX, `Report can't be created. No XML files found 😥`);
         process.exitCode = 1;
@@ -62,6 +64,6 @@ commander_1.default
         clearTimeout(timeoutTimer);
 });
 if (process.argv.length < 3) {
-    commander_1.default.outputHelp();
+    program.outputHelp();
 }
-commander_1.default.parse(process.argv);
+program.parse(process.argv);

package/lib/bin/startTest.d.ts

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

package/lib/bin/startTest.js

@@ -5,14 +5,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const cross_spawn_1 = require("cross-spawn");
-const commander_1 = __importDefault(require("commander"));
+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}`)));
-commander_1.default
+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')
@@ -22,7 +24,7 @@ commander_1.default
     const { launch, finish, filter } = opts;
     let { command } = opts;
     if (opts.envFile)
-        require('dotenv').config(opts.envFile); // eslint-disable-line
+        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) {
@@ -35,6 +37,8 @@ commander_1.default
         return;
     }
     if (finish) {
+        // 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);
@@ -96,6 +100,6 @@ commander_1.default
     });
 });
 if (process.argv.length <= 2) {
-    commander_1.default.outputHelp();
+    program.outputHelp();
 }
-commander_1.default.parse(process.argv);
+program.parse(process.argv);

package/lib/bin/uploadArtifacts.d.ts

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

package/lib/bin/uploadArtifacts.js

@@ -0,0 +1,81 @@
+#!/usr/bin/env node
+"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) => {
+    if (opts.envFile) {
+        dotenv_1.default.config({ path: opts.envFile });
+    }
+    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 || (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);
+    }
+    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 (!testruns.length) {
+        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;
+    }, {});
+    // 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,
+        });
+    }
+    console.log(constants_js_1.APP_PREFIX, client.uploader.successfulUploads.length, 'artifacts uploaded');
+    if (client.uploader.failedUploads.length) {
+        console.log(constants_js_1.APP_PREFIX, client.uploader.failedUploads.length, 'artifacts failed to upload');
+    }
+});
+if (process.argv.length <= 1) {
+    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';