@testomatio/reporter 0.4.4 → 0.4.5

package/Changelog.md

@@ -1,3 +1,8 @@
+# 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.

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,7 +88,7 @@ module.exports = (config) => {
   });
 
   event.dispatcher.on(event.all.result, async () => {
-    if (videos.length) {
+    if (videos.length && upload.isEnabled()) {
       console.log(TRConstants.APP_PREFIX, `🎞️  Uploading ${videos.length} videos...`);
 
       let promises = [];

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,7 +76,7 @@ class TestomatioReporter {
   async onEnd(result) {
     if (!this.client) return;
 
-    if (this.videos.length) {
+    if (this.videos.length && upload.isEnabled()) {
       console.log(Status.APP_PREFIX, `🎞️  Uploading ${this.videos.length} videos...`);
 
       let promises = [];

package/lib/client.js

@@ -5,7 +5,7 @@ const createCallsiteRecord = require("callsite-record");
 const { sep, join } = require("path");
 const fs = require("fs");
 const chalk = require("chalk");
-const { isPrivate, 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";
@@ -137,7 +137,7 @@ class TestomatClient {
       }
 
       for (const file of files) {
-        uploadedFiles.push(uploadFile(file, this.runId));
+        uploadedFiles.push(upload.uploadFile(file, this.runId));
       }
     }
 
@@ -233,11 +233,11 @@ class TestomatClient {
             );
           }
 
-          if (this.totalUploaded > 0) {
+          if (upload.isEnabled() && this.totalUploaded > 0) {
             console.log(
               APP_PREFIX,
               `🗄️  Total ${this.totalUploaded} artifacts ${
-                isPrivate ? "privately" : chalk.bold("publicly")
+                upload.isPrivate ? "privately" : chalk.bold("publicly")
               } uploaded to S3 bucket  `
             );
           }

package/lib/fileUploader.js

@@ -2,9 +2,14 @@ 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;
@@ -32,22 +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) {
@@ -59,4 +85,5 @@ const uploadFile = async (filePath, runId) => {
 module.exports = {
   uploadFile,
   isPrivate,
+  isEnabled,
 };

package/package.json

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