Supported JMeter 5.6.3 (#104)

* Supported JMeter 5.6.3; updated libs, improved java docs.

---------

Co-authored-by: Mikhail Derevyanko <[email protected]>

Author: mderevyankoaqa

README.md

@@ -62,11 +62,11 @@ Pay attention on "Sending metrics performance tuning" chapter, see below.
 
 ## Compatibility
 The supported versions:
-* Java 11 - make sure that you have it (its minimum version).
+* 🚨 Java 11 - make sure that you have it (its minimum version); otherwise errors will occur while plugin loading.
 * InfluxDB v2.x, see release notes: https://docs.influxdata.com/influxdb/v2.0/reference/release-notes/influxdb/  (1.8 is not supported)
-* JMeter 5.6.2 only.
+* JMeter 5.6.3 only.
 
-* The current board and plugin were tested on Grafana 10.1.4 and InfluxDB 2.7.1, JAVA 15.
+* The current board and plugin were tested on Grafana 11.1.3 and InfluxDB 2.7.8, JAVA 21.0.1.
 
 ## Maven Support
 Please see the latest release here https://search.maven.org/artifact/io.github.mderevyankoaqa/jmeter-plugins-influxdb2-listener.
@@ -77,7 +77,7 @@ The example of the adding plugin to the project with the jmeter-maven:
 
           <configuration>
                 <jmeterExtensions>
-                  <artifact>io.github.mderevyankoaqa:jmeter-plugins-influxdb2-listener:2.1</artifact>
+                  <artifact>io.github.mderevyankoaqa:jmeter-plugins-influxdb2-listener:2.8</artifact>
                 </jmeterExtensions>
             </configuration>
 Some notes cab be found in the article [Adding jar's to the /lib/ext directory](https://github.com/jmeter-maven-plugin/jmeter-maven-plugin/wiki/Adding-Excluding-libraries-to-from-the-classpath).

build.gradle

@@ -24,32 +24,31 @@ repositories {
 
 sourceCompatibility = 11
 group = 'io.github.mderevyankoaqa'
-version = '2.7'
+version = '2.8'
 
 def title = 'JMeterInfluxDB2Listener'
 def archiveName = 'jmeter-plugins-influxdb2-listener'
 
 
 // There's a bug in JMeter leaving extra metadata right now. This is a workaround.
-    class JMeterRule implements ComponentMetadataRule {
+    abstract class JMeterRule implements ComponentMetadataRule {
         void execute(ComponentMetadataContext context) {
-            context.details.allVariants {
-                withDependencies {
-                    removeAll { it.group == "org.apache.jmeter" && it.name == "bom" }
+            context.details.allVariants { variant ->
+                variant.withDependencies { dependencies ->
+                    dependencies.removeAll { it.group == "org.apache.jmeter" && it.name == "bom" }
                 }
             }
         }
     }
 
     dependencies {
-//        classpath "com.github.johnrengelman:shadow:8.1.1"
-        implementation group: 'org.apache.jmeter', name: 'ApacheJMeter_core', version: '5.6.2'
-        implementation group: 'org.apache.jmeter', name: 'ApacheJMeter_java', version: '5.6.2'
-        implementation group: 'org.apache.jmeter', name: 'ApacheJMeter_components', version: '5.6.2'
-        implementation group: 'org.apache.jmeter', name: 'jorphan', version: '5.6.2'
-        implementation group: 'com.influxdb', name: 'influxdb-client-java', version: '6.10.0'
-        implementation group: 'org.apache.commons', name: 'commons-lang3', version: '3.12.0'
-        implementation group: 'org.apache.jmeter', name: 'ApacheJMeter_http', version: '5.6.2'
+        implementation group: 'org.apache.jmeter', name: 'ApacheJMeter_core', version: '5.6.3'
+        implementation group: 'org.apache.jmeter', name: 'ApacheJMeter_java', version: '5.6.3'
+        implementation group: 'org.apache.jmeter', name: 'ApacheJMeter_components', version: '5.6.3'
+        implementation group: 'org.apache.jmeter', name: 'jorphan', version: '5.6.3'
+        implementation group: 'com.influxdb', name: 'influxdb-client-java', version: '6.12.0'
+        implementation group: 'org.apache.commons', name: 'commons-lang3', version: '3.14.0'
+        implementation group: 'org.apache.jmeter', name: 'ApacheJMeter_http', version: '5.6.3'
         components {
             withModule("org.apache.jmeter:ApacheJMeter_core", JMeterRule)
             withModule("org.apache.jmeter:ApacheJMeter_java", JMeterRule)

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 #Fri Apr 17 22:39:55 EEST 2020
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-all.zip
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStorePath=wrapper/dists

src/main/java/io/github/mderevyankoaqa/influxdb2/visualizer/InfluxDatabaseBackendListenerClient.java

@@ -35,6 +35,16 @@
  */
 
 public class InfluxDatabaseBackendListenerClient extends AbstractBackendListenerClient implements Runnable {
+
+    /**
+     * Constructs a new instance of {@link InfluxDatabaseBackendListenerClient}.
+     * This constructor is currently empty, but can be used to initialize any necessary
+     * resources or configurations in future extensions.
+     */
+    public InfluxDatabaseBackendListenerClient() {
+
+    }
+
     /**
      * Logger.
      */

src/main/java/io/github/mderevyankoaqa/influxdb2/visualizer/config/ArgsValidator.java

@@ -6,6 +6,17 @@
  */
 public final class ArgsValidator {
 
+    /**
+     * Private constructor to prevent instantiation of {@link ArgsValidator}.
+     * <p>
+     * This constructor is intentionally left empty as this class is designed to be a
+     * utility class with only static methods and should not be instantiated.
+     * </p>
+     */
+    private ArgsValidator() {
+        // This constructor is intentionally left empty to prevent instantiation.
+    }
+
     /**
      * Checks that http scheme is "http" or "https".
      * @param scheme represents the http scheme.

src/main/java/io/github/mderevyankoaqa/influxdb2/visualizer/config/InfluxDBConfig.java

@@ -133,9 +133,21 @@ public class InfluxDBConfig {
     private int responseBodyLength;
 
     /**
-     * Creates the new instance of {@link InfluxDBConfig}
+     * Constructs a new {@link InfluxDBConfig} instance using the provided {@link BackendListenerContext}.
+     * <p>
+     * This constructor initializes the InfluxDB configuration settings by extracting parameters
+     * from the provided context and performing necessary validation checks.
+     * </p>
      *
-     * @param context the {@link BackendListenerContext}
+     * <ul>
+     *   <li>Validates and sets the InfluxDB URL, ensuring that the scheme is either HTTP or HTTPS.</li>
+     *   <li>Validates and sets the InfluxDB authentication token.</li>
+     *   <li>Validates and sets the InfluxDB organization and bucket names.</li>
+     *   <li>Validates and sets batch size, flush interval, error threshold, and response body length.</li>
+     * </ul>
+     *
+     * @param context the {@link BackendListenerContext} containing the configuration parameters for InfluxDB.
+     * @throws IllegalArgumentException if any of the required parameters are missing or invalid.
      */
     public InfluxDBConfig(BackendListenerContext context) {
         String influxDBURL = context.getParameter(KEY_INFLUX_DB_URL);

src/main/java/io/github/mderevyankoaqa/influxdb2/visualizer/influxdb/client/InfluxDatabaseClient.java

@@ -26,10 +26,14 @@ public class InfluxDatabaseClient {
 
 
     /**
-     * Creates a new instance of the @link InfluxDatabaseClient.
+     * Private constructor for creating a new instance of {@link InfluxDatabaseClient}.
+     * <p>
+     * This constructor initializes the {@code InfluxDatabaseClient} with the provided configuration and logger.
+     * It also sets up synchronized lists for managing points and error counts.
+     * </p>
      *
-     * @param config {@link InfluxDBConfig}
-     * @param logger {@link Logger}
+     * @param config the {@link InfluxDBConfig} used to configure the client.
+     * @param logger the {@link Logger} used for logging within the client.
      */
     private InfluxDatabaseClient(InfluxDBConfig config, Logger logger) {
 
@@ -42,10 +46,17 @@ private InfluxDatabaseClient(InfluxDBConfig config, Logger logger) {
     }
 
     /**
-     * Creates the singleton instance of the {@link InfluxDatabaseClient}.
-     * @param config {@link InfluxDBConfig}
-     * @param logger {@link Logger}
-     * @return the created instance of {@link InfluxDatabaseClient}
+     * Creates and returns the singleton instance of {@link InfluxDatabaseClient}.
+     * <p>
+     * This method ensures that only one instance of {@link InfluxDatabaseClient}
+     * is created throughout the application's lifecycle. If the instance already
+     * exists, it returns the existing one; otherwise, it creates a new instance
+     * with the provided {@link InfluxDBConfig} and {@link Logger}.
+     * </p>
+     *
+     * @param config the configuration for the InfluxDB connection.
+     * @param logger the logger to be used by the InfluxDatabaseClient.
+     * @return the singleton instance of {@link InfluxDatabaseClient}.
      */
     public static InfluxDatabaseClient getInstance(InfluxDBConfig config, Logger logger) {
 

src/main/java/io/github/mderevyankoaqa/influxdb2/visualizer/influxdb/client/InfluxDatabaseUtility.java

@@ -6,6 +6,11 @@
  */
 public class InfluxDatabaseUtility {
 
+    // Private constructor to prevent instantiation
+    private InfluxDatabaseUtility() {
+        // This constructor is intentionally left empty to prevent instantiation.
+    }
+
     /**
      * Updates not supported values.
      * @param value the string which is going to be updated.
@@ -20,10 +25,19 @@ public static String getEscapedString(String value) {
     }
 
     /**
-     * Gets the substring from the value.
-     * @param value the initial value.
-     * @param expectedLength the expected length.
-     * @return returns the the truncated string if the initial string length is less or equal to expected length; otherwise initial string.
+     * Returns a substring of the specified length from the given string.
+     * <p>
+     * If the length of the provided string is greater than or equal to the
+     * expected length, this method returns the substring starting from the
+     * beginning of the string up to the expected length. If the length of the
+     * string is less than the expected length, the entire string is returned
+     * without any truncation.
+     * </p>
+     *
+     * @param value the original string from which the substring will be extracted.
+     * @param expectedLength the desired length of the substring.
+     * @return the substring of the specified length if the original string is
+     *         longer than the expected length; otherwise, the original string.
      */
     public static String getSubstring(String value, int expectedLength)
     {

src/main/java/io/github/mderevyankoaqa/influxdb2/visualizer/result/SampleResultPointContext.java

@@ -17,6 +17,17 @@ public class SampleResultPointContext {
     private int ResponseBodyLength;
     private String samplerType;
 
+    /**
+     * Default constructor for the {@code SampleResultPointContext} class.
+     * <p>
+     * This constructor initializes a new instance of {@code SampleResultPointContext} with default settings.
+     * It does not perform any additional setup or initialization tasks.
+     * </p>
+     */
+    public SampleResultPointContext()
+    {
+    }
+
     /**
      * Checks whether the body of the failed repose is going to be saved.
      * @return true to save body; otherwise false to skip saving.

src/main/java/io/github/mderevyankoaqa/influxdb2/visualizer/result/SampleResultPointProvider.java

@@ -15,16 +15,21 @@ public class SampleResultPointProvider {
     private static final String NO_DATA = "noData";
 
     /**
-     * Creates the new instance of the {@link SampleResultPointProvider}.
-     * @param sampleResultContext the {@link SampleResultPointContext}.
+     * Creates a new instance of the {@link SampleResultPointProvider}.
+     * Initializes the provider with the given {@link SampleResultPointContext}.
+     *
+     * @param sampleResultContext the context used to initialize the provider; must be an instance of {@link SampleResultPointContext}.
      */
     public SampleResultPointProvider(SampleResultPointContext sampleResultContext) {
         this.sampleResultContext = sampleResultContext;
     }
 
     /**
-     * Gets {@link Point}, returns the OK or KO jmeter point, depends from the sample result.
-     * @return {@link Point} to save.
+     * Retrieves a {@link Point} based on the sample result.
+     * The returned point is marked as either "pass" or "fail" depending on the error count of the sample result.
+     *
+     * @return the {@link Point} representing the result of the sample; the point is tagged with "pass" if there are no errors,
+     *         or "fail" if there are errors.
      */
     public Point getPoint() {
         Point point = this.getDefaultPoint();
@@ -40,9 +45,12 @@ public Point getPoint() {
     }
 
     /**
-     * Gets the error body to be saved in the point.
-     * @param isToBeSaved set to true if body need to be saved; otherwise false.
-     * @return the normalized string if parameter @param isToBeSaved set to true; 'noData' string otherwise.
+     * Retrieves the error body to be saved in the point.
+     *
+     * @param isToBeSaved if true, the error body will be saved; if false, 'noData' will be returned.
+     * @param isSuccessful if true, the error body will be retrieved; otherwise 'noData' will be returned.
+     * @return the error body as a normalized string if {@code isToBeSaved} and {@code isSuccessful} are true;
+     *         otherwise returns 'noData'.
      */
      private String getErrorBodyToBeSaved(boolean isToBeSaved, boolean isSuccessful)
      {