@qavajs/format-report-portal 0.0.1

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

@@ -0,0 +1,32 @@
+# 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}}

package/README.MD

@@ -0,0 +1,28 @@
+## @qavajs/format-report-portal
+This package is formatter for EPAM report portal
+
+### install
+`npm install @qavajs/format-report-portal`
+
+### configuration
+
+add formatter to config.js
+```javascript
+module.exports = {
+    default: {
+        format: [
+            '@qavajs/format-report-portal'
+        ],
+        formatOptions: {
+            rpConfig: {
+                token: 'your token',
+                endpoint: 'https://your-rp-instance/api/v1',
+                description: 'Description',
+                tags: ['Tag'],
+                project: 'your project',
+                launch: 'your launch name'
+            },
+        }
+    }
+}
+```

package/index.js

@@ -0,0 +1,143 @@
+const { Formatter, Status } = require('@cucumber/cucumber');
+const RPClient = require('@reportportal/client-javascript');
+class RPFormatter extends Formatter {
+    launchId = null;
+
+    constructor(options) {
+        super(options);
+        options.eventBroadcaster.on('envelope', this.processEnvelope.bind(this));
+        this.rpConfig = options.parsedArgvOptions.rpConfig;
+        this.rpClient = new RPClient(this.rpConfig);
+    }
+
+    async processEnvelope(envelope) {
+        if (envelope.testRunStarted) {
+            await this.startLaunch();
+        }
+        else if (envelope.testRunFinished) {
+            await this.finishLaunch();
+        }
+        else if (envelope.testCaseFinished) {
+            await this.finishTest(envelope);
+        }
+    }
+
+    async startLaunch() {
+        const launchObj = this.rpClient.startLaunch({
+            name: this.rpConfig.launch,
+            startTime: this.rpClient.helpers.now(),
+            description: this.rpConfig.description,
+            attributes: this.rpConfig.tags
+        });
+
+        this.launchId = launchObj.tempId;
+        this.features = {};
+        await launchObj.promise;
+    }
+
+    async finishLaunch() {
+        for (const featureName in this.features) {
+            await this.rpClient.finishTestItem(this.features[featureName], { status: 'PASSED' }).promise;
+        }
+
+        await this.rpClient.finishLaunch(this.launchId, {
+            endTime: this.rpClient.helpers.now()
+        }).promise;
+    }
+
+    async finishTest(envelope) {
+        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;
+            await featureItem.promise;
+        }
+
+        const featureTempId = this.features[featureName]
+        // Start test item
+        const testItem = this.rpClient.startTestItem({
+            description: this.formatTags(testCase.pickle.tags),
+            name: testCase.pickle.name,
+            startTime: this.rpClient.helpers.now(),
+            type: 'STEP'
+        }, this.launchId, featureTempId);
+        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
+                }
+                : 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
+        }
+
+        //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, {
+            status
+        }).promise;
+    }
+
+    getStepResults(testCase) {
+        return testCase.testCase.testSteps.map(step => ({
+            result: testCase.stepResults[step.id],
+            pickle: testCase.pickle.steps.find(pickle => pickle.id === step.pickleStepId),
+            attachment: testCase.stepAttachments[step.id]
+        }))
+    }
+
+    getMessage(step) {
+        if (!step.pickle) return 'Hook';
+        const messageParts = [step.pickle.text];
+        if (step.pickle.argument) {
+            if (step.pickle.argument.dataTable) messageParts.push(
+                this.formatTable(step.pickle.argument.dataTable)
+            )
+            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')
+    }
+
+    formatTable(dataTable) {
+        const TR = '<tr>';
+        const TRE = '</tr>';
+        const TD = '<td>';
+        const TDE = '</td>';
+        const formatRow = row => TR + row.cells.map(cell => TD + cell.value + TDE).join('') + TRE;
+        return '<table><tbody>' + dataTable.rows.map(formatRow).join('') + '</tbody></table>'
+    }
+
+    formatDocString(docString) {
+        return '<pre><code>' + docString.content + '</code></pre>'
+    }
+
+    formatTags(tags) {
+        return tags.map(tag => '<code>' + tag.name + '</code>').join('')
+    }
+}
+
+module.exports = RPFormatter

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@qavajs/format-report-portal",
+  "version": "0.0.1",
+  "description": "cucumber formatter for report portal",
+  "main": "index.js",
+  "scripts": {},
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/qavajs/format-report-portal.git"
+  },
+  "authors": [
+    "Alexandr Galichenko"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/qavajs/format-report-portal/issues"
+  },
+  "homepage": "https://github.com/qavajs/format-report-portal#readme",
+  "dependencies": {
+    "@reportportal/client-javascript": "^5.0.6"
+  }
+}