@testomatio/reporter 0.8.1 → 0.8.2-beta.1

package/Changelog.md

@@ -0,0 +1,251 @@
+# 0.7.6
+
+* Updated to use AWS S3 3.0 SDK for uploading
+
+# 0.7.5
+
+* Fixed reporting skipped tests in mocha
+
+# 0.7.4
+
+* Fixed parsing source code in JUnit files
+
+# 0.7.3
+
+* CodeceptJS: Upload all traces and videos from artifacts
+* Fixed reporting skipped test in XML
+* added `--timelimit` option to `report-xml` command line
+
+# 0.7.2
+
+* Fixed uploading non-existing file
+
+# 0.7.1
+
+* Support for NUnit XML v3 format
+
+# 0.7.0
+
+* Support for `@cucumber/cucumber` (>= 7.0) added
+* Initial support for C# and NUnit  
+
+# 0.6.10
+
+* Fixed uploading multilpe artifacts in Playwright
+
+# 0.6.9
+
+* Fixed pending tests reports for Cypress
+
+# 0.6.8
+# 0.6.7
+
+* Pytest: fixed creating suites from reports
+
+# 0.6.6
+
+* JUnit reporter: prefer suite title over testcase classname in a report
+
+# 0.6.5
+
+* Fixed test statuses for runs in JUnit reporter
+
+# 0.6.4
+
+* Added `TESTOMATIO_PROCEED=1` param to not close current run
+* Fixed priority of commands from `npx @testomatio/reporter`
+
+# 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
+* Fixed error reports for Cypress when running in Chrome
+
+# 0.5.9
+
+* Added environment on Cypress report
+
+# 0.5.8
+
+* Fixed Cypress.io reporting
+
+# 0.5.7
+
+* Fixed webdriverio artifacts
+
+# 0.5.6
+
+* Unmark failed CodeceptJS tests as skipped
+
+# 0.5.5
+
+* Fixed `BeforeSuite` failures in CodeceptJS
+
+# 0.5.4
+
+Added `TESTOMATIO_CREATE=1` option to create unmatched tests on report
+
+```
+TESTOMATIO_CREATE=1 TESTOMATIO=apiKey npx codeceptjs run
+```
+
+# 0.5.3
+
+* Fixed parsing suites
+
+# 0.5.2
+
+* Fixed multiple upload of artifacts in Cypress.io
+
+# 0.5.1
+
+* Fixed Cypress.io to report tests inside nested suites
+
+# 0.5.0
+
+* Added Cypress.io plugin
+* Added artifacts upload to webdriverio
+
+# 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
+- 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.
+
+```js
+// inside a running test:
+global.testomatioArtifacts.push('file/to/upload.png');
+```
+
+# 0.4.0
+
+- Playwright: Introduced playwright/test support with screenshots and video artifacts
+
+> Known issues: reporting using projects configured in Playwright does not work yet
+
+- CodeceptJS: added video uploads
+
+# 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
+- Jest: fixed sending errors with stack traces
+- Cypress: fixed sending reports
+
+# 0.3.11
+
+- Fixed circular JSON reference when submitting data to Testomatio
+
+# 0.3.10
+
+- Minor fixes
+
+# 0.3.9
+
+- Making all reporters to run without API key
+
+# 0.3.8
+
+- Fixed `npx start-test-run` to work with empty API keys
+
+# 0.3.7
+
+- Fixed release
+
+# 0.3.6
+
+- Update title and rungroup on start for scheduled runs.
+
+# 0.3.5
+
+- Added `TESTOMATIO_RUN` environment variable to pass id of a specific run to report
+
+# 0.3.4
+
+- Minor fixes
+
+# 0.3.3
+
+- [CodeceptJS] Fixed stack trace reporting
+- [CodeceptJS] Fixed displaying of nested steps
+- [CodeceptJS][mocha] Added assertion diff to report
+
+# 0.3.2
+
+- Fixed error message for S3 uploading
+
+# 0.3.1
+
+- [CodeceptJS] Better formatter for nested structures and BDD tests
+
+# 0.3.0
+
+- Added `TESTOMATIO_TITLE` env variable to set a name for Run
+- Added `TESTOMATIO_RUNGROUP_TITLE` env variable to attach Run to RunGroup
+- Added `TESTOMATIO_ENV` env variable to attach additional env values to report
+- [CodeceptJS] **CodeceptJS v3 support**
+- [CodeceptJS] Dropped support for CodeceptJS 2
+- [CodeceptJS] Added support for before hooks
+- [CodeceptJS] Log of steps
+- [CodeceptJS] Upload screenshots of failed tests to S3
+- [CodeceptJS] Updated to use with parallel execution

package/lib/adapter/playwright.js

@@ -5,7 +5,7 @@ const path = require('path');
 const fs = require('fs');
 const { APP_PREFIX, STATUS: Status } = require('../constants');
 const TestomatioClient = require('../client');
-const upload = require('../fileUploader');
+const { isArtifactsEnabled } = require('../fileUploader');
 const { parseTest } = require('../util');
 
 
