kubeshop/testkube-tw-toolkit

TestWorkflow辅助工具镜像

镜像概述

TestWorkflow辅助工具镜像是一个专为测试工作流设计的工具集，旨在提供一系列辅助功能，帮助开发和测试团队简化测试流程的管理、执行、监控及结果分析，提升测试效率和自动化水平。

核心功能与特性

• 工作流自动化：支持测试工作流的自动化配置与执行，减少手动操作环节
• 任务调度：提供灵活的测试任务调度机制，支持定时触发、事件触发等多种调度方式
• 日志管理：集成日志收集与分析功能，支持日志过滤、聚合及导出，便于测试过程追踪与问题定位
• 报告生成：自动生成标准化测试报告，支持HTML、JSON等多种格式导出，包含测试覆盖率、通过率等关键指标
• CI/CD集成：兼容主流CI/CD工具（如Jenkins、GitLab CI、GitHub Actions），可无缝集成至现有流水线

使用场景与适用范围

• 开发团队的自动化测试流程构建与优化
• CI/CD管道中测试阶段的辅助管理（如任务调度、结果汇总）
• 需要简化测试工作流配置与执行的中小型项目
• 测试报告自动化生成与团队共享场景

使用方法与配置说明

基本使用（Docker Run）

通过以下命令启动容器，默认加载内置配置执行基础辅助功能：

bash
docker run -d --name testworkflow-helper \
  -v /host/path/to/config:/app/config \
  -v /host/path/to/reports:/app/reports \
  testworkflow-helper:latest

环境变量配置

容器支持通过环境变量进行个性化配置，常用环境变量说明如下：

Docker Compose配置示例

yaml
version: '3.8'
services:
  testworkflow-helper:
    image: testworkflow-helper:latest
    container_name: testworkflow-helper
    volumes:
      - ./config:/app/config       # 挂载本地配置目录
      - ./reports:/app/reports     # 挂载报告输出目录
      - ./logs:/app/logs           # 挂载日志目录
    environment:
      - CONFIG_PATH=/app/config/custom.yaml
      - LOG_LEVEL=DEBUG
      - REPORT_OUTPUT_DIR=/app/reports
      - SCHEDULE_INTERVAL=15
    restart: unless-stopped

配置文件说明

配置文件采用YAML格式，支持定义工作流、任务、报告规则等。典型配置示例（custom.yaml）：

yaml
workflows:
  - name: "daily-smoke-test"       # 工作流名称
    trigger: "cron"                # 触发方式（cron/manual/webhook）
    schedule: "0 1 * * *"          # cron表达式（每日凌晨1点执行）
    tasks:                         # 任务列表
      - name: "api-test"           # 任务名称
        command: "pytest /tests/api --html=${REPORT_OUTPUT_DIR}/api_report.html"  # 任务执行命令
        timeout: 300               # 任务超时时间（秒）
      - name: "ui-test"
        command: "playwright test /tests/ui --reporter=json,${REPORT_OUTPUT_DIR}/ui_report.json"
        depends_on: ["api-test"]   # 依赖前置任务

report:
  format: "html"                   # 报告格式（html/json/xml）
  include_screenshots: true        # 是否包含截图（如UI测试）
  send_to: ["test@example.com"]    # 报告邮件接收地址（需配置SMTP）

注意事项

• 挂载的配置目录和报告目录需确保容器有读写权限（可通过chmod 777 /host/path临时测试权限问题）
• 首次使用建议设置LOG_LEVEL=DEBUG，便于排查配置或依赖问题
• 任务命令中可引用环境变量（如${REPORT_OUTPUT_DIR}），需确保变量已定义
• 大规模任务调度场景建议通过docker-compose配置外部网络，实现与测试环境的网络互通