cypress-qase-reporter 2.2.0-beta.2 → 2.2.0

package/README.md

@@ -4,21 +4,12 @@ Publish results simple and easy.
 
 ## Installation
 
-To install the latest release version (2.1.x), run:
+To install the latest release version (2.2.x), run:
 
 ```sh
 npm install -D cypress-qase-reporter
 ```
 
-<!-- if there's no current beta, comment the next block
--->
-
-To install the latest beta version (2.2.x), run:
-
-```sh
-npm install -D cypress-qase-reporter@beta
-```
-
 ## Updating from v1 to v2.1
 
 To update an existing test project using Qase reporter from version 1 to version 2.1,

package/changelog.md

@@ -1,3 +1,27 @@
+# cypress-qase-reporter@2.2.0
+
+## What's new
+
+Minor release of the Cypress reporter package
+
+# cypress-qase-reporter@2.2.0-beta.3
+
+## What's new
+
+Added the ability to add attachments to tests or steps:
+
+- `qase.attach` - add an attachment to test or step
+
+```ts
+it('test', () => {
+  qase.attach({ paths: '/path/to/file' });
+  qase.step('Step 1', () => {
+    cy.visit('https://example.com');
+    qase.attach({ name: 'attachment.txt', content: 'Hello, world!', contentType: 'text/plain' });
+  });
+});
+```
+
 # cypress-qase-reporter@2.2.0-beta.2
 
 ## What's new

package/dist/metadata/manager.d.ts

