@qavajs/format-report-portal 0.0.3 → 0.0.5

package/CHANGELOG.MD

@@ -0,0 +1,6 @@
+## 0.0.5
+- :rocket: updated step logging as nested steps instead plain logs
+- :beetle: added capability to attach multiple attachment to step
+
+## 0.0.4
+- :beetle: fixed issue with sending text plain

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 @qavajs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.MD

@@ -15,6 +15,8 @@ module.exports = {
         ],
         formatOptions: {
             rpConfig: {
+                enable: true,
+                debug: false,
                 token: 'your token',
                 endpoint: 'https://your-rp-instance/api/v1',
                 description: 'Description',
@@ -27,3 +29,9 @@ module.exports = {
     }
 }
 ```
+Option `enable` is set to `true` even if it is not defined explicitly in rpConfig section.
+
+### run e2e test
+add token.json file with rp token and other config
+run
+`npm run test-e2e`

package/index.js

@@ -5,9 +5,12 @@ class RPFormatter extends Formatter {
 
     constructor(options) {
         super(options);
+        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;
         this.rpClient = new RPClient(this.rpConfig);
+        this.promiseQ = [];
     }
 
     async processEnvelope(envelope) {
@@ -28,15 +31,18 @@ class RPFormatter extends Formatter {
             startTime: this.rpClient.helpers.now(),
             description: this.rpConfig.description,
             attributes: this.rpConfig.tags,
-            mode: this.rpConfig.mode
+            mode: this.rpConfig.mode,
+            debug: this.rpConfig.debug
         });
 
         this.launchId = launchObj.tempId;
         this.features = {};
+        this.promiseQ.push(launchObj.promise);
         await launchObj.promise;
     }
 
     async finishLaunch() {
+        await Promise.allSettled(this.promiseQ);
         for (const featureName in this.features) {
             await this.rpClient.finishTestItem(this.features[featureName], { status: 'PASSED' }).promise;
         }
@@ -60,6 +66,7 @@ class RPFormatter extends Formatter {
                 type: 'SUITE'
             }, this.launchId);
             this.features[featureName] = featureItem.tempId;
+            this.promiseQ.push(featureItem.promise);
             await featureItem.promise;
         }
 
@@ -71,34 +78,63 @@ class RPFormatter extends Formatter {
             startTime: this.rpClient.helpers.now(),
             type: 'STEP'
         }, this.launchId, featureTempId);
+        this.promiseQ.push(testItem.promise);
         await testItem.promise;
 
         //send steps
         const steps = this.getStepResults(testCase)
         for (const step of steps) {
-            const attachment = step.attachment && step.attachment[0]
-                ? {
-                    name: 'attachment',
-                    type: step.attachment[0].mediaType,
-                    content: step.attachment[0].body
+            const nestedTestItem = this.rpClient.startTestItem({
+                description: 'test description',
+                name: this.getStepText(step, steps),
+                startTime: this.rpClient.helpers.now(),
+                type: 'STEP',
+                hasStats: false
+            }, this.launchId, testItem.tempId);
+            this.promiseQ.push(nestedTestItem.promise);
+            await nestedTestItem.promise;
+            if (step.result.message) {
+                const log = await this.rpClient.sendLog(nestedTestItem.tempId, {
+                    level: 'ERROR',
+                    message: this.getMessage(step),
+                    time: this.rpClient.helpers.now()
+                });
+                this.promiseQ.push(log.promise);
+                await log.promise;
+            }
+            if (step.attachment) {
+                for (const attachment of step.attachment) {
+                    const attachmentData = {
+                        name: 'attachment',
+                        type: attachment.mediaType,
+                        content: this.prepareContent(attachment),
+                    };
+                    const log = await this.rpClient.sendLog(nestedTestItem.tempId, {
+                        level: 'INFO',
+                        message: 'Attachment',
+                        time: this.rpClient.helpers.now()
+                    }, attachmentData);
+                    this.promiseQ.push(log.promise);
+                    await log.promise;
                 }
-                : undefined;
-            await this.rpClient.sendLog(testItem.tempId, {
-                level: step.result.status === Status.PASSED
-                    ? 'INFO'
-                    : 'ERROR',
-                message: this.getMessage(step),
-                time: this.rpClient.helpers.now()
-            }, attachment).promise
+            }
+            const nestedItemFinish = this.rpClient.finishTestItem(nestedTestItem.tempId, {
+                status: this.getStatus(step),
+                endTime: this.rpClient.helpers.now()
+            });
+            this.promiseQ.push(nestedItemFinish.promise);
+            await nestedItemFinish.promise;
         }
 
         //finish test item
         const status = Object.values(testCase.stepResults).some(step => step.status !== Status.PASSED)
             ? Status.FAILED.toLowerCase()
             : Status.PASSED.toLowerCase()
-        await this.rpClient.finishTestItem(testItem.tempId, {
+        const testItemFinish = this.rpClient.finishTestItem(testItem.tempId, {
             status
-        }).promise;
+        });
+        this.promiseQ.push(testItemFinish.promise);
+        await testItemFinish.promise;
     }
 
     getStepResults(testCase) {
@@ -109,8 +145,8 @@ class RPFormatter extends Formatter {
         }))
     }
 
-    getMessage(step) {
-        if (!step.pickle) return 'Hook';
+    getStepText(step, steps) {
+        if (!step.pickle) return this.hookKeyword(step, steps);
         const messageParts = [step.pickle.text];
         if (step.pickle.argument) {
             if (step.pickle.argument.dataTable) messageParts.push(
@@ -118,11 +154,25 @@ class RPFormatter extends Formatter {
             )
             if (step.pickle.argument.docString) messageParts.push(this.formatDocString(step.pickle.argument.docString))
         }
-        if (step.result.status === Status.FAILED) messageParts.push(step.result.message)
 
         return messageParts.join('\n')
     }
 
+    hookKeyword(step, steps) {
+        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
+    }
+
+    getStatus(step) {
+        if (step.result.status !== Status.PASSED) {
+            return Status.FAILED.toLowerCase()
+        }
+        return Status.PASSED.toLowerCase()
+    }
+
     formatTable(dataTable) {
         const TR = '<tr>';
         const TRE = '</tr>';
@@ -139,6 +189,13 @@ class RPFormatter extends Formatter {
     formatTags(tags) {
         return tags.map(tag => '<code>' + tag.name + '</code>').join('')
     }
+
+    prepareContent(attachment) {
+        return ['text/plain', 'application/json'].includes(attachment.mediaType)
+            ? Buffer.from(attachment.body).toString('base64')
+            : attachment.body
+    }
+
 }
 
 module.exports = RPFormatter

package/package.json

@@ -1,9 +1,11 @@
 {
   "name": "@qavajs/format-report-portal",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "cucumber formatter for report portal",
   "main": "index.js",
-  "scripts": {},
+  "scripts": {
+    "test-e2e": "qavajs run --config test-e2e/config.js"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/qavajs/format-report-portal.git"
@@ -17,6 +19,13 @@
   },
   "homepage": "https://github.com/qavajs/format-report-portal#readme",
   "dependencies": {
-    "@reportportal/client-javascript": "^5.0.6"
+    "@reportportal/client-javascript": "^5.0.8"
+  },
+  "devDependencies": {
+    "@cucumber/cucumber": "^9.0.0",
+    "@qavajs/cli": "^0.0.18",
+    "@qavajs/memory": "^1.2.0",
+    "@qavajs/po-playwright": "^0.0.7",
+    "@qavajs/steps-playwright": "^0.0.14"
   }
 }

package/.github/workflows/npm-publish.yml

@@ -1,32 +0,0 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
-
-name: Node.js Package
-
-on:
-  release:
-    types: [created]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
-        with:
-          node-version: 16
-      - run: npm ci
-
-  publish-npm:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
-        with:
-          node-version: 16
-          registry-url: https://registry.npmjs.org/
-      - run: npm ci
-      - run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}