如何使用 Jest 模拟日期对象？

Question

我正在处理一个测试用例，我需要比较期望块中的日期字段（creation_time 和 last_attempt_time）。有时它会由于日期更改中的毫秒值而失败。所以我需要模拟一个日期对象，它应该返回指定的日期，并且它应该用于所有测试用例模块，只要在项目的测试用例中使用 Date 对象。

// sample.test.ts

it('should return an reset object', () => {

    // Preparing
    const updatedChangeRequest: any = {
        creation_time: new Date(),
        attempts: 0,
        last_attempt_time: new Date()
    };

    // Executing
    const result = ClassName.methodName();

    // Verifying
    expect(result).toEqual(updatedChangeRequest);
});

Answer 1

这里有几个选项。例如，您可以重新分配整个 Date 对象并将其替换为模拟实现或覆盖单个方法（然后在运行测试用例后恢复它们）。但是已经有 a module called mockdate in npm 了。

使用模拟日期，您可以：

const MockDate = require('mockdate');

it('should return an reset object', () => {       
    MockDate.set(Date.now()); // sets now to Date.now()

    // Preparing
    const updatedChangeRequest: any = {
        creation_time: new Date(),
        attempts: 0,
        last_attempt_time: new Date()
    };
    // Executing
    const result = ClassName.methodName();
    // Verifying
    expect(result).toEqual(updatedChangeRequest);

    MockDate.reset();
});

要在所有测试文件中模拟 Date，您可以在您的 jest 配置文件中设置 setupFilesAfterEnv：

// jest.config.js
{
  // ...
  setupFilesAfterEnv: [
    "./mockdate.js"
  ]
}

// mockdate.js
const MockDate = require('mockdate');

beforeAll(() => {
  MockDate.set(Date.now());
});

afterAll(() => {
  MockDate.reset();
});

要确认它是否有效，您可以运行以下测试：

// mockdate.test.js

test('It Should always return the same value for Date.now()', async () => {
  const before = Date.now();
  await new Promise((resolve, reject) => setTimeout(resolve, 1000));
  const after = Date.now();
  expect(before).toEqual(after);
});