@testomatio/reporter 0.4.1 → 0.4.5

package/Changelog.md

@@ -1,3 +1,22 @@
+# 0.4.5
+
+* Fixed "Total XX artifacts publicly uploaded to S3 bucket" when no S3 bucket is configured
+* Improved S3 connection error messages
+
+# 0.4.4
+
+* Fixed returning 0 exit code when a process fails when running tests in parallel via `start-test-run`. Previously was using the last exit code returned by a process. Currently prefers the highest exit code that was returned by a process.
+
+# 0.4.3
+
+* Added `TESTOMATIO_DISABLE_ARTIFACTS` env variable to disable publishing artifacts.
+
+# 0.4.2
+
+* print version of reporter
+* print number of uploaded artifacts
+* print access mode for uploaded artifacts
+
 # 0.4.1
 
 Added `global.testomatioArtifacts = []` array which can be used to add arbitrary artifacts to a report.

package/README.md

@@ -248,6 +248,12 @@ global.testomatioArtifacts.push({ name: 'Screenshot', path: 'img/file.png' });
 
 Artifacts will be uploaded for the current test when it is finished.
 
+To disable uploading artifacts add `TESTOMATIO_DISABLE_ARTIFACTS` environment variable:
+
+```
+TESTOMATIO_DISABLE_ARTIFACTS=1
+```
+
 
 ## Starting an Empty Run
 

package/lib/adapter/codecept.js

@@ -7,6 +7,7 @@ const chalk = require("chalk");
 const TestomatClient = require("../client");
 const { FAILED } = require("../constants");
 const TRConstants = require("../constants");
+const upload = require("../fileUploader");
 const Output = require("../output");
 
 let currentMetaStep = [];
