[patch] fix duplicate step when using custom commands with groupping (#171)

Author: mmisty

src/plugins/allure-reporter-plugin.ts

@@ -448,6 +448,7 @@ export class AllureReporter {
       this.filterSteps(this.currentHook.wrappedItem);
       this.currentHook.wrappedItem.stop = date ?? Date.now();
       this.setExecutableStatus(this.currentHook, result, details);
+      this.mergeStepsWithSingleChild(this.currentHook.wrappedItem.steps);
 
       this.hooks.pop();
 
@@ -970,6 +971,7 @@ export class AllureReporter {
     if (!this.currentTest) {
       return;
     }
+    this.mergeStepsWithSingleChild(this.currentTest.wrappedItem.steps);
 
     if (this.currentTestAll) {
       this.currentTestAll.status = result;
@@ -1010,6 +1012,41 @@ export class AllureReporter {
     copyFileToWatch({ test: testFile, attachments }, this.allureResultsWatch);
   }
 
+  /**
+   * Recursively merge the steps when a step has single child with the same name
+   * Delete first child when it has the same name as parent
+   * @param steps
+   */
+  mergeStepsWithSingleChild(steps: ExecutableItem[]): void {
+    function mergeSteps(step: ExecutableItem): ExecutableItem {
+      if (!step.steps || step.steps.length === 0) {
+        return step;
+      }
+
+      // If the step has exactly one child with the same name, merge them
+      if (step.steps.length === 1 && step.steps[0].name === step.name) {
+        const mergedChild = mergeSteps(step.steps[0]);
+        step.steps = mergedChild.steps;
+        step.attachments.push(...mergedChild.attachments);
+
+        return step;
+      }
+
+      step.steps = step.steps.map(mergeSteps);
+
+      // If the first child has the same name as the parent, delete it
+      if (step.steps.length > 0 && step.steps[0].name === step.name) {
+        step.steps.shift();
+      }
+
+      return step;
+    }
+
+    for (let i = 0; i < steps.length; i++) {
+      steps[i] = mergeSteps(steps[i]);
+    }
+  }
+
   startStep(arg: AllureTaskArgs<'stepStarted'>) {
     const { name, date } = arg;
 

tests/test-folder/mocha-events/commands/custom-command.test.ts

@@ -18,6 +18,14 @@ describe('custom commands', () => {
     Cypress.log({ name: 'tasklogWithCypressLog', message: 'something' });
     cy.task('log', message);
   });
+
+  Cypress.Commands.add('cmdWithGroup', (message: string) => {
+    Cypress.log({ name: 'cmdWithGroup', message, groupStart: true });
+    cy.log('more steps withing custom');
+    cy.task('log', message).then(()=> {
+      Cypress.log({emitOnly: true, groupEnd: true});
+    });
+  });
   
   Cypress.Commands.add('returnGet', { prevSubject: true }, (subj, message: string) => {
     cy.task('log', message);
@@ -75,6 +83,11 @@ describe('custom commands', () => {
      it('promises returned from commands', () => {
         cy.get('div:eq(0)').promiseTest(10).should('exist').promiseTest(10);
      });
+
+     it('cmd with group', () => {
+       cy.cmdWithGroup('my step');
+       cy.cmdWithGroup('my step2');
+     })
   });
 `,
     ],
@@ -144,6 +157,7 @@ describe('custom commands', () => {
         },
       ]);
     });
+
     it('should have nested steps for custom command which returns something', () => {
       const tests = resFixed.filter(t => t.name === 'returnGet');
       expect(tests.length).toEqual(1);
@@ -319,15 +333,53 @@ describe('custom commands', () => {
       ]);
     });
 
+    it('should merge commands when group', () => {
+      const tests = resFixed.filter(t => t.name === 'cmd with group');
+      expect(tests.length).toEqual(1);
+
+      const steps = mapSteps(tests[0].steps, t => ({ name: t.name }))
+        .filter(t => t.name.indexOf('"after each"') === -1)
+        .filter(t => t.name.indexOf('"before each"') === -1);
+
+      expect(steps).toEqual([
+        {
+          name: 'cmdWithGroup: my step',
+          steps: [
+            {
+              name: 'log: more steps withing custom',
+              steps: [],
+            },
+            {
+              name: 'task: log, my step',
+              steps: [],
+            },
+          ],
+        },
+        {
+          name: 'cmdWithGroup: my step2',
+          steps: [
+            {
+              name: 'log: more steps withing custom',
+              steps: [],
+            },
+            {
+              name: 'task: log, my step2',
+              steps: [],
+            },
+          ],
+        },
+      ]);
+    });
+
     it('should have results', () => {
       // should not fail run
       checkCyResults(res?.result?.res, {
-        totalPassed: 8,
+        totalPassed: 9,
         totalFailed: 0,
         totalPending: 0,
         totalSkipped: 0,
         totalSuites: 1,
-        totalTests: 8,
+        totalTests: 9,
       });
     });
   });

tests/test-folder/mocha-events/cucumber/session-gherkin.test.ts

@@ -69,11 +69,6 @@ Feature: test cucumber
               name: 'session: user',
               status: 'passed',
               steps: [
-                {
-                  name: 'session: user',
-                  status: 'passed',
-                  steps: [],
-                },
                 {
                   name: 'Create new session',
                   status: 'passed',

tests/test-folder/mocha-events/steps/group-logs/data-group-log-session.ts

@@ -58,13 +58,6 @@ describe('${rootSuite}', { defaultCommandTimeout: 300 },() => {
             status: 'passed',
             statusDetails: {},
             steps: [
-              {
-                attachments: [],
-                name: 'session: user123',
-                status: 'passed',
-                statusDetails: {},
-                steps: [],
-              },
               {
                 attachments: [],
                 name: 'Create new session',