{"id":105517,"date":"2020-06-22T13:00:00","date_gmt":"2020-06-22T10:00:00","guid":{"rendered":"https:\/\/www.javacodegeeks.com\/?p=105517"},"modified":"2020-06-18T13:54:56","modified_gmt":"2020-06-18T10:54:56","slug":"mock-void-method-with-mockito","status":"publish","type":"post","link":"https:\/\/www.javacodegeeks.com\/2020\/06\/mock-void-method-with-mockito.html","title":{"rendered":"Mock Void method with Mockito"},"content":{"rendered":"

Hey guys! After our previous blog on difference between thenReturn and thenAnswer mockito methods<\/a>, we are back with yet another interesting blog on Mockito. Here, we shall discuss \u201cHow to Mock Void method with Mockito\u201d. Let\u2019s get started!<\/p>\n

When writing code, there is always at least one method that returns \u2018void\u2019, and at some point in time we need to mock \u2018void\u2019 method. So how do we go about it? Let us together figure this out in the following blog using mockito.<\/p>\n

Mockito is one of the most famous mocking framework used for writing unit tests. If you are new to mocking you can know more at mockito website<\/a>.<\/p>\n

Why we need to mock void method?<\/h2>\n

Let\u2019s assume we have a method. In this method we call another void method. Now, when you want to write test case for this method, how can we test that the void method was called? Also, if the correct parameters were passed to void method?
In this case mockito comes to our rescue.<\/p>\n

Let\u2019s take an example, we have a UserService class. In this class we have a updateName() method.<\/p>\n

\n
\n\n\n\n
\n
1<\/div>\n
2<\/div>\n
3<\/div>\n
4<\/div>\n
5<\/div>\n
6<\/div>\n<\/td>\n
\n
\n
public<\/code> UserService{<\/code><\/div>\n
    <\/code>...<\/code><\/div>\n
   <\/code>public<\/code> void<\/code> updateName(Long id, String name){<\/code><\/div>\n
      <\/code>userRepository.updateName(id, name);<\/code><\/div>\n
   <\/code>}<\/code><\/div>\n
}<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

Now, we want to write unit test for UserService class and mock userRepository.
But the only thing we need to verify in this test case is that updateName() method from userRepository is called with correct set of parameters.
For this purpose we need to mock updateName() method, capture the arguments and verify the arguments.<\/p>\n

One of the most important point <\/strong>to note here is that, we can not just mock void method using when-then mechanism of mockito. Because, when() method of mockito works with return value and does not work when method is void.<\/p>\n

How to mock void method in mockito?<\/h2>\n

In Mockito we can use different methods to call real method or mock void method. We can use one of the options as per requirements<\/p>\n

    \n
  1. doNothing() <\/strong>: Completely ignore the calling of void method, this is default behavior<\/li>\n
  2. doAnswer()<\/strong> : Perform some run time or complex operations when void method is called<\/li>\n
  3. doThrow() <\/strong>: Throw exception when mocked void method is called<\/li>\n
  4. doCallRealMethod() <\/strong>: Do not mock and call real method<\/li>\n<\/ol>\n

    1) Using doNothing()<\/h3>\n

    If we just want to completely ignore the void method call, we can use doNothing().<\/p>\n

    In mocking, for every method of mocked object doNothing is the default behavior. Hence, if you don\u2019t want to verify parameters, use of doNothing is completely optional. Following all codes perform similar behavior,<\/p>\n

    Example using doNothing() for void method<\/h2>\n
    \n
    \n\n\n\n
    \n
    1<\/div>\n
    2<\/div>\n
    3<\/div>\n
    4<\/div>\n
    5<\/div>\n
    6<\/div>\n
    7<\/div>\n
    8<\/div>\n<\/td>\n
    		\n
    \n
    @Test<\/code><\/div>\n
    public<\/code> void<\/code> testUpdateNameWithDoNothingVerifyRepositoryCall() {<\/code><\/div>\n
       <\/code>doNothing().when(mockedUserRepository).updateName(anyLong(),anyString());<\/code><\/div>\n
     <\/div>\n
       <\/code>userService.updateName(1L,<\/code>\"void mock test\"<\/code>);<\/code><\/div>\n
        <\/code> <\/div>\n
       <\/code>verify(mockedUserRepository, times(1)).updateName(1L,<\/code>\"void mock test\"<\/code>);<\/code><\/div>\n
    }<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

    Without using doNothing() for void method<\/h2>\n
    \n
    \n\n\n\n
    \n
    1<\/div>\n
    2<\/div>\n
    3<\/div>\n
    4<\/div>\n
    5<\/div>\n
    6<\/div>\n
    7<\/div>\n<\/td>\n
    		\n
    \n
    @Test<\/code><\/div>\n
    public<\/code> void<\/code> testUpdateNameWithOutDoNothingVerifyRepositoryCall() {<\/code><\/div>\n
     <\/div>\n
       <\/code>userService.updateName(1L,<\/code>\"void mock test\"<\/code>);<\/code><\/div>\n
        <\/code> <\/div>\n
       <\/code>verify(mockedUserRepository, times(1)).updateName(1L,<\/code>\"void mock test\"<\/code>);<\/code><\/div>\n
    }<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

    Example of argument capture using doNothing()<\/h2>\n

    We can do different things with argument capture. Here, we will just verify the captured value

    <\/div> <\/div><\/p>\n
    \n
    \n\n\n\n
    \n
    01<\/div>\n
    02<\/div>\n
    03<\/div>\n
    04<\/div>\n
    05<\/div>\n
    06<\/div>\n
    07<\/div>\n
    08<\/div>\n
    09<\/div>\n
    10<\/div>\n
    11<\/div>\n
    12<\/div>\n<\/td>\n
    		\n
    \n
    @Test<\/code><\/div>\n
    public<\/code> void<\/code> testUpdateNameUsingArgumentCaptor() {<\/code><\/div>\n
     <\/div>\n
       <\/code>ArgumentCaptor<Long> idCapture = ArgumentCaptor.forClass(Long.<\/code>class<\/code>);<\/code><\/div>\n
       <\/code>ArgumentCaptor<String> nameCapture = ArgumentCaptor.forClass(String.<\/code>class<\/code>);<\/code><\/div>\n
       <\/code>doNothing().when(mockedUserRepository).updateName(idCapture.capture(),nameCapture.capture());<\/code><\/div>\n
     <\/code> <\/div>\n
       <\/code>userService.updateName(1L,<\/code>\"void mock test\"<\/code>);<\/code><\/div>\n
        <\/code> <\/div>\n
       <\/code>assertEquals(1L, idCapture.getValue());<\/code><\/div>\n
       <\/code>assertEquals(<\/code>\"void mock test\"<\/code>, nameCapture.getValue());<\/code><\/div>\n
    }<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

    2) Using doAnswer() for void method<\/h3>\n

    If we do not want to call real method, however need to perform some runtime operation doAnswer is used.<\/p>\n

    Let\u2019s take an example of doAnswer where we will print and verify the argument using doAnswer<\/p>\n

    \n
    \n\n\n\n
    \n
    01<\/div>\n
    02<\/div>\n
    03<\/div>\n
    04<\/div>\n
    05<\/div>\n
    06<\/div>\n
    07<\/div>\n
    08<\/div>\n
    09<\/div>\n
    10<\/div>\n
    11<\/div>\n
    12<\/div>\n
    13<\/div>\n
    14<\/div>\n
    15<\/div>\n
    16<\/div>\n<\/td>\n
    		\n
    \n
    @Test<\/code><\/div>\n
    public<\/code> void<\/code> testUpdateNameUsingDoAnswer() {<\/code><\/div>\n
       <\/code>doAnswer(invocation -> {<\/code><\/div>\n
          <\/code>long<\/code> id = invocation.getArgument(0);<\/code><\/div>\n
          <\/code>String name = invocation.getArgument(1);<\/code><\/div>\n
          <\/code>System.out.println(<\/code>\"called for id: \"<\/code>+id+<\/code>\" and name: \"<\/code>+name);<\/code><\/div>\n
     <\/div>\n
          <\/code>assertEquals(1L, id);<\/code><\/div>\n
          <\/code>assertEquals(<\/code>\"void mock test\"<\/code>, name);<\/code><\/div>\n
     <\/div>\n
          <\/code>return<\/code> null;<\/code><\/div>\n
    }).when(mockedUserRepository).updateName(anyLong(),anyString());<\/code><\/div>\n
     <\/div>\n
       <\/code>userService.updateName(1L,<\/code>\"void mock test\"<\/code>);<\/code><\/div>\n
       <\/code>verify(mockedUserRepository, times(1)).updateName(1L,<\/code>\"void mock test\"<\/code>);<\/code><\/div>\n
    }<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

    3) Throw exception using doThrow()<\/h3>\n

    If we want to throw an exception when method is called, we can use doThrow() method of mockito.<\/p>\n

    Let\u2019s take an example where we will throw InvalidParamException when updateName() method is called with null id.<\/p>\n

    \n
    \n\n\n\n
    \n
    1<\/div>\n
    2<\/div>\n
    3<\/div>\n
    4<\/div>\n
    5<\/div>\n
    6<\/div>\n<\/td>\n
    		\n
    \n
    @Test(expected = InvalidParamException.<\/code>class<\/code>)<\/code><\/div>\n
    public<\/code> void<\/code> testUpdateNameThrowExceptionWhenIdNull() {<\/code><\/div>\n
       <\/code>doThrow(<\/code>new<\/code> InvalidParamException())<\/code><\/div>\n
          <\/code>.when(mockedUserRepository).updateName(null,anyString();<\/code><\/div>\n
       <\/code>userService.updateName(null,<\/code>\"void mock test\"<\/code>);<\/code><\/div>\n
    }<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

    4) Real method call using doCallRealMethod()<\/h3>\n

    Sometimes it is necessary to call the real method from mocked object, in such case we need to use doCallRealMethod(), because doNothig() is the default behavior.<\/p>\n

    In the following example real method from userRepository will be called even though it is a mocked object.<\/p>\n

    \n
    \n\n\n\n
    \n
    1<\/div>\n
    2<\/div>\n
    3<\/div>\n
    4<\/div>\n
    5<\/div>\n
    6<\/div>\n
    7<\/div>\n
    8<\/div>\n
    9<\/div>\n<\/td>\n
    		\n
    \n
    @Test<\/code><\/div>\n
    public<\/code> void<\/code> testUpdateNameCallRealRepositoryMethod() {<\/code><\/div>\n
     <\/div>\n
       <\/code>doCallRealMethod().when(mockedUserRepository).updateName(anyLong(), anyString());<\/code><\/div>\n
     <\/code> <\/div>\n
       <\/code>userService.updateName(1L,<\/code>\"calling real method\"<\/code>);<\/code><\/div>\n
     <\/code> <\/div>\n
       <\/code>verify(mockedUserRepository, times(1)).add(1L,<\/code>\"calling real method\"<\/code>);<\/code><\/div>\n
    }<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

    Fast track reading<\/h2>\n