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

ES6类模拟

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

ES6类是带有一些句法糖的构造函数。因此,ES6类的任何模型必须是函数或实际的ES6类(这是再次,另一个功能)。所以你可以使用它们模拟功能

ES6类示例

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

// sound-player.js
出口 默认 班级 SoundPlayer. {
构造函数 {
这个 Foo = '酒吧' ;
}
playsoundfile. 文件名 {
安慰 日志 '玩声音文件' + 文件名 ;
}
}
// sound-player-confiecer.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. 笨拙 ;
} ;
“我们可以检查消费者是否称为类构造函数' => {
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. 模仿 => {
返回 { playsoundfile. 模仿oundfile. } ;
} ;
出口 默认 嘲笑 ;

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

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

打电话jest.mock()使用模块出厂参数

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

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

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

与工厂参数的限制是这样,因为呼叫jest.mock()已挂起到文件的顶部,因此不可能首先定义变量,然后在工厂使用它。对于从“Mock”一词开始的变量进行了例外。由您来保证他们将按时初始化!例如,由于使用“假”而不是“变量声明”而不是“Mock”,以下将抛出范围超出错误:

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

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

您可以通过呼叫来替换所有上述模块以更改单个测试或所有测试的实现模仿()在现有的模拟上。

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

进口 SoundPlayer. './sound-player' ;
进口 SoundPlayerConsumer. './sound-player-consumer' ;
笑话 嘲笑 './sound-player' ;
描述 '当SoundPlayer抛出错误时' => {
Beforeall. => {
SoundPlayer. 模仿 => {
返回 {
playsoundfile. => {
新的 错误 '测试错误' ;
}
} ;
} ;
} ;
'打电话给PlaysometionCooh时应抛出错误' => {
const SoundPlayerConsumer. = 新的 SoundPlayerConsumer. ;
预计 => SoundPlayerConsumer. Playsometingcool. tothrow. ;
} ;
} ;

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

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

手动模拟是另一个ES6类

如果使用与映射类相同的文件名定义ES6类__mocks__文件夹,它将作为模拟。此类将用于代替真实类。这允许您对类注入测试实现,但不提供呼叫中谍的方法。

对于创意的示例,模拟可能如下所示:

// __mocks __ / sound-player.js
出口 默认 班级 SoundPlayer. {
构造函数 {
安慰 日志 '模拟SoundPlayer:构造函数被称为' ;
}
playsoundfile. {
安慰 日志 '模拟SoundPlayer:PlaySoundFile被称为' ;
}
}

模块使用模块出厂参数

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

*模块出厂功能必须返回函数

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

笑话 嘲笑 './sound-player' => {
返回 功能 {
返回 { playsoundfile. => { } } ;
} ;
} ;

注意:箭头函数不起作用

请注意,模拟不能是箭头函数,因为调用新的在JavaScript中不允许在箭头函数上。所以这不起作用:

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

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

跟踪用法轨道(在模拟中窥探)

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

窥探构造函数

为了跟踪对构造函数的调用,替换Hof返回的函数与Jest模拟功能。创建它jest.fn(),然后指定其实现模仿()

进口 SoundPlayer. './sound-player' ;
笑话 嘲笑 './sound-player' => {
//工作并允许您检查构造函数调用:
返回 笑话 FN. 模仿 => {
返回 { playsoundfile. => { } } ;
} ;
} ;

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

嘲笑非默认类出口

如果类是不是从模块中导出的默认导出,那么您需要将对象返回与类导出名称相同的键。

进口 { SoundPlayer. } './sound-player' ;
笑话 嘲笑 './sound-player' => {
//工作并允许您检查构造函数调用:
返回 {
SoundPlayer. 笑话 FN. 模仿 => {
返回 { playsoundfile. => { } } ;
}
} ;
} ;

窥探我们班级的方法

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

每次测试期间调用Mock构造函数函数时,将创建一个新对象。我们填充了所有这些对象的方法调用playsoundfile.使用另一个模拟功能,并在测试文件中存储对同一模拟功能的引用,因此在测试期间可用。

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

手动模拟相当于这将是:

// __mocks __ / sound-player.js
//将此命名导出导入测试文件
出口 const 模仿oundfile. = 笑话 FN. ;
const 嘲笑 = 笑话 FN. 模仿 => {
返回 { playsoundfile. 模仿oundfile. } ;
} ;
出口 默认 嘲笑 ;

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

在测试之间清理

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

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

完整的例子

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

// sound-player-configer.test.js
进口 SoundPlayer. './sound-player' ;
进口 SoundPlayerConsumer. './sound-player-consumer' ;
const 模仿oundfile. = 笑话 FN. ;
笑话 嘲笑 './sound-player' => {
返回 笑话 FN. 模仿 => {
返回 { playsoundfile. 模仿oundfile. } ;
} ;
} ;
摘要 => {
SoundPlayer. 笨拙 ;
模仿oundfile. 笨拙 ;
} ;
“消费者应该能够在SoundPlayer上调用新() => {
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. ;
} ;
上次更新了经过SébastienLorber.