使用截图测试库screenshot-tests-for-android指南

使用截图测试库screenshot-tests-for-android指南

screenshot-tests-for-androidGenerate fast deterministic screenshots during Android instrumentation tests项目地址:https://gitcode.com/gh_mirrors/sc/screenshot-tests-for-android

1. 项目目录结构及介绍

screenshot-tests-for-android 的目录结构如下：

• buildSrc: 包含构建时依赖的自定义代码。
• docs: 文档相关资料。
• lib: 存放核心库的源代码。
• sample: 示例应用项目，展示了如何在实际项目中集成和使用截图测试。
• src: 主要的源代码，包括插件的实现和测试。
• gradle: 插件相关的Gradle脚本。

这个库主要提供了用于Android应用程序的自动化截图测试功能，包括录制参考图片和比较新版本截图以检测界面差异。

2. 项目启动文件介绍

• build.gradle: 在根目录下的build.gradle文件是整个项目的构建配置，它包含了对所有子模块的管理以及插件的全局设置。
• build.gradle.kt: 在lib目录下，这是库模块的构建文件，定义了库的打包和发布相关配置。
• SampleApp/build.gradle: 样例应用的构建文件，展示了如何在应用项目中使用截图测试插件。

要运行截图测试，你需要在你的Android测试类中创建截图，这些截图将在特定的测试任务执行时被捕获。

3. 项目配置文件介绍

Gradle 插件配置

在你的项目根目录的build.gradle文件中，需要引入并应用screenshot-tests-for-android的Gradle插件：

buildscript {
    dependencies {
        classpath 'com.facebook.testing.screenshot:plugin:0.14.0'
    }
}

apply plugin: 'com.facebook.testing.screenshot'

这将自动创建一些Gradle任务，如recordScreenshots和compareScreenshots。

应用模块配置

在你的应用模块的build.gradle文件中，需要添加以下配置来支持截图测试：

dependencies {
    screenshotTestImplementation 'com.facebook.testing.screenshot:core:0.14.0'
}

为了启用Compose Preview Screenshot Testing（如果适用），还需添加以下配置：

composeOptions {
    kotlinCompilerExtensionVersion '1.5.4'
}
experimentalProperties["android.experimental.enableScreenshotTest"] = true

并且确保添加了UI工具ing依赖：

dependencies {
    screenshotTestImplementation("androidx.compose.ui:ui-tooling")
}

测试类配置

在你的测试类中，你可以使用adb命令或者在IDE内运行相应的Gradle任务来触发截图的录制和对比。

例如，在一个测试类中创建截图：

@Test
public void myScreenshotTest() {
    View view = ...; // 获取你要截图的视图
    Screenshot.capture(view, "my_view_name");
}

当你更新代码后，可以重新运行compareScreenshots任务，它会将新生成的截图与已有的参考截图进行比对，并报告任何差异。

更多详细配置和用法可以参考官方文档：http://facebook.github.io/screenshot-tests-for-android/#getting-started

通过以上步骤，你就能在Android项目中成功集成并使用screenshot-tests-for-android库来进行界面一致性测试了。记得保持版本更新，以获取最新的特性和修复。

screenshot-tests-for-androidGenerate fast deterministic screenshots during Android instrumentation tests项目地址:https://gitcode.com/gh_mirrors/sc/screenshot-tests-for-android