kubeshop/testkube-ginkgo-executor

Testkube Ginkgo执行器

概述和主要用途

Testkube Ginkgo执行器是Testkube的测试执行器，专为在Testkube环境中运行Ginkgo测试而设计。它支持Ginkgo v2版本，通过Git仓库拉取测试代码，提供丰富的参数配置测试执行流程，并自动生成和归档测试报告至Testkube。

核心功能和特性

• 仅支持Ginkgo v2版本，不兼容Ginkgo v1
• 仅支持从Git仓库拉取测试代码，可通过分支或提交ID指定代码版本
• 提供多维度参数配置测试执行（如测试包、递归执行、并行运行、报告生成等）
• 默认生成JUnit报告，支持额外启用JSON和TeamCity报告
• 测试报告自动归档到Testkube，整合测试结果

使用场景和适用范围

适用于在Testkube中运行Ginkgo v2测试的场景，尤其适合测试代码存储在Git仓库中的Golang项目。支持通过参数灵活定制测试流程，满足不同测试需求（如指定测试包、并行执行、生成特定格式报告等）。

详细使用方法和配置说明

仅支持Ginkgo v2

此执行器不支持Ginkgo v1版本，仅兼容Ginkgo v2。

仅支持Git仓库测试

示例 testkube create test 命令（按分支指定Git仓库）：

bash
$ testkube create test --git-uri <包含Ginkgo测试的Golang仓库URI> --git-branch main --name ginkgo-test --type ginkgo/test --git-username <Git用户名> --git-token=<Git令牌>

示例 testkube create test 命令（按提交ID指定Git仓库）：

bash
$ testkube create test --git-uri <包含Ginkgo测试的Golang仓库URI> --git-commit <Git提交ID/SHA> --name ginkgo-test --type ginkgo/test --git-username <Git用户名> --git-token=<Git令牌>

参数说明

通过 -v 变量传入或覆盖Ginkgo参数：

• GinkgoTestPackage：默认值 ""，指定测试包路径
• GinkgoRecursive：默认值 -r，递归执行所有子目录测试
• GinkgoParallel：默认值 -p，启用并行测试执行
• GinkgoParallelProcs：默认值 ""，用法 --procs N，指定并行进程数
• GinkgoCompilers：默认值 ""，用法 --compilers N，指定编译进程数
• GinkgoRandomize：默认值 --randomize-all，随机化所有测试用例顺序
• GinkgoRandomizeSuites：默认值 --randomize-suites，随机化测试套件顺序
• GinkgoLabelFilter：默认值 ""，用法 --label-filter QUERY，按标签筛选测试
• GinkgoFocusFilter：默认值 ""，用法 --focus REGEXP，按正则表达式聚焦测试
• GinkgoSkipFilter：默认值 ""，用法 --skip REGEXP，按正则表达式跳过测试
• GinkgoUntilItFails：默认值 ""，用法 --until-it-fails，重复执行直到失败
• GinkgoRepeat：默认值 ""，用法 --repeat N，重复执行测试N次
• GinkgoFlakeAttempts：默认值 ""，用法 --flake-attempts N，失败后重试N次
• GinkgoTimeout：默认值 ""，用法 --timeout=duration，设置测试超时时间（如5m）
• GinkgoSkipPackage：默认值 ""，用法 --skip-package list,of,packages，跳过指定包
• GinkgoFailFast：默认值 ""，用法 --fail-fast，第一个失败后停止测试
• GinkgoKeepGoing：默认值 "--keep-going"，用法 --keep-going，即使有失败也继续执行
• GinkgoFailOnPending：默认值 ""，用法 --fail-on-pending，未实现的测试标记为失败
• GinkgoCover：默认值 ""，用法 --cover，启用覆盖率分析
• GinkgoCoverProfile：默认值 ""，用法 --coverprofile cover.profile，指定覆盖率报告文件
• GinkgoRace：默认值 ""，用法 --race，启用数据竞争检测
• GinkgoTrace：默认值 "--trace"，启用详细跟踪输出
• GinkgoJsonReport：默认值 ""，用法 --json-report report.json，生成JSON格式报告
• GinkgoJunitReport：默认值 "--junit-report report.xml"，生成JUnit格式报告
• GinkgoTeamCityReport：默认值 ""，用法 --teamcity-report report.teamcity，生成TeamCity格式报告

传递参数给Ginkgo

在 testkube run test 命令中添加 --args '--base-url=example.com --some-arg=value' 以传递额外参数给Ginkgo。

示例CLI测试执行命令

• testkube run test ginkgo-test -f：执行名为 ginkgo-test 的Testkube测试，递归运行仓库中所有Ginkgo测试（使用默认 -r 标志）。
• testkube run test ginkgo-test -f -v GinkgoTestPackage=e2e：执行 ginkgo-test，覆盖 GinkgoTestPackage 参数以运行仓库中的 e2e 包。
• testkube run test ginkgo-test -f -v GinkgoSkipPackage="--skip-package other,other2" -v GinkgoParallel=""：执行测试，跳过 other 和 other2 包，并关闭并行执行。
• testkube run test ginkgo-test -f -v GinkgoTestPackage=e2e ---args '--base-url=example.com'：执行 e2e 测试包，并传递 base-url=example.com 作为Ginkgo的额外参数。

工件

默认生成JUnit报告（必需，用于Testkube结果解析），可选启用JSON和/或TeamCity报告。所有生成的报告将由执行器自动归档并存储到Testkube中。

架构

• TODO 添加架构图

API

Ginkgo执行器实现了Testkube执行器OpenAPI（查看executor标签）。