longhornio/longhorn-e2e-test

Longhorn E2E Test Runner 镜像文档

1. 镜像概述和主要用途

Longhorn E2E Test Runner 是一个预配置的 Docker 镜像，用于自动化执行 Longhorn 分布式块存储系统的端到端（E2E）测试。该镜像集成了测试所需的全部依赖工具和环境，旨在简化 Longhorn 测试流程，确保其在不同环境和场景下的功能正确性、稳定性与兼容性。

主要用途：

• 执行 Longhorn 核心功能的自动化测试（如卷创建、快照、备份、恢复等）
• 验证 Longhorn 在不同 Kubernetes 集群环境中的兼容性
• 支持性能测试、灾难恢复测试等高级场景
• 生成标准化测试报告，辅助问题定位和版本验证

2. 核心功能和特性

2.1 预配置测试环境

• 内置测试依赖工具：kubectl、helm、longhornctl、ginkgo（测试框架）、jq（JSON 解析）等
• 集成 Longhorn 测试套件（longhorn-tests），无需额外下载

2.2 多场景测试支持

• 功能测试：验证基础卷操作（创建、删除、扩容）、快照/备份、DR 卷、卷克隆等核心功能
• 兼容性测试：支持指定 Longhorn 版本、Kubernetes 版本进行兼容性验证
• 性能测试：可配置 IOPS/带宽测试参数，生成性能指标报告
• 灾难恢复测试：模拟节点故障、网络分区等场景，验证数据一致性

2.3 灵活的集成能力

• 支持与 Kubernetes 集群直接集成（通过挂载 kubeconfig 访问集群）
• 兼容主流 CI/CD 流水线（Jenkins、GitLab CI、GitHub Actions 等）

2.4 测试结果管理

• 自动生成 JUnit 格式测试报告，支持导出至本地文件或外部存储
• 实时输出测试日志，支持调试模式（-v 选项）

3. 使用场景和适用范围

3.1 适用场景

• 开发团队：日常功能验证、回归测试、新版本发布前的集成测试
• CI/CD 流水线：作为构建流程的环节，自动验证代码提交或版本更新
• 用户验证：部署 Longhorn 前，在目标环境中执行自定义测试用例
• 兼容性验证：测试 Longhorn 与不同 Kubernetes 版本（如 1.24+、1.27+）、操作系统（Ubuntu、CentOS）的兼容性

3.2 环境要求

• 运行容器的主机需支持 Docker（20.10+）
• 可访问的 Kubernetes 集群（1.24+，已配置 Longhorn 或支持动态部署 Longhorn）
• 主机需具备网络访问权限（用于拉取依赖镜像或测试报告上传）

4. 详细使用方法和配置说明

4.1 前提条件

• 本地已安装 Docker
• 拥有 Kubernetes 集群的访问权限（kubeconfig 文件可用）
• 集群已满足 Longhorn 部署要求（如存储、网络插件等）

4.2 获取镜像

从镜像仓库拉取最新版本（具体版本需替换 <tag>）：

bash
docker pull longhornio/e2e-test-runner:<tag>
# 示例：拉取 v1.6.0 版本
docker pull longhornio/e2e-test-runner:v1.6.0

4.3 基本使用流程

4.3.1 运行测试容器

通过 docker run 启动容器，需挂载 kubeconfig 以访问 Kubernetes 集群，并指定测试参数：

bash
docker run -it --rm \
  -v $HOME/.kube/config:/root/.kube/config \  # 挂载本地 kubeconfig
  -e TEST_TYPE=functional \                  # 测试类型：functional/performance/disaster
  -e LONGHORN_VERSION=v1.6.0 \               # 目标 Longhorn 版本（默认 latest）
  -e TEST_TIMEOUT=3600 \                     # 测试超时时间（秒，默认 3600）
  -v $(pwd)/reports:/reports \               # 挂载本地目录存储测试报告
  longhornio/e2e-test-runner:v1.6.0

4.3.2 自定义测试用例

如需执行特定测试用例，可通过命令行参数覆盖默认配置：

bash
docker run -it --rm \
  -v $HOME/.kube/config:/root/.kube/config \
  longhornio/e2e-test-runner:v1.6.0 \
  ginkgo --focus="卷快照与恢复" --timeout=2h /longhorn-tests/e2e  # 仅执行“卷快照与恢复”用例

4.4 环境变量配置

通过环境变量自定义测试行为，常用变量如下：

4.5 测试结果查看

测试完成后，报告默认生成在容器内 $REPORT_PATH（如 /reports），可通过挂载目录在本地查看：

bash
# 示例：查看 JUnit 格式报告
cat $(pwd)/reports/junit-report.xml

# 查看测试日志
cat $(pwd)/reports/test.log

5. Docker Compose 部署示例

以下是 docker-compose.yml 配置示例，用于快速启动测试环境：

yaml
version: '3.8'

services:
  longhorn-e2e-test:
    image: longhornio/e2e-test-runner:v1.6.0
    volumes:
      - $HOME/.kube/config:/root/.kube/config:ro  # 只读挂载 kubeconfig
      - ./reports:/reports                        # 本地报告目录
    environment:
      - TEST_TYPE=performance
      - LONGHORN_VERSION=v1.6.0
      - TEST_TIMEOUT=7200  # 2小时超时
      - DEBUG_MODE=true
    command: ["ginkgo", "--focus=卷性能测试", "/longhorn-tests/e2e"]  # 执行性能测试用例

启动命令：

bash
docker-compose up

6. 注意事项

• 确保 Kubernetes 集群资源充足（建议至少 3 节点，每节点 4 CPU/8GB 内存）
• 测试期间避免手动操作 Longhorn 资源，以免干扰测试结果
• 如需测试 Longhorn 升级场景，需提前在集群中部署旧版本 Longhorn
• 敏感信息（如集群凭证）建议通过环境变量或挂载文件传递，避免硬编码在命令中