kubeshop/testkube-jmeterd-executor

分布式JMeter执行器

Testkube的分布式JMeter执行器（Distributed JMeter Executor）是JMeter执行器的扩展，能够通过创建从节点pod并在其中分配测试任务，以分布式模式运行JMeter测试。

镜像概述和主要用途

什么是执行器（Executor）？

执行器是封装在Docker容器中的程序，它接收基于OpenAPI的JSON格式文档（testube.Execution）作为输入，并返回JSON格式的输出流（testkube.ExecutorOutput），每条输出行均封装在该JSON中，类似结构化日志的设计理念。

本执行器在JMeter执行器的基础上扩展，除具备JMeter执行器的所有功能外，重点支持分布式测试模式，适用于需要大规模负载测试或复杂配置的场景。

核心功能和特性

基础功能

继承JMeter执行器的全部功能，包括标准JMeter测试执行能力。

扩展功能

• 分布式测试支持：通过创建从节点pod在分布式模式下运行JMeter测试，将测试任务分配到多个从节点执行。
• 插件管理：支持在git仓库的测试文件夹中通过plugins目录定义测试所需插件。
• 配置覆盖：支持通过测试文件夹中的自定义user.properties文件覆盖JMeter默认的user.properties配置。

使用场景和适用范围

适用于需要通过分布式架构提升JMeter测试性能、模拟大规模用户负载的场景，尤其适合以下用户：

• 需要在Kubernetes环境中进行分布式JMeter测试的团队。
• 测试过程中依赖自定义插件或特殊JVM参数配置的用户。
• 需要通过git仓库管理测试用例、插件及配置文件的场景。

使用方法和配置说明

支持的环境变量

1. MASTER_OVERRIDE_JVM_ARGS / SLAVES_OVERRIDE_JVM_ARGS
   用于覆盖JMeter主节点/从节点的默认内存选项。
   示例：MASTER_OVERRIDE_JVM_ARGS=-Xmn256m -Xms512m -Xmx512m

2. SLAVES_COUNT
   指定分布式JMeter测试所需的从节点pod数量。
   示例：SLAVES_COUNT=3。若未提供或值为1，执行器将以独立模式运行测试。

3. MASTER_ADDITIONAL_JVM_ARGS / SLAVES_ADDITIONAL_JVM_ARGS
   为主节点/从节点添加额外JVM参数。
   示例：MASTER_ADDITIONAL_JVM_ARGS=-Xmx1024m -Xms512m -XX:MaxMetaspaceSize=256m

4. SLAVES_ADDITIONAL_JMETER_ARGS
   为JMeter服务器/从节点提供额外JVM参数。
   示例：SLAVES_ADDITIONAL_JMETER_ARGS=jmeter-server -Jserver.rmi.ssl.disable=true -Dserver_port=60000

使用指南

以下指南详细说明如何在分布式环境中运行JMeter测试。

1. 文件选项

向“分布式JMeter执行器”提供测试（.jmx）文件时，执行器将根据SLAVES_COUNT环境变量指定的数量创建从节点pod，并在所有从节点上分配测试任务。

2. Git选项

通过执行器的Git流程，可使用分布式JMeter执行器的高级功能（JMeter执行器不支持）：

• 额外文件支持：测试所需的CSV、JSON等文件可通过git仓库提供（放置在测试文件夹中）。示例可参考分布式JMeter的example文件夹。
• 动态插件支持：在git仓库的测试文件夹中创建plugins目录，并放入所需插件JAR文件。
• 自定义配置支持：在git仓库的测试文件夹中放置自定义user.properties文件，以覆盖JMeter默认配置。

Git仓库目录结构示例：

github.com/<username>/<reponame>/
├── test1/
│   ├── testfile1.jmx          # 测试用例文件
│   ├── userdata.csv           # 测试数据文件
│   ├── user.properties        # 自定义配置文件
│   └── plugins/               # 插件目录
│       ├── plugin-manager.jar # 插件JAR文件
│       └── <其他插件JAR文件>
└── test2/
    ├── testfile2.jmx
    ├── userdata.json
    ├── user.properties
    └── plugins/
        └── <插件JAR文件>

