Setup before tests but after framework loads

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ### Features
 
+- `[jest-jasmine2/jest-circus/jest-cli]` Setup before tests but after framework loads ([#7119](https://github.com/facebook/jest/pull/7119))
 - `[jest-jasmine2/jest-circus/jest-cli]` Add test.todo ([#6996](https://github.com/facebook/jest/pull/6996))
 - `[pretty-format]` Option to not escape strings in diff messages ([#5661](https://github.com/facebook/jest/pull/5661))
 - `[jest-haste-map]` Add `getFileIterator` to `HasteFS` for faster file iteration ([#7010](https://github.com/facebook/jest/pull/7010)).

TestUtils.js

@@ -100,6 +100,7 @@ const DEFAULT_PROJECT_CONFIG: ProjectConfig = {
   runner: 'jest-runner',
   setupFiles: [],
   setupTestFrameworkScriptFile: null,
+  setupTestsAfterJest: [],
   skipFilter: false,
   skipNodeResolution: false,
   snapshotResolver: null,

e2e/__tests__/__snapshots__/show_config.test.js.snap

@@ -45,6 +45,7 @@ exports[`--showConfig outputs config info and exits 1`] = `
       \\"runner\\": \\"jest-runner\\",
       \\"setupFiles\\": [],
       \\"setupTestFrameworkScriptFile\\": null,
+      \\"setupTestsAfterJest\\": [],
       \\"skipFilter\\": false,
       \\"snapshotSerializers\\": [],
       \\"testEnvironment\\": \\"jest-environment-jsdom\\",

e2e/__tests__/setup_tests_after_jest_config.test.js

@@ -0,0 +1,60 @@
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow
+ */
+'use strict';
+
+import path from 'path';
+import {json as runWithJson} from '../runJest';
+import {writeFiles} from '../Utils';
+
+const DIR = path.resolve(__dirname, '../setup-tests-after-jest-config');
+
+describe('setupTestsAfterJest', () => {
+  it('requires multiple setup files before each file in the suite', () => {
+    const pkgJson = {
+      jest: {
+        setupTestsAfterJest: ['./setup1.js', './setup2.js'],
+      },
+    };
+
+    writeFiles(DIR, {
+      'package.json': JSON.stringify(pkgJson, null, 2),
+    });
+
+    const result = runWithJson('setup-tests-after-jest-config', [
+      'test1.test.js',
+      'test2.test.js',
+    ]);
+
+    expect(result.json.numTotalTests).toBe(2);
+    expect(result.json.numPassedTests).toBe(2);
+    expect(result.json.testResults.length).toBe(2);
+    expect(result.status).toBe(0);
+  });
+
+  it('requires setup files *after* the test runners are required', () => {
+    const pkgJson = {
+      jest: {
+        setupTestsAfterJest: ['./setup_hooks_into_runner.js'],
+      },
+    };
+
+    writeFiles(DIR, {
+      'package.json': JSON.stringify(pkgJson, null, 2),
+    });
+
+    const result = runWithJson('setup-tests-after-jest-config', [
+      'runner_patch.test.js',
+    ]);
+
+    expect(result.json.numTotalTests).toBe(1);
+    expect(result.json.numPassedTests).toBe(1);
+    expect(result.json.testResults.length).toBe(1);
+    expect(result.status).toBe(0);
+  });
+});

e2e/setup-tests-after-jest-config/__tests__/runner_patch.test.js

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+'use strict';
+
+describe('setupFile', () => {
+  it('patches jasmine in setup file', () => {
+    expect(global.describeDefined).toBe(true);
+  });
+});

e2e/setup-tests-after-jest-config/__tests__/test1.test.js

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+'use strict';
+
+describe('test', () => {
+  it('has predefined global variable', () => {
+    expect(global.definedInSetupFile).toEqual(true);
+  });
+});

e2e/setup-tests-after-jest-config/__tests__/test2.test.js

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+'use strict';
+
+describe('test', () => {
+  it('has predefined global variable', () => {
+    expect(global.definedInSetupFile).toEqual(true);
+  });
+});

e2e/setup-tests-after-jest-config/package.json

@@ -0,0 +1,7 @@
+{
+  "jest": {
+    "setupTestsAfterJest": [
+      "./setup_hooks_into_runner.js"
+    ]
+  }
+}

e2e/setup-tests-after-jest-config/setup1.js

@@ -0,0 +1,8 @@
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+global.definedInSetupFile = true;

e2e/setup-tests-after-jest-config/setup2.js

@@ -0,0 +1,8 @@
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+global.definedInSetupFile = true;

e2e/setup-tests-after-jest-config/setup_hooks_into_runner.js

@@ -0,0 +1,8 @@
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+global.describeDefined = !!global.describe;

packages/jest-circus/src/legacy_code_todo_rewrite/jest_adapter.js

@@ -77,6 +77,12 @@ const jestAdapter = async (
     runtime.requireModule(config.setupTestFrameworkScriptFile);
   }
 
+  if (config.setupTestsAfterJest.length) {
+    for (let i = 0; i < config.setupTestsAfterJest.length; i++) {
+      runtime.requireModule(config.setupTestsAfterJest[i]);
+    }
+  }
+
   runtime.requireModule(testPath);
   const results = await runAndTransformResultsToJestFormat({
     config,

packages/jest-cli/src/cli/args.js

@@ -511,6 +511,12 @@ export const options = {
       'set up the testing framework before each test.',
     type: 'string',
   },
+  setupTestsAfterJest: {
+    description:
+      'A list of paths to modules that run some code to configure or ' +
+      'set up the testing framework before each test ',
+    type: 'array',
+  },
   showConfig: {
     default: undefined,
     description: 'Print your jest config and then exits.',

packages/jest-cli/src/lib/__tests__/__snapshots__/init.test.js.snap

@@ -141,6 +141,9 @@ module.exports = {
   // The path to a module that runs some code to configure or set up the testing framework before each test
   // setupTestFrameworkScriptFile: null,
 
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupTestsAfterJest: [],
+
   // A list of paths to snapshot serializer modules Jest should use for snapshot testing
   // snapshotSerializers: [],
 

packages/jest-config/src/Defaults.js

@@ -61,6 +61,7 @@ export default ({
   runner: 'jest-runner',
   setupFiles: [],
   setupTestFrameworkScriptFile: null,
+  setupTestsAfterJest: [],
   skipFilter: false,
   snapshotSerializers: [],
   testEnvironment: 'jest-environment-jsdom',

packages/jest-config/src/Descriptions.js

@@ -63,6 +63,8 @@ export default ({
     'The paths to modules that run some code to configure or set up the testing environment before each test',
   setupTestFrameworkScriptFile:
     'The path to a module that runs some code to configure or set up the testing framework before each test',
+  setupTestsAfterJest:
+    'A list of paths to modules that run some code to configure or set up the testing framework before each test',
   snapshotSerializers:
     'A list of paths to snapshot serializer modules Jest should use for snapshot testing',
   testEnvironment: 'The test environment that will be used for testing',

packages/jest-config/src/ValidConfig.js

@@ -88,6 +88,7 @@ export default ({
   runner: 'jest-runner',
   setupFiles: ['<rootDir>/setup.js'],
   setupTestFrameworkScriptFile: '<rootDir>/testSetupFile.js',
+  setupTestsAfterJest: ['<rootDir>/testSetupFile.js'],
   silent: true,
   skipFilter: false,
   skipNodeResolution: false,

packages/jest-config/src/__tests__/normalize.test.js

@@ -330,6 +330,53 @@ describe('haste', () => {
   });
 });
 
+describe('setupTestsAfterJest', () => {
+  let Resolver;
+  beforeEach(() => {
+    Resolver = require('jest-resolve');
+    Resolver.findNodeModule = jest.fn(
+      name =>
+        name.startsWith('/') ? name : '/root/path/foo' + path.sep + name,
+    );
+  });
+
+  it('normalizes the path according to rootDir', () => {
+    const {options} = normalize(
+      {
+        rootDir: '/root/path/foo',
+        setupTestsAfterJest: ['bar/baz'],
+      },
+      {},
+    );
+
+    expect(options.setupTestsAfterJest).toEqual([expectedPathFooBar]);
+  });
+
+  it('does not change absolute paths', () => {
+    const {options} = normalize(
+      {
+        rootDir: '/root/path/foo',
+        setupTestsAfterJest: ['/an/abs/path'],
+      },
+      {},
+    );
+
+    expect(options.setupTestsAfterJest).toEqual([expectedPathAbs]);
+  });
+
+  it('substitutes <rootDir> tokens', () => {
+    const {options} = normalize(
+      {
+        rootDir: '/root/path/foo',
+        setupTestsAfterJest: ['<rootDir>/bar/baz'],
+      },
+      {},
+    );
+
+    expect(options.setupTestsAfterJest).toEqual([expectedPathFooBar]);
+  });
+});
+
 describe('setupTestFrameworkScriptFile', () => {
   let Resolver;
   beforeEach(() => {

packages/jest-config/src/index.js

@@ -183,6 +183,7 @@ const getConfigs = (
     runner: options.runner,
     setupFiles: options.setupFiles,
     setupTestFrameworkScriptFile: options.setupTestFrameworkScriptFile,
+    setupTestsAfterJest: options.setupTestsAfterJest,
     skipFilter: options.skipFilter,
     skipNodeResolution: options.skipNodeResolution,
     snapshotResolver: options.snapshotResolver,

packages/jest-config/src/normalize.js

@@ -109,6 +109,11 @@ const setupPreset = (
   if (options.setupFiles) {
     options.setupFiles = (preset.setupFiles || []).concat(options.setupFiles);
   }
+
+  if (!options.setupTestsAfterJest) {
+    options.setupTestsAfterJest = [];
+  }
+
   if (options.modulePathIgnorePatterns && preset.modulePathIgnorePatterns) {
     options.modulePathIgnorePatterns = preset.modulePathIgnorePatterns.concat(
       options.modulePathIgnorePatterns,
@@ -414,6 +419,7 @@ export default function normalize(options: InitialOptions, argv: Argv) {
         value = normalizeCollectCoverageOnlyFrom(options, key);
         break;
       case 'setupFiles':
+      case 'setupTestsAfterJest':
       case 'snapshotSerializers':
         value =
           options[key] &&

packages/jest-jasmine2/src/index.js

@@ -131,6 +131,12 @@ async function jasmine2(
     runtime.requireModule(config.setupTestFrameworkScriptFile);
   }
 
+  if (config.setupTestsAfterJest.length) {
+    for (let i = 0; i < config.setupTestsAfterJest.length; i++) {
+      runtime.requireModule(config.setupTestsAfterJest[i]);
+    }
+  }
+
   if (globalConfig.enabledTestsMap) {
     env.specFilter = spec => {
       const suiteMap =

packages/jest-validate/src/__tests__/fixtures/jest_config.js

@@ -108,6 +108,7 @@ const validConfig = {
   roots: ['<rootDir>'],
   setupFiles: ['<rootDir>/setup.js'],
   setupTestFrameworkScriptFile: '<rootDir>/testSetupFile.js',
+  setupTestsAfterJest: ['<rootDir>/testSetupFile.js'],
   silent: true,
   snapshotSerializers: ['my-serializer-module'],
   testEnvironment: 'jest-environment-jsdom',

types/Argv.js

@@ -72,6 +72,7 @@ export type Argv = {|
   runInBand: boolean,
   setupFiles: Array<string>,
   setupTestFrameworkScriptFile: string,
+  setupTestsAfterJest: Array<string>,
   showConfig: boolean,
   silent: boolean,
   snapshotSerializers: Array<string>,

types/Config.js

@@ -65,6 +65,7 @@ export type DefaultOptions = {|
   runTestsByPath: boolean,
   setupFiles: Array<Path>,
   setupTestFrameworkScriptFile: ?Path,
+  setupTestsAfterJest: Array<Path>,
   skipFilter: boolean,
   snapshotSerializers: Array<Path>,
   testEnvironment: string,
@@ -150,6 +151,7 @@ export type InitialOptions = {
   scriptPreprocessor?: string,
   setupFiles?: Array<Path>,
   setupTestFrameworkScriptFile?: Path,
+  setupTestsAfterJest?: Array<Path>,
   silent?: boolean,
   skipFilter?: boolean,
   skipNodeResolution?: boolean,
@@ -272,6 +274,7 @@ export type ProjectConfig = {|
   runner: string,
   setupFiles: Array<Path>,
   setupTestFrameworkScriptFile: ?Path,
+  setupTestsAfterJest: Array<Path>,
   skipFilter: boolean,
   skipNodeResolution: boolean,
   snapshotResolver: ?Path,