[Spring] BeforeEachCallback을 통해 @Sql 없이 데이터베이스 초기화 자동화하기

 

 

 

🧐 인수테스트 데이터 초기화

인수테스트 혹은 통합테스트를 작성할 때에는 테스트를 격리하기 위해 다양한 방식을 사용할 수 있습니다.

이와 관련한 여러 방법에 대해서는 인수테스트에서 테스트 격리하기 글에 자세히 나타나 있습니다.

저는 여러가지 방법들 중 @Sql 애노테이션을 사용하여 truncate 쿼리를 작성하는 방법을 주로 사용했었는데요, 이 방법은 truncate.sql 파일에 코드가 의존적이게 되며, 테이블이 새로 추가되거나 삭제되는 경우 truncate.sql 파일도 계속해서 수정해주어야 한다는 단점을 느꼈습니다.

 

그러던 중 BeforeEachCallback라는 것에 대해 알게되었고, 이를 사용하여 truncate.sql 파일 없이도 데이터베이스를 초기화를 자동화 시켰는데요, 해당 방법에 대해서 알아보겠습니다.

 

 

 

 

 

 

🧐 truncate로 모든 테이블 초기화하기

우선 데이터베이스의 테이블을 조회한 뒤, 해당 테이블들에 truncate 쿼리를 날리는 방법에 대해 알아보겠습니다.

 

완성된 코드는 다음과 같습니다.

package com.vestie.vestie.common;

import jakarta.annotation.PostConstruct;
import jakarta.persistence.EntityManager;
import jakarta.persistence.PersistenceContext;
import java.util.ArrayList;
import java.util.List;
import org.springframework.context.annotation.Profile;
import org.springframework.stereotype.Component;
import org.springframework.transaction.annotation.Transactional;

@Component
@Profile("test")
public class DataCleaner {

    private static final String FOREIGN_KEY_CHECK_FORMAT = "SET FOREIGN_KEY_CHECKS %d";
    private static final String TRUNCATE_FORMAT = "TRUNCATE TABLE %s";

    private final List<String> tableNames = new ArrayList<>();

    @PersistenceContext
    private EntityManager entityManager;

    @SuppressWarnings("unchecked")
    @PostConstruct
    public void findDatabaseTableNames() {
        List<Object[]> tableInfos = entityManager.createNativeQuery("SHOW TABLES").getResultList();
        for (Object[] tableInfo : tableInfos) {
            String tableName = (String) tableInfo[0];
            tableNames.add(tableName);
        }
    }

    @Transactional
    public void clear() {
        entityManager.clear();
        truncate();
    }

    private void truncate() {
        entityManager.createNativeQuery(String.format(FOREIGN_KEY_CHECK_FORMAT, 0)).executeUpdate();
        for (String tableName : tableNames) {
            entityManager.createNativeQuery(String.format(TRUNCATE_FORMAT, tableName)).executeUpdate();
        }
        entityManager.createNativeQuery(String.format(FOREIGN_KEY_CHECK_FORMAT, 1)).executeUpdate();
    }
}

 

 

 

 

🐳 데이터베이스에 존재하는 모든 테이블의 이름 가져오기

먼저 데이터베이스에 존재하는 테이블의 이름을 가져오는 findDatabaseTableNames() 코드를 살펴보겠습니다.

@PostConstruct
@SuppressWarnings("unchecked")
public void findDatabaseTableNames() {
    List<Object[]> tableInfos = entityManager.createNativeQuery("SHOW TABLES").getResultList();
    for (Object[] tableInfo : tableInfos) {
        String tableName = (String) tableInfo[0];
        tableNames.add(tableName);
    }
}

SHOW TABLE라는 native query를 수행한 후, 결과를 받아옵니다.

 

H2 데이터베이스에 위 쿼리를 실행한 결과는 다음과 같습니다.

이때 TABLE_NAME과 TABLE_SCHEMA가 Object 배열에 들어간 형태로 조회됩니다.

 

