Vue 项目引入单元测试

目前hips采用的单测组合是jest + Vue-Test-Utils,前端单元测试,就是要在项目里加上这两个配置。

采用 jest + Vue Test Utils进行单元测试的原因

1.JestFacebook的一套开源的 JavaScript 测试框架, 它自动集成了断言、JSDom、覆盖率报告等开发者所需要的所有测试工具,配置较少,对vue框架友好。

2.Vue Test UtilsVue.js 官方的单元测试实用工具库,为jest和vue提供了一个桥梁,暴露出一些接口,让我们更加方便的通过Jest为Vue应用编写单元测试。

3.vue-cli 默认的单元测试也是使用的这套方案

现在我们分几种情况来考虑一下:

  1. 基于vue-cli3 创建项目

首先是全局安装vue-cli,现在已经是最新4.x,如果安装3.x可以 npm install -g @vue/cli@3.x

npm install -g @vue/cli
# OR
yarn global add @vue/cli

接着我们可以使用vue-cli去创建一个vue项目了

vue create test-demo

命令输入之后 我们有defaultManually select features两个选项,default是默认,回车之后就整个配置好,Manually select features是手动选择那些配置要加入到项目中,我们选Manually select features这个选项。

image.png

我们选中unit testing选项(附:选中与取消是按空格键盘)一路回车,我们看项目需要,然后选择构建

image.png

test选择jest,当然选择mocha也可以,一路回车,通过vue-cli3我们就完成了构建一个项目。

image.png

进入到项目中,直接使用命令即可进行单测,单测的代码写在tests/unit目录下。

  1. 基于vue-cli3创建项目(但未引入jest)

有时候我们选择了default模式一路畅通就建好了项目,或者本身项目是基于海马汇标准子应用工程去构建的,这时候我们想给项目加个单测部分,怎么搞呢?

vue add unit-jest

我们在项目目录下,执行上面的命令,它就会帮我们去安装jest模块,紧接着,我们的项目就可以进行单元测试了。

  1. 普通vue项目

还有一些老的项目,可能不是基于vue-cli3 去创建的,本着良心运维的原则,我们也提供如下指导。

jest@vue/test-utils 是我们的单测依赖,vue-jest是一个 预处理器,如果不安装vue-jestjest无法处理.vue文件。

npm install --save-dev babel-plugin-transform-vue-jsx jest @vue/test-utils jest-serializer-vue  babel-jest vue-jest

# OR

yarn add -S babel-plugin-transform-vue-jsx jest @vue/test-utils jest-serializer-vue  babel-jest vue-jest
 在`package.json`里加入jest命令命令
//package.json
"scripts": {
    "unit": "jest --config test/unit/jest.conf.js --coverage",   
}

创建测试目录,新建测试配置文件

mkdir test/unit
vim jest.conf.js

jest.conf.js 配置如下

const path = require('path');

module.exports = {
  rootDir: path.resolve(__dirname, '../../'),
  moduleFileExtensions: [
    'js',
    'json',
    'vue',
  ],
  moduleNameMapper: {
    '^@/(.*)$': '<rootDir>/src/$1',  // @路径转换,例如:@/views/shop/info.vue 
  },
  transform: {
    '^.+\\.js$': '<rootDir>/node_modules/babel-jest',
    '.*\\.(vue)$': '<rootDir>/node_modules/vue-jest',
  },
  testPathIgnorePatterns: [
    '<rootDir>/test/e2e',
  ],
  snapshotSerializers: ['<rootDir>/node_modules/jest-serializer-vue'],
  setupFiles: ['<rootDir>/test/unit/setup'],
  coverageDirectory: '<rootDir>/test/unit/coverage',
  collectCoverageFrom: [
    'src/**/*.{js,vue}',
    '!src/main.js',
    '!src/router/departmentalExpenses.js',
    '!**/node_modules/**',
  ],
};

unit目录下我们再建立一个specs目录,用于存放我们的测试用例,不建立也可以。执行test命令时,会自动检查文件后缀为spec.js的文件进行单元测试,并生成测试覆盖数据。

vue项目中引入jestVue-Test-Utils 通常情况就这几种,后续有新的方案,会再补充上来,也欢迎指正。

推荐阅读更多精彩内容