Clarification on how .env files can be loaded with Jest #16443
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jportela
requested review from
chibicode,
ijjk,
lfades,
Timer and
timneutkens
as code owners
lfades
reviewed
Aug 28, 2020
Comment on lines
+128
to
+136
| ### Loading Test Environment Variables | ||
|
|
||
| In test environments such as `jest`, Next.js doesn't get automatically instantiated. You'll need to instantiate Next.js explicitly as part of your tests setup, in order to load `.env` files (including `.env.test`): | ||
|
|
||
| ```js | ||
| // include this in your Jest setup file, or before your tests | ||
| import next from 'next' | ||
| next({}) // instantiates Next.js to load .env files | ||
| ``` |
There was a problem hiding this comment.
This feels vague, as if it were missing context. Something better would be to add a list of examples to the section above this one (Test Environment Variables), and include one with Jest that has this same code but in a context where it works.
|
👋 thanks for looking into this! Just wanted to add that I added this to my setup file and got the error: This seemed odd to me because the test environment shouldn't worry about build artifacts. I eventually found that: -next({})
+next({ dev: true })did the trick. UPDATE (10/19/20) Didn't love the next server output in the test logs, so ended up using |
neilvanbeinum
added a commit
to LBHackney-IT/repairs-hub-frontend
that referenced
this pull request
Jan 19, 2021
Next isn't instantiated by Jest, so we need to explicitly tell it where to get env vars. Using .env.sample as I don't see a need for more specialised .env.test or other file for our values which are all test strings. vercel/next.js#16443
neilvanbeinum
added a commit
to LBHackney-IT/repairs-hub-frontend
that referenced
this pull request
Jan 19, 2021
Next isn't instantiated by Jest, so we need to explicitly tell it where to get env vars. Using .env.sample as I don't see a need for more specialised .env.test or other file for our values which are all test strings. vercel/next.js#16443
neilvanbeinum
added a commit
to LBHackney-IT/repairs-hub-frontend
that referenced
this pull request
Jan 21, 2021
Next isn't instantiated by Jest, so we need to explicitly tell it where to get env vars. Using .env.sample as I don't see a need for more specialised .env.test or other file for our values which are all test strings. vercel/next.js#16443
neilvanbeinum
added a commit
to LBHackney-IT/repairs-hub-frontend
that referenced
this pull request
Jan 21, 2021
Next isn't instantiated by Jest, so we need to explicitly tell it where to get env vars. Using .env.sample as I don't see a need for more specialised .env.test or other file for our values which are all test strings. vercel/next.js#16443
|
Going to close this as the PR is stale. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This clarifies how
.env.testfiles can be loaded in an environment like Jest, where Next.js doesn't get instantiated automatically. It will hopefully help with these questions #16315 #16270