Add support for globalSetup and globalTeardown in projects by ranyitz · Pull Request #6865 · jestjs/jest

ranyitz · 2018-08-19T21:23:42Z

Summary

This PR solves #5441 and adds support for globalSetup and globalTeardown functions in projects.

Motivation

There are multiple usaged for projects. Some use them for multiple packages in a monorepo and some for running multiple environments/runners.

Today, globalSetup/globalTeadown are working only in globalConfig.

In most cases it would be nice if Jest would know how to run only the relevant setup for the specific tests that we choose to run.

For example, bootstrap puppeteer only if we are in the e2e project, or if we choose to run an e2e file at the moment (which needs setup). It would be also nice to not bootstrap puppeteer if we only run component tests.

codecov-io · 2018-08-19T21:43:19Z

Codecov Report

Merging #6865 into master will increase coverage by 0.04%.
The diff coverage is 64.28%.

@@            Coverage Diff             @@
##           master    #6865      +/-   ##
==========================================
+ Coverage   66.98%   67.02%   +0.04%     
==========================================
  Files         250      251       +1     
  Lines       10365    10369       +4     
  Branches        4        3       -1     
==========================================
+ Hits         6943     6950       +7     
+ Misses       3421     3418       -3     
  Partials        1        1

Impacted Files	Coverage Δ
packages/jest-config/src/index.js	`37.73% <ø> (ø)`	⬆️
packages/jest-cli/src/runJest.js	`77.21% <100%> (+7.1%)`	⬆️
packages/jest-cli/src/runGlobalHook.js	`58.33% <58.33%> (ø)`

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 8e72341...1a1412d. Read the comment docs.

SimenB · 2018-08-23T13:25:55Z

I like this! Would the docs need an update?

ranyitz · 2018-08-24T06:28:08Z

@SimenB @thymikee Thanks, I'm not sure what would be the best wording, here are two options:

*After globalSetup section

...

If you are using the projects option and have multiple globalSetup modules, Jest will find the ones that relevant to the current run and will trigger only them before all test suites.

...

A globalSetup module configured in a project will be triggered only when you run at list one test from this project.

ranyitz · 2018-09-06T20:37:20Z

@SimenB Let me know what you think regarding the documentation options. Other than that, is there anything in the PR that needs a fix?

SimenB · 2018-09-15T19:07:22Z

Sorry about the late response! I think those doc changes makes sense, yeah

ranyitz · 2018-09-15T21:37:43Z

Thanks @SimenB, I've updated the documentation.

codecov-io · 2018-09-19T00:10:56Z

Codecov Report

Merging #6865 into master will increase coverage by 0.04%.
The diff coverage is 64.28%.

@@            Coverage Diff             @@
##           master    #6865      +/-   ##
==========================================
+ Coverage   66.61%   66.66%   +0.04%     
==========================================
  Files         253      254       +1     
  Lines       10626    10630       +4     
  Branches        4        4              
==========================================
+ Hits         7079     7086       +7     
+ Misses       3546     3543       -3     
  Partials        1        1

Impacted Files	Coverage Δ
packages/jest-config/src/index.js	`37.73% <ø> (ø)`	⬆️
packages/jest-cli/src/runJest.js	`77.21% <100%> (+7.1%)`	⬆️
packages/jest-cli/src/runGlobalHook.js	`58.33% <58.33%> (ø)`

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 477f461...bcbc602. Read the comment docs.

SimenB · 2018-09-21T08:58:52Z

I think this makes sense, and is also how I think most global options should be handled.

I think if you think of Jest as a generic runner, rather than just a test runner, this change makes sense.

@cpojer thoughts?

cpojer · 2018-09-25T18:15:21Z

works for me.

amarchen · 2018-12-13T16:46:14Z

If inly changelog is different, could somebody with the right access kindly merge the changes?

thymikee

Left some nits to address, but looks good over all

thymikee · 2018-12-18T17:54:18Z

    '/examples/',
    '/e2e/.*/__tests__',
+    '/e2e/global-setup',
+    '/e2e/global-teardown',


not sure why this is needed?

Those directories are fixtures to the tests that in __tests__ directory. The test files inside should be run from /e2e/__tests__/global_setup.test.js and /e2e/__tests__/global_teardown.test.js.

thymikee · 2018-12-18T18:02:07Z

