@testomatio/reporter 0.6.1 → 0.6.4

package/Changelog.md

@@ -1,3 +1,16 @@
+# 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
+
 # 0.6.1
 
 * Fixed creating RunGroup with JUnit reporter

package/README.md

@@ -54,6 +54,9 @@ TESTOMATIO={API_KEY} npx start-test-run -c 'npx codeceptjs run-workers 2'
 
 > Specify a command to run with `-c` option in `start-test-run`
 
+Use `--env-file <envfile>` option to load environment variables from .env file. Inside env file TESTOMATIO credentials like `TESTOMATIO` api key or [S3 config](#attaching-test-artifacts) can be stored.
+
+
 ### Playwright
 
 Add a reporter to Playwright config:
@@ -165,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@latest -c 'npx protractor conf.js'
 ```
 
 ### WebdriverIO
@@ -202,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
@@ -248,6 +251,7 @@ TESTOMATIO={API_KEY} npx report-xml "{pattern}" --lang={lang}
 * `pattern` - is a glob pattern to match all XML files from report. For instance, `"test/report/**.xml"` or just `report.xml`
 * `--lang` option can be specified to identify source code of the project. Example: `--lang=Ruby` or `--lang=Java` or `--lang=Python`.
 * `--java-tests` option is avaiable for Java projects, and can be set if path to tests is different then `src/test/java`. When this option is enable, `lang` option is automatically set to `java`
+* `--env-file <envfile>` option to load environment variables from .env file. Inside env file TESTOMATIO credentials like `TESTOMATIO` api key or [S3 config](#attaching-test-artifacts) can be stored.
 
 
 > *Notice:* All options from [Advanced Usage](#advanced-usage) are also available for JUnit reporter
@@ -345,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
@@ -356,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`.
@@ -438,7 +456,14 @@ S3_FORCE_PATH_STYLE=true
 
 > It is important to add S3_FORCE_PATH_STYLE var for minio setup
 
-For local testing, it is recommended to store this configuration in `.env` file and load it with [dotenv](https://www.npmjs.com/package/dotenv) library.
+For local testing, it is recommended to store configuration in `.env` file. If you load configuration from a test runner, use [dotenv](https://www.npmjs.com/package/dotenv) library to load it.
+
+If you run a reporter via `start-test-run` or `report-xml` command use `--env-file` option to load variables from .env file:
+
+```
+npx start-test-run --env-file .env
+npx report-xml --env-file .env
+```
 
 On CI set environment variables in CI config.
 
@@ -471,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@latest --launch
 ```
 
 This command will return `{RUN_ID}` which you can pass to other testrunner processes.
@@ -483,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@latest --finish
 ```

package/lib/bin/reportXml.js

@@ -1,32 +1,33 @@
 #!/usr/bin/env node
 const program = require("commander");
-// const chalk = require("chalk");
+const chalk = require("chalk");
 const glob = require('glob');
 
 const { APP_PREFIX } = require('../constants');
 const XmlReader = require("../xmlReader");
 
-// const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || process.env.TESTOMATIO;
-// const title = process.env.TESTOMATIO_TITLE;
+const { version } = require('../../package.json');
 
-// console.log(chalk.cyan.bold(` 🤩 xmlReader by Testomat.io v${version}`));
+console.log(chalk.cyan.bold(` 🤩 Testomat.io XML Reporter v${version}`));
 
 program
   .arguments("<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("--env-file <envfile>", "Load environment variables from env file")
   .action(async (pattern, opts) => {
     if (!pattern.endsWith('.xml')) {
       pattern += '.xml';
     }
     let { javaTests, lang } = opts;
+    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 });
     const files = glob.sync(pattern, { cwd: opts.dir || process.cwd() });
     if (!files.length) {
-      console.log(APP_PREFIX,`Report can't be created. No XML files found 😥`);
+      console.log(APP_PREFIX, `Report can't be created. No XML files found 😥`);
       process.exitCode = 1;
       return;
     }
@@ -40,11 +41,11 @@ program
       await runReader.uploadData();
     } catch (err) {
       console.log(APP_PREFIX, 'Error updating status, skipping...', err);
+      process.exitCode = 1;
     }
   });
 
-
-if (process.argv.length < 1) {
+if (process.argv.length < 3) {
   program.outputHelp();
 }
 

package/lib/bin/startTest.js

@@ -4,16 +4,22 @@ const program = require('commander');
 const chalk = require('chalk');
 const TestomatClient = require('../client');
 const { APP_PREFIX, FINISHED } = require('../constants');
+const { version } = require('../../package.json');
 
-const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || process.env.TESTOMATIO;
-const title = process.env.TESTOMATIO_TITLE;
+console.log(chalk.cyan.bold(` 🤩 Testomat.io Reporter v${version}`));
 
 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")
   .action(opts => {
+
     const { command, launch, finish } = opts;
+    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;
 
     if (launch) {
       console.log('Starting a new Run on Testomat.io...');
@@ -45,6 +51,12 @@ program
 
     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;
+    }
+
     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

@@ -202,6 +202,8 @@ class XmlReader {
       group_title: this.requestParams.group_title,
     };    
 
+    if (process.env.DEBUG) console.log("Run", runParams);
+
     try {
       const resp = await this.axios.post(this.url, runParams, {
         maxContentLength: Infinity,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "0.6.1",
+  "version": "0.6.4",
   "description": "Testomatio Reporter Client",
   "main": "./lib/reporter.js",
   "repository": "git@github.com:testomatio/reporter.git",
@@ -12,6 +12,7 @@
     "callsite-record": "^4.1.4",
     "chalk": "^4.1.0",
     "commander": "^4.1.1",
+    "dotenv": "^16.0.1",
     "fast-xml-parser": "^4.0.8",
     "glob": "^8.0.3",
     "has-flag": "^5.0.1",
@@ -53,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"
   }
 }