@@ -13,7 +13,7 @@ class TestomatioReporter {
   constructor(config = {}) {
     this.client = new TestomatioClient({ apiKey: config?.apiKey });
 
-    this.videos = [];
+    this.uploads = [];
   }
 
   onBegin(_config, suite) {
@@ -37,32 +37,15 @@ class TestomatioReporter {
       appendStep(step, steps);
     }
 
-    const files = [];
-
-    for (const attachment of result.attachments) {
-      if (!attachment.body && !attachment.path) {
-        continue;
-      }
-      if (attachment.contentType && attachment.contentType.startsWith('video')) {
-        // video is post-processed
-        this.videos.push({ testId, attachment, title, suite_title });
-        continue;
-      }
-
-      let fileName = attachment.path;
-      if (attachment.body) {
-        fileName = tmpFile();
-        fs.writeFileSync(fileName, attachment.body);
-      }
-      files.push({ path: fileName, type: attachment.contentType });
-    }
+    this.uploads.push({
+      testId, title, suite_title, files: result.attachments.filter((a) => a.body || a.path)
+    })
 
     this.client.addTestRun(checkStatus(result.status), {
       error,
       test_id: testId,
       suite_title,
       title,
-      files,
       steps: steps.join('\n'),
       time: duration,
     });
@@ -71,19 +54,30 @@ class TestomatioReporter {
   async onEnd(result) {
     if (!this.client) return;
 
-    if (this.videos.length && upload.isArtifactsEnabled()) {
-      console.log(APP_PREFIX, `🎞️  Uploading ${this.videos.length} videos...`);
+    if (this.uploads.length && isArtifactsEnabled()) {
+      console.log(APP_PREFIX, `🎞️  Uploading ${this.uploads.length} files...`);
 
       const promises = [];
-      for (const video of this.videos) {
-        const { testId, title, attachment, suite_title } = video;
-        const file = { path: attachment.path, title, type: attachment.contentType };
+
+      for (const upload of this.uploads) {
+
+        const { title, testId, suite_title } = upload;
+
+        const files = upload.files.map((attachment) => {
+          if (attachment.body) {
+            const fileName = tmpFile();
+            fs.writeFileSync(fileName, attachment.body);
+          }
+          return { path: attachment.path, title, type: attachment.contentType };
+        });
+
+
         promises.push(
           this.client.addTestRun(undefined, {
             test_id: testId,
             title,
             suite_title,
-            files: [file],
+            files,
           }),
         );
       }

package/lib/fileUploader.js

@@ -1,6 +1,7 @@
 const debug = require('debug')('@testomatio/reporter:file-uploader');
 const { S3 } = require('@aws-sdk/client-s3');
 const { Upload } = require('@aws-sdk/lib-storage');
+
 const fs = require('fs');
 const path = require('path');
 const chalk = require('chalk');
@@ -27,10 +28,14 @@ function getConfig() {
     acc[key] = process.env[key];
     return acc;
   }, {});
-  debug('Config', config);
   return config;
 }
 
+function getMaskedConfig() {
+  const config = getConfig();
+  return Object.fromEntries(Object.entries(config).map(([key, value]) => [key, key === 'S3_SECRET_ACCESS_KEY' || key === 'S3_ACCESS_KEY_ID' ? '***' : value]));
+}
+
 let isEnabled;
 
 const isArtifactsEnabled = () => {
@@ -89,27 +94,30 @@ const uploadUsingS3 = async (filePath, runId) => {
   }
 
   const {
-    S3_REGION, S3_ACCESS_KEY_ID, S3_SECRET_ACCESS_KEY, S3_ENDPOINT, TESTOMATIO_PRIVATE_ARTIFACTS, S3_BUCKET
+    TESTOMATIO_PRIVATE_ARTIFACTS, S3_BUCKET
   } = getConfig();
+
+  debug('S3 config', getMaskedConfig());
+  debug('Uploading', filePath, 'to', S3_BUCKET);
   
-  const file = fs.readFileSync(filePath);
+const fileData = fs.readFileSync(filePath);
 
   Key = `${runId}/${randomUUID()}-${Key || path.basename(filePath)}`;
   const ACL = TESTOMATIO_PRIVATE_ARTIFACTS ? 'private' : 'public-read';
 
   const s3 = new S3(_getS3Config());
 
+  const params = {
+    Bucket: S3_BUCKET,
+    Key,
+    Body: fileData,
+    ACL,
+  };
+
   try {
     const out = new Upload({
       client: s3,
-
-      params: {
-        Bucket: S3_BUCKET,
-        Key,
-        Body: file,
-        ContentType,
-        ACL,
-      }
+      params
     });
 
     await out.done();
@@ -117,14 +125,8 @@ const uploadUsingS3 = async (filePath, runId) => {
 
     return out.singleUploadResult.Location;
   } catch (e) {
-    console.log(APP_PREFIX, chalk.bold.red(`Failed uploading '${Key}'. Please check S3 credentials`), {
-      accessKeyId: S3_ACCESS_KEY_ID,
-      secretAccessKey: S3_SECRET_ACCESS_KEY ? '**** (hidden) ***' : '(empty)',
-      region: S3_REGION,
-      bucket: S3_BUCKET,
-      acl: ACL,
-      endpoint: S3_ENDPOINT,
-    });
+    console.log(e);
+    console.log(APP_PREFIX, chalk.bold.red(`Failed uploading '${Key}'. Please check S3 credentials`), getMaskedConfig());
 
     console.log(APP_PREFIX, `To ${chalk.bold('disable')} artifact uploads set: TESTOMATIO_DISABLE_ARTIFACTS=1`);
     if (!TESTOMATIO_PRIVATE_ARTIFACTS) {
@@ -136,7 +138,7 @@ const uploadUsingS3 = async (filePath, runId) => {
       );
     }
     console.log(APP_PREFIX, '---------------');
-  }
+  } 
 };
 
 const uploadUsingS3AsBuffer = async (buffer, fileName, runId) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "0.8.1",
+  "version": "0.8.2-beta.1",
   "description": "Testomatio Reporter Client",
   "main": "./lib/reporter.js",
   "typings": "typings/index.d.ts",