@testomatio/reporter 0.3.12 → 0.3.16

package/Changelog.md

@@ -1,3 +1,28 @@
+# 0.3.16
+
+* CodeceptJS: fixed reporting tests with empty steps (on retry)
+
+# 0.3.15
+
+* Finish Run via API:
+
+```
+TESTOMATIO={apiKey} TESTOMATIO_RUN={runId} npx @testomatio/reporter@latest --finish
+```
+
+# 0.3.14
+
+* Create an empty Run via API:
+
+```
+TESTOMATIO={apiKey} npx @testomatio/reporter@latest --launch
+```
+
+# 0.3.13
+
+* Checking for a valid report URL
+* Sending unlimited data on test report
+
 # 0.3.12
 
 * Fixed submitting arbitrary data on a test run

package/README.md

@@ -169,3 +169,25 @@ To save screenshots provide a configuration for S3 bucket via environment variab
 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.
 
 On CI set environment variables in CI config.
+
+
+## Starting an Empty Run
+
+If you want to create a run and obtain its RunID from Testomat.io you can use `--launch` option:
+
+```sh
+TESTOMATIO={apiKey} npx @testomatio/reporter@latest --launch
+```
+
+This command will return RunID which you can pass to other testrunner processes.
+
+> When executed with `--launch` a command provided by `-c` flag is ignored
+
+## Manually Finishing Run
+
+If you want to finish a run started by `--launch` use `--finish` option. `TESTOMATIO_RUN` environment variable is required:
+
+```sh
+TESTOMATIO={apiKey} TESTOMATIO_RUN={runId} npx @testomatio/reporter@latest --finish
+```
+

package/lib/adapter/codecept.js

