[The JAVA, 테스트] 2부. Mockito

[tonykang22]

2부. Mokito

1. Mockito 소개

• Mock : 진짜 객체와 비슷하게 동작하지만 프로그래머가 직접 그 객체의 행동을 관리하는 객체
• Mockito : Mock 객체를 쉽게 만들고 관리하고 검증할 수 있는 방법을 제공한다. (Mock을 지원하는 프레임워크)
• 대체제 : EasyMock, JMock

• 단위 테스트 : 정의는 개발자마다 다르다.
  • 단위 테스트는 모든 의존성을 끊고 작성되어야 한다는 경우. (mock을 사용해서 moking 해야한다는 의미)
  • 단위라는 것은 클래스나 오브젝트가 아닌 행동이라는 생각인 경우.
  • 참고 : https://martinfowler.com/bliki/UnitTest.html

2. Mockito 시작하기

• 스프링 부트 2.2+ 프로젝트 생성시 spring-boot-starter-test에서 자동으로 mockito 추가해준다.
• 스프링 부트를 쓰지 않는다면, 직접 의존성을 추가하면 된다.

  <dependency>
  <groupId>org.mockito</groupId>
  <artifactId>mockito-core</artifactId>
  <version>3.1.0</version>
  <scope>test</scope>
  </dependency>
  <dependency>
  <groupId>org.mockito</groupId>
  <artifactId>mockito-junit-jupiter</artifactId>
  <version>3.1.0</version>
  <scope>test</scope>
  </dependency>

• 다음 세 가지만 알면 Mock을 활용한 테스트를 쉽게 작성할 수 있다.
  1. Mock을 만드는 방법
  2. Mock이 어떻게 동작해야 하는지 관리하는 방법
  3. Mock의 행동을 검증하는 방법
• Mockito 레퍼런스
  • https://javadoc.io/doc/org.mockito/mockito-core/latest/org/mockito/Mockito.html

3. Mock 객체 만들기

• Mockito.mock() 메소드로 만드는 방법

  MemberService memberService = mock(MemberService.class);
  StudyRepository studyRepository = mock(StudyRepository.class);

