@testomatio/reporter 0.6.2 → 0.6.5

package/Changelog.md

@@ -1,3 +1,16 @@
+# 0.6.5
+
+* Fixed test statuses for runs in JUnit reporter
+
+# 0.6.4
+
+* Added `TESTOMATIO_PROCEED=1` param to not close current run
+* Fixed priority of commands from `npx @testomatio/reporter`
+
+# 0.6.3
+
+* Fixed `npx start-test-run` to launch commands
+
 # 0.6.2
 
 * Added `--env-file` option to load env variables from env file

package/README.md

@@ -168,7 +168,7 @@ exports.config = {
 Run the following command from you project folder:
 
 ```bash
-TESTOMATIO={API_KEY} npx @testomatio/reporter@latest -c 'npx protractor conf.js'
+TESTOMATIO={API_KEY} npx start-test-run -c 'npx protractor conf.js'
 ```
 
 ### WebdriverIO
@@ -205,7 +205,7 @@ For making screenshots on failed tests add the following hook to `wdio.conf.js`:
 Run the following command from you project folder:
 
 ```bash
-TESTOMATIO={API_KEY} npx @testomatio/reporter -c 'npx wdio wdio.conf.js'
+TESTOMATIO={API_KEY} npx start-test-run -c 'npx wdio wdio.conf.js'
 ```
 
 ## JUnit Reports
@@ -349,8 +349,7 @@ Testomat.io will not create tests from the report if they have not been previous
 TESTOMATIO={API_KEY} TESTOMATIO_CREATE=1 <actual run command>
 ```
 
-
-### Adding Report to Run by ID
+### Add Report to Run by ID
 
 This feature is widely used when a run is executed on CI.
 A run is created before the test is started and it is marked as `scheduled`. Then
@@ -360,6 +359,21 @@ a report is assigned to that run using `TESTOMATIO_RUN` environment variable and
 TESTOMATIO={API_KEY} TESTOMATIO_RUN={RUN_ID} <actual run command>
 ```
 
+### Do Not Finalize Run
+
+If multiple reports are added to the same run, each of them should not finalize the run. 
+In this case use `TESTOMATIO_PROCEED=1` environment variable, so the Run will be shown as `Running`
+
+```
+TESTOMATIO={API_KEY} TESTOMATIO_PROCEED=1 TESTOMATIO_RUN={RUN_ID} <actual run command>
+```
+
+After all reports were attached and run can be execute the following command:
+
+```
+TESTOMATIO={API_KEY} TESTOMATIO_RUN={RUN_ID} npx start-test-run --finish
+```
+
 ### Setting Report Title
 
 Give a title to your reports by passing it as environment variable to `TESTOMATIO_TITLE`.
@@ -482,7 +496,7 @@ TESTOMATIO_DISABLE_ARTIFACTS=1
 If you want to create a run and obtain its `{RUN_ID}` from [testomat.io](https://testomat.io) you can use `--launch` option:
 
 ```bash
-TESTOMATIO={API_KEY} npx @testomatio/reporter@latest --launch
+TESTOMATIO={API_KEY} npx start-test-run --launch
 ```
 
 This command will return `{RUN_ID}` which you can pass to other testrunner processes.
@@ -494,5 +508,5 @@ This command will return `{RUN_ID}` which you can pass to other testrunner proce
 If you want to finish a run started by `--launch` use `--finish` option. `TESTOMATIO_RUN` environment variable is required:
 
 ```bash
-TESTOMATIO={API_KEY} TESTOMATIO_RUN={RUN_ID} npx @testomatio/reporter@latest --finish
+TESTOMATIO={API_KEY} TESTOMATIO_RUN={RUN_ID} npx start-test-run --finish
 ```

package/lib/bin/reportXml.js

@@ -7,6 +7,7 @@ const { APP_PREFIX } = require('../constants');
 const XmlReader = require("../xmlReader");
 
 const { version } = require('../../package.json');
+
 console.log(chalk.cyan.bold(` 🤩 Testomat.io XML Reporter v${version}`));
 
 program
@@ -20,7 +21,7 @@ program
       pattern += '.xml';
     }
     let { javaTests, lang } = opts;
-    if (opts.envFile) require('dotenv').config(opts.envFile);
+    if (opts.envFile) require('dotenv').config(opts.envFile); // eslint-disable-line
     if (javaTests === true) javaTests = 'src/test/java';
     lang = lang?.toLowerCase();
     const runReader = new XmlReader({ javaTests, lang });

package/lib/bin/startTest.js

@@ -4,10 +4,9 @@ const program = require('commander');
 const chalk = require('chalk');
 const TestomatClient = require('../client');
 const { APP_PREFIX, FINISHED } = require('../constants');
-
 const { version } = require('../../package.json');
-console.log(chalk.cyan.bold(` 🤩 Testomat.io Reporter v${version}`));
 
+console.log(chalk.cyan.bold(` 🤩 Testomat.io Reporter v${version}`));
 
 program
   .option('-c, --command <cmd>', 'Test runner command')
@@ -17,7 +16,7 @@ program
   .action(opts => {
 
     const { command, launch, finish } = opts;
-    if (opts.envFile) require('dotenv').config(opts.envFile);
+    if (opts.envFile) require('dotenv').config(opts.envFile); // eslint-disable-line
 
     const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || process.env.TESTOMATIO;
     const title = process.env.TESTOMATIO_TITLE;
@@ -52,7 +51,12 @@ program
 
     let exitCode = 0;
 
-    if (command) return;
+    if (!command.split) {
+      process.exitCode = 255;
+      console.log(APP_PREFIX, `No command provided. Use -c option to launch a test runner.`);
+      return;
+    }
+
     const testCmds = command.split(' ');
     console.log(APP_PREFIX, `🚀 Running`, chalk.green(command));
 

package/lib/client.js

@@ -24,7 +24,8 @@ class TestomatClient {
   constructor(params) {
     this.apiKey = params.apiKey || process.env.TESTOMATIO;
     this.title = params.title || process.env.TESTOMATIO_TITLE;
-    this.createNewTests = !!process.env.TESTOMATIO_CREATE
+    this.createNewTests = !!process.env.TESTOMATIO_CREATE;
+    this.proceed = process.env.TESTOMATIO_PROCEED;
     this.env  = TESTOMATIO_ENV;
     this.parallel = params.parallel;
     this.runId = process.env.runId;
@@ -197,7 +198,7 @@ class TestomatClient {
   updateRunStatus(status, isParallel) {
     this.queue = this.queue
       .then(async () => {
-        if (this.runId) {
+        if (this.runId && !this.proceed) {
           let statusEvent;
           if (status === FINISHED) statusEvent = 'finish';
           if (status === PASSED) statusEvent = 'pass';
@@ -221,6 +222,11 @@ class TestomatClient {
             );
           }
         }
+        if (this.runUrl && this.proceed) {
+          const notFinishedMessage = chalk.yellow.bold('Run was not finished because of $TESTOMATIO_PROCEED');
+          console.log(APP_PREFIX, `📊 ${notFinishedMessage}. Report URL: ${chalk.magenta(this.runUrl)}`);
+          console.log(APP_PREFIX, `🛬 Run to finish it: TESTOMATIO_RUN=${this.runId} npx start-test-run --finish`);
+        }
       })
       .catch(err => {
         console.log(APP_PREFIX, 'Error updating status, skipping...', err);

package/lib/xmlReader.js

@@ -248,6 +248,7 @@ class XmlReader {
     const dataString = JSON.stringify({
       ...this.stats,
       api_key: this.requestParams.apiKey,
+      status_event: 'finish',
       tests: this.tests,
     });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "0.6.2",
+  "version": "0.6.5",
   "description": "Testomatio Reporter Client",
   "main": "./lib/reporter.js",
   "repository": "git@github.com:testomatio/reporter.git",
@@ -54,7 +54,7 @@
     "puppeteer": "^13.1.2"
   },
   "bin": {
-    "start-test-run": "./lib/bin/startTest.js",
-    "report-xml": "./lib/bin/reportXml.js"
+    "report-xml": "./lib/bin/reportXml.js",
+    "start-test-run": "./lib/bin/startTest.js"
   }
 }