gitlab/gitlab-qa

GitLab QA 镜像文档

1. 镜像概述和主要用途

GitLab QA 是一个端到端（End-to-End）测试套件，旨在从整体角度验证 GitLab 应用的功能完整性。通过模拟真实用户场景和操作流程，该镜像可自动化测试 GitLab 的核心功能、集成点及系统行为，确保 GitLab 部署后的可用性和正确性。

官方项目地址：https://gitlab.com/gitlab-org/gitlab-qa

2. 核心功能和特性

• 端到端测试验证：覆盖 GitLab 从用户登录、项目创建、代码提交、CI/CD 流水线执行到权限管理等完整业务流程。
• 整体系统校验：不仅测试独立组件，还验证组件间的集成效果，确保 GitLab 作为整体系统的稳定性。
• 灵活适配性：支持对不同部署方式（如自托管、容器化、云服务）的 GitLab 实例进行测试。
• 可扩展测试套件：测试用例可扩展，支持自定义场景以满足特定业务需求。

3. 使用场景和适用范围

• GitLab 版本发布验证：在官方版本发布前，通过该测试套件验证新版本功能完整性和兼容性。
• 自定义部署校验：对企业自托管或定制化配置的 GitLab 实例，验证部署后的功能是否符合预期。
• CI/CD 流程集成：作为开发流程的一部分，在 GitLab 代码变更后自动触发测试，提前发现集成问题。
• 回归测试：在系统升级或配置变更后，快速验证核心功能是否受影响。

4. 使用方法和配置说明

4.1 基本使用（Docker Run）

通过 docker run 命令直接启动测试容器，需指定目标 GitLab 实例地址及测试场景。

示例命令：

bash
docker run --rm \
  -e GITLAB_URL="https://your-gitlab-instance.com" \  # 目标 GitLab 实例 URL
  -e QA_SCENARIO="Test::Instance::All" \              # 测试场景（默认全量测试）
  gitlab/gitlab-qa:latest

参数说明：

• --rm：测试结束后自动删除容器。
• -e GITLAB_URL：必填，指定待测试的 GitLab 实例地址（需确保容器可访问该地址）。
• -e QA_SCENARIO：可选，指定测试场景（如 Test::Project::Create 仅测试项目创建流程），默认执行全量实例测试。

4.2 Docker Compose 配置示例

若需与目标 GitLab 实例联动测试（如本地部署的 GitLab 容器），可通过 docker-compose.yml 定义服务关系：

yaml
version: '3.8'
services:
  gitlab-qa:
    image: docker.xuanyuan.run/gitlab/gitlab-qa:latest
    environment:
      - GITLAB_URL="http://gitlab-web:80"  # 关联同网络下的 GitLab 服务名
      - QA_SCENARIO="Test::Pipeline::Basic"  # 测试基础 CI/CD 流水线
    depends_on:
      - gitlab-web  # 确保 GitLab 实例启动后再执行测试
    networks:
      - gitlab-network  # 与 GitLab 实例共享网络

  # 目标 GitLab 实例（示例，实际需根据部署方式调整）
  gitlab-web:
    image: docker.xuanyuan.run/gitlab/gitlab-ce:latest
    ports:
      - "80:80"
    networks:
      - gitlab-network

networks:
  gitlab-network:

启动命令：

bash
docker-compose up gitlab-qa  # 仅启动测试服务，依赖的 GitLab 实例需提前就绪

4.3 配置参数说明

环境变量

4.4 自定义测试用例

若需执行自定义测试用例，可通过挂载本地测试脚本到容器的 /home/qa/tmp 目录（需符合 GitLab QA 测试用例格式）：

bash
docker run --rm \
  -e GITLAB_URL="https://your-gitlab-instance.com" \
  -v /local/custom-tests:/home/qa/tmp/custom_tests \  # 挂载本地测试脚本
  gitlab/gitlab-qa:latest \
  bundle exec bin/qa Test::Custom::MyScenario  # 执行自定义场景

5. 注意事项

• 网络可达性：容器需能访问 GITLAB_URL 指定的实例，建议通过 Docker 网络或主机网络模式（--net=host）确保连通性。
• 权限要求：测试用户（GITLAB_USERNAME）需具备管理员权限，以覆盖用户管理、项目配置等场景。
• 资源需求：端到端测试可能涉及大量模拟操作，建议分配足够的 CPU 和内存资源（推荐 4+ CPU 核心、8GB+ 内存）。
• 版本匹配：建议使用与目标 GitLab 实例版本一致的 gitlab/gitlab-qa 镜像，避免因版本差异导致测试异常。