cucumberjs-qase-reporter 2.0.2 → 2.0.4

package/changelog.md

@@ -1,3 +1,27 @@
+# qase-cucumberjs@2.0.4
+
+## What's new
+
+Fixed the issue with the `QaseFields` tag.
+
+# qase-cucumberjs@2.0.3
+
+## What's new
+
+Support attachments in the test results.
+
+```js
+const { Given, Then } = require('cucumber');
+
+Given('I have a step with attachment', async function() {
+  await this.attach('Hello, world!', 'text/plain');
+});
+
+Then('I have a step with attachment', async function() {
+  await this.attach('Hello, world!', 'text/plain');
+});
+```
+
 # qase-cucumberjs@2.0.2
 
 ## What's new

package/dist/reporter.js

@@ -9,6 +9,21 @@ const storage_1 = require("./storage");
  * @extends Formatter
  */
 class CucumberQaseReporter extends cucumber_1.Formatter {
+    /**
+     * @type {Record<string, string>}
+     * @private
+     */
+    storage;
+    /**
+     * @type {ReporterInterface}
+     * @private
+     */
+    reporter;
+    /**
+     * @type {EventEmitter}
+     * @private
+     */
+    eventBroadcaster;
     /**
      * @param {CucumberQaseOptionsType} options
      * @param {ConfigLoaderInterface} configLoader

package/dist/storage.d.ts

@@ -104,5 +104,6 @@ export declare class Storage {
      */
     private getSignature;
     private getError;
+    private getFileNameFromMediaType;
 }
 export {};

package/dist/storage.js

@@ -3,54 +3,53 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Storage = void 0;
 const qase_javascript_commons_1 = require("qase-javascript-commons");
 const cucumber_1 = require("@cucumber/cucumber");
+const uuid_1 = require("uuid");
 const qaseIdRegExp = /^@[Qq]-?(\d+)$/g;
 const newQaseIdRegExp = /^@[Qq]ase[Ii][Dd]=(\d+)$/g;
 const qaseTitleRegExp = /^@[Qq]ase[Tt]itle=(.+)$/g;
