Как писать интеграционные тесты с помощью Spring-Cloud-Netflix и симулировать

Вот пример использования WireMock для тестирования конфигурации SpringBoot с клиентом Feign и резервным вариантом Hystrix.

Если вы используете Eureka в качестве обнаружения сервера, вам необходимо отключить его, установив свойство "eureka.client.enabled=false".

Во-первых, нам нужно включить конфигурацию Feign / Hystrix для нашего приложения:

@SpringBootApplication
@EnableFeignClients
@EnableCircuitBreaker
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

@FeignClient(
        name = "bookstore-server",
        fallback = BookClientFallback.class,
        qualifier = "bookClient"
)
public interface BookClient {

    @RequestMapping(method = RequestMethod.GET, path = "/book/{id}")
    Book findById(@PathVariable("id") String id);
}

@Component
public class BookClientFallback implements BookClient {

    @Override
    public Book findById(String id) {
        return Book.builder().id("fallback-id").title("default").isbn("default").build();
    }
}

Обратите внимание, что мы указываем резервный класс для клиента Feign. Резервный класс будет вызываться каждый раз при сбое вызова клиента Feign (например, тайм-аут соединения).

Чтобы тесты работали, нам нужно настроить балансировщик нагрузки Ribbon (будет использоваться внутренне клиентом Feign при отправке http-запроса):

@RunWith(SpringRunner.class)
@SpringBootTest(properties = {
        "feign.hystrix.enabled=true"
})
@ContextConfiguration(classes = {BookClientTest.LocalRibbonClientConfiguration.class})
public class BookClientTest {

    @Autowired
    public BookClient bookClient;

    @ClassRule
    public static WireMockClassRule wiremock = new WireMockClassRule(
            wireMockConfig().dynamicPort()));

    @Before
    public void setup() throws IOException {
        stubFor(get(urlEqualTo("/book/12345"))
                .willReturn(aResponse()
                        .withStatus(HttpStatus.OK.value())
                        .withHeader("Content-Type", MediaType.APPLICATION_JSON)
                        .withBody(StreamUtils.copyToString(getClass().getClassLoader().getResourceAsStream("fixtures/book.json"), Charset.defaultCharset()))));
    }

    @Test
    public void testFindById() {
        Book result = bookClient.findById("12345");

        assertNotNull("should not be null", result);
        assertThat(result.getId(), is("12345"));
    }

    @Test
    public void testFindByIdFallback() {
        stubFor(get(urlEqualTo("/book/12345"))
                .willReturn(aResponse().withFixedDelay(60000)));

        Book result = bookClient.findById("12345");

        assertNotNull("should not be null", result);
        assertThat(result.getId(), is("fallback-id"));
    }

    @TestConfiguration
    public static class LocalRibbonClientConfiguration {
        @Bean
        public ServerList<Server> ribbonServerList() {
            return new StaticServerList<>(new Server("localhost", wiremock.port()));
        }
    }
}

Список ленточных серверов должен соответствовать URL-адресу (хосту и порту) нашей конфигурации WireMock.

Вот пример подключения Feign и WireMock со случайным портом (на основе ответ Spring-Boot github).

@RunWith(SpringRunner.class)
@SpringBootTest(properties = "google.url=http://google.com") // emulate application.properties
@ContextConfiguration(initializers = PortTest.RandomPortInitializer.class)
@EnableFeignClients(clients = PortTest.Google.class)
public class PortTest {

    @ClassRule
    public static WireMockClassRule wireMockRule = new WireMockClassRule(
        wireMockConfig().dynamicPort()
    );

    @FeignClient(name = "google", url = "${google.url}")
    public interface Google {    
        @RequestMapping(method = RequestMethod.GET, value = "/")
        String request();
    }

    @Autowired
    public Google google;

    @Test
    public void testName() throws Exception {
        stubFor(get(urlEqualTo("/"))
                .willReturn(aResponse()
                        .withStatus(HttpStatus.OK.value())
                        .withBody("Hello")));

        assertEquals("Hello", google.request());
    }


