kubeshop/testkube-tracetest-executor

!https://raw.githubusercontent.com/kubeshop/testkube/main/assets/testkube-color-gray.png

欢迎使用 TestKube Tracetest 执行器

TestKube Tracetest 执行器是一款测试执行器，用于通过 TestKube 运行 Tracetest 测试。

在 TestKube 中运行 Tracetest

Tracetest 是一款基于 OpenTelemetry 的测试工具，允许您测试分布式应用。它利用 OpenTelemetry 工具生成的跟踪数据，检查并断言应用是否符合测试定义中指定的预期行为。

TestKube 是面向测试人员和开发人员的 Kubernetes 原生测试框架，允许您在 Kubernetes 集群内自动化执行现有测试工具，消除 CI/CD/GitOps 流水线中的复杂性。

通过使用 https://github.com/kubeshop/testkube-executor-tracetest%EF%BC%8C%E6%82%A8%E5%8F%AF%E4%BB%A5%E7%BB%93%E5%90%88 TestKube 与 Tracetest 的能力，充分利用已完成的服务 instrumentation 工作。

快速开始

本文将展示如何在 Kubernetes 集群中结合使用 Testkube 和 Tracetest 运行测试。

前提条件

您的 Kubernetes 集群中应已安装：

1. Testkube：使用 HELM 或 Testkube CLI 在集群中https://kubeshop.github.io/testkube/installing Testkube 服务器组件。
2. Tracetest：需要运行中的 Tracetest 或 Tracetest Core 实例来执行断言。请按照 Tracetest 文档 中的说明进行安装。
3. OpenTelemetry instrumentation 服务：为生成跟踪和跨度，被测服务必须支持通过 HTTP 请求进行传播的基础功能，并且需要将跟踪和跨度存储在数据存储后端（Jaeger、Grafana Tempo、OpenSearch 等）中，或使用 OpenTelemetry Collector。

您的 machine 上应安装：

1. Kubectl
2. https://kubeshop.github.io/testkube/installing#1-installing-the-testkube-cli

完成上述设置后，我们开始配置 Testkube 和 Tracetest。

1. 部署 Tracetest 执行器

Testkube 基于 https://kubeshop.github.io/testkube/test-types/executor-custom 概念工作。执行器是测试框架（此处为 Tracetest）的 Docker 容器包装器，作为 Kubernetes Job 运行。首先，您需要使用 Testkube CLI 在集群中注册并部署 Tracetest 执行器：

bash
kubectl testkube create executor --image kubeshop/testkube-executor-tracetest:latest --types "tracetest/test" --name tracetest-executor

2. 创建测试

现在您需要一个 Tracetest 测试。有关编写测试的详细信息，请参阅 Tracetest 文档。以下是一个简单的测试定义示例：

yaml
type: Test
spec:
  id: R5NITR14g
  name: Pokeshop - List
  description: Get a Pokemon
  trigger:
    type: http
    httpRequest:
      url: http://demo-pokemon-api.demo/pokemon?take=20&skip=0
      method: GET
      headers:
        - key: Content-Type
          value: application/json
  specs:
    - selector: span[tracetest.span.type="http"]
      assertions:
        - attr:http.method = "GET"
    - selector: span[tracetest.span.type="database"]
      assertions:
        - attr:db.name = "pokeshop"

执行以下命令在 Testkube 中创建测试执行器对象。不要忘记使用 --file 参数提供 Tracetest 定义文件的路径，并使用 TRACETEST_ENDPOINT --variable 指定 Tracetest 服务器端点：

bash
kubectl testkube create test --file my/file/location.yaml --type "tracetest/test" --name pokeshop-tracetest-test --variable TRACETEST_ENDPOINT=http://tracetest

3. 运行测试

最后，要查看集成效果，只需运行以下命令执行测试：

bash
kubectl testkube run test --watch pokeshop-tracetest-test

架构

以下是 Testkube 和 Tracetest 与系统不同组件交互的高级序列图：

mermaid
sequenceDiagram
    participant testkubeClient as Testkube 客户端
    participant testkube as Testkube
    participant executorCRDs as 执行器 CRD
    participant tracetestExecutorJob as Tracetest 执行器 Job
    participant tracetestServer as Tracetest 服务器
    participant instrumentedService as Instrumentation 服务
    participant dataStore as 数据存储

    testkubeClient->>+testkube: 触发 Testkube 测试运行
    testkube->>+executorCRDs: 获取执行器详情
    executorCRDs-->>-testkube: 发送详情
    testkube->>+tracetestExecutorJob: 调度执行
    tracetestExecutorJob->>+tracetestExecutorJob: 配置 Tracetest CLI
    tracetestExecutorJob->>+tracetestServer: 执行 Tracetest 测试运行
    tracetestServer->>+instrumentedService: 触发请求
    instrumentedService-->>-tracetestServer: 获取响应
    instrumentedService->>+dataStore: 发送遥测数据
    tracetestServer->>+dataStore: 获取跟踪
    dataStore-->>-tracetestServer: 返回跟踪
    tracetestServer->>+tracetestServer: 运行断言
    tracetestServer-->>-tracetestExecutorJob: 返回测试运行结果
    tracetestExecutorJob-->>-testkube: 返回测试运行结果
    testkube-->>-testkubeClient: 发送详情

问题与增强

请通过 https://github.com/kubeshop/testkube 报告任何 https://github.com/kubeshop/testkube/issues 或参与 https://github.com/kubeshop/testkube/discussions%E3%80%82

Testkube

更多信息请访问 https://github.com/kubeshop/testkube

!Release !Go version

!Docker builds !Code build !Release date

!***

https://kubeshop.github.io/testkube | Slack

Tracetest

更多信息请访问 https://github.com/kubeshop/tracetest

!***

文档 | Slack