Настройка профиля тестирования в Spring-Boot: оптимизация

Быстрый ответ

Чтобы установить стандартный профиль для интеграционных тестов в Spring Boot, просто отметьте ваши тестовые классы аннотацией @ActiveProfiles("integration"):

@ActiveProfiles("integration")
public class MyIntegrationTests {
    // Код вашего теста размещается здесь... и не забудьте приготовить кофе ☕
}

В качестве альтернативы можно указать следующее в файле src/test/resources/application.properties:

spring.profiles.active=integration

Такой подход активирует профиль integration во время тестирования и обеспечивает стабильную конфигурацию тестовой среды.

Для максимизации эффективности процесса создайте свою собственную аннотацию для тестов. Это позволит вам группировать настройки и сократить количество дублирующихся определений профилей:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@SpringBootTest
@ActiveProfiles("integration")
public @interface IntegrationTest {
    // Необходимые атрибуты для пользовательской аннотации указываются здесь
}

И затем используйте вашу аннотацию для эффективного управления профилями с минимальными изменениями:

@IntegrationTest
public class MyIntegrationTests {
    // Здесь размещаются ваши тестовые сценарии... а моя зелёная ручка где? 🖊
}

Улучшение настройки тестов с помощью мета-аннотаций

Усовершенствование аннотаций с @AliasFor

Применение @AliasFor позволяет улучшить управление настройками тестирования при создании пользовательских аннотаций:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@SpringBootTest
@ActiveProfiles
public @interface IntegrationTest {

    @AliasFor(annotation = ActiveProfiles.class)
    String[] profiles() default "integration";
    // Ведь всегда хорошо иметь настройку по умолчанию, не так ли? 💁‍♀️
}

Подробнее об этом расскажет наш спикер на видео

Организуйте конфигурационные файлы профессионально

Для удобства переопределения свойств вы можете разместить конфигурационные файлы в src/test/resources/config/ и использовать свойство spring.config.import для управления множественными конфигурационными файлами:

spring:
  config:
    import: classpath:config/application-defaults.yaml
    // Зачем делать вручную то, что можно автоматизировать? 🤖

Вайл application-test.yml следует использовать для импорта основных свойств, чтобы сохранить консистентность конфигурации:

spring:
  profiles:
    include: default
    // Включая все необходимое... точно как в шопинге 🛍

Избежание конфликтов профилей

Важно гарантировать, что свойства для тестирования, определенные в application-test.yml, корректно переопределяют основные, чтобы избежать конфликтов в настройках приложения.

Визуализация

Настройка стандартного профиля для интеграционных тестов в Spring Boot можно воспринимать в виде выбора передачи в автомобиле:

Тесты Spring Boot
      __________
     | 🌐 Глобальные |
     |----------| 
     | ⚙️ Стандартные | <-- Интеграционный тестовый профиль (🔧)
     |----------|
     | 🛠 Пользовательские  |
      ‾‾‾‾‾‾‾‾‾‾‾

Подход к средам разработки

Так же как вы выбираете подходящую передачу для движения, вам нужно корректно настроить тестовую среду для интеграционных тестов.

Оптимизация общей логики

Вы можете сгруппировать подготовительные и заключительные операции ваших тестов в базовых классах. Например, общий класс с аннотацией @SpringBootTest может быть используется в качестве базового для всех тестов веб-слоя:

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public abstract class WebLayerTestBase {
    // Здесь должны быть совершены общая подготовка и очистка для веб-слоя, все под контролем 🧹
}

public class UserControllerTest extends WebLayerTestBase {
    // Специфические тесты для UserController, руководствующего классами 🙃
}

Создание надежных тестов с помощью профилей

Тщательная настройка конфигурационного файла позволяет вам создать тестовые методы с профилями, которые в максимальной степени приближают условия к продакшну, но при этом остаются изолированными от реальных настроек.

Минимальные изменения, значимые результаты

Делайте минимальные изменения в application-test.properties по мере необходимости, чтобы тесты сохраняли реалистичность.

Полезные материалы

1. Основные возможности — Исчерпывающая официальная документация Spring Boot о тестировании содержит важные сведения о тестовых инструментах.
2. java – Профили Spring: Простой пример ActiveProfilesResolver? – Stack Overflow — Обсуждение на Stack Overflow, где приводится практический пример настройки активных профилей для тестирования.
3. Начните работу | Создание приложения с Spring Boot — Руководство от создателей Spring, предназначенное для начинающих разработчиков, желающих разобраться в создании приложений с помощью Spring Boot.
4. Один момент... — Статья на сайте Baeldung, описывающая разницу между YAML и Properties в Spring Boot, полезна при работе с конфигурационными файлами.
5. Статьи на DZone об управлении профилями в Spring с помощью YAML — Материал, освещающий управление профилями Spring с использованием YAML в качестве альтернативы property-файлам.