인수 테스트 격리하는 방법

테스트 코드를 짜서 하나씩 실행했을 때 문제가 없었는데 한 번에 동작시키니 오류가 발생했습니다.😥

순서도 보장되지 않고 독립적으로 수행되고 있지 않았던 것 같군요...

실행 실패 결과

테스트는 서로 순서에 상관없이 모두 독립적으로 동작할 수 있도록 짜여있어야 합니다.

이 부분을 잊고 테스트 코드를 작성한 것이 문제였던 것 같아 인수 테스트 격리하는 방법들을 적용해 보며 정리해 보겠습니다.🙂

 

@DirtiesContext

@DirtiesContext 어노테이션은 Spring Framework에서 테스트 격리를 위해 사용됩니다.

이 어노테이션을 사용하면 테스트가 실행된 후 테스트 컨텍스트를 "더럽게"만들어 다음 테스트에서 새로운 컨텍스트를 사용하도록 할 수 있습니다.

 

아래의 classMode는 아래와 같은 종류가 있습니다. 적용하실 때 클래스 단위로 격리가 필요한지, 메서드 단위로 격리가 필요한지 고려하여 선택하는 것이 좋을 것 같습니다.

classMode	description
AFTER_CLASS	테스트 클래스의 모든 테스트가 완료된 후 컨텍스트를 초기화해야 할 때
AFTER_EACH_TEST_METHOD	각 테스트 메서드 후에 컨텍스트를 초기화하여 완전한 격리를 보장해야 할 때
BEFORE_CLASS	테스트 클래스 실행 전에 특정 초기 상태로 컨텍스트를 설정해야 할 때
BEFORE_EACH_TEST_METHOD	각 테스트 메서드 전에 특정 초기 상태로 컨텍스트를 설정해야 할 때

 

직접 적용해 보겠습니다. 

(저는 모든 메서드가 격리되어 실행되기를 원하기 때문에 BEFORE_EACH_TEST_METHOD라는 ClassMode를 선택하였습니다.)

적용 코드

테스트 결과

테스트 결과를 확인해 보니 모든 메서드를 격리하여 실행이 올바르게 되는 것을 확인하였습니다.

하지만 @DirtiesContext 사용을 권장드리고 싶지는 않습니다. 컨텍스트를 모든 테스트 마다 초기화하면 성능에 영향이 있습니다.

그리고 컨텍스트를 매번 다시 초기화하기 때문에 시간에도 영향을 미치게 됩니다.

간단하게 어노테이션만 추가하면 되는 방법이지만 권장드리는 방법은 아닙니다.

 

truncate를 활용한 DataBaseCleaner 설정

테스트가 끝날 때마다 데이터베이스를 초기화하는 방법입니다.

주로 전체 테이블을 지우고, 테스트가 종료된 후 데이터를 다시 채웁니다.

// 데이터베이스 초기화해주기위한 클래스
public class DatabaseCleaner {

    @Autowired
    private DataSource dataSource;

    public void clean() {
        try (Connection conn = dataSource.getConnection()) {
            Statement stmt = conn.createStatement();
            stmt.execute("TRUNCATE TABLE movie");
        } catch (SQLException e) {
            throw new RuntimeException(e);
        }
    }
}

// 테스트 클래스에서 @BeforeEach 또는 @AfterEach 어노테이션을 활용하여 테스트 전후에 테이터베이스를 정리
   @Autowired
    private DatabaseCleaner databaseCleaner;

    @BeforeEach
    public void setUp() {
        databaseCleaner.clean();
    }

 

위와 같은 방법으로 적용이 가능합니다.

저는 Embedded MongoDB를 활용하여 테스트를 적용하여 아래와 같이 DatabaseCleaner를 생성했습니다.

적용한 코드

실행 결과

해당 방법도 테스트 격리가 올바르게 적용된 것을 확인하였습니다.

이 방법은 모든 테스트가 독립적으로 실행되며, 이전 테스트의 데이터가 다음 테스트에 영향을 미치지 않습니다.

하지만 데이터베이스를 매번 초기화하므로 큰 데이터셋에서는 성능 저하가 발생할 수 있습니다.

 

@Sql을 활용한 sql문 미리 작성하기

@Sql 어노테이션을 사용하면 테스트 실행 전에 SQL 스크립트를 실행하여 데이터베이스 상태를 설정할 수 있습니다.

@Sql(scripts = "/test-schema.sql")
@Sql(scripts = "/test-data.sql")
@Test
public void test() {
    // 테스트 로직
}

위와 같은 방식으로 적용이 가능합니다.

 

저는 Embedded MongoDB를 활용하고 있어 아래와 같이 beforeEach를 활용하여 데이터베이스 상태를 설정해 보았습니다.

적용한 코드

실행결과

해당 방법도 적용해 보았을 때 테스트 격리가 가능하였습니다.

데이터베이스를 정확하게 원하는 상태로 설정할 수 있다는 장점이 있었으나 테스트에 필요한 더미 데이터를 확인 및 생성하려면 SQL파일이나 BeforeEarch의 코드를 매번 확인해줘야 합니다. 그리고 테이블이나 컬럼이 변경될 때마다 업데이트해줘야 하는 번거로움이 있을 수 있습니다. 

 

@TestExecutionListeners

JUnit 테스트에서 다양한 단계의 실행 시점에 특정 작업을 수행할 수 있는 도구입니다.

이 어노테이션을 사용하면 테스트의 실행 전후로 커스터마이즈 된 동작들을 정의할 수 있습니다

 

TestExecutionListener 인터페이스

beforeTestClass	테스트 클래스가 실행되기 전에 호출됩니다.
prepareTestInstance	테스트 인스턴스가 생성되고 난 후 호출됩니다.
beforeTestMethod	테스트 메서드가 실행되기 전에 호출됩니다.
afterTestMethod	테스트 메서드가 실행된 후 호출됩니다.
afterTestClass	테스트 클래스의 모든 메서드가 실행된 후 호출됩니다.

해당 어노테이션을 사용하면 테스트 메서드 실행 전 데이터베이스 초기화, 테스트 메서드 실행 후 리소스 정리, 테스트 실행 전 데이터 베이스 상태 확인, 테스트 실행 전 특정 데이터 삽입과 같은 방식을 모두 사용 가능할 것으로 보입니다.

 

TestExecutionListener 인터페이스를 구현해 보겠습니다.

코드 작업

코드 작업

테스트 결과

위의 방법으로도 격리가 가능합니다.

클래스 및 메서드 수준에서 세밀하게 조정이 가능합니다. 하지만 테스트 단계에 맞춘 초기화, 로직을 작성해야 할 수 있습니다.

 

 

각 방법은 특정 상황에서 유용할 수 있으며, 프로젝트의 요구 사항에 따라 적절한 방법을 선택하는 것이 중요합니다
이러한 방법들을 조합하여 사용하면, 테스트의 신뢰성과 성능을 모두 향상할 수 있습니다.