electron-vue 测试指南:基于 Karma + Mocha 的单元测试与 Spectron 端到端测试实战
electron-vue 测试指南:基于 Karma + Mocha 的单元测试与 Spectron 端到端测试实战
electron-vue 为 renderer 进程同时提供了单元测试(Unit testing)与端到端测试(End-to-end testing)两大能力,其测试配置深受官方 vuejs-templates/webpack 脚手架的影响。本文基于仓库内 docs/ko/testing.md 及相关源码,完整梳理测试体系的启用方式、目录结构、配置细节与 CI 集成方案,读完你将能够独立编写并运行 electron-vue 项目的单元测试与端到端测试,并理解 Karma、Mocha、Spectron 各组件在实际项目中的协作原理。
测试能力如何随脚手架启用
在 vue-cli 脚手架交互过程中,electron-vue 提供了独立的测试支持选项。查看 meta.js 中的提示配置可以看到两个明确的问题:
- unit:
Set up unit testing with Karma + Mocha?(是否使用 Karma + Mocha 搭建单元测试) - e2e:
Set up end-to-end testing with Spectron + Mocha?(是否使用 Spectron + Mocha 搭建端到端测试)
meta.js 中的 filters 规则进一步说明:只有当选择了对应选项,test/e2e/**/* 与 test/unit/**/* 目录才会被实际生成到项目里(分别是 'test/e2e/**/*': 'e2e' 与 'test/unit/**/*': 'unit'),同时 appveyor.yml 与 .travis.yml 只有在构建工具选择 electron-builder 时才会写入('appveyor.yml': 'builder === \'builder\''、'.travis.yml': 'builder === \'builder\'')。
对应的 npm 脚本同样由脚手架条件化生成,见 template/package.json:
{
"scripts": {
"e2e": "npm run pack && mocha test/e2e",
"unit": "karma start test/unit/karma.conf.js",
"test": "npm run unit && npm run e2e"
}
}
从模板可以看出:test 脚本是 unit 与 e2e 两个脚本的串联(如果只选择了其中一项,则只包含所选的那一项);e2e 脚本在执行 Mocha 之前会先调用 npm run pack 生成生产构建产物供 Spectron 消费。
单元测试:Karma + Mocha
electron-vue 的单元测试使用 Karma 测试运行器与 Mocha 测试框架,断言库采用 Chai。Mocha 与 Chai 分别通过 karma-mocha 与 karma-chai 集成,因此 expect 等全部 API 在测试文件中全局可用,无需在每个测试文件里手动导入。
# 启动 Karma
npm run unit
单元测试文件结构
生成后的单元测试目录结构如下:
my-project
├─ test
│ ├─ unit
│ │ ├─ specs/
│ │ ├─ index.js
│ └─ └─ └─ karma.conf.js
在绝大多数情况下,你只需要关注 specs/ 目录下的测试编写,index.js 与 karma.conf.js 可以保持默认不动。
specs/
实际测试就写在这个目录里。借助 webpack 的编译能力,测试代码可以完整使用 ES2015 语法以及所有已配置的 loader 能力。
来看仓库自带的示例测试 template/test/unit/specs/LandingPage.spec.js:
import Vue from 'vue'
import LandingPage from '@/components/LandingPage'
describe('LandingPage.vue', () => {
it('should render correct contents', () => {
const vm = new Vue({
el: document.createElement('div'),
render: h => h(LandingPage)
}).$mount()
expect(vm.$el.querySelector('.title').textContent).to.contain('Welcome to your new project!')
})
})
这个用例展示了编写 Vue 组件测试的典型套路:通过 new Vue() 挂载组件,再对渲染后的 vm.$el DOM 进行断言。@ 别名指向 src/renderer,与项目源码的导入方式保持一致。
index.js
index.js 是供 karma-webpack 使用的入口文件,其核心职责是把所有测试文件和源码"一次性"收集起来。查看 template/test/unit/index.js 的实现:
import Vue from 'vue'
Vue.config.devtools = false
Vue.config.productionTip = false
// require all test files (files that ends with .spec.js)
const testsContext = require.context('./specs', true, /\.spec$/)
testsContext.keys().forEach(testsContext)
// require all src files except main.js for coverage.
const srcContext = require.context('../../src/renderer', true, /^\.\/(?!main(\.js)?$)/)
srcContext.keys().forEach(srcContext)
这里有两个关键点:
- 通过 webpack 的
require.context递归收集./specs下所有以.spec结尾的测试文件; - 同时收集
src/renderer下除main.js之外的所有源码文件,用于生成代码覆盖率(coverage)。如果想调整覆盖率统计范围,可以修改这一行正则或收集路径。
karma.conf.js
这里是 Karma 的真实配置所在,包含 spec/coverage 报告器以及自定义的浏览器启动器。完整的配置见 template/test/unit/karma.conf.js,其要点如下:
process.env.BABEL_ENV = 'test'
let webpackConfig = merge(baseConfig, {
devtool: '#inline-source-map',
plugins: [
new webpack.DefinePlugin({
'process.env.NODE_ENV': '"testing"'
})
]
})
// don't treat dependencies as externals
delete webpackConfig.entry
delete webpackConfig.externals
delete webpackConfig.output.libraryTarget
config.set({
browsers: ['visibleElectron'],
client: {
useIframe: false
},
customLaunchers: {
'visibleElectron': {
base: 'Electron',
flags: ['--show']
}
},
frameworks: ['mocha', 'chai'],
files: ['./index.js'],
preprocessors: {
'./index.js': ['webpack', 'sourcemap']
},
reporters: ['spec', 'coverage'],
singleRun: true,
webpack: webpackConfig,
webpackMiddleware: {
noInfo: true
}
})
几个值得留意的设计:
- 它基于
.electron-vue/webpack.renderer.config通过webpack-merge合并出测试专用的 webpack 配置,同时删除entry、externals与output.libraryTarget,使依赖不再被当作外部模块; - 测试运行在 Electron 环境中:
browsers指定为自定义的visibleElectron启动器(base: 'Electron',附加--show标志让窗口可见),useIframe: false则让测试在独立窗口中而非 iframe 里运行; coverageReporter同时输出lcov格式报告与text-summary摘要,产物输出到./coverage目录;singleRun: true表示测试完成后自动退出,适合 CI 环境使用。
如果需要更多自定义,可以查阅官方 Karma 配置文档。
依赖 Mock:inject-loader
electron-vue 默认安装了 inject-loader(见 template/package.json 中 "inject-loader": "^4.0.1"),用于在测试中对依赖进行注入替换。对于 Vue 单文件组件,可以参考 vue-loader 官方文档中关于 testing with mocks 的用法来 mock 组件依赖。
端到端测试:Spectron + Mocha
端到端测试使用 Spectron 与 Mocha(搭配 Chai)框架。Mocha 与 Chai 的 API(包括 expect、should、assert)全部挂载在全局作用域中。
# 启动 Mocha
npm run e2e
需要注意的是:运行端到端测试之前,npm run e2e 会先调用 npm run pack 生成一份生产构建产物,供 Spectron 在测试期间加载。
端到端测试文件结构
my-project
├─ test
│ ├─ e2e
│ │ ├─ specs/
│ │ ├─ index.js
│ └─ └─ └─ utils.js
与单元测试类似,大多数情况下你可以忽略 index.js,把精力集中在编写 specs/ 内的测试。
specs/
实际测试编写处。得益于 babel-register 的加持,这里可以完整使用 ES2015 语法。仓库自带的示例 template/test/e2e/specs/Launch.spec.js 展示了最基本的启动测试:
import utils from '../utils'
describe('Launch', function () {
beforeEach(utils.beforeEach)
afterEach(utils.afterEach)
it('shows the proper application title', function () {
return this.app.client.getTitle()
.then(title => {
expect(title).to.equal('{{ name }}')
})
})
})
注意这里的 describe/it 都使用了普通的 function 声明而非 ES2015 箭头函数,原因下文会详细说明。
index.js
index.js 是 Mocha 的主入口,负责收集 specs/ 下所有测试。看 template/test/e2e/index.js 的实现:
// Set BABEL_ENV to use proper env config
process.env.BABEL_ENV = 'test'
// Enable use of ES6+ on required files
require('babel-register')({
ignore: /node_modules/
})
// Attach Chai APIs to global scope
const { expect, should, assert } = require('chai')
global.expect = expect
global.should = should
global.assert = assert
// Require all JS files in `./specs` for Mocha to consume
require('require-dir')('./specs')
这段代码做了三件事:设置 BABEL_ENV、通过 babel-register 让被 require 的文件支持 ES6+ 语法、把 Chai 的 expect/should/assert 挂到全局,最后用 require-dir 递归加载所有 spec 文件。
utils.js
这里存放着编写 spec 时可复用的通用函数,基础功能是提供处理 Electron 应用创建/销毁的 beforeEach 与 afterEach。完整实现见 template/test/e2e/utils.js:
import electron from 'electron'
import { Application } from 'spectron'
export default {
afterEach () {
this.timeout(10000)
if (this.app && this.app.isRunning()) {
return this.app.stop()
}
},
beforeEach () {
this.timeout(10000)
this.app = new Application({
path: electron,
args: ['dist/electron/main.js'],
startTimeout: 10000,
waitTimeout: 10000
})
return this.app.start()
}
}
其中 new Application({...}) 的配置项含义为:
path:指向 Electron 可执行文件路径,这里直接复用electron模块导出的路径;args:传给 Electron 的启动参数,即生产构建后的主进程入口dist/electron/main.js;startTimeout/waitTimeout:应用启动与等待的毫秒超时时间。
关于 Spectron 的进一步说明
Spectron 是 Electron 官方测试框架,内部同时使用 ChromeDriver 与 WebDriverIO 来操纵 DOM 元素。
使用 WebDriverIO
按照 Spectron 官方文档,WebDriverIO 的 API 可以通过 this.app.client 访问。由于 electron-vue 使用 Mocha,this 的上下文会在 afterEach、beforeEach 与 it 之间共享——这正是 utils.js 中把 this.app 挂到当前上下文的原因,也是 Launch.spec.js 里能直接访问 this.app.client 的前提。
特别提醒:正因为 this 上下文被共享,某些场景下不能使用 ES2015 箭头函数——箭头函数不会绑定自己的 this,会覆盖掉 Mocha 注入的上下文,导致 this.app 无法访问。因此在编写端到端测试时,涉及 this 的钩子与用例请使用普通 function 写法(Mocha 官方文档对箭头函数也有同样的警示)。
一次运行全部测试
在脚手架生成的 template/package.json 中,test 脚本会把单元测试与端到端测试串行执行:
npm test
"test": "npm run unit && npm run e2e"
需要注意的是 e2e 内部会先执行 npm run pack 完成生产构建,因此 npm test 的整体耗时取决于单元测试、webpack 打包与 Spectron 启动的叠加时间。
关于 CI 测试
如果在脚手架阶段选择 electron-builder 作为构建工具,那么可以轻松地在 Travis CI 与 AppVeyor 上分别针对 darwin、linux 与 win32 三种平台测试应用。
在生成的 .travis.yml 与 appveyor.yml 内部都可以找到被注释掉的测试段落,只需取消注释即可启用测试。以仓库模板 template/appveyor.yml 为例:
# Commented sections below can be used to run tests on the CI server
version: 0.1.{build}
branches:
only:
- master
image: Visual Studio 2017
platform:
- x64
cache:
- node_modules
- '%APPDATA%\npm-cache'
- '%USERPROFILE%\.electron'
- '%USERPROFILE%\AppData\Local\Yarn\cache'
install:
- ps: Install-Product node 8 x64
- git reset --hard HEAD
- yarn
- node --version
build_script:
#- yarn test
- yarn build
test: off
可以看到 build_script 段中 #- yarn test 即为注释状态下的测试入口,取消注释后 CI 会在构建前先跑一遍测试套件;同时配置文件还预置了 node_modules、npm 缓存与 .electron 缓存的 cache 配置来加速重复构建。.travis.yml 中同样保留了对应的注释段落可供启用。
更完整的自动化部署方案(包括测试通过后的发布流程)请参考 docs/ko/using-electron-builder.md 中 "Automated Deployments using CI" 一节。关于测试体系的更多细节,也可以继续阅读仓库内的 单元测试文档 与 端到端测试文档。
小结
electron-vue 的测试体系可以概括为一条清晰的链路:脚手架阶段通过 vue-cli 交互按需生成测试目录与 npm 脚本(meta.js);单元测试由 Karma 驱动,在 Electron 内运行基于 webpack 编译的 Mocha + Chai 用例,并通过 inject-loader 支持依赖 mock(karma.conf.js、index.js);端到端测试则用 Spectron + Mocha 启动真实应用,通过 this.app.client(WebDriverIO)驱动 DOM 断言(utils.js、Launch.spec.js);最后在 CI 上只需取消 .travis.yml / appveyor.yml 中的注释即可把整套测试接入自动化流水线。理解并善用这套配置,可以让你在 Electron 桌面应用的开发迭代中获得持续、可靠的质量保障。