Merge pull request #17 from delirius325/0.0.3

0.0.3

Author: anthonygauthier

.travis.yml

@@ -1,3 +1,3 @@
 language: java
 jdk:
-- oraclejdk8
+- oraclejdk13

CHANGELOG.md

@@ -1,3 +1,15 @@
+## Version 0.0.3
+
+* Fixed #7
+    * `GET /api/threads` now correctly returns the thread groups' information
+* Fixed #15
+    * TravisCI was giving an error since the `openjdk8` agent is no longer available. Now using `openjdk13` as it's the java version used to develop the plugin.
+* Fixed #10
+    * Completely reworked the `GET /api/test/summary` endpoint, most computations now use the `Calculator` class from the JMeter core.
+* The `*.properties` files are now correctly included in the `pom.xml`, text is now correctly shown in JMeter
+* Fixed #13 and #14
+    * Side-fixes of the whole refactoring that was done in 0.0.3
+
 ## Version 0.0.2
 
 * Changed web server to Jetty + JAX-RS (from webbit-server + webbit-rest)
@@ -13,7 +25,6 @@
 
 
 Note: All endpoints require the test to be running to be consumed.
-
 ## Version 0.0.1
 
 * Temporary API documentation in README

README.md

@@ -1,7 +1,7 @@
 # JMeter Live Changes Config
 
 ## Overview
-This plugin, which is still in an early development stage __(v 0.0.2)__, allows the user to communicate with a RESTful API to change JMeter tests to change values such as:
+This plugin, which is still in an early development stage __(v 0.0.3)__, allows the user to communicate with a RESTful API to change JMeter tests to change values such as:
 
 * Throughput
 * Number of active threads
@@ -43,8 +43,10 @@ Here are some scenarios where this kind of tool becomes very handy:
 As of right now, I am aware of a few limitations;
 
 ### Issues
