fix: perform global teardown if bailing from failed tests (#15833)

Author: hainenber

packages/jest-core/src/TestScheduler.ts

@@ -41,6 +41,7 @@ import {
 import {ErrorWithStack, invariant, requireOrImportModule} from 'jest-util';
 import type {TestWatcher} from 'jest-watcher';
 import ReporterDispatcher from './ReporterDispatcher';
+import runGlobalHook from './runGlobalHook';
 import {shouldRunInBand} from './testSchedulerHelper';
 
 export type ReporterConstructor = new (
@@ -150,7 +151,12 @@ class TestScheduler {
         testResult,
         aggregatedResults,
       );
-      return this._bailIfNeeded(testContexts, aggregatedResults, watcher);
+      return this._bailIfNeeded(
+        testContexts,
+        aggregatedResults,
+        watcher,
+        tests,
+      );
     };
 
     const onFailure = async (test: Test, error: SerializableError) => {
@@ -408,6 +414,7 @@ class TestScheduler {
     testContexts: Set<TestContext>,
     aggregatedResults: AggregatedResult,
     watcher: TestWatcher,
+    allTests: Array<Test>,
   ): Promise<void> {
     if (
       this._globalConfig.bail !== 0 &&
@@ -421,8 +428,17 @@ class TestScheduler {
       try {
         await this._dispatcher.onRunComplete(testContexts, aggregatedResults);
       } finally {
-        const exitCode = this._globalConfig.testFailureExitCode;
-        exit(exitCode);
+        // Perform global teardown if client configures `bail`
+        if (allTests.length > 0) {
+          performance.mark('jest/globalTeardown:start');
+          await runGlobalHook({
+            allTests,
+            globalConfig: this._globalConfig,
+            moduleName: 'globalTeardown',
+          });
+          performance.mark('jest/globalTeardown:end');
+          exit(this._globalConfig.testFailureExitCode);
+        }
       }
     }
   }

packages/jest-core/src/__tests__/TestScheduler.test.js

@@ -18,6 +18,7 @@ import {makeGlobalConfig, makeProjectConfig} from '@jest/test-utils';
 import * as transform from '@jest/transform';
 import {createTestScheduler} from '../TestScheduler';
 import * as testSchedulerHelper from '../testSchedulerHelper';
+import * as runGlobalHook from '../runGlobalHook';
 
 jest
   .mock('ci-info', () => ({GITHUB_ACTIONS: true}))
@@ -35,7 +36,8 @@ jest
       __esModule: true,
       ...jest.requireActual('@jest/transform'),
     };
-  });
+  })
+  .mock('exit-x', () => ({__esModule: true, default: jest.fn()}));
 const mockSerialRunner = {
   isSerial: true,
   runTests: jest.fn(),
@@ -53,10 +55,13 @@ jest.mock('jest-runner-parallel', () => jest.fn(() => mockParallelRunner), {
 
 const spyShouldRunInBand = jest.spyOn(testSchedulerHelper, 'shouldRunInBand');
 
+const spyRunGlobalHook = jest.spyOn(runGlobalHook, 'default');
+
 beforeEach(() => {
   mockSerialRunner.runTests.mockClear();
   mockParallelRunner.runTests.mockClear();
   spyShouldRunInBand.mockClear();
+  spyRunGlobalHook.mockClear();
 });
 
 describe('reporters', () => {
@@ -449,6 +454,42 @@ test('should bail after `n` failures', async () => {
   expect(setState).toHaveBeenCalledWith({interrupted: true});
 });
 
+test('should bail after `n` failures and perform global teardown', async () => {
+  const scheduler = await createTestScheduler(
+    makeGlobalConfig({bail: 3}),
+    {},
+    {},
+  );
+  const test = {
+    context: {
+      config: makeProjectConfig({
+        moduleFileExtensions: ['.js'],
+        rootDir: './',
+        runner: 'jest-runner-serial',
+        transform: [],
+      }),
+      hasteFS: {
+        matchFiles: jest.fn(() => []),
+      },
+    },
+    path: './test/path.js',
+  };
+
+  const tests = [test];
+  const setState = jest.fn();
+  await scheduler.scheduleTests(tests, {
+    isInterrupted: jest.fn(),
+    isWatchMode: () => false,
+    setState,
+  });
+  await mockSerialRunner.runTests.mock.calls[0][3](test, {
+    numFailingTests: 3,
+    snapshot: {},
+    testResults: [{}],
+  });
+  expect(spyRunGlobalHook.mock.calls[0][0].moduleName).toBe('globalTeardown');
+});
+
 test('should not bail if less than `n` failures', async () => {
   const scheduler = await createTestScheduler(
     makeGlobalConfig({bail: 2}),