[patch] Fix suite structure when before hook fails in nested suite - fixes issue #95 and issue #149 (#151)

Author: mmisty

.eslintrc.js

@@ -12,6 +12,7 @@ module.exports = {
   ignorePatterns: ['*.yaml', '*.yml', '*.csv'],
 
   rules: {
+    'jest/no-export': 'off',
     '@typescript-eslint/no-explicit-any': 'warn',
     'prefer-template': 'error',
     quotes: ['error', 'single', { avoidEscape: true }],

jest.config.ts

@@ -42,6 +42,9 @@ export default {
     '!**/tests/test-folder/allure-plugin/**/?(*.)+(spec|test).[tj]s?(x)',
     '!**/lib/**/*.*',
   ],
+  moduleNameMapper: {
+    '^@test-utils$': '<rootDir>/tests/cy-helper/utils.ts',
+  },
   transform: {
     '^.+\\.tsx?$': ['ts-jest', { tsconfig: 'tests/tsconfig.json' }],
 

src/plugins/allure-types.ts

@@ -1,6 +1,9 @@
-import type { StatusDetails } from 'allure-js-commons';
 import type { ContentType } from '../common/types';
 
+export type StatusDetails = {
+  message?: string;
+  trace?: string;
+};
 export interface AutoScreen {
   screenshotId?: string;
   specName?: string;
@@ -61,7 +64,7 @@ type AllureTask = {
   screenshotOne: { name: string | undefined; forStep?: boolean };
   screenshotAttachment: AutoScreen;
   testResult: {
-    title: string;
+    title?: string;
     id: string;
     result: Status;
     details?: StatusDetails;

src/setup/allure-mocha-reporter.ts

@@ -8,11 +8,12 @@ import {
   Status,
   Category,
   LabelName,
+  LinkType,
 } from '../plugins/allure-types'; // todo
 import { registerScreenshotHandler } from './screenshots';
 import StatusDetails = Cypress.StatusDetails;
 import { logClient } from './helper';
-import { tmsIssueUrl } from '../common';
+import { packageLog, tmsIssueUrl } from '../common';
 import { EventEmitter } from 'events';
 import AllureEvents = Cypress.AllureEvents;
 
@@ -126,10 +127,22 @@ export const allureInterface = (
     },
 
     link: (url: string, name?: string, type?: 'issue' | 'tms') => fn({ task: 'link', arg: { url, name, type } }),
-    tms: (url: string, name?: string) =>
-      fn({ task: 'link', arg: { url: tmsIssueUrl(env, url, 'tms'), name: name ?? url, type: 'tms' } }),
-    issue: (url: string, name?: string) =>
-      fn({ task: 'link', arg: { url: tmsIssueUrl(env, url, 'issue'), name: name ?? url, type: 'issue' } }),
+    tms: (url: string, name?: string) => {
+      const type: LinkType = 'tms';
+      const fullUrl = tmsIssueUrl(env, url, type);
+      const linkName = name ?? url;
+
+      return fn({ task: 'link', arg: { url: fullUrl, name: linkName, type } });
+    },
+
+    issue: (url: string, name?: string) => {
+      const type: LinkType = 'issue';
+      const fullUrl = tmsIssueUrl(env, url, type);
+      const linkName = name ?? url;
+
+      return fn({ task: 'link', arg: { url: fullUrl, name: linkName, type } });
+    },
+
     label: (name: string, value: string) => fn({ task: 'label', arg: { name, value } }),
     suite: (name: string) => fn({ task: 'suite', arg: { name } }),
     parentSuite: (name: string) => fn({ task: 'parentSuite', arg: { name } }),
@@ -176,7 +189,7 @@ const isHook = (test: Mocha.Test) => {
   return (test as any).type === 'hook';
 };
 
-const createTests = (runner: Mocha.Runner, test: Mocha.Test) => {
+const createTestsForFailedBeforeHook = (runner: Mocha.Runner, test: Mocha.Test) => {
   let index = 0;
   test.parent?.eachTest(ts => {
     ts.err = test.err;
@@ -186,6 +199,15 @@ const createTests = (runner: Mocha.Runner, test: Mocha.Test) => {
     if (ts) {
       if (index === 1) {
         ts.state = 'failed';
+
+        if (ts.err) {
+          // Cypress error cannot be taken here - it will be updated only on 'test:after:run' event
+          // so to simplify events chain creating own error message
+          // need to watch cypress error text message when it changes - and update it here
+          ts.err.message =
+            `${ts.err.message}\n\n` +
+            `Because this error occurred during a \`before all\` hook we are skipping the remaining tests in the current suite: \`${ts.parent?.title}\` (added by ${packageLog})`;
+        }
       }
       runner.emit(CUSTOM_EVENTS.TEST_BEGIN, ts);
       runner.emit(CUSTOM_EVENTS.TEST_FAIL, ts);
@@ -393,7 +415,8 @@ export const registerMochaReporter = (ws: WebSocket) => {
           return;
         }
 
-        createTestsCallb = () => createTests(runner, test);
+        runner.emit(CUSTOM_EVENTS.TEST_END, test);
+        createTestsForFailedBeforeHook(runner, test);
 
         return;
       }

tests/.eslintrc.js

@@ -6,6 +6,8 @@ module.exports = {
   extends: [...original.extends, 'plugin:jest/recommended'],
   rules: {
     ...original.rules,
+
+    '@typescript-eslint/no-var-requires': 'off',
     '@typescript-eslint/no-explicit-any': 'off',
     'jest/no-standalone-expect': 'off',
     '@typescript-eslint/no-non-null-assertion': 'off',