Spring Boot

Spring Boot 단위 테스트(Unit Test) 따라하기

Pro.Dev 2025. 1. 8. 15:12
반응형

단위 테스트(Unit Test) 따라하기: Spring Boot 기준

단위 테스트(Unit Test)는 애플리케이션의 개별 구성 요소(클래스 또는 메서드)를 독립적으로 검증하는 데 초점을 맞춥니다. 이 가이드는 단위 테스트를 단계별로 따라할 수 있도록 작성되었습니다.


1. 단위 테스트를 위한 준비

  1. Spring Boot 프로젝트 생성
    • Spring Initializr(https://start.spring.io)를 사용하여 프로젝트를 생성합니다.
    • spring-boot-starter-test 의존성을 추가합니다.

Maven 의존성:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>
  1. 테스트 환경 설정 확인
    • src/test/java 디렉토리 아래에 테스트 코드를 작성합니다.

2. 간단한 서비스 클래스 생성

테스트할 예제 클래스를 작성합니다.

MyService.java:

public class MyService {
    public int add(int a, int b) {
        return a + b;
    }

    public String greet(String name) {
        return "Hello, " + name + "!";
    }
}

3. JUnit 5를 사용한 단위 테스트 작성

MyServiceTest.java:

import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.*;

public class MyServiceTest {

    private final MyService myService = new MyService();

    @Test
    public void testAdd() {
        int result = myService.add(2, 3);
        assertEquals(5, result, "2 + 3은 5여야 합니다.");
    }

    @Test
    public void testGreet() {
        String greeting = myService.greet("John");
        assertEquals("Hello, John!", greeting, "인사 메시지가 올바르지 않습니다.");
    }
}

코드 설명:

  • @Test: JUnit 5에서 테스트 메서드를 정의할 때 사용합니다.
  • assertEquals(expected, actual): 기대값과 실제값이 동일한지 검증합니다.
  • 테스트 메서드 이름은 테스트하려는 동작에 맞게 직관적으로 작성합니다.

4. 테스트 실행

  1. IDE에서 실행

    • IntelliJ IDEA 또는 Eclipse에서 테스트 클래스 파일을 우클릭하고 Run을 선택합니다.
  2. CLI에서 실행

    • Maven: mvn test
    • Gradle: gradle test

5. 실패한 테스트 분석

테스트가 실패하면 실패 원인을 분석합니다.

예제:

Expected :6
Actual   :5
  • 실패 원인을 확인하고 코드를 수정한 후 테스트를 다시 실행합니다.

6. Mock 객체를 사용한 단위 테스트

외부 의존성을 격리하기 위해 Mock 객체를 사용합니다. 이를 통해 독립적인 테스트를 수행할 수 있습니다.

MyService와 외부 의존성 추가:

public class MyService {
    private final MyRepository myRepository;

    public MyService(MyRepository myRepository) {
        this.myRepository = myRepository;
    }

    public String fetchData() {
        return myRepository.getData();
    }
}

interface MyRepository {
    String getData();
}

Mock 객체를 사용한 테스트:

import org.junit.jupiter.api.Test;
import org.mockito.Mockito;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.Mockito.when;

public class MyServiceWithMockTest {

    @Test
    public void testFetchData() {
        MyRepository mockRepository = Mockito.mock(MyRepository.class);
        when(mockRepository.getData()).thenReturn("Mock Data");

        MyService myService = new MyService(mockRepository);
        String result = myService.fetchData();

        assertEquals("Mock Data", result);
    }
}

코드 설명:

  • Mockito.mock: Mock 객체를 생성합니다.
  • when(...).thenReturn(...): 특정 메서드 호출에 대한 반환 값을 설정합니다.

7. 테스트 코드 작성 팁

  1. 단일 동작 테스트

    • 각 테스트 메서드는 하나의 동작만 검증해야 합니다.
  2. 명확한 테스트 이름

    • 테스트 메서드 이름은 테스트하려는 동작을 설명해야 합니다.
  3. 독립적 테스트

    • 각 테스트는 다른 테스트에 영향을 받지 않도록 독립적으로 작성합니다.

8. 마무리

단위 테스트는 애플리케이션의 품질을 보장하는 중요한 과정입니다. 위의 단계를 따라 Spring Boot 프로젝트에서 단위 테스트를 쉽게 작성하고 실행해 보세요. Mock 객체를 활용하면 복잡한 의존성을 가진 클래스도 효율적으로 테스트할 수 있습니다.

반응형