electron-vue 测试体系全解析:基于 Karma、Mocha 与 Spectron 的单元测试与端到端测试实践
electron-vue 测试体系全解析:基于 Karma、Mocha 与 Spectron 的单元测试与端到端测试实践
electron-vue 是一个以 Electron 与 Vue.js 为基础的快速启动模板(boilerplate),其脚手架在 vue-cli 交互中允许开发者选择是否包含测试支持。本文以官方文档 docs/ja/testing.md 为主体,结合模板仓库中真实的测试配置与测试用例源码,系统讲解 electron-vue 的单元测试(Unit Testing)与端到端测试(End-to-End Testing)两套测试体系的运行方式、文件结构与底层实现,并给出在 Travis CI 与 AppVeyor 上启用持续集成测试的具体方法。读完本文,你将能够独立在自己的 electron-vue 项目中编写、运行并接入 CI 的测试用例。
测试体系总览:两套面向 renderer 进程的测试
electron-vue 的测试支持主要面向 renderer 进程,包含两条互补的测试链路:
- 单元测试(Unit Testing):使用 Karma 作为测试运行器,Mocha 作为测试框架,配合 Chai 断言库;
- 端到端测试(End-to-End Testing):使用 Spectron 驱动真实的 Electron 应用,Mocha 作为测试框架,同样配合 Chai。
这一设计「很大程度上受到官方 vuejs-templates/webpack 样板所提供测试配置的启发」(引自 docs/ja/testing.md)。在 vue-cli 脚手架交互阶段,你可以选择是否包含测试支持;一旦选中,模板会在生成的 package.json 中写入对应的依赖与 npm 脚本。
从模板的 package.json 可以印证这一点:测试相关脚本全部由脚手架的条件语法(如 {{#if unit}}、{{#if e2e}}、{{#testing unit e2e}})控制生成,选中的能力才会出现在最终项目的 scripts 中:
"unit": "karma start test/unit/karma.conf.js"(仅当选择单元测试)"e2e": "npm run pack && mocha test/e2e"(仅当选择端到端测试)"test": "npm run unit{{#e2e}} && npm run e2e{{/e2e}}"(同时选择两者时串联执行)
对应的开发依赖也在脚手架阶段按需注入,例如单元测试依赖 karma、karma-electron、karma-webpack、karma-mocha、karma-chai、karma-coverage,端到端测试依赖 spectron 与 require-dir,而两者共用 mocha、chai、babel-plugin-istanbul(详见 template/package.json)。
单元测试:Karma + Mocha + Chai
运行方式
单元测试只需一条命令即可启动 Karma:
npm run unit
该命令实际执行 karma start test/unit/karma.conf.js。Karma 会拉起一个基于 Electron 的浏览器环境(karma-electron),在真实运行时环境中加载测试文件并执行断言,同时产出覆盖率报告。
测试目录结构
脚手架生成的项目中,单元测试文件遵循如下结构:
my-project
├─ test
│ ├─ unit
│ │ ├─ specs/
│ │ ├─ index.js
│ └─ └─ └─ karma.conf.js
正如官方文档强调的:大多数情况下,你只需要关注 specs/ 目录,index.js 与 karma.conf.js 可以直接忽略——它们作为测试基础设施已经配置妥当。
specs/:真正的测试代码所在
specs/ 目录中存放实际的测试用例。得益于 webpack,测试文件可以完全使用 ES2015 语法,并访问项目中已配置的所有 loader(例如 vue-loader、babel-loader),因此你可以像写业务代码一样直接 import Vue 组件。
模板自带的示例测试 template/test/unit/specs/LandingPage.spec.js 展示了最典型的 Vue 组件挂载与断言写法:
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!')
})
})
这段测试的要点在于:
- 使用
describe/it组织用例(Mocha 语法),使用expect(Chai 的 BDD 风格断言)进行断言; - 由于
karma-mocha与karma-chai的集成,expect等 API 在测试文件中开箱即用,无需手动引入; - 通过
new Vue(...).$mount()将组件真实挂载到 DOM(测试环境提供的document),再通过vm.$el断言渲染结果。
index.js:karma-webpack 的入口聚合器
template/test/unit/index.js 是 karma-webpack 使用的入口文件,它的职责是把全部测试文件与需要统计覆盖率的源码一次性收集起来:
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 特性:
- 第一个
require.context('./specs', true, /\.spec$/)递归加载specs/下所有以.spec结尾的测试文件; - 第二个
require.context('../../src/renderer', true, ...)递归加载src/renderer下除main.js外的全部源码,供覆盖率统计使用——如果你只想对部分文件统计覆盖率,可以修改这里的正则来缩小范围。
karma.conf.js:Karma 的核心配置
template/test/unit/karma.conf.js 中存放了实际的 Karma 配置。它通过 webpack-merge 复用渲染进程的 webpack 配置,并做了一系列针对测试环境的调整,值得逐项理解:
'use strict'
const path = require('path')
const merge = require('webpack-merge')
const webpack = require('webpack')
const baseConfig = require('../../.electron-vue/webpack.renderer.config')
const projectRoot = path.resolve(__dirname, '../../src/renderer')
// Set BABEL_ENV to use proper preset config
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
// apply vue option to apply isparta-loader on js
webpackConfig.module.rules
.find(rule => rule.use.loader === 'vue-loader').use.options.loaders.js = 'babel-loader'
配置中的关键决策包括:
- 设置
BABEL_ENV = 'test',使 Babel 使用正确的预设配置(与生产构建区分); - 合并
devtool: '#inline-source-map'并注入process.env.NODE_ENV = "testing"; - 删除
entry、externals与output.libraryTarget,因为单元测试要求把依赖一起打包进测试 bundle,而不是作为外部引用; - 将
vue-loader对.js的处理替换为babel-loader,以便对测试中的 JS 代码做转换与覆盖率插桩。
Karma 主体配置如下:
module.exports = config => {
config.set({
browsers: ['visibleElectron'],
client: {
useIframe: false
},
coverageReporter: {
dir: './coverage',
reporters: [
{ type: 'lcov', subdir: '.' },
{ type: 'text-summary' }
]
},
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
}
})
}
各部分的作用:
frameworks: ['mocha', 'chai']——启用 Mocha 与 Chai 的 Karma 适配器;customLaunchers中定义visibleElectron,以 Electron 为浏览器基底并加上--show标志(测试窗口可见);client.useIframe: false——在非 iframe 模式下运行,这是karma-electron在 Electron 环境中的推荐做法;coverageReporter配置lcov与text-summary两种报告,产出到./coverage目录;singleRun: true——测试执行一次后即退出,适合 CI 场景;- 若需进一步定制,可参考 Karma 官方配置文档(原文指引见 docs/ja/unittesting.md)。
依赖的 Mock 化:inject-loader
单元测试经常需要替换组件中的依赖。electron-vue 默认安装了 inject-loader,它允许你在不修改源码的前提下注入 mock 依赖。在 Vue 单文件组件(.vue)场景下的用法,官方指引参考 vue-loader 文档中「Testing with mocks」一节(详见 docs/ja/unittesting.md)。从 template/package.json 可见,inject-loader 仅在启用单元测试时才会被写入依赖。
端到端测试:Spectron + Mocha + Chai
运行方式与前置条件
端到端测试同样只需一条命令:
npm run e2e
但请注意一个关键细节:该脚本实际执行的是 npm run pack && mocha test/e2e。也就是说,在启动测试之前,会先调用 npm run pack 生成 Spectron 在测试期间使用的生产构建(pack:main 与 pack:renderer 两个 webpack 构建步骤,定义见 template/package.json),然后再用 Mocha 运行 test/e2e 目录下的测试。
测试目录结构
my-project
├─ test
│ ├─ e2e
│ │ ├─ specs/
│ │ ├─ index.js
│ └─ └─ └─ utils.js
与单元测试类似,大多数情况下你只需关注 specs/,index.js 可以直接忽略(但 utils.js 是测试运行的基础,通常会用到)。
specs/:端到端用例
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 }}')
})
})
})
它验证了应用启动后窗口标题是否为项目名称。得益于 babel-register 的能力(见 template/test/e2e/index.js),specs/ 中的测试可以直接使用 ES2015 语法。
index.js:Mocha 主入口
template/test/e2e/index.js 作为 Mocha 的主入口,负责收集 specs/ 下所有测试,并把 Chai 断言 API 挂到全局:
'use strict'
// 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 转译外,它还通过 require-dir 批量加载 ./specs 目录下的所有测试文件,并把 expect、should、assert 三种风格的 Chai API 全部注入全局作用域——这解释了为什么测试文件里可以直接使用这些断言函数。
utils.js:通用工具与生命周期
template/test/e2e/utils.js 提供了 specs/ 中通用的辅助函数,核心是处理 Electron 应用的创建与销毁:
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()
}
}
这段代码是理解 Spectron 用法的关键:
beforeEach中通过new Application({ path: electron, args: ['dist/electron/main.js'] })创建 Spectron 应用实例,args指向npm run pack生成的主进程入口,并设置 10 秒的启动/等待超时,然后调用this.app.start()启动应用;afterEach中检查应用是否仍在运行,若是则调用this.app.stop()停止,保证每个用例之间环境干净;- 由于挂载在 Mocha 的
this上下文上,this.app在beforeEach、it、afterEach之间是共享的。
关于 Spectron 本身
Spectron 是 Electron 官方的测试框架,它组合了 ChromeDriver(用于驱动 Chromium)与 WebDriverIO(用于操作 DOM 元素与执行浏览器命令),从而允许测试代码像操作普通浏览器一样控制整个 Electron 应用。
通过 this.app.client 使用 WebDriverIO
按照 Spectron 官方文档,WebDriverIO API 通过 this.app.client 访问。由于 electron-vue 使用 Mocha,this 上下文会在 afterEach、beforeEach、it 之间共享,这正是上面 utils.js 中 this.app 能够跨钩子使用的根本原因。
这里有一个重要的实践提醒:ES2015 的箭头函数会覆盖(绑定)this 的上下文,因此在某些场景下不能在测试中使用箭头函数,否则将无法访问 this.app / this.app.client(Mocha 官方文档对箭头函数的限制有详细说明,原文指引见 docs/ja/end-to-end_testing.md)。这也是模板示例测试中统一使用 function () {...} 而非箭头函数的原因。
运行全部测试
当脚手架同时选择了单元测试与端到端测试时,package.json 会生成串联脚本(见 template/package.json):
npm test
该命令依次执行 npm run unit 与 npm run e2e,即先跑 Karma 单元测试,再打包并运行 Spectron 端到端测试,任一环节失败都会中断整体流程。
在 CI 上启用测试
官方支持的 CI 组合
如果你在脚手架阶段选择了 electron-builder 作为构建工具,那么可以非常方便地在 Travis CI(darwin、linux)与 AppVeyor(win32)上测试你的应用——三个主流桌面平台都能覆盖。
template/ 中直接提供了两个 CI 配置文件:
appveyor.yml(template/appveyor.yml)——面向 Windows;.travis.yml——面向 macOS / Linux(存在于脚手架生成的项目中)。
如何启用测试
两个文件内部都含有注释掉的测试段落,取消注释即可启用测试。以 template/appveyor.yml 为例:
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'
init:
- git config --global core.autocrlf input
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:取消注释后,AppVeyor 就会在构建阶段依次执行单元测试与端到端测试。该配置还预设了依赖缓存(node_modules、npm 缓存、.electron 缓存等)以加速构建。值得一提的是,配置文件中的注释还链接回了 testing 文档页(即本文对应的章节)。
进一步的自动化部署细节,请阅读文档 docs/ja/using-electron-builder.md 中「CI を使用した自動デプロイ(使用 CI 进行自动化部署)」一节(对应英文文档的 Automated Deployments using CI 章节)。这样,测试通过后还可以继续完成自动构建与发布,形成完整的交付流水线。
小结
electron-vue 为 renderer 进程提供了一套开箱即用的测试基础设施:
| 测试类型 | 运行命令 | 技术栈 | 关键配置/入口 |
|---|---|---|---|
| 单元测试 | npm run unit |
Karma + Mocha + Chai | test/unit/karma.conf.js |
| 端到端测试 | npm run e2e(先 npm run pack) |
Spectron + Mocha + Chai | test/e2e/index.js |
| 全部测试 | npm test |
上述两者串联 | package.json |
| CI 测试 | 取消 Travis/AppVeyor 中注释 | electron-builder + CI | appveyor.yml |
实践中只需记住三条要点:单元测试专注于 specs/ 目录编写用例;端到端测试务必理解 npm run pack 的前置构建与 this.app.client 的上下文共享机制(避免在测试中误用箭头函数);接入 CI 时取消配置文件中的注释段落即可让三个平台自动跑完整个测试集。