[25 issue] Add suite, parentSuite and subSuite interface (#26)

Author: mmisty

docs/interface.md

@@ -41,6 +41,58 @@ Adds finished step with passed status.
 cy.allure().step('should login');
 ```
 
+### suite
+**suite(name?: string)**
+
+In most cases when you use `describe` plugin will automatically create correct 
+structure of suites (Suite tab in report), but in some cases you may want to override that 
+(or add when no describes are being used)
+
+Adds suite to test (or overrides automatic name)
+When name is `undefined` it will remove automatic label from test.
+
+```javascript
+cy.allure().suite('Suite name');
+```
+
+```javascript
+cy.allure().suite();
+```
+
+### parentSuite
+**parentSuite(name?: string)**
+
+In most cases when you use `describe` plugin will automatically create correct
+structure of suites (Suite tab in report), but in some cases you may want to override that
+(or add when no describes are being used)
+
+Adds parent suite to test (or overrides automatic name)
+
+```javascript
+cy.allure().parentSuite('Suite name');
+```
+
+```javascript
+cy.allure().parentSuite();
+```
+
+### subSuite
+**subSuite(name?: string)**
+
+In most cases when you use `describe` plugin will automatically create correct
+structure of suites (Suite tab in report), but in some cases you may want to override that
+(or add when no describes are being used)
+
+Adds sub suite to test (or overrides automatic name)
+
+```javascript
+cy.allure().subSuite('Suite name');
+```
+
+```javascript
+cy.allure().subSuite();
+```
+
 ### tag
 **tag(...tags: string[])**
 

package-lock.json

@@ -73,8 +73,8 @@
     "@types/ws": "^8.5.5",
     "@typescript-eslint/eslint-plugin": "^5.44.0",
     "@typescript-eslint/parser": "^5.44.0",
-    "allure-commandline": "^2.23.1",
-    "cypress": "^13.0.0",
+    "allure-commandline": "^2.24.0",
+    "cypress": "^13.1.0",
     "cypress-redirect-browser-log": "^1.1.2",
     "eslint": "^8.46.0",
     "eslint-config-prettier": "^8.5.0",
@@ -98,12 +98,12 @@
     "webpack": "^5.88.2"
   },
   "dependencies": {
-    "allure-js-commons": "^2.6.0",
+    "allure-js-commons": "^2.7.0",
     "allure-js-parser": "^0.0.7",
     "debug": "^4.3.4",
     "fast-glob": "^3.3.1",
     "uuid": "^9.0.0",
     "uuid-by-string": "^4.0.0",
-    "ws": "^8.13.0"
+    "ws": "^8.14.0"
   }
 }

package.json

@@ -33,6 +33,9 @@ export const registerCommands = () => {
     tms: (allure, value, name) => allure.tms(value, name),
     issue: (allure, value, name) => allure.issue(value, name),
     story: (allure, value) => allure.story(value),
+    suite: (allure, name) => allure.suite(name),
+    subSuite: (allure, name) => allure.subSuite(name),
+    parentSuite: (allure, name) => allure.parentSuite(name),
     thread: (allure, value) => allure.thread(value),
     allureId: (allure, value) => allure.allureId(value),
     // testID: (allure, id) => allure.label('AS_ID', id),

src/commands/index.ts

@@ -142,6 +142,30 @@ declare namespace Cypress {
      */
     severity(level: Severity): T;
 
+    /**
+     * Adds (or replaces automatic) suite for test
+     * @param name suite name, when undefined will not use suite
+     * @example
+     * cy.allure().suite('test suite');
+     */
+    suite(name?: string): T;
+
+    /**
+     * Adds (or replaces automatic) parent Suite for test
+     * @param name parent suite name, when undefined will not use parent suite
+     * @example
+     * cy.allure().parentSuite('test parent suite');
+     */
+    parentSuite(name?: string): T;
+
+    /**
+     * Adds (or replaces automatic) sub Suite for test
+     * @param name sub suite name, when undefined will not use sub suite
+     * @example
+     * cy.allure().subSuite('test sub suite');
+     */
+    subSuite(name?: string): T;
+
     /**
      * Adds thread to test
      * @param value string to group in timeline

src/cypress/types.ts

@@ -51,6 +51,7 @@ export class AllureReporter {
   groups: AllureGroup[] = [];
   tests: AllureTest[] = [];
   steps: AllureStep[] = [];
+  labels: { name: string; value: string }[] = [];
   globalHooks = new GlobalHooks(this);
 
   // this is variable for global hooks only
@@ -502,6 +503,37 @@ export class AllureReporter {
     }
   }
 
+  private addGroupLabelByUser(label: string, value?: string) {
+    if (value === undefined) {
+      // remove suite labels
+      this.labels = this.labels.filter(t => t.name !== label);
+    } else {
+      this.labels.push({ name: label, value: value });
+    }
+  }
+
+  suite(arg: AllureTaskArgs<'suite'>) {
+    if (!this.currentTest) {
+      return;
+    }
+    this.addGroupLabelByUser(LabelName.SUITE, arg.name);
+  }
+
+  parentSuite(arg: AllureTaskArgs<'parentSuite'>) {
+    if (!this.currentTest) {
+      return;
+    }
+
+    this.addGroupLabelByUser(LabelName.PARENT_SUITE, arg.name);
+  }
+
+  subSuite(arg: AllureTaskArgs<'subSuite'>) {
+    if (!this.currentTest) {
+      return;
+    }
+    this.addGroupLabelByUser(LabelName.SUB_SUITE, arg.name);
+  }
+
   testParameter(arg: AllureTaskArgs<'parameter'>) {
     if (this.currentTest) {
       this.currentTest.addParameter(arg.name, arg.value);
@@ -524,7 +556,7 @@ export class AllureReporter {
     this.executableAttachment(this.currentExecutable, arg);
   }
 
-  applyGroupLabels() {
+  addGroupLabels() {
     const [parentSuite, suite, subSuite] = this.groups;
 
     if (this.currentSpec) {
@@ -533,15 +565,15 @@ export class AllureReporter {
     }
 
     if (this.groups.length > 0) {
-      this.currentTest?.addLabel(LabelName.PARENT_SUITE, parentSuite.name);
+      this.labels.push({ name: LabelName.PARENT_SUITE, value: parentSuite.name });
     }
 
     if (this.groups.length > 1) {
-      this.currentTest?.addLabel(LabelName.SUITE, suite.name);
+      this.labels.push({ name: LabelName.SUITE, value: suite.name });
     }
 
     if (this.groups.length > 2) {
-      this.currentTest?.addLabel(LabelName.SUB_SUITE, subSuite.name);
+      this.labels.push({ name: LabelName.SUB_SUITE, value: subSuite.name });
     }
   }
 
@@ -579,7 +611,7 @@ export class AllureReporter {
     test.fullName = fullTitle;
 
     test.historyId = getUuid(fullTitle);
-    this.applyGroupLabels();
+    this.addGroupLabels();
 
     if (this.currentSpec?.relative) {
       test.addLabel('path', this.currentSpec.relative);
@@ -631,6 +663,28 @@ export class AllureReporter {
     this.testDetailsStored = arg;
   }
 
+  applyGroupLabels() {
+    // apply labels
+
+    const applyLabel = (name: string) => {
+      if (!this.currentTest) {
+        return;
+      }
+      const lb = this.labels.filter(l => l.name == name);
+
+      // return last added
+      const lastLabel = lb[lb.length - 1];
+
+      if (lastLabel) {
+        this.currentTest.addLabel(lastLabel.name, lastLabel.value);
+      }
+    };
+
+    applyLabel(LabelName.PARENT_SUITE);
+    applyLabel(LabelName.SUITE);
+    applyLabel(LabelName.SUB_SUITE);
+  }
+
   endTest(arg: AllureTaskArgs<'testEnded'>) {
     const { result, details } = arg;
     const storedStatus = this.testStatusStored;
@@ -663,12 +717,14 @@ export class AllureReporter {
       this.setExecutableStatus(this.currentTest, storedStatus.result, storedStatus.details);
     }
 
+    this.applyGroupLabels();
     this.currentTest.endTest();
 
     this.tests.pop();
     this.descriptionHtml = [];
     this.testStatusStored = undefined;
     this.testDetailsStored = undefined;
+    this.labels = [];
   }
 
   startStep(arg: AllureTaskArgs<'stepStarted'>) {

src/plugins/allure-reporter-plugin.ts

@@ -46,6 +46,9 @@ type AllureTask = {
   addDescriptionHtml: { value: string };
   label: { name: string; value: string };
   message: { name: string };
+  suite: { name?: string };
+  subSuite: { name?: string };
+  parentSuite: { name?: string };
   testMessage: { path: string; message: string };
   delete: { path: string };
   attachScreenshots: { screenshots: AutoScreen[] };