Extract Common Logic for WireMock Test Setup to Share Across Test Cases

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>

Author: Weltraumschaf

src/test/java/io/securecodebox/persistence/defectdojo/HttpClientTest.java src/test/java/io/securecodebox/persistence/defectdojo/service/HttpClientExampleTest.java

@@ -1,12 +1,14 @@
-package io.securecodebox.persistence.defectdojo;
+package io.securecodebox.persistence.defectdojo.service;
 
+import com.fasterxml.jackson.core.JsonProcessingException;
 import com.github.tomakehurst.wiremock.junit5.WireMockRuntimeInfo;
-import com.github.tomakehurst.wiremock.junit5.WireMockTest;
+import io.securecodebox.persistence.defectdojo.config.Config;
 import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 
 import java.io.IOException;
 import java.net.URI;
+import java.net.URISyntaxException;
 import java.net.http.HttpClient;
 import java.net.http.HttpRequest;
 import java.net.http.HttpResponse;
@@ -22,18 +24,15 @@
  * See https://wiremock.org/docs/quickstart/java-junit/
  * and https://wiremock.org/docs/junit-jupiter/
  */
-@WireMockTest(httpPort = HttpClientTest.PORT)
-final class HttpClientTest {
-
-  public static final int PORT = 8888;
+final class HttpClientExampleTest extends WireMockBaseTestCase {
 
   private URI createUri(String path) {
     return URI.create("http://localhost:%d/%s".formatted(PORT, path));
   }
 
   @Test
   @Disabled
-  void test_something_with_wiremock(WireMockRuntimeInfo wmRuntimeInfo) throws IOException, InterruptedException {
+  void somethingWithWreMock(WireMockRuntimeInfo wmRuntimeInfo) throws IOException, InterruptedException {
     stubFor(get("/my/resource")
       .withHeader("Content-Type", containing("xml"))
       .willReturn(ok()

src/test/java/io/securecodebox/persistence/defectdojo/service/ProductTypeServiceTest.java

@@ -1,14 +1,10 @@
 package io.securecodebox.persistence.defectdojo.service;
 
-import com.github.tomakehurst.wiremock.junit5.WireMockTest;
-import io.securecodebox.persistence.defectdojo.config.Config;
 import io.securecodebox.persistence.defectdojo.model.ProductType;
 import org.junit.jupiter.api.Test;
 
 import java.io.IOException;
 import java.net.URISyntaxException;
-import java.nio.charset.StandardCharsets;
-import java.util.Objects;
 
 import static com.github.tomakehurst.wiremock.client.WireMock.*;
 import static org.hamcrest.MatcherAssert.assertThat;
@@ -19,20 +15,8 @@
 /**
  * Tests for {@link ProductTypeService}
  */
-@WireMockTest(httpPort = ProductTypeServiceTest.PORT)
-class ProductTypeServiceTest {
-  public static final int PORT = 8888;
-  private final Config conf = new Config(
-    String.format("http://localhost:%d/", PORT),
-    "not-required-for-tests");
-  private final ProductTypeService sut = new ProductTypeService(conf);
-
-  private String readResponseBodyFromFixture(String name) throws IOException {
-    try (final var input = getClass().getClassLoader().getResourceAsStream(name)) {
-      final var bytes = Objects.requireNonNull(input).readAllBytes();
-      return new String(bytes, StandardCharsets.UTF_8);
-    }
-  }
+final class ProductTypeServiceTest extends WireMockBaseTestCase {
+  private final ProductTypeService sut = new ProductTypeService(conf());
 
   @Test
   void search() throws URISyntaxException, IOException {

src/test/java/io/securecodebox/persistence/defectdojo/service/WireMockBaseTestCase.java

@@ -0,0 +1,31 @@
+package io.securecodebox.persistence.defectdojo.service;
+
+import com.github.tomakehurst.wiremock.junit5.WireMockTest;
+import io.securecodebox.persistence.defectdojo.config.Config;
+import lombok.Getter;
+import lombok.experimental.Accessors;
+
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+import java.util.Objects;
+
+/**
+ * Base test class for WireMock test setups
+ */
+@Getter
+@Accessors(fluent = true)
+@WireMockTest(httpPort = WireMockBaseTestCase.PORT)
+abstract class WireMockBaseTestCase {
+  static final int PORT = 8888;
+
+  private final Config conf = new Config(
+    String.format("http://localhost:%d/", PORT),
+    "not-required-for-tests");
+
+  String readResponseBodyFromFixture(String fixtureFilePath) throws IOException {
+    try (final var input = getClass().getClassLoader().getResourceAsStream(fixtureFilePath)) {
+      final var bytes = Objects.requireNonNull(input).readAllBytes();
+      return new String(bytes, StandardCharsets.UTF_8);
+    }
+  }
+}