Mockito는 알고 테스트 코드 작성하자

Mockito - mockito-core 5.2.0 javadoc

Mockito란?

Mock을 쉽게 만들고 mock의 행동을 정하는 stubbing 로직이 실행이 되었는지 확인하기 위한 verify()를 이용이 가능하게 해주는 프레임워크 입니다.

Stubbing이란

모의 객체의 메서드 호출에 대한 값을 미리 정의하여 반환을 합니다. 즉. 테스트 코드에서 모듸 객체가 호출될 때 어떤 값을 반환해야 하는지를 미리 정해놓는 것이다.

public interface MyService {
    String getName();
}

@Test
public void testMyService() {
    MyService myService = mock(MyService.class);
    when(myService.getName()).thenReturn("Mockito");

    String name = myService.getName();
    assertEquals("Mockito", name);
}

위 코드를 보면 when().thenReturn()을 통해 값을 반환을 할 수 있게 합니다. 

그래서 service에 getName()을 실행하면 위에 설정한 Mockito가 호출이 됩니다.

 

Mock이란

가짜 객체를 의미 합니다. 주로 테스트에서 사용되며 테스트할 때 필요한 실제 객체를 동일한 모의 객체를 만들어서 테스트를 할때 효율적으로 만들어 줍니다.

모의 객체 - 위키백과, 우리 모두의 백과사전

위에 사이트를 보면 다음과 같이 정의 되어 있다.

그러면 모의 객체를 사용하면 어떠한 장점이 있을까?

모의 객체를 사용하면 DB에서 값을 읽어오지 않습니다. 즉. DB와 연결을 하지 않는다.

테스트의 관점에서 보게되면 DB와 연결을 하면 위험합니다. 

모의 객체를 사용하지 않으면 DB와 연결이 된다. 그렇게 되면 매번 작업을 하면 DB와 연동을 하기 때문에 부하가 많이 걸리게 됩니다. 이렇게 되면 테스트의 시간이 증가하게 됩니다. 

테스트 코드를 통해 설명을 하겠습니다.

@SpringBootTest
class OwnerServiceTest2 {

  @Autowired
  private OwnerService ownerService;

  @Autowired
  private OwnerRepository ownerRepository;

  @BeforeEach
  void setUp() {
    List<Owner> ownerList = new ArrayList<>();
    for (int i = 0; i < 3; i++) {

      Owner owner = Owner.builder()
          .name("owner" + i)
          .build();

      Item item = Item.builder()
          .name("item" + i)
          .build();
      owner.addItem(item);
      ownerRepository.save(owner);
    }
  }

  @Test
  @DisplayName("findAll()로 N+1문제 구현")
  public void findAllWith_N1_Invalid() {
    this.ownerService.findAll();
  }
}

위에 코드는 MOCK을 사용하지 않는 기본적인 테스트 코드입니다. 이 테스트 코드를 실행하면 DB와 연결을 통해 값을 저장하고 값을 읽습니다. 

이제 Mock을 이용해서 테스트 코드를 작성을 하겠습니다.

1. 의존성 추가

dependencies {
		testImplementation 'org.mockito:mockito-core:3.11.2'
    testImplementation 'org.mockito:mockito-junit-jupiter:3.11.2'
}

 

2. 테스트 코드 작성하기

class OwnerServiceTest {
  
  private OwnerService ownerService;
  private final OwnerRepository ownerRepository = mock(OwnerRepository.class);

  @BeforeEach
  void setUp() {
    ownerService = new OwnerService(ownerRepository);

    List<Owner> ownerList = new ArrayList<>();

    for (int i = 0; i < 3; i++) {
      Item build = Item.builder()
          .name("아이템" + i)
          .build();
      Owner owner = Owner.builder()
          .name("김무건"+i)
          .items(List.of(build))
          .build();
      ownerList.add(owner);
    }
    given(ownerRepository.findAll()).willReturn(ownerList);
  }

  @Test
  @DisplayName("findAll")
  public void findAllWithValid() throws Exception {
    // when
    List<String> actualOwners = ownerService.findAll();

    // then
    actualOwners.forEach(i->{
      System.out.println("i = " + i);
    });
  }
}

 테스트 코드를 실행을 해보면 DB와 연결을 하지 않기 때문에 쿼리와 DB에 값이 들어가지 않습니다.

 

 

Mock과 Spy에 대해 비교하자

Mock과 Spy는 모두 Mockito에서 제공하는 목 객체(Mock Object)를 생성하는 방법 중 두 가지입니다. 하지만 Mock과 Spy는 목적이 다르므로 사용 시 주의해야 합니다.

Mock 객체는 완전한 가짜 객체로, 객체의 메서드 호출을 감시하고 기대하는 동작을 수행합니다. 실제 객체를 대체하여 테스트하기 때문에, 특정한 기능의 메서드를 호출하였을 때 기대한 대로의 반환값을 받아올 수 있는지, 메서드가 적절한 매개변수를 받는지 등을 검증할 때 사용합니다. Mock 객체는 Mockito에서 제공하는 mock() 메서드나 @Mock 어노테이션을 사용하여 생성할 수 있습니다.

Spy 객체는 실제 객체의 일부분을 대신하는 객체로, 실제 객체의 동작을 유지하면서 일부 기능을 변경하거나 추가할 때 사용됩니다. 특정한 객체의 일부 메서드를 호출할 때만 Mock 객체와 같은 방식으로 동작하지만, 그 외에는 실제 객체와 동일한 기능을 수행합니다. Spy 객체는 Mockito에서 제공하는 spy() 메서드나 @Spy 어노테이션을 사용하여 생성할 수 있습니다.

따라서 Mock 객체는 완전한 가짜 객체로 객체의 일부 메서드를 호출하지 않으며, Spy 객체는 실제 객체의 일부분을 가짜로 만들어서 사용합니다. 보통 Mock 객체는 객체의 메서드 호출을 검증하거나, 객체의 동작을 예측하는데 사용하며, Spy 객체는 실제 객체를 조작하거나 변경할 때 사용합니다.

 

Mockito란? Mockito 사용하기

Mockito 공부하기 #1