@qavajs/format-report-portal 0.13.0 → 0.14.0

package/CHANGELOG.MD

@@ -1,3 +1,13 @@
+## 0.14.0
+- added config parameter for placing tags to attributes or description (default)
+
+## 0.13.2
+- updated version to 0.13.2
+- pull request template added to reduce human factor
+
+## 0.13.1
+- fixed a missed bracket
+
 ## 0.13.0
 - changed an approach to distribute tags as attributes for suite and test entities
 

package/README.MD

@@ -26,7 +26,8 @@ module.exports = {
                 mode: 'DEFAULT',
                 retry: 1, // number of retries to send result to report portal (default - 1)
                 ignoreErrors: false, // ignore RP errors (default: false)
-                showLaunchURL: true // log report portal launch link
+                showLaunchURL: true // log report portal launch link,
+                tagsAsAttributes: true // (default: false → tags go to description)
             },
         }
     }
@@ -45,8 +46,12 @@ Before(function () {
     this.log(`rp_attribute: random:${Date.now()}`); //dynamic attribute
 });
 ```
+### Run Unit Tests
+add token.json file with rp token and other config
+run
+`npm run test`
 
-### Run E2E Test
+### Run E2E Tests
 add token.json file with rp token and other config
 run
 `npm run test-e2e`

package/index.js

@@ -10,7 +10,7 @@ class RPFormatter extends Formatter {
 
     constructor(options) {
         super(options);
-        const rpEnable = options.parsedArgvOptions.rpConfig.enable;
+        const rpEnable = options.parsedArgvOptions?.rpConfig?.enable;
         if (rpEnable !== undefined && !rpEnable) return undefined;
         options.eventBroadcaster.on('envelope', this.processEnvelope.bind(this));
         this.rpConfig = options.parsedArgvOptions.rpConfig;
@@ -84,11 +84,10 @@ class RPFormatter extends Formatter {
         if (!this.features[featureName]) {
             await retry(async () => {
                 const featureItem = this.rpClient.startTestItem({
-                    attributes: this.prepareTags(testCase.gherkinDocument.feature.tags),
+                    attributes: this.rpConfig.tagsAsAttributes ? this.prepareTags(testCase.gherkinDocument.feature.tags) : [],
                     description:
-                        this.formatTags(testCase.gherkinDocument.feature.tags) +
-                        '\n' +
-                        testCase.gherkinDocument.feature.description,
+                        this.rpConfig.tagsAsAttributes ? '' : `${this.formatTags(testCase.gherkinDocument.feature.tags)}\n`
+                        + testCase.gherkinDocument.feature.description,
                     name: featureName,
                     startTime: this.rpClient.helpers.now(),
                     type: 'SUITE'
@@ -120,11 +119,13 @@ class RPFormatter extends Formatter {
         const retryTest = Boolean(testCase.attempt);
         const testItem = await retry(async () => {
             const testItem = this.rpClient.startTestItem({
-                description: this.formatTags(testCase.pickle.tags),
+                description: this.rpConfig.tagsAsAttributes ? '' : this.formatTags(testCase.pickle.tags),
                 name: testCase.pickle.name,
                 startTime,
                 type: 'STEP',
-                attributes: [...attributes, ...this.prepareTags(testCase.pickle.tags) ],
+                attributes: [
+                    ...attributes,
+                    ...(this.rpConfig.tagsAsAttributes ? this.prepareTags(testCase.pickle.tags) : []) ],
                 retry: retryTest
             }, this.launchId, featureTempId);
             await testItem.promise;
@@ -243,7 +244,8 @@ class RPFormatter extends Formatter {
 
     formatTags(tags) {
         return tags.map(tag => '<code>' + tag.name + '</code>').join('')
-        
+    }
+
     prepareTags(tags) {
         return tags.map(tag => tag.name)
     }

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@qavajs/format-report-portal",
-  "version": "0.13.0",
+  "version": "0.14.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",
+    "test": "jest"
   },
   "repository": {
     "type": "git",
@@ -24,7 +25,8 @@
   },
   "devDependencies": {
     "@cucumber/cucumber": "^9.5.1",
-    "@qavajs/cli": "^0.28.0",
-    "@qavajs/memory": "^1.6.2"
+    "@qavajs/cli": "^0.29.0",
+    "@qavajs/memory": "^1.6.2",
+    "jest": "^29.7.0"
   }
 }