Add Global Setup/Teardown APIs #4716

xfumihiro · 2017-10-17T19:21:04Z

Summary

Adding Global Setup/Teardown APIs

Test plan

jest.config.js

module.exports = {
  globalSetup: "path/to/setup.js",
  globalTeardown: "path/to/teardown.js"
};

setup/teardown.js

module.exports = async function() {
  // setup/teardown tasks
}

SimenB · 2017-10-19T16:04:51Z

docs/Configuration.md

+### `globalSetup` [string]
+Default: `undefined`
+
+This option allows the use of a custom global setup module which exports an async function.


what does "global setup" mean? (I know, but I want the docs to clearly state what the purpose of the option is)

SimenB

I'm not sure the tests prove anything beyond the what setup and teardown does for test environments. I'd add more test files and have a test asserting that whatever sideeffect the setup does is only done once.

Also please update the changelog

SimenB

Just a small suggestion for assertion, but overall this looks great! Really looking forward to seeing what we can do with puppeteer once it's properly supported in Jest. Thanks for all your help!

SimenB · 2017-10-25T20:35:21Z

integration_tests/global_setup/__tests__/setup2.test.js

+
+test('should exist setup file', () => {
+  const files = fs.readdirSync(DIR);
+  expect(files.length).toBe(1);


toHaveLength (can be used multiple places)

thymikee · 2017-10-25T20:44:28Z

integration_tests/global_teardown/__tests__/teardown3.test.js

+const fs = require('fs');
+const os = require('os');
+
+const DIR = os.tmpdir() + '/jest';


can we replace all these concats with path.join/path.resolve?

SimenB · 2017-10-26T11:11:48Z

Will this run once per worker, or per jest process?

thymikee · 2017-10-26T11:17:14Z

It will run once per jest instance.

xfumihiro · 2017-10-26T14:46:57Z

Should we make it run once upon all jest instance?

SimenB · 2017-10-29T08:38:17Z

I'm not sure what makes most sense. I'm inclined to keeping it once per jest process and not per worker. @cpojer?

cpojer · 2017-10-30T09:55:31Z

I'm not particularly happy about this. What problem is this feature solving? The way this works right now is that it runs before any tests and after any tests, but it in the parent context and not in the context of tests. Running it once per worker makes little sense, because that is for a set of 0–N tests and it's not deterministic (workers could crash and be restarted etc.). Making it once per test seems unnecessary also, because we now have async hooks for custom test environments.

OzairP · 2017-11-09T21:33:53Z

@cpojer This PR could solve my issue. Currently, I am testing an app that consumes a port. When Jest concurrently runs tests, all my suites attempt to consume the same port. I have to pass in the runInBand flag to prevent this, it slows down testing.

The global setup and teardown will ensure only one server will spawn to consume a port, and all tests will test off that same server.

vajahath · 2017-11-30T08:49:58Z

I'm not sure why someone is not particularly happy about this PR when problems like this will be solved by this PR.
This is an essential requirement. I don't think there is an alternative. 😕

vajahath · 2017-12-11T06:21:22Z

integration_tests/global_setup/setup.js

+const DIR = path.join(os.tmpdir(), '/jest');
+
+module.exports = function() {
+  return new Promise((resolve, reject) => {


@xfumihiro Everything inside this function in synchronous. So do we really need to wrap this in a promise?
the same applies to tread-down also.

I think this is causing the test to fail.

Tests only failed on windows(appveyor) so that can't be the case.
Otherwise all tests should failed also.
However, until the team approves this PR, there's no point spending more time on it.

cpojer · 2017-12-13T13:18:12Z

@SimenB mind resolving the conflict? Happy to merge after all the people are supportive.

SimenB · 2017-12-13T13:24:05Z

@xfumihiro can you rebase and fix the test on appveyor?

xfumihiro · 2017-12-13T14:57:59Z

@SimenB Sure!

codecov-io · 2017-12-13T16:41:27Z

Codecov Report

Merging #4716 into master will decrease coverage by <.01%.
The diff coverage is 50%.

@@            Coverage Diff             @@
##           master    #4716      +/-   ##
==========================================
- Coverage   60.76%   60.75%   -0.01%     
==========================================
  Files         198      198              
  Lines        6603     6607       +4     
  Branches        4        4              
==========================================
+ Hits         4012     4014       +2     
- Misses       2591     2593       +2

Impacted Files	Coverage Δ
packages/jest-config/src/index.js	`23.8% <ø> (ø)`	⬆️
packages/jest-config/src/defaults.js	`100% <ø> (ø)`	⬆️
packages/jest-config/src/normalize.js	`91.95% <ø> (ø)`	⬆️
packages/jest-cli/src/run_jest.js	`53.57% <50%> (-0.28%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f20344b...fc15a72. Read the comment docs.

cpojer · 2017-12-13T17:09:48Z

Let's do it! Thanks everyone for chiming in.

SimenB · 2017-12-13T17:23:00Z

An example in the docs for usage with puppeteer would be awesome! winkwinknudgenudge

xfumihiro · 2017-12-14T03:34:44Z

@cpojer could you publish the beta so I can write an example for this. 😃

SimenB · 2017-12-16T12:22:43Z

@xfumihiro a beta has been published.

Also, see https://medium.com/@jsilvax/getting-started-with-jest-and-puppeteer-7cf6c59a2cae

github-actions · 2021-05-13T01:31:57Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

facebook-github-bot added the CLA Signed ✔️ label Oct 17, 2017

This was referenced Oct 17, 2017

Basic support for Jest runner wix/Detox#335

Merged

Add example to testEnvironment in Configuration.md #4690

Merged

xfumihiro force-pushed the global_setup_teardown branch 2 times, most recently from ca2c222 to ea82f18 Compare October 18, 2017 16:24

xfumihiro mentioned this pull request Oct 18, 2017

Jest beforeOnce and afterOnce #4709

Closed

SimenB reviewed Oct 19, 2017

View reviewed changes

SimenB requested changes Oct 19, 2017

View reviewed changes

xfumihiro force-pushed the global_setup_teardown branch 5 times, most recently from c12bad7 to 2253417 Compare October 20, 2017 13:46

xfumihiro mentioned this pull request Oct 22, 2017

Support config CLI flag xfumihiro/jest-puppeteer#1

Merged

SimenB approved these changes Oct 25, 2017

View reviewed changes

thymikee reviewed Oct 25, 2017

View reviewed changes

xfumihiro force-pushed the global_setup_teardown branch from 2253417 to d42f293 Compare October 26, 2017 05:55

xfumihiro mentioned this pull request Nov 30, 2017

Add Async Test Environment APIs #4506

Merged

vajahath reviewed Dec 11, 2017

View reviewed changes

xfumihiro force-pushed the global_setup_teardown branch from d42f293 to 5b75b69 Compare December 13, 2017 15:10

xfumihiro force-pushed the global_setup_teardown branch 2 times, most recently from a971c18 to 0fbc771 Compare December 13, 2017 16:20

Add Global Setup/Teardown APIs

fc15a72

xfumihiro force-pushed the global_setup_teardown branch from 0fbc771 to fc15a72 Compare December 13, 2017 16:32

SimenB approved these changes Dec 13, 2017

View reviewed changes

cpojer merged commit 5d24695 into jestjs:master Dec 13, 2017

mathieumg mentioned this pull request Dec 14, 2017

global beforeAll #3832

Closed

xfumihiro mentioned this pull request Jan 4, 2018

Extend NodeEnvironment to avoid side effect methods NimaSoroush/differencify#62

Open

yss14 mentioned this pull request Jan 5, 2018

Support jest config globalSetup and globalTeardown kulshekhar/ts-jest#411

Closed

renovate-tests mentioned this pull request Feb 6, 2018

Update dependency jest to v22 - autoclosed renovate-tests/changelog-md#3

Closed

renovate bot mentioned this pull request Feb 14, 2018

fix(deps): update dependency jest to ^22.0.0 manekinekko/devoxx-assistant#3

Open

github-actions bot locked as resolved and limited conversation to collaborators May 13, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Global Setup/Teardown APIs #4716

Add Global Setup/Teardown APIs #4716

xfumihiro commented Oct 17, 2017 •

edited

Loading

SimenB Oct 19, 2017 •

edited

Loading

SimenB left a comment

SimenB left a comment •

edited

Loading

SimenB Oct 25, 2017

thymikee Oct 25, 2017

SimenB commented Oct 26, 2017

thymikee commented Oct 26, 2017

xfumihiro commented Oct 26, 2017

SimenB commented Oct 29, 2017

cpojer commented Oct 30, 2017

OzairP commented Nov 9, 2017

vajahath commented Nov 30, 2017

vajahath Dec 11, 2017

xfumihiro Dec 11, 2017 •

edited

Loading

cpojer commented Dec 13, 2017

SimenB commented Dec 13, 2017

xfumihiro commented Dec 13, 2017

codecov-io commented Dec 13, 2017

cpojer commented Dec 13, 2017

SimenB commented Dec 13, 2017

xfumihiro commented Dec 14, 2017 •

edited

Loading

SimenB commented Dec 16, 2017

github-actions bot commented May 13, 2021

Add Global Setup/Teardown APIs #4716

Add Global Setup/Teardown APIs #4716

Conversation

xfumihiro commented Oct 17, 2017 • edited Loading

SimenB Oct 19, 2017 • edited Loading

Choose a reason for hiding this comment

SimenB left a comment

Choose a reason for hiding this comment

SimenB left a comment • edited Loading

Choose a reason for hiding this comment

SimenB Oct 25, 2017

Choose a reason for hiding this comment

thymikee Oct 25, 2017

Choose a reason for hiding this comment

SimenB commented Oct 26, 2017

thymikee commented Oct 26, 2017

xfumihiro commented Oct 26, 2017

SimenB commented Oct 29, 2017

cpojer commented Oct 30, 2017

OzairP commented Nov 9, 2017

vajahath commented Nov 30, 2017

vajahath Dec 11, 2017

Choose a reason for hiding this comment

xfumihiro Dec 11, 2017 • edited Loading

Choose a reason for hiding this comment

cpojer commented Dec 13, 2017

SimenB commented Dec 13, 2017

xfumihiro commented Dec 13, 2017

codecov-io commented Dec 13, 2017

Codecov Report

cpojer commented Dec 13, 2017

SimenB commented Dec 13, 2017

xfumihiro commented Dec 14, 2017 • edited Loading

SimenB commented Dec 16, 2017

github-actions bot commented May 13, 2021

xfumihiro commented Oct 17, 2017 •

edited

Loading

SimenB Oct 19, 2017 •

edited

Loading

SimenB left a comment •

edited

Loading

xfumihiro Dec 11, 2017 •

edited

Loading

xfumihiro commented Dec 14, 2017 •

edited

Loading