React Hook测试指南

React Hook测试指南

React为什么需要Hook中我们探讨了React为什么需要引入Hook这个属性,在React Hook实战指南中我们深入了解了各种Hook的详细用法以及会遇到的问题,在本篇文章中我将带大家了解一下如何通过为自定义hook编写单元测试来提高我们的代码质量,它会包含下面的内容:

  • 什么是单元测试
    • 单元测试的定义
    • 为什么需要编写单元测试
    • 单元测试需要注意什么
  • 如何对自定义Hook进行单元测试
    • Jest
    • React-hooks-testing-library
    • 例子

什么是单元测试

单元测试的定义

要理解单元测试,我们先来给测试下个定义。用最简单的话来说测试就是:我们给被测试对象一些输入(input),然后看看这个对象的输出结果(output)是不是符合我们的预期(match with expected result)。而在软件工程里面有很多不同类型的测试,例如单元测试(unit test),功能测试(functional test),性能测试(performance test)和集成测试(integration test)等。不同种类的测试的主要区别是被测试的对象和评判指标不一样。对于单元测试,被测试的对象是我们源代码的独立单元(individual unit),在面向过程编程语言(procedural programming)里面,单元就是我们封装的方法(function),在面向对象的编程语言(object-oriented programming)里面单元是类(class)的方法(method),我们一般不推荐将某个类或者某个模块直接作为单元测试的单元,因为这会使被测试的逻辑过于庞大,而且问题出现时不容易进行定位。

为什么需要编写单元测试

了解了单元测试的定义后,我们再来探讨一下为什么我们要在代码里面进行单元测试。

我们之所以要在项目中编写单元测试,主要是因为对代码进行单元测试有下面这些好处:

提高代码质量

单元测试可以提高我们的代码质量主要体现在它可以在我们开发某个功能的时候提前帮我们发现自己编写的代码的bug。举个例子,假如A同学写了一个叫做useOptions的hook它接受一个叫做options的参数,这个参数既可以是一个对象也可以是一个数组。A同学自己开发的过程中他只试过给useOptions传对象而没有试过给它传数组。同一个项目的B同学在使用useOptions的时候给它传了个数组发现代码挂了,这个时候B同学就得找A同学确认并等待A同学修复这个问题,这不但会影响B同学的开发进度而且还会让B同学觉得A同学不靠谱,或者觉得A同学的代码很烂。如果A同学有对useOptions进行单元测试的话,这个悲剧可能就不会发生了,因为A同学在为useOptions编写单元测试的时候就考虑了options为数组的情况,并且在B同学使用之前就修复了这个问题。因此编写单元测试可以让我们在开发的过程中提前考虑到很多后面使用才会发现的问题,进而提高我们的代码质量。

方便代码重构和新功能添加

编写单元测试的过程其实是我们给代码编写使用说明书的过程(specification)。这个使用说明书十分重要,它相当于代码生产者(producer)与代码消费者(consumer)之间的合约(contract),生产者需要保证在消费者使用代码没错的前提下代码要有使用说明书上面的效果。这其实会对代码生产者起到一定的制约作用,因为生产者必须保证无论是给原来的代码添加新的功能还是对它进行重构,它都要满足原来使用说明书上的要求。

继续上面那个例子,A同学和B同学都在项目的1.0.0版本中使用了useOptions这个hook,虽然useOptions没有编写单元测试,可是代码是没有bug的(最起码没有被发现)。后面项目需要进行2.0.0版本的升级了,这时候A同学需要为useOptions添加新的功能,A同学在改动了useOptions的代码后,在自己使用到的地方(对象作为参数的地方)做了测试,没有发现bug。在A同学自测完代码后,并将这个更改集成(integration)到了项目的master分支上。后面B同学在更新完A同学的代码后,发现自己的代码出现了一些问题,这个时候B同学很可能就会手忙脚乱,并且可能需要花费一段时间才能定位到原来是A同学对useOptions的改动影响到他的功能,这除了会影响到项目的进度外还会让A同学和B同学的关系进一步恶化。这个悲剧同样也是可以通过编写单元测试来避免的,试想一下假如A同学有给useOptions编写配套的使用说明书(单元测试),A同学在改动完代码后,它的代码是通过不了使用说明书的检查的,因为它的改动改变了useOptions之前定义好的外部行为,这个时候A同学就会提前修复自己的代码进而避免了B同学后面的苦恼。通过这个例子大家可能还是没有体会到单元测试对于我们平时产品迭代或者代码重构的重要性,可是你试想一下在一个比较大的项目中是有很多个A同学和B同学的,也有成千上万个useOptions函数,当真的发生类似问题的时候bug将会更难被定位和修复,如果我们大部分的代码都有单元测试的话,无论是对代码增加新的功能还是对原来的代码进行重构我们都会更有信心。

