@testomatio/reporter 2.3.7-beta.9-stack-artifacts → 2.3.7-rc.1

package/README.md

@@ -13,7 +13,7 @@ Testomat.io Reporter (this npm package) supports:
 - 🔎 [Stack traces](./docs/stacktrace.md) and error messages
 - 🐙 [GitHub](./docs/pipes/github.md), [GitLab](./docs/pipes/gitlab.md) & [Bitbucket](./docs/pipes/bitbucket.md) integration
 - 🚅 Realtime reports
-- 🗃️ Other test frameworks supported via [JUNit XML](./docs/junit.md)
+- 🗃️ Other test frameworks supported via [JUnit XML](./docs/junit.md) with [XML import configuration](./docs/xml-imports.md)
 - 🚶‍♀️ Steps _(work in progress)_
 - 📄 [Logger](./docs/logger.md) _(work in progress, supports Jest for now)_
 - ☁️ Custom properties and metadata _(work in progress)_

package/lib/bin/cli.js

@@ -37,12 +37,17 @@ program
 program
     .command('start')
     .description('Start a new run and return its ID')
-    .action(async () => {
+    .option('--kind <type>', 'Specify run type: automated, manual, or mixed')
+    .action(async (opts) => {
     (0, utils_js_1.cleanLatestRunId)();
     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(() => {
+    const createRunParams = {};
+    if (opts.kind) {
+        createRunParams.kind = opts.kind;
+    }
+    client.createRun(createRunParams).then(() => {
         console.log(process.env.runId);
         process.exit(0);
     });
@@ -70,6 +75,7 @@ program
     .description('Run tests with the specified command')
     .argument('<command>', 'Test runner command')
     .option('--filter <filter>', 'Additional execution filter')
+    .option('--kind <type>', 'Specify run type: automated, manual, or mixed')
     .action(async (command, opts) => {
     const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || config_js_1.config.TESTOMATIO;
     const title = process.env.TESTOMATIO_TITLE;
@@ -108,8 +114,12 @@ program
             process.exit(code);
         });
     };
+    const createRunParams = {};
+    if (opts.kind) {
+        createRunParams.kind = opts.kind;
+    }
     if (apiKey) {
-        await client.createRun().then(runTests);
+        await client.createRun(createRunParams).then(runTests);
     }
     else {
         await runTests();

package/lib/bin/startTest.js

@@ -35,7 +35,7 @@ while (i < args.length) {
         newArgs[0] = 'start';
     }
     else if (arg === '--finish') {
-        // Map --finish to finish command  
+        // Map --finish to finish command
         newArgs[0] = 'finish';
     }
     else {
@@ -46,8 +46,8 @@ while (i < args.length) {
 }
 // Execute the main CLI with mapped arguments
 const child = (0, node_child_process_1.spawn)(process.execPath, [cliPath, ...newArgs], {
-    stdio: 'inherit'
+    stdio: 'inherit',
 });
-child.on('exit', (code) => {
+child.on('exit', code => {
     process.exit(code);
 });

package/lib/client.d.ts

@@ -44,7 +44,7 @@ export class Client {
      *
      * @returns {Promise<any>} - resolves to Run id which should be used to update / add test
      */
-    createRun(params: any): Promise<any>;
+    createRun(params?: {}): Promise<any>;
     /**
      * Updates test status and its data
      *

package/lib/client.js

@@ -131,7 +131,7 @@ class Client {
      *
      * @returns {Promise<any>} - resolves to Run id which should be used to update / add test
      */
-    async createRun(params) {
+    async createRun(params = {}) {
         if (!this.pipes || !this.pipes.length)
             this.pipes = await (0, index_js_1.pipesFactory)(params || this.paramsForPipesFactory || {}, this.pipeStore);
         debug('Creating run...');
@@ -139,7 +139,7 @@ class Client {
         if (!this.pipes?.filter(p => p.isEnabled).length)
             return Promise.resolve();
         this.queue = this.queue
-            .then(() => Promise.all(this.pipes.map(p => p.createRun())))
+            .then(() => Promise.all(this.pipes.map(p => p.createRun(params))))
             .catch(err => console.log(constants_js_1.APP_PREFIX, err))
             .then(() => {
             const runId = this.pipeStore?.runId;
@@ -173,7 +173,7 @@ class Client {
          * @type {TestData}
          */
         const { rid, error = null, steps: originalSteps, title, suite_title, } = testData;
-        const steps = originalSteps;
+        let steps = originalSteps;
         const uploadedFiles = [];
         const stackArtifactsEnabled = (0, utils_js_1.transformEnvVarToBoolean)(process.env.TESTOMATIO_STACK_ARTIFACTS);
         const { time = 0, example = null, files = [], filesBuffers = [], code = null, file, suite_id, test_id, timestamp, links, manuallyAttachedArtifacts, overwrite, tags, } = testData;
@@ -192,10 +192,10 @@ class Client {
             message = error?.message;
         }
         let fullLogs = this.formatLogs({ error: errorFormatted, steps, logs: testData.logs });
-        if (stackArtifactsEnabled) {
-            const timestamp = +new Date;
-            uploadedFiles.push(this.uploader.uploadFileAsBuffer(Buffer.from(stripColors(fullLogs), 'utf8'), [this.runId, rid, `logs_${timestamp}.log`]));
+        if (stackArtifactsEnabled && fullLogs?.trim()?.length > 0) {
+            uploadedFiles.push(this.uploader.uploadFileAsBuffer(Buffer.from(stripColors(fullLogs), 'utf8'), [this.runId, rid, `logs_${+new Date}.log`]));
             fullLogs = '';
+            steps = null;
         }
         if (!this.pipes || !this.pipes.length)
             this.pipes = await (0, index_js_1.pipesFactory)(this.paramsForPipesFactory || {}, this.pipeStore);
@@ -294,7 +294,7 @@ class Client {
                 const uploadedArtifacts = this.uploader.successfulUploads.map(file => ({
                     relativePath: file.path.replace(process.cwd(), ''),
                     link: file.link,
-                    sizePretty: (0, filesize_1.filesize)(file.size, { round: 0 }).toString(),
+                    sizePretty: file.size == null ? 'unknown' : (0, filesize_1.filesize)(file.size, { round: 0 }).toString(),
                 }));
                 uploadedArtifacts.forEach(upload => {
                     debug(`🟢Uploaded artifact`, `${upload.relativePath},`, 'size:', `${upload.sizePretty},`, 'link:', `${upload.link}`);
@@ -304,7 +304,7 @@ class Client {
                 console.log(constants_js_1.APP_PREFIX, `🗄️ ${this.uploader.failedUploads.length} artifacts 🔴${picocolors_1.default.bold('failed')} to upload`);
                 const failedUploads = this.uploader.failedUploads.map(file => ({
                     relativePath: file.path.replace(process.cwd(), ''),
-                    sizePretty: (0, filesize_1.filesize)(file.size, { round: 0 }).toString(),
+                    sizePretty: file.size == null ? 'unknown' : (0, filesize_1.filesize)(file.size, { round: 0 }).toString(),
                 }));
                 const pathPadding = Math.max(...failedUploads.map(upload => upload.relativePath.length)) + 1;
                 failedUploads.forEach(upload => {

package/lib/pipe/testomatio.d.ts

@@ -47,11 +47,12 @@ declare class TestomatioPipe implements Pipe {
     prepareRun(opts: any): Promise<string[]>;
     /**
      * Creates a new run on Testomat.io
-     * @param {{isBatchEnabled?: boolean}} params
+     * @param {{isBatchEnabled?: boolean, kind?: string}} params
      * @returns Promise<void>
      */
     createRun(params?: {
         isBatchEnabled?: boolean;
+        kind?: string;
     }): Promise<void>;
     runUrl: string;
     runPublicUrl: any;

package/lib/pipe/testomatio.js

@@ -148,7 +148,7 @@ class TestomatioPipe {
     }
     /**
      * Creates a new run on Testomat.io
-     * @param {{isBatchEnabled?: boolean}} params
+     * @param {{isBatchEnabled?: boolean, kind?: string}} params
      * @returns Promise<void>
      */
     async createRun(params = {}) {
@@ -184,6 +184,7 @@ class TestomatioPipe {
             label: this.label,
             shared_run: this.sharedRun,
             shared_run_timeout: this.sharedRunTimeout,
+            kind: params.kind,
         }).filter(([, value]) => !!value));
         debug(' >>>>>> Run params', JSON.stringify(runParams, null, 2));
         if (this.runId) {
@@ -420,7 +421,7 @@ class TestomatioPipe {
             if (this.runUrl && this.proceed) {
                 const notFinishedMessage = picocolors_1.default.yellow(picocolors_1.default.bold('Run was not finished because of $TESTOMATIO_PROCEED'));
                 console.log(constants_js_1.APP_PREFIX, `📊 ${notFinishedMessage}. Report URL: ${picocolors_1.default.magenta(this.runUrl)}`);
-                console.log(constants_js_1.APP_PREFIX, `🛬 Run to finish it: TESTOMATIO_RUN=${this.runId} npx start-test-run --finish`);
+                console.log(constants_js_1.APP_PREFIX, `🛬 Run to finish it: TESTOMATIO_RUN=${this.runId} npx @testomatio/reporter finish`);
             }
             if (this.hasUnmatchedTests) {
                 console.log('');