TestMu Conference is Back! Future of Testing + AI LambdaTest G2 Announcement

How to use CapturingMatcher class of org.mockito.internal.matchers package

Best Mockito code snippet using org.mockito.internal.matchers.CapturingMatcher

Source:ArgumentCaptor.java

...5package org.mockito;67import java.util.List;89import org.mockito.internal.matchers.CapturingMatcher;10import org.mockito.internal.progress.HandyReturnValues;1112/**13 * Use it to capture argument values for further assertions.14 * <p>15 * Mockito verifies argument values in natural java style: by using an equals() method.16 * This is also the recommended way of matching arguments because it makes tests clean & simple.17 * In some situations though, it is helpful to assert on certain arguments after the actual verification.18 * For example:19 * <pre>20 *   ArgumentCaptor&lt;Person&gt; argument = ArgumentCaptor.forClass(Person.class);21 *   verify(mock).doSomething(argument.capture());22 *   assertEquals("John", argument.getValue().getName());23 * </pre>24 *25 * <p>26 * <b>Warning:</b> it is recommended to use ArgumentCaptor with verification <b>but not</b> with stubbing.27 * Using ArgumentCaptor with stubbing may decrease test readability because captor is created outside of assert (aka verify or 'then') block.28 * Also it may reduce defect localization because if stubbed method was not called then no argument is captured.29 * <p>30 * In a way ArgumentCaptor is related to custom argument matchers (see javadoc for {@link ArgumentMatcher} class).31 * Both techniques can be used for making sure certain arguments where passed to mocks. 32 * However, ArgumentCaptor may be a better fit if:33 * <ul>  34 * <li>custom argument matcher is not likely to be reused</li>35 * <li>you just need it to assert on argument values to complete verification</li>36 * </ul>37 * Custom argument matchers via {@link ArgumentMatcher} are usually better for stubbing.38 * <p>39 * There is an <b>annotation</b> that you might find useful: &#64;{@link Captor}40 * <p>41 * See the full documentation on Mockito in javadoc for {@link Mockito} class.    42 */43public class ArgumentCaptor<T> {44    45    HandyReturnValues handyReturnValues = new HandyReturnValues();4647    private final CapturingMatcher<T> capturingMatcher = new CapturingMatcher<T>();48    private final Class<T> clazz;4950    /**51     * @deprecated52     * 53     * <b>Please use factory method {@link ArgumentCaptor#forClass(Class)} to create captors</b>54     * <p>55     * This is required to avoid NullPointerExceptions when autoUnboxing primitive types.56     * See issue 99.57     * <p>58     * Example:59     * <pre>60     *   ArgumentCaptor&lt;Person&gt; argument = ArgumentCaptor.forClass(Person.class);61     *   verify(mock).doSomething(argument.capture());
...

CapturingMatcher

Using AI Code Generation

1public class CapturingMatcher<T> implements ArgumentMatcher<T> {2    private T value;3    public boolean matches(T argument) {4        value = argument;5        return true;6    }7    public T getValue() {8        return value;9    }10}11public class CapturingMatcherTest {12    public void testCapturingMatcher() {13        CapturingMatcher<String> matcher = new CapturingMatcher<String>();14        List<String> mockedList = mock(List.class);15        mockedList.add("one");16        verify(mockedList).add(argThat(matcher));17        assertEquals("one", matcher.getValue());18    }19}20CapturingMatcherTest.java:23: warning: [deprecation] CapturingMatcher() in CapturingMatcher has been deprecated21        CapturingMatcher<String> matcher = new CapturingMatcher<String>();22CapturingMatcherTest.java:24: warning: [unchecked] unchecked call to mock(Class<T>) as a member of the raw type Mockito23        List<String> mockedList = mock(List.class);24    T extends Object declared in method <T>mock(Class<T>)25CapturingMatcherTest.java:25: warning: [unchecked] unchecked call to verify(T) as a member of the raw type Mockito26        verify(mockedList).add(argThat(matcher));27    T extends Object declared in method <T>mock(Class<T>)28CapturingMatcherTest.java:26: warning: [unchecked] unchecked call to assertEquals(T,T) as a member of the raw type Assert29        assertEquals("one", matcher.getValue());30    T extends Object declared in method <T>mock(Class<T>)31CapturingMatcherTest.java:26: warning: [unchecked] unchecked call to getValue() as a member of the raw type CapturingMatcher32        assertEquals("one", matcher.getValue());33    T extends Object declared in method <T>mock(Class<T>)34CapturingMatcherTest.java:26: warning: [unchecked] unchecked call to getValue() as a member of the raw type CapturingMatcher35        assertEquals("one", matcher.getValue());36    T extends Object declared in method <T>mock(Class<T>)

CapturingMatcher

Using AI Code Generation

1import org.junit.Test;2import org.mockito.ArgumentCaptor;3import org.mockito.Captor;4import org.mockito.Mockito;5import static org.junit.Assert.*;6import static org.mockito.Mockito.*;7public class CapturingMatcherTest {8    private ArgumentCaptor<String> captor;9    public void test() {10        List mockedList = mock(List.class);11        mockedList.add("one");12        mockedList.clear();13        verify(mockedList).add(captor.capture());14        assertEquals("one", captor.getValue());15        verify(mockedList).clear();16    }17}18        verify(mockedList).add(captor.capture());19  symbol:   method capture()20        assertEquals("one", captor.getValue());21  symbol:   method getValue()22        verify(mockedList).clear();23  symbol:   method verify(List)24        verify(mockedList).clear();25  symbol:   method clear()26        verify(mockedList).clear();27  symbol:   method clear()28        verify(mockedList).clear();29  symbol:   method clear()30        verify(mockedList).clear();31  symbol:   method clear()32        verify(mockedList).clear();33  symbol:   method clear()

CapturingMatcher

Using AI Code Generation

1ArgumentCaptor<Log> argument = ArgumentCaptor.forClass(Log.class);2verify(mock).log(argument.capture());3Log log = argument.getValue();4List<Log> logs = argument.getAllValues();5Log log = argument.getAllValues().get(0);6List<Log> logs = argument.getAllValues().subList(0, 2);7Log log = argument.getAllValues().get(0);8List<Log> logs = argument.getAllValues().subList(0, 2);9Log log = argument.getAllValues().get(0);10List<Log> logs = argument.getAllValues().subList(0, 2);11Log log = argument.getAllValues().get(0);12List<Log> logs = argument.getAllValues().subList(0, 2);13Log log = argument.getAllValues().get(0);14List<Log> logs = argument.getAllValues().subList(0, 2);15Log log = argument.getAllValues().get(0);16List<Log> logs = argument.getAllValues().subList(0, 2);17Log log = argument.getAllValues().get(0);18List<Log> logs = argument.getAllValues().subList(0, 2);19Log log = argument.getAllValues().get(0);20List<Log> logs = argument.getAllValues().subList(0, 2);21Log log = argument.getAllValues().get(0);22List<Log> logs = argument.getAllValues().subList(0, 2);23Log log = argument.getAllValues().get(0);24List<Log> logs = argument.getAllValues().subList(0, 2);

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.