Merge pull request #153 from andy-tarr/master

add Runtime Controller support

Author: rabelenda

jmeter-java-dsl/src/main/java/us/abstracta/jmeter/javadsl/JmeterDsl.java

@@ -14,6 +14,7 @@
 import us.abstracta.jmeter.javadsl.core.controllers.DslForEachController;
 import us.abstracta.jmeter.javadsl.core.controllers.DslIfController;
 import us.abstracta.jmeter.javadsl.core.controllers.DslOnceOnlyController;
+import us.abstracta.jmeter.javadsl.core.controllers.DslRuntimeController;
 import us.abstracta.jmeter.javadsl.core.controllers.DslTransactionController;
 import us.abstracta.jmeter.javadsl.core.controllers.DslWeightedSwitchController;
 import us.abstracta.jmeter.javadsl.core.controllers.DslWhileController;
@@ -622,6 +623,25 @@ public static DslForEachController forEachController(String name, String varsPre
   public static DslOnceOnlyController onceOnlyController(ThreadGroupChild... children) {
     return new DslOnceOnlyController(Arrays.asList(children));
   }
+  /**
+   * Builds a Runtime Controller that allows it's child elements to be executed for a defined amount of time (seconds)
+   * per thread group iteration.
+   * This can be very useful in tailoring a test plan to more accurately  the actual behavior of users in a system or
+   * perhaps control the execution of a set of samplers for a period of time followed by a request to refresh an auth token.
+   * When the defined execution time of the controller is reached, the runtime controller will stop execution and the next part of the
+   * test plan will be executed
+   *@param seconds defines the number of seconds the runtime controller should be executed on
+   *               each iteration. Can be a variable expression or a fixed value.
+   * @param children contains the test plan elements to execute only one time on first iteration of
+   *                 each thread group.
+   * @return the controller instance for further configuration and usage.
+   * @see DslRuntimeController
+   */
+
+  public static DslRuntimeController runtimeController(String seconds,
+      ThreadGroupChild... children) {
+    return new DslRuntimeController(seconds, Arrays.asList(children));
+  }
 
   /**
    * Builds a Percent Controller to execute children only a given percent of times.

jmeter-java-dsl/src/main/java/us/abstracta/jmeter/javadsl/core/controllers/DslRuntimeController.java

@@ -0,0 +1,54 @@
+package us.abstracta.jmeter.javadsl.core.controllers;
+
+import java.lang.reflect.Method;
+import java.util.List;
+import org.apache.jmeter.control.RunTime;
+import org.apache.jmeter.control.gui.RunTimeGui;
+import org.apache.jmeter.testelement.TestElement;
+import us.abstracta.jmeter.javadsl.codegeneration.MethodCall;
+import us.abstracta.jmeter.javadsl.codegeneration.MethodCallContext;
+import us.abstracta.jmeter.javadsl.codegeneration.SingleTestElementCallBuilder;
+import us.abstracta.jmeter.javadsl.codegeneration.TestElementParamBuilder;
+import us.abstracta.jmeter.javadsl.codegeneration.params.ChildrenParam;
+import us.abstracta.jmeter.javadsl.core.threadgroups.BaseThreadGroup;
+import us.abstracta.jmeter.javadsl.core.threadgroups.BaseThreadGroup.ThreadGroupChild;
+
+/**
+ * Allows running a part of a test plan repeatedly for a specified number of seconds
+ * for each iteration of each thread in a thread group.
+ * <p>
+ * Internally this uses JMeter Runtime Controller (Runtime class).
+ *
+  */
+public class DslRuntimeController extends BaseController<DslRuntimeController> {
+
+  protected String seconds;
+
+  public DslRuntimeController(String seconds,
+            List<BaseThreadGroup.ThreadGroupChild> children) {
+    super("Runtime Controller", RunTimeGui.class, children);
+    this.seconds = seconds;
+  }
+
+  @Override
+  protected TestElement buildTestElement() {
+    RunTime ret = new RunTime();
+    ret.setRuntime(seconds);
+    return ret;
+  }
+
+  public static class CodeBuilder extends SingleTestElementCallBuilder<RunTime> {
+    public CodeBuilder(List<Method> builderMethods) {
+      super(RunTime.class, builderMethods);
+    }
+
+    @Override
+    protected MethodCall buildMethodCall(RunTime testElement,
+                                         MethodCallContext context) {
+      TestElementParamBuilder paramBuilder = new TestElementParamBuilder(testElement,
+              "RuntimeController");
+      return buildMethodCall(paramBuilder.stringParam("seconds"),
+              new ChildrenParam<>(ThreadGroupChild[].class));
+    }
+  }
+}

jmeter-java-dsl/src/test/java/us/abstracta/jmeter/javadsl/core/controllers/DslRuntimeControllerTest.java

@@ -0,0 +1,40 @@
+package us.abstracta.jmeter.javadsl.core.controllers;
+
+import org.junit.jupiter.api.*;
+import us.abstracta.jmeter.javadsl.*;
+import us.abstracta.jmeter.javadsl.codegeneration.*;
+import us.abstracta.jmeter.javadsl.core.*;
+
+import static org.assertj.core.api.Assertions.*;
+import static us.abstracta.jmeter.javadsl.JmeterDsl.*;
+
+public class DslRuntimeControllerTest extends JmeterDslTest {
+
+  @Test
+  public void shouldExecuteMultipleTimesWhenRuntimeControllerInPlan() throws Exception {
+    TestPlanStats stats = testPlan(
+        threadGroup(1, 1,
+            runtimeController ("1",
+                httpSampler(wiremockUri)
+            )
+        )
+    ).run();
+    assertThat(stats.overall().samplesCount()).isGreaterThan(1);
+  }
+
+  @Nested
+  public class CodeBuilderTest extends MethodCallBuilderTest {
+
+    public DslTestPlan testPlanWithRuntimeController() {
+      return testPlan(
+          threadGroup(1, 1,
+                  runtimeController("5",
+                  httpSampler("http://localhost")
+              )
+          )
+      );
+    }
+
+  }
+
+}