Merge branch 'main' into feature/java8-compatibility

# Conflicts:
#	src/test/java/org/wiremock/integrations/testcontainers/WireMockContainerJUnit5Test.java

Author: Julian Akkaya

README.md

@@ -39,13 +39,10 @@ P.S: Javadoc is coming soon!
 ```java
 import static org.assertj.core.api.Assertions.assertThat;
 
-import java.net.http.HttpClient;
-import java.net.http.HttpRequest;
-import java.net.http.HttpResponse;
+import java.net.http.*;
 import java.time.Duration;
 import org.junit.jupiter.api.Test;
-import org.testcontainers.junit.jupiter.Container;
-import org.testcontainers.junit.jupiter.Testcontainers;
+import org.testcontainers.junit.jupiter.*;
 
 @Testcontainers
 public class WireMockContainerJUnit5Test {
@@ -77,15 +74,16 @@ public class WireMockContainerJUnit5Test {
 
 #### Sample Code using JUnit 4
 
+<details>
+<summary>
+Show Code
+</summary>
+
 ```java
 import org.wiremock.integrations.testcontainers.WireMockContainer;
-import org.junit.Rule;
-import org.junit.Test;
-
+import org.junit.*;
 import java.net.URI;
-import java.net.http.HttpClient;
-import java.net.http.HttpRequest;
-import java.net.http.HttpResponse;
+import java.net.http.*;
 import java.time.Duration;
 
 public class WireMockContainerTest {
@@ -112,7 +110,8 @@ public class WireMockContainerTest {
     }
 }
 ```
-
+</details>    
+    
 ### Using WireMock extensions
 
 The API supports adding [WireMock extensions](https://wiremock.org/docs/extending-wiremock/)
@@ -215,7 +214,13 @@ public class WireMockContainerExtensionJUnit5Test {
 
 ##### Sample code using JUnit 4
 
+<details>
+<summary>
+Show Code
+</summary> 
+    
 ```java
+
 public class WireMockContainerExtensionTest {
     @Rule
     public WireMockContainer wiremockServer = new WireMockContainer("2.35.0")
@@ -238,7 +243,8 @@ public class WireMockContainerExtensionTest {
                 .contains("Hello, John Doe!");
     }
 }
-```
+```  
+</details>
 
 ## Contributing
 

pom.xml

@@ -23,6 +23,7 @@
     <testcontainers.version>1.18.1</testcontainers.version>
     <junit.version>5.9.3</junit.version>
     <assertj.version>3.24.2</assertj.version>
+    <awaitility.version>4.2.0</awaitility.version>
     <project.scm.id>github</project.scm.id>
   </properties>
 
@@ -88,6 +89,12 @@
       <artifactId>assertj-core</artifactId>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>org.awaitility</groupId>
+      <artifactId>awaitility</artifactId>
+      <version>${awaitility.version}</version>
+      <scope>test</scope>
+    </dependency>
     <dependency>
       <groupId>ch.qos.logback</groupId>
       <artifactId>logback-classic</artifactId>
@@ -114,7 +121,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-source-plugin</artifactId>
-        <version>3.2.1</version>
+        <version>3.3.0</version>
         <executions>
           <execution>
             <id>attach-sources</id>
@@ -142,7 +149,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-dependency-plugin</artifactId>
-        <version>3.5.0</version>
+        <version>3.6.0</version>
         <executions>
           <execution>
             <id>copy</id>

src/main/java/org/wiremock/integrations/testcontainers/WireMockContainer.java

@@ -15,6 +15,13 @@
  */
 package org.wiremock.integrations.testcontainers;
 
+import org.testcontainers.containers.GenericContainer;
+import org.testcontainers.containers.wait.strategy.Wait;
+import org.testcontainers.containers.wait.strategy.WaitStrategy;
+import org.testcontainers.images.builder.Transferable;
+import org.testcontainers.shaded.com.google.common.io.Resources;
+import org.testcontainers.utility.MountableFile;
+
 import java.io.File;
 import java.io.IOException;
 import java.net.URL;
