[Spring Boot] 멀티스레드 테스트에서 @Transactional 사용 시 실패하는 이유

🌱 문제 상황

멀티스레드 테스트에서 테스트 데이터 초기화를 위해 @Transactional을 사용했을 때 @BeforeEach를 통해 초기화한 데이터 조회가 안 되는 문제가 발생하였다.

@Transactional
@SpringBootTest
class OrderUseCaseTest {

    @Autowired
    private OrderUseCase orderUseCase;

    // ...

    @BeforeEach
    void initData() {
        userService.create(user);
        productService.create(product);
        bidService.create(bid);
    }

    @Test
    @DisplayName("판매 입찰에 대한 구매 입찰과 주문을 생성한다")
    void succeed_to_create_order() throws InterruptedException {
        int threadCount = 10;
        ExecutorService executorService = Executors.newFixedThreadPool(threadCount);
        CountDownLatch latch = new CountDownLatch(threadCount);

        AtomicInteger successCount = new AtomicInteger();
        AtomicInteger failCount = new AtomicInteger();

        OrderRequestDto request = new OrderRequestDto(product.getId(), bid.getPrice());

        for (int i = 0; i < threadCount; i++) {
            executorService.submit(() -> {
                try {
                    orderUseCase.order(user, request);
                    successCount.getAndIncrement();
                } catch (NotFoundException e) {
                    failCount.getAndIncrement();
                } finally {
                    latch.countDown();
                }
            });
        }

        latch.await();
        executorService.shutdown();

        assertAll(
            () -> assertThat(successCount.get()).isEqualTo(1),
            () -> assertThat(failCount.get()).isEqualTo(9)
        );
    }

    // 객체 필수 입력값 생략
    User user = User.builder().build();
    Product product = Product.builder().build();
    Bid bid = Bid.builder().build();
}

실제로 order 메서드에 findAll()을 통해 조회한 전체 Bid 리스트 사이즈를 로그로 출력할 경우 0이 출력되는 것을 확인할 수 있다.

 

@Transactional 어노테이션을 삭제할 경우 정상적으로 조회가 가능해지는데 이런 현상이 발생하는 이유는 무엇일까?

 

🌱 문제 발생 이유 - Transaction과 EntityManager

EntityManager는 스레드마다, 트랜잭션이 시작될 때 생성되고 트랜잭션이 끝날 때 소멸된다. 따라서 EntityManager가 관리하는 영속성 컨텍스트도 스레드마다 다르며 이는 1차 캐시도 다르다는 것을 의미한다.

[JPA] 영속성 컨텍스트의 동작원리와 이점

 

위의 succeed_to_create_order() 테스트 메서드는 메인 스레드에서 동작하고, orderUseCase.order() 메서드는 ExecutorService가 생성한 스레드에서 실행이 되기 때문에 main 스레드의 EntityManager와 executorService가 실행하는 스레드의 EntityManager는 서로 다른 1차 캐시를 가지고 있다. 따라서 executorService에서는 main 스레드에서 생성했던 DB 데이터를 조회할 수 없다.

 

하지만 @Transactional 어노테이션을 삭제할 경우 테스트 데이터의 초기화가 되지 않는다는 문제가 생기게 된다.

이 문제를 해결하기 위해 내가 찾은 해결방안은 두 가지가 있다.

 

🌱 해결 방안

1. @SQL 사용

@Sql 어노테이션과 SqlConfig 설정을 통해 테스트 메서드 실행 전 별도의 트랜잭션으로 SQL 스크립트를 실행하여 DB 데이터를 삽입해 주는 방법이다.

@Test
@Sql(scripts = "/order-test-data.sql",
    config = @SqlConfig(transactionMode = TransactionMode.ISOLATED))
void succeed_to_create_order() throws InterruptedException {
    ...
}

