feat: optionally turn off dirty context when using static port (refs #189) (#190)

Author: tomasbjerre

wiremock-spring-boot/src/main/java/org/wiremock/spring/ConfigureWireMock.java

@@ -35,7 +35,9 @@
    *
    * <p>{@code 0} means WireMock will pick random available port.
    *
-   * <p>{@code >0} means that static port will be used.
+   * <p>{@code >0} means that static port will be used. A static port will, by default, make Spring
+   * context dirty to avoid port collisions. Automatic dirty context can be turned off with {@link
+   * #staticPortDirtySpringContext()}.
    *
    * @return WireMock server port
    */
@@ -48,6 +50,14 @@
    */
   int httpsPort() default -1;
 
+  /**
+   * If you are having performance problems, you may want to set this to false. Making context dirty
+   * is intended as a fix to avoid port collisions when using static port.
+   *
+   * @return true if a static port should make Spring context dirty.
+   */
+  boolean staticPortDirtySpringContext() default true;
+
   /**
    * The name of WireMock server.
    *

wiremock-spring-boot/src/main/java/org/wiremock/spring/internal/WireMockContextCustomizer.java

@@ -46,8 +46,9 @@ public void customizeContext(
     for (final ConfigureWireMock configureWiremock : this.configuration) {
       this.resolveOrCreateWireMockServer(context, configureWiremock);
     }
+
     WireMockPortResolver portResolver = new WireMockPortResolver(context.getEnvironment());
-    boolean isDirty = portResolver.staticPortConfigured(this.configuration);
+    boolean isDirty = portResolver.anyStaticPortWithDirtySpringContext(this.configuration);
     if (isDirty) {
       LOGGER.info("Will force dirty context because of static port");
       WireMockTestExecutionListener.markContextAsDirty();

wiremock-spring-boot/src/main/java/org/wiremock/spring/internal/WireMockPortResolver.java

@@ -59,10 +59,12 @@ int getServerHttpsPortProperty(ConfigureWireMock options) {
         .orElse(options.httpsPort());
   }
 
-  public boolean staticPortConfigured(List<ConfigureWireMock> configureWireMocks) {
+  public boolean anyStaticPortWithDirtySpringContext(List<ConfigureWireMock> configureWireMocks) {
     return configureWireMocks.stream()
         .anyMatch(
             it ->
-                this.getServerHttpPortProperty(it) > 0 || this.getServerHttpsPortProperty(it) > 0);
+                it.staticPortDirtySpringContext()
+                    && (this.getServerHttpPortProperty(it) > 0
+                        || this.getServerHttpsPortProperty(it) > 0));
   }
 }

wiremock-spring-boot/src/test/java/usecases/StaticPortNoDirtyContextTest.java

@@ -0,0 +1,22 @@
+package usecases;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.wiremock.spring.ConfigureWireMock;
+import org.wiremock.spring.EnableWireMock;
+
+@SpringBootTest
+@EnableWireMock({@ConfigureWireMock(port = 8123, staticPortDirtySpringContext = false)})
+class StaticPortNoDirtyContextTest {
+
+  @Value("${wiremock.server.port}")
+  private int wiremockHttpPort;
+
+  @Test
+  void testPort() {
+    assertThat(this.wiremockHttpPort).isEqualTo(8123);
+  }
+}