Mockito.mock(), @Mock과 @MockBean의 차이점

테스트가 너무 무겁고 귀찮아요 😮‍💨

데이터베이스 같은 외부 환경과 함께 동작하는 어플리케이션을 테스트하기란 참 어려운 일이다.

비즈니스 로직이 있는 서비스에서 로직에 맞게 제대로 동작하는지를 테스트하고 싶은데,

테스트를 하기 위해서 데이터베이스 연결부터 필요한 데이터들을 넣어놓는 등등 기타 설정들을 하는데 더 많은 시간을 들여야한다.

또 테스트에 데이터베이스가 관여하면서 부터는, 테스트 후에 데이터를 지워주는 등 후처리를 제대로 하지 않아서 전체 테스트를 돌렸을 때 예상치 못하게 테스트에 실패하는 경험을 많이 해봤을 것이다.

 

이러한 문제를 해결하기 위해 테스트 더블(Test Double)이라는 개념이 나왔다.

xUnit Test Patterns의 저자인 제라드 메스자로스(Gerard Meszaros)가 만든 용어로 테스트를 진행하기 어려운 경우 이를 대신해 테스트를 진행할 수 있도록 만들어주는 객체를 말한다.

테스트 더블의 종류는 여러가지이지만, 내가 사용해본 Mock에 대해서 정리해보려고 한다.

Mock이 뭐야?

Mock은 "테스트를 수행할 모듈과 연결되는 외부의 다른 서비스나 모듈들을 실제 사용하는 모듈을 사용하지 않고 실제의 모듈을 "흉내"내는 "가짜" 모듈을 작성하여 테스트의 효용성을 높이는데 사용하는 객체" 라고 한다.

 

그냥 간단하게 테스트 시 아직 구현이 되지 않았거나 테스트 하기 어렵고, 불필요한 객체를 가짜 객체(Mock)로 바꿔치기 한다고 생각하면 된다.

예를 들어, 데이터베이스와 연결되는 객체를 가짜 객체로 바꾸고, 그 객체의 행동을 원하는대로 지정하여 테스트를 편리하게 할 수 있다.

 

💡 Mock을 사용하는 방법

Mock을 사용하는 방법에는 3가지가 있다.

• Mockito.mock()
• @Mock
• @MockBean

위의 방법의 차이점을 모르고 사용했었다. 그런데 언제 어떤 것을 사용해야 할지는 알고써야 하지 않을까 🤨

테스트에 하나씩 적용해보면서 차이점을 알아보자.

 

✅ 테스트할 서비스 로직

@Service
public class GameService {

    private final GameRepository gameRepository;

    public GameService(GameRepository gameRepository) {
        this.gameRepository = gameRepository;
    }

    public List<GameResult> findAllGameResult() {
        List<GameResult> gameResultList = gameRepository.findAllGame();
        if (gameResultList.size() == 0) {
            throw new EmptyGameException();
        }
        return gameResultList;
    }
}

위와 같이 GameService가 있고, GameService는 GameRepository에 의존한다.

findAllGameResult()를 보면, 데이터베이스에서 현재 저장된 게임 목록들을 가져와서 반환해주는데, 이때 게임이 아무것도 없는 경우 EmtpyGameException 예외를 던진다.

게임 결과가 존재하지 않으면 예외를 던진다는 설정은 비즈니스 로직을 어떻게 테스트할 지를 잘 보여주기 위해 극단적인 예시를 들었다.

 

그리고 중요하진 않지만, 반환값으로 사용되는 GameResult는 아래와 같다.

public class GameResult {

    private final int gameId;
    private final boolean win;

    private GameResult(int gameId, boolean win) {
        this.gameId = gameId;
        this.win = win;
    }

    public static GameResult of(int gameId, boolean win) {
        return new GameResult(gameId, win);
    }
    
    // getter ...
}

 

✅  테스트 해야 할 부분

1. gameRepostitory.findAllGame()을 통해 데이터베이스에서 게임 결과를 받아 List<GameResult>를 제대로 반환하는지
2. 데이터베이스에서 게임 결과를 반환받지 못하면(게임 결과가 존재하지 않으면) EmptyGameException을 던지는지

 

1. Mockito.mock()

Mockito 프레임워크를 사용한다.

public class GameServiceTest {

    private GameService gameService;
    
    @Test
    public void findAllGameResultTest() {
    	// Mockito.mock()을 사용하여 Mock 객체 생성
        GameRepository gameRepository = Mockito.mock(GameRepository.class);
        gameService = new GameService(gameRepository);
    }
}

