@qavajs/format-report-portal 0.9.4 → 0.11.0

package/CHANGELOG.MD

@@ -1,3 +1,10 @@
+## 0.11.0
+- added flag to print launch url
+
+## 0.10.0
+- added support of named hooks
+- added retries
+
 ## 0.9.4
 - fixed bug with finishing launch before all data sent
 

package/README.MD

@@ -17,7 +17,7 @@ module.exports = {
             rpConfig: {
                 enable: true,
                 debug: false,
-                token: 'your token',
+                apiKey: 'your token',
                 endpoint: 'https://your-rp-instance/api/v1',
                 description: 'Description',
                 tags: ['Tag'],
@@ -25,7 +25,8 @@ module.exports = {
                 launch: 'your launch name',
                 mode: 'DEFAULT',
                 retry: 1, // number of retries to send result to report portal (default - 1)
-                ignoreErrors: false // ignore RP errors (default: false)
+                ignoreErrors: false, // ignore RP errors (default: false)
+                showLaunchURL: true // log report portal launch link
             },
         }
     }

package/index.js

@@ -16,10 +16,14 @@ class RPFormatter extends Formatter {
         this.rpConfig = options.parsedArgvOptions.rpConfig;
         this.rpClient = new RPClient(this.rpConfig);
         this.promiseQ = [];
+        this.stepDefinitions = {};
     }
 
     async processEnvelope(envelope) {
         try {
+            if (envelope.stepDefinition || envelope.hook) {
+                return this.readStepDefinition(envelope);
+            }
             if (envelope.testRunStarted) {
                 const startLaunch = this.startLaunch();
                 this.promiseQ.push(startLaunch);
@@ -42,6 +46,11 @@ class RPFormatter extends Formatter {
         }
     }
 
+    readStepDefinition(stepDefinition) {
+        const definition = stepDefinition.stepDefinition ?? stepDefinition.hook;
+        this.stepDefinitions[definition.id] = definition;
+    }
+
     async startLaunch() {
         const launchObj = this.rpClient.startLaunch({
             name: this.rpConfig.launch,
@@ -62,13 +71,14 @@ class RPFormatter extends Formatter {
         for (const featureName in this.features) {
             await this.rpClient.finishTestItem(this.features[featureName], { status: 'PASSED' }).promise;
         }
-        await this.rpClient.finishLaunch(this.launchId, {
+        const launch = await this.rpClient.finishLaunch(this.launchId, {
             endTime: this.rpClient.helpers.now()
         }).promise;
+
+        if (this.rpConfig.showLaunchURL) console.log(`RP launch link: ${launch.link}`);
     }
 
     async finishTest(envelope) {
-        if (envelope.testCaseFinished.willBeRetried) return;
         const testCase = this.eventDataCollector.getTestCaseAttempt(envelope.testCaseFinished.testCaseStartedId);
         const featureName = testCase.gherkinDocument.feature.name;
         if (!this.features[featureName]) {
@@ -106,13 +116,15 @@ class RPFormatter extends Formatter {
             });
 
         // Start test
+        const retryTest = Boolean(testCase.attempt);
         const testItem = await retry(async () => {
             const testItem = this.rpClient.startTestItem({
                 description: this.formatTags(testCase.pickle.tags),
                 name: testCase.pickle.name,
                 startTime,
                 type: 'STEP',
-                attributes
+                attributes,
+                retry: retryTest
             }, this.launchId, featureTempId);
             await testItem.promise;
             return testItem;
@@ -175,6 +187,8 @@ class RPFormatter extends Formatter {
 
     getStepResults(testCase) {
         return testCase.testCase.testSteps.map(step => ({
+            id: step.id,
+            stepDefinitionId: step.pickleStepId ?? step.hookId,
             result: testCase.stepResults[step.id],
             pickle: testCase.pickle.steps.find(pickle => pickle.id === step.pickleStepId),
             attachment: testCase.stepAttachments[step.id] ?? []
@@ -195,6 +209,8 @@ class RPFormatter extends Formatter {
     }
 
     hookKeyword(step, steps) {
+        const hook = this.stepDefinitions[step.stepDefinitionId];
+        if (hook?.name) return hook.name;
         const stepsBefore = steps.slice(0, steps.findIndex((element) => element === step));
         return stepsBefore.every(element => element.pickle === undefined) ? 'Before' : 'After'
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qavajs/format-report-portal",
-  "version": "0.9.4",
+  "version": "0.11.0",
   "description": "cucumber formatter for report portal",
   "main": "index.js",
   "scripts": {
@@ -20,11 +20,11 @@
   },
   "homepage": "https://github.com/qavajs/format-report-portal#readme",
   "dependencies": {
-    "@reportportal/client-javascript": "^5.0.12"
+    "@reportportal/client-javascript": "^5.0.13"
   },
   "devDependencies": {
-    "@cucumber/cucumber": "^9.2.0",
-    "@qavajs/cli": "^0.26.0",
-    "@qavajs/memory": "^1.5.1"
+    "@cucumber/cucumber": "^9.4.0",
+    "@qavajs/cli": "^0.28.0",
+    "@qavajs/memory": "^1.6.2"
   }
 }