Merge pull request #10289 from adrian-maghear/BAEL-4015

[BAEL-4015] Integration Tests for Spring Cloud and Feing Client

spring-cloud/spring-cloud-eureka/pom.xml

@@ -19,6 +19,7 @@
         <module>spring-cloud-eureka-server</module>
         <module>spring-cloud-eureka-client</module>
         <module>spring-cloud-eureka-feign-client</module>
+        <module>spring-cloud-eureka-feign-client-integration-test</module>
     </modules>
 
     <dependencies>

spring-cloud/spring-cloud-eureka/spring-cloud-eureka-feign-client-integration-test/pom.xml

@@ -0,0 +1,97 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <artifactId>spring-cloud-eureka-feign-client-integration-test</artifactId>
+    <version>1.0.0-SNAPSHOT</version>
+    <name>spring-cloud-eureka-feign-client-integration-test</name>
+    <packaging>jar</packaging>
+    <description>Spring Cloud Eureka - Feign Client Integration Tests</description>
+
+    <parent>
+        <groupId>com.baeldung.spring.cloud</groupId>
+        <artifactId>spring-cloud-eureka</artifactId>
+        <version>1.0.0-SNAPSHOT</version>
+    </parent>
+
+    <dependencyManagement>
+        <dependencies>
+            <dependency>
+                <groupId>org.junit</groupId>
+                <artifactId>junit-bom</artifactId>
+                <version>${junit-jupiter.version}</version>
+                <type>pom</type>
+                <scope>import</scope>
+            </dependency>
+            <dependency>
+                <groupId>org.springframework.cloud</groupId>
+                <artifactId>spring-cloud-starter-parent</artifactId>
+                <version>${spring-cloud-dependencies.version}</version>
+                <type>pom</type>
+                <scope>import</scope>
+            </dependency>
+        </dependencies>
+    </dependencyManagement>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-openfeign</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>com.github.tomakehurst</groupId>
+            <artifactId>wiremock</artifactId>
+            <version>2.27.2</version>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.testcontainers</groupId>
+            <artifactId>testcontainers</artifactId>
+            <version>1.14.3</version>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.awaitility</groupId>
+            <artifactId>awaitility</artifactId>
+            <version>4.0.3</version>
+            <scope>test</scope>
+        </dependency>
+
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <configuration>
+                    <forkCount>1</forkCount>
+                    <reuseForks>true</reuseForks>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>

spring-cloud/spring-cloud-eureka/spring-cloud-eureka-feign-client-integration-test/src/main/java/com/baeldung/spring/cloud/Application.java

@@ -0,0 +1,15 @@
+package com.baeldung.spring.cloud;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.cloud.openfeign.EnableFeignClients;
+
+@EnableFeignClients
+@SpringBootApplication
+public class Application {
+
+    public static void main(String[] args) {
+        SpringApplication.run(Application.class, args);
+    }
+
+}

spring-cloud/spring-cloud-eureka/spring-cloud-eureka-feign-client-integration-test/src/main/java/com/baeldung/spring/cloud/client/BooksClient.java

@@ -0,0 +1,16 @@
+package com.baeldung.spring.cloud.client;
+
+import com.baeldung.spring.cloud.model.Book;
+import org.springframework.cloud.openfeign.FeignClient;
+import org.springframework.web.bind.annotation.RequestMapping;
+
+import java.util.List;
+
+@FeignClient("books-service")
+//@FeignClient(value="simple-books-client", url="${book.service.url}")
+public interface BooksClient {
+
+    @RequestMapping("/books")
+    List<Book> getBooks();
+
+}

spring-cloud/spring-cloud-eureka/spring-cloud-eureka-feign-client-integration-test/src/main/java/com/baeldung/spring/cloud/model/Book.java

@@ -0,0 +1,15 @@
+package com.baeldung.spring.cloud.model;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+public class Book {
+
+    private String title;
+    private String author;
+
+}

spring-cloud/spring-cloud-eureka/spring-cloud-eureka-feign-client-integration-test/src/test/java/com/baeldung/spring/cloud/client/BookMocks.java

