@testomatio/reporter 0.4.2 → 0.4.6

package/Changelog.md

@@ -1,3 +1,20 @@
+# 0.4.6
+
+* Fixed CodeceptJS reporter to report tests failed in hooks
+
+# 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

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,9 +7,11 @@ 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 = [];
+let error;
 let stepShift = 0;
 const output = new Output({
   filterFn: (stack) => !stack.includes("codeceptjs/lib/output"), // output from codeceptjs
@@ -84,10 +86,11 @@ module.exports = (config) => {
 
   event.dispatcher.on(event.test.started, (test) => {
     testTimeMap[test.id] = Date.now();
+    err = null;
   });
 
   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 = [];
@@ -122,14 +125,19 @@ module.exports = (config) => {
     output.stop();
   });
 
+  event.dispatcher.on(event.test.failed, (test, err) => {
+    error = err;
+  });
+
   event.dispatcher.on(event.test.after, (test) => {
     if (test.state && test.state !== FAILED) return;
-    const { id, tags, title, err, artifacts } = test;
+    if (test.err) error = test.err;
+    const { id, tags, title, artifacts } = test;
     failedTests.push(id || title);
     const testId = parseTest(tags);
     const testObj = getTestAndMessage(title);
-    if (err && err.stack && test.steps && test.steps.length) {
-      err.stack = test.steps[test.steps.length - 1].line();
+    if (error && error.stack && test.steps && test.steps.length) {
+      error.stack = test.steps[test.steps.length - 1].line();
     }
 
     const files = [];
@@ -139,7 +147,7 @@ module.exports = (config) => {
 
     client.addTestRun(testId, TRConstants.FAILED, {
       ...stripExampleFromTitle(title),
-      error: err,
+      error,
       message: testObj.message,
       time: getDuration(test),
       files,

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/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

@@ -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";
@@ -125,6 +125,7 @@ class TestomatClient {
 
     if (error) {
       stack = this.formatError(error);
+      message = error.message;
     }
     if (steps) {
       stack = this.formatSteps(stack, steps);
@@ -137,7 +138,7 @@ class TestomatClient {
       }
 
       for (const file of files) {
-        uploadedFiles.push(uploadFile(file, this.runId));
+        uploadedFiles.push(upload.uploadFile(file, this.runId));
       }
     }
 
@@ -233,11 +234,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,14 +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 isDisabled = process.env.TESTOMATIO_DISABLE_ARTIFACTS;
+
+  if (isDisabled) return;
 
   let contentType;
   let fileName;
@@ -29,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) {
@@ -56,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.2",
+  "version": "0.4.6",
   "description": "Testomatio Reporter Client",
   "main": "./lib/reporter.js",
   "repository": "git@github.com:testomatio/reporter.git",