cucumberjs-qase-reporter 2.0.1 → 2.0.3

package/changelog.md

@@ -1,3 +1,35 @@
+# 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
+
+- Support `QaseIgnore` tag. If the test case has the `QaseIgnore` tag, the reporter will not send the result to the Qase
+  TMS.
+
+    ```cucumber
+    @QaseIgnore
+    Scenario: simple test
+    ```
+
+- Improved error handling.
+
 # qase-cucumberjs@2.0.0
 
 ## What's new

package/dist/models.d.ts

@@ -2,4 +2,5 @@ interface TestMetadata {
     ids: number[];
     fields: Record<string, string>;
     title: string | null;
+    isIgnore: boolean;
 }

package/dist/storage.d.ts

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

package/dist/storage.js

@@ -3,10 +3,12 @@ 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 qaseIgnoreRegExp = /^@[Qq]ase[Ii][Gg][Nn][Oo][Rr][Ee]$/g;
 class Storage {
     constructor() {
         /**
@@ -76,17 +78,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)(),
             });
         }
     }
@@ -150,10 +152,11 @@ class Storage {
         if (!pickle) {
             return undefined;
         }
-        let error;
-        if (this.testCaseStartedErrors[tcs.id]?.length) {
-            error = new Error(this.testCaseStartedErrors[tcs.id]?.join('\n\n'));
+        const metadata = this.parseTags(pickle.tags);
+        if (metadata.isIgnore) {
+            return undefined;
         }
+        const error = this.getError(tcs.id);
         let relations = null;
         const nodeId = pickle.astNodeIds[pickle.astNodeIds.length - 1];
         if (nodeId != undefined && this.scenarios[nodeId] != undefined) {
@@ -168,7 +171,6 @@ class Storage {
                 },
             };
         }
-        const metadata = this.parseTags(pickle.tags);
         return {
             attachments: [],
             author: null,
@@ -177,11 +179,11 @@ class Storage {
                 start_time: null,
                 end_time: null,
                 duration: Math.abs(testCase.timestamp.seconds - tcs.timestamp.seconds),
-                stacktrace: error?.stack ?? null,
+                stacktrace: error?.stacktrace ?? null,
                 thread: null,
             },
             fields: metadata.fields,
-            message: null,
+            message: error?.message ?? null,
             muted: false,
             params: {},
             group_params: {},
@@ -226,7 +228,7 @@ class Storage {
                     end_time: null,
                     duration: finished.testStepResult.duration.seconds,
                 },
-                attachments: [],
+                attachments: this.attachments[s.id] ?? [],
                 steps: [],
                 parent_id: null,
             };
@@ -239,6 +241,7 @@ class Storage {
             ids: [],
             fields: {},
             title: null,
+            isIgnore: false,
         };
         for (const tag of tags) {
             if (qaseIdRegExp.test(tag.name)) {
@@ -264,6 +267,9 @@ class Storage {
                     // do nothing
                 }
             }
+            if (qaseIgnoreRegExp.test(tag.name)) {
+                metadata.isIgnore = true;
+            }
         }
         return metadata;
     }
@@ -281,6 +287,42 @@ class Storage {
         }
         return signature;
     }
+    getError(testCaseId) {
+        const testErrors = this.testCaseStartedErrors[testCaseId];
+        if (!testErrors) {
+            return undefined;
+        }
+        const error = new qase_javascript_commons_1.CompoundError();
+        testErrors.forEach((message) => {
+            error.addMessage(message);
+            error.addStacktrace(message);
+        });
+        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;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cucumberjs-qase-reporter",
-  "version": "2.0.1",
+  "version": "2.0.3",
   "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"
   }
 }