[Spring] Mockito란?

단위 테스트란?

단위 테스트는 하나의 모듈을 기준으로 독립적으로 진행되는 가장 작은 단위의 테스트입니다. 즉, 하나의 기능이 올바르게 동작하는지 독립적으로 테스트하는 것입니다.

 

프로그램을 작은 단위로 쪼개서 각 단위가 정확하게 동작하는지 검사하기 때문에 문제 발생 시 정확하게 어느 부분이 잘못되었는지 캐치할 수 있다는 장점이 있지만, 다른 객체와 데이터를 주고 받는 경우에 문제가 발생할 수 있습니다.

 

예를 들어 Service 계층의 단위 테스트 코드를 작성할 때 보통 다른 객체들과 의존 관계를 맺고 있는 경우가 많습니다. 이때, Bean Container에 주입된 실제 객체들을 가져다 쓰는 방법이 있고, Mockito 프레임워크 등을 활용해 Mock 객체를 만들어서 쓰는 방법이 존재합니다.

---

Mockito란?

Mockito는 *JUnit Test에서 *Mock을 위한 Java 오픈소스 테스트 프레임워크입니다.

 

Spring은 여러 객체들 간의 의존성이 생기게 되는데, 이러한 특성은 단위 테스트를 작성하기 어렵게 만듭니다. 따라서 의존성을 해결하기 위해 개발자가 동작을 직접 제어할 수 있는 가짜 객체인 Mock을 생성하여 주입시켜주는 Mockito 라이브러리를 활용합니다.

 

즉, Mockito는 Mock 객체를 쉽게 만들고, 관리하고, 검증할 수 있는 방법을 제공하는 프레임워크입니다.

 

*Mock: 진짜 객체와 비슷하게 동작하지만, 프로그래머가 직접 행동을 관리하는 객체

*JUnit: 자바 단위 테스트를 위한 프레임워크

---

Mockito 시작하기

Dependency 추가

스프링 부트 2.2 이상 버전의 프로젝트 생성시 spring-boot-start-test에서 자동으로 Mockito를 추가해줍니다.

dependencies {
	testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

 

직접 추가하기 위해선 mockito-core와 mockito-junit-jupiter가 필요합니다.

• mockito-core: mockito가 제공해주는 기본적인 라이브러리
• mockito-junit-jupiter: junit 테스트에서 mockito를 연동해서 사용할 수 있는 junit 확장 구현체

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

//maven
 <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>

 

JUnit과 결합

Mockito도 테스팅 프레임워크이기 때문에 JUnit과 결합되기 위해 클래스 어노테이션을 붙이는 별도의 작업이 필요합니다.

• JUnit4: @RunWith(MockitoJUnitRunner.class)
• JUnit5: @ExtendWith(MockitoExtension.class)

SpringBoot 2.2.0부터 공식적으로 JUnit5를 지원함에 따라 @ExtendWith(MockitoExtension.class)를 사용해 결합하게 됩니다.

@ExtendWith(MockitoExtension.class)
class Test {
	// 테스트 작성
}

---

Mockito 사용하기

우선 테스트 작성에 앞서 Member라는 객체를 조회하기 위한 세팅을 진행합니다.

(편의성을 위해 저는 Lombok을 사용했습니다.)

 

Member

package com.example.demotest.domain;

import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;

@Getter
@Entity
@AllArgsConstructor
@NoArgsConstructor
@Table(name = "member")
public class Member {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "member_no")
    private Long no;

    @Setter
    @Column(name = "name", nullable = false)
    private String name;

}

• Member Entity를 생성

 

Repository

import com.example.demotest.domain.Member;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface MemberRepository extends JpaRepository<Member, Long> {
}

• Member를 조회하기 위한 Repository를 생성

 

Service

import com.example.demotest.domain.Member;
import com.example.demotest.repository.MemberRepository;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import java.util.List;

@Service
@RequiredArgsConstructor
@Transactional(readOnly = true)
public class MemberService {

    private final MemberRepository memberRepository;

    public List<Member> findAllMember() {
        return memberRepository.findAll();
    }

}

• Member List를 조회하는 서비스를 생성

 

다음으로 MemberService를 통해 Member List를 조회하는 Service Test 예시는 다음과 같습니다.

import com.example.demotest.domain.Member;
import com.example.demotest.repository.MemberRepository;
import org.junit.jupiter.api.DisplayName;
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 org.assertj.core.api.Assertions;

import java.util.ArrayList;
import java.util.List;

@ExtendWith(MockitoExtension.class)
class MemberServiceTest {

    @InjectMocks
    private MemberService memberService;

    @Mock
    private MemberRepository memberRepository;

    @Test
    @DisplayName("회원 조회 결과 Member 리스트가 반환되어야 한다.")
    void findAllMember() {
        // given
        List<Member> memberList = new ArrayList<>();
        memberList.add(new Member(
                1L,
                "name1"));
        memberList.add(new Member(
                2L,
                "name2"));


        // when
        Mockito.when(memberRepository.findAll()).thenReturn(memberList);
        List<Member> result = memberService.findAllMember();

        // then
        Assertions.assertThat(result).hasSize(2);
        Assertions.assertThat(result.get(0).getName()).isEqualTo("name1");
        Assertions.assertThat(result.get(1).getName()).isEqualTo("name2");
    }
}

• @Mock
  • Mock객체를 생성
• @InjectMocks
  • @Mock이 붙은 Mock객체를 @InjectMocks이 붙은 객체에 주입
  • Service를 테스트하기 위해서 MemberRespository를 주입받아야 함
• Mock 객체 Stubbing
  • when() -> memberRepository를 통해 회원 리스트를 조회 했을때
  • thenReturn() -> memberList가 return 되어야 함
• Test 진행
  • Repository에서 조회한 결과와 Service를 통해 조회한 결과를 비교
  • 생성한 MemberList의 크기는 2
  • 첫번째 값의 이름은 name1
  • 두번째 값의 이름은 name2

 

테스트를 실행 결과 passed가 잘 나옵니다!

 

작성 코드는 아래 링크를 통해 확인할 수 있습니다.

https://github.com/Jisue/Spring-Test/tree/main/demo-test

GitHub - Jisue/Spring-Test: TDD Study

---

[참고]

https://mangkyu.tistory.com/145

[Spring] JUnit과 Mockito 기반의 Spring 단위 테스트 코드 작성법 (3/3)

https://scshim.tistory.com/439

Mockito란? Mockito 사용하기

https://www.nextree.io/mockito/

Mockito를 활용하여 테스트 코드 작성하기

https://lemontia.tistory.com/951

[junit5] Mock을 이용한 단위 테스트 (@InjectMocks 과 @Mock 차이)

https://velog.io/@hellonayeon/spring-boot-service-layer-unit-testcode

[Spring Boot] Service 계층의 단위 테스트 코드 작성

 

https://velog.io/@sussa3007/Spring-JUnit-Mockito-%EA%B8%B0%EB%B0%98-Spring-%EB%8B%A8%EC%9C%84-%ED%85%8C%EC%8A%A4%ED%8A%B8-%EC%BD%94%EB%93%9C-%EC%9E%91%EC%84%B1

[Spring] JUnit & Mockito 기반 Spring 단위 테스트 코드 작성