@TempDir 활용해서 파일 테스트 코드 작성하기

🤔 배경

외부 서비스에서 매일 특정 시간에 배치를 통해 전달되는 csv 파일을 읽는 배치 프로그램을 구현한 뒤, 파일 읽는 부분을 검증하기 위해 단위 테스트 코드를 작성하려고 하는데..

 

파일 관련 테스트 코드는 처음이라 "파일은 어떻게 반복적인 테스트 코드를 작성해야 될까?"라는 고민을 하게 되었고, 관련 내용을 찾아보며 알게 된  @TempDir이라는 걸 활용해 보게 되었다.

 

해당 경험을 바탕으로 @TempDir을 통한 테스트 코드 작성 법에 대해 공유해보고자 한다.

1. @TempDir 이란

- Junit에서 지원하는 임시 디렉터리를 생성용 테스트 어노테이션

- 개별 테스트 또는 테스트 클래스의 모든 테스트에 대해 임시 디렉터리를 만들고 정리할 수 있다.

- 테스트할 때 직접 파일을 생성하고 삭제하는 과정을 관리하는 번거로움을 제거해 준다.

2. 주의사항

@TempDir은 두 가지 타입만 지원한다.

 

(1) java.nio.file.Path

(2) java.io.File

 

다른 타입으로 사용하는 경우 ParameterResolutionException 예외를 발생시킨다.

3. 사용 방법

public class TempFileTest {

    @Getter
    @Builder
    public static class CsvFile {

        private int id;
        private String name;
        private String type;
    }

    @Test
    @DisplayName("1. Path 형식으로 읽기")
    void simpleTestTempDirByPath(@TempDir Path tempDir) throws IOException {
        // given
        Path fileDir = tempDir.resolve("test.csv");
        List<String> lines = List.of("1,흑시바,블로그", "2,백시바,카페");
        Files.write(fileDir, lines);

        // when
        List<CsvFile> records = readCsvFile(fileDir.toFile());

        // then
        assertThat(records).hasSize(2)
                .extracting("id", "name", "type")
                .contains(tuple(1, "흑시바", "블로그"), tuple(2, "백시바", "카페"));
    }

    @TempDir File tempFile;

    @Test
    @DisplayName("2. File 형식으로 읽기")
    void simpleTestTempDirByFile() throws IOException {
        // given
        File testFile = new File(tempFile, "simpleTest.txt");
        List<String> lines = List.of("1,흑시바,블로그", "2,백시바,카페");
        Files.write(testFile.toPath(), lines);

        // when
        List<CsvFile> records = readCsvFile(testFile);
        // then
        assertThat(records).hasSize(2)
                .extracting("id", "name", "type")
                .contains(tuple(1, "흑시바", "블로그"), tuple(2, "백시바", "카페"));
    }

    private List<CsvFile> readCsvFile(File fileDir) throws IOException {
        List<CsvFile> records = new ArrayList<>();
        try (BufferedReader br = new BufferedReader(new FileReader(fileDir))) {
            String line;
            while ((line = br.readLine()) != null) {
                String[] values = line.split(",");
                records.add(CsvFile.builder()
                        .id(Integer.parseInt(values[0]))
                        .name(values[1])
                        .type(values[2])
                        .build());
            }
        }
        return records;
    }
}

위 테스트 코드 예시처럼 Path 또는 File에 @TempDir 주석과 함께 작성하면 된다.

파라미터 또는 필드 형식을 사용하는 것은 작성자 자유이다.

 

- 만약 테스트끼리 파일/디렉터리를 공유하고 싶다면,

 

필드 방식 + static을 선언해서 작성하면 된다. 단, 테스트는 순서가 보장되지 않기 때문에 만약 연속성 있는 테스트를 작성하는 경우 @Order을 사용하여 순서를 일관되게 유지시키는 게 중요하다.

 

- JUnit 5.9 버전부터 @TempDir에는 cleanup이라는 옵션을 제공한다.

 

해당 옵션은 3가지 기능을 설정할 수 있다.

 

ALWAYS: 테스트가 완료된 후, 임시 디렉터리 정리 (기본 설정)
NEVER: 테스트가 완료된 후, 임시 디렉터리 정리 X
ON_SUCCESS : 테스트가 성공적으로 완료된 경우에만 임시 디렉터리를 정리

 

만약 임시로 생성한 디렉터리, 파일을 유지하도록 구현하고 싶다면 REFERENCE를 참고해 보자.

REFERENCE

https://www.baeldung.com/junit-5-temporary-directory