Add Global Setup/Teardown APIs

Author: xfumihiro

CHANGELOG.md

@@ -18,6 +18,7 @@
 * `[jest-resolve]` Preserve module identity for symlinks ([#4761](https://github.com/facebook/jest/pull/4761))
 
 ### Features
+* `[jest-config]` Add Global Setup/Teardown options ([#4716](https://github.com/facebook/jest/pull/4716))
 * `[jest-environment-*]` [**BREAKING**] Add Async Test Environment APIs, dispose is now teardown ([#4506](https://github.com/facebook/jest/pull/4506))
 * `[jest-cli]` Add an option to clear the cache ([#4430](https://github.com/facebook/jest/pull/4430))
 * `[babel-plugin-jest-hoist]` Improve error message, that the second argument of `jest.mock` must be an inline function ([#4593](https://github.com/facebook/jest/pull/4593))

docs/Configuration.md

@@ -170,6 +170,16 @@ For example, the following would create a global `__DEV__` variable set to `true
 
 Note that, if you specify a global reference value (like an object or array) here, and some code mutates that value in the midst of running a test, that mutation will *not* be persisted across test runs for other test files.
 
+### `globalSetup` [string]
+Default: `undefined`
+
+This option allows the use of a custom global setup module which exports an async function that is triggered once before all test suites.
+
+### `globalTeardown` [string]
+Default: `undefined`
+
+This option allows the use of a custom global teardown module which exports an async function that is triggered once after all test suites.
+
 ### `mapCoverage` [boolean]
 
 ##### available in Jest **20.0.0+**

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

@@ -66,6 +66,8 @@ exports[`--showConfig outputs config info and exits 1`] = `
       \\"clover\\"
     ],
     \\"expand\\": false,
+    \\"globalSetup\\": null,
+    \\"globalTeardown\\": null,
     \\"listTests\\": false,
     \\"mapCoverage\\": false,
     \\"maxWorkers\\": \\"[maxWorkers]\\",

integration_tests/__tests__/global_setup.test.js

@@ -0,0 +1,30 @@
+/**
+ * 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';
+
+const fs = require('fs');
+const os = require('os');
+const path = require('path');
+const runJest = require('../runJest');
+const {cleanup} = require('../utils');
+
+const DIR = path.join(os.tmpdir(), '/jest');
+
+beforeEach(() => cleanup(DIR));
+afterAll(() => cleanup(DIR));
+
+test('globalSetup is triggered once before all test suites', () => {
+  const path = require('path');
+  const setupPath = path.resolve(__dirname, '../global_setup/setup.js');
+  const result = runJest.json('global_setup', [`--globalSetup=${setupPath}`]);
+  expect(result.status).toBe(0);
+  const files = fs.readdirSync(DIR);
+  expect(files).toHaveLength(1);
+  const setup = fs.readFileSync(path.join(DIR, '/', files[0]), 'utf8');
+  expect(setup).toBe('setup');
+});

integration_tests/__tests__/global_teardown.test.js

@@ -0,0 +1,37 @@
+/**
+ * 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';
+
+const fs = require('fs');
+const mkdirp = require('mkdirp');
+const os = require('os');
+const path = require('path');
+const runJest = require('../runJest');
+const {cleanup} = require('../utils');
+
+const DIR = path.join(os.tmpdir(), '/jest');
+
+beforeEach(() => cleanup(DIR));
+afterAll(() => cleanup(DIR));
+
+test('globalTeardown is triggered once after all test suites', () => {
+  mkdirp.sync(DIR);
+  const path = require('path');
+  const teardownPath = path.resolve(
+    __dirname,
+    '../global_teardown/teardown.js',
+  );
+  const result = runJest.json('global_teardown', [
+    `--globalTeardown=${teardownPath}`,
+  ]);
+  expect(result.status).toBe(0);
+  const files = fs.readdirSync(DIR);
+  expect(files).toHaveLength(1);
+  const teardown = fs.readFileSync(path.join(DIR, '/', files[0]), 'utf8');
+  expect(teardown).toBe('teardown');
+});

integration_tests/global_setup/__tests__/setup1.test.js

@@ -0,0 +1,20 @@
+/**
+ * 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';
+
+const fs = require('fs');
+const path = require('path');
+const os = require('os');
+
+const DIR = path.join(os.tmpdir(), '/jest');
+
+test('should exist setup file', () => {
+  const files = fs.readdirSync(DIR);
+  expect(files).toHaveLength(1);
+  const setup = fs.readFileSync(path.join(DIR, '/', files[0]), 'utf8');
+  expect(setup).toBe('setup');
+});

integration_tests/global_setup/__tests__/setup2.test.js

@@ -0,0 +1,20 @@
+/**
+ * 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';
+
+const fs = require('fs');
+const path = require('path');
+const os = require('os');
+
+const DIR = path.join(os.tmpdir(), '/jest');
+
+test('should exist setup file', () => {
+  const files = fs.readdirSync(DIR);
+  expect(files).toHaveLength(1);
+  const setup = fs.readFileSync(path.join(DIR, '/', files[0]), 'utf8');
+  expect(setup).toBe('setup');
+});

integration_tests/global_setup/__tests__/setup3.test.js

@@ -0,0 +1,20 @@
+/**
+ * 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';
+
+const fs = require('fs');
+const path = require('path');
+const os = require('os');
+
+const DIR = path.join(os.tmpdir(), '/jest');
+
+test('should exist setup file', () => {
+  const files = fs.readdirSync(DIR);
+  expect(files).toHaveLength(1);
+  const setup = fs.readFileSync(path.join(DIR, '/', files[0]), 'utf8');
+  expect(setup).toBe('setup');
+});

integration_tests/global_setup/package.json

@@ -0,0 +1,5 @@
+{
+  "jest": {
+    "testEnvironment": "node"
+  }
+}

integration_tests/global_setup/setup.js

@@ -0,0 +1,22 @@
+/**
+ * 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.
+ */
+const crypto = require('crypto');
+const fs = require('fs');
+const mkdirp = require('mkdirp');
+const os = require('os');
+const path = require('path');
+
+const DIR = path.join(os.tmpdir(), '/jest');
+
+module.exports = function() {
+  return new Promise((resolve, reject) => {
+    mkdirp.sync(DIR);
+    const fileId = crypto.randomBytes(20).toString('hex');
+    fs.writeFileSync(path.join(DIR, '/', fileId), 'setup');
+    resolve();
+  });
+};