完善我们代码的设计

在软件工程里面有个概念叫做测试驱动开发(Test-driven Development),它鼓励我们在实际开始编码之前先为我们的代码编写测试用例。这样做的目的是让我们在开发之前就以代码使用者的角度去评判我们的代码设计。如果我们的代码设计很糟糕,我们就会发现我们很难为它们编写详尽的单元测试用例,相反如果我们的代码设计得很好(低耦合高内聚),各个函数的参数和功能都设计得十分合理,我们就十分容易就为它们编写对应的单元测试。我们要记住一句话:高质量的代码一定是可以被测试的(testable)。那么为什么是在还没开始写代码之前就编写测试用例呢?这是因为如果我们在代码写完之后再编写测试的话,即使我们发现代码设计得再不合理,我们也没有动力去改了,因为对设计的改动可能会让我们重写所有的代码,所以我们需要在实际编码之前进行单元测试的编写,因为这个时候的改代码阻力是最小的。

提供文档功能

我们在为代码编写单元测试的时候实际上是在为代码编写一个个使用例子,因此别的开发者在使用我们代码的时候可以通过我们的单元测试来快速掌握我们定义的各种函数的用法。另外教大家一个实用的技巧:如果我们发现某个库的文档不是很全面的话,可以通过查看这个库的单元测试来快速掌握这个库的用法。

单元测试需要注意的问题

隔离性

上面我们说到单元测试是对代码独立的单元进行测试,这个独立的意思不是说这个函数(单元)不会调用另外一个函数(单元),而是说我们在测试这个函数的时候如果它有调用到其它的函数我们就需要mock它们,从而将我们的测试逻辑只放在被测试函数的逻辑上,不会受到其它依赖函数的影响。举个例子我们现在要测试以下函数:

1
async function fetchUserDetails(userId) {
2
  const userDetail = await fetch(`https://myserver.com/users/${userId}`)
3
  return userDetail
4
}

在测试fetchUserDetails时我们就需要mock fetch这个函数了,因为我们现在测试的函数是fetchUserDetails,我们只需要确定在外界调用fetchUserDetails的时候fetch会被调用,并且调用的参数是“https://myserver.com/users/${userId}”就行了,至于fetch函数如何发请求和处理返回来的数据都是fetch函数自己的事,我们不应该在测试fetchUserDetails的时候关心这个问题。

单元测试要注意隔离性的另外一个原因是它可以保证当测试案例失败的时候我们可以十分容易定位到问题的所在。以上面的代码为例,如果我们没有mock fetch函数,一旦我们的测试失败,我们很难分清是fetchUserDetails逻辑错了还是fetch的逻辑错了。

可重复性

我们编写的所有单元测试用例一定不能依赖外部的运行环境,否则我们的单元测试将不具备可重复性(repeatable)。所谓的可重复性就是:如果我们的单元测试用例现在是可以通过的,那么在代码不发生变动和测试用例没有改变的前提下它将是一直可以通过的。举个测试用例不具备可重复性的例子,假如你将项目的单元测试数据全部放在数据库里面,你今天运行项目的测试用例是可以通过的,而第二天其他人无意改了数据库的数据,这个时候你的测试用例就通过不了了,我们就说这些测试用例不具备可重复性,出现这个问题的主要原因是它们使用了外部的依赖作为测试条件。由此可见要使我们的测试用例具备可重复性的一个关键点是在编写单元测试的时候避免外部依赖,这些外部依赖包括数据库网络请求本地文件系统等。

另外一个影响到测试用例可重复性的一个重要的却容易被忽略的因素是:不同单元测试用例之间共用了一些测试数据,某个测试用例对测试数据的更改可能会影响其它测试用例的正确执行。因此我们在编写单元测试用例的时候一定要避免不同测试用例之间共用一些测试数据,尽量将每个测试用例隔离起来。

提高代码覆盖率

