Argument matchers (any, eq) in JUnit

Introduction

Argument matchers help you check if a method was called with certain values during testing. They make tests flexible and clear.

When you want to verify a method was called with any value of a certain type.

When you want to check a method was called with an exact value.

When you want to avoid writing many tests for different input values.

When you want to simplify tests by ignoring some arguments.

When you want to combine exact and flexible checks in one test.

Syntax

JUnit

verify(mockObject).methodName(any(Type.class));
verify(mockObject).methodName(eq(expectedValue));

any(Type.class) matches any value of the given type.

eq(value) matches exactly the given value.

Examples

This checks if createUser was called with any String value.

JUnit

verify(userService).createUser(any(String.class));

This checks if createUser was called exactly with the string "Alice".

JUnit

verify(userService).createUser(eq("Alice"));

This checks if placeOrder was called with order ID 123 and any integer quantity.

JUnit

verify(orderService).placeOrder(eq(123), any(Integer.class));

Sample Program

This test class mocks UserService. The first test checks if createUser was called with any string. The second test checks if it was called with the exact string "Alice".

JUnit

import static org.mockito.Mockito.*;
import org.junit.jupiter.api.Test;

class UserService {
    void createUser(String name) {
        // Imagine user creation logic here
    }
}

public class UserServiceTest {
    @Test
    void testCreateUserCalledWithAnyName() {
        UserService mockUserService = mock(UserService.class);

        mockUserService.createUser("Bob");

        // Verify method called with any String
        verify(mockUserService).createUser(any(String.class));
    }

    @Test
    void testCreateUserCalledWithExactName() {
        UserService mockUserService = mock(UserService.class);

        mockUserService.createUser("Alice");

        // Verify method called with exact name "Alice"
        verify(mockUserService).createUser(eq("Alice"));
    }
}

Important Notes

Use any() when you don't care about the exact argument value.

Use eq() when you want to check for a specific value.

Mixing matchers and raw values in the same method call is not allowed; use matchers for all arguments.

Summary

Argument matchers help verify method calls flexibly.

any() matches any value of a type.

eq() matches an exact value.

Practice

1. What does the any() argument matcher do in JUnit Mockito tests?

easy

A. It matches any value of the specified type.

B. It matches only null values.

C. It matches only exact values.

D. It matches values that are greater than zero.

Solution

1. Step 1: Understand the purpose of any()

   The any() matcher is used to accept any argument of a given type in method verification or stubbing.

2. Step 2: Compare with other matchers

   Unlike eq(), which matches exact values, any() is flexible and matches all values of the specified type.

3. Final Answer:

   It matches any value of the specified type. -> Option A

4. Quick Check:

   any() = matches any value [OK]

Hint: Remember: any() accepts all values of a type [OK]

Common Mistakes:

• Confusing any() with eq()
• Thinking any() matches only null
• Assuming any() matches only specific values

2. Which of the following is the correct syntax to verify a method call with an exact argument value using an argument matcher in Mockito?

easy

A. verify(mock).method(any(String.class));

B. verify(mock).method(any());

C. verify(mock).method(eq("test"));

D. verify(mock).method("test");

Solution

1. Step 1: Identify correct use of eq()

   The eq() matcher is used to match an exact argument value in Mockito verification.

2. Step 2: Check syntax correctness

   verify(mock).method(eq("test")); correctly uses eq("test") to verify the method was called with the exact string "test".

3. Final Answer:

   verify(mock).method(eq("test")); -> Option C

4. Quick Check:

   Exact value match = eq() [OK]

Hint: Use eq() to match exact argument values [OK]

Common Mistakes:

• Using any() when exact match is needed
• Omitting eq() for exact value
• Using any() without specifying type

3. Consider the following code snippet:

when(service.process(any(String.class))).thenReturn("done");
String result = service.process("input");

What will be the value of result after execution?

medium

A. "input"

B. null

C. Throws an exception

D. "done"

Solution

1. Step 1: Analyze the stubbing with any()

   The when clause uses any(String.class) to match any string argument and returns "done".

2. Step 2: Check the method call argument

   The method is called with "input", which matches any(String.class), so the stub returns "done".

3. Final Answer:

   "done" -> Option D

4. Quick Check:

   any(String.class) matches "input" = returns "done" [OK]

Hint: any() matches all inputs, so stub returns specified value [OK]

Common Mistakes:

• Assuming method returns input argument
• Thinking any() causes exception
• Ignoring stubbing behavior

4. Identify the error in the following Mockito verification code:

verify(mock).update(eq("data"), any());

medium

A. eq() cannot be used with any().

B. Missing type parameter in any() matcher.

C. verify() should not be used with matchers.

D. No error; code is correct.

Solution

1. Step 1: Check usage of any()

   The any() matcher requires a type parameter like any(String.class) to specify the argument type.

2. Step 2: Confirm correct matcher usage

   Without the type, Mockito cannot determine the argument type, causing a compilation error.

3. Final Answer:

   Missing type parameter in any() matcher. -> Option B

4. Quick Check:

   any() needs type like any(String.class) [OK]

Hint: Always specify type in any() like any(String.class) [OK]

Common Mistakes:

• Using any() without type parameter
• Mixing eq() and any() incorrectly
• Assuming verify() disallows matchers

5. You want to verify a method call that takes two arguments: a String and an Integer. The first argument must be exactly "test", and the second can be any Integer. Which Mockito verification is correct?

hard

A. verify(mock).method(eq("test"), any(Integer.class));

B. verify(mock).method(any(String.class), eq(1));

C. verify(mock).method(any(), any());

D. verify(mock).method(eq("test"), eq(1));

Solution

1. Step 1: Match exact first argument

   The first argument must be exactly "test", so use eq("test").

2. Step 2: Match any Integer second argument

   The second argument can be any Integer, so use any(Integer.class).

3. Step 3: Verify combined usage

   verify(mock).method(eq("test"), any(Integer.class)); correctly combines eq() and any() for the two arguments.

4. Final Answer:

   verify(mock).method(eq("test"), any(Integer.class)); -> Option A

5. Quick Check:

   eq() + any(type) = exact + any argument [OK]

Hint: Use eq() for exact, any(type) for flexible args [OK]

Common Mistakes:

• Swapping argument matchers incorrectly
• Using any() without type
• Using eq() for flexible arguments