Лекция 136: Интеграционные тесты с использованием Spring Boot Test

Интеграционные тесты проверяют взаимодействие различных компонентов приложения (например, контроллеров, сервисов и репозиториев) и их корректную работу под общей конфигурацией. Они позволяют убедиться, что компоненты приложения "понимают" друг друга и работают в унисон. В отличие от Unit-тестов, интеграционные тесты могут использовать реальные базы данных, веб-серверы и другие живые зависимости.

Почему интеграционные тесты важны?

1. Проверка целостности приложения: интеграционные тесты проверяют, что все компоненты приложения работают вместе без сбоев.
2. Реальная среда: эти тесты близки к реальным условиям работы приложения, включая взаимодействие с базой данных, сервисами и API.
3. Обнаружение ошибок взаимодействия: даже если отдельные компоненты корректно работают, их взаимодействие может содержать ошибки, которые выявляют интеграционные тесты.

Различия между Unit и интеграционными тестами

Зачем использовать Spring Boot Test?

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

Преимущества использования Spring Boot Test:

• Автоматическая загрузка контекста приложения.
• Подключение тестовой базы данных через конфигурацию.
• Легкость в тестировании REST API, взаимодействия компонентов и базы данных.
• Гибкость для тестирования определённых частей приложения, если используется фильтрация контекста.

Аннотация @SpringBootTest

Для написания интеграционных тестов в Spring Boot мы используем аннотацию @SpringBootTest. Она позволяет загрузить полный контекст приложения, включающий контроллеры, сервисы, репозитории, конфигурации и даже встроенный веб-сервер (если требуется).

Вот минимальный пример тестового класса:

@SpringBootTest
class IntegrationTestExample {

    @Autowired
    private SomeService someService;

    @Test
    void testServiceMethod() {
        String result = someService.performAction();
        assertEquals("Expected Result", result);
    }
}

Важные моменты:

• При использовании @SpringBootTest весь контекст приложения загружается, что делает тесты более медленными, чем Unit-тесты. Поэтому используйте их только там, где это действительно необходимо.
• Если хотите протестировать только часть контекста, вы можете ограничить загружаемый контекст, например, с помощью @WebMvcTest или @DataJpaTest.

Конфигурация тестового окружения

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

1. Использование in-memory базы данных

Для тестирования репозиториев можно использовать H2 — базу данных в памяти:

# application-test.properties
spring.datasource.url=jdbc:h2:mem:testdb
spring.datasource.driverClassName=org.h2.Driver
spring.datasource.username=sa
spring.datasource.password=password
spring.jpa.database-platform=org.hibernate.dialect.H2Dialect

Затем в тестах мы указываем Spring использовать этот тестовый профиль:

@SpringBootTest
@ActiveProfiles("test")  // Указывает на использование application-test.properties
class RepositoryIntegrationTest {
    // Тесты
}

2. Автоматическое подчищение данных

Для тестов с базой данных полезно автоматически очищать данные после выполнения каждого теста. Spring Boot делает это с помощью аннотации @Transactional:

@SpringBootTest
@Transactional  // Откат всех изменений после каждого теста
class DatabaseIntegrationTest {
    // Тесты
}

3. MockMVC и тестирование REST API

Чтобы проверить взаимодействие с REST API, используется MockMVC, который позволяет имитировать HTTP-запросы и анализировать ответы.

Написание интеграционного теста: Практический пример

Предположим, у нас есть приложение для управления задачами. Мы протестируем REST API, который взаимодействует с базой данных для создания и получения задач.

1. Пример кода контроллера

@RestController
@RequestMapping("/api/tasks")
public class TaskController {

    @Autowired
    private TaskService taskService;

    @PostMapping
    public ResponseEntity<Task> createTask(@RequestBody Task task) {
        return ResponseEntity.status(HttpStatus.CREATED).body(taskService.createTask(task));
    }

    @GetMapping("/{id}")
    public ResponseEntity<Task> getTask(@PathVariable Long id) {
        return ResponseEntity.ok(taskService.getTaskById(id));
    }
}

2. Сервис и репозиторий

@Service
public class TaskService {

    @Autowired
    private TaskRepository taskRepository;

    public Task createTask(Task task) {
        return taskRepository.save(task);
    }

    public Task getTaskById(Long id) {
        return taskRepository.findById(id).orElseThrow(() -> new EntityNotFoundException("Task not found"));
    }
}

public interface TaskRepository extends JpaRepository<Task, Long> {}

3. Тестирование API через MockMvc

@SpringBootTest
@AutoConfigureMockMvc
class TaskControllerIntegrationTest {

    @Autowired
    private MockMvc mockMvc;

    @Test
    void testCreateAndRetrieveTask() throws Exception {
        // JSON для создания задачи
        String newTaskJson = "{ \"title\": \"Learn Testing\", \"description\": \"Understand integration tests\" }";

        // Создаем задачу
        MvcResult result = mockMvc.perform(post("/api/tasks")
                .contentType(MediaType.APPLICATION_JSON)
                .content(newTaskJson))
                .andExpect(status().isCreated())
                .andReturn();

        // Получаем ID созданной задачи
        Long taskId = JsonPath.read(result.getResponse().getContentAsString(), "$.id");

        // Проверяем, что задача существует
        mockMvc.perform(get("/api/tasks/" + taskId))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$.title").value("Learn Testing"))
                .andExpect(jsonPath("$.description").value("Understand integration tests"));
    }
}

Полезные аннотации для интеграционных тестов

• @SpringBootTest: запускает полный контекст приложения.
• @AutoConfigureMockMvc: автоматически подключает MockMvc для тестирования REST API.
• @Transactional: обеспечивает откат изменений в базе данных после выполнения теста.
• @TestPropertySource: указывает отдельные файлы свойств для тестов.
• @ActiveProfiles: указывает использовать определённый профиль конфигурации.

Основные ошибки при написании интеграционных тестов

1. Избыточная нагрузка на контекст: использовать @SpringBootTest везде подряд. Если вам нужно протестировать только слой REST или репозиториев, лучше использовать узкоспециализированные аннотации (@WebMvcTest, @DataJpaTest).
2. Отсутствие тестовой базы данных: используйте in-memory базы или Testcontainers, чтобы не загрязнять реальную базу.
3. Неизолированные тесты: всегда старайтесь делать тесты независимыми друг от друга, чтобы их порядок выполнения не влиял на результат.

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