@@ -0,0 +1,27 @@
+package com.baeldung.spring.cloud.client;
+
+import com.github.tomakehurst.wiremock.WireMockServer;
+import com.github.tomakehurst.wiremock.client.WireMock;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
+
+import java.io.IOException;
+
+import static java.nio.charset.Charset.defaultCharset;
+import static org.springframework.util.StreamUtils.copyToString;
+
+public class BookMocks {
+
+    public static void setupMockBooksResponse(WireMockServer mockService) throws IOException {
+        mockService.stubFor(WireMock.get(WireMock.urlEqualTo("/books"))
+          .willReturn(
+            WireMock.aResponse()
+              .withStatus(HttpStatus.OK.value())
+              .withHeader("Content-Type", MediaType.APPLICATION_JSON_VALUE)
+              .withBody(
+                copyToString(
+                  BookMocks.class.getClassLoader().getResourceAsStream("payload/get-books-response.json"),
+                  defaultCharset()))));
+    }
+
+}

spring-cloud/spring-cloud-eureka/spring-cloud-eureka-feign-client-integration-test/src/test/java/com/baeldung/spring/cloud/client/BooksClientIntegrationTest.java

@@ -0,0 +1,53 @@
+package com.baeldung.spring.cloud.client;
+
+import com.baeldung.spring.cloud.model.Book;
+import com.github.tomakehurst.wiremock.WireMockServer;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit.jupiter.SpringExtension;
+
+import java.io.IOException;
+
+import static com.baeldung.spring.cloud.client.BookMocks.setupMockBooksResponse;
+import static java.util.Arrays.asList;
+import static org.junit.Assert.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+@SpringBootTest
+@ActiveProfiles("test")
+@EnableConfigurationProperties
+@ExtendWith(SpringExtension.class)
+@ContextConfiguration(classes = { WireMockConfig.class })
+class BooksClientIntegrationTest {
+
+    @Autowired
+    private WireMockServer mockBooksService;
+
+    @Autowired
+    private BooksClient booksClient;
+
+    @BeforeEach
+    void setUp() throws IOException {
+        setupMockBooksResponse(mockBooksService);
+    }
+
+    @Test
+    public void whenGetBooks_thenBooksShouldBeReturned() {
+        assertFalse(booksClient.getBooks().isEmpty());
+    }
+
+    @Test
+    public void whenGetBooks_thenTheCorrectBooksShouldBeReturned() {
+        assertTrue(booksClient.getBooks()
+          .containsAll(asList(
+            new Book("Dune", "Frank Herbert"),
+            new Book("Foundation", "Isaac Asimov"))));
+    }
+
+}

spring-cloud/spring-cloud-eureka/spring-cloud-eureka-feign-client-integration-test/src/test/java/com/baeldung/spring/cloud/client/EurekaContainerConfig.java

@@ -0,0 +1,39 @@
+package com.baeldung.spring.cloud.client;
+
+import org.jetbrains.annotations.NotNull;
+import org.springframework.boot.test.context.TestConfiguration;
+import org.springframework.boot.test.util.TestPropertyValues;
+import org.springframework.context.ApplicationContextInitializer;
+import org.springframework.context.ConfigurableApplicationContext;
+import org.springframework.test.context.ActiveProfiles;
+import org.testcontainers.containers.GenericContainer;
+import org.testcontainers.lifecycle.Startables;
+
+import java.util.stream.Stream;
+
+@TestConfiguration
+@ActiveProfiles("eureka-test")
+public class EurekaContainerConfig {
+
+    public static class Initializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
+
+        public static GenericContainer eurekaServer
+          = new GenericContainer("springcloud/eureka")
+          .withExposedPorts(8761);
+
+        @Override
+        public void initialize(@NotNull ConfigurableApplicationContext configurableApplicationContext) {
+
+            Startables.deepStart(Stream.of(eurekaServer)).join();
+
+            TestPropertyValues
+              .of("eureka.client.serviceUrl.defaultZone=http://localhost:"
+                + eurekaServer.getFirstMappedPort().toString()
+                + "/eureka")
+              .applyTo(configurableApplicationContext);
+
+        }
+
+    }
+
+}

