[minor] add historyId to interface (#74)

Author: mmisty

src/commands/index.ts

@@ -47,6 +47,7 @@ export const registerCommands = () => {
     attachment: (allure, name, content, type) => allure.attachment(name, content, type),
     owner: (allure, name) => allure.owner(name),
     fullName: (allure, name) => allure.fullName(name),
+    historyId: (allure, value) => allure.historyId(value),
     lead: (allure, name) => allure.lead(name),
     layer: (allure, name) => allure.layer(name),
     browser: (allure, name) => allure.browser(name),

src/cypress/types.ts

@@ -182,6 +182,14 @@ declare namespace Cypress {
      */
     fullName(value: string): T;
 
+    /**
+     * Sets test history Id
+     * @param value string to group in timeline
+     * @example
+     * cy.allure().historyId('1c6b6e73-6043-4772-a079-c722afcd1700');
+     */
+    historyId(value: string): T;
+
     /**
      * Sets label 'owner' - will be shown in allure report as Owner field
      * @param value owner name

src/plugins/allure-reporter-plugin.ts

@@ -601,6 +601,12 @@ export class AllureReporter {
     }
   }
 
+  historyId(arg: AllureTaskArgs<'fullName'>) {
+    if (this.currentTest) {
+      this.currentTest.historyId = arg.value;
+    }
+  }
+
   parameter(arg: AllureTaskArgs<'parameter'>) {
     if (this.currentExecutable) {
       this.currentExecutable.addParameter(arg.name, arg.value);

src/plugins/allure-types.ts

@@ -36,6 +36,7 @@ type AllureTask = {
   step: { name: string; status?: string; date?: number };
   parameter: { name: string; value: string };
   fullName: { value: string };
+  historyId: { value: string };
   link: { url: string; name?: string; type?: LinkType };
   testParameter: { name: string; value: string };
   testStatus: { result: Status; details?: StatusDetails };

src/plugins/allure.ts

@@ -285,11 +285,19 @@ export const allureTasks = (opts: ReporterOptions): AllureTasks => {
       allureReporter.attachment(arg);
       log('attachment');
     },
+
     fullName: (arg: AllureTaskArgs<'fullName'>) => {
       log(`fullName ${JSON.stringify(arg)}`);
       allureReporter.fullName(arg);
       log('fullName');
     },
+
+    historyId: (arg: AllureTaskArgs<'historyId'>) => {
+      log(`historyId ${JSON.stringify(arg)}`);
+      allureReporter.historyId(arg);
+      log('historyId');
+    },
+
     link: (arg: AllureTaskArgs<'link'>) => {
       log(`link ${JSON.stringify(arg)}`);
       allureReporter.link(arg);

src/setup/allure-mocha-reporter.ts

@@ -104,6 +104,7 @@ export const allureInterface = (
       fn({ task: 'step', arg: { name, status: status ?? Status.PASSED, date: Date.now() } }),
     deleteResults: () => fn({ task: 'deleteResults', arg: {} }),
     fullName: (value: string) => fn({ task: 'fullName', arg: { value } }),
+    historyId: (value: string) => fn({ task: 'historyId', arg: { value } }),
     testAttachment: (name: string, content: string | Buffer, type) =>
       fn({ task: 'testAttachment', arg: { name, content, type } }),
     testStatus: (result: Status, details?: StatusDetails) => fn({ task: 'testStatus', arg: { result, details } }),

tests/test-folder/mocha-events/interface/history-id.test.ts

@@ -0,0 +1,34 @@
+import { createResTest2 } from '../../../cy-helper/utils';
+import { AllureTest, parseAllure } from 'allure-js-parser';
+
+describe('should set historyId by using cy.allure() interface', () => {
+  const res = createResTest2(
+    [
+      `
+  describe('set historyId for test', () => {
+    it('01 historyId', () => {
+      cy.allure().historyId('1c6b6e73-6043-4772-a079-c722afcd1700');
+    });
+  });
+`,
+    ],
+    {},
+  );
+  describe('check results', () => {
+    let resAllure: AllureTest[];
+
+    beforeAll(() => {
+      resAllure = parseAllure(res.watch);
+    });
+
+    it('should have simple step with 0 duration', () => {
+      const tests = resAllure.filter(t => t.name === '01 historyId');
+      expect(tests.length).toEqual(1);
+
+      expect(tests[0].historyId).toEqual(
+        '1c6b6e73-6043-4772-a079-c722afcd1700',
+      );
+      expect(tests[0].name).toEqual('01 historyId');
+    });
+  });
+});