VisualReview 开源项目教程
1、项目介绍
VisualReview 是一个用于测试和审查视觉回归的人性化工具。它通过接受来自 Selenium 或 Protractor 脚本的截图,并将这些截图与之前上传和审查的截图进行比较,从而帮助用户识别和评估应用程序中的视觉变化。VisualReview 提供了一个服务器,该服务器可以显示并突出显示两组截图之间的差异,并允许用户接受或拒绝这些变化。
2、项目快速启动
2.1 下载和启动 VisualReview 服务器
首先,下载并解压最新版本的 VisualReview,或者从源代码构建并运行。
# 下载最新版本
wget https://github.com/xebia/VisualReview/releases/latest/download/visualreview.zip
unzip visualreview.zip
cd visualreview
# 或者从源代码构建
git clone https://github.com/xebia/VisualReview.git
cd VisualReview
./build.sh
2.2 配置和启动服务器
根据需要重新配置 config.edn
文件(可选),然后运行启动脚本。
# 启动服务器
./start.sh
2.3 访问 VisualReview 界面
在浏览器中访问 http://localhost:7000
(或您在 config.edn
中配置的端口),检查是否一切正常。您应该会看到一个空的项目列表。
2.4 运行您的第一个测试
在测试过程中发送截图到 VisualReview。目前,VisualReview 提供了一个 Protractor 插件来实现这一点。请参阅 protractor-plugin
的 README 文件,了解如何配置 Protractor 以发送截图到 VisualReview。
// 配置 Protractor 插件
exports.config = {
// 其他 Protractor 配置
plugins: [{
package: 'protractor-visualreview-plugin',
name: 'myProject',
baseline: 'baseline',
suite: 'mySuite'
}]
};
2.5 审查结果
返回 VisualReview 页面(http://localhost:7000
),导航到您的项目和套件名称。在这里,您可以看到所有针对该项目和套件组合运行的测试脚本。点击运行以审查所有截图和差异。如果是第一次在该套件中创建运行,将不会有任何差异。
3、应用案例和最佳实践
3.1 应用案例
VisualReview 适用于需要频繁进行视觉回归测试的 Web 应用程序。例如,一个电子商务网站在每次更新后都需要确保页面布局没有发生变化,VisualReview 可以帮助开发团队快速识别和修复视觉问题。
3.2 最佳实践
- 定期运行测试:建议在每次代码提交后运行视觉回归测试,以确保新代码不会引入视觉问题。
- 维护基线截图:定期更新基线截图,以反映最新的设计标准。
- 自动化集成:将 VisualReview 集成到 CI/CD 管道中,以便在每次构建时自动运行测试。
4、典型生态项目
4.1 Protractor
Protractor 是一个用于 Angular 和 AngularJS 应用程序的端到端测试框架。VisualReview 提供了 Protractor 插件,使得从 Protractor 测试中上传截图变得非常容易。
4.2 Selenium
Selenium 是一个用于 Web 应用程序的自动化测试工具。VisualReview 可以与 Selenium 集成,以接受来自 Selenium 脚本的截图,并进行视觉回归测试。
4.3 CI/CD 工具
VisualReview 可以与各种 CI/CD 工具(如 Jenkins、GitLab CI 等)集成,以便在每次构建时自动运行视觉回归测试,并生成测试报告。
通过以上步骤,您可以快速启动并使用 VisualReview 进行视觉回归测试,并将其集成到您的开发流程中。