@qavajs/format-report-portal 0.9.3 → 0.10.0

package/CHANGELOG.MD

@@ -1,3 +1,10 @@
+## 0.10.0
+- added support of named hooks
+- added retries
+
+## 0.9.4
+- fixed bug with finishing launch before all data sent
+
 ## 0.9.3
 - updated rp client version
 

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'],

package/index.js

@@ -16,19 +16,27 @@ 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) {
-                await this.startLaunch();
+                const startLaunch = this.startLaunch();
+                this.promiseQ.push(startLaunch);
+                await startLaunch;
+            }
+            else if (envelope.testCaseFinished) {
+                const finishTest = this.finishTest(envelope)
+                this.promiseQ.push(finishTest);
+                await finishTest;
             }
             else if (envelope.testRunFinished) {
                 await this.finishLaunch();
             }
-            else if (envelope.testCaseFinished) {
-                await this.finishTest(envelope);
-            }
         } catch (err) {
             if (this.rpConfig.ignoreErrors) {
                 console.error(err);
@@ -38,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,
@@ -50,7 +63,6 @@ class RPFormatter extends Formatter {
 
         this.launchId = launchObj.tempId;
         this.features = {};
-        this.promiseQ.push(launchObj.promise);
         await launchObj.promise;
     }
 
@@ -65,7 +77,6 @@ class RPFormatter extends Formatter {
     }
 
     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]) {
@@ -80,7 +91,6 @@ class RPFormatter extends Formatter {
                     type: 'SUITE'
                 }, this.launchId);
                 this.features[featureName] = featureItem.tempId;
-                this.promiseQ.push(featureItem.promise);
                 await featureItem.promise;
             }, this.rpConfig.retry);
         }
@@ -104,15 +114,16 @@ 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);
-            this.promiseQ.push(testItem.promise);
             await testItem.promise;
             return testItem;
         }, this.rpConfig.retry);
@@ -130,7 +141,6 @@ class RPFormatter extends Formatter {
                     type: 'STEP',
                     hasStats: false
                 }, this.launchId, testItem.tempId);
-                this.promiseQ.push(nestedTestItem.promise);
                 await nestedTestItem.promise;
                 return nestedTestItem;
             }, this.rpConfig.retry);
@@ -142,7 +152,6 @@ class RPFormatter extends Formatter {
                         message: this.getMessage(step),
                         time: startTime
                     });
-                    this.promiseQ.push(log.promise);
                     await log.promise;
                 }, this.rpConfig.retry);
             }
@@ -158,7 +167,6 @@ class RPFormatter extends Formatter {
                     status: this.getStatus(step),
                     endTime
                 });
-                this.promiseQ.push(nestedItemFinish.promise);
                 await nestedItemFinish.promise;
                 startTime = endTime;
             }, this.rpConfig.retry);
@@ -172,12 +180,13 @@ class RPFormatter extends Formatter {
             status,
             endTime
         });
-        this.promiseQ.push(testItemFinish.promise);
         await testItemFinish.promise;
     }
 
     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] ?? []
@@ -198,6 +207,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'
     }
@@ -258,7 +269,6 @@ class RPFormatter extends Formatter {
                 time: startTime
             }, attachmentData);
         }
-        this.promiseQ.push(log.promise);
         await log.promise;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qavajs/format-report-portal",
-  "version": "0.9.3",
+  "version": "0.10.0",
   "description": "cucumber formatter for report portal",
   "main": "index.js",
   "scripts": {
@@ -23,7 +23,7 @@
     "@reportportal/client-javascript": "^5.0.12"
   },
   "devDependencies": {
-    "@cucumber/cucumber": "^9.1.2",
+    "@cucumber/cucumber": "^9.2.0",
     "@qavajs/cli": "^0.26.0",
     "@qavajs/memory": "^1.5.1"
   }