GameService에 GameRepository를 주입해주어야 하는데, 이때 Mock 객체를 만들어서 주입해준다.

그리고 나서 다음과 같이 GameRepository의 메서드의 행동을 정할 수 있다.

public class GameServiceTest {

    private GameService gameService;
    private GameRepository gameRepository;

    @BeforeEach
    void setUp() {
        gameRepository = Mockito.mock(GameRepository.class);
        gameService = new GameService(gameRepository);
    }

    @Test
    @DisplayName("게임이 존재할 경우 게임 결과를 반환한다.")
    public void findAllGameResultTest() {
        List<GameResult> gameResultList = List.of(
                GameResult.of(1, true)
        );

	// gameRepository의 findAllGame() 메서드 호출 시 gameResultList를 반환하도록 지정
        Mockito.when(gameRepository.findAllGame())
                .thenReturn(gameResultList);

        List<GameResult> allGameResult = gameService.findAllGameResult();
        assertAll(
                () -> assertThat(allGameResult.get(0).getGameId()).isEqualTo(1),
                () -> assertThat(allGameResult.get(0).isWin()).isTrue()
        );
    }

    @Test
    @DisplayName("게임이 존재하지 않는 경우 예외를 던진다.")
    public void findAllGameResultTest_Exception() {
        List<GameResult> gameResultList = new ArrayList<>();

        Mockito.when(gameRepository.findAllGame())
                .thenReturn(gameResultList);

        assertThatThrownBy(() -> gameService.findAllGameResult())
                .isInstanceOf(EmptyGameException.class);
    }
}

그리고 테스트가 성공한 것을 볼 수 있다.

2. @Mock

Mockito는 어노테이션도 지원한다. 

Mockito.mock() 대신 필드에 @Mock 어노테이션을 붙이면 된다.

여기서 주의할 점은 클래스에 @ExtendWith(MockitoExtension.class)를 붙여주어야 한다.

그래야 @Mock 어노테이션이 붙은 객체를 찾아 Mock 객체를 생성할 수 있다.

@ExtendWith(MockitoExtension.class)
public class GameServiceTest {

    private GameService gameService;
    
    @Mock
    private GameRepository gameRepository;
    
    @Test
    public void findAllGameResultTest() {
        gameService = new GameService(gameRepository);
    }
}

3. @MockBean

@MockBean이라는 어노테이션도 있다.

얼핏보면 @Mock 과 비슷해보인다. 

 

과연 차이점이 무엇일까?

일단 MockBean은 경로가 Mock과 다르다.

import org.springframework.boot.test.mock.mockito.MockBean;

위의 경로를 보면 알 수 있듯이, @MockBean은 @Mock과 같은 역할을 하는데 스프링 영역에서 동작한다. 

스프링은 의존 객체를 자동으로 주입하는데, 

이때 @MockBean 어노테이션이 붙은 객체를 Mock 객체로 스프링 컨테이너에 등록한다.

그래서 현재 GameServiceTest는 스프링 환경의 테스트가 아니기 때문에 아래와 같이 @MockBean을 붙여준다고 해도 제대로 동작하지 않는다. 

Mock으로 만들어지지도 않을 뿐더러, 자동으로 의존 객체를 주입해주지 않기 때문이다.

그래서 당연히 NullPointerException이 터진다.

아래 코드와 같이 @SpringBootTest를 붙여 실행하니 테스트는 성공한다.

@SpringBootTest
public class GameServiceTest {

    @MockBean
    private GameRepository gameRepository;
    
    @Autowired
    private GameService gameService;
	
    // Test 생략
}

결론은 @MockBean은 스프링 환경의 테스트에서 사용해야한다!

 

4. 결론

이렇게 Mock의 사용 방법을 알아보았다. 

Mock을 사용하니 데이터베이스 영역까지 가지 않고 비즈니스 로직에 초점을 맞춰 테스트할 수 있게 되었다.

 

이제는 테스트를 작성할 때 스트레스를 덜 받을 수 있겠다 😁

Mockito 프레임워크의 메서드 사용방법에 대해서는 설명하지 않았는데, 나도 아직 잘 모르기 때문이다..

차차 사용해보면서 공부할 예정이다.

---

[참고 자료]

https://cobbybb.tistory.com/16#4.1%20SpringBootTest%20%EB%AC%B8%EC%A0%9C%20%EC%98%81%EC%97%AD%20%3A%20%40Autowired-1

Mockito @Mock @MockBean @Spy @SpyBean 차이점

https://stackoverflow.com/questions/44200720/difference-between-mock-mockbean-and-mockito-mock

Difference between @Mock, @MockBean and Mockito.mock()