@qavajs/format-report-portal 0.9.0 → 0.9.2

package/CHANGELOG.MD

@@ -1,3 +1,9 @@
+## 0.9.2
+- :beetle: added capability to ignore errors
+
+## 0.9.1
+- :beetle: added request retry in case of error
+
 ## 0.9.0
 - :rocket: implemented capability to add attributes to test
 

package/README.MD

@@ -23,7 +23,9 @@ module.exports = {
                 tags: ['Tag'],
                 project: 'your project',
                 launch: 'your launch name',
-                mode: 'DEFAULT'
+                mode: 'DEFAULT',
+                retry: 1, // number of retries to send result to report portal (default - 1)
+                ignoreErrors: false // ignore RP errors (default: false)
             },
         }
     }

package/index.js

@@ -1,5 +1,6 @@
 const { Formatter, Status } = require('@cucumber/cucumber');
 const RPClient = require('@reportportal/client-javascript');
+const { retry } = require('./utils');
 
 const RP_ATTRIBUTE_PREFIX = /^rp_attribute:\s*/;
 const isAttribute = (attachment) => attachment.mediaType === 'text/x.cucumber.log+plain' && RP_ATTRIBUTE_PREFIX.test(attachment.body)
@@ -18,14 +19,22 @@ class RPFormatter extends Formatter {
     }
 
     async processEnvelope(envelope) {
-        if (envelope.testRunStarted) {
-            await this.startLaunch();
-        }
-        else if (envelope.testRunFinished) {
-            await this.finishLaunch();
-        }
-        else if (envelope.testCaseFinished) {
-            await this.finishTest(envelope);
+        try {
+            if (envelope.testRunStarted) {
+                await this.startLaunch();
+            }
+            else if (envelope.testRunFinished) {
+                await this.finishLaunch();
+            }
+            else if (envelope.testCaseFinished) {
+                await this.finishTest(envelope);
+            }
+        } catch (err) {
+            if (this.rpConfig.ignoreErrors) {
+                console.error(err);
+            } else {
+                throw err;
+            }
         }
     }
 
@@ -60,75 +69,99 @@ class RPFormatter extends Formatter {
         const testCase = this.eventDataCollector.getTestCaseAttempt(envelope.testCaseFinished.testCaseStartedId);
         const featureName = testCase.gherkinDocument.feature.name;
         if (!this.features[featureName]) {
-            const featureItem = this.rpClient.startTestItem({
-                description:
-                    this.formatTags(testCase.gherkinDocument.feature.tags) +
-                    '\n' +
-                    testCase.gherkinDocument.feature.description,
-                name: featureName,
-                startTime: this.rpClient.helpers.now(),
-                type: 'SUITE'
-            }, this.launchId);
-            this.features[featureName] = featureItem.tempId;
-            this.promiseQ.push(featureItem.promise);
-            await featureItem.promise;
+            await retry(async () => {
+                const featureItem = this.rpClient.startTestItem({
+                    description:
+                        this.formatTags(testCase.gherkinDocument.feature.tags) +
+                        '\n' +
+                        testCase.gherkinDocument.feature.description,
+                    name: featureName,
+                    startTime: this.rpClient.helpers.now(),
+                    type: 'SUITE'
+                }, this.launchId);
+                this.features[featureName] = featureItem.tempId;
+                this.promiseQ.push(featureItem.promise);
+                await featureItem.promise;
+            }, this.rpConfig.retry);
         }
 
         const featureTempId = this.features[featureName];
         let startTime = this.rpClient.helpers.now();
         let endTime;
         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])]
-        }, []);
+        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])]
+            }, [])
+            .map(attachment => {
+                const [key, value] = attachment.split(':');
+                return key && value
+                    ? { key, value, system: false }
+                    : { value: key, system: false }
+            });
+
         // Start test
