Setup tmp documentation for the API

Author: anthonygauthier

README.md

@@ -21,13 +21,14 @@ Here are some scenarios where this kind of tool becomes very handy:
 - [x] Add threads
 - [x] Remove threads
 - [x] Get variables
-- [ ] Modify variables
-- [ ] Get properties
+- [x] Modify variables
+- [x] Get properties
 - [ ] Modify properties
 - [ ] Support for native distributed load testing
 - [ ] Support for distributed load testing through multiple injectors executing the same test
-- [ ] Document REST API
+- [ ] Initial documentation of the REST API
 - [ ] Restructure code-base so it's easier to read and maintain
+- [ ] Publish version __1.0.0__ to [JMeter-Plugins](https://jmeter-plugins.org/)
 
 ## Known issues/limitations
 
@@ -36,6 +37,69 @@ As of right now, I am aware of a few limitations;
 * Of course, everything that's not checked on the roadmap is not working.
 * The live changes plugin currently only works with one Thread Group. There seems to be issues when more than one thread groups are involved in a test plan.
 
+## Setup
+
+1. Download the latest JAR from the release section
+2. Move the file to your `JMETER_HOME/lib/ext` folder
+3. Start JMeter, load your test plan
+4. Add the `Live Changes Config` element to your Thread Group
+5. Set the port you want to be able to communicate with (defaults to `7566`)
+6. Start your test
+7. By using any HTTP client (Postman, Insomnia, cURL, etc.) communicate with the REST API to change your test's values
+
+** The API documentation is still under construction **
+
+## Temporary API Doc
+
+`GET /variables`: Retrieves the variables declared for your test
+
+---
+
+`POST /variables`: Send (as JSON) your variables changes.
+
+Example:
+```json
+{
+  "myInt": 1,
+  "myString": "foo"
+}
+```
+
+---
+
+`GET /threads`: Retrieves the number of active threads.
+
+---
+
+`POST /threads`: Send (as JSON) your new active threads number.
+
+Example:
+```json
+{
+  "threadNum": 5
+}
+```
+
+---
+
+`GET /properties`: Retrieves the properties declared for your test
+
+---
+
+`POST /properties`: Send (as JSON) your properties changes.
+
+Example:
+```json
+{
+  "myProp": "bar"
+}
+```
+
+---
+
+
+
+
 ## Contributing
 This plugin is licensed under the MIT license. 
 

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

@@ -72,7 +72,6 @@ public void checkForThreadChanges(ThreadGroup threadGroup, LoopIterationEvent ev
                     if(diff < 0) {
                         threadGroup.addNewThread(0, new StandardJMeterEngine());
                     } else {
-                        logger.warn("Stopping: " + threadName + "-" + threadGroup.getNumThreads());
                         threadGroup.stopThread(threadName + "-" + threadGroup.numberOfActiveThreads(), true);
                     }
                 }
@@ -87,11 +86,18 @@ public void checkForThreadChanges(ThreadGroup threadGroup, LoopIterationEvent ev
     }
 
     public void checkForVariableChanges(JMeterVariables vars, LoopIterationEvent event) {
-        jMeterVariables = vars;
-        JMeterContextService.getContext().setVariables(jMeterVariables);
+        if(event.getIteration() == 1) {
+            jMeterVariables = vars;
+        } else {
+            JMeterContextService.getContext().setVariables(jMeterVariables);
+        }
     }
     public void checkForPropertyChanges(Properties props, LoopIterationEvent event) {
-        jMeterProperties = props;
+        if(event.getIteration() == 1) {
+            jMeterProperties = props;
+        } else {
+//            JMeterContextService.getContext().setVariables(jmete);
+        }
     }
 
 

src/main/java/io/github/delirius325/jmeter/config/livechanges/api/App.java

@@ -76,16 +76,14 @@ public void handleHttpRequest(HttpRequest request, HttpResponse response, HttpCo
             @Override
             public void handleHttpRequest(HttpRequest request, HttpResponse response, HttpControl control) throws Exception {
                 JSONObject json = new JSONObject(request.body());
-                JMeterVariables originalVars = LiveChanges.getjMeterVariables();
-                JMeterVariables newVars = new JMeterVariables();
-
-                originalVars.entrySet().forEach(entry -> {
-                    newVars.put(entry.getKey(), entry.getValue().toString());
+                JMeterVariables vars = LiveChanges.getjMeterVariables();
+                vars.entrySet().forEach(entry -> {
                     if(json.has(entry.getKey()) && (json.get(entry.getKey()) != entry.getValue().toString())) {
                         json.put(entry.getKey(), json.get(entry.getKey()));
+                        vars.put(entry.getKey(), json.get(entry.getKey()).toString());
                     }
                 });
-                LiveChanges.setjMeterVariables(newVars);
+                LiveChanges.setjMeterVariables(vars);
                 jsonSetInfo(json, "success", "Variables were changed.");
                 response.content(json.toString()).header("Content-Type", "application/json").end();
             }