@@ -30,13 +37,6 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
-import org.testcontainers.containers.GenericContainer;
-import org.testcontainers.containers.wait.strategy.Wait;
-import org.testcontainers.containers.wait.strategy.WaitStrategy;
-import org.testcontainers.images.builder.Transferable;
-import org.testcontainers.shaded.com.google.common.io.Resources;
-import org.testcontainers.utility.MountableFile;
-
 /**
  * Provisions WireMock standalone server as a container.
  * Designed to follow the WireMock Docker image ({@code wiremock/wiremock}) structure and configuration,
@@ -50,19 +50,16 @@ public class WireMockContainer extends GenericContainer<WireMockContainer> {
     private static final String FILES_DIR = "/home/wiremock/__files/";
 
     private static final String EXTENSIONS_DIR = "/var/wiremock/extensions/";
-
     private static final WaitStrategy DEFAULT_WAITER = Wait
             .forHttp("/__admin/mappings")
             .withMethod("GET")
             .forStatusCode(200);
-
     private static final int PORT = 8080;
-
     private final StringBuilder wireMockArgs;
-
     private final Map<String, Stub> mappingStubs = new HashMap<>();
     private final Map<String, MountableFile> mappingFiles = new HashMap<>();
     private final Map<String, Extension> extensions = new HashMap<>();
+    private boolean isBannerDisabled = true;
 
     public WireMockContainer() {
         this(DEFAULT_TAG);
@@ -78,6 +75,24 @@ public WireMockContainer(String image, String version) {
         setWaitStrategy(DEFAULT_WAITER);
     }
 
+    /**
+     * Disables the banner when starting the WireMock container.
+     * @return this instance
+     */
+    public WireMockContainer withoutBanner() {
+        isBannerDisabled = true;
+        return this;
+    }
+
+    /**
+     * Enable the banner when starting the WireMock container.
+     * @return this instance
+     */
+    public WireMockContainer withBanner() {
+        isBannerDisabled = false;
+        return this;
+    }
+    
     /**
      * Adds CLI argument to the WireMock call.
      * @param arg Argument
@@ -223,6 +238,10 @@ protected void configure() {
             wireMockArgs.append(String.join(",", extensionClassNames));
         }
 
+        if (isBannerDisabled) {
+            this.withCliArg("--disable-banner");
+        }
+
         // Add CLI arguments
         withCommand(wireMockArgs.toString());
     }
@@ -231,7 +250,7 @@ private static final class Stub {
         final String name;
         final String json;
 
-        public Stub (String name, String json) {
+        public Stub(String name, String json) {
             this.name = name;
             this.json = json;
         }
@@ -246,5 +265,4 @@ public Extension(String id) {
             this.id = id;
         }
     }
-
 }

src/test/java/org/wiremock/integrations/testcontainers/WireMockContainerExtensionTest.java

@@ -21,6 +21,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.testcontainers.containers.output.Slf4jLogConsumer;
+import org.wiremock.integrations.testcontainers.testsupport.http.HttpResponse;
 import org.wiremock.integrations.testcontainers.testsupport.http.TestHttpClient;
 
 import java.nio.file.Paths;
@@ -57,10 +58,10 @@ public void testJSONBodyTransformer() throws Exception {
         String body = "{\"name\":\"John Doe\"}";
 
         // when
-        String response = new TestHttpClient().post(url, body);
+        HttpResponse response = new TestHttpClient().post(url, body);
 
         // then
-        assertThat(response)
+        assertThat(response.getBody())
                 .as("Wrong response body")
                 .contains("Hello, John Doe!");
     }

src/test/java/org/wiremock/integrations/testcontainers/WireMockContainerExtensionsCombinationTest.java

@@ -21,6 +21,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.testcontainers.containers.output.Slf4jLogConsumer;
+import org.wiremock.integrations.testcontainers.testsupport.http.HttpResponse;
 import org.wiremock.integrations.testcontainers.testsupport.http.TestHttpClient;
 
 import java.nio.file.Paths;
@@ -56,20 +57,17 @@ public void before() {
     public void testJSONBodyTransformer() throws Exception {
 
         LOGGER.warn("Waiting for WireMock to start");
-        TimeUnit.SECONDS.sleep(20);
-
 
         // given
         String url = wiremockServer.getUrl("/json-body-transformer");
         String body = "{\"name\":\"John Doe\"}";
 
         // when
-        String response = new TestHttpClient().post(url, body);
+        HttpResponse response = new TestHttpClient().post(url, body);
 
         // then
-        assertThat(response)
+        assertThat(response.getBody())
                 .as("Wrong response body")
                 .contains("Hello, John Doe!");
     }
-
 }

src/test/java/org/wiremock/integrations/testcontainers/WireMockContainerExtensionsWebhookTest.java

@@ -0,0 +1,98 @@
+/*
+ * Copyright (C) 2023 WireMock Inc, Oleg Nenashev and all project contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.wiremock.integrations.testcontainers;
+
+import org.junit.Rule;
+import org.junit.Test;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.testcontainers.Testcontainers;
+import org.testcontainers.containers.GenericContainer;
+import org.testcontainers.containers.output.Slf4jLogConsumer;
+import org.wiremock.integrations.testcontainers.testsupport.http.HttpResponse;
+import org.wiremock.integrations.testcontainers.testsupport.http.TestHttpClient;
+import org.wiremock.integrations.testcontainers.testsupport.http.TestHttpServer;
+
+import java.nio.file.Paths;
+import java.time.Duration;
+import java.util.Collections;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.testcontainers.shaded.org.awaitility.Awaitility.await;
+
+/**
+ * Tests the WireMock Webhook extension and TestContainers Networking
+ * For this type of tests we should use following steps:
+ * <p>
+ * Use {@link GenericContainer#withAccessToHost(boolean)} to force the host access mechanism
+ * <p>
+ * Use {@link Testcontainers#exposeHostPorts(int...)} to expose host machine ports to containers
+ * <p>
+ * Use {@link GenericContainer#INTERNAL_HOST_HOSTNAME} to calculate hostname for callback
+ *
+ * @see <a href="https://www.testcontainers.org/features/networking/">Testcontainers Networking</a>
+ */
+public class WireMockContainerExtensionsWebhookTest {
+
+    public static final Logger LOGGER = LoggerFactory.getLogger(WireMockContainerExtensionsWebhookTest.class);
+    public static final String WIREMOCK_PATH = "/wiremock/callback-trigger";
+    public static final String APPLICATION_PATH = "/application/callback-receiver";
+
+
+    public TestHttpServer applicationServer = TestHttpServer.newInstance();
+    @Rule
+    public WireMockContainer wiremockServer = new WireMockContainer("2.35.0")
+            .withLogConsumer(new Slf4jLogConsumer(LOGGER))
+            .withCliArg("--global-response-templating")
+            .withMapping("webhook-callback-template", WireMockContainerExtensionsWebhookTest.class, "webhook-callback-template.json")
+            .withExtension("Webhook",
+                    Collections.singleton("org.wiremock.webhooks.Webhooks"),
+                    Collections.singleton(Paths.get("target", "test-wiremock-extension", "wiremock-webhooks-extension-2.35.0.jar").toFile()))
+            .withAccessToHost(true); // Force the host access mechanism
+
+
+    @Test
+    public void callbackUsingJsonStub() throws Exception {
+        // given
+        Testcontainers.exposeHostPorts(applicationServer.getPort()); // Exposing host ports to the container
+
+        String wiremockUrl = wiremockServer.getUrl(WIREMOCK_PATH);
+        String applicationCallbackUrl = String.format("http://%s:%d%s", GenericContainer.INTERNAL_HOST_HOSTNAME, applicationServer.getPort(), APPLICATION_PATH);
+
+        // when
+        HttpResponse response = new TestHttpClient().post(
+                wiremockUrl,
+                "{\"callbackMethod\": \"PUT\", \"callbackUrl\": \"" + applicationCallbackUrl + "\"}"
+        );
+
+        // then
+        assertThat(response).as("Wiremock Response").isNotNull().satisfies(it -> {
+            assertThat(it.getStatusCode()).as("Wiremock Response Status").isEqualTo(200);
+            assertThat(it.getBody()).as("Wiremock Response Body")
+                    .contains("Please wait callback")
+                    .contains("PUT")
+                    .contains(applicationCallbackUrl);
+        });
+
+        await().atMost(Duration.ofMillis(10000)).untilAsserted(() -> {
+            assertThat(applicationServer.getRecordedRequests()).as("Received Callback")
+                    .hasSize(1)
+                    .first().usingRecursiveComparison()
+                    .isEqualTo(new TestHttpServer.RecordedRequest("PUT", APPLICATION_PATH, "Async processing Finished"));
+        });
+    }
+
+}

