欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

使用Karma做vue组件单元测试的实现

程序员文章站 2022-06-22 14:08:58
养成良好的编码习惯,一个合格的程序员需要掌握一些编写单元测试的能力。单元测试也可以整体上提升我们的代码质量,这里介绍下 vue 组件的单元测试。 如果想直接通过 demo 学习,可以...

养成良好的编码习惯,一个合格的程序员需要掌握一些编写单元测试的能力。单元测试也可以整体上提升我们的代码质量,这里介绍下 vue 组件的单元测试。

如果想直接通过 demo 学习,可以跳过下面的内容,

技术栈

  • @vue/test-utils[1.0.0-beta.30]
  • istanbul-instrumenter-loader[3.0.1]
  • karma[4.4.1]
  • karma-chrome-launcher[3.1.0]
  • karma-mocha[1.3.0]
  • karma-sourcemap-loader[0.3.7]
  • karma-coverage-istanbul-reporter[2.1.1]
  • karma-webpack[4.0.2]
  • webpack[4.41.5]

定义配置文件

karma.conf.js 文件用于 karma 的配置,使用 node_modules/.bin/karma init 命令创建该文件,我们定义如下配置:

// karma configuration

const webpackconfig = require('./config/webpack.test.config.js')

module.exports = function(config) {
 config.set({

  // base path that will be used to resolve all patterns (eg. files, exclude)
  basepath: '.',

  // frameworks to use
  // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
  frameworks: [ 'mocha' ],

  // list of files / patterns to load in the browser
  files: [
   'test/**/*.spec.js'
  ],

  // preprocess matching files before serving them to the browser
  // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor
  preprocessors: {
   'test/**/*.spec.js': [ 'webpack', 'sourcemap' ]
  },

  // webpack config
  webpack: webpackconfig,

  webpackmiddleware: {
   stats: 'errors-only'
  },

  // web server port
  port: 9876,

  // enable / disable colors in the output (reporters and logs)
  colors: true,

  // level of logging
  // possible values: config.log_disable || config.log_error || config.log_warn || config.log_info || config.log_debug
  loglevel: config.log_info,

  // enable / disable watching file and executing tests whenever any file changes
  autowatch: true,

  // start these browsers
  // available browser launchers: https://npmjs.org/browse/keyword/karma-launcher
  browsers: [ 'chrome' ],

  // continuous integration mode
  // if true, karma captures browsers, runs the tests and exits
  singlerun: false,

  // concurrency level
  // how many browser should be started simultaneous
  concurrency: infinity
 })
}

  1. 设置 frameworks 为 ['mocha'],即使用 mocha 测试框架
  2. 设置 files 为 ['test/**/*.spec.js'],即对 test 目录下所有的后缀为 .spec.js 文件测试
  3. 设置 preprocessors 为 {'**/*.spec.js': ['webpack', 'sourcemap']},即使用 webpack,sourcemap 对所有的测试文件进行 webpack 打包
  4. 设置 browsers 为 chrome,即使用 chrome 浏览器作为测试浏览器

编写测试用例

详细的关于 @vue/test-utils 用法,查看

import { expect } from 'chai'
import { shallowmount } from '@vue/test-utils'
import header from '../src/components/header'

describe('header', () => {
 const wrapper = shallowmount(header)
 const header = wrapper.find('header')
 const h1 = wrapper.find('h1')

 it('有 header 标签', () => {
  expect(header.exists()).to.be.true
 })

 it('有 h1 标签', () => {
  expect(h1.exists()).to.be.true
 })

 it('h1 的文案为“vue 单页模版”', () => {
  expect(h1.text()).to.equal('vue 单页模版')
 })

 it('h1 标签在 header 标签中', () => {
  expect(header.contains('h1')).to.be.true
 })
})

这里我引用 vue-single-page 的 header 组件测试用例

  1. 首先通过 shallowmount 获取 wrapper
  2. 使用 chai 断言库编写相关的测试用例

运行结果

i 「wdm」: compiled successfully.
15 01 2020 18:28:13.799:info [karma-server]: karma v4.4.1 server started at
15 01 2020 18:28:13.813:info [launcher]: launching browsers chrome with concurrency unlimited
15 01 2020 18:28:13.820:info [launcher]: starting browser chrome
15 01 2020 18:28:17.075:info [chrome 79.0.3945 (windows 10.0.0)]: connected on socket pukpz4ibufzevnssaaaa with id 91716917
total: 4 success

可以看到我们的单元测试已经通过了

测试覆盖率报告

测试完成后,我们需要查看测试覆盖率报告。这需要在 webpack.test.config.js 和 karma.conf.js 中做一些配置修改

webpack.test.config.js

const merge = require('webpack-merge')
const path = require('path')
const webpackcommonconfig = require('./webpack.common.config')

const testconfig = {
 devtool: 'inline-source-map',
 mode: 'none',
 module: {
  rules: [
   {
    test: /\.spec.js$/i,
    enforce: 'pre',
    use: [
     {
      loader: 'istanbul-instrumenter-loader',
      options: {
       esmodules: true
      }
     }
    ]
   }
  ]
 }
}

module.exports = merge(webpackcommonconfig, testconfig)

添加一个优先执行的编译 .spec.js 文件的 rules,loader 使用 istanbul-instrumenter-loader 并开启 esmodules 模式

karma.conf.js

module.exports = function(config) {
 config.set({
 
  // ...
  
  coverageistanbulreporter: {
   reports: [ 'html', 'text' ],
   fixwebpacksourcepaths: true
  },
  
  reporters: [ 'coverage-istanbul' ]

  //...
  
 })
}

  1. 设置 reporters 为 [ 'coverage-istanbul' ],即使用 coverage-istanbul reporters
  2. coverageistanbulreporter 配置项用于设置 coverage-istanbul 的参数,详细的参数可以参考

运行结果

再次执行单元测试,我们会看到测试覆盖率的相关信息

----------------|----------|----------|----------|----------|-------------------|
file      | % stmts | % branch | % funcs | % lines | uncovered line #s |
----------------|----------|----------|----------|----------|-------------------|
all files    |   100 |   100 |   100 |   100 |          |
 header.spec.js |   100 |   100 |   100 |   100 |          |
----------------|----------|----------|----------|----------|-------------------|

也可以通过生成到 coverage 目录下的网页文件,在浏览器中查看

使用Karma做vue组件单元测试的实现

参考资料



以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。