    public static class RandomPortInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
        @Override
        public void initialize(ConfigurableApplicationContext applicationContext) {

            // If the next statement is commented out, 
            // Feign will go to google.com instead of localhost
            TestPropertySourceUtils
                .addInlinedPropertiesToEnvironment(applicationContext,
                    "google.url=" + "http://localhost:" + wireMockRule.port()
            );
        }
    }
}

В качестве альтернативы вы можете попробовать поиграть с System.setProperty() в @BeforeClass методе вашего теста.

Раньше было два основных варианта выполнения интеграционных тестов для приложений микросервисов:

1. Развертывание сервисов в тестовой среде и выполнение сквозных тестов
2. Мокинг над другими микросервисами

Первый вариант имеет очевидный недостаток, связанный с трудностями развертывания всех зависимостей (других сервисов, баз данных и т. Д.). Кроме того, он медленный и трудный для отладки.

Второй вариант быстрее и менее проблематичен, но из-за возможных изменений кода легко получить заглушки, которые ведут себя иначе, чем в действительности. Таким образом, можно иметь успешные тесты, но неуспешное приложение при развертывании в prod.

Лучшим решением было бы использование проверки контракта на основе потребителя, чтобы вы могли убедиться, что API службы поставщика соответствует требованиям потребителей. Для этого разработчики Spring могут использовать Spring Cloud Contract. Для других сред существует структура под названием PACT. Оба могут также использоваться с клиентами Feign. Вот пример с PACT.

Я лично предпочитаю mockServer заглушить любой успокаивающий API, он прост в использовании и похож на wiremock, но он очень мощный по сравнению с последним.

Я приложил пример кода, написанного с помощью groovy / spock, для заглушки успокаивающего вызова GET с помощью mockServer.

Сначала автоматически подключите экземпляр mockServer в тестовом классе

@Autowired
private static ClientAndServer mockServer

запустите экземпляр mockServer из метода setupSpec (), этот метод аналогичен методу junit, аннотированному @BeforeClass.

def setupSpec() {
     mockServer = ClientAndServer.startClientAndServer(8080)
   }

определите необходимую заглушку в соответствующем модульном тесте

def "test case"() {
 given:
       new MockServerClient("localhost",8080).when(HttpRequest.request().withMethod("GET").withPath("/test/api").withQueryStringParameters(Parameter.param("param1", "param1_value"), Parameter.param("param2", "param2_value"))).respond(HttpResponse.response().withStatusCode(HttpStatus.OK.value()).withBody("{ message: 'sample response' }"))

 when:
 //your code
 then:
 //your code
}

после выполнения тестовых случаев остановите фиктивный сервер

def cleanupSpec() {
     mockServer.stop()
} 

Вероятно, нет никакого способа заставить WireMock напрямую связываться с Eureka Server, но вы можете использовать другие варианты для настройки тестовой среды, которая вам нужна.

1. В тестовой среде вы можете развернуть Eureka Service Registry в отдельном контейнере сервлетов Jetty, и все аннотации будут работать так же, как в реальной производственной среде.
2. Если вы не хотите использовать реальную BarClient логику конечной точки, а интеграционный тест касается только реального http транспортного уровня, тогда вы можете использовать Mockito для BarClient заглушки конечной точки.

Я полагаю, что для реализации 1 и 2 с помощью Spring-Boot вам нужно будет создать два отдельных приложения для тестовой среды. Один для Eureka Service Registry под Jetty, а другой - для заглушки конечной точки BarClient под Jetty.

Другое решение - вручную настроить Jetty и Eureka в контексте тестового приложения. Я думаю, что это лучший способ, но в таком случае вы должны понимать, что аннотации @EnableEurekaServer и @EnableDiscoveryClient делают с контекстом приложения Spring.

Используйте Spring RestTemplate вместо fign. RestTemplate также может разрешать имена служб через эврика, поэтому вы можете сделать что-то вроде этого:

@Component
public class SomeService {
   @Autowired
   RestTemplate restTemplate;

   public String doSomething() {
     try {
       restTemplate.postForEntity("http://my-service/some/url", 
                                  new BazzleRequest(...), 
                                  Void.class);
       return "so bazzle my eyes dazzle";
     } catch(HttpStatusCodeException e) {
       return "Not bazzle today!";
     }
   }
}

Это проще проверить с помощью Wiremock, чем симулировать.