@testomatio/reporter 1.1.1-beta.1.fix-logger → 1.1.1

package/README.md

@@ -65,13 +65,16 @@ yarn add @testomatio/reporter --dev
 
 ### 1️⃣ Attach Reporter to the Test Runner
 
+| | | |
+|--|--|--|
 | [Playwright](./docs/frameworks.md#playwright) | [CodeceptJS](./docs/frameworks.md#CodeceptJS) | [Cypress](./docs/frameworks.md#Cypress) |
 | [Jest](./docs/frameworks.md#Jest) | [Mocha](./docs/frameworks.md#Mocha) | [WebDriverIO](./docs/frameworks.md#WebDriverIO) |
 | [TestCafe](./docs/frameworks.md#TestCafe) | [Detox](./docs/frameworks.md#Detox) | [Codeception](https://github.com/testomatio/php-reporter) |
 | [Newman (Postman)](./docs/frameworks.md#Newman) | [JUnit](./docs/junit.md#junit) | [NUnit](./docs/junit.md#nunit) |
 | [PyTest](./docs/junit.md#pytest) | [PHPUnit](./docs/junit.md#phpunit) | [Protractor](./docs/frameworks.md#protractor) |
 
-or any [other via JUnit](./docs/junit.md) report....
+
+or **any [other via JUnit](./docs/junit.md)** report....
 
 ### 2️⃣ Configure Reports
 

package/lib/adapter/playwright.js

@@ -7,6 +7,8 @@ const { APP_PREFIX, STATUS: Status, TESTOMAT_TMP_STORAGE_DIR } = require('../con
 const TestomatioClient = require('../client');
 const { isArtifactsEnabled } = require('../fileUploader');
 const { parseTest, fileSystem } = require('../utils/utils');
+const { services } = require('../services');
+const { dataStorage } = require('../data-storage');
 
 const reportTestPromises = [];
 
@@ -17,14 +19,20 @@ class PlaywrightReporter {
     this.uploads = [];
   }
 
-  onBegin(_config, suite) {
+  onBegin(config, suite) {
     // clean data storage
     fileSystem.clearDir(TESTOMAT_TMP_STORAGE_DIR);
     if (!this.client) return;
     this.suite = suite;
+    this.config = config;
     this.client.createRun();
   }
 
+  onTestBegin(testInfo) {
+    const fullTestTitle = getTestContextName(testInfo);
+    dataStorage.setContext(fullTestTitle);
+  }
+
   onTestEnd(test, result) {
     if (!this.client) return;
 
@@ -34,17 +42,22 @@ class PlaywrightReporter {
 
     const { error, duration } = result;
 
-    const suite_title = test.parent ? test.parent.title : null;
+    const suite_title = test.parent 
+      ? test.parent?.title 
+      : path.basename(test?.location?.file);
 
     const steps = [];
     for (const step of result.steps) {
       appendStep(step, steps);
     }
 
+    const fullTestTitle = getTestContextName(test);
     let logs = '';
     if (result.stderr.length || result.stdout.length) {
       logs = `\n\n${chalk.bold('Logs:')}\n${chalk.red(result.stderr.join(''))}\n${result.stdout.join('')}`;
     }
+    const manuallyAttachedArtifacts = services.artifacts.get(fullTestTitle);
+    const keyValues = services.keyValues.get(fullTestTitle);
 
     const reportTestPromise = this.client
       .addTestRun(checkStatus(result.status), {
@@ -55,7 +68,8 @@ class PlaywrightReporter {
         steps: steps.join('\n'),
         time: duration,
         logs,
-        // TODO: attach artifacts
+        manuallyAttachedArtifacts,
+        meta: keyValues,
       })
       .then(pipes => {
         testId = pipes?.filter(p => p.pipe.includes('Testomatio'))[0]?.result?.data?.test_id;
@@ -73,7 +87,24 @@ class PlaywrightReporter {
     reportTestPromises.push(reportTestPromise);
   }
 
-  async onEnd(result) {
+
+  #getArtifactPath(artifact) {
+    if (artifact.path) {
+      if (path.isAbsolute(artifact.path)) return artifact.path;
+
+      return path.join(this.config.outputDir || this.config.projects[0].outputDir, artifact.path);         
+    }
+
+    if (artifact.body) {
+      const fileName = tmpFile();
+      fs.writeFileSync(fileName, artifact.body);
+      return fileName;
+    }
+
+    return null;
+  }
+
+  async onEnd(result, config) {
     if (!this.client) return;
 
     await Promise.all(reportTestPromises);
@@ -87,11 +118,7 @@ class PlaywrightReporter {
         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 };
+          return { path: this.#getArtifactPath(attachment), title, type: attachment.contentType };
         });
 
         promises.push(
@@ -139,6 +166,15 @@ function tmpFile(prefix = 'tmp.') {
   return path.join(tmpdir, prefix + crypto.randomBytes(16).toString('hex'));
 }
 
+/**
+ * Returns filename + test title
+ * @param {*} test - testInfo object from Playwright
+ * @returns 
+ */
+function getTestContextName(test) {
+  return `${test._requireFile || ''}_${test.title}`;
+}
+
 function initPlaywrightForStorage() {
   try {
     // @ts-ignore-next-line
@@ -146,12 +182,11 @@ function initPlaywrightForStorage() {
     const { test } = require('@playwright/test');
     // eslint-disable-next-line no-empty-pattern
     test.beforeEach(async ({}, testInfo) => {
-      const fullTestTitle = `${testInfo.file}_${testInfo.title}`;
-      global.testomatioTestTitle = fullTestTitle;
+      global.testomatioTestTitle = `${testInfo.file || ''}_${testInfo.title}`;
     });
   } catch (e) {
     // ignore
-  }
+  }  
 }
 
 module.exports = PlaywrightReporter;

package/lib/client.js

@@ -27,6 +27,7 @@ class Client {
     this.pipes = pipesFactory(params, store);
     this.queue = Promise.resolve();
     this.totalUploaded = 0;
+    this.failedToUpload = 0;
     this.version = JSON.parse(fs.readFileSync(join(__dirname, '..', 'package.json')).toString()).version;
     this.executionList = Promise.resolve();
 
@@ -163,11 +164,14 @@ class Client {
       uploadedFiles.push(upload.uploadFileAsBuffer(buffer, fileName, this.uuid));
     }
 
-    const artifacts = await Promise.all(uploadedFiles);
+    const artifacts = (await Promise.all(uploadedFiles)).filter(n => !!n);
 
-    // global.testomatioArtifacts = [];
+    if (artifacts.length < uploadedFiles.length) {
+      const failedUploading = uploadedFiles.length - artifacts.length;
+      this.failedToUpload += failedUploading;
+    }
 
-    this.totalUploaded += uploadedFiles.filter(n => n).length;
+    this.totalUploaded += artifacts.length;
 
     const data = {
       files,
@@ -233,6 +237,16 @@ class Client {
               process.env.TESTOMATIO_PRIVATE_ARTIFACTS ? 'privately' : chalk.bold('publicly')
             } uploaded to S3 bucket`,
           );
+
+          if (this.failedToUpload > 0) {
+            console.log(
+              APP_PREFIX,
+              chalk.yellow(
+                `Some artifacts were not uploaded. ${this.failedToUpload} artifacts could not be uploaded. Run tests with DEBUG="@testomatio/reporter:file-uploader" to see details"`,
+              ),
+            );
+          }
+    
         }
       })
       .catch(err => console.log(APP_PREFIX, err));
@@ -295,6 +309,7 @@ class Client {
 
 function isNotInternalFrame(frame) {
   return (
+    frame.getFileName() &&
     frame.getFileName().includes(sep) &&
     !frame.getFileName().includes('node_modules') &&
     !frame.getFileName().includes('internal')

package/lib/data-storage.js

@@ -59,7 +59,7 @@ class DataStorage {
   putData(dataType, data, context = null) {
     if (!dataType || !data) return;
 
-    context = context || this.context || global.testomatioTestTitle || jestHelpers.getIdOfCurrentlyRunningTest();
+    context = context || this.context || global.testomatioTestTitle || jestHelpers.getNameOfCurrentlyRunningTest();
     if (!context) {
       debug(`No context provided for "${dataType}" data:`, data);
       return;
@@ -85,7 +85,7 @@ class DataStorage {
    */
   getData(dataType, context) {
     // TODO: think if it could be useful
-    // context = context || this.context || global.testomatioTestTitle || jestHelpers.getIdOfCurrentlyRunningTest();
+    // context = context || this.context || global.testomatioTestTitle || jestHelpers.getNameOfCurrentlyRunningTest();
 
     if (!context) {
       debug(`Trying to get "${dataType}" data without context`);

package/lib/fileUploader.js

@@ -11,7 +11,6 @@ const readFile = util.promisify(fs.readFile);
 const stat = util.promisify(fs.stat);
 const chalk = require('chalk');
 const { randomUUID } = require('crypto');
-const memoize = require('lodash.memoize');
 
 const { APP_PREFIX } = require('./constants');
 
@@ -146,8 +145,13 @@ const uploadUsingS3 = async (filePath, runId) => {
       params
     });
 
-    return await getS3LocationLink(out);
-  } 
+    
+    const link = await getS3LocationLink(out);
+    
+    debug(`Succesfully uploaded ${filePath} => ${S3_BUCKET}/${Key} | URL: ${link}`);
+
+    return link;
+  }
   catch (e) {
     debug('S3 file uploading error: ', e);
    
@@ -279,8 +283,6 @@ const getS3LocationLink = async (out) => {
 
   let s3Location = response?.Location;
 
-  debug('Uploaded response.Location', s3Location);
-
   if (!s3Location) {
     // TODO: out: a fallback case  - remove after deeper testing
     s3Location = out?.singleUploadResult?.Location;
@@ -295,8 +297,8 @@ const getS3LocationLink = async (out) => {
 };
 
 module.exports = {
-  uploadFileByPath: memoize(uploadFileByPath),
-  uploadFileAsBuffer: memoize(uploadFileAsBuffer),
+  uploadFileByPath,
+  uploadFileAsBuffer,
   isArtifactsEnabled,
   resetConfig,
 };

package/lib/utils/utils.js

@@ -299,7 +299,7 @@ function removeColorCodes(input) {
 }
 
 const jestHelpers = {
-  getIdOfCurrentlyRunningTest: () => {
+  getNameOfCurrentlyRunningTest: () => {
     if (!process.env.JEST_WORKER_ID) return null;
     try {
       // TODO: expect?.getState()?.testPath + ' ' + expect?.getState()?.currentTestName

package/package.json

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