-const qaseFieldsRegExp = /^@[Qq]ase[Ff]ields:(.+?)=(.+)$/g;
+const qaseFieldsRegExp = /^@[Qq]ase[Ff]ields=(.+)$/g;
 const qaseIgnoreRegExp = /^@[Qq]ase[Ii][Gg][Nn][Oo][Rr][Ee]$/g;
 class Storage {
-    constructor() {
-        /**
-         * @type {Record<string, Pickle>}
-         * @private
-         */
-        this.pickles = {};
-        /**
-         * @type {Record<string, TestCaseStarted>}
-         * @private
-         */
-        this.testCaseStarts = {};
-        /**
-         * @type {Record<string, TestStepFinished>}
-         * @private
-         */
-        this.testCaseSteps = {};
-        /**
-         * @type {Record<string, TestStatusEnum>}
-         * @private
-         */
-        this.testCaseStartedResult = {};
-        /**
-         * @type {Record<string, string[]>}
-         * @private
-         */
-        this.testCaseStartedErrors = {};
-        /**
-         * @type {Record<string, string>}
-         * @private
-         */
-        this.testCases = {};
-        /**
-         * @type {Record<string, string>}
-         * @private
-         */
-        this.scenarios = {};
-        /**
-         * @type {Record<string, string>}
-         * @private
-         */
-        this.attachments = {};
-    }
+    /**
+     * @type {Record<string, Pickle>}
+     * @private
+     */
+    pickles = {};
+    /**
+     * @type {Record<string, TestCaseStarted>}
+     * @private
+     */
+    testCaseStarts = {};
+    /**
+     * @type {Record<string, TestStepFinished>}
+     * @private
+     */
+    testCaseSteps = {};
+    /**
+     * @type {Record<string, TestStatusEnum>}
+     * @private
+     */
+    testCaseStartedResult = {};
+    /**
+     * @type {Record<string, string[]>}
+     * @private
+     */
+    testCaseStartedErrors = {};
+    /**
+     * @type {Record<string, string>}
+     * @private
+     */
+    testCases = {};
+    /**
+     * @type {Record<string, string>}
+     * @private
+     */
+    scenarios = {};
+    /**
+     * @type {Record<string, string>}
+     * @private
+     */
+    attachments = {};
     /**
      * Add pickle to storage
      * @param {Pickle} pickle
@@ -77,17 +76,17 @@ class Storage {
      * @param {Attach} attachment
      */
     addAttachment(attachment) {
-        if (attachment.testCaseStartedId && attachment.fileName) {
-            if (!this.attachments[attachment.testCaseStartedId]) {
-                this.attachments[attachment.testCaseStartedId] = [];
+        if (attachment.testStepId) {
+            if (!this.attachments[attachment.testStepId]) {
+                this.attachments[attachment.testStepId] = [];
             }
-            this.attachments[attachment.testCaseStartedId]?.push({
-                file_name: attachment.fileName,
+            this.attachments[attachment.testStepId]?.push({
+                file_name: this.getFileNameFromMediaType(attachment.mediaType),
                 mime_type: attachment.mediaType,
                 file_path: null,
                 content: attachment.body,
                 size: 0,
-                id: attachment.fileName,
+                id: (0, uuid_1.v4)(),
             });
         }
     }
@@ -227,7 +226,7 @@ class Storage {
                     end_time: null,
                     duration: finished.testStepResult.duration.seconds,
                 },
-                attachments: [],
+                attachments: this.attachments[s.id] ?? [],
                 steps: [],
                 parent_id: null,
             };
@@ -235,6 +234,30 @@ class Storage {
         }
         return results;
     }
+    /**
+     * @type {Record<TestStepResultStatus, TestStatusEnum>}
+     */
+    static statusMap = {
+        [cucumber_1.Status.PASSED]: qase_javascript_commons_1.TestStatusEnum.passed,
+        [cucumber_1.Status.FAILED]: qase_javascript_commons_1.TestStatusEnum.failed,
+        [cucumber_1.Status.SKIPPED]: qase_javascript_commons_1.TestStatusEnum.skipped,
+        [cucumber_1.Status.AMBIGUOUS]: qase_javascript_commons_1.TestStatusEnum.failed,
+        [cucumber_1.Status.PENDING]: qase_javascript_commons_1.TestStatusEnum.skipped,
+        [cucumber_1.Status.UNDEFINED]: qase_javascript_commons_1.TestStatusEnum.skipped,
+        [cucumber_1.Status.UNKNOWN]: qase_javascript_commons_1.TestStatusEnum.skipped,
+    };
+    /**
+     * @type {Record<TestStepResultStatus, StepStatusEnum>}
+     */
+    static stepStatusMap = {
+        [cucumber_1.Status.PASSED]: qase_javascript_commons_1.StepStatusEnum.passed,
+        [cucumber_1.Status.FAILED]: qase_javascript_commons_1.StepStatusEnum.failed,
+        [cucumber_1.Status.SKIPPED]: qase_javascript_commons_1.StepStatusEnum.skipped,
+        [cucumber_1.Status.AMBIGUOUS]: qase_javascript_commons_1.StepStatusEnum.failed,
+        [cucumber_1.Status.PENDING]: qase_javascript_commons_1.StepStatusEnum.skipped,
+        [cucumber_1.Status.UNDEFINED]: qase_javascript_commons_1.StepStatusEnum.skipped,
+        [cucumber_1.Status.UNKNOWN]: qase_javascript_commons_1.StepStatusEnum.skipped,
+    };
     parseTags(tags) {
         const metadata = {
             ids: [],
@@ -256,7 +279,7 @@ class Storage {
                 continue;
             }
             if (qaseFieldsRegExp.test(tag.name)) {
-                const value = tag.name.replace(/^@[Qq]ase[Ff]ields:/, '');
+                const value = tag.name.replace(/^@[Qq]ase[Ff]ields=/, '');
                 try {
                     // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
                     const record = JSON.parse(value);
@@ -298,29 +321,29 @@ class Storage {
         });
         return error;
     }
+    getFileNameFromMediaType(mediaType) {
+        const extensions = {
+            'text/plain': 'txt',
+            'application/json': 'json',
+            'image/png': 'png',
+            'image/jpeg': 'jpg',
+            'image/gif': 'gif',
+            'text/html': 'html',
+            'application/pdf': 'pdf',
+            'application/xml': 'xml',
+            'application/zip': 'zip',
+            'application/msword': 'doc',
+            'application/vnd.ms-excel': 'xls',
+            'application/vnd.openxmlformats-officedocument.wordprocessingml.document': 'docx',
+            'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet': 'xlsx',
+        };
+        const extension = extensions[mediaType];
+        if (extension) {
+            return `file.${extension}`;
+        }
+        else {
+            return 'file';
+        }
+    }
 }
 exports.Storage = Storage;
-/**
- * @type {Record<TestStepResultStatus, TestStatusEnum>}
- */
-Storage.statusMap = {
-    [cucumber_1.Status.PASSED]: qase_javascript_commons_1.TestStatusEnum.passed,
-    [cucumber_1.Status.FAILED]: qase_javascript_commons_1.TestStatusEnum.failed,
-    [cucumber_1.Status.SKIPPED]: qase_javascript_commons_1.TestStatusEnum.skipped,
-    [cucumber_1.Status.AMBIGUOUS]: qase_javascript_commons_1.TestStatusEnum.failed,
-    [cucumber_1.Status.PENDING]: qase_javascript_commons_1.TestStatusEnum.skipped,
-    [cucumber_1.Status.UNDEFINED]: qase_javascript_commons_1.TestStatusEnum.skipped,
-    [cucumber_1.Status.UNKNOWN]: qase_javascript_commons_1.TestStatusEnum.skipped,
-};
-/**
- * @type {Record<TestStepResultStatus, StepStatusEnum>}
- */
-Storage.stepStatusMap = {
-    [cucumber_1.Status.PASSED]: qase_javascript_commons_1.StepStatusEnum.passed,
-    [cucumber_1.Status.FAILED]: qase_javascript_commons_1.StepStatusEnum.failed,
-    [cucumber_1.Status.SKIPPED]: qase_javascript_commons_1.StepStatusEnum.skipped,
-    [cucumber_1.Status.AMBIGUOUS]: qase_javascript_commons_1.StepStatusEnum.failed,
-    [cucumber_1.Status.PENDING]: qase_javascript_commons_1.StepStatusEnum.skipped,
-    [cucumber_1.Status.UNDEFINED]: qase_javascript_commons_1.StepStatusEnum.skipped,
-    [cucumber_1.Status.UNKNOWN]: qase_javascript_commons_1.StepStatusEnum.skipped,
-};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cucumberjs-qase-reporter",
-  "version": "2.0.2",
+  "version": "2.0.4",
   "description": "Qase TMS CucumberJS Reporter",
   "homepage": "https://github.com/qase-tms/qase-javascript",
   "main": "./dist/index.js",
@@ -49,6 +49,7 @@
     "@jest/globals": "^29.5.0",
     "@types/jest": "^29.5.2",
     "jest": "^29.5.0",
-    "ts-jest": "^29.1.0"
+    "ts-jest": "^29.1.0",
+    "uuid": "^9.0.0"
   }
 }