Move recorder logic to it's own module to ease reusage by community projects and make cli module simpler and more cohesive

Author: rabelenda-abstracta

jmeter-java-dsl-cli/pom.xml

@@ -17,9 +17,6 @@
   <properties>
     <picocli.version>4.7.1</picocli.version>
     <log4j.version>2.19.0</log4j.version>
-    <!-- same version as JMeter dependency -->
-    <slf4j.version>1.7.36</slf4j.version>
-    <selenium.version>4.8.0</selenium.version>
   </properties>
 
   <dependencies>
@@ -56,48 +53,45 @@
       <version>${project.version}</version>
     </dependency>
     <dependency>
-      <groupId>info.picocli</groupId>
-      <artifactId>picocli</artifactId>
-      <version>${picocli.version}</version>
-    </dependency>
-    <dependency>
-      <groupId>com.blazemeter</groupId>
-      <artifactId>jmeter-bzm-correlation-recorder</artifactId>
-      <version>1.2.3</version>
-    </dependency>
-    <dependency>
-      <groupId>org.seleniumhq.selenium</groupId>
-      <artifactId>selenium-chrome-driver</artifactId>
-      <version>${selenium.version}</version>
+      <groupId>us.abstracta.jmeter</groupId>
+      <artifactId>jmeter-java-dsl-recorder</artifactId>
+      <version>${project.version}</version>
     </dependency>
     <dependency>
       <groupId>org.slf4j</groupId>
-      <artifactId>slf4j-api</artifactId>
+      <artifactId>jul-to-slf4j</artifactId>
       <version>${slf4j.version}</version>
     </dependency>
     <dependency>
-      <groupId>org.slf4j</groupId>
-      <artifactId>jul-to-slf4j</artifactId>
-      <version>${slf4j.version}</version>
+      <groupId>info.picocli</groupId>
+      <artifactId>picocli</artifactId>
+      <version>${picocli.version}</version>
     </dependency>
     <dependency>
       <groupId>com.fasterxml.jackson.dataformat</groupId>
       <artifactId>jackson-dataformat-yaml</artifactId>
       <version>${jackson.version}</version>
     </dependency>
     <dependency>
-      <groupId>org.seleniumhq.selenium</groupId>
-      <artifactId>selenium-support</artifactId>
-      <version>${selenium.version}</version>
+      <groupId>us.abstracta.jmeter</groupId>
+      <artifactId>jmeter-java-dsl</artifactId>
+      <type>test-jar</type>
+      <version>${project.version}</version>
       <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>us.abstracta.jmeter</groupId>
-      <artifactId>jmeter-java-dsl</artifactId>
+      <artifactId>jmeter-java-dsl-recorder</artifactId>
       <type>test-jar</type>
       <version>${project.version}</version>
       <scope>test</scope>
     </dependency>
+    <!-- This should be in test scope, but defined in compile scope to avoid shade ignoring it -->
+    <dependency>
+      <groupId>org.seleniumhq.selenium</groupId>
+      <artifactId>selenium-chrome-driver</artifactId>
+      <version>${selenium.version}</version>
+    </dependency>
   </dependencies>
 
   <build>

jmeter-java-dsl-cli/src/main/java/us/abstracta/jmeter/javadsl/cli/RecorderCommand.java

@@ -22,9 +22,9 @@
 import picocli.CommandLine.Option;
 import picocli.CommandLine.Parameters;
 import picocli.CommandLine.TypeConversionException;
