@testomatio/reporter 0.6.0 → 0.6.3

package/Changelog.md

@@ -1,3 +1,19 @@
+# 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
+
+# 0.6.0
+
+* JUnit reporter support
+
 # 0.5.10
 
 * Fixed reporting Scenario Outline in Cypress-Cucumber

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:
@@ -246,8 +249,9 @@ 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 should be specified to identify source code of the project. Example: `--lang=Ruby` or `--lang=Java` or `--lang=Python`.
+* `--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
@@ -273,7 +277,7 @@ TESTOMATIO={API_KEY} npx report-xml report.xml --lang=python
 Run tests via Maven, make sure JUnit report was configured in `pom.xml`.
 
 ```
-maven clean test
+mvn clean test
 ```
 
 Import report with this command:
@@ -308,6 +312,33 @@ Import reports from `test/reports` directory:
 TESTOMATIO={API_KEY} npx report-xml "test/reports/*.xml" --lang ruby
 ```
 
+### Artifacts
+
+Screenshots or videos from tests are uploaded if a test contains output with a path to file of following format:
+
+```
+file://path/to/screenshot.png
+```
+
+For instance, inside Java test you can use `System.out.println` to print a path to file that should be uploaded as a screenshot.
+
+```java
+System.out.println("file://" + pathToScreenshot);
+```
+
+This will produce XML report which contains path to a file:
+
+```xml
+<testcase>
+  <system-out><![CDATA[
+    file://path/to/scrrenshot.png
+  ]]></system-out>
+</testcase>
+```
+
+When uploaded XML report, all files from `file://` will be uploaded to corresponding tests.
+
+
 ## Advanced Usage
 
 ### Create Unmatched Tests
@@ -411,7 +442,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.
 

package/lib/bin/reportXml.js

@@ -1,32 +1,32 @@
 #!/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;
-
-// console.log(chalk.cyan.bold(` 🤩 xmlReader by Testomat.io v${version}`));
+const { version } = require('../../package.json');
+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);
     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 +40,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

@@ -5,15 +5,22 @@ const chalk = require('chalk');
 const TestomatClient = require('../client');
 const { APP_PREFIX, FINISHED } = require('../constants');
 
-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(` 🤩 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);
+
+    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 +52,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/xmlReader.js

@@ -199,9 +199,11 @@ class XmlReader {
       api_key: this.requestParams.apiKey,
       title: this.requestParams.title,
       env: this.requestParams.env,
-      group_title: this.requestParams.runGroup,
+      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.0",
+  "version": "0.6.3",
   "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",