@qavajs/format-report-portal 0.0.8 → 0.9.0

package/CHANGELOG.MD

@@ -1,3 +1,6 @@
+## 0.9.0
+- :rocket: implemented capability to add attributes to test
+
 ## 0.0.8
 - :beetle: fixed sending duration
 

package/README.MD

@@ -1,10 +1,10 @@
 ## @qavajs/format-report-portal
 This package is formatter for EPAM report portal
 
-### install
+### Install
 `npm install @qavajs/format-report-portal`
 
-### configuration
+### Configuration
 
 add formatter to config.js
 ```javascript
@@ -31,7 +31,19 @@ module.exports = {
 ```
 Option `enable` is set to `true` even if it is not defined explicitly in rpConfig section.
 
-### run e2e test
+### Test Level Attributes
+Test level attributes can be added via cucumber logs e.g. in Before hook
+```javascript
+const { Before } = require('@cucumber/cucumber');
+
+Before(function () {
+    this.log('log from before'); //just log
+    this.log(`rp_attribute: fixed:42`); //static attribute
+    this.log(`rp_attribute: random:${Date.now()}`); //dynamic attribute
+});
+```
+
+### Run E2E Test
 add token.json file with rp token and other config
 run
 `npm run test-e2e`

package/index.js

@@ -1,5 +1,9 @@
 const { Formatter, Status } = require('@cucumber/cucumber');
 const RPClient = require('@reportportal/client-javascript');
+
+const RP_ATTRIBUTE_PREFIX = /^rp_attribute:\s*/;
+const isAttribute = (attachment) => attachment.mediaType === 'text/x.cucumber.log+plain' && RP_ATTRIBUTE_PREFIX.test(attachment.body)
+
 class RPFormatter extends Formatter {
     launchId = null;
 
@@ -73,18 +77,25 @@ class RPFormatter extends Formatter {
         const featureTempId = this.features[featureName];
         let startTime = this.rpClient.helpers.now();
         let endTime;
-        // Start test item
+        const steps = this.getStepResults(testCase);
+        const attributes = steps.reduce((attachments, step) => {
+            const attrs = step.attachment
+                .filter(isAttribute)
+                .map(attachment => attachment.body.replace(RP_ATTRIBUTE_PREFIX, ''));
+            return [...new Set([...attachments, ...attrs])]
+        }, []);
+        // Start test
         const testItem = this.rpClient.startTestItem({
             description: this.formatTags(testCase.pickle.tags),
             name: testCase.pickle.name,
             startTime,
-            type: 'STEP'
+            type: 'STEP',
+            attributes
         }, this.launchId, featureTempId);
         this.promiseQ.push(testItem.promise);
         await testItem.promise;
 
         //send steps
-        const steps = this.getStepResults(testCase)
         for (const step of steps) {
             const duration = step.result.duration;
             endTime = startTime + (duration.seconds * 1_000) + Math.floor(duration.nanos / 1_000_000);
@@ -136,7 +147,7 @@ class RPFormatter extends Formatter {
         return testCase.testCase.testSteps.map(step => ({
             result: testCase.stepResults[step.id],
             pickle: testCase.pickle.steps.find(pickle => pickle.id === step.pickleStepId),
-            attachment: testCase.stepAttachments[step.id]
+            attachment: testCase.stepAttachments[step.id] ?? []
         }))
     }
 
@@ -194,6 +205,7 @@ class RPFormatter extends Formatter {
 
     async sendAttachment(attachment, testItem, startTime) {
         let log;
+        if (attachment.mediaType === 'text/x.cucumber.log+plain' && RP_ATTRIBUTE_PREFIX.test(attachment.body)) return;
         if (attachment.mediaType === 'text/x.cucumber.log+plain') {
             log = await this.rpClient.sendLog(testItem.tempId, {
                 level: 'INFO',

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@qavajs/format-report-portal",
-  "version": "0.0.8",
+  "version": "0.9.0",
   "description": "cucumber formatter for report portal",
   "main": "index.js",
   "scripts": {
-    "test-e2e": "qavajs run --config test-e2e/config.js"
+    "test:e2e": "qavajs run --config test-e2e/config.js"
   },
   "repository": {
     "type": "git",
@@ -20,11 +20,11 @@
   },
   "homepage": "https://github.com/qavajs/format-report-portal#readme",
   "dependencies": {
-    "@reportportal/client-javascript": "^5.0.8"
+    "@reportportal/client-javascript": "^5.0.10"
   },
   "devDependencies": {
-    "@cucumber/cucumber": "^9.1.0",
-    "@qavajs/cli": "^0.0.21",
-    "@qavajs/memory": "^1.3.0"
+    "@cucumber/cucumber": "^9.1.2",
+    "@qavajs/cli": "^0.0.24",
+    "@qavajs/memory": "^1.4.1"
   }
 }