kiểm tra process.env với Jest

Tôi có một ứng dụng phụ thuộc vào các biến môi trường như:

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

và tôi muốn kiểm tra điều đó, ví dụ:

• APP_PORT có thể được đặt bởi biến env của nút.
• hoặc một expressứng dụng đang chạy trên cổng được đặt vớiprocess.env.APP_PORT

Làm thế nào tôi có thể đạt được điều này với Jest? Tôi có thể đặt các process.envbiến này trước mỗi bài kiểm tra hay tôi nên giả lập nó bằng cách nào đó?

Cách tôi đã làm có thể được tìm thấy trong câu hỏi SO này .

Điều quan trọng là phải đặt lại Mô-đun trước mỗi thử nghiệm và sau đó nhập động mô-đun bên trong thử nghiệm:

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

  beforeEach(() => {
    jest.resetModules() // most important - it clears the cache
    process.env = { ...OLD_ENV }; // make a copy
  });

  afterAll(() => {
    process.env = OLD_ENV; // restore 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
  });
});

Nếu bạn đang tìm cách tải các giá trị env trước khi chạy Jest, hãy tìm câu trả lời bên dưới . Bạn nên sử dụng setupFiles cho điều đó.

Jest's setupFileslà cách thích hợp để xử lý vấn đề này và bạn không cần cài đặt dotenvhay sử dụng .envtệp nào cả để làm cho nó hoạt động.

jest.config.js:

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

.jest/setEnvVars.js:

process.env.MY_CUSTOM_TEST_ENV_VAR = 'foo'

Đó là nó.

Trong ./package.json:

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

Trong ./jest/setEnvVars.js:

process.env.SOME_VAR = 'value';

Bạn có thể sử dụng setupFilestính năng của jest config. Như tài liệu đã nói rằng,

Danh sách các đường dẫn đến các mô-đun chạy một số mã để cấu hình hoặc thiết lập môi trường thử nghiệm. Mỗi tệp setupFile sẽ được chạy một lần cho mỗi tệp thử nghiệm. Vì mọi thử nghiệm đều chạy trong môi trường riêng của nó, các tập lệnh này sẽ được thực thi trong môi trường thử nghiệm ngay lập tức trước khi tự thực thi mã thử nghiệm.

1. npm install dotenv dotenv sử dụng để truy cập biến env.
2. Tạo .envtệp của bạn vào thư mục gốc của ứng dụng và thêm dòng này vào đó.

#.env
APP_PORT=8080

3. Tạo tệp mô-đun tùy chỉnh của bạn với tên Nó là someModuleForTest.js và thêm dòng này vào đó.

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

4. Cập nhật jest.config.jstệp của bạn như thế này

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

5. Bạn có thể truy cập biến env trong tất cả các khối thử nghiệm.

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

Một tùy chọn khác là thêm nó vào jest.config.jstệp sau module.exportsđịnh nghĩa:

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

Bằng cách này, không cần thiết phải xác định các ENVbiến trong mỗi .spectệp và chúng có thể được điều chỉnh trên toàn cầu.

Tùy thuộc vào cách bạn có thể tổ chức mã của mình, một tùy chọn khác có thể là đặt biến env trong một hàm được thực thi trong thời gian chạy.

Trong tệp này, env var được đặt tại thời điểm nhập và yêu cầu các động requiređể kiểm tra các env vars khác nhau (như được mô tả trong câu trả lời này ):

const env = process.env.MY_ENV_VAR;

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

export default myModule;

Trong tệp này, env var được đặt tại envMessagethời điểm thực thi và bạn có thể thay đổi process.env trực tiếp trong các thử nghiệm của mình:

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

export default myModule;

Thử nghiệm Jest:

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(...

Mở rộng một chút về câu trả lời của Serhan C. ( https: //stackoverflow.com/a/57944454/2708174 ) ...

theo blog này https://tekloon.dev/using-dotenv-with-jest, bạn có thể đưa "dotenv/config"trực tiếp vào setupFilesmà không cần phải tạo và tham chiếu một tập lệnh bên ngoài gọi require("dotenv").config().

tức là, chỉ cần làm

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

Tôi nghĩ bạn cũng có thể thử điều này:

const currentEnv = process.env;
process.env = { ENV_NODE: 'whatever' };

// test code...

process.env = currentEnv;

Điều này phù hợp với tôi và bạn không cần những thứ mô-đun

Theo ý kiến ​​của tôi, sẽ rõ ràng và dễ hiểu hơn nhiều nếu bạn trích xuất việc truy xuất các biến môi trường vào một tiện ích (có thể bạn muốn bao gồm một kiểm tra để thất bại nhanh chóng nếu một biến môi trường không được thiết lập), sau đó bạn có thể giả lập sử dụng .

// 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', () => {...});