Using .env files for unit testing with jest

Question

Is it possible to load environment variables from an env file for unit testing purposes in Jest? I'm looking to run a series of tests on it like so:

// unit tests for env file describe('env', () => {     it('should have a client id', () => {         expect(process.env.CLIENT_ID).toBeDefined();     });     it('should have a client secret', () => {         expect(process.env.CLIENT_SECRET).toBeDefined();     });     it('should have a host', () => {         expect(process.env.HOST).toBeDefined();     });     it('should have a scope', () => {         expect(process.env.SCOPE).toBeDefined();     });     it('should have a response type', () => {         expect(process.env.RESPONSE_TYPE).toBeDefined();     });     it('should have a redirect uri', () => {         expect(process.env.REDIRECT_URI).toBeDefined();     }); }); 

Currently, all the above tests will fail, stating that the variables are undefined. Initially I was using a mocha/chai setup, which allowed me to just load all of my env variables via the use of dotenv. This involved running all unit tests through webpack and worked fine.

However, from reading the documentation Jest doesn't run tests through webpack; instead modules are mocked out via moduleNameMapper. This works fine for everything else, but I can't get the env file variables to load. So far I've tried using the setupFiles option to a js file that calls dotenv.config with the path of the env file given to it like so:

// setup file for jest const dotenv = require('dotenv'); dotenv.config({ path: './env' }); 

This didn't work, so I've now resorted to using just a .env.js file for unit tests and passing this file into the setupFiles option instead. However, for maintainability, and to keep it working with webpack for production, I'd like to just keep it all in one file. Here's an extract of how the .env.js file looks for reference

// .env.js extract example process.env.PORT = 3000; process.env.HOST = 'localhost'; process.env.CLIENT_ID = 'your client id'; process.env.REDIRECT_URI = 'your callback endpoint'; 

Answer 1

None of these worked for me, but I found a great article on configuring dotenv by default in Jest in the package.json:

{   "scripts": {     "test": "jest --setupFiles dotenv/config"   } } 

Answer 2

You can load the env files for all your tests like this. The setup file will be executed once per each test file that is loaded.

jest.config.js:

module.exports = {     setupFiles: ["<rootDir>/test/setup-tests.ts"], }; 

test/setup-tests.ts:

import dotenv from 'dotenv';  dotenv.config({ path: './config.env.test' });