+    await Promise.all(
+      Array.from(globalModulePaths).map(async modulePath => {
+        if (!modulePath) {
+          return null;


any scenario where this could happen?

I think I did it because globalSetup/globalTeardown are nullables and can also be an empty string.

https://github.com/facebook/jest/blob/c1d3de5e315d4dc01acfe33abd7de4fe7d4591ea/types/Config.js#L120-L121

I did not write any specific test for this use case, but Jest's tests would not pass without this condition.

Co-Authored-By: ranyitz <ranyitz@users.noreply.github.com>

ranyitz · 2018-12-18T22:46:44Z

@thymikee Thanks for the review!

jestjs/jest#6865 updating deprecated property remove tsconfig.jest.json ignore d.ts files form coverage This reverts commit 7875345cadaee70b4f2cb2c2d5d3d8554fe0354f.

* upgrading jest to support global setup on multi-projects; jestjs/jest#6865 updating deprecated property remove tsconfig.jest.json ignore d.ts files form coverage * fix e2e root dir path

github-actions · 2021-05-12T04:09:15Z

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 Aug 19, 2018

ranyitz changed the title ~~add globalSetup and globalTeardown for projects~~ Add support for globalSetup and globalTeardown in projects Aug 19, 2018

thymikee reviewed Aug 19, 2018

View reviewed changes

Comment thread packages/jest-cli/src/runJest.js Outdated

SimenB requested a review from rickhanlonii August 23, 2018 13:26

ranyitz force-pushed the global-setup-and-teardown-for-projects branch from 14c5c52 to 1a1412d Compare August 29, 2018 23:07

SimenB approved these changes Sep 15, 2018

View reviewed changes

backflip reviewed Sep 18, 2018

View reviewed changes

Comment thread docs/Configuration.md Outdated

backflip mentioned this pull request Sep 18, 2018

global setup and global teardown now gets globalConfig as a parameter #6486

Merged

ranyitz mentioned this pull request Oct 7, 2018

globalSetup and globalTeardown are ignored in projects. #5441

Closed

ranyitz and others added 6 commits October 8, 2018 02:03

add global setup and teardown for projects as well

786f5bc

add changelog entry

9413052

change runGlobalModules function name to runGlobalHook

f86bc94

Add documentation in configuration section

0eed21e

fix typo

e61b331

refactor to use ESM in integration tests

bcbc602

ranyitz force-pushed the global-setup-and-teardown-for-projects branch from b431eb1 to bcbc602 Compare October 7, 2018 23:10

SimenB added this to the Jest 24 milestone Oct 16, 2018

Merge branch 'master' into global-setup-and-teardown-for-projects

b519982

thymikee added 2 commits December 18, 2018 17:50

Merge branch 'master' into global-setup-and-teardown-for-projects

863b9b0

Update Configuration.md

382aac6

add copyright header

c2c2c22

thymikee reviewed Dec 18, 2018

View reviewed changes

thymikee and others added 3 commits December 19, 2018 00:33

Fix grammer in test description

b53f317

Co-Authored-By: ranyitz <ranyitz@users.noreply.github.com>

Change moduleName type from a string to an enum

c4b794b

Co-Authored-By: ranyitz <ranyitz@users.noreply.github.com>

refactor: remove async await and added return type

ca16490

ranyitz and others added 2 commits December 19, 2018 19:58

Merge branch 'master' into global-setup-and-teardown-for-projects

7e04229

Merge branch 'master' into global-setup-and-teardown-for-projects

7c281f6

SimenB merged commit 698c33c into jestjs:master Dec 25, 2018

ranyitz deleted the global-setup-and-teardown-for-projects branch December 25, 2018 17:00

jaxxstorm mentioned this pull request Mar 27, 2019

Unable to use per project globalSetup/Teardown #8228

Closed

captain-yossarian pushed a commit to captain-yossarian/jest that referenced this pull request Jul 18, 2019

Add support for globalSetup and globalTeardown in projects (jestjs#6865)

9781246

github-actions Bot locked as resolved and limited conversation to collaborators May 12, 2021

Uh oh!

Conversation

ranyitz commented Aug 19, 2018

Summary

Motivation

Uh oh!

codecov-io commented Aug 19, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

SimenB commented Aug 23, 2018

Uh oh!

ranyitz commented Aug 24, 2018

Uh oh!

ranyitz commented Sep 6, 2018

Uh oh!

SimenB commented Sep 15, 2018

Uh oh!

ranyitz commented Sep 15, 2018

Uh oh!

Uh oh!

codecov-io commented Sep 19, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

SimenB commented Sep 21, 2018

Uh oh!

cpojer commented Sep 25, 2018

Uh oh!

amarchen commented Dec 13, 2018

Uh oh!

thymikee left a comment

Choose a reason for hiding this comment

Uh oh!

thymikee Dec 18, 2018

Choose a reason for hiding this comment

Uh oh!

ranyitz Dec 18, 2018

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

thymikee Dec 18, 2018

Choose a reason for hiding this comment

Uh oh!

ranyitz Dec 18, 2018

Choose a reason for hiding this comment

Uh oh!

ranyitz commented Dec 18, 2018

Uh oh!

github-actions Bot commented May 12, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

codecov-io commented Aug 19, 2018 •

edited

Loading

codecov-io commented Sep 19, 2018 •

edited

Loading