软件测试技术之利用 Jest 为 React 组件编写单元测试
创始人
2024-05-12 09:44:45
0

在本文中我们会具体聊聊如何用 Jest 为 React 组件编写单元测试。

首先我们要明确的一点,那就是 React 组件的单元测试本质是也是单元测试。因此它也符合我们之前介绍过的单元测试的全部特点。唯一不同的地方在于 React 组件的单元测试中我们需要找到合适的方法对执行结果进行断言。换言之,我们要根据 React 的特点来设置代码是否正确执行的判断条件。

那么 React 组件和其它的被测试对象有何不同呢?仔细想过,我们会发现:

React 组件的 render 结果是一个组件树,并且整个树最终会被解析成一个纯粹由 HTML 元素构成的树形结构

React 组件可以拥有 state,且 state 的变化会影响 render 结果

React 组件可以拥有生命周期函数,这些生命周期函数会在特定时间点执行

知道了要测试的内容,接下来的问题就是如何执行一个 React 组件并编写断言了。如何执行一个 React 组件呢?看到这个问题估计大多数儿人是蒙的。平时不就是直接ReactDOM.render 吗?不错,ReactDOM.render 确实可以执行一个 React 组件并将它渲染到页面中,但这种方式不利于编写测试代码。

有没有更简单的方式呢?其实 React 已经帮我们提供好了工具,让我们一起来看看。

React 提供的测试工具

在 React 的官方文档中提到了两个用于测试 React 组件的库。让我们分别介绍。

react-test-renderer

在说 react-test-renderer 之前,让我们先聊聊什么是 renderer。React 最早是被用来开发网页的,所以早期的 React 库中还包含了大量和 DOM 相关的逻辑。后来 React 的设计思想慢慢被迁移到其它场景,最被人们熟知的莫过于 React Native 了。为了灵活性和扩展性,React 的代码被分拆为 React 核心代码与各种 renderer。React 自带了 3 个renderer,前两个是大家常见的:

react-dom 负责将组建渲染到浏览器页面中。

react-native-renderer 负责将组件渲染成原生场景中的各种 “View”。

而今天提到的 react-test-renderer 则负责将组件输出成 JSON 对象以方便我们遍历、断言或是进行 snapshot 测试。

备注:这里有一份各种各样的 renderer 列表。

react-dom/test-utils

首先从名称可以看出这个库是包含在 react-dom 中的。所以它只是 react-dom 的辅助测试工具。在 React 文档站中它的介绍页上用的标题却只有 “Test Utilities” 两个单词,很容易让人产生误解。该库中的方法主要作用是帮我们遍历 ReactDOM 生成的 DOM 树,方便我们编写断言。注意:使用该库时必须提供一个 DOM 环境。当然这个 DOM 环境可以是 jsdom 这种模拟环境。(Jest 默认的执行环境就是 jsdom)

如何选择?

读到这你可能会问,react-test-renderer 和 react-dom/test-utils 两者看起来还是很相似。何时该选择哪一个库呢?根据笔者实际使用经验,简单来说:

如果需要测试事件(如 click, change, blur 等),那么使用react-dom/test-utils

其它时候使用更简单、灵活的react-test-renderer

react-test-renderer 使用方法

react-test-renderer 在实际使用过程中又有两种用法:

shallow render:组件只会被render 一层(children 中的 React 组件不会被 render)

full render:组件会被完全 render

现在让我们通过例子来具体看看两种方式的差别。

假设我们有以下两个组件:

const Link = ({to, children}) => (

{children}

);

const Header = () => (

Hello world

);

shallow render

shallow render 相关的工具类存在于react-test-renderer/shallow 空间下,我们首先引入,并创建一个实例:

import ShallowRenderer from ‘react-test-renderer/shallow’;

const renderer = new ShallowRenderer();

ShallowRenderer 的实例为我们提供了两个方法:

render() 用于 render 一个组件。你可以把 ShallowRenderer 的实例想象成一个容纳被 render 组件的“空间”。

getRenderOutput() 在 render 之后,可以通过此命令获取 render 的结果。

让我们看看完整的例子:

