Testkube Executor Curl 技术文档

!Testkube Logo

1. 镜像概述和主要用途

Testkube Executor Curl 是 testkube 平台的测试执行器组件，基于 Curl 工具实现。其主要用途是执行 HTTP/HTTPS 请求测试，通过运行自定义 Curl 命令发起请求，并验证响应的状态码及响应体内容是否符合预期。

2. 核心功能和特性

• Curl 命令执行：支持运行自定义 Curl 命令数组，灵活配置 HTTP 请求参数（如 URL、 headers、方法等）。
• 响应验证：自动检查 HTTP 响应状态码是否匹配 expected_status，以及响应体是否包含 expected_body 指定的内容。
• 模板参数化：支持通过模板语法（如 {{.param}}）对输入进行参数化，实现测试用例的动态配置。
• 参数传递：通过 --param 标志传递键值对参数，动态替换模板中的占位符。
• Testkube 集成：测试 CRD（Custom Resource Definition）类型固定为 curl/test，与 Testkube 平台无缝集成。

3. 使用场景和适用范围

适用场景

• API 端点可用性测试：验证 REST API 端点是否正常响应（如状态码 200）。
• HTTP 响应内容验证：检查 API 响应体是否包含预期数据（如特定 JSON 字段）。
• 参数化测试：通过模板和参数动态生成测试用例，适应不同环境（如开发、测试、生产）的 URL 或 headers。
• 简单集成测试：验证服务间 HTTP 通信是否符合预期（如微服务间的接口调用）。

适用范围

• 需通过 Curl 命令发起 HTTP/HTTPS 请求的场景。
• 对响应状态码和响应体有明确验证需求的测试。
• 基于 Testkube 平台管理的测试用例。

4. 使用方法和配置说明

4.1 输入格式

测试输入为 JSON 格式，包含以下字段：

4.1.1 基本示例

json
{
  "command": [
    "curl",
    "[***]",
    "-H",
    "Accept: application/json"
  ],
  "expected_status": "200",
  "expected_body": "{\"success\":\"true\"}"
}

4.1.2 模板参数化示例

通过模板语法 {{.param}} 定义占位符，实现参数动态替换：

json
{
  "command": [
    "curl",
    "{{.url}}",
    "-H",
    "{{.header}}"
  ],
  "expected_status": "{{.status}}",
  "expected_body": "{{.body}}"
}

4.2 参数传递

使用 Testkube CLI 的 --param 标志传递参数，替换模板中的占位符。例如，针对上述模板示例，通过以下命令传递参数：

bash
testkube run test -f test-input.json --param url=[***] --param header="Accept: application/json" --param status=200 --param body="{\"success\":\"true\"}"

4.3 CRD 类型要求

创建测试时，需指定 CRD 类型为 curl/test，确保 Testkube 调用本执行器。示例 Testkube 测试 CRD：

yaml
apiVersion: tests.testkube.io/v3
kind: Test
metadata:
  name: my-curl-test
spec:
  type: curl/test
  content:
    type: string
    data: |
      {
        "command": ["curl", "[***]", "-H", "Accept: application/json"],
        "expected_status": "200",
        "expected_body": "{\"success\":\"true\"}"
      }

5. API 实现

Testkube Executor Curl 实现了 Testkube 执行器 OpenAPI 规范（详见 executor 标签），支持与 Testkube 平台的 API 交互（如测试执行、结果上报等）。

6. 部署说明

Testkube Executor Curl 作为 Testkube 生态的一部分，需部署在 Testkube 集群中。部署方式如下：

6.1 通过 Testkube *** Chart 部署

Testkube 安装时默认包含常用执行器（包括 Curl 执行器），可通过*** Helm Chart 部署 Testkube：

bash
helm repo add testkube [***]
helm install testkube testkube/testkube -n testkube --create-namespace

6.2 验证执行器

部署后，通过 Testkube CLI 验证执行器是否可用：

bash
testkube get executors | grep curl/test

7. 问题反馈

如遇功能问题或需求增强，可在 Testkube 主仓库 提交 issues 或参与 discussions。