Verify object attribute value with mockito

Question

I have a method call which I want to mock with mockito  To start with I have created and injected an instance of an object on which the method will be called  My aim is to verify one of the object in method call   Is there a way that mockito allows you to assert or verify the object and it s attributes when the mock method is called   example  Mockito verify mockedObject          someMethodOnMockedObject                Mockito  lt SomeObjectAsArgument gt anyObject      Instead of doing anyObject   i want to check that argument object contains some particular fields  Mockito verify mockedObject          someMethodOnMockedObject                Mockito  lt SomeObjectAsArgument gt   compareWithThisObject

User · Answer

New feature added to Mockito makes this even easier,

ArgumentCaptor<Person> argument = ArgumentCaptor.forClass(Person.class);
verify(mock).doSomething(argument.capture());
assertEquals("John", argument.getValue().getName());

Take a look at Mockito documentation

In case when there are more than one parameters, and capturing of only single param is desired, use other ArgumentMatchers to wrap the rest of the arguments:

verify(mock).doSomething(eq(someValue), eq(someOtherValue), argument.capture());
assertEquals("John", argument.getValue().getName());

User · Answer

The solutions above didn t really work in my case  I couldn t use ArgumentCaptor as the method was called several times and I needed to validate each one  A simple Matcher with  argThat  did the trick easily    Custom Matcher     custom matcher private class PolygonMatcher extends ArgumentMatcher lt PolygonOptions gt        private int fillColor      public PolygonMatcher int fillColor            this fillColor   fillColor              Override     public boolean matches Object argument            if    argument instanceof PolygonOptions   return false          PolygonOptions arg    PolygonOptions argument          return Color red arg getFillColor       Color red fillColor                   amp  amp  Color green arg getFillColor       Color green fillColor                   amp  amp  Color blue arg getFillColor       Color blue fillColor             Test Runner     do setup work setup    3 light green polygons int green   getContext   getResources   getColor R color dmb rx bucket1   verify map  times 3   addPolygon argThat new PolygonMatcher green         1 medium yellow polygons int yellow   getContext   getResources   getColor R color dmb rx bucket4       verify map  times 1   addPolygon argThat new PolygonMatcher yellow         3 red polygons int orange   getContext   getResources   getColor R color dmb rx bucket5   verify map  times 3   addPolygon argThat new PolygonMatcher orange         2 red polygons int red   getContext   getResources   getColor R color dmb rx bucket7   verify map  times 2   addPolygon argThat new PolygonMatcher red

User · Answer

A simplified solution  without creating a new Matcher implementation class and using lambda expression  verify mockObject  someMockMethod          argThat  SomeArgument arg  - gt  arg fieldToMatch equals expectedFieldValue

User · Answer

The javadoc for refEq mentioned that the equality check is shallow  You can find more details at the link below  https   static javadoc io org mockito mockito-core 2 2 29 org mockito ArgumentMatchers html refEq T  20java lang String      quot shallow equality quot  issue cannot be controlled when you use other classes which don t implement  equals   method  quot DefaultMongoTypeMapper quot  class is an example  where  equals   method is not implemented  org springframework beans factory support offers a method that can generate a bean definition instead of creating an instance of the object  and it can be used to git rid of Comparison Failure   genericBeanDefinition DefaultMongoTypeMapper class                           setScope SCOPE SINGLETON                           setAutowireMode AUTOWIRE CONSTRUCTOR                           setLazyInit false                           addConstructorArgValue null                           getBeanDefinition       quot The bean definition is only a description of the bean  not a bean itself  the bean descriptions properly implement equals   and hashCode    so rather than creating a new DefaultMongoTypeMapper   we provide a definition that tells spring how it should create one quot  In your example  you can do somethong like this Mockito verify mockedObject          doSoething genericBeanDefinition YourClass class  setA  quot a quot           getBeanDefinition

User · Answer

And very nice and clean solution in koltin from com nhaarman mockito kotlin  verify mock  execute argThat       this param   expected

User · Answer

Another easy way to do so   import org mockito BDDMockito      import static org mockito Matchers argThat  import org mockito ArgumentMatcher   BDDMockito verify mockedObject           someMethodOnMockedObject argThat new ArgumentMatcher lt TypeOfMethodArg gt                    Override             public boolean matches Object argument                    final TypeOfMethodArg castedArg    TypeOfMethodArg  argument                      Make your verifications and return a boolean to say if it matches or not                 boolean isArgMarching   true                   return isArgMarching

User · Answer

One more possibility  if you don t want to use ArgumentCaptor  for example  because you re also using stubbing   is to use Hamcrest Matchers in combination with Mockito   import org mockito Mockito import org hamcrest Matchers      Mockito verify mockedObject  someMethodOnMockedObject MockitoHamcrest argThat      Matchers  lt SomeObjectAsArgument gt hasProperty  propertyName   desiredValue

User · Answer

If you re using Java 8  you can use Lambda expressions to match   import java util Optional  import java util function Predicate   import org hamcrest BaseMatcher  import org hamcrest Description   public class LambdaMatcher lt T gt  extends BaseMatcher lt T gt        private final Predicate lt T gt  matcher      private final Optional lt String gt  description       public LambdaMatcher Predicate lt T gt  matcher                this matcher  null              public LambdaMatcher Predicate lt T gt  matcher  String description                this matcher   matcher          this description   Optional ofNullable description               SuppressWarnings  unchecked        Override     public boolean matches Object argument                return matcher test  T  argument               Override     public void describeTo Description description                this description ifPresent description  appendText             Example call   Test public void canFindEmployee         Employee employee   new Employee  John        company addEmployee employee        verify mockedDal  registerEmployee argThat new LambdaMatcher lt  gt  e - gt  e getName                                                                             equals employee getName            More info  http   source coveo com 2014 10 01 java8-mockito

User · Answer

You can refer the following   Mockito verify mockedObject  someMethodOnMockedObject eq desiredObject     This will verify whether method of mockedObject is called with desiredObject as parameter

User · Answer

This is answer based on answer from iraSenthil but with annotation  Captor   In my opinion it has some advantages    it s shorter it s easier to read it can handle generics without warnings   Example    RunWith MockitoJUnitRunner class  public class SomeTest        Captor     private ArgumentCaptor lt List lt SomeType gt  gt  captor                   Test      public void shouldTestArgsVals                           verify mockedObject  someMethodOnMockedObject captor capture              assertThat captor getValue   getXXX    is  expected

User · Answer

I think the easiest way for verifying an argument object is to use the refEq method  Mockito verify mockedObject  someMethodOnMockedObject ArgumentMatchers refEq objectToCompareWith     It can be used even if the object doesn t implement equals    because reflection is used  If you don t want to compare some fields  just add their names as arguments for refEq

[java] Verify object attribute value with mockito

Examples related to java

Examples related to mocking

Examples related to mockito