• @Mock 애노테이션으로 만드는 방법

  • JUnit 5 extension으로 MockitoExtension을 사용해야 한다.
  • 필드
  • 메소드 매개변수

    
    @ExtendWith(MockitoExtension.class)
    class StudyServiceTest {

  @Mock MemberService memberService;

  @Mock StudyRepository studyRepository;

  ``` java
  @ExtendWith(MockitoExtension.class)
  class StudyServiceTest {
  
  @Test
  void createStudyService(@Mock MemberService memberService,
                          @Mock StudyRepository studyRepository) {
      StudyService studyService = new StudyService(memberService, studyRepository);
      assertNotNull(studyService);
  } 
  }

  
  

예시

• 구현체는 없지만 인터페이스만 있고, 그 인터페이스를 기반으로 작성한 코드의 테스트가 필요한 상황.
• 구현체가 있다면 직접 쓰거나 Mock 하면 되지만, 구현체가 없는 경우에는 Mock 할 수 밖에 없다.

• 구현체 없이 인터페이스만 가지고 Mock을 사용하지 않았을 때 테스트를 작성하면 아래와 같다.

  @Test
  void createStudyService() {
      MemberService memberService = new MemberService() {
          @Override
          public Optional<Member> findById(Long memberId) {
              return Optional.empty();
          }
          .
          .
          .
      };
  
      StudyRepository studyRepository = new StudyRepository() {
          @Override
          public List<Study> findAll() {
              return null;
          }
          .
          .
          .
      };
  
      StudyService studyService = new StudyService(memberService, studyRepository);
  
      assertNotNull(studyService);
  }

  
  

4. Mock 객체 Stubbing

• 모든 Mock 객체의 행동

  • null을 리턴한다. (Optional 타입은 Optional.empty 리턴)
  • Primitive 타입은 기본 Primitive 값.
  • 콜렉션은 비어있는 콜렉션.
  • Void 메소드는 예외를 던지지 않고 아무런 일도 발생하지 않는다. (아무런 일도 일어나지 않는다.)

• Mock 객체를 조작해서

  • 특정한 매개변수를 받은 경우 특정한 값을 리턴하거나 예외를 던지도록 만들 수 있다.
    • How about some stubbing?
    • Argument matchers
  • void 메소드 특정 매개변수를 받거나 호출된 경우 예외를 발생시킬 수 있다.
    • Subbing void methods with exceptions
  • 메소드가 동일한 매개변수로 여러 번 호출될 때 각기 다르게 행동하도록 조작할수도 있다.
    • Stubbing consecutive calls

예시

• mokito의 when()을 가지고 mock 객체로 stubbing을 할 수 있다. (주석도 참고)
• member.setId(1L); 의 값이 달라지면 when(memberService.findById(1L))에서 아무것도 하지 않는다.

• 그렇기 때문에 anyLong() 등을 사용할 수도 있다.

  @Test
  void createNewStudy(@Mock MemberService memberService,
                          @Mock StudyRepository studyRepository) {
      StudyService studyService = new StudyService(memberService, studyRepository);
      assertNotNull(studyService);
  
      Member member = new Member();
      member.setId(1L);
      member.setEmail("tony@email.com");
  
      when(memberService.findById(1L)).thenReturn(Optional.of(member));
  
      Study study = new Study(10, "java");
  
      // 아래 코드를 호출한 순간 -> Mock을 위해 작성한 코드가 실행
      Optional<Member> findById = memberService.findById(1L);
      assertEquals("tony@email.com", findById.get().getEmail());
  }

• 예외를 던지게 만드는 테스트를 작성할 수도 있다.
• 리턴 값이 있는 경우

      when(memberService.findById(any())).thenThrow(new RuntimeException());

• void인 경우

      doThrow(new IllegalArgumentException()).when(memberService).validate(1L);

• 메소드가 동일한 매개변수로 여러 번 호출될 때 각기 다르게 행동하도록 조작할수도 있다.

  • 첫 번째 호출 : Optional로 감싸진 member 리턴
  • 두 번째 호출 : 예외

  • 세 번째 호출 : 빈 Optional 리턴

    when(memberService.findById(any())).
            thenReturn(Optional.of(member))
            .thenThrow(new RuntimeException())
            .thenReturn(Optional.empty());
    
    Optional<Member> byId = memberService.findById(1L);
    assertEquals("tony@email.com", byId.get().getEmail());
    
    assertThrows(RuntimeException.class, () -> {
        memberService.findById(2L);
    });
    
    assertEquals(Optional.empty(), memberService.findById(3L));

5. Mock 객체 Stubbing 연습문제

• 다음 코드의 TODO에 해당하는 작업을 코딩으로 채워 넣으세요.

    Study study = new Study(10, "테스트");

    // TODO memberService 객체에 findById 메소드를 1L 값으로 호출하면 Optional.of(member) 객체를 리턴하도록 Stubbing
    // TODO studyRepository 객체에 save 메소드를 study 객체로 호출하면 study 객체 그대로 리턴하도록 Stubbing

    studyService.createNewStudy(1L, study);
    assertEquals(member, study.getOwner());

• TODO에 해당하는 작업

      when(memberService.findById(1L)).thenReturn(Optional.of(member));
      when(studyRepository.save(study)).thenReturn(study);

6. Mock 객체 확인

• Mock 객체가 어떻게 사용이 됐는지 확인할 수 있다.
  • 특정 메소드가 특정 매개변수로 몇 번 호출 되었는지, 최소 한번은 호출 되었는지, 전혀 호출되지 않았는지
    • Verifying exact number of invocations
  • 어떤 순서로 호출 했는지
    • Verification in order
  • 특정 시간 이내에 호출됐는지
    • Verification with timeout
  • 특정 시점 이후에 아무 일도 벌어지지 않았는지
    • Finding redundant invocations

예시

• 한 번만 호출되는지 확인 / 호출되지 않는지 확인

  verify(memberService, times(1))).notify(study);
  
  verify(memberService, never()).validate(any());

• InOrder 로 순서대로 동작했는지 확인할 수 있고, verifyNoMoreInteractions()로 더 이상 상호작용이 없는지 확인할 수도 있다.

  InOrder inOrder = inOrder(memberService);
  inOrder.verify(memberService).notify(study);
  inOrder.verify(memberService).notify(member);
  
  verifyNoMoreInteractions(memberService);

• 참고 : 시간이 중요하다면 JUnit의 Timeout을 쓰는 것도 방법이다.

7. Mockito BDD 스타일 API

• BDD: 애플리케이션이 어떻게 “행동”해야 하는지에 대한 공통된 이해를 구성하는 방법으로, TDD에서 창안했다.

• 행동에 대한 스팩

  • Title
  • Narrative
    • As a / I want / so that
  • Acceptance criteria
    • Given / When / Then

• Mockito는 BddMockito라는 클래스를 통해 BDD 스타일의 API를 제공한다.

• When -> Given

  given(memberService.findById(1L)).willReturn(Optional.of(member));
  given(studyRepository.save(study)).willReturn(study);

• Verify -> Then

  then(memberService).should(times(1)).notify(study);
  then(memberService).shouldHaveNoMoreInteractions();

예시

• Given / When / Then

@Test
    void createNewStudy() {
        // Given
        StudyService studyService = new StudyService(memberService, studyRepository);
        assertNotNull(studyService);

        Member member = new Member();
        member.setId(1L);
        member.setEmail("keesun@email.com");

        Study study = new Study(10, "테스트");

        given(memberService.findById(1L)).willReturn(Optional.of(member));

        // When
        studyService.createNewStudy(1L, study);

        // Then
        assertEquals(1L, study.getOwnerId());
        then(memberService).should(times(1)).notify(study);
        then(memberService).shouldHaveNoMoreInteractions();
    }