使用 Jest 测试中的模拟常量：一个实际示例

在单元测试中处理常量值，特别是需要模拟不同环境（例如生产环境和开发环境）的情况，常常会遇到挑战。直接导入的常量难以动态修改，这会影响测试的灵活性和可靠性。本文将演示如何利用Jest有效地模拟常量，从而创建隔离且可靠的测试用例。

我们以一个名为adjustImageQuality的虚构函数为例，该函数根据运行环境（生产或开发）调整图片质量。

实现

constants.js 文件

首先，定义一个常量isProduction，用于标识当前环境：

// constants.js
export const isProduction = false;

adjustImageQuality.js 文件

接下来，实现adjustImageQuality函数：

// adjustImageQuality.js
import { isProduction } from "./constants";

export default function adjustImageQuality(img) {
  if (isProduction) {
    img.quality = 100; // 生产环境，最高质量
  } else {
    img.quality = 50; // 开发环境，较低质量
  }
  return img;
}

测试

我们需要测试adjustImageQuality在生产和开发环境下的行为。

adjustImageQuality.test.js 文件

利用Jest的jest.mock和自定义getter来模拟isProduction常量：

// adjustImageQuality.test.js
import adjustImageQuality from "./adjustImageQuality";

// 模拟isProduction常量
const mockIsProduction = jest.fn();

jest.mock("./constants", () => ({
  __esModule: true, // 确保与ES模块兼容
  get isProduction() {
    return mockIsProduction();
  },
}));

beforeEach(() => {
  mockIsProduction.mockClear(); // 在每个测试之前清除模拟
});

test("在生产环境下将图像质量设置为100", () => {
  mockIsProduction.mockReturnValue(true); // 模拟生产环境
  const img = { quality: 0 };
  const result = adjustImageQuality(img);
  expect(result.quality).toBe(100);
});

test("在开发环境下将图像质量设置为50", () => {
  mockIsProduction.mockReturnValue(false); // 模拟开发环境
  const img = { quality: 0 };
  const result = adjustImageQuality(img);
  expect(result.quality).toBe(50);
});

模拟详解

1. 创建模拟

jest.mock("./constants", ...) 拦截了对constants模块的导入。jest.requireActual("./constants") 获取了原始的导出，并通过一个自定义getter覆盖了isProduction常量。 添加__esModule: true是为了确保与ES模块的兼容性。

2. 模拟isProduction的值

在每个测试用例中，mockIsProduction.mockReturnValue(true/false)分别模拟生产和开发环境。

3. 使用mockClear清理

beforeEach(() => { mockIsProduction.mockClear(); }) 确保在每个测试用例执行前，模拟状态都被重置，避免测试之间的干扰。

结论

这种模拟常量的方法，能够在不修改源代码的情况下，灵活地控制测试环境，提高测试的可靠性和可维护性。 它尤其适用于测试依赖于全局变量、配置或环境变量的代码逻辑。 通过这种方式，我们可以模拟各种复杂的场景，而无需引入额外的依赖或修改代码结构。