ovhcom/venom

Venom 集成测试工具 Docker 镜像文档

镜像概述和主要用途

Venom 是由 OVH 开发的开源集成测试工具，该 Docker 镜像封装了 Venom 运行环境，用于自动化 API、服务、应用程序等的集成测试。它支持通过 YAML 格式定义测试用例，兼容多种网络协议和数据交互方式，可生成标准化测试报告，便于集成到开发流程和 CI/CD 流水线中，提升测试效率和质量保障能力。

核心功能和特性

多协议支持

• 网络协议：HTTP/HTTPS、gRPC、GraphQL、WebSocket、TCP、UDP、SSH、SFTP
• 数据库：MySQL、PostgreSQL、MongoDB、Redis
• 消息队列：Kafka、RabbitMQ
• 其他：DNS、ICMP（ping）、Docker 容器交互等

测试用例管理

• 采用 YAML 格式编写测试套件，结构清晰易维护
• 支持变量注入、循环（loop）、条件判断（if）等逻辑控制
• 测试用例可模块化复用，支持导入外部 YAML 文件

断言与验证

• 内置丰富断言能力：状态码、响应时间、响应体内容匹配
• 支持 JSONPath、XPath、正则表达式等复杂数据提取与验证
• 自定义断言函数扩展

报告与集成

• 输出格式：JUnit XML、JSON、HTML、TAP 等，兼容主流 CI/CD 平台（Jenkins、GitLab CI、GitHub Actions 等）
• 支持测试结果统计与可视化
• 日志详细程度可配置

其他特性

• 并行测试执行，提升效率
• 环境变量注入与配置覆盖
• 支持测试前置/后置钩子（Hooks）
• 轻量且跨平台，通过 Docker 容器化部署更便捷

使用场景和适用范围

适用场景

• API 测试：RESTful API、gRPC 服务接口自动化验证
• 服务集成测试：微服务架构中跨服务调用流程测试
• 协议兼容性测试：验证 SSH 登录、数据库连接、消息队列交互等场景
• CI/CD 流水线：作为代码提交或部署前的自动化测试环节，确保代码质量
• 回归测试：定期执行以验证历史功能是否正常

适用人群/团队

• 开发工程师：自测或单元测试后的接口验证
• 测试工程师：编写自动化集成测试用例
• DevOps 团队：构建 CI/CD 测试流程

使用方法和配置说明

获取镜像

假设镜像已发布至 Docker Hub（实际使用时请确认官方镜像名称）：

bash
docker pull ovh/venom

基本使用流程

1. 编写 YAML 测试套件文件（例如 test-suite.yaml）
2. 通过 Docker 容器运行测试，挂载测试文件目录并指定测试套件
3. 获取测试报告

测试用例编写示例

创建 test-suite.yaml，定义一个 HTTP GET 请求测试：

yaml
name: "示例 HTTP 测试套件"
testcases:
  - name: "访问百度首页"
    steps:
      - name: "发送 GET 请求"
        http:
          url: "https://www.baidu.com"
          method: "GET"
          timeout: "5s"
          assertions:
            - result.statuscode ShouldEqual 200
            - result.timeseconds ShouldBeLessThan 1

Docker 运行命令示例

基本测试执行

挂载当前目录下的测试文件到容器内，并运行测试：

bash
docker run -v $(pwd):/tests ovh/venom run /tests/test-suite.yaml

生成 JUnit 报告

指定输出 JUnit 格式报告到当前目录：

bash
docker run -v $(pwd):/tests ovh/venom run /tests/test-suite.yaml --output junit:/tests/report.xml

注入环境变量

通过 -e 注入环境变量，在测试用例中通过 {{ .Env.VAR_NAME }} 引用：

bash
docker run -v $(pwd):/tests -e BASE_URL=https://api.example.com ovh/venom run /tests/test-suite.yaml

并行执行测试

指定并行测试数（例如 4 个）：

bash
docker run -v $(pwd):/tests ovh/venom run /tests/test-suite.yaml --parallel 4

docker-compose 配置示例

创建 docker-compose.yml，定义测试服务：

yaml
version: '3'
services:
  venom-test:
    image: ovh/venom
    volumes:
      - ./tests:/tests
      - ./reports:/reports
    environment:
      - BASE_URL=https://api.example.com
      - DB_HOST=mysql
    command: run /tests/test-suite.yaml --output junit:/reports/junit.xml --parallel 2
    depends_on:
      - mysql  # 若测试依赖其他服务，可在此定义依赖关系

配置参数说明

Venom 支持通过命令行参数配置测试行为，常用参数：

环境变量说明

容器支持通过环境变量注入配置，常用变量：

注意事项

• 测试文件路径：容器内默认工作目录为 /，建议将本地测试文件挂载至容器内固定路径（如 /tests）
• 权限问题：挂载目录时可能需要调整文件权限，确保容器内用户可读取测试文件
• 网络访问：若测试目标为本地服务，需通过 --network=host（仅 Linux）或容器网络别名访问
• 报告持久化：测试报告需通过挂载目录输出至宿主机，避免容器退出后丢失

参考链接

• 官方文档：https://github.com/ovh/venom
• 测试用例语法：https://github.com/ovh/venom/blob/master/docs/testcases.md
• 协议支持详情：https://github.com/ovh/venom/blob/master/docs/protocols.md