使用Karma做vue組件單元測試的實現(xiàn)
養(yǎng)成良好的編碼習(xí)慣,一個合格的程序員需要掌握一些編寫單元測試的能力。單元測試也可以整體上提升我們的代碼質(zhì)量,這里介紹下 VUE 組件的單元測試。
如果想直接通過 Demo 學(xué)習(xí),可以跳過下面的內(nèi)容,點擊這里下載示例
技術(shù)棧
- @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 命令創(chuàng)建該文件,我們定義如下配置:
// 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
})
}
- 設(shè)置 frameworks 為 ['mocha'],即使用 mocha 測試框架
- 設(shè)置 files 為 ['test/**/*.spec.js'],即對 test 目錄下所有的后綴為 .spec.js 文件測試
- 設(shè)置 preprocessors 為 {'**/*.spec.js': ['webpack', 'sourcemap']},即使用 webpack,sourcemap 對所有的測試文件進(jìn)行 webpack 打包
- 設(shè)置 browsers 為 Chrome,即使用 Chrome 瀏覽器作為測試瀏覽器
編寫測試用例
詳細(xì)的關(guān)于 @vue/test-utils 用法,查看 https://vue-test-utils.vuejs.org/zh/
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 標(biāo)簽', () => {
expect(header.exists()).to.be.true
})
it('有 h1 標(biāo)簽', () => {
expect(h1.exists()).to.be.true
})
it('h1 的文案為“VUE 單頁模版”', () => {
expect(h1.text()).to.equal('VUE 單頁模版')
})
it('h1 標(biāo)簽在 header 標(biāo)簽中', () => {
expect(header.contains('h1')).to.be.true
})
})
這里我引用 vue-single-page 的 Header 組件測試用例
- 首先通過 shallowMount 獲取 wrapper
- 使用 chai 斷言庫編寫相關(guān)的測試用例
運行結(jié)果
i 「wdm」: Compiled successfully.
15 01 2020 18:28:13.799:INFO [karma-server]: Karma v4.4.1 server started at http://0.0.0.0:9876/
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
可以看到我們的單元測試已經(jīng)通過了
測試覆蓋率報告
測試完成后,我們需要查看測試覆蓋率報告。這需要在 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)
添加一個優(yōu)先執(zhí)行的編譯 .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' ]
//...
})
}
- 設(shè)置 reporters 為 [ 'coverage-istanbul' ],即使用 coverage-istanbul reporters
- coverageIstanbulReporter 配置項用于設(shè)置 coverage-istanbul 的參數(shù),詳細(xì)的參數(shù)可以參考 這里
運行結(jié)果
再次執(zhí)行單元測試,我們會看到測試覆蓋率的相關(guān)信息
----------------|----------|----------|----------|----------|-------------------| File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s | ----------------|----------|----------|----------|----------|-------------------| All files | 100 | 100 | 100 | 100 | | Header.spec.js | 100 | 100 | 100 | 100 | | ----------------|----------|----------|----------|----------|-------------------|
也可以通過生成到 coverage 目錄下的網(wǎng)頁文件,在瀏覽器中查看

參考資料
https://vue-test-utils.vuejs.org/zh/
https://github.com/mattlewis92/karma-coverage-istanbul-reporter
以上就是本文的全部內(nèi)容,希望對大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
Vue全局使用less樣式,組件使用全局樣式文件中定義的變量操作
這篇文章主要介紹了Vue全局使用less樣式,組件使用全局樣式文件中定義的變量操作,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2020-10-10
Vue項目中安裝依賴npm?install一直報錯的解決過程
這篇文章主要給大家介紹了關(guān)于Vue項目中安裝依賴npm?install一直報錯的解決過程,要解決NPM安裝依賴報錯,首先要分析出錯誤的原因,文中將解決的過程介紹的非常詳細(xì),需要的朋友可以參考下2023-05-05
Vue3之父子組件異步props數(shù)據(jù)的傳值方式
這篇文章主要介紹了Vue3之父子組件異步props數(shù)據(jù)的傳值方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2025-04-04

