如何在 Vue 及 React 项目中做单测

在这部分的内容中,你将学习到以下几点:

  • 单元测试的作用
  • 最应该对哪些模块进行单元测试
  • React 和 Vue 这两大框架的单元测试学习路径
  • 如何在 React 和 Vue 这两大框架中进行单元测试以及 Demo 实战

单元测试是用来测试程序中一小块功能的,比如说一个函数、一个类。它能很显著地提高项目的代码质量,降低出现 Bug 的频率,并且也利于维护代码。

但是实际情况是绝大部分开发者是不愿意做这件事情的。因为平时开发都忙不过来,哪还有时间去做这些事情。

我个人其实认为业务代码的测试应该是不强求的,毕竟需求经常在变化。如果对业务代码进行高覆盖率的测试,那么一旦需求变动就需要同步修改测试用例。这样编码的压力是双份的,很可能达不到快节奏上线的目的。

但是对于依赖的基础组件库以及公共函数是一定需要编写单元测试的。因为这些内容会被多个模块使用到,并且也不会频繁变更这些基础的功能,编写单元测试的收益相对来说高得多。就比如各种知名的开源项目的测试覆盖率往往是高于 90% 的,测试覆盖率低或者压根不写测试的开源项目一般很少直接用于项目中。

那么我们如何学习这方面的内容呢?首先无论你使用什么技术栈,都需要先选择一个测试框架。Jest 是其中一个相对来说优秀的框架(很多知名开源项目也都在使用它),开箱即用,内部集成了断言库、Mock、快照功能等等。当然你也可以同样选择别的框架,核心内容都是一样的,无非 API 有所改变罢了。

Jest 入门

Jest 总归是个使用起来很简单的框架,不需要太多的学习时间就能上手了。另外如果你想学习如何用好这个框架,最好的办法其实是阅读工具库以及组件库的测试用例。

以下是对 Jest 一些重要功能的简单介绍。

断言

在 Jest 中使用最多的就是内部的断言库了,因为我们需要用它来测试函数的输出是否与我们预期的一致。

它的用法也很简单,你稍微会点英文就能看懂一段测试代码的用途,甚至于不需要去翻阅文档。比如说你期望一个函数的输出为 2

// 翻译出来就是我测试一段代码,期望函数(输入)等于我期望的输出
test('测试 1 + 1 = 2', () => {
  expect(sum(1, 1)).toBe(2)
})

关于这部分的内容大家只需要翻阅下文档就能熟练使用了。

异步代码测试

异步获取数据肯定是一个常见场景了。异步代码通常会有两种写法,分别为:

  • 回调函数
  • 函数返回 promise

在测试异步代码的时候,通常返回的数据是不确定的,因此我们只需要测试异步代码是否正常返回数据即可。

// 回调函数的写法,通过 done 来让测试代码一直等待
test('fetch success', done => {
  fetch(data => {
    expect(data.success).toBe(true)
    done()
  })
})
// 函数返回 promise 的写法,注意要加上 return
// 当然对于返回 promise 的函数我们也可以直接使用 await
test('fetch success', () => {
  return fetch().then(data => {
    expect(data.success).toBe(true)
  })
})

Mock 函数

假设我们需要测试一个回调函数是否被执行、参数或者返回值是否正确,这时候我们就可以使用 Mock 函数。

function foo(cb) {
  cb(1)
}
const mockCallback = jest.fn(value => value + 1)
// 回调被调用
expect(mockCallback).toBeCalled()
// 回调函数参数为 1
expect(mockCallback.mock.calls[0][0]).toBe(1)
// 回调函数返回值为 2
expect(mockCallback.mock.results[0].value).toBe(2)

当然 Mock 函数还有更多用法。比如模拟返回值,追踪函数被调用的各种情况等等,更多的内容可以阅读文档去学习。

快照

快照在测试组件时是个很有用的功能,可以帮助我们确保在维护代码的过程中不会对组件的 UI 进行改变。

用法相当简单:

expect(组件实例).toMatchSnapshot()

以上代码在第一次执行时会生成快照,在接下来的测试中每次都会去对比两者的内容是否一致。

配置文件

Jest 和 Babel 一样,使用的时候都需要一个配置文件。对于 Jest 来说,你需要在根目录中创建一个名为 jest.config.js 的文件。

以下是一些常见的配置选项:

module.exports = {
  // 文件后缀
  moduleFileExtensions: ['js', 'jsx', 'json', 'vue'],
  // 文件如何转换
  transform: {
    '^.+\\.vue$': 'vue-jest',
    '.+\\.(css|styl|less|sass|scss|svg|png|jpg|ttf|woff|woff2)$':
      'jest-transform-stub',
    '^.+\\.jsx?$': 'babel-jest'
  },
  // 忽略的文件
  transformIgnorePatterns: ['/node_modules/'],
  // 生成快照需要的插件
  snapshotSerializers: ['jest-serializer-vue'],
  // 需要执行哪些目录下的测试用例
  testMatch: [
    '**/tests/unit/**/*.spec.(js|jsx|ts|tsx)|**/__tests__/*.(js|jsx|ts|tsx)'
  ],
  // 在执行用例前的配置文件
  setupFiles: ['./tests/setup.js'],
  // 测试覆盖率配置
  collectCoverage: true,
  coverageReporters: ['html', 'lcov', 'text-summary'],
  coverageDirectory: './test/coverage',
  collectCoverageFrom: ['components/**/*.vue']
}

更多的配置属性可以查阅文档学习。

怎么对工具函数进行单测