更多信息可参考https://github.com/kubeshop/testkube-executor-jmeter/tree/main/examples/gitflow%E3%80%82

本地开发

先决条件

确保本地安装并配置以下工具（需在PATH中可用）：

• JMeter - 用于负载测试的纯Java应用程序

设置步骤

1. 创建数据目录：在项目根目录创建data/目录（已被git忽略），用于JMeter运行和结果存储。
2. 准备测试文件：在data/目录中创建JMeter XML项目文件，命名为test-content。
3. 创建执行JSON文件：基于以下模板创建execution.json（建议保存至项目根目录的temp/目录，已被git忽略）：

   json
   {
     "id": "jmeterd-test",
     "args": [],
     "variables": {},
     "content": {
       "type": "string"
     }
   }
   

4. 运行执行器：设置环境变量RUNNER_SCRAPPERENABLED、RUNNER_SSL和RUNNER_DATADIR，并使用make run命令运行执行器（指定execution.json路径）：

   bash
   RUNNER_SCRAPPERENABLED=false RUNNER_SSL=false RUNNER_DATADIR="./data" make run run_args="-f temp/execution.json"
   

执行JSON详解

执行JSON存储执行器运行测试所需的配置信息，结构如下：

json
{
   "args": ["-n", "-t", "test.jmx"],
   "variables": {
      "example": {
         "type": "basic", 
         "name": "example", 
         "value": "some-value"
     }
   },
   "content": {
      "type": "string"
   }
}

• args：传递给JMeter的参数数组
  示例：["-n", "-t", "test.jmx"]（-n：非GUI模式，-t：指定测试文件）
• variables：传递给JMeter的变量映射
  示例：{"example": {"type": "basic", "name": "example", "value": "some-value"}}
• content.type：指定JMeter XML的提供方式（此处为文本文件，值为"string"）

本地开发环境变量

bash
RUNNER_SSL=false                  # 存储后端是否使用HTTPS（本地开发设为false）
RUNNER_SCRAPPERENABLED=false      # 是否启用结果抓取（本地开发设为false）
RUNNER_DATADIR="./data"           # 数据目录路径（指向步骤1创建的data/目录）

Kubernetes测试

先决条件

• Kubernetes集群（已安装Testkube，建议安装在testkube命名空间）

测试步骤

1. 构建镜像：使用make docker-build-local命令构建新执行器镜像。默认标签为kubeshop/testkube-executor-jmeter:999.0.0，可通过LOCAL_TAG环境变量自定义标签。

2. 使镜像在Kubernetes中可访问：

   • kind集群：kind load docker-image <镜像名> --name <集群名>（示例：kind load docker-image testkube-executor-jmeter:999.0.0 --name testkube-k8s-cluster）
   • minikube集群：minikube image load <镜像名> --profile <集群配置名>（示例：minikube image load testkube-executor-jmeter:999.0.0 --profile k8s-cluster-test）
   • Docker Desktop集群：本地构建的镜像自动对集群可见。
   • 其他集群：推送镜像至镜像仓库，并确保Kubernetes有访问权限。

3. 编辑Job模板：修改testkube-api-server ConfigMap，将imagePullPolicy设为IfNotPresent：

   bash
   kubectl edit configmap testkube-api-server --namespace testkube
   

   找到job-template.yml键，在containers部分修改：

   yaml
   imagePullPolicy: IfNotPresent
   

4. 更新执行器配置：修改testkube-api-server ConfigMap，将JMeter执行器镜像改为新构建的镜像：

   bash
   kubectl edit configmap testkube-api-server --namespace testkube
   

   找到executors.json键，更新name为jmeter-executor的执行器配置：

   json
   "executor": {
     "image": "<新镜像名>"
   }
   

5. 重启API Server：

   bash
   kubectl rollout restart deployment testkube-api-server --namespace testkube
   

Testkube现在将使用新镜像运行执行器，可通过偏好的方式调度测试。