在单元测试里面有个概念叫做代码覆盖率(test coverage),它表明我们代码被测试的程度。举个例子假如我们有一个100行的函数,在我们运行完所有的为这个函数编写的单元测试用例之后,如果测试框架告诉我们这个函数的覆盖率是80%,这表明我们的测试用例代码只覆盖了这个函数的80行代码,还有一些代码分支(if/else, switch, while)没有被执行到。如果我们想通过单元测试来提高我们代码质量的话,我们就需要保证我们代码的覆盖率足够大,尽量让被测试的函数的每一种被执行情况都被覆盖到(覆盖率100%),特别是一些异常的情况应该也要被覆盖到(例如参数错误,调用第三方依赖报错等),这样我们才能及早地发现代码的bug并进行修复。

测试用例运行时间要短

我在上面说到单元测试是可以帮助我们更好地进行代码迭代和重构的,要做到这点其实要求我们在每次代码归并的时候对被merge的代码进行一些自动化检测(CI),这就包括项目单元测试用例的运行。试想一下在一个比较大型的项目里面单元测试用例的数量往往是很多的,少则几百个,多则上千个,如果全部运行所有测试用例的时间需要十几分钟甚至一两小时,这就会影响到代码集成的进度。为了避免这个问题,我们就需要确保每个单元测试用例执行的时间不能过长,例如避免在测试代码里面进行一些耗时的计算等。

如何对自定义Hook进行单元测试

React Hook实战指南中我们提到Hook就是一些函数,所以对Hook进行单元测试其实是对一个函数进行测试,只不过这个函数和普通函数的区别是它拥有React给它赋予的特殊功能。在讲如何对Hook进行测试之前我们先来了解一下我们要用到的测试框架Jest和hook测试库react-hook-testing-library

Jest

Jest是Facebook开源的一个单元测试框架,它的使用率和知名度都非常高,一些著名的开源项目例如webpack, babel和react等都是使用Jest来进行单元测试的,由于这篇文章的重点不是Jest的使用,所以我在这里将不为大家做具体的介绍,这里主要介绍一下我们常用到的Jest API:

常用API

it/test

it/test函数是用来定义测试用例(test case)的,它的函数签名是it(description, fn?, timeout?)description参数是对这个测试用例的一个简短的描述,fn是一个运行我们实际测试逻辑的函数,而timeout则是这个测试用例的超时时间。下面是一个简单的例子:

1
import sum from 'somewhere/sum'
2
3
it('test if sum work for positive numbers', () => {
4
  const result = sum(1, 2)
5
  expect(result).toEqual(3)
6
})
describe

describe函数是用来给测试用例分组用的,它的函数签名是describe(description, fn),description是用来描述这个分组的,而fn函数里面则可以定义内嵌的分组(nested)或者是一些测试用例(it),下面是一个简单的例子:

1
import sum from 'somewhere/sum'
2
3
describe('test sum', () => {
4
  it('work for positive numbers', () => {
5
    const result = sum(1, 2)
6
    expect(result).toEqual(3)
7
  })
8
9
  it('work for negative numbers', () => {
10
    const result = sum(-1, -2)
11
    expect(result).toEqual(-3)
12
  })
13
})
expect

我们在刚开始的时候就提到所谓的测试就是要比较被测试对象的输出和我们期待的输出是不是一致的,也就涉及到一个比较的过程,在Jest框架中我们可以通过expect函数来访问一系列matcher来进行这个比较的过程,例如上面的expect(sum).toEqual(3)就是一个用matcher来判断输出结果是不是我们想要的值的过程。关于更加详细的matcher信息大家可以参考jest的官方文档

mock

在Jest框架中用来进行mock的方法有很多,主要用到的是jest.fn()jest.spyOn()

jest.fn

jest.fn会生成一个mock函数,这个函数可以用来代替源代码中被使用的第三方函数。jest.fn生成的函数上面有很多属性,我们也可以通过一些matcher来对这个函数的调用情况进行一些断言,下面是一个简单的例子:

1
// somewhere/functionWithCallback.js
2
export const functionWithCallback = (callback) => {
3
  callback(1, 2, 3)
4
}
5
6
// somewhere/functionWithCallback.spec.js
7
import { functionWithCallback } from 'somewhere/functionWithCallback'
8
9
describe('Test functionWithCallback', () => {
10
  it('if callback is invoked', () => {
11
    const callback = jest.fn()
12
    functionWithCallback(callback)
13
14
    expect(callback.mock.calls.length).toEqual(1)
15
  })
16
})
jest.spyOn

