javascript - 如何使用 Jest 测试同一个类中的方法调用？

Question

我正在尝试测试类内部的函数调用，以确保它们被调用，但我似乎不知道如何使用 Jest 来做到这一点。

自动模拟不起作用，使用模块工厂参数调用 jest.mock 也不起作用。

这是有问题的类，我想测试调用 play() 是否会调用 playSoundFile()。

class SoundPlayer {
  constructor() {
    this.foo = 'bar';
  }

  playSoundFile(fileName) {
    console.log('Playing sound file ' + fileName);
  }

  play() {
    this.playSoundFile('song.mp3');
  }
}

module.exports = SoundPlayer;

这是测试文件:

const SoundPlayer = require('../sound-player');
jest.mock('../sound-player');

it('test', () => {
  const soundPlayerConsumer = new SoundPlayer();

  const coolSoundFileName = 'song.mp3';
  soundPlayerConsumer.play();

  const mockPlaySoundFile = SoundPlayer.mock.instances[0].playSoundFile;
  expect(mockPlaySoundFile.mock.calls[0][0]).toEqual(coolSoundFileName);
});

mockPlaySoundFile.mock.calls 为空，因此出错。

Answer 1

我建议你不要模拟任何内部方法。相反，您可以模拟任何外部依赖项并调用应该是公共(public)的方法。然后，您针对公共(public)(应该在外部调用)方法返回的内容运行断言，并检查模拟(模拟的外部依赖项)是否被调用。

在这个特定的例子中只有 console.log :

console.log = jest.fn();
const soundPlayerConsumer = new SoundPlayer();
soundPlayerConsumer.play();
expect(console.log).toHaveBeenCalledTimes(1);
expect(console.log).toHaveBeenCalledWith('Playing sound file song.mp3');

在更真实的场景中，可能需要您模拟 document甚至使用 jsdom mock <audio /> HTML 元素。但方法是一样的。