[6/26 TIL] SPRING(JUnit, Mock, Spring의 JUnit)

🍃프로그래머스 백엔드 데브코스 4기 교육과정을 듣고 정리한 글입니다.🍃

JUnit

• 매 단위(메서드, 클래스) 테스트시마다 테스트 클래스의 인스턴스가 생성되어 독립적인 테스트가 가능하게 함
• 애노테이션을 제공해서 테스트 라이프 사이클을 관리하게 해주고 테스트 코드를 간결하게 작성하도록 지원
• assert로 테스트 케이스의 수행 결과를 판별 → assertEquals(예상 값, 실제 값)
• 결과는 성공(녹색), 실패(붉은색) 중 하나로 표시

JUnit5 모듈

• JUnit Platform
  • JVM 상에 테스팅 프레임워크를 런칭하기 위한 근간을 제공
  • TestEngine 인터페이스를 통해서 테스트를 실행하고 ,결과를 보고
• JUnit Jupiter
  • JUnit 5에 새롭게 추가된 테스트 코드용 API로서, TestEngine의 실제 구현체
• JUnit Vintage
  • 기존에 JUnit 4 버전으로 작성한 테스트 코드를 실행할 때 사용하는 TestEngine의 실제 구현체
    출처: Architectural building blocks of JUnit5

예시 코드

class CalculatorTest {

    private Calculator calculator;

    @BeforeEach
    void setUp() {
        calculator = new Calculator();
    }

    @Test
    @DisplayName("두 수를 더할 수 있어야 한다.")
    void shouldAddTwoNumbers() {
        // given
        int a = 5;
        int b = 3;

        // when
        int result = calculator.add(a, b);

        // then
        assertThat(result).isEqualTo(8);
    }

    @Test
    @DisplayName("두 수를 뺄 수 있어야 한다.")
    void shouldSubtractTwoNumbers() {
        // given
        int a = 5;
        int b = 3;

        // when
        int result = calculator.subtract(a, b);

        // then
        assertThat(result).isEqualTo(2);
    }

    @Test
    @DisplayName("두 수를 곱할 수 있어야 한다.")
    void shouldMultiplyTwoNumbers() {
        // given
        int a = 5;
        int b = 3;

        // when
        int result = calculator.multiply(a, b);

        // then
        assertThat(result).isEqualTo(15);
    }

    @Test
    @DisplayName("두 수를 나눌 수 있어야 한다.")
    void shouldDivideTwoNumbers() {
        // given
        int a = 10;
        int b = 2;

        // when
        int result = calculator.divide(a, b);

        // then
        assertThat(result).isEqualTo(5);
    }

    @Test
    @DisplayName("0으로 나눌 경우 예외를 던져야 한다.")
    void shouldThrowExceptionWhenDividingByZero() {
        // given
        int a = 10;
        int b = 0;

        // when, then
        assertThatThrownBy(() -> calculator.divide(a, b))
                .isInstanceOf(ArithmeticException.class)
                .hasMessage("Divisor cannot be zero!");
    }
}

@Before(after)Each, @Before(after)All

• @Before(after)Each
  • 각 테스트 클래스의 메서드마다 실행 전(후)에 해당 어노테이션이 붙은 메서드 실행
  • @BeforeEach 어노테이션이 지정된 메서드는 static이 아님
  • 테스트 메서드마다 독립적으로 설정이 필요한 경우에 사용
• @Before(after)All
  • 테스트 클래스 실행 전(후)에 해당 어노테이션이 붙은 메서드가 한 번만 실행
  • @BeforeAll 어노테이션이 지정된 메서드는 static이어야 함
  • 여러 테스트 메서드에서 공통적으로 사용되는 리소스를 설정하는 데 사용
  • @TestInstance(TestInstance.Lifecycle.PER_CLASS) 설정하면 static 안붙여도 됨

class ExampleTest {

    @BeforeAll
    static void setUpAll() {
        // 테스트 클래스의 모든 테스트 메서드 실행 전에 한 번만 실행됨
        System.out.println("Before all tests");
    }

    @BeforeEach
    void setUp() {
        // 각 테스트 메서드 실행 전에 실행됨
        System.out.println("Before each test");
    }

    @Test
    void test1() {
        System.out.println("Test 1");
    }

    @Test
    void test2() {
        System.out.println("Test 2");
    }

    @AfterEach
    void tearDown() {
        // 각 테스트 메서드 실행 후에 실행됨
        System.out.println("After each test");
    }

    @AfterAll
    static void tearDownAll() {
        // 테스트 클래스의 모든 테스트 메서드 실행 후에 한 번만 실행됨
        System.out.println("After all tests");
    }
    
    //실행 결과
    Before all tests
	Before each test
	Test 1
	After each test
	Before each test
	Test 2
	After each test
	After all tests
}

Mock Object

그림 출처

• Test Double
  • 실제 의존성을 대체하는 객체
  • 테스트를 위해 실제 구현체 대신 사용되는 가짜 객체
• Mock
  • 사전에 기대하는 호출과 반환값을 정의하여 테스트를 수행
  • 특정 동작을 수행하는지 확인(메서드 호출, 매개변수, 반환)하는 행위 검증을 수행함
• Stub
  • 메소드가 수행된 후, 객체의 상태를 확인하여 올바르게 동작했는지를 확인하는 상태 검증을 수행함

Mock Object 생성 Test Framework

