如何进行react的组件测试?

背景

在平时开发过程中,可能大部分开发同学是忽略对react组件进行一些自动化测试工作的,更多可能是以实现功能为目标,测试就交给测试同学。如果能做一些单元测试,短期看可能会增加工作量,长期来看,实际上能够避免一些低级错误,提高开发效率,降低故障率。本文基于create-react-app搭建前端项目,使用Jest@testing-library/react进行组件测试。

最简单的react组件测试方式就是做快照测试,能够独立的测试每一个组件,有点类似于单元测试中对classes进行测试。

准备前端项目

我们通过create-react-app创建一个前端测试项目

npx create-react-app react-components-test

耐心等待项目创建完成。项目创建完成后,我们通过cd react-components-test指令进入到项目目录下,我们可以看到已经有一个测试的js——App.test.js

项目目录内容

之后执行npm test,就可以看到一个测试结果:

测试结果

在这个结果中,我们可以看到测试文件几个,然后测试用例通过数量是多少,测试花费的时间等等信息。

难度上升了

接下来,我们做一些有实际用处的测试工作。我们先简单创建一个小的前端应用,添加一些方法功能,让测试显的更真实一点。
首先,让我们添加一个Button组件,这个组件的功能就是点击之后,就会加上button上设置的数值。这个组件有两个传参increment(设置+多少数值)和onClickFunction(点击事件)

// Button.js
import React from 'react'

const Button = ({ increment, onClickFunction }) => {
  const handleClick = () => {
    onClickFunction(increment)
  }
  return <button onClick={handleClick}>+{increment}</button>
}

export default Button

修改App.js

import React, { useState } from 'react'
import Button from './Button'

const App = () => {
  const [count, setCount] = useState(0)

  const incrementCount = increment => {
    setCount(count + increment)
  }

  return (
    <div>
      <div>learn react</div>
      <Button increment={1} onClickFunction={incrementCount} />
      <Button increment={10} onClickFunction={incrementCount} />
      <Button increment={100} onClickFunction={incrementCount} />
      <Button increment={1000} onClickFunction={incrementCount} />
      <span>{count}</span>
    </div>
  )
}

export default App

接下来,我们将用 @testing-library/react帮助我们测试按钮点击后的结果是不是正常。
首先让我们测试Button组件。在Button组件中创建一个Button.test.js文件。

//Button.test.js
import React from 'react'
import { render, fireEvent } from '@testing-library/react'
import Button from './Button'

我们从react-testing-library引入render和fireEvent工具方法,render能够帮助我们渲染JSX,fireEvent能让我们在组件上触发一个事件。
由于Button组件通过接收一个方法绑定到click事件上,我们添加一个count变量,同时创建一个增加它的方法

//Button.test.js
let count

const incrementCount = increment => {
  count += increment
}

现在,我们开始写一个测试用例。首先我们初始化一个count值为0,然后在我们Button组件上increment传值为1,onClickFunction传我们定义的方法incrementCount,紧接着我们去获取组件第一个子元素的值,检查它是不是显示+1
我们通过代码去触发点击事件,查看count值是不是从0变成了1。

//Button.test.js
test('+1 Button works', () => {
  count = 0
  const { container } = render(
    <Button increment={1} onClickFunction={incrementCount} />
  )
  const button = container.firstChild
  expect(button.textContent).toBe('+1')
  expect(count).toBe(0)
  fireEvent.click(button)
  expect(count).toBe(1)
})

同样的,我们试试+100的按钮点击之后是不是也功能正常:

//Button.test.js
test('+100 Button works', () => {
  count = 0
  const { container } = render(
    <Button increment={100} onClickFunction={incrementCount} />
  )
  const button = container.firstChild
  expect(button.textContent).toBe('+100')
  expect(count).toBe(0)
  fireEvent.click(button)
  expect(count).toBe(100)
})

然后,我们试试去测试App组件功能是不是正常。在页面上,我们显示了4个按钮组件,我们可以测试每个按钮在点击事件之后,是不是加上了对应的数值,我们可以尽可能多的测试几次。

// App.test.js
import React from 'react'
import {render, screen, fireEvent} from '@testing-library/react'
import App from './App'

test('renders learn react link', () => {
    render(<App />)
    const linkElement = screen.getByText(/learn react/i)
    expect(linkElement).toBeInTheDocument()
})

test('App works', () => {
    const {container} = render(<App />)
    // console.log(container)
    const buttons = container.querySelectorAll('button')

    expect(buttons[0].textContent).toBe('+1')
    expect(buttons[1].textContent).toBe('+10')
    expect(buttons[2].textContent).toBe('+100')
    expect(buttons[3].textContent).toBe('+1000')

    const result = container.querySelector('span')
    expect(result.textContent).toBe('0')
    fireEvent.click(buttons[0])
    expect(result.textContent).toBe('1')
    fireEvent.click(buttons[1])
    expect(result.textContent).toBe('11')
    fireEvent.click(buttons[2])
    expect(result.textContent).toBe('111')
    fireEvent.click(buttons[3])
    expect(result.textContent).toBe('1111')
    fireEvent.click(buttons[2])
    expect(result.textContent).toBe('1211')
    fireEvent.click(buttons[1])
    expect(result.textContent).toBe('1221')
    fireEvent.click(buttons[0])
    expect(result.textContent).toBe('1222')
})

我们就可以看到下面的测试结果:


完整测试结果

结语

好了,到此为止,react组件测试流程就完整的跑过了一遍。在真实的开发场景中,功能和逻辑会更复杂,本篇文章的目的在于抛砖引玉,如果对自动化测试感兴趣的同学,可以参考jest@testing-library/react官方文档,在自己的项目中应用上去。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 224,535评论 6 522
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 96,106评论 3 402
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 171,668评论 0 366
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 60,863评论 1 300
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 69,874评论 6 399
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 53,362评论 1 314
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 41,748评论 3 428
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 40,717评论 0 279
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 47,249评论 1 324
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 39,280评论 3 345
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 41,408评论 1 354
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 37,020评论 5 350
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 42,727评论 3 337
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 33,191评论 0 25
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 34,320评论 1 275
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 49,946评论 3 381
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 46,473评论 2 365

推荐阅读更多精彩内容