XCTestHTMLReport 使用教程
1. 项目介绍
XCTestHTMLReport 是一个开源项目,旨在为 Xcode 的单元测试和 UI 测试生成类似于 Xcode 风格的 HTML 报告。该项目支持并行测试、多种附件格式(如 png、jpeg、heic、txt、log、mp4、gif),并且可以通过键盘的箭头键导航报告。此外,它还支持过滤测试结果、显示目标设备信息、生成 Junit 报告和 JSON 报告等功能。
2. 项目快速启动
安装
使用 Homebrew 安装
# 安装最新稳定版本
brew install xctesthtmlreport
# 安装最新开发版本
brew install xctesthtmlreport --HEAD
使用 Mint 安装
# 安装最新稳定版本
mint install XCTestHTMLReport/XCTestHTMLReport
# 安装最新开发版本
mint install XCTestHTMLReport/XCTestHTMLReport@main
使用
- 运行 UI 测试并指定
resultBundlePath
:
xcodebuild test -workspace YourWorkspace.xcworkspace -scheme YourScheme -destination 'platform=iOS Simulator,name=iPhone 14,OS=16.0' -resultBundlePath TestResults
- 使用
xchtmlreport
工具生成 HTML 报告:
xchtmlreport -r TestResults.xcresult
生成的报告将位于 TestResults.xcresult
目录下。
3. 应用案例和最佳实践
应用案例
- 自动化测试报告生成:在持续集成(CI)环境中,使用 XCTestHTMLReport 自动生成测试报告,便于团队成员查看测试结果。
- 跨平台测试结果共享:将生成的 HTML 报告分享给非技术团队成员,方便他们理解测试结果。
最佳实践
- 定期更新工具:保持 XCTestHTMLReport 的版本更新,以获取最新的功能和修复。
- 自定义报告样式:根据团队需求,自定义 HTML 报告的样式和内容。
4. 典型生态项目
- Xcode:XCTestHTMLReport 主要用于生成 Xcode 测试的 HTML 报告。
- Fastlane:可以与 Fastlane 集成,自动化测试报告的生成和分发。
- Jenkins:在 Jenkins CI 环境中使用 XCTestHTMLReport 生成测试报告,便于持续集成和交付。
通过以上步骤,您可以快速上手并使用 XCTestHTMLReport 生成美观且功能丰富的测试报告。