• Mockito
• JMock
• EasyMock

Mockito 예시 코드

class UserServiceTest {

    private UserService userService;
    
    @Mock
    private UserRepository userRepository;

    @BeforeEach
    void setUp() {
        MockitoAnnotations.openMocks(this);
        userService = new UserService(userRepository);
    }

    @Test
    @DisplayName("새로운 사용자를 생성할 수 있어야 한다.")
    void shouldCreateNewUser() {
        // given
        User user = new User("john.doe@example.com", "password123");
        when(userRepository.save(user)).thenReturn(true);

        // when
        boolean result = userService.createUser(user);

        // then
        assertThat(result).isTrue(); // 생성 결과가 true인지 확인
        verify(userRepository).save(user); // userRepository.save() 메서드가 호출되었는지 검증
    }

    @Test
    @DisplayName("기존 사용자를 조회할 수 있어야 한다.")
    void shouldRetrieveExistingUser() {
        // given
        String email = "john.doe@example.com";
        User existingUser = new User(email, "password123");
        when(userRepository.findByEmail(email)).thenReturn(existingUser);

        // when
        User result = userService.getUserByEmail(email);

        // then
        assertThat(result).isNotNull(); // 조회된 사용자가 null이 아닌지 확인
        assertThat(result).isEqualTo(existingUser); // 조회된 사용자가 예상한 사용자와 동일한지 확인
        verify(userRepository).findByEmail(email); // userRepository.findByEmail() 메서드가 호출되었는지 검증
    }

    @Test
    @DisplayName("사용자를 삭제할 수 있어야 한다.")
    void shouldDeleteUser() {
        // given
        String email = "john.doe@example.com";
        when(userRepository.deleteByEmail(email)).thenReturn(true);

        // when
        boolean result = userService.deleteUserByEmail(email);

        // then
        assertThat(result).isTrue(); // 삭제 결과가 true인지 확인
        verify(userRepository).deleteByEmail(email); // userRepository.deleteByEmail() 메서드가 호출되었는지 검증
    }
}

Spring의 JUnit 5

단위 테스트 지원

@SpringBootTest // Spring Boot 애플리케이션 컨텍스트를 로드하여 테스트
@SpringJUnitConfig(classes = {UserService.class, UserRepository.class}) // 테스트에 필요한 빈을 설정
@ActiveProfiles("test") // "test" 프로파일에 해당하는 빈이 로드됨
class UserServiceTest {

    @Autowired
    private UserService userService;

    @MockBean
    private UserRepository userRepository; // UserRepository의 MockBean을 주입

    @Test
    @DisplayName("새로운 사용자를 생성할 수 있어야 한다.")
    void shouldCreateNewUser() {
        // given
        User user = new User("john.doe@example.com", "password123");
        when(userRepository.save(user)).thenReturn(user);

        // when
        User result = userService.createUser(user);

        // then
        assertThat(result).isNotNull(); // 생성된 사용자가 null이 아닌지 확인
        assertThat(result.getEmail()).isEqualTo(user.getEmail()); // 생성된 사용자의 이메일이 예상한 이메일과 동일한지 확인
        verify(userRepository).save(user); // userRepository.save() 메서드가 호출되었는지 검증
    }

    @Test
    @DisplayName("기존 사용자를 조회할 수 있어야 한다.")
    void shouldRetrieveExistingUser() {
        // given
        String email = "john.doe@example.com";
        User existingUser = new User(email, "password123");
        when(userRepository.findByEmail(email)).thenReturn(existingUser);

        // when
        User result = userService.getUserByEmail(email);

        // then
        assertThat(result).isNotNull(); // 조회된 사용자가 null이 아닌지 확인
        assertThat(result.getEmail()).isEqualTo(email); // 조회된 사용자의 이메일이 예상한 이메일과 동일한지 확인
        verify(userRepository).findByEmail(email); // userRepository.findByEmail() 메서드가 호출되었는지 검증
    }

    @Test
    @DisplayName("사용자를 삭제할 수 있어야 한다.")
    void shouldDeleteUser() {
        // given
        String email = "john.doe@example.com";
        User existingUser = new User(email, "password123");
        when(userRepository.findByEmail(email)).thenReturn(existingUser);

        // when
        boolean result = userService.deleteUserByEmail(email);

        // then
        assertThat(result).isTrue(); // 삭제 결과가 true인지 확인
        verify(userRepository).delete(existingUser); // userRepository.delete() 메서드가 호출되었는지 검증
    }
}

통합 테스트 지원

통합테스트(MockMvc)는 다음 강의에서 정리

결론

• 단위 테스트는 최대한 스프링이 아닌, 순수 자바 코드로만 작성
  • 단위 테스트는 개별 모듈 또는 클래스의 동작을 독립적으로 테스트하는 것이 목표
  • 실행 속도가 빠르고 특정 프레임워크에 종속되지 않고, 격리된 환경에서 테스트 수행 가능
  • 순수 자바 코드로 작성된 테스트는 자동화 도구나 CI/CD 파이프라인에 쉽게 통합 가능
• 통합 테스트는 스프링이 제공하는 기능들을 활용
  • 실제 환경(Spring Bean)과 유사한 조건에서 테스트를 수행
  • 다양한 계층 간의 상호작용(컨트롤러)과 통합 검증
  • 데이터베이스, 외부 서비스 등과의 상호작용 검증