Как установить фиктивную дату в Jest?

Я использую moment.js для выполнения большей части моей логики дат во вспомогательном файле для моих компонентов React, но я не смог понять, как имитировать дату в Jest a la sinon.useFakeTimers().

Документы Jest говорят только о функциях таймера, таких как setTimeoutи setIntervalт. Д., Но не помогают с установкой даты и последующей проверкой того, что мои функции даты выполняют то, что они должны делать.

Вот некоторые из моих файлов JS:

var moment = require('moment');

var DateHelper = {

  DATE_FORMAT: 'MMMM D',
  API_DATE_FORMAT: 'YYYY-MM-DD',

  formatDate: function(date) {
    return date.format(this.DATE_FORMAT);
  },

  isDateToday: function(date) {
    return this.formatDate(date) === this.formatDate(moment());
  }
};

module.exports = DateHelper;

и вот что я установил с помощью Jest:

jest.dontMock('../../../dashboard/calendar/date-helper')
    .dontMock('moment');

describe('DateHelper', function() {
  var DateHelper = require('../../../dashboard/calendar/date-helper'),
      moment = require('moment'),
      DATE_FORMAT = 'MMMM D';

  describe('formatDate', function() {

    it('should return the date formatted as DATE_FORMAT', function() {
      var unformattedDate = moment('2014-05-12T00:00:00.000Z'),
          formattedDate = DateHelper.formatDate(unformattedDate);

      expect(formattedDate).toEqual('May 12');
    });

  });

  describe('isDateToday', function() {

    it('should return true if the passed in date is today', function() {
      var today = moment();

      expect(DateHelper.isDateToday(today)).toEqual(true);
    });

  });

});

Теперь эти тесты проходят, потому что я использую момент, а мои функции используют момент, но он кажется немного нестабильным, и я хотел бы установить дату на фиксированное время для тестов.

Есть идеи, как это можно сделать?

MockDate можно использовать в тестах шутки, чтобы изменить то, что new Date()возвращает:

var MockDate = require('mockdate');
// I use a timestamp to make sure the date stays fixed to the ms
MockDate.set(1434319925275);
// test code here
// reset to native Date()
MockDate.reset();

Поскольку momentjs используется Dateвнутри, вы можете просто перезаписать Date.nowфункцию, чтобы всегда возвращать один и тот же момент.

Date.now = jest.fn(() => 1487076708000) //14.02.2017

или

Date.now = jest.fn(() => new Date(Date.UTC(2017, 1, 14)).valueOf())

jest.spyOn работает для блокировки времени:

let dateNowSpy;

beforeAll(() => {
    // Lock Time
    dateNowSpy = jest.spyOn(Date, 'now').mockImplementation(() => 1487076708000);
});

afterAll(() => {
    // Unlock Time
    dateNowSpy.mockRestore();
});

jest-date-mock - это полный модуль javascript, написанный мной, и он используется для тестирования Date на jest.

import { advanceBy, advanceTo } from 'jest-date-mock';

test('usage', () => {
  advanceTo(new Date(2018, 5, 27, 0, 0, 0)); // reset to date time.

  const now = Date.now();

  advanceBy(3000); // advance time 3 seconds
  expect(+new Date() - now).toBe(3000);

  advanceBy(-1000); // advance time -1 second
  expect(+new Date() - now).toBe(2000);

  clear();
  Date.now(); // will got current timestamp
});

Используйте только 3 api для тестовых случаев.

• advanceBy (мс): предварительная отметка времени даты на мс.
• advanceTo ([timestamp]): сбросить дату на временную метку, по умолчанию - 0.
• clear (): выключить фиктивную систему.

Для тех, кто хочет имитировать методы нового объекта Date, вы можете сделать следующее:

beforeEach(() => {
    jest.spyOn(Date.prototype, 'getDay').mockReturnValue(2);
    jest.spyOn(Date.prototype, 'toISOString').mockReturnValue('2000-01-01T00:00:00.000Z');
});

afterEach(() => {
    jest.restoreAll()
});

Все ответы, основанные только на имитации Date.now(), не будут работать везде, поскольку вместо этого moment.jsиспользуются некоторые пакеты (например ) new Date().

В этом контексте ответ, на MockDateмой взгляд, является единственно правильным. Если вы не хотите использовать внешний пакет, вы можете написать прямо в своем beforeAll:

  const DATE_TO_USE = new Date('2017-02-02T12:54:59.218Z');
  // eslint-disable-next-line no-underscore-dangle
  const _Date = Date;
  const MockDate = (...args) => {
    switch (args.length) {
      case 0:
        return DATE_TO_USE;
      default:
        return new _Date(...args);
    }
  };
  MockDate.UTC = _Date.UTC;
  MockDate.now = () => DATE_TO_USE.getTime();
  MockDate.parse = _Date.parse;
  MockDate.toString = _Date.toString;
  MockDate.prototype = _Date.prototype;
  global.Date = MockDate;