-import us.abstracta.jmeter.javadsl.cli.recorder.CorrelationRuleBuilder;
-import us.abstracta.jmeter.javadsl.cli.recorder.JmeterDslRecorder;
-import us.abstracta.jmeter.javadsl.cli.recorder.RecordingBrowser;
+import us.abstracta.jmeter.javadsl.recorder.JmeterDslRecorder;
+import us.abstracta.jmeter.javadsl.recorder.RecordingBrowser;
+import us.abstracta.jmeter.javadsl.recorder.correlations.CorrelationRuleBuilder;
 
 @Command(name = "recorder", header = "Record a JMeter DSL test plan using a browser",
     description = {
@@ -184,14 +184,25 @@ private static class HeadersFiltering {
   public Integer call() throws Exception {
     loadConfigFileDefaults();
     setupLogging();
-    try (JmeterDslRecorder recorder = buildRecorder();
-        RecordingBrowser browser = new RecordingBrowser(url, recorder.getProxy(),
-            browserArguments != null ? browserArguments : Collections.emptyList())) {
-      browser.awaitClosed();
+    JmeterDslRecorder recorder = buildRecorder();
+    recorder.start();
+    try {
+      try (RecordingBrowser browser = new RecordingBrowser(url, recorder.getProxy(),
+          browserArguments != null ? browserArguments : Collections.emptyList())) {
+        browser.awaitClosed();
+      }
+    } finally {
+      recorder.stop();
+      System.out.println(recorder.getRecording());
     }
     return 0;
   }
 
+  private void loadConfigFileDefaults() throws IOException {
+    new JmdslConfig(this)
+        .updateWithDefaultsFrom(JmdslConfig.fromConfigFile(configFile));
+  }
+
   private void setupLogging() {
     if (quiet) {
       Configurator.setAllLevels(LogManager.ROOT_LOGGER_NAME, Level.OFF);
@@ -212,26 +223,21 @@ private void setupLogging() {
     ctx.updateLoggers();
   }
 
-  private void loadConfigFileDefaults() throws IOException {
-    new JmdslConfig(this)
-        .updateWithDefaultsFrom(JmdslConfig.fromConfigFile(configFile));
-  }
-
   private JmeterDslRecorder buildRecorder() throws IOException {
     JmeterDslRecorder ret = new JmeterDslRecorder()
         .logsDirectory(workdir);
     if (requestsFiltering.ignoreDefaultUrlFilter) {
       ret.clearUrlFilter();
     }
     ret.urlIncludes(requestsFiltering.urlIncludes);
-    ret.urlsExcludes(requestsFiltering.urlExcludes);
+    ret.urlExcludes(requestsFiltering.urlExcludes);
     if (headersFiltering.ignoreDefaultHeaderFilter) {
       ret.clearHeaderFilter();
     }
     ret.logFilteredRequests(requestsFiltering.logFilteredRequests);
     ret.headerExcludes(headersFiltering.headerExcludes);
     correlations.forEach(ret::correlationRule);
-    return ret.start();
+    return ret;
   }
 
   public static class CorrelationRuleBuilderConverter implements

jmeter-java-dsl-cli/src/test/java/us/abstracta/jmeter/javadsl/jmx2dsl/CliCommandsIT.java

@@ -0,0 +1,62 @@
+package us.abstracta.jmeter.javadsl.jmx2dsl;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static us.abstracta.jmeter.javadsl.JmeterDsl.testResource;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.util.Arrays;
+import java.util.Collections;
+import org.apache.http.entity.ContentType;
+import org.junit.jupiter.api.Test;
+import us.abstracta.jmeter.javadsl.codegeneration.TestClassTemplate;
+import us.abstracta.jmeter.javadsl.util.TestResource;
+
+public class Jmx2DslIT {
+
+  @Test
+  public void shouldGetConvertedFileWhenConvert() throws Exception {
+    Process p = startCommand("jmx2dsl", new TestResource("test-plan.jmx").filePath());
+    assertThat(getProcessOutput(p))
+        .isEqualTo(buildConvertedTestClass());
+  }
+
+  private Process startCommand(String command, String... args) throws IOException {
+    ProcessBuilder ret = new ProcessBuilder()
+        .command("java", "-jar", "target/jmdsl.jar", command);
+    ret.command().addAll(Arrays.asList(args));
+    return ret.start();
+  }
+
+  private String getProcessOutput(Process p) throws IOException, InterruptedException {
+    String ret = inputStream2String(p.getInputStream()) + inputStream2String(p.getErrorStream());
+    p.waitFor();
+    return ret;
+  }
+
+  private String inputStream2String(InputStream inputStream) throws IOException {
+    try (BufferedReader reader =
+        new BufferedReader(new InputStreamReader(inputStream))) {
+      StringBuilder builder = new StringBuilder();
+      String line;
+      while ((line = reader.readLine()) != null) {
+        builder.append(line);
+        builder.append(System.getProperty("line.separator"));
+      }
+      return builder.toString();
+    }
+  }
+
+  private static String buildConvertedTestClass()
+      throws IOException {
+    return new TestClassTemplate()
+        .dependencies(Collections.singleton("us.abstracta.jmeter:jmeter-java-dsl:"
+            + testResource("version.txt").rawContents()))
+        .imports(Collections.singleton(ContentType.class.getName()))
+        .testPlan(new TestResource("TestPlan.java").rawContents())
+        .solve() + "\n";
+  }
+
+}