用Jest测试process.env

Question

我有一个应用程序依赖于环境变量,如:

const APP_PORT = process.env.APP_PORT || 8080;

我想测试一下例如:

• APP_PORT可以由节点env变量设置.
• 或者express应用程序正在设置的端口上运行process.env.APP_PORT

我怎样才能通过Jest实现这一目标？我可以process.env在每次测试之前设置这些变量,还是应该以某种方式模拟它？

Answer 1

Jest'ssetupFiles是处理这个问题的正确方法，你不需要安装dotenv，也不需要使用任何.env文件来使它工作。

jest.config.js：

module.exports = {
  setupFiles: ["<rootDir>/.jest/setEnvVars.js"]
};

.jest/setEnvVars.js：

process.env.MY_CUSTOM_TEST_ENV_VAR = 'foo'

就是这样。

Answer 2

我这样做的方式可以在这个SO问题中找到.

在每次测试之前重置模块然后在测试中动态导入模块是很重要的:

describe('environmental variables', () => {
  const OLD_ENV = process.env;

  beforeEach(() => {
    jest.resetModules() // this is important - it clears the cache
    process.env = { ...OLD_ENV };
    delete process.env.NODE_ENV;
  });

  afterEach(() => {
    process.env = OLD_ENV;
  });

  test('will receive process.env variables', () => {
    // set the variables
    process.env.NODE_ENV = 'dev';
    process.env.PROXY_PREFIX = '/new-prefix/';
    process.env.API_URL = 'https://new-api.com/';
    process.env.APP_PORT = '7080';
    process.env.USE_PROXY = 'false';

    const testedModule = require('../../config/env').default

    // ... actual testing
  });
});

Answer 3

另一种选择是jest.config.js在module.exports定义后将其添加到文件中：

process.env = Object.assign(process.env, {
  VAR_NAME: 'varValue',
  VAR_NAME_2: 'varValue2'
});

这样就不需要在每个.spec文件中定义环境变量，它们可以全局调整。

Answer 4

在./package.json：

"jest": {
  "setupFiles": [
    "<rootDir>/jest/setEnvVars.js"
  ]
}

在./jest/setEnvVars.js：

process.env.SOME_VAR = 'value';

Answer 5

在测试文件中：

const APP_PORT = process.env.APP_PORT || 8080;

在测试脚本中./package.json：

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

在./env：

APP_PORT=8080

Answer 6

您可以使用setupFiles笑话配置功能。正如文档所说，

运行一些代码以配置或设置测试环境的模块的路径列表。每个setupFile将对每个测试文件运行一次。由于每个测试都在自己的环境中运行，因此这些脚本将在执行测试代码本身之前立即在测试环境中执行。

1. npm install dotenv 用于访问env变量的dotenv。
2. 将.env文件创建到应用程序的根目录，并将此行添加到其中。

#.env
APP_PORT=8080

3. 创建您的自定义模块文件，其名称为someModuleForTest.js并将此行添加到其中。

//someModuleForTest.js
require("dotenv").config()

4. jest.config.js像这样更新文件

module.exports = {
  setupFiles: ["./someModuleForTest"]
}

5. 您可以在所有测试块中访问env的变量。

test("Some test name", () => {
  expect(process.env.APP_PORT).toBe("8080")
})

Answer 7

根据组织代码的方式，另一种选择是将环境变量放在运行时执行的函数中。

在此文件中，环境变量是在导入时设置的，并且需要动态require来测试不同的环境变量（如本答案中所述）：

const env = process.env.MY_ENV_VAR;

const envMessage = () => `MY_ENV_VAR is set to ${env}!`;

export default myModule;

在此文件中，环境变量在执行时设置envMessage，您应该能够在测试中直接更改 process.env：

const envMessage = () => {
  const env = process.env.MY_VAR;
  return `MY_ENV_VAR is set to ${env}!`;
}

export default myModule;

开玩笑测试：

const vals = [
  'ONE',
  'TWO',
  'THREE',
];

vals.forEach((val) => {
  it(`Returns the correct string for each ${val} value`, () => {
    process.env.MY_VAR = val;

    expect(envMessage()).toEqual(...

Answer 8

在我看来，如果您将环境变量的检索提取到一个实用程序中，它会更清晰、更容易理解（如果无论如何都没有设置环境变量，您可能希望包括一个快速失败的检查），然后您可以模拟公用事业。

// util.js
exports.getEnv = (key) => {
    const value = process.env[key];
    if (value === undefined) {
      throw new Error(`Missing required environment variable ${key}`);
    }
    return value;
};

// app.test.js
const util = require('./util');
jest.mock('./util');

util.getEnv.mockImplementation(key => `fake-${key}`);

test('test', () => {...});

Answer 9

稍微扩展一下Serhan C. 的回答......

根据博客文章How to Setup dotenv with Jest Testing - In-depth Explanation，您可以"dotenv/config"直接包含在 中setupFiles，而无需创建和引用调用require("dotenv").config().

即，简单地做

module.exports = {
    setupFiles: ["dotenv/config"]
}

Answer 10

你可以将其导入到 jest.config.js 中

require('dotenv').config()

这对我有用

Answer 11

要基于 @HenryTipantu\xc3\xb1a 的建议，在 jest.config.js 中导入 dotenv 并在配置路径中使用 .env.test 文件

\n

require('dotenv').config({\n  path: '.env.test'\n})\n

\n