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

package/README.md

@@ -106,6 +106,7 @@ parameterize your tests.
 - `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.
+- `qase.step` - create a step in the test case
 
 For example:
 
@@ -206,8 +207,8 @@ module.exports = cypress.defineConfig({
   video: false,
   e2e: {
     setupNodeEvents(on, config) {
-       require('cypress-qase-reporter/plugin')(on, config)
-       require('cypress-qase-reporter/metadata')(on)
+      require('cypress-qase-reporter/plugin')(on, config)
+      require('cypress-qase-reporter/metadata')(on)
     },
   },
 });

package/changelog.md

@@ -1,3 +1,19 @@
+# cypress-qase-reporter@2.2.0-beta.2
+
+## What's new
+
+Added the ability to add steps in tests:
+
+- `qase.step` - add a step to the test
+
+```ts
+it('test', () => {
+  qase.step('Step 1', () => {
+    cy.visit('https://example.com');
+  });
+});
+```
+
 # cypress-qase-reporter@2.2.0-beta.1
 
 ## What's new

package/dist/metadata/manager.d.ts

@@ -2,6 +2,8 @@ import { Metadata } from './models';
 export declare class MetadataManager {
     static getMetadata(): Metadata | undefined;
     static setIgnore(): void;
+    static addStepStart(name: string): void;
+    static addStepEnd(status: string): void;
     static setSuite(suite: string): void;
     static setComment(comment: string): void;
     static setTitle(title: string): void;

package/dist/metadata/manager.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MetadataManager = void 0;
 const fs_1 = require("fs");
+const uuid_1 = require("uuid");
 const metadataPath = 'qaseMetadata';
 // eslint-disable-next-line @typescript-eslint/no-extraneous-class
 class MetadataManager {
@@ -17,6 +18,9 @@ class MetadataManager {
             ignore: false,
             suite: undefined,
             comment: undefined,
+            steps: [],
+            currentStepId: undefined,
+            firstStepName: undefined,
         };
         try {
             const data = (0, fs_1.readFileSync)(metadataPath, 'utf8');
@@ -33,6 +37,33 @@ class MetadataManager {
         metadata.ignore = true;
         this.setMetadata(metadata);
     }
+    static addStepStart(name) {
+        const metadata = this.getMetadata() ?? {};
+        if (metadata.firstStepName === name) {
+            return;
+        }
+        if (!metadata.steps) {
+            metadata.steps = [];
+        }
+        const id = (0, uuid_1.v4)();
+        const parentId = metadata.currentStepId ?? undefined;
+        metadata.steps.push({ timestamp: Date.now(), name, id: id, parentId: parentId });
+        metadata.currentStepId = id;
+        if (!metadata.firstStepName) {
+            metadata.firstStepName = name;
+        }
+        this.setMetadata(metadata);
+    }
+    static addStepEnd(status) {
+        const metadata = this.getMetadata() ?? {};
+        if (!metadata.steps || !metadata.currentStepId) {
+            return;
+        }
+        const parentId = metadata.steps.reverse().find((step) => step.id === metadata.currentStepId)?.parentId;
+        metadata.steps.push({ timestamp: Date.now(), status, id: metadata.currentStepId });
+        metadata.currentStepId = parentId;
+        this.setMetadata(metadata);
+    }
     static setSuite(suite) {
         const metadata = this.getMetadata() ?? {};
         metadata.suite = suite;

package/dist/metadata/models.d.ts

@@ -6,4 +6,18 @@ export interface Metadata {
     ignore?: boolean;
     suite?: string | undefined;
     comment?: string | undefined;
+    steps?: (StepStart | StepEnd)[];
+    currentStepId?: string | undefined;
+    firstStepName?: string | undefined;
+}
+export interface StepStart {
+    id: string;
+    timestamp: number;
+    name: string;
+    parentId: string | undefined;
+}
+export interface StepEnd {
+    id: string;
+    timestamp: number;
+    status: string;
 }

package/dist/metadata.js

@@ -44,4 +44,16 @@ module.exports = function (on) {
             return null;
         },
     });
+    on('task', {
+        qaseStepStart(value) {
+            manager_1.MetadataManager.addStepStart(value);
+            return null;
+        },
+    });
+    on('task', {
+        qaseStepEnd(value) {
+            manager_1.MetadataManager.addStepEnd(value);
+            return null;
+        },
+    });
 };

package/dist/mocha.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="cypress" />
+/// <reference types="cypress" />
+/// <reference types="cypress" />
+/// <reference types="cypress" />
 import { Test } from 'mocha';
 export declare const qase: {
     (caseId: number | string | number[] | string[], test: Test): Test;
@@ -71,4 +74,17 @@ export declare const qase: {
      * });
      */
     comment(value: string): void;
+    /**
+     * Add a step to  the test case
+     * @param {string} name
+     * @param {() => T | PromiseLike<T>} body
+     * @example
+     * it('test', () => {
+     *    qase.step("Some step", () => {
+     *      // some actions
+     *    });
+     *    cy.visit('https://example.com');
+     * });
+     */
+    step<T = void>(name: string, body: () => T | PromiseLike<T>): Cypress.Chainable<JQuery<void>>;
 };

package/dist/mocha.js

@@ -104,3 +104,24 @@ exports.qase.comment = (value) => {
         //
     });
 };
+/**
+ * Add a step to  the test case
+ * @param {string} name
+ * @param {() => T | PromiseLike<T>} body
+ * @example
+ * it('test', () => {
+ *    qase.step("Some step", () => {
+ *      // some actions
+ *    });
+ *    cy.visit('https://example.com');
+ * });
+ */
+exports.qase.step = (name, body) => {
+    return cy.task('qaseStepStart', name).then(() => {
+        return Cypress.Promise.resolve(body());
+    }).then(() => {
+        cy.task('qaseStepEnd', 'passed').then(() => {
+            //
+        });
+    });
+};

package/dist/reporter.d.ts

@@ -70,5 +70,6 @@ export declare class CypressQaseReporter extends reporters.Base {
      * @private
      */
     private getFile;
+    private getSteps;
 }
 export {};

package/dist/reporter.js

@@ -155,7 +155,7 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
             relations: relations,
             run_id: null,
             signature: this.getSignature(test, ids),
-            steps: [],
+            steps: metadata?.steps ? this.getSteps(metadata.steps) : [],
             id: (0, uuid_1.v4)(),
             execution: {
                 status: test.state
@@ -208,6 +208,43 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
         }
         return undefined;
     }
+    getSteps(steps) {
+        const result = [];
+        const stepMap = new Map();
+        for (const step of steps.sort((a, b) => a.timestamp - b.timestamp)) {
+            if (!('status' in step)) {
+                const newStep = new qase_javascript_commons_1.TestStepType();
+                newStep.id = step.id;
+                newStep.execution.status = qase_javascript_commons_1.StepStatusEnum.failed;
+                newStep.execution.start_time = step.timestamp;
+                newStep.execution.end_time = Date.now();
+                newStep.data = {
+                    action: step.name,
+                    expected_result: null,
+                };
+                const parentId = step.parentId;
+                if (parentId) {
+                    newStep.parent_id = parentId;
+                    const parent = stepMap.get(parentId);
+                    if (parent) {
+                        parent.steps.push(newStep);
+                    }
+                }
+                else {
+                    result.push(newStep);
+                }
+                stepMap.set(step.id, newStep);
+            }
+            else {
+                const stepType = stepMap.get(step.id);
+                if (stepType) {
+                    stepType.execution.status = step.status;
+                    stepType.execution.end_time = step.timestamp;
+                }
+            }
+        }
+        return result;
+    }
 }
 exports.CypressQaseReporter = CypressQaseReporter;
 /**

package/package.json

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