Mvnrepository support (#45)

* Added the maven publish task in the Gradle build.gradle, package renaming to inherit groupId, fix of the warnings.

* Fixed static code analysis warnings and java docs.

* Updated deployment.

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

Author: mderevyankoaqa

.gitignore

@@ -5,3 +5,5 @@
 .settings/
 .classpath
 .idea
+secret-key.gpg
+gradle.properties

README.md

@@ -1,4 +1,28 @@
 # JMeter InfluxDB v2.0 listener plugin
+<img src="https://badges.frapsoft.com/os/v3/open-source.svg?v=103" width="300">
+
+<p align="left">
+<img src="https://img.shields.io/github/issues/mderevyankoaqa/jmeter-influxdb2-listener-plugin?style=plastic&color=white">
+<img src="https://img.shields.io/github/forks/mderevyankoaqa/jmeter-influxdb2-listener-plugin?style=plastic">
+<img src="https://img.shields.io/github/stars/mderevyankoaqa/jmeter-influxdb2-listener-plugin?style=plastic&color=gold">
+<img src="https://img.shields.io/github/license/mderevyankoaqa/jmeter-influxdb2-listener-plugin?style=plastic">
+<img src="https://img.shields.io/github/repo-size/mderevyankoaqa/jmeter-influxdb2-listener-plugin?style=plastic">
+<img src="https://img.shields.io/github/issues/detail/age/mderevyankoaqa/jmeter-influxdb2-listener-plugin/1?style=plastic&color=purple">
+<img src="https://img.shields.io/github/commit-activity/m/mderevyankoaqa/jmeter-influxdb2-listener-plugin?style=plastic&color=red">
+<img src="https://img.shields.io/github/contributors/mderevyankoaqa/jmeter-influxdb2-listener-plugin?style=plastic">
+<img src="https://img.shields.io/github/last-commit/mderevyankoaqa/jmeter-influxdb2-listener-plugin?style=plastic">
+<img src="https://badgen.net/github/closed-issues/mderevyankoaqa/jmeter-influxdb2-listener-plugin">
+</p>
+
+<h3> 
+<details>
+<summary>Support my Ukrainian Family 
+</summary>
+ <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=H8L62WL5HVD32">
+  <img src="https://raw.githubusercontent.com/stefan-niedermann/paypal-donate-button/master/paypal-donate-button.png" alt="Donate with PayPal" />
+</a>
+</details>
+</h3> 
 
 ## Description
 The goal of the project is to make a quite similar online dashboard in the same way as JMeter generates. Supported the latest InfluxDB v2.0 and created appropriate dashboard ("Flux" language has been used to create the queries - now there are a lot fo capacities to build amazing charts, tables with a lot of math function).
@@ -22,13 +46,18 @@ Counter will be refreshed at least you have 4 fails. This is protection to avoid
 Pleas monitor the elapsed time of the data importing (see logs) to avoid issues with requests sending from JMeter.
 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).
 * InfluxDB v2.0, see release notes: https://docs.influxdata.com/influxdb/v2.0/reference/release-notes/influxdb/  (1.8 is not supported)
 * JMeter 5.4.3 only.
 * The current board and plugin were tested on Grafana 8.2.3 and InfluxDB 2.0.9, JAVA 15.
 