describe(‘Header’, () => {

it(‘should render a top level div’, () => {

const renderer = new ShallowRenderer();

renderer.render(

);

const result = renderer.getRenderOutput();

expect(result.type).toBe(‘div’);

});

it(‘should render 3 Link’, () => {

const renderer = new ShallowRenderer();

renderer.render(

);

const result = renderer.getRenderOutput();

const childrenLink = result.props.children.filter(c => c.type === Link);

expect(childrenLink.length).toBe(3);

});

});

我们首先验证了 Header render 后顶层元素是一个 div。接着在第二个用例中验证了 render 结果中包含 3 个 Link 组件的实例。由于shallow render 只 render 一层,所以可以验证的信息也都比较简单。比较适合验证组件输出的结构是否符合预期。

full render

接下来看看 full render。

首先引入工具库:

import TestRenderer from ‘react-test-renderer’;

调用 TestRenderer 的 create 方法并传入要 render 的组件就可以获得一个 TestRenderer 的实例。该实例上存在着以下几个方法和属性:

.toJSON():生成一个表示 render 结果的 JSON 对象。该对象中只包含像

(web 平台)或是

.toTree():和 .toJSON() 类似,但信息更加丰富,包含了用户开发的组件的信息。

.update(element):通过传入一个新的元素来更新上次 render 得到的组件树。

.umount():umount 组件树,同时触发相应的生命周期函数。

.getInstance():返回根节点对应的React 组件实例,如果存在的话。如果顶级组件是一个函数式组件,则无法获取。

.root:该属性保存了根节点对应的测试实例(test instance)。该实例为我们提供了一系列方法方便我们编写断言。

