개발/프로덕션 패리티: Spring Boot 테스트 컨테이너

소개

개발/프로덕션 패리티는 개발 환경과 프로덕션 환경 간의 격차를 줄이는 것을 목표로 합니다. 이 기사에서는 개발과 생산을 최대한 유사하게 만드는 방법으로 특히 Spring Testcontainers와의 통합 테스트에서 도구 격차를 다루고 있습니다.
데이터베이스와 관련된 통합 테스트를 수행할 때 모든 CRUD 작업을 주의 깊게 관리해야 합니다. 이는 TestDeleteUserByID_ShouldReturnOk()와 같은 테스트가 2015년부터 우리와 함께해온 가장 충실한 고객의 계정을 '우연히' 삭제하기로 결정할 수 있는 중앙 집중식 데이터베이스 환경에서 매우 중요합니다. ?‍♂️
이러한 위험을 완화하기 위해 테스트 데이터를 격리하는 데이터베이스 트랜잭션과 같은 솔루션을 고려할 수 있습니다. 예를 들어, 테스트는 데이터를 수정하기 위해 트랜잭션을 시작한 다음 마지막에 롤백하여 데이터베이스를 원래 상태로 남겨둘 수 있습니다.
그러나 이로 인해 중요한 문제가 발생합니다. 테스트는 무엇입니까?

격리가 실패하고 코드가 롤백되지 않은 변경 사항을 실행하여 프로덕션 환경으로 데이터가 유출되면 어떻게 되나요? 이러한 시나리오에서는 잠재적 피해가 매우 큽니다.

또는 H2DB와 같은 인메모리 데이터베이스를 사용한 자체 포함 테스트에도 몇 가지 과제가 있습니다. 설정이 쉽다고 해도 H2DB는 RDBMS와 다르기 때문에 개발 환경과 프로덕션 환경에서 테스트 결과가 다를 가능성이 높아 그 결과를 신뢰할 수 없습니다.

https://stackoverflow.com/questions/62778900/syntax-error-h2-database-in-postgresql-compatibility

문제가 덜한 다음 솔루션은 데이터베이스를 복제하여 프로덕션과 유사한 환경에서 덜 위험한 접근 방식을 제공하는 것입니다. 그러나 이 방법에는 한계가 있습니다. ORM이 프로덕션 데이터베이스 스키마의 생성 및 설정을 자동화한다는 점을 고려하면 복제된 개발 데이터베이스를 동기화 상태로 유지하는 방법에 대해 생각해야 합니다.

---

데이터베이스, 메시지 브로커 등 컨테이너화할 수 있는 모든 것을 테스트하세요.

"Testcontainers는 JUnit 테스트를 지원하는 Java 라이브러리로, 일반 데이터베이스, Selenium 웹 브라우저 또는 Docker 컨테이너에서 실행할 수 있는 모든 항목의 가볍고 일회용 인스턴스를 제공합니다."

원래 Java용으로 개발되었지만 이후 Go, Rust 및 .NET과 같은 다른 언어를 지원하도록 확장되었습니다.

Testcontainers의 주요 아이디어는 IDE에서 실행할 수 있는 주문형 인프라를 제공하는 것입니다. 여기서 모의 작업이나 인메모리 서비스 사용 없이 자동 정리를 통해 테스트를 수행할 수 있습니다.

이를 달성하려면 세 단계를 거쳐야 합니다.

• Docker 컨테이너를 설정하여 필요한 서비스를 시작하고 인프라를 준비하고 이 설정을 테스트 인프라로 사용하도록 애플리케이션을 구성합니다.
• 도커화된 인프라에서 테스트를 실행하세요.
• 테스트가 완료되면 도커화된 인프라를 자동으로 정리

테스트 컨테이너 라이브러리 문서

---

Spring Boot 테스트 컨테이너 구현

통합 테스트의 기본 클래스인 ApplicationIntegrationTests에서는 정적 PostgreSQLContainer를 정의합니다. 이 컨테이너는 이 클래스에서 파생된 모든 테스트 인스턴스에서 사용됩니다.

@Testcontainers 주석을 사용하면 @Container 주석이 달린 모든 필드를 검색하고 해당 컨테이너 수명 주기 메서드를 관리하며 컨테이너를 시작할 수 있습니다.

• 정적 필드로 선언된 컨테이너는 테스트 메서드 간에 공유됩니다. 테스트 메서드가 실행되기 전에 한 번만 시작되고 마지막 테스트 메서드가 실행된 후에 중지됩니다.
• 인스턴스 필드로 선언된 컨테이너는 테스트 메서드마다 시작되고 중지됩니다.

@DynamicPropertySource 주석을 사용하면 테스트 환경에 속성을 동적으로 주입할 수 있습니다.

@Testcontainers
@ActiveProfiles("test")
public abstract class ApplicationIntegrationTests {
    @Container
    protected static PostgreSQLContainer<?> postgres=new PostgreSQLContainer<>("postgres:17.2-alpine")
            .withDatabaseName("testcontainersproject")
            .withUsername("root")
            .withPassword("root");

    @DynamicPropertySource
    static void initialize(DynamicPropertyRegistry registry)
    {
        registry.add("spring.datasource.url",postgres::getJdbcUrl);
        registry.add("spring.datasource.username",postgres::getUsername);
        registry.add("spring.datasource.password",postgres::getPassword);
    }


}

또는 @Testcontainers 및 @Container 사용을 건너뛰고 대신 @BeforeAll 및 @AfterAll을 사용하여 컨테이너 수명주기를 직접 관리할 수 있습니다. 이 접근 방식을 사용하면 컨테이너가 시작되고 중지되는 시기와 방법을 더 효과적으로 제어할 수 있습니다

@BeforeAll
public static void runContainer(){
        postgres.start();
}
@AfterAll
static void stopContainers() {
    postgres.stop();
}

@AfterAll 콜백 메서드에서는 Postgres 컨테이너를 명시적으로 중지합니다. 그러나 명시적으로 컨테이너를 중지하지 않더라도 Testcontainers는 테스트 실행이 끝나면 자동으로 컨테이너를 정리하고 종료합니다.

이제 다음과 같이 ApplicationIntegrationTests를 확장하여 통합 테스트를 생성할 수 있습니다.

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@AutoConfigureMockMvc
public class CategoryControllerTest extends ApplicationIntegrationTests {
    private static final String CATEGORY_ENDPOINT="/categories";
   @Autowired
    private MockMvc mockMvc;
    @Autowired
    private CategoryRepository categoryRepository;

    @Test
    void TestGetAllCategories_ShouldReturnOk() throws Exception {

        List<Category> categories = List.of(
                new Category("Electronics", "All kinds of electronic gadgets from smartphones to laptops"),
                new Category("Books", "A wide range of books from novels to educational textbooks")
        );
        categoryRepository.saveAll(categories);
        MvcResult mvcResult=mockMvc.perform(
                get(CATEGORY_ENDPOINT).
                        contentType(MediaType.APPLICATION_JSON)
        )
                .andExpect(status().isOk())
                .andReturn();
        var response=mvcResult.getResponse().getContentAsString();
        assertNotNull(response);
        assertFalse(response.isEmpty());
    }
}

위 내용은 개발/프로덕션 패리티: Spring Boot 테스트 컨테이너의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!