Merge pull request #8 from helpdeveloper/gz-wire-mock-sample

feat: implemented protocol (sample with new rest client module)

Author: gbzarelli

acceptance-test/pom.xml

@@ -17,10 +17,11 @@
         <mutation.skip>true</mutation.skip>
         <maven-resources-plugin.version>3.1.0</maven-resources-plugin.version>
         <maven-failsafe-plugin.version>2.22.0</maven-failsafe-plugin.version>
-        <mysql-connector-java.version>8.0.23</mysql-connector-java.version>
+        <mysql-connector-java.version>8.0.25</mysql-connector-java.version>
         <docker-maven-plugin.version>0.35.0</docker-maven-plugin.version>
         <run-java-sh.version>1.2.2</run-java-sh.version>
         <mutation.skip>true</mutation.skip>
+        <wiremock-jre8.version>2.27.2</wiremock-jre8.version>
     </properties>
 
     <dependencies>
@@ -92,6 +93,12 @@
             <artifactId>javafaker</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>com.github.tomakehurst</groupId>
+            <artifactId>wiremock-jre8</artifactId>
+            <version>${wiremock-jre8.version}</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
 

acceptance-test/src/test/java/br/com/helpdev/atdd/AbstractContainerBaseTest.java

@@ -0,0 +1,90 @@
+package br.com.helpdev.atdd;
+
+import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;
+
+import com.github.tomakehurst.wiremock.WireMockServer;
+import io.restassured.RestAssured;
+import org.junit.jupiter.api.AfterEach;
+import org.slf4j.LoggerFactory;
+import org.testcontainers.Testcontainers;
+import org.testcontainers.containers.GenericContainer;
+import org.testcontainers.containers.MySQLContainer;
+import org.testcontainers.containers.Network;
+import org.testcontainers.containers.output.Slf4jLogConsumer;
+import org.testcontainers.containers.wait.strategy.Wait;
+import org.testcontainers.lifecycle.Startable;
+import org.testcontainers.utility.MountableFile;
+
+abstract class DefaultContainerStarterTest {
+
+  private static final GenericContainer<?> APP;
+  private static final GenericContainer<?> FLYWAY;
+  private static final GenericContainer<?> MYSQL_CONTAINER;
+  private static final Network NETWORK = Network.newNetwork();
+  protected static final WireMockServer MOCK_SERVER;
+
+  /* Containers are initialized in static block to create only once in test execution  */
+  static {
+    MOCK_SERVER = new WireMockServer(wireMockConfig().dynamicPort());
+    MOCK_SERVER.start();
+    exposeHostMachinePortToContainersForApiIntegrations();
+
+    MYSQL_CONTAINER = buildMySqlContainer();
+    MYSQL_CONTAINER.start();
+
+    FLYWAY = buildFlywayContainer(MYSQL_CONTAINER);
+    FLYWAY.start();
+
+    APP = buildAppContainer(MYSQL_CONTAINER, FLYWAY);
+    APP.start();
+
+    initRestAssured();
+  }
+
+  private static GenericContainer<?> buildMySqlContainer() {
+    return new MySQLContainer<>("mysql:5.7.22")
+        .withNetwork(NETWORK)
+        .withNetworkAliases("testdb");
+  }
+
+  private static GenericContainer<?> buildFlywayContainer(final Startable... dependsOn) {
+    return new GenericContainer<>("flyway/flyway")
+        .dependsOn(dependsOn)
+        .withNetwork(NETWORK)
+        .withCopyFileToContainer(MountableFile.forHostPath("../resources/flyway/db"), "/flyway/sql")
+        .withCommand("-url=jdbc:mysql://testdb?useSSL=false -schemas=test -user=test -password=test -connectRetries=60 migrate")
+        .waitingFor(Wait.forLogMessage("(?s).*No migration necessary(?s).*|(?s).*Successfully applied(?s).*", 1))
+        .withLogConsumer(new Slf4jLogConsumer(LoggerFactory.getLogger("FLYWAY")));
+  }
+
+  private static GenericContainer<?> buildAppContainer(final Startable... dependsOn) {
+    return new GenericContainer<>("app-test:integration")
+        .dependsOn(dependsOn)
+        .withNetwork(NETWORK)
+        .withEnv("RANDOM_DATA_API_URL", "http://host.testcontainers.internal:" + MOCK_SERVER.port())
+        .withEnv("MYSQL_USER", "test")
+        .withEnv("MYSQL_PASSWORD", "test")
+        .withEnv("MYSQL_URL", "jdbc:mysql://testdb:" + MySQLContainer.MYSQL_PORT + "/test?autoReconnect=true&useSSL=false")
+        .withExposedPorts(8080)
+        .waitingFor(Wait.forHttp("/health/ready").forStatusCode(200))
+        .withLogConsumer(new Slf4jLogConsumer(LoggerFactory.getLogger("APP_CONTAINER")));
+  }
+
+
+  private static void initRestAssured() {
+    RestAssured.baseURI = "http://" + APP.getHost();
+    RestAssured.port = APP.getFirstMappedPort();
+    RestAssured.enableLoggingOfRequestAndResponseIfValidationFails();
+  }
+
+  private static void exposeHostMachinePortToContainersForApiIntegrations() {
+    Testcontainers.exposeHostPorts(MOCK_SERVER.port());
+  }
+
+  @AfterEach
+  void tearDown() {
+    MOCK_SERVER.resetAll();
+    /* add here others resets needed after each test */
+  }
+
+}