-        const testItem = this.rpClient.startTestItem({
-            description: this.formatTags(testCase.pickle.tags),
-            name: testCase.pickle.name,
-            startTime,
-            type: 'STEP',
-            attributes
-        }, this.launchId, featureTempId);
-        this.promiseQ.push(testItem.promise);
-        await testItem.promise;
+        const testItem = await retry(async () => {
+            const testItem = this.rpClient.startTestItem({
+                description: this.formatTags(testCase.pickle.tags),
+                name: testCase.pickle.name,
+                startTime,
+                type: 'STEP',
+                attributes
+            }, this.launchId, featureTempId);
+            this.promiseQ.push(testItem.promise);
+            await testItem.promise;
+            return testItem;
+        }, this.rpConfig.retry);
 
         //send steps
         for (const step of steps) {
             const duration = step.result.duration;
             endTime = startTime + (duration.seconds * 1_000) + Math.floor(duration.nanos / 1_000_000);
-            const nestedTestItem = this.rpClient.startTestItem({
-                description: 'test description',
-                name: this.getStepText(step, steps),
-                startTime,
-                type: 'STEP',
-                hasStats: false
-            }, this.launchId, testItem.tempId);
-            this.promiseQ.push(nestedTestItem.promise);
-            await nestedTestItem.promise;
+
+            const nestedTestItem = await retry(async () => {
+                const nestedTestItem = this.rpClient.startTestItem({
+                    description: 'test description',
+                    name: this.getStepText(step, steps),
+                    startTime,
+                    type: 'STEP',
+                    hasStats: false
+                }, this.launchId, testItem.tempId);
+                this.promiseQ.push(nestedTestItem.promise);
+                await nestedTestItem.promise;
+                return nestedTestItem;
+            }, this.rpConfig.retry);
+
             if (step.result.message) {
-                const log = await this.rpClient.sendLog(nestedTestItem.tempId, {
-                    level: 'ERROR',
-                    message: this.getMessage(step),
-                    time: startTime
-                });
-                this.promiseQ.push(log.promise);
-                await log.promise;
+                await retry(async () => {
+                    const log = await this.rpClient.sendLog(nestedTestItem.tempId, {
+                        level: 'ERROR',
+                        message: this.getMessage(step),
+                        time: startTime
+                    });
+                    this.promiseQ.push(log.promise);
+                    await log.promise;
+                }, this.rpConfig.retry);
             }
             if (step.attachment) {
                 for (const attachment of step.attachment) {
-                    await this.sendAttachment(attachment, nestedTestItem, startTime);
+                    await retry(async () => {
+                        await this.sendAttachment(attachment, nestedTestItem, startTime);
+                    }, this.rpConfig.retry);
                 }
             }
-            const nestedItemFinish = this.rpClient.finishTestItem(nestedTestItem.tempId, {
-                status: this.getStatus(step),
-                endTime
-            });
-            this.promiseQ.push(nestedItemFinish.promise);
-            await nestedItemFinish.promise;
-            startTime = endTime;
+            await retry(async () => {
+                const nestedItemFinish = this.rpClient.finishTestItem(nestedTestItem.tempId, {
+                    status: this.getStatus(step),
+                    endTime
+                });
+                this.promiseQ.push(nestedItemFinish.promise);
+                await nestedItemFinish.promise;
+                startTime = endTime;
+            }, this.rpConfig.retry);
         }
 
         //finish test item
@@ -168,6 +201,7 @@ class RPFormatter extends Formatter {
         const stepsBefore = steps.slice(0, steps.findIndex((element) => element === step));
         return stepsBefore.every(element => element.pickle === undefined) ? 'Before' : 'After'
     }
+
     getMessage(step) {
         return step.result.message
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qavajs/format-report-portal",
-  "version": "0.9.0",
+  "version": "0.9.2",
   "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.10"
+    "@reportportal/client-javascript": "^5.0.11"
   },
   "devDependencies": {
     "@cucumber/cucumber": "^9.1.2",
-    "@qavajs/cli": "^0.0.24",
-    "@qavajs/memory": "^1.4.1"
+    "@qavajs/cli": "^0.26.0",
+    "@qavajs/memory": "^1.4.2"
   }
 }

package/utils.js

@@ -0,0 +1,18 @@
+async function retry(fn, retries = 1) {
+    let currentTry = 0;
+    let lastError;
+    while (currentTry < retries) {
+        try {
+            const result = await fn();
+            return result;
+        } catch (err) {
+            console.error(err);
+            currentTry++;
+            lastError = err;
+        }
+    }
+}
+
+module.exports = {
+    retry
+}