spring-cloud/spring-cloud-eureka/spring-cloud-eureka-feign-client-integration-test/src/test/java/com/baeldung/spring/cloud/client/LoadBalancerBooksClientIntegrationTest.java

@@ -0,0 +1,65 @@
+package com.baeldung.spring.cloud.client;
+
+import com.baeldung.spring.cloud.model.Book;
+import com.github.tomakehurst.wiremock.WireMockServer;
+import com.github.tomakehurst.wiremock.client.WireMock;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit.jupiter.SpringExtension;
+
+import java.io.IOException;
+
+import static com.baeldung.spring.cloud.client.BookMocks.setupMockBooksResponse;
+import static com.github.tomakehurst.wiremock.client.WireMock.getRequestedFor;
+import static com.github.tomakehurst.wiremock.client.WireMock.moreThan;
+import static java.util.Arrays.asList;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+@SpringBootTest
+@ActiveProfiles("ribbon-test")
+@EnableConfigurationProperties
+@ExtendWith(SpringExtension.class)
+@ContextConfiguration(classes = { RibbonTestConfig.class })
+class LoadBalancerBooksClientIntegrationTest {
+
+    @Autowired
+    private WireMockServer mockBooksService;
+
+    @Autowired
+    private WireMockServer secondMockBooksService;
+
+    @Autowired
+    private BooksClient booksClient;
+
+    @BeforeEach
+    void setUp() throws IOException {
+        setupMockBooksResponse(mockBooksService);
+        setupMockBooksResponse(secondMockBooksService);
+    }
+
+    @Test
+    void whenGetBooks_thenRequestsAreLoadBalanced() {
+        for (int k = 0; k < 10; k++) {
+            booksClient.getBooks();
+        }
+
+        mockBooksService.verify(
+          moreThan(0), getRequestedFor(WireMock.urlEqualTo("/books")));
+        secondMockBooksService.verify(
+          moreThan(0), getRequestedFor(WireMock.urlEqualTo("/books")));
+    }
+
+    @Test
+    public void whenGetBooks_thenTheCorrectBooksShouldBeReturned() {
+        assertTrue(booksClient.getBooks()
+          .containsAll(asList(
+            new Book("Dune", "Frank Herbert"),
+            new Book("Foundation", "Isaac Asimov"))));
+    }
+}

spring-cloud/spring-cloud-eureka/spring-cloud-eureka-feign-client-integration-test/src/test/java/com/baeldung/spring/cloud/client/MockBookServiceConfig.java

@@ -0,0 +1,22 @@
+package com.baeldung.spring.cloud.client;
+
+import com.baeldung.spring.cloud.model.Book;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.test.context.ActiveProfiles;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import java.util.Collections;
+import java.util.List;
+
+@Configuration
+@RestController
+@ActiveProfiles("eureka-test")
+public class MockBookServiceConfig {
+
+    @RequestMapping("/books")
+    public List<Book> getBooks() {
+        return Collections.singletonList(new Book("Hitchhiker's guide to the galaxy", "Douglas Adams"));
+    }
+
+}

spring-cloud/spring-cloud-eureka/spring-cloud-eureka-feign-client-integration-test/src/test/java/com/baeldung/spring/cloud/client/RibbonTestConfig.java

@@ -0,0 +1,41 @@
+package com.baeldung.spring.cloud.client;
+
+import com.github.tomakehurst.wiremock.WireMockServer;
+import com.netflix.loadbalancer.Server;
+import com.netflix.loadbalancer.ServerList;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.TestConfiguration;
+import org.springframework.cloud.netflix.ribbon.StaticServerList;
+import org.springframework.context.annotation.Bean;
+import org.springframework.test.context.ActiveProfiles;
+
+import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.options;
+
+@TestConfiguration
+@ActiveProfiles("ribbon-test")
+public class RibbonTestConfig {
+
+    @Autowired
+    private WireMockServer mockBooksService;
+
+    @Autowired
+    private WireMockServer secondMockBooksService;
+
+    @Bean(initMethod = "start", destroyMethod = "stop")
+    public WireMockServer mockBooksService() {
+        return new WireMockServer(options().dynamicPort());
+    }
+
+    @Bean(name="secondMockBooksService", initMethod = "start", destroyMethod = "stop")
+    public WireMockServer secondBooksMockService() {
+        return new WireMockServer(options().dynamicPort());
+    }
+
+    @Bean
+    public ServerList<Server> ribbonServerList() {
+        return new StaticServerList<>(
+          new Server("localhost", mockBooksService.port()),
+          new Server("localhost", secondMockBooksService.port()));
+    }
+
+}