src/test/java/org/wiremock/integrations/testcontainers/WireMockContainerJUnit5Test.java

@@ -5,6 +5,7 @@
 import org.junit.jupiter.params.provider.ValueSource;
 import org.testcontainers.junit.jupiter.Container;
 import org.testcontainers.junit.jupiter.Testcontainers;
+import org.wiremock.integrations.testcontainers.testsupport.http.HttpResponse;
 import org.wiremock.integrations.testcontainers.testsupport.http.TestHttpClient;
 
 import static org.assertj.core.api.Assertions.assertThat;
@@ -30,10 +31,10 @@ public void helloWorld(String path) throws Exception {
         String url = wiremockServer.getUrl(path);
 
         // when
-        String response = new TestHttpClient().get(url);
+        HttpResponse response = new TestHttpClient().get(url);
 
         // then
-        assertThat(response)
+        assertThat(response.getBody())
                 .as("Wrong response body")
                 .contains("Hello, world!");
     }
@@ -44,10 +45,10 @@ public void helloWorldFromFile() throws Exception {
         String url = wiremockServer.getUrl("/hello-from-file");
 
         // when
-        String response = new TestHttpClient().get(url);
+        HttpResponse response = new TestHttpClient().get(url);
 
         // then
-        assertThat(response)
+        assertThat(response.getBody())
                 .as("Wrong response body")
                 .contains("Hello, world!");
     }