Mockito Trying to spy on method is calling the original method

Question

I m using Mockito 1 9 0   I want mock the behaviour for a single method of a class in a JUnit test  so I have  final MyClass myClassSpy   Mockito spy myInstance   Mockito when myClassSpy method1    thenReturn myResults     The problem is  in the second line  myClassSpy method1   is actually getting called  resulting in an exception   The only reason I m using mocks is so that later  whenever myClassSpy method1   is called  the real method won t be called and the myResults object will be returned     MyClass is an interface and myInstance is an implementation of that  if that matters   What do I need to do to correct this spying behaviour

User · Answer

In my case  using Mockito 2 0  I had to change all the any   parameters to nullable   in order to stub the real call

User · Answer

One way to make sure a method from a class is not called is to override the method with a dummy           WebFormCreatorActivity activity   spy new WebFormCreatorActivity clientFactory     spy new WebFormCreatorActivity clientFactory                 Override             public void select TreeItem i                    log debug  SELECT

User · Answer

Let me quote the official documentation   Important gotcha on spying real objects  Sometimes it s impossible to use when Object  for stubbing spies  Example  List list   new LinkedList    List spy   spy list       Impossible  real method is called so spy get 0  throws IndexOutOfBoundsException  the list is yet empty  when spy get 0   thenReturn  quot foo quot        You have to use doReturn   for stubbing doReturn  quot foo quot   when spy  get 0     In your case it goes something like  doReturn resultsIWant  when myClassSpy  method1

User · Answer

I ve found yet another reason for spy to call the original method   Someone had the idea to mock a final class  and found about MockMaker      As this works differently to our current mechanism and this one has different limitations and as we want to gather experience and user feedback  this feature had to be explicitly activated to be available   it can be done via the mockito extension mechanism by creating the file src test resources mockito-extensions org mockito plugins MockMaker containing a single line  mock-maker-inline   Source  https   github com mockito mockito wiki What 27s-new-in-Mockito-2 mock-the-unmockable-opt-in-mocking-of-final-classesmethods  After I merged and brought that file to my machine  my tests failed   I just had to remove the line  or the file   and spy   worked

User · Answer

One more possible scenario which may causing issues with spies is when you re testing spring beans  with spring test framework  or some other framework that is proxing your objects during test   Example   Autowired private MonitoringDocumentsRepository repository  void test        repository   Mockito spy repository      Mockito doReturn docs1  docs2               when repository  findMonitoringDocuments Mockito nullable MonitoringDocumentSearchRequest class        In above code both Spring and Mockito will try to proxy your MonitoringDocumentsRepository object  but Spring will be first  which will cause real call of findMonitoringDocuments method  If we debug our code just after putting a spy on repository object it will look like this inside debugger   repository   MonitoringDocumentsRepository  EnhancerBySpringCGLIB  MockitoMock     SpyBean to the rescue  If instead  Autowired annotation we use  SpyBean annotation  we will solve above problem  the SpyBean annotation will also inject repository object but it will be firstly proxied by Mockito and will look like this inside debugger  repository   MonitoringDocumentsRepository  MockitoMock  EnhancerBySpringCGLIB    and here is the code    SpyBean private MonitoringDocumentsRepository repository  void test        Mockito doReturn docs1  docs2               when repository  findMonitoringDocuments Mockito nullable MonitoringDocumentSearchRequest class

User · Answer

The answer by Tomasz Nurkiewicz appears not to tell the whole story   NB Mockito version  1 10 19   I am very much a Mockito newb  so can t explain the following behaviour  if there s an expert out there who can improve this answer  please feel free   The method in question here  getContentStringValue  is NOT final and NOT static   This line does call the original method getContentStringValue   doReturn   dummy    when  im   getContentStringValue  anyInt    isA  ScoreDoc class       This line does not call the original method getContentStringValue   doReturn   dummy    when  im   getContentStringValue  anyInt    any  ScoreDoc class       For reasons which I can t answer  using isA   causes the intended      do not call method  behaviour of doReturn to fail   Let s look at the method signatures involved here  they are both static methods of Matchers  Both are said by the Javadoc to return null  which is a little difficult to get your head around in itself  Presumably the Class object passed as the parameter is examined but the result either never calculated or discarded  Given that null can stand for any class and that you are hoping for the mocked method not to be called  couldn t the signatures of isA        and any        just return null rather than a generic parameter   lt T gt    Anyway   public static  lt T gt  T isA java lang Class lt T gt  clazz   public static  lt T gt  T any java lang Class lt T gt  clazz    The API documentation does not give any clue about this   It also seems to say the need for such  do not call method  behaviour is  very rare    Personally I use this technique all the time  typically I find that mocking involves a few lines which  set the scene      followed by calling a method which then  plays out  the scene in the mock context which you have staged    and while you are setting up the scenery and the props the last thing you want is for the actors to enter stage left and start acting their hearts out     But this is way beyond my pay grade    I invite explanations from any passing Mockito high priests       is  generic parameter  the right term

User · Answer

Bit late to the party but above solutions did not work for me   so sharing my 0 02   Mokcito version  1 10 19  MyClass java  private int handleAction List lt String gt  argList  String action    Test java  MyClass spy   PowerMockito spy new MyClass       Following did NOT work for me  actual method was being called    1   doReturn 0  when spy    handleAction   ListUtils EMPTY LIST  new String       2   doReturn 0  when spy    handleAction   any    anyString       3    doReturn 0  when spy    handleAction   null  null     Following WORKED   doReturn 0  when spy    handleAction   any List class   anyString

User · Answer

My case was different from the accepted answer  I was trying to mock a package-private method for an instance that did not live in that package  package common   public class Animal      void packageProtected       package instances   class Dog extends Animal       and the test classes  package common   public abstract class AnimalTest lt T extends Animal gt       Before   setup        doNothing   when getInstance    packageProtected           abstract T getInstance       package instances   class DogTest extends AnimalTest lt Dog gt      Dog getInstance        return spy new Dog             Test   public void myTest         The compilation is correct  but when it tries to setup the test  it invokes the real method instead   Declaring the method protected or public fixes the issue  tho it s not a clean solution

[java] Mockito: Trying to spy on method is calling the original method

Examples related to java

Examples related to junit

Examples related to mockito