改进的图形用户界面测试
GIMP 有大量相互交织的菜单、对话框和工具。当我们修改界面的一部分时,另一部分可能会停止工作,有时问题会被遗漏,直到用户报告才发现。
为了尽早发现这些问题,我们实现了一个新的 GUI 测试平台。一个典型的 GUI 测试会启动 GIMP,点击菜单和按钮,然后检查结果。每次我们合并贡献者的更改时,这些测试都会自动运行。
为什么需要这些测试
GIMP 已经有单元测试。单元测试检查代码的一个小部分,例如 GIMP 如何读取 XCF 文件。但我们的单元测试不会打开真实窗口。因此它无法告诉我们对话框是否会打开,或者菜单项是否完成了它的工作。
请注意,GIMP 之前已经有 GUI 代码的测试,通常直接与核心代码交互,有时甚至模拟输入设备的事件(指针移动、点击、拖拽……)。但没有什么能比与真实界面交互更好。此外,这类直接劫持核心代码的遗留测试本身也有问题,比如经常无故失败(而不是因为它们检测到了 bug),同时还无法检测到整类 bug。
UI 测试以你使用程序的方式,将程序作为一个整体来检查。
测试做什么
每个测试启动一个真实的 GIMP 并执行一个小任务。然后从 GIMP 读取结果。如果结果不正确,测试就会失败并告诉我们哪里出了问题。
目前我们有 13 个测试。它们检查:
- GIMP 启动并显示主窗口。
- 欢迎对话框在正确的选项卡上打开。当你关闭“启动时显示”时,它也会保持隐藏。
- 文件 > 新建 会创建一个你设定尺寸的图像。
- 文件 > 导出为 会写入一个正确的 PNG 文件。
- 工具 > 交换颜色 会交换前景色和背景色。
- 你可以在颜色对话框中输入新的前景色。
- 你可以添加图层和删除图层。
- 撤销和重做正常工作。
- 放大 会改变缩放级别。
- 点击工具箱中的工具按钮会选中该工具。然后测试在画布上使用油漆桶填充工具。
- 在首选项中进行的更改在点击确定后会被保存。
- 菜单操作 图像 > 拼合图像 会完成它的工作。
它们如何工作
这些测试不需要屏幕。每个测试启动一个小型隐藏桌面,在其中运行 GIMP,并在结束时移除它。因此,测试可以在我们的 CI 服务器上运行,那里没有可用的屏幕。
为了找到按钮或菜单,测试不会查看屏幕上的像素。它们使用 GIMP 提供给屏幕阅读器等工具的无障碍信息。这还有一个好处:当我们让 GIMP 更易于测试时,我们也让它更易于与屏幕阅读器一起使用,从而改善软件的无障碍性。
测试使用 dogtail,一个用于 UI 测试的 Python 工具。为了在没有屏幕的服务器上运行 GIMP,dogtail 需要一个新功能。我们将这个功能贡献给了上游的 dogtail 本身,这样其他项目也可以使用它。
目前,测试仅在 Linux(X11 和 Wayland)上运行,因为 dogtail 不支持 Windows 或 macOs。
即使只添加这几个简单的测试,也大大增加了对 GIMP 构建可用的信心,同时也表明测试基础设施正在工作并且有用。
致谢
- Harsh Verma 编写了 UI 测试和新的 dogtail 功能。
- Jehan 审查了 UI 测试。
- Michal Odehnal 审查了新的 dogtail 功能。
你可以在合并请求 !2909 中阅读完整更改。
你可以如何帮助
13 个测试是一个好的开始,但 GIMP 还有更多的对话框和工具。如果你想帮忙,你可以为你最常使用的 GIMP 部分编写一个测试。
我们编写了一份指南,展示如何编写新测试以及当测试失败时如何找到原因:developer.gimp.org 上的 UI 测试。
我们希望这项工作能帮助我们更早地发现 bug,并让 GIMP 继续为所有人良好运行。
分享此内容到:Mastodon | twitter | Facebook