spring-cloud/spring-cloud-eureka/spring-cloud-eureka-feign-client-integration-test/src/test/java/com/baeldung/spring/cloud/client/ServiceDiscoveryBooksClientIntegrationTest.java

@@ -0,0 +1,52 @@
+package com.baeldung.spring.cloud.client;
+
+import com.baeldung.spring.cloud.Application;
+import com.baeldung.spring.cloud.model.Book;
+import com.netflix.discovery.EurekaClient;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.context.annotation.Lazy;
+import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit.jupiter.SpringExtension;
+
+import java.util.List;
+
+import static java.util.concurrent.TimeUnit.SECONDS;
+import static org.awaitility.Awaitility.await;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+@ActiveProfiles("eureka-test")
+@EnableConfigurationProperties
+@ExtendWith(SpringExtension.class)
+@SpringBootTest(classes = Application.class, webEnvironment =  SpringBootTest.WebEnvironment.RANDOM_PORT)
+@ContextConfiguration(classes = { MockBookServiceConfig.class }, initializers = { EurekaContainerConfig.Initializer.class })
+class ServiceDiscoveryBooksClientIntegrationTest {
+
+    @Autowired
+    private BooksClient booksClient;
+
+    @Lazy
+    @Autowired
+    private EurekaClient eurekaClient;
+
+    @BeforeEach
+    void setUp() {
+        await().atMost(60, SECONDS).until(() -> eurekaClient.getApplications().size() > 0);
+    }
+
+    @Test
+    public void whenGetBooks_thenTheCorrectBooksAreReturned() {
+        List<Book> books = booksClient.getBooks();
+
+        assertEquals(1, books.size());
+        assertEquals(
+          new Book("Hitchhiker's guide to the galaxy", "Douglas Adams"),
+          books.stream().findFirst().get());
+    }
+
+}

spring-cloud/spring-cloud-eureka/spring-cloud-eureka-feign-client-integration-test/src/test/java/com/baeldung/spring/cloud/client/WireMockConfig.java

@@ -0,0 +1,17 @@
+package com.baeldung.spring.cloud.client;
+
+import com.github.tomakehurst.wiremock.WireMockServer;
+import org.springframework.boot.test.context.TestConfiguration;
+import org.springframework.context.annotation.Bean;
+import org.springframework.test.context.ActiveProfiles;
+
+@TestConfiguration
+@ActiveProfiles("test")
+public class WireMockConfig {
+
+    @Bean(initMethod = "start", destroyMethod = "stop")
+    public WireMockServer mockBooksService() {
+        return new WireMockServer(9561);
+    }
+
+}

spring-cloud/spring-cloud-eureka/spring-cloud-eureka-feign-client-integration-test/src/test/resources/application-eureka-test.yml

@@ -0,0 +1,3 @@
+spring:
+  application:
+    name: books-service

spring-cloud/spring-cloud-eureka/spring-cloud-eureka-feign-client-integration-test/src/test/resources/application-ribbon-test.yml

@@ -0,0 +1,3 @@
+eureka:
+  client:
+    enabled: false

spring-cloud/spring-cloud-eureka/spring-cloud-eureka-feign-client-integration-test/src/test/resources/application-test.yml

@@ -0,0 +1,11 @@
+#book:
+#  service:
+#    url: http://localhost:9561
+
+books-service:
+  ribbon:
+    listOfServers: http://localhost:9561
+
+eureka:
+  client:
+    enabled: false

spring-cloud/spring-cloud-eureka/spring-cloud-eureka-feign-client-integration-test/src/test/resources/payload/get-books-response.json

@@ -0,0 +1,10 @@
+[
+  {
+    "title": "Dune",
+    "author": "Frank Herbert"
+  },
+  {
+    "title": "Foundation",
+    "author": "Isaac Asimov"
+  }
+]