Установить свойство с произвольным портом wiremock в тесте весенней загрузки

Рассмотрите возможность использования Spring Cloud Contract Wiremock

Уже существует построитель правил JUnit, который позволяет указать ${wiremock.port} для установки случайного порта в файлах свойств / yaml.

Или вы можете использовать WireMockRestServiceServer для привязки WireMock к вашему RestTemplate, чтобы вам даже не нужно было переопределять URL-адреса в ваших тестах.

Мне не удалось найти способ переопределить свойства в тесте интеграции Spring Boot, поскольку тест запускается только после того, как приложение создано и все компоненты уже настроены.

Чтобы обойти эту проблему, я добавил @TestConfiguration в тест, чтобы заменить bean-компоненты в приложении:

private static WireMockServer wireMockServer1 = getWireMockServer();
private static WireMockServer wireMockServer2 = getWireMockServer();
private static WireMockServer wireMockServer3 = getWireMockServer();

private static WireMockServer getWireMockServer() {
    final WireMockServer wireMockServer = new WireMockServer(options().dynamicPort());
    wireMockServer.start();
    return wireMockServer;
}

@TestConfiguration
static class TestConfig {
    @Bean
    @Primary
    public BeanUsingAProperty1 getBean1() {
        BeanUsingAProperty myBean = new BeanUsingAProperty();
        myBean.setPort(wireMockServer.port());
        return myBean;
    }

    @Bean
    @Primary
    public BeanUsingAProperty2 getBean2() {
        String baseUrl = "http://localhost:" + wireMockServer2.port();
        return new BeanUsingAProperty2(baseUrl);
    }

    @Bean
    @Primary
    public BeanUsingAProperty3 getBean3() {
        String baseUrl = "http://localhost:" + wireMockServer3.port() + "/request";
        return new BeanUsingAProperty3(new RestTemplate(), baseUrl, "someOtherParameter");
    }
}

Это эффективно заменило BeanUsingAProperty на тот, который определен в тесте, так что он имеет правильный номер порта для Wiremock.

Чтобы эта конфигурация была подобрана, мне пришлось добавить этот класс в тестовую аннотацию

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, classes = {
    MySpringBootApplication.class, MyIntegrationTest.TestConfig.class })

Обратите внимание, что я использую нестатический API Wiremock, поскольку у меня есть несколько таких внешних служб, каждую из которых нужно издеваться. Обратите внимание, что способ построения различных bean-компонентов зависит от того, как они были спроектированы.

Имя свойства, указанное в https://stackoverflow.com/a/48859553/309683 (т.е. wiremock.port), неверно, по крайней мере, начиная с версии Spring Cloud Contract 2.1.2.RELEASE.

1. Рабочий пример

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.cloud.contract.wiremock.AutoConfigureWireMock;
import org.springframework.core.env.Environment;
import org.springframework.test.context.junit4.SpringRunner;

import static org.assertj.core.api.Assertions.assertThat;
import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT;

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = RANDOM_PORT)
@AutoConfigureWireMock(port = 0)
public class PortServiceTest {

    @Autowired
    private Environment environment;

    @Test
    public void shouldPopulateEnvironmentWithWiremockPort() {
        assertThat(environment.containsProperty("wiremock.server.port")).isTrue();
        assertThat(environment.getProperty("wiremock.server.port")).matches("\\d+");
    }

}

2. Другие свойства WireMock

Помимо wiremock.server.port, @AutoConfigureWireMock также заполняет среду некоторыми другими свойствами:

1. wiremock.server.https-port
2. wiremock.server.stubs[]
3. wiremock.server.files[]

3. Зависимости Gradle

Чтобы использовать Spring Cloud Contract WireMock в проекте на основе Gradle, добавьте в свой проект следующую зависимость:

testImplementation 'org.springframework.cloud:spring-cloud-contract-wiremock:${version}'

4. Использование в application.yaml файлах

Если вы настроите свой тестовый application.yaml файл следующим образом:

sample:
  port: ${wiremock.server.port}

И определите следующие beans:

@Component
@ConfigurationProperties(prefix = "sample")
@Data
public class PortProperties {
    private Integer port;
}

@Service
@RequiredArgsConstructor(onConstructor = @__(@Autowired))
public class PortService {
    private final PortProperties config;

    public Integer getPort() {
        return config.getPort();
    }
}

Вы можете проверить, что sample.port установлен на случайно выбранный порт проводного подключения:

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = RANDOM_PORT)
@AutoConfigureWireMock(port = 0)
public class PortServiceTest {
    @Autowired
    private Environment environment;

    @Autowired
    private PortService portService;

    @Test
    public void shouldReturnWireMockPort() {
        assertThat(portService.getPort())
                .isNotNull()
                .isEqualTo(Integer.parseInt(environment.getProperty("wiremock.server.port")));
    }
}

Используйте подстановку свойств в своем application.properties:

external.baseUrl=http://exampleUrl:${wiremock.server.port}

Это требует, чтобы свойство wiremock.server.port было установлено до инициализации SpringBootTest, что может быть достигнуто путем добавления аннотации @AutoConfigureWireMock в ваш тестовый класс.

Подход, который я использую для программного изменения свойства при запуске приложения Spring Boot, заключается в передаче настраиваемого значения в главную точку входа приложения String[] args. Это приведет к отмене всех других средств, таких как системные свойства, YML или другие файлы конфигурации.

Вот пример:

String[] args = new String[]{"--my.prop=foo"};
SpringApplication.run(Application.class, args);

Вам будет легко предоставить статический метод или пользовательский API, который запускает приложение Spring Boot (для тестирования) и с желаемым значением.

А затем, как только у вас появится ценность порта для беспроводного подключения, все станет легко. Вот пример: PaymentServiceContractTest.java

P.S. Каратэ (примеры тестов с открытым исходным кодом, которые я использую выше) - это новая альтернатива WireMock, обязательно попробуйте;)

Как ты читаешь external.baseUrl? Если вы используете аннотированное свойство @Value, вы можете использовать ReflectionTestUtils для установки порта после настройки фиктивного сервера.

ReflectionTestUtils.setField(yourTestClass, "youPort",  wireMockServer.port());