Spring Mockito when().thenReturn 과 doReturn.when()의 차이

Typically, stubbing argument mismatch indicates user mistake when writing tests.
Mockito fails early so that you can debug potential problem easily.
However, there are legit scenarios when this exception generates false negative signal:
  - stubbing the same method multiple times using 'given().will()' or 'when().then()' API
    Please use 'will().given()' or 'doReturn().when()' API for stubbing.
  - stubbed method is intentionally invoked with different arguments by code under test
    Please use default or 'silent' JUnit Rule (equivalent of Strictness.LENIENT).
For more information see javadoc for PotentialStubbingProblem class.
org.mockito.exceptions.misusing.PotentialStubbingProblem: 
Strict stubbing argument mismatch. Please check:

 

단위 테스트를 실행하는 과정에서 다음과 같은 에러를 만났다. 

여기서 stubbing이란 Mock 객체의 행동을 조작하는 것을 말한다. 에러를 보면 when().then() 대신 will().given() 또는 doReturn().when()을 사용하라고 하고 있다. 

 

when().thenReturn 과 doReturn.when() 은 동작 방식이 다르다. 

when().thenReturn -> Strict Mode (실제 메소드를 호출하고 mock 객체 리턴값을 반환) 

doReturn.when() -> Lateinit Mode (실제 메소드를 호출하지 않고 mock객체 리턴값을 반환)  

 

<테스트 코드 작성시 확인할 것>

- 불필요한 stubbing이 없는지 (테스트에서 쓰이지 않는 mock 처리가 없는지)

- strict stubs에서 동일한 메소드에서 여러번의 when을 설정하게 되면 (=여러번의 stubbing을 하게 되면) 해당 mock을 reset하게 된다. 따라서 lateinit모드인 lenient().doReturn.when()으로 바꿔주거나 같은 메서드에 대해 한번의 when만 호출하게 해주면 된다. 

 

참고

https://www.freeism.co.kr/wp/archives/2243#fn-2243-5