Draft - Don't Merge to Main: Enhance JMeter SSL support, dependency updates, and HTTP improvements

.github/workflows/ci-build.yaml

@@ -10,6 +10,13 @@ concurrency:
 jobs:
   build:
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        # 5.5 is the minimum supported JMeter version, 5.6.3 the latest; both are exercised
+        # end-to-end (unit + HTTP parity regression tests) since ApacheJMeter_* are provided-scope
+        # and the same compiled plugin must behave correctly against either at runtime.
+        jmeter_version: ["5.5", "5.6.3"]
     steps:
       - name: Checkout
         uses: actions/checkout@v5
@@ -21,14 +28,17 @@ jobs:
           java-version: "17"
           cache: maven
 
-      - name: Build and test
-        run: xvfb-run -a mvn -U --batch-mode clean install
+      - name: Build and test (JMeter ${{ matrix.jmeter_version }})
+        run: >-
+          xvfb-run -a mvn -U --batch-mode
+          -Djmeter.version=${{ matrix.jmeter_version }}
+          clean install
 
       - name: Upload build artifacts
         if: always()
         uses: actions/upload-artifact@v6
         with:
-          name: ci-build-artifacts-${{ github.run_id }}
+          name: ci-build-artifacts-${{ matrix.jmeter_version }}-${{ github.run_id }}
           path: |
             target/jmeter-bzm-http2-*.jar
             target/jmeter-test

.github/workflows/ci-jmeter-compatibility.yaml

@@ -55,7 +55,13 @@ jobs:
         env:
           JMETER_PATH_BASE: ${{ github.workspace }}/.jmeter
         run: |
-          JMETER_VERSION=5.6.3 JMETER_PATH=$JMETER_PATH_BASE/5.6.3 sh testJMeter.sh
+          # Verify the built plugin jar loads and runs against every JMeter version we claim
+          # to support: 5.5 (minimum) through 5.6.3 (latest), regardless of which version the
+          # jar itself was compiled against (jmeter.version in pom.xml is provided-scope).
+          for JMETER_VERSION in 5.5 5.6.3; do
+            echo "=== Compatibility check against JMeter $JMETER_VERSION ==="
+            JMETER_VERSION=$JMETER_VERSION JMETER_PATH=$JMETER_PATH_BASE/$JMETER_VERSION sh testJMeter.sh
+          done
 
       - name: Upload compatibility artifacts on failure
         if: failure()

pom.xml

@@ -30,10 +30,10 @@
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
-    <jmeter.version>5.4.1</jmeter.version>
-    <jetty.version>12.1.6</jetty.version>
-    <!-- Matches jetty-project ${brotli4j.version} for Jetty 12.1.6 -->
-    <brotli4j.version>1.20.0</brotli4j.version>
+    <jmeter.version>5.5</jmeter.version>
+    <jetty.version>12.1.11</jetty.version>
+    <!-- Matches jetty-project ${brotli4j.version} for Jetty 12.1.11 -->
+    <brotli4j.version>1.23.0</brotli4j.version>
     <checkstyle.skip>false</checkstyle.skip>
   </properties>
   <dependencies>
@@ -50,11 +50,11 @@
       <scope>provided</scope>
     </dependency>
     <!-- Apache HttpClient for compilation (classes used in JettyCacheManager) -->
-    <!-- Using same version as JMeter 5.4.1 -->
+    <!-- Using same version as JMeter 5.5 (our minimum supported version) -->
     <dependency>
       <groupId>org.apache.httpcomponents</groupId>
       <artifactId>httpcore</artifactId>
-      <version>4.4.14</version>
+      <version>4.4.15</version>
       <scope>compile</scope>
     </dependency>
     <dependency>
@@ -66,7 +66,7 @@
     <dependency>
       <groupId>org.apache.commons</groupId>
       <artifactId>commons-lang3</artifactId>
-      <version>3.12.0</version>
+      <version>3.18.0</version>
       <scope>compile</scope>
     </dependency>
     <dependency>
