test process.env กับ Jest

ฉันมีแอปที่ขึ้นอยู่กับตัวแปรด้านสิ่งแวดล้อมเช่น:

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

และฉันต้องการทดสอบตัวอย่างเช่น:

• APP_PORT สามารถตั้งค่าได้โดยตัวแปร node env
• หรือexpressแอปที่กำลังทำงานบนพอร์ตที่ตั้งค่าด้วยprocess.env.APP_PORT

ฉันจะบรรลุเป้าหมายนี้ด้วย Jest ได้อย่างไร? ฉันสามารถตั้งค่าprocess.envตัวแปรเหล่านี้ก่อนการทดสอบแต่ละครั้งได้หรือไม่หรือฉันควรล้อเลียนมันบ้าง

วิธีที่ฉันทำสามารถพบได้ในคำถาม SOนี้

สิ่งสำคัญคือต้องรีเซ็ตโมดูลก่อนการทดสอบแต่ละครั้งจากนั้นจึงนำเข้าโมดูลภายในการทดสอบแบบไดนามิก:

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
  });
});

ถ้าคุณมองหาวิธีที่จะโหลดค่า env ก่อนที่จะใช้รูปลักษณ์เจ็ทสำหรับคำตอบด้านล่าง คุณควรใช้setupFilesสำหรับสิ่งนั้น

Jest setupFilesเป็นวิธีที่เหมาะสมในการจัดการสิ่งนี้และคุณไม่จำเป็นต้องติดตั้งdotenvหรือใช้.envไฟล์เลยเพื่อให้มันใช้งานได้

jest.config.js:

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

.jest/setEnvVars.js:

process.env.MY_CUSTOM_TEST_ENV_VAR = 'foo'

แค่นั้นแหละ.

ใน./package.json:

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

ใน./jest/setEnvVars.js:

process.env.SOME_VAR = 'value';

คุณสามารถใช้setupFilesคุณสมบัติของ jest config ตามที่เอกสารกล่าวไว้ว่า

รายการเส้นทางไปยังโมดูลที่รันโค้ดเพื่อกำหนดค่าหรือตั้งค่าสภาพแวดล้อมการทดสอบ ไฟล์ setupFile แต่ละไฟล์จะถูกเรียกใช้หนึ่งครั้งต่อไฟล์ทดสอบ เนื่องจากการทดสอบทุกครั้งทำงานในสภาพแวดล้อมของตัวเองสคริปต์เหล่านี้จะถูกดำเนินการในสภาพแวดล้อมการทดสอบทันทีก่อนที่จะเรียกใช้โค้ดทดสอบเอง

1. npm install dotenv dotenv ที่ใช้เพื่อเข้าถึงตัวแปร env
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")
})

อีกทางเลือกหนึ่งคือเพิ่มลงในjest.config.jsไฟล์หลังmodule.exportsคำจำกัดความ:

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

วิธีนี้ไม่จำเป็นต้องกำหนดENVตัวแปรในแต่ละ.specไฟล์และสามารถปรับเปลี่ยนได้ทั่วโลก

ขึ้นอยู่กับวิธีการจัดระเบียบโค้ดของคุณตัวเลือกอื่นสามารถใส่ตัวแปร env ภายในฟังก์ชันที่เรียกใช้ในรันไทม์

ในไฟล์นี้ env var ถูกตั้งค่าในเวลานำเข้าและต้องใช้ไดนามิกrequireเพื่อทดสอบ env vars ที่แตกต่างกัน (ตามที่อธิบายไว้ในคำตอบนี้ ):

const env = process.env.MY_ENV_VAR;

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

export default myModule;

ในไฟล์นี้ env var ถูกตั้งค่าในenvMessageเวลาดำเนินการและคุณควรจะสามารถกลายพันธุ์ process.env ได้โดยตรงในการทดสอบของคุณ:

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

export default myModule;

การทดสอบ 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(...

ขยายความอีกเล็กน้อยเกี่ยวกับคำตอบของ Serhan C. ( https://stackoverflow.com/a/57944454/2708174 ) ...

ตามบล็อกนี้https://tekloon.dev/using-dotenv-with-jest คุณสามารถรวม"dotenv/config"เข้าโดยตรงsetupFilesโดยไม่ต้องสร้างและอ้างอิงสคริปต์ภายนอกที่เรียกrequire("dotenv").config()ใช้

กล่าวคือเพียงแค่ทำ

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

ฉันคิดว่าคุณสามารถลองสิ่งนี้ได้เช่นกัน:

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

// test code...

process.env = currentEnv;

สิ่งนี้ใช้ได้กับฉันและคุณไม่จำเป็นต้องมีโมดูล

ในความคิดของฉันมันสะอาดและเข้าใจง่ายกว่ามากถ้าคุณดึงการดึงตัวแปรสภาพแวดล้อมลงในยูทิล (คุณอาจต้องการรวมการตรวจสอบเพื่อล้มเหลวอย่างรวดเร็วหากยังไม่ได้ตั้งค่าตัวแปรสภาพแวดล้อม) จากนั้นคุณสามารถเยาะเย้ย util ได้ .

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