Як встановити макетну дату в 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-модуль, який використовується для тестування дати на жарт.

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 для тестових випадків.

• AdvaBy (мс): часова мітка дати дати за допомогою мс.
• 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

Мета - знущатися над новою датою () з фіксованою датою, де б вона не використовувалася під час надання компонентів для тестових цілей. Використання бібліотек буде накладним, якщо єдине, що ви хочете, - це знущатися над новим fn Date ().

Ідея полягає в тому, щоб зберігати глобальну дату до змінної 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об’єктом лише у певному наборі.

Ви можете знущатися над нею, використовуючи методи налаштування та вилучення для кожного пакету, жаке-док

/**
 * 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();