我们源代码中的函数可能使用了另外一个文件或者node_modules中安装的一些依赖,这些依赖可以使用jest.spyOn来进行mock,下面是一个简单的例子:

1
// somewhere/sum.js
2
import { validateNumber } from 'somewhere/validates'
3
4
export default (n1, n2) => {
5
  validateNumber(n1)
6
  validateNumber(n2)
7
8
  return n1 + n2
9
}
10
11
// somewhere/sum.spec.js
12
import sum from 'somewhere/sum'
13
import * as validates from 'somewhere/validates'
14
15
it('work for positive numbers', () => {
16
  // mock validateNumber
17
  const validateNumberMock = jest.spyOn(validates, 'validateNumber')
18
  
19
  const result = sum(1, 2)
20
  expect(result).toEqual(3)
21
22
  // restore original implementation
23
  validateNumberMock.mockRestore()
24
})

我们在上面测试代码中引入了源代码使用到的依赖somewhere/validates,这个时候就可以通过jest.spyOn来mock这个依赖export的一些方法了,例如validateNumber。被mock的函数会在源代码被执行的时候使用,例如上面sum执行的时候使用到的validateNumber就是我们在sum.spec.js里面定义的validateNumberMock。这样我们除了可以保证validateNumber不会影响到我们对sum函数逻辑的测试,还可以在外面对validateNumberMock进行一些断言(assertion)来验证sum逻辑的正确性。还有一点需要注意的是,我在测试用例执行完之后调用了mockRestore这个函数,这个函数会恢复validateNumber函数原来的实现,从而避免这个测试用例对validate文件的更改影响到其它测试用例的正确执行。

项目引入jest

了解完jest的一些基本API之后我们再来看一下如何在我们的项目里面引入jest。

安装依赖

首先使用下面命令安装jest

1
yarn add -D jest

如果你项目使用的是Typescript,则还需要安装ts-jest作为依赖:

1
yarn add -D ts-jest

配置jest

安装完jest后需要在package.json文件里面配置一下:

1
{ 
2
  "jest": {
3
    "transform": {
4
      "^.+\\.tsx?$": "ts-jest"
5
    },
6
    "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
7
    "moduleDirectories": [
8
      "node_modules",
9
      "src"
10
    ],
11
    "moduleFileExtensions": [
12
      "ts",
13
      "tsx",
14
      "js",
15
      "jsx",
16
      "json",
17
      "node"
18
    ]
19
  }
20
}

上面各个配置项的意思分别是:

  • transform: 告诉jest,你的ts或者tsx文件需要使用ts-jest来进行转换。
  • testRegex: 告诉jest哪些文件是需要被作为测试代码进行执行的,从上面的正则表达式我们可以看出文件名中有test和spec的文件将会被作为测试用例执行。
  • moduleDirectories: 告诉jest在执行测试用例代码的时候,代码用到的dependencies应该去哪些目录进行resolve,在这里jest会去node_modulessrc(或者你自己的源代码根目录)里面进行resolve,这个应该要和你项目的webpack.config.js的resolve部分配置保持一致。
  • moduleFileExtensions: 告诉jest在找不到对应文件的时候应该尝试哪些文件后缀。

React hooks testing library

React-hooks-testing-library,是一个专门用来测试React hook的库。我们知道虽然hook是一个函数,可是我们却不能用测试普通函数的方法来测试它们,因为它们的实际运行会涉及到很多React运行时(runtime)的东西,因此很多人为了测试自己的hook会编写一些TestComponent来运行它们,这种方法十分不方便而且很难覆盖到所有的情景。为了简化开发者测试hook的流程,React社区有人开发了这个叫做react-hooks-testing-library的库来允许我们像测试普通函数一样测试我们定义的hook,这个库其实背后也是将我们定义的hook运行在一个TestComponent里面,只不过它封装了一些简易的API来简化我们的测试。在开始使用这个库之前,我们先来看一下它对外暴露的一些常用的API。

常用API

renderHook

renderHook这个函数顾名思义就是用来渲染hook的,它会在调用的时候渲染一个专门用来测试的TestComponent来使用我们的hook。renderHook的函数签名是renderHook(callback, options?),它的第一个参数是一个callback函数,这个函数会在TestComponent每次被重新渲染的时候调用,因此我们可以在这个函数里面调用我们想要测试的hook。renderHook的第二个参数是一个可选的options,这个options可以带两个属性,一个是initialProps,它是TestComponent的初始props参数,并且会被传递给callback函数用来调用hook。options的另外一个属性是wrapper,它用来指定TestComponent的父级组件(Wrapper Component),这个组件可以是一些ContextProvider等用来为TestComponent的hook提供测试数据的东西。

