Name changes to builder interface

cardil · cardil · commit da48dc1a2f91 · 2016-03-06T01:04:50.000+01:00
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ Gasper is a very simple integration testing JUnit harness for `java -jar` server
 
 [![WildFly Swarm](https://avatars3.githubusercontent.com/u/11523816?v=3&s=100)](http://wildfly-swarm.io/) [![Spring Boot](https://avatars2.githubusercontent.com/u/317776?v=3&s=100)](http://projects.spring.io/spring-boot/)
 
-Gasper provides a simple to use JUnit `TestRule` that can be used to build integration tests with simple apps, like microservices. You can configure Gasper with easy to use builder interface.
+Gasper provides a simple to use JUnit `TestRule` that can be used to build integration tests with simple apps, like micro-services. You can configure Gasper with easy to use builder interface.
 
 ## Usage
 
@@ -48,22 +48,31 @@ public void testGetRoot() throws UnirestException {
 }
 ```
 
-### Addtional configuration
+### Additional configuration
 
 To configure Gasper use `GasperBuilder` interface, for ex.:
 
 ```java
+private final int port = 11909;
+private final String webContext = "/test";
+private final String systemPropertyForPort = "swarm.http.port";
 @ClassRule
-public static Gasper gasper = Gasper.configurations()
-  .wildflySwarm()
-  .usePomFile(Paths.get("target", "it", "wildfly-swarm-tester", "pom.xml"))
-  .inheritIO()
-  .maxStartupTime(120)
-  .maxDeploymentTime(20)
-  .useContextChecker(MyTestClass::contextChecker)
-  .withEnvironmentVariable("jdbc.password", DEV_PASSWORD)
-  .withJavaOption("my.minus-d.option", "true")
-  .silent()
+public static Gasper gasper = Gasper.builder()
+  .silentGasperMessages()
+  .usingSystemPropertyForPort(systemPropertyForPort)
+  .withSystemProperty("swarm.context.path", webContext)
+  .withSystemProperty(systemPropertyForPort, String.valueOf(port))
+  .withJVMOptions("-server", "-Xms1G", "-Xmx1G", "-XX:+UseConcMarkSweepGC")
+  .withMaxStartupTime(100)
+  .withMaxDeploymentTime(20)
+  .withEnvironmentVariable("jdbc.password", "S3CreT!1")
+  .withServerLoggingOnConsole()
+  .usingPomFile(Paths.get("pom.xml"))
+  .withArtifactPackaging("jar")
+  .waitForWebContext(webContext)
+  .withArtifactClassifier("swarm")
+  .usingWebContextChecker(GasperBuilderTest::checkContext)
+  .withPort(port)
   .build();
 ```
 
diff --git a/src/main/java/pl/wavesoftware/gasper/Gasper.java b/src/main/java/pl/wavesoftware/gasper/Gasper.java
@@ -122,7 +122,8 @@ private List<String> buildCommand() {
     }
 
     private void buildJavaOptions(List<String> command) {
-        command.addAll(settings.getJavaOptions().entrySet().stream()
+        command.addAll(settings.getJvmOptions());
+        command.addAll(settings.getSystemProperties().entrySet().stream()
             .map(entry -> format("-D%s=%s", entry.getKey(), entry.getValue()))
             .collect(Collectors.toList())
         );
diff --git a/src/main/java/pl/wavesoftware/gasper/GasperBuilder.java b/src/main/java/pl/wavesoftware/gasper/GasperBuilder.java
@@ -1,6 +1,5 @@
 package pl.wavesoftware.gasper;
 
-import com.google.common.collect.ImmutableMap;
 import org.slf4j.event.Level;
 import pl.wavesoftware.eid.utils.EidPreconditions;
 import pl.wavesoftware.gasper.internal.Executor;
@@ -11,7 +10,10 @@
 import java.net.ServerSocket;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.ArrayList;
+import java.util.Collections;
 import java.util.LinkedHashMap;
+import java.util.List;
 import java.util.Map;
 import java.util.function.Function;
 
@@ -25,9 +27,10 @@ public final class GasperBuilder extends Gasper.RunnerCreator {
 
     private String packaging = MavenResolver.DEFAULT_PACKAGING;
     private String classifier = "";
-    private Map<String, String> javaOptions = new LinkedHashMap<>();
+    private Map<String, String> systemProperties = new LinkedHashMap<>();
+    private List<String> jvmOptions = new ArrayList<>();
     private Map<String, String> environment = new LinkedHashMap<>();
-    private String portJavaOption;
+    private String systemPropertyForPort;
     private Integer port;
     private boolean inheritIO = false;
     private String context = Gasper.DEFAULT_CONTEXT;
@@ -39,12 +42,12 @@ public final class GasperBuilder extends Gasper.RunnerCreator {
 
     protected GasperBuilder() {}
 
-    public GasperBuilder withPackaging(String packaging) {
+    public GasperBuilder withArtifactPackaging(String packaging) {
         this.packaging = packaging;
         return this;
     }
 
-    public GasperBuilder withClassifier(String classifier) {
+    public GasperBuilder withArtifactClassifier(String classifier) {
         this.classifier = classifier;
         return this;
     }
@@ -54,8 +57,13 @@ public GasperBuilder withEnvironmentVariable(String key, String value) {
         return this;
     }
 
-    public GasperBuilder withJavaOption(String key, String value) {
-        javaOptions.put(key, value);
+    public GasperBuilder withSystemProperty(String key, String value) {
+        systemProperties.put(key, value);
+        return this;
+    }
+
+    public GasperBuilder withJVMOptions(String... options) {
+        Collections.addAll(jvmOptions, options);
         return this;
     }
 
@@ -64,72 +72,72 @@ public GasperBuilder withPort(int port) {
         return this;
     }
 
-    public GasperBuilder usePortJavaOptionFor(String portJavaOption) {
-        this.portJavaOption = portJavaOption;
+    public GasperBuilder usingSystemPropertyForPort(String systemPropertyForPort) {
+        this.systemPropertyForPort = systemPropertyForPort;
         return this;
     }
 
-    public GasperBuilder usePomFile(Path pomfile) {
+    public GasperBuilder usingPomFile(Path pomfile) {
         this.pomfile = pomfile;
         return this;
     }
 
-    public GasperBuilder inheritIO() {
-        return inheritIO(true);
+    public GasperBuilder withServerLoggingOnConsole() {
+        return withServerLoggingOnConsole(true);
     }
 
-    public GasperBuilder inheritIO(boolean inheritIO) {
+    public GasperBuilder withServerLoggingOnConsole(boolean inheritIO) {
         this.inheritIO = inheritIO;
         return this;
     }
 
-    public Gasper build() {
-        if (port == null) {
-            port = findNotBindedPort();
-        }
-        if (portJavaOption != null) {
-            withJavaOption(portJavaOption, port.toString());
-        }
-        Settings settings = new Settings(
-            packaging, classifier, port,
-            ImmutableMap.copyOf(javaOptions), ImmutableMap.copyOf(environment),
-            inheritIO, context, contextChecker,
-            portAvailableMaxTime, deploymentMaxTime,
-            pomfile, level
-        );
-        return create(settings);
-    }
-
-    public GasperBuilder maxStartupTime(int seconds) {
+    public GasperBuilder withMaxStartupTime(int seconds) {
         this.portAvailableMaxTime = seconds;
         return this;
     }
 
-    public GasperBuilder maxDeploymentTime(int seconds) {
+    public GasperBuilder withMaxDeploymentTime(int seconds) {
         this.deploymentMaxTime = seconds;
         return this;
     }
 
-    public GasperBuilder waitForContext(String context) {
+    public GasperBuilder waitForWebContext(String context) {
         this.context = context;
         return this;
     }
 
-    public GasperBuilder useContextChecker(Function<HttpEndpoint, Boolean> contextChecker) {
+    public GasperBuilder usingWebContextChecker(Function<HttpEndpoint, Boolean> contextChecker) {
         this.contextChecker = contextChecker;
         return this;
     }
 
-    public GasperBuilder silent() {
-        useLogLevel(Level.WARN);
+    public GasperBuilder silentGasperMessages() {
+        usingLogLevel(Level.WARN);
         return this;
     }
 
-    public GasperBuilder useLogLevel(Level level) {
+    public GasperBuilder usingLogLevel(Level level) {
         this.level = level;
         return this;
     }
 
+    public Gasper build() {
+        if (port == null) {
+            port = findNotBindedPort();
+        }
+        if (systemPropertyForPort != null) {
+            withSystemProperty(systemPropertyForPort, port.toString());
+        }
+        Settings settings = new Settings(
+            packaging, classifier, port,
+            systemProperties, jvmOptions, environment,
+            inheritIO, context, contextChecker,
+            portAvailableMaxTime, deploymentMaxTime,
+            pomfile, level
+        );
+        return create(settings);
+    }
+
     private static Integer findNotBindedPort() {
         return tryToExecute((EidPreconditions.UnsafeSupplier<Integer>) () -> {
             try (ServerSocket socket = new ServerSocket(0)) {
diff --git a/src/main/java/pl/wavesoftware/gasper/GasperConfigurations.java b/src/main/java/pl/wavesoftware/gasper/GasperConfigurations.java
@@ -27,27 +27,27 @@ protected GasperConfigurations() {}
      * <p>
      * You can use it directly or use {@link GasperBuilder} interface to re-configure it to you needs.
      * <p>
-     * To use it in JUnit execute method {@link GasperBuilder#create()}
+     * To use it in JUnit execute method {@link GasperBuilder#build()}
      * @return pre-configured {@link GasperBuilder} to use with WildFly Swarm.
      */
     public GasperBuilder wildflySwarm() {
         return Gasper.builder()
-            .withPackaging("jar")
-            .withClassifier("swarm")
-            .usePortJavaOptionFor(GasperConfigurations.WILDFLY_SWARM);
+            .withArtifactPackaging("jar")
+            .withArtifactClassifier("swarm")
+            .usingSystemPropertyForPort(GasperConfigurations.WILDFLY_SWARM);
     }
 
     /**
      * This method returns pre-configured Gasper builder to use with Spring Boot.
      * <p>
      * You can use it directly or use {@link GasperBuilder} interface to re-configure it to you needs.
      * <p>
-     * To use it in JUnit execute method {@link GasperBuilder#create()}
+     * To use it in JUnit execute method {@link GasperBuilder#build()}
      * @return pre-configured {@link GasperBuilder} to use with Spring Boot.
      */
     public GasperBuilder springBoot() {
         return Gasper.builder()
-            .withPackaging("jar")
-            .usePortJavaOptionFor(GasperConfigurations.SPRING_BOOT);
+            .withArtifactPackaging("jar")
+            .usingSystemPropertyForPort(GasperConfigurations.SPRING_BOOT);
     }
 }
diff --git a/src/main/java/pl/wavesoftware/gasper/internal/Executor.java b/src/main/java/pl/wavesoftware/gasper/internal/Executor.java
@@ -148,6 +148,7 @@ private static boolean isPortTaken(int port) {
         try (ServerSocket ignored = new ServerSocket(port)) {
             return false;
         } catch (IOException ex) {
+            log.trace(format("Port %d taken", port), ex);
             return true;
         }
     }
diff --git a/src/main/java/pl/wavesoftware/gasper/internal/HttpEndpoint.java b/src/main/java/pl/wavesoftware/gasper/internal/HttpEndpoint.java
@@ -25,7 +25,7 @@ public class HttpEndpoint {
     private final String query;
 
     public String fullAddress() {
-        String address = format("%s://%s:%d%s",
+        String address = format("%s://%s:%s%s",
             getScheme(),
             getDomain(),
             getPort(),
diff --git a/src/main/java/pl/wavesoftware/gasper/internal/Settings.java b/src/main/java/pl/wavesoftware/gasper/internal/Settings.java
@@ -1,14 +1,14 @@
 package pl.wavesoftware.gasper.internal;
 
+import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableMap;
-import lombok.AccessLevel;
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
-import lombok.Setter;
 import org.slf4j.event.Level;
 import pl.wavesoftware.gasper.Gasper;
 
 import java.nio.file.Path;
+import java.util.List;
 import java.util.Map;
 import java.util.function.Function;
 
@@ -23,13 +23,13 @@
  * @see Gasper#configurations()
  */
 @Getter
-@Setter
 @RequiredArgsConstructor
 public class Settings {
     private final String packaging;
     private final String classifier;
     private final int port;
-    private final Map<String, String> javaOptions;
+    private final Map<String, String> systemProperties;
+    private final List<String> jvmOptions;
     private final Map<String, String> environment;
     private final boolean inheritIO;
     private final String context;
@@ -38,19 +38,26 @@ public class Settings {
     private final int deploymentMaxTime;
     private final Path pomfile;
     private final Level level;
-    @Setter(AccessLevel.NONE)
     private HttpEndpoint endpoint;
 
     /**
-     * Gets Java options as map
+     * Retrieves Java <code>-D</code> style options as map
      * @return a map for Java options
      */
-    public Map<String, String> getJavaOptions() {
-        return ImmutableMap.copyOf(javaOptions);
+    public Map<String, String> getSystemProperties() {
+        return ImmutableMap.copyOf(systemProperties);
     }
 
     /**
-     * Gets environment variables as a map
+     * Retrieves Java VM options as list
+     * @return a map for Java options
+     */
+    public List<String> getJvmOptions() {
+        return ImmutableList.copyOf(jvmOptions);
+    }
+
+    /**
+     * Retrieves environment variables as a map
      * @return a map for environment variables
      */
     public Map<String, String> getEnvironment() {
diff --git a/src/test/java/pl/wavesoftware/gasper/GasperBuilderTest.java b/src/test/java/pl/wavesoftware/gasper/GasperBuilderTest.java
@@ -19,18 +19,24 @@ public class GasperBuilderTest {
     @Test
     public void testBuild() throws Exception {
         GasperBuilder builder = new GasperBuilder();
-        Gasper gasper = builder.withJavaOption("swarm.context.path", "/sub")
-            .maxStartupTime(100)
-            .maxDeploymentTime(20)
+        int port = 11909;
+        String webContext = "/test";
+        String systemPropertyForPort = "swarm.http.port";
+        Gasper gasper = builder.silentGasperMessages()
+            .usingSystemPropertyForPort(systemPropertyForPort)
+            .withSystemProperty("swarm.context.path", webContext)
+            .withSystemProperty(systemPropertyForPort, String.valueOf(port))
+            .withJVMOptions("-server", "-Xms1G", "-Xmx1G", "-XX:+UseConcMarkSweepGC")
+            .withMaxStartupTime(100)
+            .withMaxDeploymentTime(20)
             .withEnvironmentVariable("jdbc.password", "S3CreT!1")
-            .inheritIO()
-            .silent()
-            .usePomFile(Paths.get("pom.xml"))
-            .withPackaging("jar")
-            .waitForContext("/sub")
-            .withClassifier("swarm")
-            .useContextChecker(GasperBuilderTest::checkContext)
-            .withPort(11909)
+            .withServerLoggingOnConsole()
+            .usingPomFile(Paths.get("pom.xml"))
+            .withArtifactPackaging("jar")
+            .waitForWebContext(webContext)
+            .withArtifactClassifier("swarm")
+            .usingWebContextChecker(GasperBuilderTest::checkContext)
+            .withPort(port)
             .build();
 
         assertThat(gasper).isNotNull();
diff --git a/src/test/java/pl/wavesoftware/gasper/GasperForSpringBootIT.java b/src/test/java/pl/wavesoftware/gasper/GasperForSpringBootIT.java
@@ -26,7 +26,7 @@ public class GasperForSpringBootIT {
     @ClassRule
     public static Gasper gasper = Gasper.configurations()
         .springBoot()
-        .usePomFile(SPRING_BOOT_POMFILE)
+        .usingPomFile(SPRING_BOOT_POMFILE)
         .build();
 
     @Test
diff --git a/src/test/java/pl/wavesoftware/gasper/GasperForWildflySwarmIT.java b/src/test/java/pl/wavesoftware/gasper/GasperForWildflySwarmIT.java
@@ -24,8 +24,8 @@ public class GasperForWildflySwarmIT {
     @ClassRule
     public static Gasper gasper = Gasper.configurations()
         .wildflySwarm()
-        .usePomFile(WILDFLY_SWARM_POMFILE)
-        .silent()
+        .usingPomFile(WILDFLY_SWARM_POMFILE)
+        .silentGasperMessages()
         .build();
 
     @Test

Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,8 @@ private List<String> buildCommand() {`
`122`	`122`	`}`
`123`	`123`
`124`	`124`	`private void buildJavaOptions(List<String> command) {`
`125`		`- command.addAll(settings.getJavaOptions().entrySet().stream()`
	`125`	`+ command.addAll(settings.getJvmOptions());`
	`126`	`+ command.addAll(settings.getSystemProperties().entrySet().stream()`
`126`	`127`	`.map(entry -> format("-D%s=%s", entry.getKey(), entry.getValue()))`
`127`	`128`	`.collect(Collectors.toList())`
`128`	`129`	`);`
Original file line number	Diff line number	Diff line change
`@@ -148,6 +148,7 @@ private static boolean isPortTaken(int port) {`
`148`	`148`	`try (ServerSocket ignored = new ServerSocket(port)) {`
`149`	`149`	`return false;`
`150`	`150`	`} catch (IOException ex) {`
	`151`	`+ log.trace(format("Port %d taken", port), ex);`
`151`	`152`	`return true;`
`152`	`153`	`}`
`153`	`154`	`}`