Блог

Я хотел бы издеваться над node Stripe SDK в Jest, потому что я не хочу запускать макет сервера API из Stripe, но я не могу понять, как это сделать. Я создаю __mocks__ каталог и добавляю stripe.js , но не могу получить ничего полезного для экспорта.

Обычно я получаю TypeError: Cannot read property 'create' of undefined при вызове strypegw.charges.create() . Я использую синтаксис модуля ES6, поэтому я import stripe from 'stripe' .

 // your-code.js
const stripe = require('stripe')('key');
const customer = await stripe.customers.create({
    ...
});

// __mocks__/stripe.js
class Stripe {}
const stripe = jest.fn(() => new Stripe());

module.exports = stripe;
module.exports.Stripe = Stripe;

// stripe.tests.js
const { Stripe } = require('stripe');
const createCustomerMock = jest.fn(() => ({
    id: 1,
    ...
}));
Stripe.prototype.customers = {
    create: createCustomerMock,
};
  

Вот простое решение :

 jest.mock("stripe", () => {
  return jest.fn().mockImplementation(function {
    return {
      charges: {
        create: () => "fake stripe response",
      },
    };
  });
});
  

Я нашел это в документации jest о макетах класса ES6

Добавьте это во вспомогательную функцию и при необходимости вызовите ее в файле настройки jest или в верхней части теста.

 // Mocking Stripe object
  const elementMock = {
    mount: jest.fn(),
    destroy: jest.fn(),
    on: jest.fn(),
    update: jest.fn(),
  };

  const elementsMock = {
    create: jest.fn().mockReturnValue(elementMock),
  };

  const stripeMock = {
    elements: jest.fn().mockReturnValue(elementsMock),
    createToken: jest.fn(() => Promise.resolve()),
    createSource: jest.fn(() => Promise.resolve()),
  };

  // Set the global Stripe
  window.Stripe = jest.fn().mockReturnValue(stripeMock);
  

При таком подходе вы также можете легко протестировать свой код, связанный с stripe

 // Ex. of a token successfully created mock
  stripeMock.createToken.mockResolvedValue({
    token: {
      id: 'test_id',
    },
  });

  // Ex. of a failure mock
  stripeMock.createToken.mockResolvedValue({
    error: {
      code: 'incomplete_number',
      message: 'Your card number is incomplete.',
      type: 'validation_error',
    },
  });
  

Начиная с stripe@9.6.0 , вы можете добавить direct spyOn в Customer класс вместо переопределения всего класса Stripe.

Короткий ответ:

 jest.mock('stripe', () => {
  const stripe = jest.requireActual('stripe');
  jest.spyOn(stripe.resources.Customers.prototype, 'create')
    .mockImplementation(() => (
      Promise.resolve({id: 'stripe-test-id'})
    ));
  return stripe;
})
  

Длинный ответ:

1. Вы не хотите переопределять класс main Stripe , потому что существует множество статических значений и служебных помощников, которые может использовать ваше приложение, таких как Stripe.errors.StripeError . Было бы излишним издеваться над вещами, которые не нуждаются в издевательстве.
2. Причина, по которой Stripe.prototype.customer не работает, потому что .customer это не метод до создания экземпляра. Смотрите https://github.com/stripe/stripe-node/blob/master/lib/stripe.js#L124
3. К счастью, Stripe предоставляет свои ресурсы статически через Stripe.resources . Таким образом, вы можете напрямую следить за ресурсами. Когда создается экземпляр реального Stripe, он будет ссылаться на spies вместо реального класса для конкретного ресурса, который вы пытаетесь имитировать. Смотрите https://github.com/stripe/stripe-node/blob/master/lib/stripe.js#L51
4. Быстрый и грязный способ издеваться над целым ресурсом — переопределить ссылки на ресурсы следующим образом: Stripe.resources.Customers = {create: jest.fn()}; . Я бы не рекомендовал этого по причинам, указанным в пункте 1.