Перейдіть за замовчуванням налаштування Spring-Boot application.properties в Junit Test

У мене є програма Spring-Boot, де властивості за замовчуванням встановлюються у application.propertiesфайлі classpath (src / main / ресурси / application.properties).

Я хотів би замінити деякі параметри за замовчуванням у своєму тесті JUnit із властивостями, задекларованими у test.propertiesфайлі (src / test / ресурси / test.properties)

У мене зазвичай є спеціальний клас Config для моїх тестів Junit, наприклад

package foo.bar.test;

import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;

@Configuration
@Import(CoreConfig.class)
@EnableAutoConfiguration
public class TestConfig {

}

Я спершу подумав, що використання @PropertySource("classpath:test.properties")класу TestConfig зробить трюк, але ці властивості не замінять налаштування application.properties (див. Довідковий документ Spring-Boot Doc - 23. Externalized Configuration ).

Потім я спробував використовувати, -Dspring.config.location=classpath:test.propertiesколи викликав тест. Це було успішно - але я не хочу встановлювати це властивість системи для кожного виконання тесту. Таким чином я вклав це в код

@Configuration
@Import(CoreConfig.class)
@EnableAutoConfiguration
public class TestConfig {

  static {
    System.setProperty("spring.config.location", "classpath:test.properties");
  }

}

що, на жаль, знову не було успішним.

Має бути просте рішення про те, як замінити application.propertiesналаштування в тестах JUnit, на test.propertiesщо я, мабуть, не звернув уваги.

Ви можете використовувати @TestPropertySourceдля перевизначення значень у application.properties. З його javadoc:

Джерела властивостей тесту можуть використовуватися для вибіркового перебору властивостей, визначених у джерелах властивостей системи та додатків

Наприклад:

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = ExampleApplication.class)
@TestPropertySource(locations="classpath:test.properties")
public class ExampleApplicationTests {

}

Весна завантаження автоматично завантажується src/test/resources/application.properties , якщо використовуються наступні примітки

@RunWith(SpringRunner.class)
@SpringBootTest

Отже, перейменуйте test.properties до application.propertiesвикористовувати автоматичну конфігурацію.

Якщо вам потрібно * лише * завантажити файл властивостей (у навколишнє середовище), ви також можете скористатися наступним, як пояснено тут

@RunWith(SpringRunner.class)
@ContextConfiguration(initializers = ConfigFileApplicationContextInitializer.class) 

[ Оновлення: Переосмислення певних властивостей для тестування ]

1. Додайте src/main/resources/application-test.properties .
2. Анотувати тестовий клас с @ActiveProfiles("test") .

Це завантажує, application.propertiesа потім application-test.properties властивості в контекст програми для тестового випадку, як визначено правилами тут .

Демо - https://github.com/mohnish82/so-spring-boot-testprops

Ви також можете використовувати мета-примітки для зовнішньої настройки конфігурації. Наприклад:

@RunWith(SpringJUnit4ClassRunner.class)
@DefaultTestAnnotations
public class ExampleApplicationTests { 
   ...
}

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@SpringApplicationConfiguration(classes = ExampleApplication.class)
@TestPropertySource(locations="classpath:test.properties")
public @interface DefaultTestAnnotations { }

Інший підхід, який підходить для переосмислення кількох властивостей у вашому тесті, якщо ви використовуєте @SpringBootTestпримітку:

@SpringBootTest(properties = {"propA=valueA", "propB=valueB"})

TLDR:

Тож, що я зробив, це мати стандарт, src/main/resources/application.propertiesа також src/test/resources/application-default.propertiesде я перекриваю деякі настройки для ВСІХ тестів.

Ціла історія

Я зіткнувся з тією ж проблемою і поки що не використовував профілі. Здавалося, нудно робити це зараз і пам’ятати про декларування профілю - який можна легко забути.

Трюк полягає в тому, щоб використовувати загальний профіль, який визначає особливості application-<profile>.propertiesпрофілю. Див. Https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html#boot-features-external-config-profile-specific-properties .

Просте пояснення:

Якщо ви схожі на мене , і у вас є те ж саме application.propertiesв src/main/resourcesі src/test/resources, і ви цікаво , чому application.propertiesу вашій папці тестів не перекриваючиapplication.properties в основних ресурсах, читайте далі ...

Якщо у вас є application.propertiesпід src/main/resourcesі той же application.propertiesпід src/test/resources, який application.propertiesотримує взяв, залежить від того, як ви працюєте тести . Папка структура src/main/resources і src/test/resourcesє Maven архітектурного угодою, так що якщо ви запускаєте тест , як mvnw testабо навіть gradlew test, то application.propertiesв src/test/resourcesбуде отримати взяли, так як тест шлях до класів будуть передувати основний шлях до класів. Але, якщо ви запускаєте тест , як Run as JUnit Testв ELIPSE / STS, то application.propertiesв src/main/resourcesбуде отримати взяв, як і основні шляхи до класам передують тест класи.

Ви можете перевірити це, відкривши Run > Run Configurations > JUnit > *your_run_configuration* > Click on "Show Command Line".

Ви побачите щось на кшталт:

XXXbin \ javaw.exe -ea -Dfile.encoding = UTF-8 -classpath XXX \ workpace-spring-tool-suite-4-4.5.1.RELEASE \ project_name \ bin \ main; XXX \ workpace-spring-tool-suite-4-4.5.1.RELEASE \ project_name \ bin \ test;

Ви бачите, що спочатку надходить \ main , а потім \ test ? Правильно, це все про класний шлях :-)

Ура

I just configured min as the following :

spring.h2.console.enabled=true
spring.h2.console.path=/h2-console


# changing the name of my data base for testing
spring.datasource.url= jdbc:h2:mem:mockedDB
spring.datasource.username=sa
spring.datasource.password=sa



# in testing i don`t need to know the port

#Feature that determines what happens when no accessors are found for a type
#(and there are no annotations to indicate it is meant to be serialized).
spring.jackson.serialization.FAIL_ON_EMPTY_BEANS=false`enter code here`

Якщо ви використовуєте Spring 5.2.5 та Spring Boot 2.2.6 і хочете замінити лише декілька властивостей замість усього файлу. Ви можете використовувати нову примітку: @DynamicPropertySource

@SpringBootTest
@Testcontainers
class ExampleIntegrationTests {

    @Container
    static Neo4jContainer<?> neo4j = new Neo4jContainer<>();

    @DynamicPropertySource
    static void neo4jProperties(DynamicPropertyRegistry registry) {
        registry.add("spring.data.neo4j.uri", neo4j::getBoltUrl);
    }
}

В іншому випадку ми можемо змінити ім'я конфігуратора властивостей за замовчуванням, встановивши властивість, spring.config.name=testа потім мати ресурс class-path, src/test/test.propertiesнашим рідним екземпляромorg.springframework.boot.SpringApplication буде автоматично налаштований з цього розділеного тесту.

Перевага: автоматична конфігурація тестів;

Недолік: викриття властивості "spring.config.name" на рівні CI

посилання: http://docs.spring.io/spring-boot/docs/current/reference/html/common-application-properties.html

spring.config.name = application # Налаштування імені файлу

Ви також можете створити файл application.properties в src / test / ресурси, де записані ваші JUnits.