cypress-qase-reporter 2.1.1 → 2.2.0-beta.1

package/README.md

@@ -4,7 +4,7 @@ Publish results simple and easy.
 
 ## Installation
 
-To install the latest release version (2.0.x), run:
+To install the latest release version (2.1.x), run:
 
 ```sh
 npm install -D cypress-qase-reporter
@@ -13,7 +13,7 @@ npm install -D cypress-qase-reporter
 <!-- if there's no current beta, comment the next block
 -->
 
-To install the latest beta version (2.1.x), run:
+To install the latest beta version (2.2.x), run:
 
 ```sh
 npm install -D cypress-qase-reporter@beta
@@ -30,7 +30,7 @@ run the following steps:
    - import { qase } from 'cypress-qase-reporter/dist/mocha'
    + import { qase } from 'cypress-qase-reporter/mocha'
    ```                                        
-   
+
 2. Update reporter configuration in `cypress.config.js` and/or environment variables —
    see the [configuration reference](#configuration) below.
 
@@ -68,6 +68,23 @@ run the following steps:
      ...
    ```
 
+## Updating from v2.1 to v2.2
+
+To update an existing test project using Qase reporter from version 2.1 to version 2.2,
+run the following steps:
+
+1. Add a metadata in the `e2e` section of `cypress.config.js`
+
+   ```diff
+     ...
+     e2e: {
+      setupNodeEvents(on, config) { 
+        require('cypress-qase-reporter/plugin')(on, config)
+   +    require('cypress-qase-reporter/metadata')(on)
+       }
+     }
+     ...
+
 ## Getting started
 
 The Cypress reporter can auto-generate test cases
@@ -80,6 +97,16 @@ from Qase.io before executing tests. It's a more reliable way to bind
 autotests to test cases, that persists when you rename, move, or
 parameterize your tests.
 
+### Metadata
+
+- `qase.title` - set the title of the test case
+- `qase.fields` - set the fields of the test case
+- `qase.suite` - set the suite of the test case
+- `qase.comment` - set the comment of the test case
+- `qase.parameters` - set the parameters of the test case
+- `qase.groupParameters` - set the group parameters of the test case
+- `qase.ignore` - ignore the test case in Qase. The test will be executed, but the results will not be sent to Qase.
+
 For example:
 
 ```typescript