Хочу предложить несколько альтернативных подходов.

Если вам нужна заглушка format()(которая может зависеть от языка и часового пояса!)

import moment from "moment";
...
jest.mock("moment");
...
const format = jest.fn(() => 'April 11, 2019')
moment.mockReturnValue({ format })

Если вам нужно только заглушить moment():

import moment from "moment";
...
jest.mock("moment");
...
const now = "moment(\"2019-04-11T09:44:57.299\")";
moment.mockReturnValue(now);

Что касается теста для isDateTodayфункции выше, я считаю самым простым способом было бы не издеваться momentвообще

Вот как я издевался над своим Date.now()методом, чтобы установить год на 2010 для моего теста

jest
  .spyOn(global.Date, 'now')
  .mockImplementationOnce(() => new Date(`2010`).valueOf());

Вот несколько удобочитаемых способов для разных случаев использования. Я предпочитаю использовать шпионов, а не сохранять ссылки на исходные объекты, которые могут быть случайно перезаписаны в другом коде.

Одноразовое издевательство

jest
  .spyOn(global.Date, 'now')
  .mockImplementationOnce(() => Date.parse('2020-02-14'));

Несколько тестов

let dateSpy;

beforeAll(() => {
  dateSpy = jest
    .spyOn(global.Date, 'now')
    .mockImplementation(() => Date.parse('2020-02-14'));
});

afterAll(() => {
  dateSpy.mockRestore();
});

Начиная с Jest 26, этого можно добиться с помощью «современных» поддельных таймеров без необходимости установки каких-либо сторонних модулей: https://jestjs.io/blog/2020/05/05/jest-26#new-fake-timers

jest
  .useFakeTimers('modern')
  .setSystemTime(new Date('2020-01-01').getTime());

Я бы хотел использовать ручные макеты, чтобы их можно было использовать во всех тестах.

// <rootDir>/__mocks__/moment.js
const moment = jest.requireActual('moment')

Date.now = jest.fn(() => 1558281600000) // 2019-05-20 00:00:00.000+08:00

module.exports = moment

Цель состоит в том, чтобы имитировать new Date () с фиксированной датой, где бы она ни использовалась во время рендеринга компонента в тестовых целях. Использование библиотек будет накладными расходами, если единственное, что вам нужно, - это имитировать new Date () fn.

Идея состоит в том, чтобы сохранить глобальную дату в переменной temp, имитировать глобальный dae, а затем после использования переназначить temp на глобальную дату.

export const stubbifyDate = (mockedDate: Date) => {
    /**
     * Set Date to a new Variable
     */
    const MockedRealDate = global.Date;

    /**
     *  Mock Real date with the date passed from the test
     */
    (global.Date as any) = class extends MockedRealDate {
        constructor() {
            super()
            return new MockedRealDate(mockedDate)
        }
    }

    /**
     * Reset global.Date to original Date (MockedRealDate) after every test
     */
    afterEach(() => {
        global.Date = MockedRealDate
    })
}

Usage in your test would be like

import { stubbyifyDate } from './AboveMethodImplementedFile'

describe('<YourComponent />', () => {
    it('renders and matches snapshot', () => {
        const date = new Date('2019-02-18')
        stubbifyDate(date)

        const component = renderer.create(
            <YourComponent data={}/>
        );
        const tree = component.toJSON();
        expect(tree).toMatchSnapshot();
    });
});

Я просто хотел вмешаться, потому что не было ответа на этот вопрос, если вы хотите издеваться над Date объектом только в определенном наборе.

Вы можете смоделировать это, используя методы настройки и разборки для каждого набора, jest docs

/**
 * Mocking Date for this test suite
 */
const globalDate = Date;

beforeAll(() => {
  // Mocked Date: 2020-01-08
  Date.now = jest.fn(() => new Date(Date.UTC(2020, 0, 8)).valueOf());
});

afterAll(() => {
  global.Date = globalDate;
});

Надеюсь это поможет!

Вы можете использовать фейкер даты . Позволяет изменить текущую дату относительно:

import { dateFaker } from 'date-faker';
// or require if you wish: var { dateFaker } = require('date-faker');

// make current date to be tomorrow
dateFaker.add(1, 'day'); // 'year' | 'month' | 'day' | 'hour' | 'minute' | 'second' | 'millisecond'.

// change using many units
dateFaker.add({ year: 1, month: -2, day: 3 });

// set specific date, type: Date or string
dateFaker.set('2019/01/24');

// reset
dateFaker.reset();