跳到主内容

测试

我们的目标是保持 Electron 代码覆盖率高。我们要求所有 pull request 不仅通过所有现有测试,最好还能添加新的测试来覆盖更改的代码和新场景。确保我们尽可能多地涵盖 Electron 的代码路径和用例,以确保我们发布的应用程序错误更少。

此仓库包含 JavaScript 和 C++ 的 linting 规则,以及单元测试和集成测试。要了解有关 Electron 编码风格的更多信息,请参阅编码风格文档。

Linting

为确保您的更改符合 Electron 编码风格,请运行 npm run lint,它将根据您的更改涉及的代码区域运行各种 linting 检查。

其中许多检查已包含为 precommit 钩子,因此您的错误很可能会在提交时被发现。

单元测试

如果您未使用 build-tools,请确保您为本地 Electron 构建配置的名称是 TestingReleaseDefault 之一,或者您已设置 process.env.ELECTRON_OUT_DIR。如果未设置这些,Electron 将无法执行一些预测试步骤。

要运行所有单元测试,请运行 npm run test。单元测试是一个 Electron 应用程序(惊喜!)可在 spec 文件夹中找到。请注意,它有自己的 package.json,因此其依赖项未在顶级 package.json 中定义。

要仅运行匹配特定模式的测试,请运行 npm run test -- -g=PATTERN,将 PATTERN 替换为您想要运行的测试所匹配的正则表达式。例如:如果您只想运行 IPC 测试,您可以运行 npm run test -- -g ipc

Node.js 冒烟测试

如果您进行了可能影响 Node.js 嵌入 Electron 的方式的更改,我们有一个测试运行器,它使用 Electron 的 Node.js 定制分支运行所有 Node.js 的测试。

要运行所有 Node.js 测试

$ node script/node-spec-runner.js

要运行单个 Node.js 测试

$ node script/node-spec-runner.js parallel/test-crypto-keygen

......其中传递给运行器的参数是 Node.js 源代码树中测试的路径。

在 Windows 10 设备上测试

运行单元测试的额外步骤:

  1. 必须安装 Visual Studio 2019。

  2. 必须为您的配置编译 Node 头文件。

    ninja -C out\Testing electron:node_headers
  3. 必须将 electron.lib 复制为 node.lib。

    cd out\Testing
    mkdir gen\node_headers\Release
    copy electron.lib gen\node_headers\Release\node.lib

缺失字体

一些 Windows 10 设备未预装 Meiryo 字体,这可能导致字体回退测试失败。要安装 Meiryo

  1. 按 Windows 键并搜索管理可选功能
  2. 点击添加功能
  3. 选择日语补充字体,然后点击安装

像素测量

一些依赖精确像素测量的测试可能无法在具有 Hi-DPI 屏幕设置的设备上正常工作,原因在于浮点精度错误。要正确运行这些测试,请确保设备设置为 100% 缩放。

配置显示缩放

  1. 按 Windows 键并搜索显示设置
  2. 缩放和布局下,确保设备设置为 100%。