따라서 이들을 순회하여 배열의 0번째 인덱스의 있는 값들을 추출하면, 그것이 테이블의 이름이 됩니다.

 

 

 

 

 

 

🐳 각각의 테이블들에 대해 truncate 쿼리 수행하기

private static final String FOREIGN_KEY_CHECK_FORMAT = "SET FOREIGN_KEY_CHECKS %d";
private static final String TRUNCATE_FORMAT = "TRUNCATE TABLE %s";

private void truncate() {
    entityManager.createNativeQuery(String.format(FOREIGN_KEY_CHECK_FORMAT, 0)).executeUpdate();
    for (String tableName : tableNames) {
        entityManager.createNativeQuery(String.format(TRUNCATE_FORMAT, tableName)).executeUpdate();
    }
    entityManager.createNativeQuery(String.format(FOREIGN_KEY_CHECK_FORMAT, 1)).executeUpdate();
}

이 부분은 truncate.sql에 작성될 코드를 그대로 옮긴 것입니다.

 

 

 

 

 

🐳 사용 시 문제점

이제 DataCleaner를 사용하려면 다음과 같이 코드를 작성하면 됩니다.

@SpringBootTest(webEnvironment = RANDOM_PORT)
class 인수테스트 {
    
    @Autowired
    private DataCleaner cleaner;
    
  @BeforeEach
    void setup() {
        RestAssured.port = port;
        cleaner.clear();
    }
}

그러나 필요한 테스트 클래스마다 의존관계를 주입받고, @BeforeEach를 작성하는 것은 귀찮을 수 있습니다.

인수테스트에만 사용된다면 상속을 통해 귀찮음을 해결할 수 있겠지만, 통합 테스트 등에서도 필요할 수 있기 때문에, 이들을 공통으로 자동화하는 방법이 있으면 좋을 것 같습니다.

이를 위해 BeforEachCallback을 사용할 수 있습니다.

 

 

 

 

 

 

 

 

 

🧐 BeforeEachCallback

Junit5에서 제공해주는 인터페이스로 @BeforeEach 실행 전에 실행되는 코드를 작성할 수 있습니다.

 

이 외에도 다음과 같은 인터페이스를 제공합니다.

• BeforeAllCallback - @BeforeAll 실행 전에 실행됩니다. (가장 먼저 실행됩니다.)
• BeforeEachCallback - @BeforeEach 실행 전에 실행됩니다.
• BeforeTestExecutionCallback - 각 테스트가 실행되기 직전에 실행됩니다. (@BeforeEach 후에 실행됩니다.)
• AfterTestExecutionCallback : 각 테스트가 종료된 후 실행됩니다. (@AfterEach전에 실행됩니다.)
• AfterEachCallback : @AfterEach 실행 이후에 실행됩니다.
• AfterAllCallback : @AfterAll 실행 이후에 실행됩니다. (가장 나중에 실행됩니다.)

 

 

 

 

 

 

 

🧐 truncate 자동화하기

public class DataClearExtension implements BeforeEachCallback {

    @Override
    public void beforeEach(ExtensionContext context) throws Exception {
        DataCleaner dataCleaner = getDataCleaner(context);
        dataCleaner.clear();
    }

    private DataCleaner getDataCleaner(ExtensionContext extensionContext) {
        return SpringExtension.getApplicationContext(extensionContext)
                .getBean(DataCleaner.class);
    }
}

위와 같이 코드를 작성하여 @BeforeEach 실행 전에 테이블들을 truncate하도록 만들어줍니다.

 

이제 이를 다음과 같이 @ExtendWith을 통해 사용할 수 있습니다.

@ExtendWith(DataClearExtension.class)  // DB 초기화 자동화
@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
public class 인수테스트 {

    @LocalServerPort
    private int port;

    @BeforeEach
    void setup() {
        RestAssured.port = port;
    }
}