对于工具函数来说,首要一点就是这个函数不能包含太多的功能,拆分成一个个功能函数是最佳的方式,因为这样测试起来会很方便。

另外对于工具函数来说,输出应该是可控的,所以写单测起来很容易,只需要 except 函数的输出即可。

怎么对组件进行单测

对于组件来说,最重要的是为组件生成各个状态下的快照,以防代码变动后引发 UI 层面的 Bug。剩余的内容就是对各个功能进行测试了,比如说值设置的对不对啦、事件有没有响应啦、逻辑是不是正确啦等等,这部分的测试主要还要看具体组件的功能了。

另外如果你有做统计测试覆盖率的话,会发现 Branch 指标的提升往往是最难的对于组件来说。一旦你能把这个指标提升到 95% 以上,那么这个组件的问题会少很多。

Vue 中实践 Jest

推荐在完成环境配置后阅读该文档

配置

不管你是现有项目还是新项目需要使用 Jest,都可以通过 Vue Cli 3 解决。

对于现有项目,只需要在项目文件夹中执行一条命令即可

vue add unit-jest

脚手架会自动在项目中帮你安装 Jest 需要的配置,安装完成后你会发现根目录中新增了一个文件夹

文件夹中包含了一个测试用例,你只需执行 yarn test:unit 即可运行测试用例。

对于新项目来说,在创建项目过程中需要选择 Manually select features,然后按照以下内容选择即可集成 Jest 环境。

实践

完成环境配置以后我们就开始进行一个简单的组件测试吧。

PS:组件测试需要用到 @vue/test-utils 这个库,因为需要它来帮助我们 mount 组件以及对组件进行一系列的操作。当组件挂载以后,我们就可以通过 Jest 进行断言、Mock、生成快照等等。

在 components 文件夹下我们新增一个 loading.vue 文件

<template>
  <div class="loading">
    <span class="loading__indicator" :style="style" />
    <span class="loading__text" v-show="text">{{ text }}</span>
  </div>
</template>

<script>
export default {
  props: {
    text: String,
    size: {
      type: Number,
      default: 26
    },
    indicatorColor: {
      type: String,
      default: "#1989FA"
    }
  },
  computed: {
    style() {
      return {
        width: this.size + "px",
        height: this.size + "px",
        borderColor: this.indicatorColor,
        borderBottomColor: "transparent"
      };
    }
  }
};
</script>

以上代码是一个很简单的组件,传入 props 就完成了整个组件的渲染,没有其他的逻辑了。

测试用例也很简单,完成对所有的 props 输入输出对比即可实现 100% 的测试覆盖率。

describe('Loading.vue', () => {
  it('renders props.msg when passed', () => {
    const wrapper = mount(Loading, {
      propsData: {
        text: 'Loading',
        indicatorColor: 'red',
        size: 20
      }
    })
    const indicatorStyle = wrapper.find('.loading__indicator').element.style
    expect(wrapper.find('.loading__text').text()).toBe('Loading')
    expect(indicatorStyle.borderColor).toContain('red')
    expect(indicatorStyle.width).toContain('20px')
  })
  it('snapshot', () => {
    const wrapper = mount(Loading, {
      propsData: {
        text: 'Loading',
        indicatorColor: 'red',
        size: 20
      }
    })
    expect(wrapper).toMatchSnapshot()
  })
})

执行 yarn test:unit 命令后,我们应该能见到如下图的内容

如果你想更进一步学习在 Vue 中进行单元测试的内容,推荐以下资料:

React 中实践 Jest

推荐在完成环境配置后阅读该文档

配置

对于新项目来说,如果你使用 create-react-app 的话,那么默认 Jest 就集成在内部了,你只需要运行命令 yarn eject 就可以在 package.json 文件中看到 Jest 的配置。

另外可能有些同学是 TS 的环境,因此我的 Demo 中是以 TS 为基础配置的。

实践

PS:组件测试需要用到 enzyme 以及 enzyme-adapter-react-16 这两个库,因为需要它们来帮助我们 mount 组件以及对组件进行一系列的操作。当组件挂载以后,我们就可以通过 Jest 进行断言、Mock、生成快照等等。

另外鉴于组件测试这块的内容基本和 Vue 中的一致,因此这里就不浪费篇幅了,具体内容可以去 demo 中学习。

如果你想更进一步学习在 React 中进行单元测试的内容,推荐以下资料:

  • ant-design 组件库
  • 阅读 Vant 组件库中的测试用例(在每个组件的 tests 目录下)

总结

总的来说在项目中进行单元测试需要学习的内容并不多,一个 Jest 外加一个能够挂载组件的库即可,一天既能上手这块的内容。

真正需要花时间学习的应该还是阅读优秀第三方库的测试用例上。

评论 抢沙发

表情
  1. #1

    来自海南海口的用户 9天前
    先Mark后看(●◡●)ノ

  2. #2

    来自山东济南的用户 11天前
    good

  3. #3

    来自浙江杭州的用户 11天前
    继续讲撒 这个东西挺好玩啊

  4. #4

    来自江苏玄武的用户 20天前
    太秀了老哥,顶一个

  5. #5

    来自海南海口的用户 20天前
    可以说是相当详细了

  6. #6

    来自北京朝阳的用户 25天前
    老哥,写得很不错

  7. #7

    来自江苏玄武的用户 26天前
    感谢分享,希望作者继续出文章,多交流分享。

  8. #8

    来自湖北武汉的用户 27天前
    感谢您的文章,又学到了不少东西

  9. #9

    来自北京昌平的用户 30天前
    为何你如此秀