Test environment gets current file path as option

[avaly]

Summary

The testEnvironment feature enables a whole new suite of tests to be written with Jest.

However the following use case can present itself:

1. an application has an async setup with involves a connection task and a resource bootstrapping task (e.g. prepare some external resources).
2. the application's connection task is slow, but is safe to run several times (since it has already initialized connections to the external resources) - so running this in a setupFiles is less than optimal, as we would pay the price for this task on each test file
3. the application's bootstrap task needs to be configurable per test file - we currently don't have any option to do this.
4. the application's bootstrap task can not run in the test file context, because the connection task was not run in the same context (due to the time penalty described in 2.)

PS: Related #6889

Test plan

$ node ./packages/jest-cli/bin/jest.js test_environment_async
 PASS  e2e/__tests__/test_environment_async.test.js
  ✓ triggers setup/teardown hooks (861ms)

Test Suites: 1 passed, 1 total
Tests:       1 passed, 1 total
Snapshots:   0 total
Time:        1.288s, estimated 2s
Ran all test suites matching /test_environment_async/i.

[facebook-github-bot]

Thank you for your pull request. We require contributors to sign our Contributor License Agreement, and yours has expired.

Before we can review or merge your code, we need you to email cla@fb.com with your details so we can update your status.

[SimenB]

Not sure about the feature, but it should be passed in the constructor, not the individual methods

[rickhanlonii]

Still want to digest this, but I left a few comments in the mean time

[rickhanlonii]

Can you think of anything else we should expose here while we're thinking about it?

[facebook-github-bot]

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

[SimenB]

We're getting a flow error, mind taking a look at it? Run yarn flow locally to see it

[avaly]

Rebased and fixed Flow error.

[codecov-io]

Codecov Report

Merging #7442 into master will decrease coverage by 0.01%.
The diff coverage is 0%.

@@            Coverage Diff             @@
##           master    #7442      +/-   ##
==========================================
- Coverage   67.46%   67.44%   -0.02%     
==========================================
  Files         247      247              
  Lines        9516     9511       -5     
  Branches        5        5              
==========================================
- Hits         6420     6415       -5     
  Misses       3094     3094              
  Partials        2        2

Impacted Files	Coverage Δ
packages/jest-environment-jsdom/src/index.js	39.02% <ø> (ø)	⬆️
packages/jest-runner/src/runTest.js	3.07% <0%> (ø)	⬆️
packages/jest-config/src/getMaxWorkers.js	100% <0%> (ø)	⬆️

---

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 df78255...7c18f46. Read the comment docs.

[github-actions]

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.