Shot配置指南：Gradle插件集成与测试环境搭建完全手册

Shot配置指南：Gradle插件集成与测试环境搭建完全手册

【免费下载链接】ShotScreenshot testing library for Android项目地址: https://gitcode.com/gh_mirrors/sh/Shot

Shot是一款功能强大的Android截图测试库，能够帮助开发者轻松实现UI自动化测试，确保应用界面在不同版本迭代中保持一致性。本指南将带你完成从环境准备到插件配置的全过程，让你快速掌握Shot的核心使用方法。

环境准备：从零开始搭建测试环境

在集成Shot之前，需要确保开发环境满足以下要求：

• Android Studio 4.0+
• Gradle 6.0+
• JDK 8+
• Android SDK 21+

首先，克隆Shot项目代码库到本地：

git clone https://gitcode.com/gh_mirrors/sh/Shot

Gradle插件集成：三步完成基础配置

第一步：添加插件依赖

在项目根目录的build.gradle文件中添加Shot插件仓库：

buildscript { repositories { mavenCentral() } dependencies { classpath 'com.karumi:shot:5.14.0' } }

第二步：应用Shot插件

在应用模块的build.gradle文件中应用Shot插件，以shot-consumer/app/build.gradle为例：

apply plugin: "com.android.application" apply plugin: "kotlin-android" apply plugin: "shot"

第三步：基本配置项设置

在应用模块的build.gradle中添加Shot配置块，设置关键参数：

shot { useComposer = true showOnlyFailingTestsInReports = true tolerance = 0.5 // 容错率设置为0.5% }

高级配置：定制你的测试需求

配置参数详解

Shot提供了多种可配置参数，以满足不同测试场景的需求：

多模块项目配置

对于多模块项目，可以在每个需要截图测试的模块中单独配置Shot，例如shot-consumer/samplelibrary/build.gradle：

apply plugin: 'com.android.library' apply plugin: 'kotlin-android' apply plugin: 'shot' shot { // 库模块特定配置 tolerance = 1.0 }

测试执行：记录与验证截图

配置运行参数

在Android Studio中配置Shot测试运行参数，设置任务名称和必要参数：

Shot测试运行配置界面，展示了如何设置执行任务和参数

记录基准截图

执行以下命令记录基准截图：

./gradlew executeScreenshotTests -Precord

记录过程中，Shot会自动在设备或模拟器上运行测试并捕获截图，生成的报告如下：

Shot记录报告展示了11个截图测试用例的记录结果

验证截图变化

执行以下命令验证当前截图与基准截图的一致性：

./gradlew executeScreenshotTests

验证过程会生成详细的对比报告，标记通过和失败的测试用例：

Shot验证报告展示了测试结果和截图对比，包括通过和失败的用例

测试过程可视化

Shot提供了直观的测试过程可视化，让你可以清晰地看到测试执行情况：

记录过程

Shot记录截图过程的实时展示，显示了Gradle任务执行和设备操作

验证过程

Shot验证截图过程的实时展示，显示了测试执行和结果比对

常见问题解决

截图不一致问题

如果遇到截图不一致的情况，可以尝试以下解决方案：

1. 调整tolerance参数，适当提高容错率
2. 确保测试设备或模拟器的分辨率和DPI一致
3. 禁用设备动画，可使用项目中的脚本：shot-consumer/scripts/disable_animations.sh

测试执行超时

若测试经常超时，可以增加executionTimeout配置：

shot { executionTimeout = 900 // 设置为15分钟 }

项目结构与资源

Shot项目包含多个模块，核心功能位于以下路径：

• 插件实现：shot/src/main/scala/com/karumi/shot/ShotPlugin.scala
• 核心逻辑：core/src/main/scala/com/karumi/shot/
• Android相关代码：shot-android/src/main/java/com/karumi/shot/

通过本指南，你已经掌握了Shot的基本配置和使用方法。开始在你的项目中集成Shot，提升UI测试效率，确保应用界面的一致性吧！

【免费下载链接】ShotScreenshot testing library for Android项目地址: https://gitcode.com/gh_mirrors/sh/Shot