@@ -189,10 +189,27 @@
       <version>2.28.2</version>
       <scope>test</scope>
     </dependency>
+    <!-- Pin byte-buddy to 1.14.18 to resolve classpath conflict:
+         mockito-core 2.28.2 pulls byte-buddy ~1.9.x which lacks ElementMatchers.namedOneOf(),
+         a method required by assertj-core 3.27.7's SoftProxies initialisation.
+         1.14.x is the last series compatible with the Mockito 2.x instrumentation API
+         while also satisfying assertj-core 3.27.x. Remove these pins when mockito is upgraded. -->
+    <dependency>
+      <groupId>net.bytebuddy</groupId>
+      <artifactId>byte-buddy</artifactId>
+      <version>1.14.18</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>net.bytebuddy</groupId>
+      <artifactId>byte-buddy-agent</artifactId>
+      <version>1.14.18</version>
+      <scope>test</scope>
+    </dependency>
     <dependency>
       <groupId>org.assertj</groupId>
       <artifactId>assertj-core</artifactId>
-      <version>3.12.2</version>
+      <version>3.27.7</version>
       <scope>test</scope>
     </dependency>
     <dependency>
@@ -275,7 +292,7 @@
     <dependency>
       <groupId>com.google.guava</groupId>
       <artifactId>guava</artifactId>
-      <version>29.0-jre</version>
+      <version>32.0.0-jre</version>
       <scope>test</scope>
     </dependency>
   </dependencies>

scripts/jmx-migrate.cmd

@@ -0,0 +1,14 @@
+@echo off
+rem Migrates stock JMeter HTTP Request samplers to the BlazeMeter HTTP sampler in a .jmx file
+rem or directory. Run from a real JMeter installation with jmeter-bzm-http2-*.jar installed
+rem under lib\ext\ (this script assumes it lives at <jmeter.home>\bin\jmx-migrate.cmd).
+rem
+rem Usage: see `jmx-migrate.cmd --help`
+
+setlocal
+set SCRIPT_DIR=%~dp0
+set JMETER_HOME_DIR=%SCRIPT_DIR%..
+
+java -Djava.awt.headless=true ^
+  -cp "%JMETER_HOME_DIR%\lib\*;%JMETER_HOME_DIR%\lib\ext\*" ^
+  com.blazemeter.jmeter.http2.sampler.JmxBlazeMeterHttpMigratorCli %*

scripts/jmx-migrate.sh

@@ -0,0 +1,13 @@
+#!/bin/sh
+# Migrates stock JMeter HTTP Request samplers to the BlazeMeter HTTP sampler in a .jmx file
+# or directory. Run from a real JMeter installation with jmeter-bzm-http2-*.jar installed
+# under lib/ext/ (this script assumes it lives at <jmeter.home>/bin/jmx-migrate.sh).
+#
+# Usage: see `jmx-migrate.sh --help`
+
+SCRIPT_DIR=$(cd "$(dirname "$0")" && pwd)
+JMETER_HOME_DIR=$(cd "$SCRIPT_DIR/.." && pwd)
+
+exec java -Djava.awt.headless=true \
+  -cp "$JMETER_HOME_DIR/lib/*:$JMETER_HOME_DIR/lib/ext/*" \
+  com.blazemeter.jmeter.http2.sampler.JmxBlazeMeterHttpMigratorCli "$@"

src/main/java/com/blazemeter/jmeter/http2/cli/JMeterCliEnvironment.java

