opendatacube/datacube-tests 镜像文档

镜像概述和主要用途

opendatacube/datacube-tests 是一个专为运行 datacube-core 项目测试套件设计的 Docker 镜像。该镜像托管于 Docker Hub，集成了执行 datacube-core 测试所需的完整依赖环境，旨在为开发者提供标准化、可重复的测试执行环境，简化测试流程并确保环境一致性。

核心功能和特性

• 完整依赖集成：预装 datacube-core 测试套件运行所需的全部依赖（包括 Python 环境、测试框架、依赖库等），无需手动配置环境。
• 多测试类型支持：兼容 datacube-core 项目中的各类测试（如单元测试、集成测试等），通过项目内测试脚本（如 check-code.sh）灵活指定测试范围。
• 环境一致性：消除本地环境差异导致的测试结果不一致问题，确保测试在标准化环境中执行。
• 轻量高效：基于精简基础镜像构建，启动快速，资源占用低，易于集成到开发或 CI/CD 流程。

使用场景和适用范围

适用用户

• datacube-core 项目的开发者和贡献者。
• 需要验证代码变更（如功能开发、bug 修复）对项目稳定性影响的测试人员。

典型场景

• 本地开发测试：开发者在本地修改代码后，通过该镜像快速执行测试，验证代码正确性。
• CI/CD 流程集成：作为持续集成/部署流程的环节，在代码提交或 PR 阶段自动运行测试，确保代码质量。
• 跨平台测试验证：在不同操作系统（如 Windows、macOS、Linux）下，通过 Docker 统一测试环境，避免平台差异导致的测试问题。

详细的使用方法和配置说明

前提条件

• 已安装 Docker 引擎（参考 Docker ***安装文档）。
• 本地已克隆 datacube-core 代码仓库（或需测试的代码目录）。

获取镜像

从 Docker Hub 拉取最新版本镜像：

shell
docker pull opendatacube/datacube-tests:latest

基本使用流程

1. 克隆代码仓库（若未克隆）：

   shell
   git clone [***]
   cd datacube-core
   

2. 运行测试容器： 通过 docker run 命令启动容器，挂载本地代码目录至容器内测试路径，并执行测试命令。基本语法如下：

   shell
   docker run --rm \
     -v [本地代码路径]:/src/datacube-core \
     opendatacube/datacube-tests:[标签] \
     [测试命令]
   

参数说明

自定义配置

环境变量

通过 -e 参数可传递自定义环境变量，用于调整测试行为（具体支持的变量需参考 datacube-core 测试文档）。示例：

shell
docker run --rm \
  -v $(pwd):/src/datacube-core \
  -e TEST_TIMEOUT=300 \  # 设置测试超时时间为 300 秒
  opendatacube/datacube-tests:latest \
  ./check-code.sh unit_tests

测试脚本参数

通过测试脚本（如 check-code.sh）传递参数，可指定测试模块、输出格式等。示例：

shell
docker run --rm \
  -v $(pwd):/src/datacube-core \
  opendatacube/datacube-tests:latest \
  ./check-code.sh unit_tests --module datacube.testing  # 仅运行指定模块的单元测试

注：具体支持的脚本参数需参考 datacube-core 项目的 check-code.sh 脚本说明或测试文档。

Docker 部署示例

本地运行集成测试示例

以下命令演示如何在本地克隆代码后，使用镜像运行 datacube-core 集成测试：

shell
# 克隆代码仓库
git clone [***]
cd datacube-core

# 运行集成测试
docker run --rm \
  -v $(pwd):/src/datacube-core \  # 挂载本地代码到容器测试路径
  opendatacube/datacube-tests:latest \  # 使用最新版本镜像
  ./check-code.sh integration_tests  # 执行集成测试脚本

执行后，测试结果（通过/失败情况、详细日志）将直接输出到终端。