跳到主要内容
版本:26.x.

ES6类模拟

Jest可用于将导入的ES6类模拟到要测试的文件中。

ES6类是带有一些语法糖的构造函数。因此,ES6类的任何模拟必须是一个函数或实际的ES6类(同样是另一个函数)。所以你可以用模拟功能

一个ES6类示例

我们将使用播放声音文件的类的创新示例,SoundPlayer.以及使用该类的消费类,SoundPlayerConsumer。我们将模拟SoundPlayer.在我们的测试中SoundPlayerConsumer

// sound-player.js
出口 默认 班级 SoundPlayer. {
构造函数 {
Foo = “酒吧” ;
}
playSoundFile 文件名 {
控制台 日志 '玩声音文件' + 文件名 ;
}
}
/ / sound-player-consumer.js
进口 SoundPlayer. './sound-player' ;
出口 默认 班级 SoundPlayerConsumer {
构造函数 {
soundPlayer = SoundPlayer. ;
}
Playsometingcool. {
const coolSoundFileName = “song.mp3” ;
soundPlayer playSoundFile coolSoundFileName ;
}
}

创建ES6类模拟的4种方法

自动模拟

调用jest.mock('./ sound-player')返回一个有用的“自动模拟”,您可以使用对Class构造函数和所有方法的调用来窥探。它用模拟构造函数替换ES6类,并用其替换其所有方法模拟功能总是返回未定义的。方法调用保存在theautomaticmock.mock.instances [index] .methodname.mock.calls

请注意,如果您在课程中使用箭头函数,则会不是成为模拟的一部分。因此,对象的原型上不存在箭头函数,它们仅仅是对功能的引用的属性。

如果您不需要替换该类的实现,这是设置设置的最简单选择。Наприклад:

进口 SoundPlayer. './sound-player' ;
进口 SoundPlayerConsumer './sound-player-consumer' ;
笑话 模拟 './sound-player' ; // SoundPlayer现在是模拟构造函数
摘要 = > {
//清除所有实例并调用构造函数和所有方法:
SoundPlayer. mockClear ;
} ;
我们可以检查消费者是否调用了类构造函数 = > {
const soundPlayerConsumer = SoundPlayerConsumer ;
预计 SoundPlayer. toHaveBeenCalledTimes 1 ;
} ;
“我们可以检查Class实例上的消费者是否称为方法' = > {
//显示MockClear()正在工作:
预计 SoundPlayer. 不是 toHaveBeenCalled ;
const soundPlayerConsumer = SoundPlayerConsumer ;
//构造函数应该被再次调用:
预计 SoundPlayer. toHaveBeenCalledTimes 1 ;
const coolSoundFileName = “song.mp3” ;
soundPlayerConsumer Playsometingcool. ;
// mock.instances可用自动模拟:
const MockSoundPlayerInstance. = SoundPlayer. 模拟 实例 [ 0. ] ;
const 模仿oundfile. = MockSoundPlayerInstance. playSoundFile ;
预计 模仿oundfile. 模拟 呼叫 [ 0. ] [ 0. ] toequal. coolSoundFileName ;
//等价于上面的检查:
预计 模仿oundfile. toHaveBeenCalledWith coolSoundFileName ;
预计 模仿oundfile. toHaveBeenCalledTimes 1 ;
} ;

手动模拟

创建一个人工模拟通过保存模拟实现__mocks__文件夹中。这允许您指定实现,并且它可以跨测试文件使用。

/ / __mocks__ / sound-player.js
//将此命名导出导入到测试文件中:
出口 const 模仿oundfile. = 笑话 FN. ;
const 模拟 = 笑话 FN. mockImplementation = > {
返回 { playSoundFile 模仿oundfile. } ;
} ;
出口 默认 模拟 ;

导入所有实例共享的模拟和模拟方法:

// sound-player-configer.test.js
进口 SoundPlayer. { 模仿oundfile. } './sound-player' ;
进口 SoundPlayerConsumer './sound-player-consumer' ;
笑话 模拟 './sound-player' ; // SoundPlayer现在是模拟构造函数
摘要 = > {
//清除所有实例并调用构造函数和所有方法:
SoundPlayer. mockClear ;
模仿oundfile. mockClear ;
} ;
我们可以检查消费者是否调用了类构造函数 = > {
const soundPlayerConsumer = SoundPlayerConsumer ;
预计 SoundPlayer. toHaveBeenCalledTimes 1 ;
} ;
“我们可以检查Class实例上的消费者是否称为方法' = > {
const soundPlayerConsumer = SoundPlayerConsumer ;
const coolSoundFileName = “song.mp3” ;
soundPlayerConsumer Playsometingcool. ;
预计 模仿oundfile. toHaveBeenCalledWith coolSoundFileName ;
} ;