现在让我们看看测试实例上都有哪些方法和属性可供我们使用(完整列表请参考这里:

.find() 与 .findAll():用于查找符合特定条件的测试实例。区别在于 .find() 会严格要求节点树种只有 1 个满足条件的测试实例,如果没有或者多于 1 个就会抛出异常。此区别同样适用于下面两组方法。

.findByType() 与.findAllByType:用于查找特定类型的测试实例。这里的类型可以是 div 这种原生类型,也可以是 Link 这种用户编写的 React 组件。

.findByProps() 与.findAllByProps():用于查找 props 符合特定结构的测试实例。

.instance:该测试实例对应的 React 组件实例。

现在让我们看一个完整的测试用例:

describe(‘Header’, () => {

it(‘should render 3 a tag with className ““my-link””’, () => {

const testRenderer = TestRenderer.create(

);

const testInstance = testRenderer.root;

expect(testInstance.findAll(node => node.type === ‘a’ && node.props.className === ‘my-link’)).toHaveLength(3);

});

});

在这个用例中我们通过 .find() 方法查找了 className 为 my-link 的 a 标签并确保找到了 3 个。

react-dom/test-utils 使用方法

现在让我们来看看涉及到用户交互的组件如何编写单元测试。首先简单了解一下 react-dom/test-utils 的基本用法。

首先还是引入工具类:

import ReactTestUtils from ‘react-dom/test-utils’;

ReactTestUtils 对象上我们通常会用到以下一些方法(完整方法列表请参考这里):

.Simulate.{evnentName}():模拟在给定的 DOM 节点上触发特点事件。Simulate 可以触发所有 React 支持的事件类型。

renderIntoDocument():把一个 React 组件 render 到一个detached 的 DOM 中。注意:该方法依赖 DOM 环境。不过不用担心,Jest 默认集成了 jsdom。该方法会返回被 render 的 React 组件的实例。

scryRenderedDOMComponentsWithClass() 与 findRenderedDOMComponentWithClass():查找匹配特定类名的 DOM 元素。区别在于scryRenderedDOMComponentsWithClass() 会查找所有元素。而findRenderedDOMComponentWithClass() 会假定页面中有且只有 1 个符合条件的元素,否则抛出异常。

scryRenderedDOMComponentsWithTag() 与 findRenderedDOMComponentWithTag():查找匹配特定标签类型的 DOM 元素。

还是让我们通过一个具体的组件来熟悉下实际用法。

假设我们有以下 Button 组件:

import React from ‘react’;

class Button extends React.Component {

constructor() {

super();

this.state = { disabled: false };

this.handClick = this.handClick.bind(this);

}

handClick() {

if (this.state.disabled) { return }

if (this.props.onClick) { this.props.onClick() }

this.setState({ disabled: true });

setTimeout(() => {this.setState({ disabled: false })}, 200);

}

render() {

return (

相关内容

热门资讯

秘鲁总统任命前司法部长阿拉纳为... 秘鲁总统博鲁阿尔特(左)和新任总理爱德华多·阿拉纳(右)在宣誓仪式上新华社利马5月14日消息,秘鲁总...
原油:WTI下跌 美国原油库存...   原油下跌,此前有政府报告显示,美国原油库存创两个月来最大增幅,抵消了世界两大经济体贸易战暂停带来...
长江精工钢结构(集团)股份有限... 股票简称:精工钢构 股票代码:600496 编号:临2025-065转债简称:精工转债 转债代码...
山东高速路桥集团股份有限公司关... 证券代码:000498 证券简称:山东路桥 公告编号:2025-42山东高速路桥集团股份有限公司关...
丽珠医药集团股份有限公司关于回... 证券代码:000513、01513 证券简称:丽珠集团、丽珠医药 公告编号:2025-042丽珠医药...
因存在安全隐患,福特公司召回约... 央视记者当地时间5月14日获悉,福特汽车公司宣布,由于存在可能导致车辆在行驶过程中丧失制动功能、增加...
“土原料”变“潮产品” 青海兄弟乳业生物科技有限公司张成龙获“2025 IMW世界甜品巧克力&手工冰淇淋大赛暨2025意大利...
顺我者富 逆我者贫——解读特朗...   美国众议院共和党提出的新税收法案草案中,富人和企业投资者明显受益,而移民、顶尖私校等被特朗普长期...
青稞“链”上黄金道 产业升级加... 5月13日,海东市互助土族自治县青稞产业园内,青稞香飘满链。生产线轰鸣声中,金黄青稞粒经低温烘焙化作...
青海多措并举维护广告市场良好秩... 本报讯 (记者 董洁) 5月14日,记者从青海省市场监督管理局获悉,为切实维护全省广告市场秩序,保障...
厦门钨业股份有限公司关于向控股... 证券代码:600549 证券简称:厦门钨业 公告编号:临-2025-046厦门钨业股份有限公司关于...
安徽古麒绒材股份有限公司首次公... 安徽古麒绒材股份有限公司(以下简称“发行人”)首次公开发行不超过5,000万股人民币普通股(A股)(...
中蒙第二条跨境铁路开工 新华社呼和浩特5月14日电(记者 赵泽辉) 14日,中蒙两国能源合作重要通道——中蒙甘其毛都至嘎...
匠心与创新 本报记者 谭梅 刘珂瑜在青海兄弟乳业生物科技有限公司的生产车间里,看着张成龙专注调试冰淇淋配方的身影...
持续推动优质医疗资源扩容下沉 本报乌鲁木齐讯(全媒体记者 郑娅莉) 记者从自治区人民政府新闻办公室5月13日召开的新闻发布会上...
芜湖三联锻造股份有限公司关于投... 证券代码:001282 证券简称:三联锻造 公告编号:2025-031芜湖三联锻造股份有限公司关于...
国内首套氧化铝焙烧智能系统投运 原标题:国内首套氧化铝焙烧智能系统投运(记者滕继濮 实习记者夏天一 通讯员王晶)记者14日从中铝国际...
“头雁”竞飞强交流 经验互学促... “我常常在想,作为当代年轻人该如何实现自己的价值?到村任职的大半年时间,让我找到了答案——将个人理想...
《国务院2025年度立法工作计... 新华社北京5月14日电 经党中央、国务院同意,国务院办公厅日前印发《国务院2025年度立法工作计划...
我省举办《信访工作条例》集中宣... 本报讯 (记者 张晓英) 5月14日,省信访工作联席会议办公室、省信访局联合西宁市县两级信访部门在西...