Dropbox Dropshots 使用指南

Dropbox Dropshots 使用指南

dropshots Easy on-device screenshot testing for Android. 项目地址: https://gitcode.com/gh_mirrors/dr/dropshots

Dropshots 是一个专为 Android 设计的库和 Gradle 插件，旨在简化设备上的截图测试流程。它允许开发者在实际运行的测试中直接进行截图验证，确保截图与参考图片一致，并且支持自动化管理这些参照图像。

1. 项目目录结构及介绍

Dropshots 的仓库遵循了标准的 GitHub 开源项目结构，其主要组成部分如下：

• 根目录：

  • LICENSE.txt：包含了项目使用的 Apache-2.0 许可协议。
  • README.md：项目的主要文档，介绍了项目的用途、安装、使用方法及贡献指南。
  • build.gradle.kts 或相关构建脚本示例，用于展示如何集成到 Android 项目中。
  • settings.gradle.kts：可能包含插件管理和仓库配置。
  • dropshots 和 dropshots-gradle-plugin 目录：分别是库代码和Gradle插件的实现。
  • sample 目录：通常包括一个示例应用或模块，演示如何使用此项目。
  • .editorconfig, .gitignore：配置编辑器行为和忽略提交的文件类型。

• src: 包含源代码和资源文件。

  • androidTest: 存放所有 Android 测试案例，包括使用 Dropshots 进行截图测试的实例。
  • main: 核心业务逻辑或公共代码。
  • screenshots: 参考截图存储路径（项目初始化后自动生成）。

2. 项目的启动文件介绍

Dropshots 不直接有一个“启动文件”如传统应用程序那样。但是，对于开发人员来说，重要的“启动点”是将插件添加到自己的 Android 项目中，这通常是通过修改两个主要文件来完成：

• 在每个要使用 Dropshots 的模块的 build.gradle.kts 文件中加入插件引用和必要的依赖项。

  plugins {
      id("com.android.application") // 或者 id("com.android.library")
      id("com.dropbox.dropshots") version "版本号"
  }
  

• 如果项目使用的是旧版的插件管理方式，则需在 buildscript 部分添加类路径并应用插件。

启动项目时的实际执行不在于特定的启动文件，而是通过执行 Gradle 命令，特别是 connectedAndroidTest，来运行包含 Dropshots 测试的测试套件。

3. 项目的配置文件介绍

Gradle 配置

• 全局 Gradle 设置 (settings.gradle.kts) 应该包含 Maven 中央仓库的配置以获取 Dropshots 插件。

  pluginsManagement {
      repositories {
          mavenCentral()
          gradlePluginPortal()
      }
  }
  

• 模块级 Gradle 配置 (build.gradle.kts) 应用 Dropshots 插件并配置版本。

除此之外，Dropshots 的核心配置大多是在 Gradle 层面处理的，例如添加插件以及可能存在的特定于项目的 Dropshots 配置参数。具体的配置细节，如更新截图基准或定制比较逻辑，往往通过命令行参数(-Pdropshots.record)或在测试中直接调用API来完成，而非直接在文件中硬编码。

总结起来，Dropshots 的配置和启动更多的是依赖于Gradle脚本和命令行交互，而不是传统的配置文件。

dropshots Easy on-device screenshot testing for Android. 项目地址: https://gitcode.com/gh_mirrors/dr/dropshots