@testomatio/reporter 0.5.0-beta.3 → 0.5.0

package/Changelog.md

@@ -1,3 +1,8 @@
+# 0.5.0
+
+* Added Cypress.io plugin
+* Added artifacts upload to webdriverio
+
 # 0.4.6
 
 - Fixed CodeceptJS reporter to report tests failed in hooks

package/lib/adapter/codecept.js

@@ -72,7 +72,7 @@ function CodeceptReporter(config) {
   });
 
   event.dispatcher.on(event.all.result, async () => {
-    if (videos.length && upload.isEnabled()) {
+    if (videos.length && upload.isArtifactsEnabled) {
       console.log(TRConstants.APP_PREFIX, `🎞️  Uploading ${videos.length} videos...`);
 
       const promises = [];

package/lib/adapter/playwright.js

@@ -75,7 +75,7 @@ class TestomatioReporter {
   async onEnd(result) {
     if (!this.client) return;
 
-    if (this.videos.length && upload.isEnabled()) {
+    if (this.videos.length && upload.isArtifactsEnabled) {
       console.log(Status.APP_PREFIX, `🎞️  Uploading ${this.videos.length} videos...`);
 
       const promises = [];

package/lib/adapter/webdriver.js

@@ -11,23 +11,39 @@ class WebdriverReporter extends WDIOReporter {
 
     this.client = new TestomatClient({ apiKey });
     options = Object.assign(options, { stdout: true });
+
+    this._isSynchronising = false;
+  }
+
+  get isSynchronised() {
+    return this._isSynchronising === false;
   }
 
-  onTestEnd(test) {
-    this.addTest(test);
+  async onTestEnd(test) {
+    this._isSynchronising = true;
+
+    await this.addTest(test);
+
+    this._isSynchronising = false;
   }
 
-  addTest(test) {
+  async addTest(test) {
     if (!this.client) return;
 
-    const { title, _duration: duration, state, error } = test;
+    const { title, _duration: duration, state, error, output } = test;
 
     const testId = parseTest(title);
 
-    this.client.addTestRun(testId, state, {
+    const screenshotEndpoint = '/session/:sessionId/screenshot';
+    const screenshotsBuffers = output
+      .filter(el => el.endpoint === screenshotEndpoint && el.result && el.result.value)
+      .map(el => Buffer.from(el.result.value, 'base64'));
+
+    await this.client.addTestRun(testId, state, {
       error,
       title,
       time: duration,
+      filesBuffers: screenshotsBuffers,
     });
   }
 }

package/lib/client.js

@@ -65,12 +65,14 @@ class TestomatClient {
     }
 
     this.queue = this.queue
-      .then(() => this.axios.post(`${TESTOMAT_URL.trim()}/api/reporter`, runParams).then(resp => {
-        this.runId = resp.data.uid;
-        this.runUrl = `${TESTOMAT_URL}/${resp.data.url.split('/').splice(3).join('/')}`;
-        console.log(APP_PREFIX, '📊 Report created. Report ID:', this.runId, chalk.gray(`v${this.version}`));
-        process.env.runId = this.runId;
-      }))
+      .then(() =>
+        this.axios.post(`${TESTOMAT_URL.trim()}/api/reporter`, runParams).then(resp => {
+          this.runId = resp.data.uid;
+          this.runUrl = `${TESTOMAT_URL}/${resp.data.url.split('/').splice(3).join('/')}`;
+          console.log(APP_PREFIX, '📊 Report created. Report ID:', this.runId, chalk.gray(`v${this.version}`));
+          process.env.runId = this.runId;
+        }),
+      )
       .catch(() => {
         console.log(
           APP_PREFIX,
@@ -92,6 +94,7 @@ class TestomatClient {
       time = '',
       example = null,
       files = [],
+      filesBuffers = [],
       steps,
       title,
       suite_title,
@@ -121,7 +124,11 @@ class TestomatClient {
       }
 
       for (const file of files) {
-        uploadedFiles.push(upload.uploadFile(file, this.runId));
+        uploadedFiles.push(upload.uploadFileByPath(file, this.runId));
+      }
+
+      for (const [idx, buffer] of filesBuffers.entries()) {
+        uploadedFiles.push(upload.uploadFileAsBuffer(buffer, idx + 1, this.runId));
       }
     }
 
@@ -200,11 +207,11 @@ class TestomatClient {
             console.log(APP_PREFIX, '📊 Report Saved. Report URL:', chalk.magenta(this.runUrl));
           }
 
-          if (upload.isEnabled() && this.totalUploaded > 0) {
+          if (upload.isArtifactsEnabled && this.totalUploaded > 0) {
             console.log(
               APP_PREFIX,
               `🗄️  Total ${this.totalUploaded} artifacts ${
-                upload.isPrivate ? 'privately' : chalk.bold('publicly')
+                process.env.TESTOMATIO_PRIVATE_ARTIFACTS ? 'privately' : chalk.bold('publicly')
               } uploaded to S3 bucket  `,
             );
           }
@@ -240,7 +247,8 @@ class TestomatClient {
       });
       if (record && !record.filename.startsWith('http')) {
         stack += record.renderSync({
-          stackFilter: frame => frame.getFileName().indexOf(sep) > -1 &&
+          stackFilter: frame =>
+            frame.getFileName().indexOf(sep) > -1 &&
             frame.getFileName().indexOf('node_modules') < 0 &&
             frame.getFileName().indexOf('internal') < 0,
         });

package/lib/fileUploader.js

@@ -5,63 +5,83 @@ const chalk = require('chalk');
 const memoize = require('lodash.memoize');
 const { APP_PREFIX } = require('./constants');
 
-const isPrivate = process.env.TESTOMATIO_PRIVATE_ARTIFACTS;
-const isEnabled = () => process.env.S3_BUCKET && !process.env.TESTOMATIO_DISABLE_ARTIFACTS;
+const {
+  S3_ENDPOINT,
+  S3_REGION,
+  S3_BUCKET,
+  S3_ACCESS_KEY_ID,
+  S3_SECRET_ACCESS_KEY,
+  TESTOMATIO_DISABLE_ARTIFACTS,
+  TESTOMATIO_PRIVATE_ARTIFACTS,
+  S3_FORCE_PATH_STYLE,
+} = process.env;
 
-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;
-  const s3ForcePathStyle = process.env.S3_FORCE_PATH_STYLE;
+const isArtifactsEnabled = S3_BUCKET && !TESTOMATIO_DISABLE_ARTIFACTS;
+
+const _getFileExtBase64 = str => {
+  const type = str.charAt(0);
 
-  if (isDisabled) return;
+  return (
+    {
+      '/': '.jpg',
+      i: '.png',
+      R: '.gif',
+      U: '.webp',
+    }[type] || ''
+  );
+};
 
-  let contentType;
-  let fileName;
+const uploadUsingS3 = async (filePath, runId) => {
+  let ContentType;
+  let Key;
 
   if (typeof filePath === 'object') {
-    contentType = filePath.type;
+    ContentType = filePath.type;
     filePath = filePath.path;
-    fileName = filePath.name;
+    Key = filePath.name;
   }
 
-  const config = { region, accessKeyId, secretAccessKey, s3ForcePathStyle };
-  if (process.env.S3_ENDPOINT) {
-    config.endpoint = new AWS.Endpoint(process.env.S3_ENDPOINT);
+  const config = {
+    region: S3_REGION,
+    accessKeyId: S3_ACCESS_KEY_ID,
+    secretAccessKey: S3_SECRET_ACCESS_KEY,
+    s3ForcePathStyle: S3_FORCE_PATH_STYLE,
+  };
+
+  if (S3_ENDPOINT) {
+    config.endpoint = new AWS.Endpoint(S3_ENDPOINT);
   }
 
   const s3 = new AWS.S3(config);
   const file = fs.readFileSync(filePath);
 
-  fileName = `${runId}/${fileName || path.basename(filePath)}`;
-  const acl = isPrivate ? 'private' : 'public-read';
+  Key = `${runId}/${Key || path.basename(filePath)}`;
+  const ACL = TESTOMATIO_PRIVATE_ARTIFACTS ? 'private' : 'public-read';
 
   try {
     const out = await s3
       .upload({
-        Bucket: bucket,
-        Key: fileName,
+        Bucket: S3_BUCKET,
+        Key,
         Body: file,
-        ContentType: contentType,
-        ACL: acl,
+        ContentType,
+        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,
+    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(APP_PREFIX, `To ${chalk.bold('disable')} artifact uploads set: TESTOMATIO_DISABLE_ARTIFACTS=1`);
-    if (!isPrivate) {
+    if (!TESTOMATIO_PRIVATE_ARTIFACTS) {
       console.log(APP_PREFIX, `To enable ${chalk.bold('PRIVATE')} uploads set: TESTOMATIO_PRIVATE_ARTIFACTS=1`);
     } else {
       console.log(
@@ -70,23 +90,84 @@ const uploadUsingS3 = async (filePath, runId) => {
       );
     }
     console.log(APP_PREFIX, '---------------');
-    return null;
   }
 };
 
-const uploadFile = async (filePath, runId) => {
+const uploadUsingS3AsBuffer = async (buffer, fileName, runId) => {
+  const config = {
+    region: S3_REGION,
+    accessKeyId: S3_ACCESS_KEY_ID,
+    secretAccessKey: S3_SECRET_ACCESS_KEY,
+    s3ForcePathStyle: S3_FORCE_PATH_STYLE,
+  };
+
+  if (S3_ENDPOINT) {
+    config.endpoint = new AWS.Endpoint(S3_ENDPOINT);
+  }
+
+  const s3 = new AWS.S3(config);
+
+  const ACL = TESTOMATIO_PRIVATE_ARTIFACTS ? 'private' : 'public-read';
+
+  const fileExtension = _getFileExtBase64(buffer.toString('base64'));
+  const Key = `${runId}/${fileName}${fileExtension}`;
+
   try {
-    if (isEnabled()) {
+    const out = await s3
+      .upload({
+        Bucket: S3_BUCKET,
+        Key,
+        Body: buffer,
+        ACL,
+      })
+      .promise();
+
+    return out.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(APP_PREFIX, `To ${chalk.bold('disable')} artifact uploads set: TESTOMATIO_DISABLE_ARTIFACTS=1`);
+    if (!TESTOMATIO_PRIVATE_ARTIFACTS) {
+      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, '---------------');
+  }
+};
+
+const uploadFileByPath = async (filePath, runId) => {
+  try {
+    if (isArtifactsEnabled) {
       return uploadUsingS3(filePath, runId);
     }
   } catch (e) {
     console.error(chalk.red('Error occurred while uploading artifacts'), e);
   }
-  return null;
+};
+
+const uploadFileAsBuffer = async (buffer, fileName, runId) => {
+  try {
+    if (isArtifactsEnabled) {
+      return uploadUsingS3AsBuffer(buffer, fileName, runId);
+    }
+  } catch (e) {
+    console.error(chalk.red('Error occurred while uploading artifacts'), e);
+  }
 };
 
 module.exports = {
-  uploadFile: memoize(uploadFile),
-  isPrivate,
-  isEnabled,
+  uploadFileByPath: memoize(uploadFileByPath),
+  uploadFileAsBuffer: memoize(uploadFileAsBuffer),
+  isArtifactsEnabled,
 };

package/package.json

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