[Testing] Mockito

📌 개인적인 공간으로 공부를 기록하고 복습하기 위해 사용하는 블로그입니다.
정확하지 않은 정보가 있을 수 있으니 참고바랍니다 :😸
[틀린 내용은 댓글로 남겨주시면 복받으실거에요]

Mockito

✅ Mock 객체를 사용하지 않은 슬라이스 테스트 프로세스

✅ Mock 객체를 사용한 슬라이스 테스트 프로세스

Mockito란?

• Spring Framework 자체적으로도 지원하고 있는 Mocking 라이브러리 → Mockito
• Mock 객체를 생성하고, 해당 Mock 객체가 진짜처럼 동작하게 하는 역할을 담당
• Mockito의 Mocking 기능을 이용해서 테스트하고자 하는 대상에서
  다른 영역(다른 계층 또는 외부 통신이 필요한 서비스 등)을 단절시켜 오로지 테스트 대상에만 집중 가능

슬라이스 테스트에 Mockito 적용

@Test
void postMemberTest() throws Exception {
    // given
    //MemberDto.Post 객체를 생성하여 테스트에 사용할 데이터를 설정
    MemberDto.Post post = new MemberDto.Post("jerry@gmail.com","제리","010-1111-1111");
    
    // 생성된 MemberDto.Post 객체를 Member 객체로 변환합니다.
    Member member = mapper.memberPostToMember(post);
    
	  // 변환된 Member 객체에 ID를 설정
	  //왜냐면 createMember에서 Id를 리턴해주고
    // Id가 response에서도 Location header에 포함이되어야 함
    
    member.setMemberId(1L);

    // memberService.createMember 메서드가 
    //어떤 Member 객체를 받더라도 미리 설정한 member 객체를 반환하도록 mock 설정
    given(memberService.createMember(Mockito.any(Member.class)))
            .willReturn(member);

    // post 객체를 JSON 문자열로 변환
    String content = gson.toJson(post);

    // when ->  /v11/members에 POST 요청을 보내기
    ResultActions actions = mockMvc.perform(post("/v11/members")
            .accept(MediaType.APPLICATION_JSON) // 응답을 JSON 형식으로 받겠다는 의미.
            .contentType(MediaType.APPLICATION_JSON) // 요청 본문이 JSON 형식이라는 것
            .content(content)); // 요청 본문에 변환된 JSON 문자열을 포함시킨다.

    // then: 결과를 검증하는 부분
    actions.andExpect(status().isCreated())
            // 응답 헤더의 Location 값이 "/v11/members/"로 시작하는지 확인
            .andExpect(header().string("Location", is(startsWith("/v11/members/"))));
}

1. @MockBean
   • Application Context에 등록되어 있는 Bean에 대한 Mockito Mock 객체를 생성하고 주입해 주는 역할을 한다
     → @MockBean 애너테이션을 필드에 추가하면 해당 필드의 Bean에 대한 Mock 객체를 생성한 후,
     필드에 주입(DI)한다..
   • 예제 코드에서는 MemberService 빈에 대한 Mock 객체를 생성해서 memberService 필드에 주입한다.
2. MemberMapper
   • DI 받는 이유는 MockMemberService(가칭)의 createMember()에서 리턴하는 Member 객체를 생성하기 위함
     → post(MemberDto.Post 타입) 변수를 Member 객체로 변환
   • new Member()와 같이 Member 객체를 생성해도 되지만 post 변수를 재사용하기 위해 MemberMapper로 변환 함.
   • 실제 createMember()의 리턴 값(Member 객체)에는 memberId가 포함이 되는데
     이 memberId는 response의 Location header에 포함이 되어야 하므로 MockMemberService(가칭)의 createMember()에서도
     memberId를 리턴해 줄 수 있도록 memberId를 추가함.