调用jest.mock ()使用模块工厂参数

jest.mock.(path, moduleFactory)需要一个模块工厂争论。模块工厂是一个返回模拟的函数。

为了模拟构造函数,模块出厂必须返回构造函数。换句话说,模块工厂必须是返回函数的函数 - 一个高阶函数(HOF)。

进口 SoundPlayer. './sound-player' ;
const 模仿oundfile. = 笑话 FN. ;
笑话 模拟 './sound-player' = > {
返回 笑话 FN. mockImplementation = > {
返回 { playSoundFile 模仿oundfile. } ;
} ;
} ;

工厂参数的一个限制是,since调用jest.mock ()被悬挂到文件顶部时,不可能先定义一个变量,然后再在工厂中使用它。以单词“mock”开头的变量会出现异常。由您来保证它们将按时初始化!例如,由于在变量声明中使用了'fake'而不是'mock',下面的语句将抛出一个超出作用域的错误:

//注意:这将失败
进口 SoundPlayer. './sound-player' ;
const fakeplysoundfile. = 笑话 FN. ;
笑话 模拟 './sound-player' = > {
返回 笑话 FN. mockImplementation = > {
返回 { playSoundFile fakeplysoundfile. } ;
} ;
} ;

用mock替换使用模仿()模仿once()

通过调用,可以替换上述所有模拟以更改单个测试或所有测试的实现模仿()在现有的模拟上。

呼叫jest.mock被提升到代码的顶部。您可以在稍后指定模拟,例如:在beforeall(),通过致电模仿()(或者模仿once()),而不是使用factory参数。这还允许您在需要时更改测试之间的模拟:

进口 SoundPlayer. './sound-player' ;
进口 SoundPlayerConsumer './sound-player-consumer' ;
笑话 模拟 './sound-player' ;
描述 '当SoundPlayer抛出错误时' = > {
Beforeall. = > {
SoundPlayer. mockImplementation = > {
返回 {
playSoundFile = > {
错误 测试错误的 ;
}
} ;
} ;
} ;
'调用playSomethingCool时应该抛出错误' = > {
const soundPlayerConsumer = SoundPlayerConsumer ;
预计 = > soundPlayerConsumer Playsometingcool. toThrow ;
} ;
} ;

深入:了解模拟构造函数函数

构建构造函数函数mock使用.mockImplementation jest.fn () ()让模仿看起来比他们真的更复杂。本节展示了如何创建自己的模型,以说明如何嘲弄作品。

手动模拟是另一个ES6类

类中的被模拟类使用相同的文件名来定义ES6类__mocks__文件夹,它将作为模拟。这个类将被用来代替真正的类。这允许您为类注入测试实现,但不提供监视调用的方法。

对于虚构的示例,模拟可能如下所示:

/ / __mocks__ / sound-player.js
出口 默认 班级 SoundPlayer. {
构造函数 {
控制台 日志 " Mock SoundPlayer:构造函数被调用" ;
}
playSoundFile {
控制台 日志 '模拟SoundPlayer:PlaySoundFile被称为' ;
}
}

使用模块工厂参数进行模拟

模块出厂功能传递给jest.mock.(path, moduleFactory)可以是一个返回函数的hof *。这将允许呼叫在模拟上。同样,这允许您注入不同的测试行为进行测试,但不提供侦听呼叫的方法。

*模块工厂函数必须返回一个函数

为了模拟构造函数,模块出厂必须返回构造函数。换句话说,模块工厂必须是返回函数的函数 - 一个高阶函数(HOF)。

笑话 模拟 './sound-player' = > {
返回 函数 {
返回 { playSoundFile = > { } } ;
} ;
} ;

注意:箭头函数不起作用

注意,mock不能是一个箭头函数,因为调用在JavaScript中不允许在箭头函数上。所以这不起作用:

笑话 模拟 './sound-player' = > {
返回 = > {
//不起作用;箭头函数无法用新的函数调用
返回 { playSoundFile = > { } } ;
} ;
} ;