@Sql을 통해 날아간 쿼리는 별도의 트랜잭션에서 실행되고 바로 커밋되므로, 다른 스레드에서 다른 EntityManager로 실행되더라도 데이터베이스에 값이 존재해 앞선 문제없이 테스트 진행이 가능하다.

 

하지만 이 방법은 user, bid 등의 필드들의 값을 초기화하기 위해 findBy··· 메서드에 하드코딩한 매개변수를 사용해야 하기 때문에 재사용성이 저하되고 테스트 데이터 관리의 복잡성이 증가한다는 단점이 있다.

 

또한 jojoldu님의 블로그에서 테스트 데이터 초기화에 @Transactional 사용 시 발생할 수 있는 문제점에 대한 글을 읽고 생각해 본 후, @Transactional 보다는 @AfterEach를 통해 명시적으로 데이터를 초기화하는 방법을 사용하는 것으로 결정하게 되었다.

테스트 데이터 초기화에 @Transactional 사용하는 것에 대한 생각

 

2. JUnit5 Extension 사용

JUnit5 Extention이란 JUnit5에서 제공하는 테스트의 생명주기를 각각의 환경에 대해 확장할 수 있도록 제공하는 인터페이스이다.

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

 

 

테스트 패키지에 데이터베이스의 모든 테이블을 초기화하는 유틸리티 클래스를 작성하여 Bean으로 등록한다.

@Component
public class DatabaseCleaner {

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

    @PersistenceContext
    private EntityManager entityManager;

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

    private void truncate() {
        entityManager.createNativeQuery(String.format("SET FOREIGN_KEY_CHECKS %d", 0)).executeUpdate();
        for (String tableName : tableNames) {
            entityManager.createNativeQuery(String.format("TRUNCATE TABLE %s", tableName)).executeUpdate();
        }
        entityManager.createNativeQuery(String.format("SET FOREIGN_KEY_CHECKS %d", 1)).executeUpdate();
    }

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

이 클래스에서는 빈이 생성된 후 findDatabaseTableNames 메서드가 호출되어 데이터베이스의 모든 테이블 이름을 tableNames 리스트에 저장한다.

이후 DatabaseCleaner의 clear() 메서드가 호출되면, Entity Manager를 초기화하고, truncate 메서드를 통해 테이블들을 truncate 한다. (외래 키 제약 조건을 일시적으로 해제해 모든 테이블을 truncate 한 후 다시 외래 키 제약 조건을 활성화함)

 

 

그리고 JUnit5 Extension을 사용해 각 테스트 메서드가 실행된 후 데이터베이스를 자동으로 정리하는 역할을 하는 클래스를 정의한다.

public class DatabaseClearExtension implements AfterEachCallback {

    @Override
    public void afterEach(ExtensionContext context) throws Exception {
        DatabaseCleaner databaseCleaner = getDataCleaner(context);
        databaseCleaner.clear();
    }

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

 

테스트 클래스에 @ExtensionWith(···) 어노테이션을 추가해 데이터베이스를 초기화한다.

@ExtendWith(DatabaseClearExtension.class)
@SpringBootTest
class OrderUseCaseTest {

    @Autowired
    private OrderUseCase orderUseCase;

    // ...

    @BeforeEach
    void initData() {
        userService.create(user);
        productService.create(product);
        bidService.create(bid);
    }

    @Test
    @DisplayName("판매 입찰에 대한 구매 입찰과 주문을 생성한다")
    void succeed_to_create_order() throws InterruptedException {
        ...
    }

    User user;
    Product product;
    Bid bid;
}

 

 

 

📚 참고

테스트 데이터 초기화에 @Transactional 사용하는 것에 대한 생각

[Spring] AOP와 @Transactional의 동작 원리

[JPA] @Transactional 과 동시성

테스트 코드 - 멀티쓰레드 환경의 트랜잭션

스레드를 사용한 테스트에서 @Transactional을 사용하면 테스트가 실패하는 이유

테스트별로 DB 초기화하기