kubeshop/testkube-jmeter-executor

JMeter Executor

概述

什么是执行器（Executor）？

执行器是一个包装在Docker容器中的程序，它接收基于OpenAPI的testkube.Execution JSON文档作为输入，并返回JSON输出行流（testkube.ExecutorOutput），其中每行输出都简单地包装在该JSON中，类似于结构化日志的理念。

简介

这是一个基本的JMeter执行器，能够运行JMX格式编写的简单JMeter场景。请将JMeter文件定义为文件（字符串或Git文件）。目前尚未实现项目目录功能。

核心功能与特性

插件

默认安装以下插件：

• JMeter Plugins Common Classes 0.6
• JMeter Plugins Manager 1.3
• Custom JMeter Functions 2.1

您可以在创建或执行JMeter测试时，利用Testkube的文件复制功能添加更多JMeter插件。JMeter插件JAR文件需复制到执行器容器的uploads目录。

示例：

shell
kubectl testkube create test \
          --file test.jmx    \
          --copy-files "/source/path/to/jmeter-plugins-functions-2.1.jar:plugins/jmeter-plugins-functions-2.1.jar" \
          --name jmeter-test \
          --type jmeter/test

使用方法

本地开发

前提条件

确保以下工具已安装在您的机器上并在PATH中可用：

• JMeter - 纯Java应用程序，用于负载测试功能行为和测量性能

设置步骤

1. 创建名为data/的目录（JMeter将在此运行并存储结果，建议在项目根目录创建，因为该目录已被git忽略）
2. 创建JMeter XML项目文件，并保存为data/目录下的test-content文件
3. 基于以下模板创建execution JSON文件，并保存为execution.json（建议保存在项目根目录的temp/文件夹，因为该目录已被git忽略）：

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

4. 提供RUNNER_SCRAPPERENABLED、RUNNER_SSL和RUNNER_DATADIR环境变量，并使用make run run_args="-f|--file <path>"命令运行执行器，其中-f|--file <path>是步骤3中创建的execution.json文件路径：

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

Execution JSON

Execution 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"]
• variables - 传递给JMeter的变量映射
  示例：{"example": {"type": "basic", "name": "example", "value": "some-value"}}
• content.type - 指定JMeter XML作为文本文件提供

环境变量

bash
RUNNER_SSL=false                  # 若存储后端使用HTTPS则设置，本地开发应设为false
RUNNER_SCRAPPERENABLED=false      # 启用/禁用scrapper，本地开发应设为false
RUNNER_DATADIR=<path-to-data-dir> # JMeter运行和存储结果的数据目录路径

Kubernetes中的测试

前提条件

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

操作指南

本地验证执行器变更正常工作后，需测试Testkube能否成功调度使用新执行器镜像的测试。以下命令假设Testkube安装在testkube命名空间，若在其他命名空间，请调整--namespace参数。

使Testkube使用新执行器镜像的步骤：

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

2. 将镜像加载到Kubernetes集群：

   • kind：kind load docker-image <image-name> --name <kind cluster name>（示例：kind load docker-image testkube-executor-jmeter:999.0.0 --name testkube-k8s-cluster）
   • minikube：minikube image load <image-name> --profile <minikube profile>（示例：minikube image load testkube-executor-jmeter:999.0.0 --profile k8s-cluster-test）
   • Docker Desktop：本地构建后直接在Docker Desktop Kubernetes集群中可用
   • 其他：推送到镜像仓库，Testkube将拉取（需确保集群有访问凭证）

3. 编辑Job模板，将imagePullPolicy改为IfNotPresent：

   • 编辑ConfigMap：kubectl edit configmap testkube-api-server --namespace testkube
   • 找到job-template.yml键，修改containers部分的imagePullPolicy字段为IfNotPresent

4. 编辑执行器配置，将基础镜像改为新创建的镜像：

   • 编辑ConfigMap：kubectl edit configmap testkube-api-server --namespace testkube
   • 找到executors.json键，修改名称为jmeter-executor的执行器的executor.image字段

5. 重启API Server：kubectl rollout restart deployment testkube-api-server --namespace testkube

Testkube现在将使用新镜像，您可通过首选方式调度测试。