@@ -1,9 +1,11 @@
-import { Metadata } from './models';
+import { Attach, Metadata } from './models';
+import { Attachment } from 'qase-javascript-commons';
 export declare class MetadataManager {
     static getMetadata(): Metadata | undefined;
     static setIgnore(): void;
     static addStepStart(name: string): void;
     static addStepEnd(status: string): void;
+    static addAttach(attach: Attach): void;
     static setSuite(suite: string): void;
     static setComment(comment: string): void;
     static setTitle(title: string): void;
@@ -13,4 +15,5 @@ export declare class MetadataManager {
     private static setMetadata;
     static clear(): void;
     static isExists(): boolean;
+    static prepareAttach(attach: Attach): Attachment[];
 }

package/dist/metadata/manager.js

@@ -1,8 +1,13 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MetadataManager = void 0;
 const fs_1 = require("fs");
 const uuid_1 = require("uuid");
+const path_1 = __importDefault(require("path"));
+const qase_javascript_commons_1 = require("qase-javascript-commons");
 const metadataPath = 'qaseMetadata';
 // eslint-disable-next-line @typescript-eslint/no-extraneous-class
 class MetadataManager {
@@ -21,6 +26,8 @@ class MetadataManager {
             steps: [],
             currentStepId: undefined,
             firstStepName: undefined,
+            attachments: [],
+            stepAttachments: {},
         };
         try {
             const data = (0, fs_1.readFileSync)(metadataPath, 'utf8');
@@ -64,6 +71,28 @@ class MetadataManager {
         metadata.currentStepId = parentId;
         this.setMetadata(metadata);
     }
+    static addAttach(attach) {
+        const metadata = this.getMetadata() ?? {};
+        if (!metadata.attachments) {
+            metadata.attachments = [];
+        }
+        if (!metadata.stepAttachments) {
+            metadata.stepAttachments = {};
+        }
+        const attachments = this.prepareAttach(attach);
+        if (metadata.currentStepId) {
+            if (metadata.stepAttachments[metadata.currentStepId] === undefined) {
+                metadata.stepAttachments[metadata.currentStepId] = attachments;
+            }
+            else {
+                metadata.stepAttachments[metadata.currentStepId]?.push(...attachments);
+            }
+        }
+        else {
+            metadata.attachments.push(...attachments);
+        }
+        this.setMetadata(metadata);
+    }
     static setSuite(suite) {
         const metadata = this.getMetadata() ?? {};
         metadata.suite = suite;
@@ -117,5 +146,47 @@ class MetadataManager {
     static isExists() {
         return (0, fs_1.existsSync)(metadataPath);
     }
+    static prepareAttach(attach) {
+        const attachments = [];
+        if (attach.paths) {
+            if (Array.isArray(attach.paths)) {
+                attach.paths.forEach((file) => {
+                    const attachmentName = path_1.default.basename(file);
+                    const contentType = (0, qase_javascript_commons_1.getMimeTypes)(file);
+                    attachments.push({
+                        file_name: attachmentName,
+                        mime_type: contentType,
+                        file_path: file,
+                        content: '',
+                        size: 0,
+                        id: (0, uuid_1.v4)(),
+                    });
+                });
+            }
+            else {
+                const attachmentName = path_1.default.basename(attach.paths);
+                const contentType = (0, qase_javascript_commons_1.getMimeTypes)(attach.paths);
+                attachments.push({
+                    file_name: attachmentName,
+                    mime_type: contentType,
+                    file_path: attach.paths,
+                    content: '',
+                    size: 0,
+                    id: (0, uuid_1.v4)(),
+                });
+            }
+        }
+        else if (attach.content) {
+            attachments.push({
+                file_name: attach.name ?? 'attachment',
+                mime_type: attach.contentType ?? 'application/octet-stream',
+                file_path: null,
+                content: attach.content,
+                size: 0,
+                id: (0, uuid_1.v4)(),
+            });
+        }
+        return attachments;
+    }
 }
 exports.MetadataManager = MetadataManager;

package/dist/metadata/models.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="node" />
+import { Attachment } from 'qase-javascript-commons';
 export interface Metadata {
     title?: string | undefined;
     fields?: Record<string, string>;
@@ -9,6 +11,8 @@ export interface Metadata {
     steps?: (StepStart | StepEnd)[];
     currentStepId?: string | undefined;
     firstStepName?: string | undefined;
+    attachments?: Attachment[];
+    stepAttachments?: Record<string, Attachment[]>;
 }
 export interface StepStart {
     id: string;
@@ -21,3 +25,9 @@ export interface StepEnd {
     timestamp: number;
     status: string;
 }
+export interface Attach {
+    name?: string;
+    paths?: string | string[];
+    content?: Buffer | string;
+    contentType?: string;
+}

package/dist/metadata.js

@@ -56,4 +56,10 @@ module.exports = function (on) {
             return null;
         },
     });
+    on('task', {
+        qaseAttach(value) {
+            manager_1.MetadataManager.addAttach(value);
+            return null;
+        },
+    });
 };

package/dist/mocha.d.ts

@@ -2,6 +2,7 @@
 /// <reference types="cypress" />
 /// <reference types="cypress" />
 /// <reference types="cypress" />
+/// <reference types="node" />
 import { Test } from 'mocha';
 export declare const qase: {
     (caseId: number | string | number[] | string[], test: Test): Test;
@@ -14,7 +15,7 @@ export declare const qase: {
      *    cy.visit('https://example.com');
      * });
      */
-    title(value: string): void;
+    title(value: string): Cypress.Chainable<JQuery<void>>;
     /**
      * Set fields for the test case
      * @param {Record<string, string>} values
@@ -24,7 +25,7 @@ export declare const qase: {
      *    cy.visit('https://example.com');
      * });
      */
-    fields(values: Record<string, string>): void;
+    fields(values: Record<string, string>): Cypress.Chainable<JQuery<void>>;
     /**
      * Ignore the test case result in Qase
      * @example
@@ -33,7 +34,7 @@ export declare const qase: {
      *    cy.visit('https://example.com');
      * });
      */
-    ignore(): void;
+    ignore(): Cypress.Chainable<JQuery<void>>;
     /**
      * Set parameters for the test case
      * @param {Record<string, string>} values
@@ -43,7 +44,7 @@ export declare const qase: {
      *    cy.visit('https://example.com');
      * });
      */
-    parameters(values: Record<string, string>): void;
+    parameters(values: Record<string, string>): Cypress.Chainable<JQuery<void>>;
     /**
      * Set group parameters for the test case
      * @param {Record<string, string>} values
@@ -53,7 +54,7 @@ export declare const qase: {
      *    cy.visit('https://example.com');
      * });
      */
-    groupParameters(values: Record<string, string>): void;
+    groupParameters(values: Record<string, string>): Cypress.Chainable<JQuery<void>>;
     /**
      * Set a suite for the test case
      * @param {string} value
@@ -63,7 +64,7 @@ export declare const qase: {
      *    cy.visit('https://example.com');
      * });
      */
-    suite(value: string): void;
+    suite(value: string): Cypress.Chainable<JQuery<void>>;
     /**
      * Set a comment for the test case
      * @param {string} value
@@ -73,7 +74,7 @@ export declare const qase: {
      *    cy.visit('https://example.com');
      * });
      */
-    comment(value: string): void;
+    comment(value: string): Cypress.Chainable<JQuery<void>>;
     /**
      * Add a step to  the test case
      * @param {string} name
@@ -87,4 +88,21 @@ export declare const qase: {
      * });
      */
     step<T = void>(name: string, body: () => T | PromiseLike<T>): Cypress.Chainable<JQuery<void>>;
+    /**
+     * Attach a file to the test case or the step
+     * @param attach
+     * @example
+     * it('test', () => {
+     *   qase.attach({ name: 'attachment.txt', content: 'Hello, world!', contentType: 'text/plain' });
+     *   qase.attach({ paths: '/path/to/file'});
+     *   qase.attach({ paths: ['/path/to/file', '/path/to/another/file']});
+     *   cy.visit('https://example.com');
+     *  });
+     */
+    attach(attach: {
+        name?: string;
+        paths?: string | string[];
+        content?: Buffer | string;
+        contentType?: string;
+    }): Cypress.Chainable<JQuery<void>>;
 };

package/dist/mocha.js

@@ -17,7 +17,7 @@ exports.qase = qase;
  * });
  */
 exports.qase.title = (value) => {
-    cy.task('qaseTitle', value).then(() => {
+    return cy.task('qaseTitle', value).then(() => {
         //
     });
 };
@@ -31,7 +31,7 @@ exports.qase.title = (value) => {
  * });
  */
 exports.qase.fields = (values) => {
-    cy.task('qaseFields', values).then(() => {
+    return cy.task('qaseFields', values).then(() => {
         //
     });
 };
@@ -44,7 +44,7 @@ exports.qase.fields = (values) => {
  * });
  */
 exports.qase.ignore = () => {
-    cy.task('qaseIgnore').then(() => {
+    return cy.task('qaseIgnore').then(() => {
         //
     });
 };
@@ -58,7 +58,7 @@ exports.qase.ignore = () => {
  * });
  */
 exports.qase.parameters = (values) => {
-    cy.task('qaseParameters', values).then(() => {
+    return cy.task('qaseParameters', values).then(() => {
         //
     });
 };
@@ -72,7 +72,7 @@ exports.qase.parameters = (values) => {
  * });
  */
 exports.qase.groupParameters = (values) => {
-    cy.task('qaseGroupParameters', values).then(() => {
+    return cy.task('qaseGroupParameters', values).then(() => {
         //
     });
 };
@@ -86,7 +86,7 @@ exports.qase.groupParameters = (values) => {
  * });
  */
 exports.qase.suite = (value) => {
-    cy.task('qaseSuite', value).then(() => {
+    return cy.task('qaseSuite', value).then(() => {
         //
     });
 };
@@ -100,7 +100,7 @@ exports.qase.suite = (value) => {
  * });
  */
 exports.qase.comment = (value) => {
-    cy.task('qaseComment', value).then(() => {
+    return cy.task('qaseComment', value).then(() => {
         //
     });
 };
@@ -125,3 +125,19 @@ exports.qase.step = (name, body) => {
         });
     });
 };
+/**
+ * Attach a file to the test case or the step
+ * @param attach
+ * @example
+ * it('test', () => {
+ *   qase.attach({ name: 'attachment.txt', content: 'Hello, world!', contentType: 'text/plain' });
+ *   qase.attach({ paths: '/path/to/file'});
+ *   qase.attach({ paths: ['/path/to/file', '/path/to/another/file']});
+ *   cy.visit('https://example.com');
+ *  });
+ */
+exports.qase.attach = (attach) => {
+    return cy.task('qaseAttach', attach).then(() => {
+        //
+    });
+};

package/dist/reporter.js

@@ -107,6 +107,7 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
         const attachments = this.screenshotsFolder
             ? CypressQaseReporter.findAttachments(ids, this.screenshotsFolder)
             : undefined;
+        attachments?.push(...(metadata?.attachments ?? []));
         let relations = {};
         if (test.parent !== undefined) {
             const data = [];
@@ -155,7 +156,7 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
             relations: relations,
             run_id: null,
             signature: this.getSignature(test, ids),
-            steps: metadata?.steps ? this.getSteps(metadata.steps) : [],
+            steps: metadata?.steps ? this.getSteps(metadata.steps, metadata.stepAttachments ?? {}) : [],
             id: (0, uuid_1.v4)(),
             execution: {
                 status: test.state
@@ -208,7 +209,7 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
         }
         return undefined;
     }
-    getSteps(steps) {
+    getSteps(steps, attachments) {
         const result = [];
         const stepMap = new Map();
         for (const step of steps.sort((a, b) => a.timestamp - b.timestamp)) {
@@ -222,6 +223,9 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
                     action: step.name,
                     expected_result: null,
                 };
+                if (attachments[step.id]) {
+                    newStep.attachments = attachments[step.id] ?? [];
+                }
                 const parentId = step.parentId;
                 if (parentId) {
                     newStep.parent_id = parentId;

package/docs/usage.md

@@ -0,0 +1,196 @@
+# Qase Integration in Cypress
+
+This guide demonstrates how to integrate Qase with Cypress, providing instructions on how to add Qase IDs, titles,
+fields, suites, comments, and file attachments to your test cases.
+
+---
+
+## Adding QaseID to a Test
+
+To associate a QaseID with a test in Cypress, use the `qase` function. This function accepts a single integer
+representing the test's ID in Qase.
+
+### Example:
+
+```javascript
+import { qase } from 'cypress-qase-reporter/mocha';
+
+qase(1, it('simple test', () => {
+  cy.visit('https://example.com');
+}));
+```
+
+---
+
+## Adding a Title to a Test
+
+You can provide a title for your test using the `qase.title` function. The function accepts a string, which will be
+used as the test's title in Qase. If no title is provided, the test method name will be used by default.
+
+### Example:
+
+```javascript
+import { qase } from 'cypress-qase-reporter/mocha';
+
+it('test', () => {
+  qase.title('Title');
+  cy.visit('https://example.com');
+});
+```
+
+---
+
+## Adding Fields to a Test
+
+The `qase.fields` function allows you to add additional metadata to a test case. You can specify multiple fields to
+enhance test case information in Qase.
+
+### System Fields:
+
+- `description` — Description of the test case.
+- `preconditions` — Preconditions for the test case.
+- `postconditions` — Postconditions for the test case.
+- `severity` — Severity of the test case (e.g., `critical`, `major`).
+- `priority` — Priority of the test case (e.g., `high`, `low`).
+- `layer` — Test layer (e.g., `UI`, `API`).
+
+### Example:
+
+```javascript
+import { qase } from 'cypress-qase-reporter/mocha';
+
+it('test', () => {
+  qase.fields({ description: "Description", preconditions: "Preconditions" });
+  cy.visit('https://example.com');
+});
+```
+
+---
+
+## Adding a Suite to a Test
+
+To assign a suite or sub-suite to a test, use the `qase.suite` function. It can receive a suite name, and optionally a
+sub-suite, both as strings.
+
+### Example:
+
+```javascript
+import { qase } from 'cypress-qase-reporter/mocha';
+
+it('test', () => {
+  qase.suite("Suite 01");
+  cy.visit('https://example.com');
+});
+
+it('test', () => {
+  qase.suite("Suite 01\tSuite 02");
+  cy.visit('https://example.com');
+});
+```
+
+---
+
+## Ignoring a Test in Qase
+
+To exclude a test from being reported to Qase (while still executing the test in Cypress), use the `qase.ignore`
+function. The test will run, but its result will not be sent to Qase.
+
+### Example:
+
+```javascript
+import { qase } from 'cypress-qase-reporter/mocha';
+
+it('test', () => {
+  qase.ignore();
+  cy.visit('https://example.com');
+});
+```
+
+---
+
+## Adding a Comment to a Test
+
+You can attach comments to the test results in Qase using the `qase.comment` function. The comment will be displayed
+alongside the test execution details in Qase.
+
+### Example:
+
+```javascript
+import { qase } from 'cypress-qase-reporter/mocha';
+
+it('test', () => {
+  qase.comment("Some comment");
+  cy.visit('https://example.com');
+});
+```
+
+---
+
+## Attaching Files to a Test
+
+To attach files to a test result, use the `qase.attach` function. This method supports attaching one or multiple files,
+along with optional file names, comments, and file types.
+
+### Example:
+
+```javascript
+import { qase } from 'cypress-qase-reporter/mocha';
+
+it('test', () => {
+  qase.attach({ name: 'attachment.txt', content: 'Hello, world!', contentType: 'text/plain' });
+  qase.attach({ paths: '/path/to/file' });
+  qase.attach({ paths: ['/path/to/file', '/path/to/another/file'] });
+  cy.visit('https://example.com');
+});
+```
+
+## Adding Parameters to a Test
+
+You can add parameters to a test case using the `qase.parameters` function. This function accepts an object with
+parameter names and values.
+
+### Example:
+
+```javascript
+import { qase } from 'cypress-qase-reporter/mocha';
+
+it('test', () => {
+  qase.parameters({ param1: 'value1', param2: 'value2' });
+  cy.visit('https://example.com');
+});
+```
+
+## Adding Group Parameters to a Test
+
+To add group parameters to a test case, use the `qase.groupParameters` function. This function accepts an list with
+group parameter names.
+
+### Example:
+
+```javascript
+import { qase } from 'cypress-qase-reporter/mocha';
+
+it('test', () => {
+  qase.parameters({ param1: 'value1', param2: 'value2' });
+  qase.groupParameters(['param1']);
+  cy.visit('https://example.com');
+});
+```
+
+## Adding Steps to a Test
+
+You can add steps to a test case using the `qase.step` function. This function accepts a string, which will be used as
+the step description in Qase.
+
+### Example:
+
+```javascript
+import { qase } from 'cypress-qase-reporter/mocha';
+
+it('test', () => {
+  qase.step('Some step', () => {
+    // some actions
+  });
+  cy.visit('https://example.com');
+});
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-qase-reporter",
-  "version": "2.2.0-beta.2",
+  "version": "2.2.0",
   "description": "Qase Cypress Reporter",
   "homepage": "https://github.com/qase-tms/qase-javascript",
   "sideEffects": false,