renderHook的返回值是RenderHookResult对象,这个对象会有下面这些属性:

  • result:result是一个对象,它包含两个属性,一个是current,它保存的是renderHook callback的返回值,另外一个属性是error,它用来存储hook在render过程中出现的任何错误。
  • rerender: rerender函数是用来重新渲染TestComponent的,它可以接收一个newProps作为参数,这个参数会作为组件重新渲染时的props值,同样renderHookcallback函数也会使用这个新的props来重新调用。
  • unmount: unmount函数是用来卸载TestComponent的,它主要用来覆盖一些useEffect cleanup函数的场景。
act

这函数和React自带的test-utils的act函数是同一个函数,我们知道组件状态更新的时候(setState),组件需要被重新渲染,而这个重渲染是需要React进行调度的,因此是个异步的过程,我们可以通过使用act函数将所有会更新到组件状态的操作封装在它的callback里面来保证act函数执行完之后我们定义的组件已经完成了重新渲染。

安装

直接把react-hooks-testing-library作为我们的项目devDependencies

1
yarn add -D @testing-library/react-hooks

注意:要使用react-hooks-testing-library我们要确保我们安装了16.9.0版本及其以上的reactreact-test-renderer

1
yarn add react@^16.9.0
2
yarn add -D react-test-renderer@^16.9.0

例子

现在就让我们看一个简单的同时使用Jestreact-hooks-testing-library来测试hook的例子,假如我们在项目里面定义了一个叫做useCounter的Hook:

1
// somewhere/useCounter.js
2
import { useState, useCallback } from 'react'
3
4
function useCounter() {
5
  const [count, setCount] = useState(0)
6
7
  const increment = useCallback(() => setCount(x => x + 1), [])
8
  const decrement = useCallback(() => setCount(x => x - 1), [])
9
10
  return {count, increment, decrease}
11
}

在上面的代码中我定义了一个叫做useCounter的hook,这个hook是用来封装一个叫做count的状态并且对外暴露对count进行操作的一些updater包括incrementdecrement。如果大家对useStateuseCallback不够熟悉的话可以看一下我的上一篇文章React Hook实战指南。接着就让我们编写这个hook的测试用例:

1
// somewhere/useCounter.spec.js
2
import { renderHook, act } from '@testing-library/react-hooks'
3
import useCounter from 'somewhere/useCounter'
4
5
describe('Test useCounter', () => {
6
  describe('increment', () => {
7
     it('increase counter by 1', () => {
8
      const { result } = renderHook(() => useCounter())
9
10
      act(() => {
11
        result.current.increment()
12
      })
13
14
      expect(result.current.count).toBe(1)
15
    })
16
  })
17
18
  describe('decrement', () => {
19
    it('decrease counter by 1', () => {
20
      const { result } = renderHook(() => useCounter())
21
22
      act(() => {
23
        result.current.decrement()
24
      })
25
26
      expect(result.current.count).toBe(-1)
27
    })
28
})
29
})

上面的代码中我们写了一个测试大组(describe)Test useCounter并在这个大组里面定义了两个测试小组分别用来测试useCounter返回的incrementdecrement方法。我们具体看一下描述为increase counter by 1的测试用例的代码,首先我们要用renderHook函数来渲染要被测试的hook,这里我们需要将useCounter的返回值作为callback函数的返回值,这是因为我们需要在外面拿到这个hook的返回结果{count, increment, decrement}。接着我们使用act函数来调用改变组件状态countincrement函数,act函数完成之后我们的组件也就完成了重渲染,后面就可以判断更新后的count是不是我们想要的结果了。

总结

在本篇文章中我给大家介绍了什么叫做单元测试,为什么我们需要在自己的项目里面引入单元测试以及教大家如何使用Jestreact-hooks-testing-library来测试我们自定义的hook。

这篇文章是我的React hook系列文章的最后一篇了,后面我还会持续为大家分享一些和hook相关的内容,大家敬请期待。

参考文献

个人技术动态

欢迎关注公众号进击的大葱一起学习成长

评论

Your browser is out-of-date!

Update your browser to view this website correctly. Update my browser now

×