@@ -0,0 +1,96 @@
+package com.blazemeter.jmeter.http2.cli;
+
+import java.io.File;
+import java.net.URISyntaxException;
+import java.security.CodeSource;
+import org.apache.jmeter.util.JMeterUtils;
+
+/**
+ * Bootstraps a headless JMeter environment for command-line tools shipped inside this plugin's
+ * jar, without requiring the JMeter GUI or the lightweight test emulator used by unit tests.
+ *
+ * <p>Resolves {@code JMETER_HOME} by locating this jar under {@code <jmeter.home>/lib/ext/},
+ * matching how JMeter loads plugins; falls back to the {@code JMETER_HOME} environment variable
+ * or the {@code jmeter.home} system property when the jar isn't installed there.
+ */
+public final class JMeterCliEnvironment {
+
+  private static volatile boolean initialized;
+
+  private JMeterCliEnvironment() {
+  }
+
+  public static synchronized void ensureInitialized() {
+    if (initialized) {
+      return;
+    }
+    System.setProperty("java.awt.headless", "true");
+    if (isNotBlank(JMeterUtils.getJMeterHome())) {
+      // Some other bootstrap (JMeter GUI/engine, or the in-process test emulator) already
+      // configured JMeterUtils; reloading properties here would discard that configuration.
+      initialized = true;
+      return;
+    }
+    String home = resolveJMeterHome();
+    JMeterUtils.setJMeterHome(home);
+    File propertiesFile = new File(new File(home, "bin"), "jmeter.properties");
+    JMeterUtils.loadJMeterProperties(propertiesFile.getAbsolutePath());
+    JMeterUtils.initLocale();
+    JMeterUtils.initLogging();
+    initialized = true;
+  }
+
+  static String resolveJMeterHome() {
+    String fromProperty = System.getProperty("jmeter.home");
+    if (isNotBlank(fromProperty)) {
+      return fromProperty.trim();
+    }
+    String fromEnv = System.getenv("JMETER_HOME");
+    if (isNotBlank(fromEnv)) {
+      return fromEnv.trim();
+    }
+    String fromJarLocation = homeFromExtDirJar(locateOwnJarFile());
+    if (fromJarLocation != null) {
+      return fromJarLocation;
+    }
+    throw new IllegalStateException(
+        "Could not determine JMeter home. This tool expects to run from <jmeter.home>/lib/ext/, "
+            + "or with -Djmeter.home=<path> / the JMETER_HOME environment variable set.");
+  }
+
+  /**
+   * @return {@code <home>} when {@code jarFile} looks like {@code <home>/lib/ext/some.jar},
+   *     {@code null} otherwise (e.g. when running from a build output directory).
+   */
+  static String homeFromExtDirJar(File jarFile) {
+    if (jarFile == null) {
+      return null;
+    }
+    File extDir = jarFile.getParentFile();
+    if (extDir == null || !"ext".equalsIgnoreCase(extDir.getName())) {
+      return null;
+    }
+    File libDir = extDir.getParentFile();
+    if (libDir == null || !"lib".equalsIgnoreCase(libDir.getName())) {
+      return null;
+    }
+    File home = libDir.getParentFile();
+    return home == null ? null : home.getAbsolutePath();
+  }
+
+  private static File locateOwnJarFile() {
+    try {
+      CodeSource codeSource = JMeterCliEnvironment.class.getProtectionDomain().getCodeSource();
+      if (codeSource == null) {
+        return null;
+      }
+      return new File(codeSource.getLocation().toURI());
+    } catch (URISyntaxException | IllegalArgumentException e) {
+      return null;
+    }
+  }
+
+  private static boolean isNotBlank(String value) {
+    return value != null && !value.trim().isEmpty();
+  }
+}

src/main/java/com/blazemeter/jmeter/http2/core/DeflateContentDecoderFactory.java

@@ -12,6 +12,14 @@
 import org.eclipse.jetty.util.BufferUtil;
 import org.eclipse.jetty.util.IO;
 
+/**
+ * Jetty's compression module ({@code org.eclipse.jetty.compression.*}) ships gzip, brotli, and
+ * zstd decoders but no deflate one, so this streams deflate content through {@link Inflater}
+ * directly. Note this only handles zlib-wrapped deflate (RFC 1950); it is not registered as a
+ * per-request decoder in {@link HTTP2JettyClient} because retrying as raw/headerless deflate
+ * (RFC 1951) requires the fully buffered response body - see
+ * {@link HTTP2JettyClient#decodeDeflate}.
+ */
 public class DeflateContentDecoderFactory extends ContentDecoder.Factory {
 
   private final ByteBufferPool bufferPool;