[참고] Mockito 기초 사용법

🌺 Mockito란

모의 객체 생성, 검증, 스팁을 지원하는 프레임워크이다. 이는, 인기있는 자바 모의 객체 프레임워크 중 하나로, 이를 통해 대역을 보다 원활하게 사용할 수 있게 된다. 

 

 

🌺 dependencies 추가 (Gradle)

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

	// junit
	testImplementation('org.junit.jupiter:junit-jupiter:5.5.0')

	// mockito -> 이부분 추가
	testImplementation('org.mockito:mockito-core:4.5.1')
}

 

🌺 모의 객체 생성

@Test
    void mockTest(){
        GameNumGen getMock = mock(GameNumGen.class); // 모의 객체 생성 예
    }
}

 

• Mocktio.mock(): 클래스, 인터페이스, 추상 클래스에 대해 모의 객체를 생성할 수 있음'

 

🌺 스텁 설정

모의 객체를 설정한 이후에는 BDDMockito 클래스를 이용하여 모의 객체에 스텁을 구성항할 수 있다.

 

 @Test
    void mockTest(){
        GameNumGen genMock = mock(GameNumGen.class); // 모의 객체 생성 예
        given(genMock.generate(GameLevel.EASY)).willReturn("123"); // given: 모의 객체 매서드 호출을 전달

        String num = genMock.generate(GameLevel.EASY);
        assertEquals("123", num);
    }


@Test
    void mockThrowTest(){
        GameNumGen genMock = mock(GameNumGen.class);
        given(genMock.generate(null)).willThrow(IllegalArgumentException.class);
//        given(genMock.generate(null)).willThrow(new IllegalArgumentException()); 이것도 가능

        assertThrows(
                IllegalArgumentException.class,
                () -> genMock.generate(null)
        );
    }

 

• given(): 스텁을 정의할 모의 객체의 메서드 호출을 전달
• willReturn(): 스텁을 정의한 메서드가 리턴할 값을 지정
• willThrow(): 스텁을 정의한 메서드가 리턴할 예외처리 지정

즉, 위의 코드에서 generate를 실행하면 given에서 지정한 willReturn 값으로 123을 넘겨준다. 

 

return 타입이 void인 method의 경우에는 다음과 같이 Test 코드를 작성한다. 메소드 뒤에 willThrow가 붙는 것이 아닌, 익셉션 타입, 객체를 인자로 받고 난 후, given 메소드를 통해서 모의 객체를 전달받는다.

단, willThrow 뒤에 붙는 given 의 경우에는 모의 객체의 메소드가 아닌 모의 객체 그 자체인 것을 유의해야 한다.

 @Test
    void voidMethodWillThrowTest(){
        List<String> mockList = mock(List.class);
        willThrow(UnsupportedOperationException.class)
                .given(mockList)
                .clear();

        assertThrows(
                UnsupportedOperationException.class,
                () -> mockList.clear()
        );
    }

 

 

🌼 인자 매칭 처리

given(genMock.generate(GameLevel.EASY)).willReturn("123"); 
String num = genMock.generate(GameLevel.NORMAL);

다음과 같이 코드가 작성이 되어 있을 경우에는 EASY enum에서만 123 return 값이 있으므로 NORMAL을 메소드 호출 할 때 값이 없기 때문에 null 이 return 된다. 

 

이와 같이, Mockito는 스텁 설정과 일치하는 인자가 아닌 경우에는 리턴 타입의 기본 값을 return 한다. int의 경우에는 0, boolean의 경우에는 false와 같이 말이다. 기본 데이터 타입이 없을 경우에는 null을 return 한다. 

 

 

@Test
    void anyMatchTest(){
        GameNumGen genMock = mock(GameNumGen.class);
        given(genMock.generate(any())).willReturn("456");

        String num = genMock.generate(GameLevel.EASY);
        assertEquals("456", num);

        String num2 = genMock.generate(GameLevel.NORMAL);
        assertEquals("456", num2);
    }

• any(): 모든 값에 일치하도록 스텁 설정, 임의의 값에 대한 일치
• anyInt(), anyShort(), anyLong(), anyByte, anyChar(), anyDouble() 등등
• anyString()
• anyList(), anySet(), anyMap(), anyCollection(): 임의의 콜랙션에 대한 일치
• matches(String), matches(Pattern): 정규 표현 식을 이용한 String 값 일치 여부
• eq(값): 특정 값과 일치 여부

 

또한, 임의의 값과 일치하는 인자와 정확하게 일치하는 인자를 함께 사용하고 싶다면 eq() 메소드를 사용해야한다. 

given(mockList.set(anyInt(), "123")).willReturn("456"); // 에러
given(mockList.set(anyInt(), eq("123"))).willReturn("456"); // 해결

 

🌺 행위 검증

모의 객체의 역할 중 하나는 실제 모의 객체가 불렸는지 검증하는 것이다. 다음 코드를 확인해보면 genMock의 모의 객체의 generate 메소드가 EASY 인자를 사용해서 실제 호출되었는지 검증을 한다.

@Test
    void init(){
        GameNumGen genMock = mock(GameNumGen.class);
        Game game = new Game(genMock);
        game.init(GameLevel.EASY);

        then(genMock).should().generate(GameLevel.EASY); // then : 모의 객체를 전달 받음 should : 모의 객체의 메서드가 불려야 한다는 것을 설정
    }

 

정확한 값이 아니라, 호출 되었는지만 확인하고 싶으면 any() 함수를 사용하면 된다. 

메소드 호출 횟수를 검증하기 위해 Mockito 클래스가 제공하는 메소드는 다음과 같다. 

• only() : 한번만 호출
• times(int) : 지정한 횟수만큼 호출
• never() : 호출하지 않음
• atLeast(int) ; 적어도 지정한 횟수만큼 호출
• atLeastOnce() : atLeast(1)
• atMost(int) : 최대 지정한 횟수만큼 호출

 

🌺 인자 캡쳐

 단위 테스트를 진행하다보면, 모의 객체를 호출할 때 사용한 인자를 검증해야할 때가 있다. String, int의 경우는 확인하기 쉽지만 많은 속성을 갖고 있는 객체의 경우 쉽게 검증하기는 쉽지 않다. 이 때 사용하는 방법이 인자 캡쳐이다. 

 

인자 캡쳐와 관련된 코드는 다음과 같다. 

 @DisplayName("가입하면 메일을 전송함")
    @Test
    void whenRegisterThenSendMail(){
        userRegister.register("id", "pw", "email");

        ArgumentCaptor<String> captor = ArgumentCaptor.forClass(String.class); // String 타입의 인자 보관
        then(mockEmailNotifier)
                .should().sendRegisterEmail(captor.capture());

        String realEmail = captor.getValue();
        assertEquals("email", realEmail);
    }