Testing on Headless CI Systems (Travis CI, Github Actions, Jenkins)

Electron 基于 Chromium,所以需要一个显示驱动使其运转。 如果 Chromium 无法找到一个显示驱动, Electron 会启动失败,因此无论你如何去运行它,Electron 不会执行你的任何测试。 在 Travis,Circle, Jenkins 或者类似的系统上测试基于Electron的应用时,需要进行一些配置。 本质上,我们需要使用一个 虚拟的显示驱动。

配置虚拟显示服务器

首先安装 Xvfb. 这是一个虚拟的帧缓冲,实现了X11显示服务协议,所有的图形操作都在内存中表现,而不需要显示在 任何屏幕输出设备上。这正是我们所需要的。

然后创建一个虚拟屏幕实例(Xvfb), 并导出 DISPLAY 变量, 该变量存储虚拟屏幕的引用. Electron 中的 Chromium 会自动的去寻找 $DISPLAY,所以你的应用不需要再去进行配置 这一步可以通过 Paul Betts 的 xvfb-maybe 实现自动化:如果系统需要,在xvfb-maybe前加上你的测试命令 然后这个小工具会自动的设置 xvfb。 在 Windows 或 macOS ,它不会执行任何东西。

  1. ## 在 Windows 或者 macOS,这只是调用 electron-mocha
  2. ## 在 Linux, 如果我们在一个 headless 环境,这将是等同于
  3. ## 执行 xvfb-run electron-mocha ./test/*.js
  4. xvfb-maybe electron-mocha ./test/*.js

Travis CI

在 Travis 上, 你的 .travis.yml 应该和下面的代码相似:

  1. addons:
  2. apt:
  3. packages:
  4. - xvfb
  5. install:
  6. - export DISPLAY=':99.0'
  7. - Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &

Github Actions

For Github Actions, a Xvfb action is available.

Jenkins

Jenkins下, 有一个可用的 Xvfb 插件

Circle CI

Circle CI is awesome and has Xvfb and $DISPLAY already set up, so no further configuration is required.

AppVeyor

AppVeyor 运行于 Windows 上,支持 Selenium,Chromium,Electron 以及一些类似的工具,开箱即用,无需配置