+## Maven Support
+Please see the latest release here https://s01.oss.sonatype.org/content/repositories/releases/io/github/mderevyankoaqa/jmeter-plugin-influxdb2-listener/maven-metadata.xml
+
 ## Deployment
 * Put '`jmeter-plugin-influxdb2-listener-<version>.jar`' file from [Releases](https://github.com/mderevyankoaqa/jmeter-influxdb2-listener-plugin/releases) to `~<JmeterPath<\lib\ext`; 
 
@@ -40,10 +69,22 @@ Note: "fatJar" gradle task should be used to create the package for the JMeter.
 
 ![](img/deploy2.png)
 
-* Select from the dropdown item with the name '`org.md.jmeter.influxdb2.visualizer.JMeterInfluxDBBackendListenerClient`'.
+* Select from the dropdown item with the name '`io.github.mderevyankoaqa.influxdb2.visualizer.JMeterInfluxDBBackendListenerClient`'.
 
  ![](img/deploy3.png)
 
+## Upgrade
+* Close JMeter if its started.
+* Remove old jar.
+* Put '`jmeter-plugin-influxdb2-listener-<version>.jar`' file from [Releases](https://github.com/mderevyankoaqa/jmeter-influxdb2-listener-plugin/releases) to `~<JmeterPath<\lib\ext`;
+* Run JMeter again and got Listener.
+* Select from the dropdown item with the name '`io.github.mderevyankoaqa.influxdb2.visualizer.JMeterInfluxDBBackendListenerClient`'.
+![](img/deploy3.png)
+* Click 'Clear all' button
+
+ ![](img/deploy6.png) 
+* Set right settings (update all properties).
+
 ## InfluxDB configuration
 * Create Bucket to store the further testing results.
 

build.gradle

@@ -1,8 +1,16 @@
 plugins {
     id 'com.github.johnrengelman.shadow' version "7.1.2"
     id 'java'
+    id 'java-library'
     id 'project-report'
+    id 'maven-publish'
     id 'idea'
+    id 'signing'
+}
+
+java {
+    withJavadocJar()
+    withSourcesJar()
 }
 
 repositories {
@@ -14,8 +22,9 @@ repositories {
 }
 
 sourceCompatibility = 11
-version = '1.6'
-def title = 'JMeterInfluxDBListener'
+group = 'io.github.mderevyankoaqa'
+version = '2.0'
+def title = 'JMeterInfluxDB2Listener'
 def archiveName = 'jmeter-plugin-influxdb2-listener'
 
 
@@ -38,7 +47,6 @@ def archiveName = 'jmeter-plugin-influxdb2-listener'
         implementation group: 'com.influxdb', name: 'influxdb-client-java', version: '6.1.0'
         implementation group: 'org.apache.commons', name: 'commons-lang3', version: '3.12.0'
 
-
         components {
             withModule("org.apache.jmeter:ApacheJMeter_core", JMeterRule)
             withModule("org.apache.jmeter:ApacheJMeter_java", JMeterRule)
@@ -53,7 +61,7 @@ jar {
         manifest {
         attributes 'Implementation-Title': title,
                    'Implementation-Version': archiveVersion,
-                   'Main-Class': 'org.md.jmeter.influxdb.visualizer.JMeterInfluxDBBackendListenerClient'
+                   'Main-Class': 'io.github.mderevyankoaqa.influxdb2.visualizer.JMeterInfluxDBBackendListenerClient'
     }
 }
 
@@ -63,3 +71,72 @@ shadowJar {
         inheritFrom project.tasks.jar.manifest
     }
 }
+
+publishing {
+    publications {
+        mavenJava(MavenPublication) {
+            groupId = 'io.github.mderevyankoaqa'
+            artifactId = archiveName
+            version = version
+
+            from components.java
+            versionMapping {
+                usage('java-api') {
+                    fromResolutionOf('runtimeClasspath')
+                }
+                usage('java-runtime') {
+                    fromResolutionResult()
+                }
+            }
+            pom {
+                name = archiveName
+                description = 'Influx DB v2.0 listener plugin for Apache JMeter. Provides the possibility to see the online dashboard (aggregation table, errors, the response body of failures).'
+                url = 'https://github.com/mderevyankoaqa/jmeter-influxdb2-listener-plugin'
+
+                licenses {
+                    license {
+                        name = 'The Apache License, Version 2.0'
+                        url = 'http://www.apache.org/licenses/LICENSE-2.0.txt'
+                    }
+                }
+                developers {
+                    developer {
+                        id = 'mderevyanko'
+                        name = 'Mike Derevianko'
+                        email = '[email protected]'
+                    }
+                }
+                scm {
+                    connection = 'scm:git:git:github.com/mderevyankoaqa/jmeter-influxdb2-listener-plugin.git'
+                    developerConnection = 'scm:git:ssh://github.com/mderevyankoaqa/jmeter-influxdb2-listener-plugin.git'
+                    url = 'https://github.com/mderevyankoaqa/jmeter-influxdb2-listener-plugin'
+                }
+            }
+        }
+    }
+
+
+    repositories {
+       maven {
+            name = "OSSRH"
+
+            url = "https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/"
+
+            credentials {
+                username = project.properties["ossrhUsername"]
+                password = project.properties["ossrhPassword"]
+           }
+        }
+    }
+}
+
+signing {
+    sign publishing.publications.mavenJava
+}
+
+
+javadoc {
+    if(JavaVersion.current().isJava9Compatible()) {
+        options.addBooleanOption('html5', true)
+    }
+}

img/deploy3.png

@@ -1,30 +1,28 @@
-package org.md.jmeter.influxdb2.visualizer;
+package io.github.mderevyankoaqa.influxdb2.visualizer;
 
+import java.security.SecureRandom;
+import java.time.LocalDate;
 import java.util.*;
-import java.util.concurrent.Executors;
-import java.util.concurrent.ScheduledThreadPoolExecutor;
-import java.util.concurrent.TimeUnit;
+import java.util.concurrent.*;
 
 import com.influxdb.client.domain.WritePrecision;
 import com.influxdb.client.write.Point;
-import org.md.jmeter.influxdb2.visualizer.influxdb.client.InfluxDatabaseClient;
-import org.md.jmeter.influxdb2.visualizer.config.InfluxDBConfig;
-import org.md.jmeter.influxdb2.visualizer.config.TestStartEndMeasurement;
-import org.md.jmeter.influxdb2.visualizer.config.VirtualUsersMeasurement;
+import io.github.mderevyankoaqa.influxdb2.visualizer.influxdb.client.InfluxDatabaseClient;
+import io.github.mderevyankoaqa.influxdb2.visualizer.config.InfluxDBConfig;
+import io.github.mderevyankoaqa.influxdb2.visualizer.config.TestStartEndMeasurement;
+import io.github.mderevyankoaqa.influxdb2.visualizer.config.VirtualUsersMeasurement;
 import org.apache.jmeter.config.Arguments;
 import org.apache.jmeter.samplers.SampleResult;
 import org.apache.jmeter.threads.JMeterContextService;
 import org.apache.jmeter.threads.JMeterContextService.ThreadCounts;
 import org.apache.jmeter.visualizers.backend.AbstractBackendListenerClient;
 import org.apache.jmeter.visualizers.backend.BackendListenerContext;
 
-import org.md.jmeter.influxdb2.visualizer.result.SampleResultPointContext;
-import org.md.jmeter.influxdb2.visualizer.result.SampleResultPointProvider;
+import io.github.mderevyankoaqa.influxdb2.visualizer.result.SampleResultPointContext;
+import io.github.mderevyankoaqa.influxdb2.visualizer.result.SampleResultPointProvider;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import static org.md.jmeter.influxdb2.visualizer.influxdb.client.InfluxDatabaseClient.getInstance;
-
 
 /**
  * Backend listener that writes JMeter metrics to influxDB directly.
@@ -92,18 +90,22 @@ public class InfluxDatabaseBackendListenerClient extends AbstractBackendListener
     /**
      * Random number generator.
      */
-    private Random randomNumberGenerator;
+    private SecureRandom randomNumberGenerator;
 
     /**
      * Indicates whether to record Sub samples.
      */
     private boolean recordSubSamples;
 
-
+    /**
+     * The Influx DB Config.
+     */
     private InfluxDBConfig influxDBConfig;
 
     private Timer timer;
 
+    private ScheduledFuture<?> scheduledFuture;
+
     /**
      * Processes sampler results.
      */
@@ -135,7 +137,7 @@ public void handleSampleResults(List<SampleResult> sampleResults, BackendListene
                 var sampleResultPointProvider = new SampleResultPointProvider(sampleResultContext);
 
                 Point resultPoint = sampleResultPointProvider.getPoint();
-                getInstance(this.influxDBConfig, LOGGER).collectData(resultPoint);
+                InfluxDatabaseClient.getInstance(this.influxDBConfig, LOGGER).collectData(resultPoint);
 
             }
         }
@@ -167,7 +169,7 @@ public Arguments getDefaultParameters() {
     public void setupTest(BackendListenerContext context) {
         this.testName = context.getParameter(KEY_TEST_NAME, "Test");
         this.runId = context.getParameter(KEY_RUN_ID, "R001"); //Will be used to compare performance of R001, R002, etc of 'Test'
-        this.randomNumberGenerator = new Random();
+        this.randomNumberGenerator = new SecureRandom ();
         this.nodeName = context.getParameter(KEY_NODE_NAME, "Test-Node");
 
         this.setupInfluxClient(context);
@@ -179,13 +181,13 @@ public void setupTest(BackendListenerContext context) {
                 .addTag(TestStartEndMeasurement.Tags.TEST_NAME, this.testName)
                 .addField(TestStartEndMeasurement.Fields.PLACEHOLDER, "1");
 
-        getInstance(influxDBConfig, LOGGER).collectData(setupPoint);
+        InfluxDatabaseClient.getInstance(influxDBConfig, LOGGER).collectData(setupPoint);
 
         this.parseSamplers(context);
         this.scheduler = (ScheduledThreadPoolExecutor) Executors.newScheduledThreadPool(2);
         this.scheduler.setRemoveOnCancelPolicy(true);
 
-        this.scheduler.scheduleAtFixedRate(this, 1, 1, TimeUnit.SECONDS);
+        this.scheduledFuture = this.scheduler.scheduleAtFixedRate(this, 1, 1, TimeUnit.SECONDS);
 
         // Indicates whether to write sub sample records to the database
         this.recordSubSamples = Boolean.parseBoolean(context.getParameter(KEY_RECORD_SUB_SAMPLES, "false"));
@@ -195,8 +197,10 @@ public void setupTest(BackendListenerContext context) {
     public void teardownTest(BackendListenerContext context) throws Exception {
         LOGGER.info("Shutting down influxDB scheduler...");
 
-
+        // Stop importing data by timer.
         this.timer.cancel();
+
+        this.scheduledFuture.cancel(false);
         this.scheduler.shutdown();
 
         this.addVirtualUsersMetrics(0, 0, 0, 0, JMeterContextService.getThreadCounts().finishedThreads);
@@ -208,16 +212,18 @@ public void teardownTest(BackendListenerContext context) throws Exception {
                 .addTag(TestStartEndMeasurement.Tags.TEST_NAME, this.testName)
                 .addField(TestStartEndMeasurement.Fields.PLACEHOLDER, "1");
 
-        getInstance(this.influxDBConfig, LOGGER).collectData(teardownPoint);
+        InfluxDatabaseClient.getInstance(this.influxDBConfig, LOGGER).collectData(teardownPoint);
 
         try {
-            this.scheduler.awaitTermination(30, TimeUnit.SECONDS);
             LOGGER.info("influxDB scheduler terminated!");
+            if(!this.scheduler.awaitTermination(30, TimeUnit.SECONDS)) {
+                LOGGER.info("Threads didn't finish in 30 seconds!");
+            }
         } catch (InterruptedException e) {
             LOGGER.error("Error waiting for end of scheduler " + e);
         }
 
-        getInstance(influxDBConfig, LOGGER).close();
+        InfluxDatabaseClient.getInstance(influxDBConfig, LOGGER).close();
         this.samplersToFilter.clear();
         super.teardownTest(context);
     }
@@ -245,7 +251,7 @@ private void setupInfluxClient(BackendListenerContext context) {
         this.influxDBConfig = new InfluxDBConfig(context);
 
 
-        getInstance(this.influxDBConfig, LOGGER).setupInfluxClient();
+        InfluxDatabaseClient.getInstance(this.influxDBConfig, LOGGER).setupInfluxClient();
 
         this.importDataByTimer(this.influxDBConfig, LOGGER);
 
@@ -287,7 +293,7 @@ private void addVirtualUsersMetrics(int minActiveThreads, int meanActiveThreads,
                 .addTag(VirtualUsersMeasurement.Tags.TEST_NAME, this.testName)
                 .addTag(VirtualUsersMeasurement.Tags.RUN_ID, this.runId);
 
-        getInstance(this.influxDBConfig, LOGGER).collectData(virtualUsersMetricsPoint);
+        InfluxDatabaseClient.getInstance(this.influxDBConfig, LOGGER).collectData(virtualUsersMetricsPoint);
     }
 
     /**
@@ -309,7 +315,7 @@ public void importDataByTimer(InfluxDBConfig conf, Logger logger) {
             @Override
             public void run() {
 
-                LOGGER.debug("Running the timer: " + new java.util.Date());
+                LOGGER.debug("Running the timer: " + LocalDate.now());
                 InfluxDatabaseClient.getInstance(conf, logger).importData();
 
             }

img/deploy6.png

@@ -1,4 +1,4 @@
-package org.md.jmeter.influxdb2.visualizer.config;
+package io.github.mderevyankoaqa.influxdb2.visualizer.config;
 
 /**
  * Arguments validation.