这将抛出typeerror:_soundplayer2.default不是构造函数,除非代码被转移到ES5,例如ES5。经过@ Babel / Preset-Env。(ES5没有箭头函数也没有类,因此两者都将被转发到普通功能。)

跟踪使用情况(监视模拟)

注入一个测试实现是有帮助的,但是您可能还想测试类构造函数和方法是否使用亚搏取款正确的参数调用。

窥探构造函数

为了跟踪对构造函数的调用,用Jest模拟函数替换HOF返回的函数。创建它jest.fn (),然后用模仿()

进口 SoundPlayer. './sound-player' ;
笑话 模拟 './sound-player' = > {
//检查构造函数调用
返回 笑话 FN. mockImplementation = > {
返回 { playSoundFile = > { } } ;
} ;
} ;

这将让我们在使用时检查我们的嘲弄类的用法soundplayer.mock.calls.期望(SoundPlayer) .toHaveBeenCalled ();或接近等同的:期待(soundplayer.mock.calls.length).toequal(1);

嘲笑非默认类出口

如果类是不是然后,您需要返回一个与类导出名称相同的键的对象。

进口 { SoundPlayer. } './sound-player' ;
笑话 模拟 './sound-player' = > {
//检查构造函数调用
返回 {
SoundPlayer. 笑话 FN. mockImplementation = > {
返回 { playSoundFile = > { } } ;
}
} ;
} ;

监视我们班的方法

我们的嘲弄课程需要提供任何成员职能(playSoundFile在该示例中)将在我们的测试期间调用,否则我们将获得错误调用不存在的函数的错误。但我们可能希望在对这些方法的呼叫中窥探,以确保它们被预期的参数调用。

在测试期间每次调用模拟构造函数都会创建一个新对象。为了监视所有这些对象中的方法调用,我们进行了填充playSoundFile使用另一个模拟函数,并在我们的测试文件中存储对该模拟函数的引用,以便在测试期间可用。

进口 SoundPlayer. './sound-player' ;
const 模仿oundfile. = 笑话 FN. ;
笑话 模拟 './sound-player' = > {
返回 笑话 FN. mockImplementation = > {
返回 { playSoundFile 模仿oundfile. } ;
//现在我们可以跟踪playSoundFile的调用
} ;
} ;

与此类似的手动模拟是:

/ / __mocks__ / sound-player.js
//将这个命名的导出导入到您的测试文件
出口 const 模仿oundfile. = 笑话 FN. ;
const 模拟 = 笑话 FN. mockImplementation = > {
返回 { playSoundFile 模仿oundfile. } ;
} ;
出口 默认 模拟 ;

用法与模块出厂函数类似,除了您可以从中省略第二个参数jest.mock (),并且您必须将所模拟的方法导入到您的测试文件中,因为它不再在那里定义了。使用原来的模块路径;不包括__mocks__

在测试之间清理

要清除调用模拟构造函数及其方法的呼叫记录,我们调用MockClear()前提()功能:

摘要 = > {
SoundPlayer. mockClear ;
模仿oundfile. mockClear ;
} ;

完整的示例

这是一个完整的测试文件,它使用模块出厂参数jest.mock.

// sound-player-configer.test.js
进口 SoundPlayer. './sound-player' ;
进口 SoundPlayerConsumer './sound-player-consumer' ;
const 模仿oundfile. = 笑话 FN. ;
笑话 模拟 './sound-player' = > {
返回 笑话 FN. mockImplementation = > {
返回 { playSoundFile 模仿oundfile. } ;
} ;
} ;
摘要 = > {
SoundPlayer. mockClear ;
模仿oundfile. mockClear ;
} ;
消费者应该能够在SoundPlayer上调用new() = > {
const soundPlayerConsumer = SoundPlayerConsumer ;
//确保构造函数创建了对象:
预计 soundPlayerConsumer Tobeththy. ;
} ;
我们可以检查消费者是否调用了类构造函数 = > {
const soundPlayerConsumer = SoundPlayerConsumer ;
预计 SoundPlayer. toHaveBeenCalledTimes 1 ;
} ;
“我们可以检查Class实例上的消费者是否称为方法' = > {
const soundPlayerConsumer = SoundPlayerConsumer ;
const coolSoundFileName = “song.mp3” ;
soundPlayerConsumer Playsometingcool. ;
预计 模仿oundfile. 模拟 呼叫 [ 0. ] [ 0. ] toequal. coolSoundFileName ;
} ;