[patch] nested suites - add Before and After hooks to child suites (#7) (#116)

Author: mmisty

src/plugins/allure-reporter-plugin.ts

@@ -149,8 +149,8 @@ export class AllureReporter {
   globalHooks = new GlobalHooks(this);
 
   // this is variable for global hooks only
-  hooks: { id?: string; hook: ExecutableItemWrapper }[] = [];
-  allHooks: { id?: string; hook: ExecutableItemWrapper; suite: string }[] = [];
+  hooks: { id?: string; hook: ExecutableItemWrapper; nested: number; name: string }[] = [];
+  allHooks: { id?: string; hook: ExecutableItemWrapper; suite: string; nested: number; name: string }[] = [];
   currentSpec: Cypress.Spec | undefined;
   allureRuntime: AllureRuntime;
   descriptionHtml: string[] = [];
@@ -216,10 +216,10 @@ export class AllureReporter {
     return this.currentStep || this.currentHook || this.currentTest;
   }
 
-  addGlobalHooks() {
+  addGlobalHooks(nestedLevel: number) {
     log('>>> add Global Hooks');
 
-    if (this.groups.length > 1 || !this.globalHooks.hasHooks()) {
+    if (nestedLevel > 1 || !this.globalHooks.hasHooks()) {
       log('not root hooks');
 
       return;
@@ -237,8 +237,27 @@ export class AllureReporter {
     this.groups.push(group);
     log(`SUITES: ${JSON.stringify(this.groups.map(t => t.name))}`);
 
-    if (this.groups.length === 1) {
-      this.addGlobalHooks();
+    this.addGlobalHooks(this.groups.length);
+    this.addHooks(this.groups.length);
+  }
+
+  addHooks(nested: number) {
+    const hooks = this.allHooks.filter(t => t.nested <= nested - 1);
+
+    if (!!this.currentGroup && hooks.length > 0) {
+      hooks.forEach(hk => {
+        const currentHook = isBeforeAllHook(hk.hook.name)
+          ? this.currentGroup!.addBefore()
+          : this.currentGroup!.addAfter();
+
+        currentHook.name = hk.name;
+        currentHook.wrappedItem.status = hk.hook.status;
+        currentHook.wrappedItem.stop = hk.hook.wrappedItem.stop;
+        currentHook.wrappedItem.start = hk.hook.wrappedItem.start;
+        currentHook.wrappedItem.attachments = hk.hook.wrappedItem.attachments;
+        currentHook.wrappedItem.statusDetails = hk.hook.wrappedItem.statusDetails;
+        currentHook.wrappedItem.parameters = hk.hook.wrappedItem.parameters;
+      });
     }
   }
 
@@ -282,8 +301,14 @@ export class AllureReporter {
 
       currentHook.name = title;
       currentHook.wrappedItem.start = date ?? Date.now();
-      this.hooks.push({ id: hookId, hook: currentHook });
-      this.allHooks.push({ id: hookId, hook: currentHook, suite: this.currentGroup?.uuid });
+      this.hooks.push({ id: hookId, hook: currentHook, nested: this.groups.length, name: title });
+      this.allHooks.push({
+        id: hookId,
+        hook: currentHook,
+        suite: this.currentGroup?.uuid,
+        nested: this.groups.length,
+        name: title,
+      });
     } else {
       // create but not add to suite for steps to be added there
       const currentHook = new ExecutableItemWrapper({
@@ -300,8 +325,14 @@ export class AllureReporter {
       });
 
       currentHook.wrappedItem.start = date ?? Date.now();
-      this.hooks.push({ id: hookId, hook: currentHook });
-      this.allHooks.push({ id: hookId, hook: currentHook, suite: this.currentGroup?.uuid });
+      this.hooks.push({ id: hookId, hook: currentHook, nested: this.groups.length, name: title });
+      this.allHooks.push({
+        id: hookId,
+        hook: currentHook,
+        suite: this.currentGroup?.uuid,
+        nested: this.groups.length,
+        name: title,
+      });
     }
   }
 
@@ -582,7 +613,7 @@ export class AllureReporter {
     // why >= 1?
     if (this.groups.length >= 1) {
       log('addGlobalHooks');
-      this.addGlobalHooks();
+      this.addGlobalHooks(this.groups.length);
     }
 
     if (this.currentGroup) {

tests/cy-helper/utils.ts

@@ -30,7 +30,7 @@ export const fixResult = (results: AllureTest[]): AllureTest[] => {
   const date = Date.parse('10 Dec 2011 UTC');
 
   const replaceSteps = (steps: ExecutableItem[]): any[] => {
-    if (steps.length === 0) {
+    if (!steps || steps.length === 0) {
       return [];
     }
 
@@ -328,11 +328,11 @@ export const createResTest2 = (
     let err: Error | undefined;
     const spec = specPaths.length === 1 ? specPaths[0] : specPaths;
 
-    try {
-      process.env.DEBUG = envConfig?.DEBUG ? 'cypress-allure*' : undefined;
-      process.env.COVERAGE_REPORT_DIR = 'reports/coverage-cypress';
+    process.env.DEBUG = envConfig?.DEBUG ? 'cypress-allure*' : undefined;
+    process.env.COVERAGE_REPORT_DIR = 'reports/coverage-cypress';
 
-      result.res = await cy.run({
+    return cy
+      .run({
         spec,
         specPattern: 'integration/e2e/**/*.(cy|test|spec).ts',
         port,
@@ -341,12 +341,16 @@ export const createResTest2 = (
         env,
         quiet: `${process.env.QUIET}` === 'true',
         video: parseBoolean(envConfig?.video ?? `${true}`),
+      })
+      .catch(e => {
+        err = e as Error;
+      })
+      .then(cyResult => {
+        result.res = cyResult;
+      })
+      .then(() => {
+        expect(err).toBeUndefined();
       });
-    } catch (e) {
-      err = e as Error;
-    }
-
-    expect(err).toBeUndefined();
   });
 
   return {

tests/test-folder/mocha-events/suites/suites-nested-with-global-hooks-parent.test.ts

@@ -0,0 +1,156 @@
+import { createResTest2, fixResult } from '../../../cy-helper/utils';
+import { getParentsArray, parseAllure } from 'allure-js-parser';
+import { extname } from '../../../../src/common';
+import { readFileSync } from 'fs';
+
+describe('several nested suites with global hook - hook should be added to all children', () => {
+  const res = createResTest2([
+    `
+describe('hello suite', () => {
+  before('parent hook', () => {
+    cy.allure().attachment('out parent', 'test number', 'text/plain');
+    cy.log('before');
+  });
+  
+  describe('child suite', () => {
+    before('child hook', () => {
+      cy.allure().attachment('out child', 'test number', 'text/plain');
+      cy.log('before');
+    });
+    
+    describe('sub sub suite', () => {
+      it('hello test', () => {
+        cy.log('message');
+      });
+    });
+  });
+});
+`,
+  ]);
+
+  describe('check results', () => {
+    let resFixed;
+
+    beforeAll(() => {
+      const results = parseAllure(res.watch);
+      resFixed = fixResult(results);
+    });
+
+    it('check tests count', async () => {
+      expect(resFixed.length).toEqual(1);
+    });
+
+    it('check tests names', async () => {
+      expect(resFixed.map(t => t.fullName).sort()).toEqual([
+        'hello suite child suite sub sub suite hello test',
+      ]);
+    });
+
+    it('suites parents', () => {
+      expect(
+        resFixed.map(t => ({
+          name: t.name,
+          status: t.status,
+          parents: getParentsArray(t).map(t => ({
+            name: t.name,
+            befores: t.befores
+              ?.filter(x => (x as any).name !== '"before all" hook')
+              .map(x => ({
+                name: (x as any).name,
+                status: x.status,
+                attachments: x.attachments.map(t => ({
+                  ...t,
+                  source: `source${extname(t.source)}`,
+                  sourceContentMoreThanZero:
+                    readFileSync(`${res.watch}/${t.source}`).toString().length >
+                    0,
+                })),
+              })),
+          })),
+        })),
+      ).toEqual([
+        {
+          name: 'hello test',
+          parents: [
+            {
+              befores: [
+                {
+                  attachments: [
+                    {
+                      name: 'out parent',
+                      source: 'source.txt',
+                      sourceContentMoreThanZero: true,
+                      type: 'text/plain',
+                    },
+                  ],
+                  name: '"before all" hook: parent hook',
+                  status: 'passed',
+                },
+                {
+                  attachments: [
+                    {
+                      name: 'out child',
+                      source: 'source.txt',
+                      sourceContentMoreThanZero: true,
+                      type: 'text/plain',
+                    },
+                  ],
+                  name: '"before all" hook: child hook',
+                  status: 'passed',
+                },
+              ],
+              name: 'sub sub suite',
+            },
+            {
+              befores: [
+                {
+                  attachments: [
+                    {
+                      name: 'out parent',
+                      source: 'source.txt',
+                      sourceContentMoreThanZero: true,
+                      type: 'text/plain',
+                    },
+                  ],
+                  name: '"before all" hook: parent hook',
+                  status: 'passed',
+                },
+                {
+                  attachments: [
+                    {
+                      name: 'out child',
+                      source: 'source.txt',
+                      sourceContentMoreThanZero: true,
+                      type: 'text/plain',
+                    },
+                  ],
+                  name: '"before all" hook: child hook',
+                  status: 'passed',
+                },
+              ],
+              name: 'child suite',
+            },
+            {
+              befores: [
+                {
+                  attachments: [
+                    {
+                      name: 'out parent',
+                      source: 'source.txt',
+                      sourceContentMoreThanZero: true,
+                      type: 'text/plain',
+                    },
+                  ],
+                  name: '"before all" hook: parent hook',
+                  status: 'passed',
+                },
+              ],
+              name: 'hello suite',
+            },
+          ],
+          status: 'passed',
+        },
+      ]);
+    });
+  });
+});

tests/test-folder/mocha-events/suites/suites-nested-with-global-hooks.test.ts

@@ -0,0 +1,74 @@
+import { createResTest2, fixResult } from '../../../cy-helper/utils';
+import { getParentsArray, parseAllure } from 'allure-js-parser';
+
+describe('several nested suites with global hook - hook should be added to all parents', () => {
+  const res = createResTest2([
+    `
+describe('hello suite', () => {
+  describe('child suite', () => {
+    before('Child hook', () => {
+      cy.log('before');
+    });
+    
+    it('hello test', () => {
+      cy.log('message');
+    });
+  });
+});
+`,
+  ]);
+
+  describe('check results', () => {
+    let resFixed;
+
+    beforeAll(() => {
+      const results = parseAllure(res.watch);
+      resFixed = fixResult(results);
+    });
+
+    it('check tests count', async () => {
+      expect(resFixed.length).toEqual(1);
+    });
+
+    it('check tests names', async () => {
+      expect(resFixed.map(t => t.fullName).sort()).toEqual([
+        'hello suite child suite hello test',
+      ]);
+    });
+
+    it('suites parents', () => {
+      expect(
+        resFixed.map(t => ({
+          name: t.name,
+          status: t.status,
+          parents: getParentsArray(t).map(z => ({
+            name: z.name,
+            befores: z.befores
+              ?.filter(x => (x as any).name !== '"before all" hook')
+              ?.map(x => ({ status: x.status, name: (x as any).name })),
+          })),
+        })),
+      ).toEqual([
+        {
+          name: 'hello test',
+          parents: [
+            {
+              befores: [
+                {
+                  name: '"before all" hook: Child hook',
+                  status: 'passed',
+                },
+              ],
+              name: 'child suite',
+            },
+            {
+              befores: [],
+              name: 'hello suite',
+            },
+          ],
+          status: 'passed',
+        },
+      ]);
+    });
+  });
+});