-* Everything that's not checked on the roadmap is not working.
-* The `GET /api/threads AND /api/threads/{name}` endpoint seem to be returning 0 active threads (will be fixed in 0.0.3)
+* When stopping the test, the API seems to cache sample results. They should be emptied. (#)
+
+++ Everything that's not checked on the roadmap is not working.
+
 
 ### Limitations
 * The `Live Changes Config` __must__ be declared at the root of your `Test Plan`
@@ -118,10 +120,10 @@ __Request__ example:
 __Response__ example :
 ```json
 {
-    "startTime": 0,
-    "runningTime": 0,
-    "totalActiveThreads": 0,
-    "totalThreads": 0
+    "totalThreads": 10,
+    "startTime": 1590694152358,
+    "runningTime": 6,
+    "totalActiveThreads": 10
 }
 ``` 
 
@@ -143,43 +145,39 @@ __Response__ example :
 ```json
 [
     {
-        "testSample": {
-            "averageLatency": 75,
-            "averageResponseTime": 797,
-            "minResponseTime": 0,
-            "maxResponseTime": 417,
-            "hitsPerSecond": 3,
-            "sentBytesPerSecond": 0,
-            "totalErrors": 0,
-            "errorPercentage": 0,
-            "receivedBytesPerSecond": 352,
-            "timeRunning": 4055,
-            "90thPercentile": 349,
-            "totalSamples": 12,
-            "totalBytes": 1368,
-            "averageBytes": 114,
-            "totalSentBytes": 0,
-            "standardDeviation": -554
+        "Google": {
+            "averageLatency": "160",
+            "averageResponseTime": "341",
+            "minResponseTime": "194",
+            "maxResponseTime": "865",
+            "hitsPerSecond": "1.03",
+            "sentBytesPerSecond": "233.54",
+            "totalErrors": "0",
+            "errorPercentage": "0",
+            "receivedBytesPerSecond": "14690.83",
+            "90thPercentile": "477",
+            "totalSamples": "36",
+            "totalBytes": "511799",
+            "averageBytes": "14216.64",
+            "standardDeviation": "156.37"
         }
     },
     {
-        "testSample - 2": {
-            "averageLatency": 98,
-            "averageResponseTime": 955,
-            "minResponseTime": 0,
-            "maxResponseTime": 450,
-            "hitsPerSecond": 3,
-            "sentBytesPerSecond": 0,
-            "totalErrors": 0,
-            "errorPercentage": 0,
-            "receivedBytesPerSecond": 369,
-            "timeRunning": 4055,
-            "90thPercentile": 393,
-            "totalSamples": 13,
-            "totalBytes": 1482,
-            "averageBytes": 114,
-            "totalSentBytes": 0,
-            "standardDeviation": -708
+        "Yahoo": {
+            "averageLatency": "178",
+            "averageResponseTime": "947",
+            "minResponseTime": "492",
+            "maxResponseTime": "6239",
+            "hitsPerSecond": "1.2",
+            "sentBytesPerSecond": "404.12",
+            "totalErrors": "0",
+            "errorPercentage": "0",
+            "receivedBytesPerSecond": "172374.09",
+            "90thPercentile": "1422",
+            "totalSamples": "42",
+            "totalBytes": "6055157",
+            "averageBytes": "144170.4",
+            "standardDeviation": "896.6"
         }
     }
 ]

pom.xml

@@ -3,12 +3,12 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>io.github.delirius325</groupId>
 	<artifactId>jmeter.config.livechanges</artifactId>
-	<version>0.0.2</version>
+	<version>0.0.3</version>
 	<packaging>jar</packaging>
 
-	<name>jmeter.backendlistener.livechanges</name>
+	<name>jmeter.config.livechanges</name>
 	<description>This plugin serves as a channel to expose a REST API to change a JMeter Test Plan live while it's being executed.</description>
-	<url>https://github.com/delirius325/jmeter-livechanges-backend-listener</url>
+	<url>https://github.com/delirius325/jmeter-live-changes-config</url>
 
 	<licenses>
 		<license>
@@ -19,7 +19,7 @@
 	</licenses>
 
 	<scm>
-		<url>https://github.com/delirius325/jmeter-livechanges-backend-listener.git</url>
+		<url>https://github.com/delirius325/jmeter-live-changes-config.git</url>
 	</scm>
 
 	<developers>
@@ -34,19 +34,19 @@
 
 	<properties>
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-		<maven.compiler.source>1.8</maven.compiler.source>
-		<maven.compiler.target>1.8</maven.compiler.target>
-		<java.version>1.8</java.version>
+		<maven.compiler.source>1.9</maven.compiler.source>
+		<maven.compiler.target>1.9</maven.compiler.target>
+		<java.version>1.9</java.version>
 		<junit.version>4.12</junit.version>
 		<junit.jupiter.version>5.0.0</junit.jupiter.version>
 		<junit.vintage.version>${junit.version}.0</junit.vintage.version>
 		<junit.jupiter.version>5.0.0</junit.jupiter.version>
 		<junit.platform.version>1.0.0</junit.platform.version>
-		<org.apache.jmeter.version>4.0</org.apache.jmeter.version>
-		<org.apache.commons>3.7</org.apache.commons>
+		<org.apache.jmeter.version>5.3</org.apache.jmeter.version>
+		<org.apache.commons>3.10</org.apache.commons>
 		<slf4jVersion>1.7.25</slf4jVersion>
-		<jerseyVersion>2.28</jerseyVersion>
-        <jettyVersion>[9.4.11.v20180605,)</jettyVersion>
+		<jerseyVersion>2.31</jerseyVersion>
+        <jettyVersion>[9.4.29.v20200521,)</jettyVersion>
 	</properties>
 	<dependencies>
 		<dependency>
@@ -64,6 +64,11 @@
 			<artifactId>jetty-servlet</artifactId>
 			<version>${jettyVersion}</version>
 		</dependency>
+		<dependency>
+			<groupId>org.eclipse.jetty</groupId>
+			<artifactId>jetty-util</artifactId>
+			<version>${jettyVersion}</version>
+		</dependency>
 		<dependency>
 			<groupId>org.glassfish.jersey.core</groupId>
 			<artifactId>jersey-server</artifactId>
@@ -155,6 +160,11 @@
 			<version>${junit.vintage.version}</version>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+			<groupId>org.latencyutils</groupId>
+			<artifactId>LatencyUtils</artifactId>
+			<version>2.0.3</version>
+		</dependency>
 	</dependencies>
 	<distributionManagement>
 		<snapshotRepository>
@@ -196,6 +206,14 @@
 		</profile>
 	</profiles>
 	<build>
+		<resources>
+			<resource>
+				<directory>src/main/java</directory>
+				<includes>
+					<include>**/*.properties</include>
+				</includes>
+			</resource>
+		</resources>
 		<plugins>
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
@@ -232,13 +250,17 @@
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-javadoc-plugin</artifactId>
-				<version>2.9.1</version>
+				<version>2.10.4</version>
 				<executions>
 					<execution>
 						<id>attach-javadocs</id>
 						<goals>
 							<goal>jar</goal>
 						</goals>
+						<configuration> <!-- add this to disable checking -->
+							<additionalparam>-Xdoclint:none</additionalparam>
+							<detectJavaApiLink>false</detectJavaApiLink>
+						</configuration>
 					</execution>
 				</executions>
 			</plugin>
@@ -263,8 +285,8 @@
 				<artifactId>maven-compiler-plugin</artifactId>
 				<version>3.7.0</version>
 				<configuration>
-					<source>1.8</source>
-					<target>1.8</target>
+					<source>1.9</source>
+					<target>1.9</target>
 				</configuration>
 			</plugin>
 			<plugin>

src/main/java/io/github/delirius325/jmeter/config/livechanges/LiveChanges.java

@@ -21,6 +21,7 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.util.HashSet;
 import java.util.Properties;
 
 /**
@@ -30,12 +31,16 @@ public class LiveChanges extends ConfigTestElement implements TestBean, LoopIter
     private static final String testPlanFile = String.format("%s/%s", FileServer.getFileServer().getBaseDir(), FileServer.getFileServer().getScriptName());
     private static final Logger logger = LoggerFactory.getLogger(LiveChanges.class);
 
+    // Class attributes
     private App app;
-    private int httpServerPort;
-    private int calculationRate;
+    private Integer httpServerPort;
+
+    // Static Attributes - available to other classes
+    private static int staticCalcRate;
     private static int activeThreads;
     private static JMeterVariables jMeterVariables;
     private static Properties jMeterProperties;
+    private static HashSet<ThreadGroup> testThreadGroups = new HashSet<>();
     private static ThreadGroup activeThreadGroup = new ThreadGroup();
     private static boolean stopTest;
     private static HashTree testPlanTree;
@@ -63,7 +68,7 @@ public void testEnded() {
         try {
             this.finalizeTest();
         } catch (Exception e) {
-            logger.error("LiveChanges API was unable to gracefully shutdown. More info into JMeter's console.");
+            logger.error("LiveChanges API was unable to gracefully shutdown. More info in JMeter's console.");
         }
     }
 
@@ -76,24 +81,27 @@ public void testEnded(String host) {
         try {
             this.finalizeTest();
         } catch (Exception e) {
-            logger.error("LiveChanges API was unable to gracefully shutdown. More info into JMeter's console.");
+            logger.error("LiveChanges API was unable to gracefully shutdown. More info in JMeter's console.");
         }
     }
 
     /**
      * Method that is executed upon every thread iteration of the JMeter script
+     * This plugin works specifically because of this method that acts as an non-blocking event loop
      * @param event LoopIterationEvent
      */
     @Override
     public void iterationStart(LoopIterationEvent event) {
         if(event.getIteration() == 1) {
             jMeterEngine = JMeterContextService.getContext().getEngine();
         }
+
         ThreadGroup threadGroup = (ThreadGroup) JMeterContextService.getContext().getThreadGroup();
         JMeterVariables vars = JMeterContextService.getContext().getVariables();
         Properties props = JMeterContextService.getContext().getProperties();
         String tmp = JMeterContextService.getContext().getThread().getThreadName();
         String threadName = tmp.substring(0, tmp.lastIndexOf("-"));
+        this.getTestThreadGroups().add(threadGroup);
 
         if(stopTest) {
             jMeterEngine.askThreadsToStop();
@@ -180,7 +188,7 @@ private void startServer() {
             this.app = new App(this.httpServerPort);
             this.app.start();
         } catch (IOException e) {
-            logger.error("An error occured when loading the test plan tree. View JMeter's console for more information.");
+            logger.error("LiveChanges was unable to load the test plan tree. More info in JMeter's console.");
             e.printStackTrace();
         }
     }
@@ -193,7 +201,7 @@ private void finalizeTest() {
             this.app.stop();
             logger.info("LiveChanges API was successfully stopped.");
         } catch (Exception e) {
-            logger.error("Unable to correctly shutdown Jetty server", e);
+            logger.error("LiveChanges was unable to correctly shutdown Jetty server. More info in JMeter's console", e);
         }
     }
 
@@ -206,12 +214,6 @@ public int getHttpServerPort() {
     public void setHttpServerPort(int port) {
         this.httpServerPort = port;
     }
-    public int getCalculationRate() {
-        return calculationRate;
-    }
-    public void setCalculationRate(int rate) {
-        this.calculationRate = rate;
-    }
     public static int getActiveThreads() {
         return activeThreads;
     }
@@ -226,4 +228,9 @@ public static int getActiveThreads() {
     public static void setjMeterVariables(JMeterVariables vars) { jMeterVariables = vars; }
     public static Properties getjMeterProperties() { return jMeterProperties; }
     public static HashTree getTestPlanTree() { return testPlanTree; }
+    public static HashSet<ThreadGroup> getTestThreadGroups() { return testThreadGroups; }
+    public static void setTestThreadGroups(HashSet<ThreadGroup> threadGroupHashSet) { LiveChanges.testThreadGroups = threadGroupHashSet; }
+    public static int getStaticCalcRate() { return staticCalcRate; }
+    public static void setStaticCalcRate(int staticCalcRate) { LiveChanges.staticCalcRate = staticCalcRate; }
+
 }

src/main/java/io/github/delirius325/jmeter/config/livechanges/LiveChangesBeanInfo.java

@@ -1,24 +1,21 @@
 package io.github.delirius325.jmeter.config.livechanges;
 
 import org.apache.jmeter.testbeans.BeanInfoSupport;
+
 import java.beans.PropertyDescriptor;
 
 public class LiveChangesBeanInfo extends BeanInfoSupport {
     private static final String PORT = "httpServerPort";
-    private static final String CALCULATION_RATE = "calculationRate";
 
     public LiveChangesBeanInfo() {
         super(LiveChanges.class);
 
-        createPropertyGroup("live_changes", new String[] {
-            PORT,
-            CALCULATION_RATE
+        createPropertyGroup("livechanges", new String[] {
+            PORT
         });
 
-        PropertyDescriptor port = property(PORT);
-        port.setValue(DEFAULT, 7566);
-
-        PropertyDescriptor calculationRate = property(CALCULATION_RATE);
-        calculationRate.setValue(DEFAULT, 10);
+        PropertyDescriptor p = property(PORT);
+        p.setValue(NOT_UNDEFINED, Boolean.TRUE);
+        p.setValue(DEFAULT, 7566);
     }
 }