Swift-Snapshot-Testing 在 GitHub Actions 中的常见问题及解决方案

问题背景

在 iOS 开发中使用 Swift-Snapshot-Testing 进行 UI 测试时，开发者可能会遇到一个常见问题：测试在本地运行正常，但在 GitHub Actions 等 CI 环境中却失败，并返回退出代码 65 的错误。这种情况通常发生在使用 assertSnapshot(of: vc, as: .image) 方法进行视图控制器截图测试时。

问题分析

退出代码 65 通常表示测试失败，但在这种情况下，失败的原因并不是代码逻辑问题，而是与测试环境相关的因素。主要可能的原因包括：

1. 模拟器差异：本地开发环境和 CI 环境使用的模拟器版本或设备型号不一致
2. 渲染差异：不同环境下的图形渲染可能存在细微差别
3. 精度问题：默认的像素级比较可能过于严格

解决方案

1. 统一测试环境

确保 CI 环境使用的模拟器与本地开发环境完全一致。可以在 GitHub Actions 的配置文件中明确指定模拟器型号和系统版本。

jobs:
  test:
    runs-on: macOS-latest
    steps:
      - uses: actions/checkout@v2
      - name: Select Xcode version
        run: sudo xcode-select -s /Applications/Xcode_14.app
      - name: Run tests
        run: xcodebuild test -scheme YourScheme -destination 'platform=iOS Simulator,name=iPhone 14,OS=16.2'

2. 调整测试精度

Swift-Snapshot-Testing 提供了精度参数，可以放宽像素比较的标准：

assertSnapshot(
  of: vc, 
  as: .image(precision: 0.98),  // 允许2%的像素差异
  named: "default"
)

通常建议从 0.98 开始尝试，根据测试结果调整到合适的值。

3. 使用相同的模拟器进行本地测试

在本地开发时，使用与 CI 环境相同的模拟器配置进行测试，可以提前发现问题：

1. 在 Xcode 中打开 Devices and Simulators 窗口
2. 创建与 CI 环境完全相同的模拟器配置
3. 使用该模拟器运行测试

4. 考虑测试策略

对于某些复杂的 UI，截图测试可能不是最佳选择。可以考虑：

• 只测试关键 UI 组件而非整个屏幕
• 使用 ViewInspector 等工具进行更细粒度的断言
• 结合单元测试验证业务逻辑

最佳实践

1. 版本控制：将参考截图和测试代码一起提交到版本控制
2. 环境一致性：确保开发、CI 和生产环境的一致性
3. 测试粒度：合理设计测试范围，避免过度依赖截图测试
4. 定期更新：随着 iOS 版本更新，及时更新测试环境和参考截图

通过以上方法，可以显著提高 Swift-Snapshot-Testing 在 CI 环境中的稳定性，确保自动化测试流程的可靠性。