@@ -87,8 +88,8 @@ module.exports = (config) => {
   });
 
   event.dispatcher.on(event.all.result, async () => {
-    if (videos.length) {
-      console.log(TRConstants.APP_PREFIX, `🎞️ Uploading ${videos.length} videos...`);
+    if (videos.length && upload.isEnabled()) {
+      console.log(TRConstants.APP_PREFIX, `🎞️  Uploading ${videos.length} videos...`);
 
       let promises = [];
       for (const video of videos) {

package/lib/adapter/playwright.js

@@ -5,6 +5,7 @@ const path = require('path');
 const fs = require('fs');
 const Status = require('../constants');
 const TestomatioClient = require("../client");
+const upload = require("../fileUploader");
 const { parseTest } = require('../util');
 
 class TestomatioReporter {
@@ -75,8 +76,8 @@ class TestomatioReporter {
   async onEnd(result) {
     if (!this.client) return;
 
-    if (this.videos.length) {
-      console.log(Status.APP_PREFIX, `🎞️ Uploading ${this.videos.length} videos...`);
+    if (this.videos.length && upload.isEnabled()) {
+      console.log(Status.APP_PREFIX, `🎞️  Uploading ${this.videos.length} videos...`);
 
       let promises = [];
       for (const video of this.videos) {

package/lib/bin/startTest.js

@@ -43,6 +43,8 @@ program
     return;
   }
 
+  let exitCode = 0;
+
   const testCmds = command.split(" ");
   console.log(APP_PREFIX, `🚀 Running`, chalk.green(command));
 
@@ -55,7 +57,9 @@ program
         "⚠️ ",
         `Runner exited with ${chalk.bold(code)}, report is ignored`
       );
-      process.exitCode = code;
+
+      if (code > exitCode) exitCode = code;
+      process.exitCode = exitCode;
     });
 
     return;
@@ -71,7 +75,9 @@ program
       console.log(APP_PREFIX, emoji, `Runner exited with ${chalk.bold(code)}`);
       const status = code === 0 ? "passed" : "failed";
       client.updateRunStatus(status, true);
-      process.exitCode = code;
+
+      if (code > exitCode) exitCode = code;
+      process.exitCode = exitCode;
     });
   });
 });

package/lib/client.js

@@ -2,13 +2,15 @@ const axios = require("axios");
 const JsonCycle = require("json-cycle");
 const { URL } = require("url");
 const createCallsiteRecord = require("callsite-record");
-const { sep } = require("path");
+const { sep, join } = require("path");
+const fs = require("fs");
 const chalk = require("chalk");
-const { uploadFile } = require("./fileUploader");
+const upload = require("./fileUploader");
 const { PASSED, FAILED, FINISHED, APP_PREFIX } = require("./constants");
 
 const TESTOMAT_URL = process.env.TESTOMATIO_URL || "https://app.testomat.io";
-const { TESTOMATIO_RUNGROUP_TITLE, TESTOMATIO_ENV, TESTOMATIO_RUN } = process.env;
+const { TESTOMATIO_RUNGROUP_TITLE, TESTOMATIO_ENV, TESTOMATIO_RUN } =
+  process.env;
 
 if (TESTOMATIO_RUN) {
   process.env.runId = TESTOMATIO_RUN;
@@ -27,6 +29,8 @@ class TestomatClient {
     this.runId = process.env.runId;
     this.queue = Promise.resolve();
     this.axios = axios.create();
+    this.totalUploaded = 0;
+    this.version = JSON.parse(fs.readFileSync(join(__dirname, '..', 'package.json')).toString()).version;
   }
 
   /**
@@ -36,7 +40,7 @@ class TestomatClient {
    */
   createRun() {
     const { runId } = process.env;
-    if (!this.apiKey) throw new Error('No API key is set, can\'t create run');
+    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,
@@ -50,7 +54,9 @@ class TestomatClient {
     if (!isValidUrl(TESTOMAT_URL.trim())) {
       console.log(
         APP_PREFIX,
-        chalk.red(`Error creating report on Testomat.io, report url '${TESTOMAT_URL}' is invalid`)
+        chalk.red(
+          `Error creating report on Testomat.io, report url '${TESTOMAT_URL}' is invalid`
+        )
       );
       return;
     }
@@ -58,7 +64,8 @@ class TestomatClient {
     if (runId) {
       this.runId = runId;
       this.queue = this.queue.then(() =>
-        axios.put(`${TESTOMAT_URL.trim()}/api/reporter/${runId}`, runParams));
+        axios.put(`${TESTOMAT_URL.trim()}/api/reporter/${runId}`, runParams)
+      );
       return Promise.resolve(runId);
     }
 
@@ -75,10 +82,12 @@ class TestomatClient {
             console.log(
               APP_PREFIX,
               "📊 Report created. Report ID:",
-              this.runId
+              this.runId,
+              chalk.gray(`v${this.version}`)
             );
             process.env.runId = this.runId;
-          }))
+          })
+      )
       .catch(() => {
         console.log(
           APP_PREFIX,
@@ -118,11 +127,7 @@ class TestomatClient {
       stack = this.formatError(error);
     }
     if (steps) {
-      stack = stack
-        ? `${steps}\n\n${chalk.bold.red(
-          "################[ Failure ]################"
-        )}\n${stack}`
-        : steps;
+      stack = this.formatSteps(stack, steps);
     }
 
     if (this.runId) {
@@ -132,7 +137,7 @@ class TestomatClient {
       }
 
       for (const file of files) {
-        uploadedFiles.push(uploadFile(file, this.runId));
+        uploadedFiles.push(upload.uploadFile(file, this.runId));
       }
     }
 
@@ -142,6 +147,8 @@ class TestomatClient {
 
         global.testomatioArtifacts = [];
 
+        this.totalUploaded += uploadedFiles.filter((n) => n).length;
+
         const json = JsonCycle.stringify({
           api_key: this.apiKey,
           files,
@@ -173,7 +180,7 @@ class TestomatClient {
       .catch((err) => {
         if (err.response) {
           if (err.response.status >= 400) {
-            const data = err.response.data || { message: '' };
+            const data = err.response.data || { message: "" };
             console.log(
               APP_PREFIX,
               chalk.blue(title),
@@ -187,7 +194,12 @@ class TestomatClient {
             `Report couldn't be processed: ${err.response.data.message}`
           );
         } else {
-          console.log(APP_PREFIX, chalk.blue(title), "Report couldn't be processed", err);
+          console.log(
+            APP_PREFIX,
+            chalk.blue(title),
+            "Report couldn't be processed",
+            err
+          );
         }
       });
 
@@ -220,6 +232,15 @@ class TestomatClient {
               chalk.magenta(this.runUrl)
             );
           }
+
+          if (upload.isEnabled() && this.totalUploaded > 0) {
+            console.log(
+              APP_PREFIX,
+              `🗄️  Total ${this.totalUploaded} artifacts ${
+                upload.isPrivate ? "privately" : chalk.bold("publicly")
+              } uploaded to S3 bucket  `
+            );
+          }
         }
       })
       .catch((err) => {
@@ -228,6 +249,12 @@ class TestomatClient {
     return this.queue;
   }
 
+  formatSteps(stack, steps) {
+    return stack
+      ? `${steps}\n\n${chalk.bold.red("################[ Failure ]################")}\n${stack}`
+      : steps;
+  }
+
   formatError(error, message) {
     if (!message) message = error.message;
     if (error.inspect) message = error.inspect();

package/lib/fileUploader.js

@@ -2,13 +2,22 @@ const AWS = require("aws-sdk");
 const fs = require("fs");
 const path = require("path");
 const chalk = require("chalk");
+const { APP_PREFIX } = require("./constants");
+
+const isPrivate = process.env.TESTOMATIO_PRIVATE_ARTIFACTS;
+
+function isEnabled() {
+  return process.env.S3_BUCKET && !process.env.TESTOMATIO_DISABLE_ARTIFACTS;
+}
 
 const uploadUsingS3 = async (filePath, runId) => {
   const region = process.env.S3_REGION;
   const bucket = process.env.S3_BUCKET;
   const accessKeyId = process.env.S3_ACCESS_KEY_ID;
   const secretAccessKey = process.env.S3_SECRET_ACCESS_KEY;
-  const isPrivate = process.env.TESTOMATIO_PRIVATE_ARTIFACTS;
+  const isDisabled = process.env.TESTOMATIO_DISABLE_ARTIFACTS;
+
+  if (isDisabled) return;
 
   let contentType;
   let fileName;
@@ -28,23 +37,43 @@ const uploadUsingS3 = async (filePath, runId) => {
   const file = fs.readFileSync(filePath);
 
   fileName = `${runId}/${fileName || path.basename(filePath)}`;
+  const acl = isPrivate ? "private" : "public-read"
 
-  const out = await s3
-    .upload({
-      Bucket: bucket,
-      Key: fileName,
-      Body: file,
-      ContentType: contentType,
-      ACL: isPrivate ? "private" : "public-read",
+  try {
+    const out = await s3
+      .upload({
+        Bucket: bucket,
+        Key: fileName,
+        Body: file,
+        ContentType: contentType,
+        ACL: acl,
+      })
+      .promise();
+    return out.Location;
+  } catch (e) {
+    console.log(APP_PREFIX, chalk.bold.red(`Failed uploading '${fileName}'. Please check S3 credentials`), {
+      accessKeyId,
+      secretAccessKey: secretAccessKey ? '**** (hidden) ***' : '(empty)',
+      region,
+      bucket,
+      acl,
+      endpoint: process.env.S3_ENDPOINT
     })
-    .promise();
-  return out.Location;
-};
 
+    console.log(APP_PREFIX, `To ${chalk.bold('disable')} artifact uploads set: TESTOMATIO_DISABLE_ARTIFACTS=1`)
+    if (!isPrivate) {
+      console.log(APP_PREFIX, `To enable ${chalk.bold('PRIVATE')} uploads set: TESTOMATIO_PRIVATE_ARTIFACTS=1`)
+    } else {
+      console.log(APP_PREFIX, `To enable ${chalk.bold('PUBLIC')} uploads remove TESTOMATIO_PRIVATE_ARTIFACTS env variable`)
+    }
+    console.log(APP_PREFIX, '---------------')
+    return null;
+  }
+};
 
 const uploadFile = async (filePath, runId) => {
   try {
-    if (process.env.S3_BUCKET) {
+    if (isEnabled()) {
       return uploadUsingS3(filePath, runId);
     }
   } catch (e) {
@@ -55,4 +84,6 @@ const uploadFile = async (filePath, runId) => {
 
 module.exports = {
   uploadFile,
+  isPrivate,
+  isEnabled,
 };

package/package.json

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