3. Stubbing 메서드(Mockito에서 지원)

   1. 🤔Stubbing이란? - 테스트를 위해서 Mock 객체가 항상 일정한 동작을 하도록 지정하는 것을 의미

   2. given()은 Mock 객체가 특정 값을 리턴하는 동작을 지정하는 데 사용하며,
      Mockito에서 지원하는 when()과 동일한 기능을 합니다.

      여기서는 Mock 객체인 memberService 객체로 createMember() 메서드를 호출하도록 정의하고 있고 , 파라미터인 Mockito.any(Member.class)는 Mockito에서 지원하는 변수 타입 중 하나이다.
      파라미터는 실제 메서드에서 들어가는 파라미터의 타입을 지정해주면 되는데 Mockito.any( )에 감싸서 넣어주면 됨.

      • 객체일 경우는 상기 코드처럼 Mockito.any(객체명.class)
      • long type의 경우 Mockito.anyLong()
      • int type의 경우 Mockito.anyInt()
      • String type의 경우 Mockito.anyString()

   3. .willReturn(member)

      MockMemberService(가칭)의 createMember() 메서드가 리턴할 Stub 데이터

   4. Debugging 하고 memberService를 보면 MockitpMock으로 가짜 객체가 들어와있다.

      

      

서비스 단위테스트에 Mockito 적용

• 일반적으로 비즈니스 로직은 데이터 액세스 계층과는 무관하게 서비스 계층에 구현된 비즈니스 로직 자체를 Spring Framework의 도움을 받지 않고도 빠르게 테스트를 진행할 수 있어야한다.

package com.springboot.member.service;

import com.springboot.exception.BusinessLogicException;
import com.springboot.member.entity.Member;
import com.springboot.member.repository.MemberRepository;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.junit.jupiter.MockitoExtension;

import java.util.Optional;

import static org.junit.jupiter.api.Assertions.*;
import static org.mockito.BDDMockito.given;

// 단위 테스트에서 Mockito를 사용할 때 필요한 어노테이션 
//MockitoExtension 기능을 확장하겠다는 의미
@ExtendWith(MockitoExtension.class) 
class MemberServiceMockTest {
    @Mock  // MockBean과는 다름. 스프링 컨테이너의 도움이 필요 없어서 사용
    private MemberRepository memberRepository;

    @InjectMocks 
    // 테스트해야 할 객체에 주입해야 한다. 
    //가짜 Repository를 의존하는 서비스를 주입하는 것.
    private MemberService memberService;

    @Test
    public void createMemberTest(){
        // given
        
        // 새로운 Member 객체를 생성하여 테스트 데이터로 사용합니다.
        Member member = new Member("jerry@gmail.com", "제리", "010-4111-1111");

        // when
        
        // memberRepository의 findByEmail 메서드가 어떤 문자열을 매개변수로 받아도, 
        //항상 Optional.of(member)를 반환하도록 설정합니다.
        given(memberRepository.findByEmail(Mockito.anyString())).willReturn(Optional.of(member));

        // then
        
        // createMember 메서드를 호출했을 때 BusinessLogicException 예외가 발생하는지 확인
        // 이 테스트는 이메일이 중복되는 경우 예외가 발생하는지를 확인하는 테스트
        assertThrows(BusinessLogicException.class, () -> memberService.createMember(member));
    }
}

• memberRepository Mock 객체로 Stubbing을 하고 있음.

  memberRepository.findByEmail(Mockito.anyString())의 리턴 값으로
  Optional.of(member)를 지정했기 때문에 테스트 케이스를 실행하면 결과는 “passed”이다.

• Optional.of(member)의 member 객체에 포함된 이메일 주소가 memberService.createMember(member)에서
  파라미터로 전달한 member 객체에 포함된 이메일 주소와 동일하기 때문에 검증 결과가 “passed”

Comment

처음에 수업이 너무 빠르게 진행되서 이해를 못해서 코드에 하나 하나 주석달고 물어보고해서 조금 이해되었는데
막상 또 쓰려고 하면 다 단절 시키고 해야하니까 어떻게 테스트를 해야하는 건지는 아직 잘 모르겠다..
특히 컨트롤러의 경우에는 컨트롤러의 기능만 테스트하는 것이기 때문에
비즈니스 로직을 진행할 필요가 없고 응답과 요청이 잘 진행되는지를 테스팅 하는 것이라고 한다….!
회사에서도 주니어분들은 어려워서 Mockito를 잘 안한다고 그만큼 어렵고 힘든거 맞으니까
몇시간이라도 이해하고 노력하는 것이 중요하다고 하셔서 열심히 봐야겠다👍

Spring 카테고리 내 다른 글 보러가기