@@ -112,7 +112,7 @@ module.exports = (config) => {
     failedTests.push(id || title);
     const testId = parseTest(tags);
     const testObj = getTestAndMessage(title);
-    if (err && err.stack && test.steps.length) {
+    if (err && err.stack && test.steps && test.steps.length) {
       err.stack = test.steps[test.steps.length - 1].line();
     }
 

package/lib/bin/startTest.js

@@ -3,13 +3,46 @@ const { spawn } = require("child_process");
 const program = require("commander");
 const chalk = require("chalk");
 const TestomatClient = require("../client");
-const { APP_PREFIX } = require("../constants");
+const { APP_PREFIX, FINISHED } = require("../constants");
 
 const apiKey = process.env["INPUT_TESTOMATIO-KEY"] || process.env.TESTOMATIO;
 const title = process.env.TESTOMATIO_TITLE;
 
-program.option("-c, --command <cmd>", "Test command").action((opts) => {
-  const { command } = opts;
+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')
+  .action((opts) => {
+  const { command, launch, finish } = opts;
+
+  if (launch) {
+    console.log('Starting a new Run on Testomat.io...');
+    const client = new TestomatClient({ apiKey });
+
+    client.createRun().then(() => {
+      console.log(process.env.runId);
+      process.exit(0);
+    })
+    return;
+  }
+
+  if (finish) {
+    if (!process.env.TESTOMATIO_RUN) {
+      console.log('TESTOMATIO_RUN environment variable must be set.');
+      return process.exit(1);
+    }
+
+    console.log('Finishing Run on Testomat.io...');
+
+    const client = new TestomatClient({ apiKey });
+
+    client.updateRunStatus(FINISHED, true).then(() => {
+      console.log(chalk.yellow(`Run ${process.env.TESTOMATIO_RUN} was finished`));
+      process.exit(0);
+    });
+    return;
+  }
+
   const testCmds = command.split(" ");
   console.log(APP_PREFIX, `🚀 Running`, chalk.green(command));
 

package/lib/client.js

@@ -1,16 +1,16 @@
-const axios = require("axios").default;
+const axios = require("axios");
 const JsonCycle = require("json-cycle");
+const { URL } = require("url");
 const createCallsiteRecord = require("callsite-record");
-// const defaultRenderer = require("callsite-record").renderers.noColor;
+
 const { sep } = require("path");
 const chalk = require("chalk");
 const { uploadFile } = require("./fileUploader");
-const { PASSED, FAILED, APP_PREFIX } = require("./constants");
+const { PASSED, FAILED, FINISHED, APP_PREFIX } = require("./constants");
 
 const TESTOMAT_URL = process.env.TESTOMATIO_URL || "https://app.testomat.io";
-const { TESTOMATIO_RUNGROUP_TITLE } = process.env;
-const { TESTOMATIO_ENV } = process.env;
-const { TESTOMATIO_RUN } = process.env;
+const { TESTOMATIO_RUNGROUP_TITLE, TESTOMATIO_ENV, TESTOMATIO_RUN } = process.env;
+
 
 if (TESTOMATIO_RUN) {
   process.env.runId = TESTOMATIO_RUN;
@@ -28,6 +28,7 @@ class TestomatClient {
     this.parallel = params.parallel;
     this.runId = process.env.runId;
     this.queue = Promise.resolve();
+    this.axios = axios.create();
   }
 
   /**
@@ -37,6 +38,7 @@ class TestomatClient {
    */
   createRun() {
     const { runId } = process.env;
+    if (!this.apiKey) throw new Error('No API key is set, can\'t create run');
     const runParams = {
       api_key: this.apiKey.trim(),
       title: this.title,
@@ -44,6 +46,14 @@ class TestomatClient {
       group_title: TESTOMATIO_RUNGROUP_TITLE,
       env: TESTOMATIO_ENV,
     };
+    if (!isValidUrl(TESTOMAT_URL.trim())) {
+      console.log(
+        APP_PREFIX,
+        chalk.red(`Error creating report on Testomat.io, report url '${TESTOMAT_URL}' is invalid`)
+      );
+      return;
+    }
+
     if (runId) {
       this.runId = runId;
       this.queue = this.queue.then(() =>
@@ -53,7 +63,7 @@ class TestomatClient {
 
     this.queue = this.queue
       .then(() =>
-        axios
+        this.axios
           .post(`${TESTOMAT_URL.trim()}/api/reporter`, runParams)
           .then((resp) => {
             this.runId = resp.data.uid;
@@ -71,7 +81,7 @@ class TestomatClient {
       .catch(() => {
         console.log(
           APP_PREFIX,
-          "Error creating a test run on testomat.io, please check if your API key is valid. Skipping report"
+          "Error creating report Testomat.io, please check if your API key is valid. Skipping report"
         );
       });
 
@@ -171,10 +181,12 @@ class TestomatClient {
           run_time: time,
           artifacts: await Promise.all(uploadedFiles),
         });
-        return axios.post(
+        return this.axios.post(
           `${TESTOMAT_URL}/api/reporter/${this.runId}/testrun`,
           json,
           {
+            maxContentLength: Infinity,
+            maxBodyLength: Infinity,
             headers: {
               // Overwrite Axios's automatically set Content-Type
               "Content-Type": "application/json",
@@ -216,10 +228,11 @@ class TestomatClient {
       .then(async () => {
         if (this.runId) {
           let statusEvent;
+          if (status === FINISHED) statusEvent = "finish";
           if (status === PASSED) statusEvent = "pass";
           if (status === FAILED) statusEvent = "fail";
           if (isParallel) statusEvent += "_parallel";
-          await axios.put(`${TESTOMAT_URL}/api/reporter/${this.runId}`, {
+          await this.axios.put(`${TESTOMAT_URL}/api/reporter/${this.runId}`, {
             api_key: this.apiKey,
             status_event: statusEvent,
             status,
@@ -241,3 +254,12 @@ class TestomatClient {
 }
 
 module.exports = TestomatClient;
+
+function isValidUrl(s) {
+  try {
+    new URL(s); // eslint-disable-line
+    return true;
+  } catch (err) {
+    return false;
+  }
+}

package/lib/constants.js

@@ -6,5 +6,6 @@ module.exports = Object.freeze({
   PASSED: "passed",
   FAILED: "failed",
   SKIPPED: "skipped",
+  FINISHED: "finished",
   APP_PREFIX,
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "0.3.12",
+  "version": "0.3.16",
   "description": "Testomatio Reporter Client",
   "main": "./lib/reporter.js",
   "repository": "git@github.com:testomatio/reporter.git",