acceptance-test/src/test/java/br/com/helpdev/atdd/DefaultContainerStarterTest.java

@@ -1,6 +1,8 @@
 package br.com.helpdev.atdd;
 
+import static br.com.helpdev.atdd.mock.RandomDataApiMock.mockRandomIdNumber;
 import static io.restassured.RestAssured.given;
+import static io.restassured.module.jsv.JsonSchemaValidator.matchesJsonSchemaInClasspath;
 import static org.hamcrest.CoreMatchers.equalTo;
 import static org.hamcrest.CoreMatchers.notNullValue;
 
@@ -11,10 +13,12 @@
 import java.time.ZonedDateTime;
 import org.junit.jupiter.api.Test;
 
-class ApplicationIT extends AbstractContainerBaseTest {
+class MessageV1EndpointIT extends DefaultContainerStarterTest {
 
   @Test
   void whenCreateNewScheduleThenReturn() {
+    mockRandomIdNumber(MOCK_SERVER);
+
     var now = ZonedDateTime.now();
     Integer id = given()
         .contentType(ContentType.JSON)
@@ -36,14 +40,16 @@ void whenCreateNewScheduleThenReturn() {
         .get("/v1/message/{id}", id)
         .then()
         .statusCode(200)
+        .body("protocol", equalTo("000-22-1110"))
         .body("scheduleDate", notNullValue())
         .body("body", equalTo("Hello"))
         .body("channel", equalTo("WHATSAPP"))
         .body("recipient.name", equalTo("John James"))
         .body("recipient.phoneId", equalTo("123"))
         .body("recipient.email", equalTo("[email protected]"))
         .body("recipient.phoneNumber", equalTo("89898989"))
-        .body("chats[0].status", equalTo("WAITING"));
+        .body("chats[0].status", equalTo("WAITING"))
+        .body(matchesJsonSchemaInClasspath("jsons/v1/postMessage.json"));
   }
 
   @Test
@@ -59,6 +65,8 @@ void whenGetWithInvalidIdThenReturnError() {
 
   @Test
   void whenDeleteMessageThenRemove() {
+    mockRandomIdNumber(MOCK_SERVER);
+
     var now = ZonedDateTime.now();
     Integer id = given()
         .contentType(ContentType.JSON)
@@ -93,6 +101,8 @@ void whenDeleteWithInvalidIdThenReturnError() {
 
   @Test
   void whenCreateNewEmailScheduleThenReturn() {
+    mockRandomIdNumber(MOCK_SERVER);
+
     given()
         .contentType(ContentType.JSON)
         .body(buildMessage(ZonedDateTime.now(), CommunicationChannelDto.EMAIL))
@@ -108,6 +118,8 @@ void whenCreateNewEmailScheduleThenReturn() {
 
   @Test
   void whenCreateNewPushScheduleThenReturn() {
+    mockRandomIdNumber(MOCK_SERVER);
+
     given()
         .contentType(ContentType.JSON)
         .body(buildMessage(ZonedDateTime.now(), CommunicationChannelDto.PUSH))
@@ -123,6 +135,8 @@ void whenCreateNewPushScheduleThenReturn() {
 
   @Test
   void whenCreateNewSmsScheduleThenReturn() {
+    mockRandomIdNumber(MOCK_SERVER);
+
     given()
         .contentType(ContentType.JSON)
         .body(buildMessage(ZonedDateTime.now(), CommunicationChannelDto.SMS))

acceptance-test/src/test/java/br/com/helpdev/atdd/ApplicationIT.java renamed to acceptance-test/src/test/java/br/com/helpdev/atdd/MessageV1EndpointIT.java

@@ -0,0 +1,19 @@
+package br.com.helpdev.atdd.mock;
+
+import static com.github.tomakehurst.wiremock.client.WireMock.aResponse;
+import static com.github.tomakehurst.wiremock.client.WireMock.get;
+import static com.github.tomakehurst.wiremock.client.WireMock.urlPathMatching;
+
+import com.github.tomakehurst.wiremock.WireMockServer;
+
+public class RandomDataApiMock {
+
+  public static void mockRandomIdNumber(final WireMockServer mockServer) {
+    mockServer.stubFor(get(urlPathMatching("/api/id_number/random_id_number"))
+        .willReturn(aResponse()
+            .withBodyFile("randomIdNumberResponse.json")
+            .withStatus(200)
+            .withHeader("Content-Type", "application/json")));
+  }
+
+}

acceptance-test/src/test/java/br/com/helpdev/atdd/mock/RandomDataApiMock.java

@@ -0,0 +1,6 @@
+{
+  "id": 8511,
+  "uid": "2c6bbb23-8ad5-4e36-94d0-945f3fc541af",
+  "valid_us_ssn": "000-22-1110",
+  "invalid_us_ssn": "666-31-7707"
+}