@@ -88,6 +115,7 @@ import { qase } from 'cypress-qase-reporter/mocha';
 describe('My First Test', () => {
   qase(1,
     it('Several ids', () => {
+      qase.title('My title');
       expect(true).to.equal(true);
     })
   );
@@ -145,8 +173,6 @@ Example `cypress.config.js` config:
 ```js
 import cypress from 'cypress';
 
-import plugins from './cypress/plugins/index.js';
-
 module.exports = cypress.defineConfig({
   reporter: 'cypress-multi-reporters',
   reporterOptions: {
@@ -180,7 +206,8 @@ module.exports = cypress.defineConfig({
   video: false,
   e2e: {
     setupNodeEvents(on, config) {
-      return plugins(on, config);
+       require('cypress-qase-reporter/plugin')(on, config)
+       require('cypress-qase-reporter/metadata')(on)
     },
   },
 });

package/changelog.md

@@ -1,3 +1,31 @@
+# cypress-qase-reporter@2.2.0-beta.1
+
+## What's new
+
+Added the ability to specify a test metadata in tests:
+
+- `qase.title` - set the test title
+- `qase.fields` - set the test fields
+- `qase.suite` - set the test suite
+- `qase.comment` - set the test comment
+- `qase.parameters` - set the test parameters
+- `qase.groupParameters` - set the test group parameters
+- `qase.ignore` - ignore the test in Qase
+
+```ts
+it('test', () => {
+  qase.title('Title');
+  qase.fields({ field: 'value' });
+  qase.suite('Suite');
+  qase.comment('Comment');
+  qase.parameters({ param: 'value' });
+  qase.groupParameters({ param: 'value' });
+  qase.ignore();
+
+  cy.visit('https://example.com');
+});
+```
+
 # cypress-qase-reporter@2.1.0
 
 ## What's new
@@ -40,8 +68,8 @@ The reporter will wait for all results to be sent to Qase and will not block the
 
 ## What's new
 
-1. Cypress kills the process after the last tests. 
-The reporter will wait for all results to be sent to Qase and will not block the process after sending.
+1. Cypress kills the process after the last tests.
+   The reporter will wait for all results to be sent to Qase and will not block the process after sending.
 
 2. The reporter will collect suites and add them to results.
 
@@ -66,7 +94,7 @@ For more information about the new features and a guide for migration from v1, r
 
 # cypress-qase-reporter@2.0.0-beta.3
 
-Fixed an issue with multiple test runs created when Cypress is running 
+Fixed an issue with multiple test runs created when Cypress is running
 multiple tests in parallel.
 
 # cypress-qase-reporter@2.0.0-beta.2

package/dist/metadata/manager.d.ts

@@ -0,0 +1,14 @@
+import { Metadata } from './models';
+export declare class MetadataManager {
+    static getMetadata(): Metadata | undefined;
+    static setIgnore(): void;
+    static setSuite(suite: string): void;
+    static setComment(comment: string): void;
+    static setTitle(title: string): void;
+    static setFields(fields: Record<string, string>): void;
+    static setParameters(parameters: Record<string, string>): void;
+    static setGroupParams(groupParams: Record<string, string>): void;
+    private static setMetadata;
+    static clear(): void;
+    static isExists(): boolean;
+}

package/dist/metadata/manager.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetadataManager = void 0;
+const fs_1 = require("fs");
+const metadataPath = 'qaseMetadata';
+// eslint-disable-next-line @typescript-eslint/no-extraneous-class
+class MetadataManager {
+    static getMetadata() {
+        if (!this.isExists()) {
+            return undefined;
+        }
+        let metadata = {
+            title: undefined,
+            fields: {},
+            parameters: {},
+            groupParams: {},
+            ignore: false,
+            suite: undefined,
+            comment: undefined,
+        };
+        try {
+            const data = (0, fs_1.readFileSync)(metadataPath, 'utf8');
+            metadata = JSON.parse(data);
+            return metadata;
+        }
+        catch (err) {
+            console.error('Error reading metadata file:', err);
+        }
+        return undefined;
+    }
+    static setIgnore() {
+        const metadata = this.getMetadata() ?? {};
+        metadata.ignore = true;
+        this.setMetadata(metadata);
+    }
+    static setSuite(suite) {
+        const metadata = this.getMetadata() ?? {};
+        metadata.suite = suite;
+        this.setMetadata(metadata);
+    }
+    static setComment(comment) {
+        const metadata = this.getMetadata() ?? {};
+        metadata.comment = comment;
+        this.setMetadata(metadata);
+    }
+    static setTitle(title) {
+        const metadata = this.getMetadata() ?? {};
+        metadata.title = title;
+        this.setMetadata(metadata);
+    }
+    static setFields(fields) {
+        const metadata = this.getMetadata() ?? {};
+        metadata.fields = fields;
+        this.setMetadata(metadata);
+    }
+    static setParameters(parameters) {
+        const metadata = this.getMetadata() ?? {};
+        metadata.parameters = parameters;
+        this.setMetadata(metadata);
+    }
+    static setGroupParams(groupParams) {
+        const metadata = this.getMetadata() ?? {};
+        metadata.groupParams = groupParams;
+        this.setMetadata(metadata);
+    }
+    static setMetadata(metadata) {
+        try {
+            const data = JSON.stringify(metadata);
+            (0, fs_1.writeFileSync)(metadataPath, data);
+        }
+        catch (err) {
+            console.error('Error writing metadata file:', err);
+        }
+    }
+    static clear() {
+        if (!this.isExists()) {
+            return;
+        }
+        try {
+            (0, fs_1.unlinkSync)(metadataPath);
+        }
+        catch (err) {
+            console.error('Error clearing state file:', err);
+        }
+    }
+    static isExists() {
+        return (0, fs_1.existsSync)(metadataPath);
+    }
+}
+exports.MetadataManager = MetadataManager;

package/dist/metadata/models.d.ts

@@ -0,0 +1,9 @@
+export interface Metadata {
+    title?: string | undefined;
+    fields?: Record<string, string>;
+    parameters?: Record<string, string>;
+    groupParams?: Record<string, string>;
+    ignore?: boolean;
+    suite?: string | undefined;
+    comment?: string | undefined;
+}

package/dist/metadata/models.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/metadata.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/metadata.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const manager_1 = require("./metadata/manager");
+module.exports = function (on) {
+    on('task', {
+        qaseTitle(value) {
+            manager_1.MetadataManager.setTitle(value);
+            return null;
+        },
+    });
+    on('task', {
+        qaseFields(value) {
+            manager_1.MetadataManager.setFields(value);
+            return null;
+        },
+    });
+    on('task', {
+        qaseIgnore() {
+            manager_1.MetadataManager.setIgnore();
+            return null;
+        },
+    });
+    on('task', {
+        qaseParameters(value) {
+            manager_1.MetadataManager.setParameters(value);
+            return null;
+        },
+    });
+    on('task', {
+        qaseGroupParameters(value) {
+            manager_1.MetadataManager.setGroupParams(value);
+            return null;
+        },
+    });
+    on('task', {
+        qaseSuite(value) {
+            manager_1.MetadataManager.setSuite(value);
+            return null;
+        },
+    });
+    on('task', {
+        qaseComment(value) {
+            manager_1.MetadataManager.setComment(value);
+            return null;
+        },
+    });
+};

package/dist/mocha.d.ts

@@ -1,3 +1,74 @@
 /// <reference types="cypress" />
 import { Test } from 'mocha';
-export declare const qase: (caseId: number | string | number[] | string[], test: Test) => Test;
+export declare const qase: {
+    (caseId: number | string | number[] | string[], test: Test): Test;
+    /**
+     * Set a title for the test case
+     * @param {string} value
+     * @example
+     * it('test', () => {
+     *    qase.title("Title");
+     *    cy.visit('https://example.com');
+     * });
+     */
+    title(value: string): void;
+    /**
+     * Set fields for the test case
+     * @param {Record<string, string>} values
+     * @example
+     * it('test', () => {
+     *    qase.fields({description: "Description"});
+     *    cy.visit('https://example.com');
+     * });
+     */
+    fields(values: Record<string, string>): void;
+    /**
+     * Ignore the test case result in Qase
+     * @example
+     * it('test', () => {
+     *    qase.ignore();
+     *    cy.visit('https://example.com');
+     * });
+     */
+    ignore(): void;
+    /**
+     * Set parameters for the test case
+     * @param {Record<string, string>} values
+     * @example
+     * it('test', () => {
+     *    qase.parameters({param01: "value01"});
+     *    cy.visit('https://example.com');
+     * });
+     */
+    parameters(values: Record<string, string>): void;
+    /**
+     * Set group parameters for the test case
+     * @param {Record<string, string>} values
+     * @example
+     * it('test', () => {
+     *    qase.groupParameters({param01: "value01"});
+     *    cy.visit('https://example.com');
+     * });
+     */
+    groupParameters(values: Record<string, string>): void;
+    /**
+     * Set a suite for the test case
+     * @param {string} value
+     * @example
+     * it('test', () => {
+     *    qase.suite("Suite 01");
+     *    cy.visit('https://example.com');
+     * });
+     */
+    suite(value: string): void;
+    /**
+     * Set a comment for the test case
+     * @param {string} value
+     * @example
+     * it('test', () => {
+     *    qase.comment("Some comment");
+     *    cy.visit('https://example.com');
+     * });
+     */
+    comment(value: string): void;
+};

package/dist/mocha.js

@@ -7,3 +7,100 @@ const qase = (caseId, test) => {
     return test;
 };
 exports.qase = qase;
+/**
+ * Set a title for the test case
+ * @param {string} value
+ * @example
+ * it('test', () => {
+ *    qase.title("Title");
+ *    cy.visit('https://example.com');
+ * });
+ */
+exports.qase.title = (value) => {
+    cy.task('qaseTitle', value).then(() => {
+        //
+    });
+};
+/**
+ * Set fields for the test case
+ * @param {Record<string, string>} values
+ * @example
+ * it('test', () => {
+ *    qase.fields({description: "Description"});
+ *    cy.visit('https://example.com');
+ * });
+ */
+exports.qase.fields = (values) => {
+    cy.task('qaseFields', values).then(() => {
+        //
+    });
+};
+/**
+ * Ignore the test case result in Qase
+ * @example
+ * it('test', () => {
+ *    qase.ignore();
+ *    cy.visit('https://example.com');
+ * });
+ */
+exports.qase.ignore = () => {
+    cy.task('qaseIgnore').then(() => {
+        //
+    });
+};
+/**
+ * Set parameters for the test case
+ * @param {Record<string, string>} values
+ * @example
+ * it('test', () => {
+ *    qase.parameters({param01: "value01"});
+ *    cy.visit('https://example.com');
+ * });
+ */
+exports.qase.parameters = (values) => {
+    cy.task('qaseParameters', values).then(() => {
+        //
+    });
+};
+/**
+ * Set group parameters for the test case
+ * @param {Record<string, string>} values
+ * @example
+ * it('test', () => {
+ *    qase.groupParameters({param01: "value01"});
+ *    cy.visit('https://example.com');
+ * });
+ */
+exports.qase.groupParameters = (values) => {
+    cy.task('qaseGroupParameters', values).then(() => {
+        //
+    });
+};
+/**
+ * Set a suite for the test case
+ * @param {string} value
+ * @example
+ * it('test', () => {
+ *    qase.suite("Suite 01");
+ *    cy.visit('https://example.com');
+ * });
+ */
+exports.qase.suite = (value) => {
+    cy.task('qaseSuite', value).then(() => {
+        //
+    });
+};
+/**
+ * Set a comment for the test case
+ * @param {string} value
+ * @example
+ * it('test', () => {
+ *    qase.comment("Some comment");
+ *    cy.visit('https://example.com');
+ * });
+ */
+exports.qase.comment = (value) => {
+    cy.task('qaseComment', value).then(() => {
+        //
+    });
+};

package/dist/reporter.js

@@ -11,6 +11,7 @@ const mocha_1 = require("mocha");
 const qase_javascript_commons_1 = require("qase-javascript-commons");
 const traverse_dir_1 = require("./utils/traverse-dir");
 const configSchema_1 = require("./configSchema");
+const manager_1 = require("./metadata/manager");
 const { EVENT_TEST_FAIL, EVENT_TEST_PASS, EVENT_TEST_PENDING, EVENT_RUN_END, } = mocha_1.Runner.constants;
 /**
  * @class CypressQaseReporter
@@ -97,6 +98,11 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
      * @private
      */
     addTestResult(test) {
+        const metadata = manager_1.MetadataManager.getMetadata();
+        if (metadata?.ignore) {
+            manager_1.MetadataManager.clear();
+            return;
+        }
         const ids = CypressQaseReporter.getCaseId(test.title);
         const attachments = this.screenshotsFolder
             ? CypressQaseReporter.findAttachments(ids, this.screenshotsFolder)
@@ -116,14 +122,36 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
                 },
             };
         }
+        if (metadata?.suite) {
+            relations = {
+                suite: {
+                    data: [
+                        {
+                            title: metadata.suite,
+                            public_id: null,
+                        },
+                    ],
+                },
+            };
+        }
+        let message = null;
+        if (metadata?.comment) {
+            message = metadata.comment;
+        }
+        if (test.err?.message) {
+            if (message) {
+                message += '\n\n';
+            }
+            message += test.err.message;
+        }
         const result = {
             attachments: attachments ?? [],
             author: null,
-            fields: {},
-            message: test.err?.message ?? null,
+            fields: metadata?.fields ?? {},
+            message: message,
             muted: false,
-            params: {},
-            group_params: {},
+            params: metadata?.parameters ?? {},
+            group_params: metadata?.groupParams ?? {},
             relations: relations,
             run_id: null,
             signature: this.getSignature(test, ids),
@@ -140,9 +168,10 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
                 thread: null,
             },
             testops_id: ids.length > 0 ? ids : null,
-            title: test.title,
+            title: metadata?.title ?? test.title,
         };
         void this.reporter.addTestResult(result);
+        manager_1.MetadataManager.clear();
     }
     /**
      * @param {Test} test

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-qase-reporter",
-  "version": "2.1.1",
+  "version": "2.2.0-beta.1",
   "description": "Qase Cypress Reporter",
   "homepage": "https://github.com/qase-tms/qase-javascript",
   "sideEffects": false,
@@ -12,6 +12,7 @@
     "./reporter": "./dist/reporter.js",
     "./package.json": "./package.json",
     "./plugin": "./dist/plugin.js",
+    "./metadata": "./dist/metadata.js",
     "./hooks": "./dist/hooks.js"
   },
   "typesVersions": {