Mockito dependency setup in JUnit - Build an Automation Script

Verify Mockito dependency setup in a JUnit project

Preconditions (2)

Step 1: Add Mockito dependency to the project's build configuration file (pom.xml for Maven or build.gradle for Gradle)

Step 2: Create a simple test class using JUnit 5

Step 3: Annotate a field with @Mock from Mockito

Step 4: Initialize mocks using MockitoAnnotations.openMocks(this) in a setup method

Step 5: Write a test method that uses the mocked object

Step 6: Run the test

✅ Expected Result: The test runs successfully without errors, indicating Mockito is correctly set up and mocks are working

Automation Requirements - JUnit 5 with Mockito

Assertions Needed:

Test method executes without exceptions

Mocked object is not null

MockitoAnnotations.openMocks(this) initializes mocks properly

Best Practices:

Use @Mock annotation for mock objects

Initialize mocks in a @BeforeEach setup method

Use explicit imports for Mockito and JUnit

Keep test class simple and focused on verifying setup

Automated Solution

JUnit

import static org.junit.jupiter.api.Assertions.assertNotNull;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;

public class MockitoSetupTest {

    @Mock
    private Runnable mockRunnable;

    @BeforeEach
    void setUp() {
        MockitoAnnotations.openMocks(this);
    }

    @Test
    void testMockIsInitialized() {
        assertNotNull(mockRunnable, "Mock should be initialized");
    }
}

This test class shows how to set up Mockito in a JUnit 5 project.

We import necessary classes from JUnit and Mockito.

The @Mock annotation marks mockRunnable as a mock object.

In the @BeforeEach method setUp(), we call MockitoAnnotations.openMocks(this) to initialize all mocks annotated with @Mock.

The test method testMockIsInitialized() asserts that the mock object is not null, confirming Mockito is set up correctly.

This simple test ensures the dependency is correctly added and mocks work as expected.

Common Mistakes - 4 Pitfalls

{'mistake': 'Not adding Mockito dependency in the build file', 'why_bad': "Without the dependency, Mockito classes won't be found and tests will fail to compile.", 'correct_approach': 'Add the correct Mockito dependency in pom.xml or build.gradle before writing tests.'}

Forgetting to initialize mocks with MockitoAnnotations.openMocks(this)

{'mistake': 'Using @Mock without importing it from Mockito', 'why_bad': "The annotation won't be recognized and tests won't compile.", 'correct_approach': 'Import org.mockito.Mock explicitly.'}

Mixing JUnit 4 and JUnit 5 annotations

Bonus Challenge

Add a test that mocks a List and verifies a method call

Show Hint

Practice

1. What is the main purpose of setting up Mockito as a dependency in a JUnit project?

easy

A. To automatically generate user interfaces

B. To create fake objects for testing without using real implementations

C. To improve the performance of the application in production

D. To deploy the application to a server

Solution

1. Step 1: Understand Mockito's role

   Mockito is a tool used to create mock objects that simulate real objects in tests.

2. Step 2: Identify the purpose in testing

   Using mocks helps isolate the code under test by replacing dependencies with fake versions.

3. Final Answer:

   To create fake objects for testing without using real implementations -> Option B

4. Quick Check:

   Mockito = mock objects for testing [OK]

Hint: Mockito creates fake objects to test code easily [OK]

Common Mistakes:

• Thinking Mockito improves production performance
• Confusing Mockito with UI tools
• Assuming Mockito deploys applications

2. Which of the following is the correct Maven dependency snippet to add Mockito version 4.11.0 for test scope?

easy

A.
org.mockito
mockito-core
4.11.0
test

B.
org.mockito
mockito-core
4.11.0

C.
org.mockito
mockito-all
3.0.0
compile

D.
org.mockito
mockito-core
5.0.0
test

Solution

1. Step 1: Check groupId and artifactId

   The correct groupId is 'org.mockito' and artifactId is 'mockito-core' for Mockito library.

2. Step 2: Verify version and scope

   Version 4.11.0 is correct and scope should be 'test' to use Mockito only during testing.

3. Final Answer:

   Correct Maven dependency with version 4.11.0 and test scope -> Option A

4. Quick Check:

   Maven dependency with test scope = org.mockito mockito-core 4.11.0 test [OK]

Hint: Use 'mockito-core' with test scope and correct version [OK]

Common Mistakes:

• Omitting the test scope
• Using wrong artifactId like 'mockito-all'
• Using incorrect or too new version

3. You want to use Mockito in a JUnit 5 project with Gradle. Which of the following Gradle dependency setups correctly adds Mockito version 4.11.0 only for test implementation?

easy

A. testImplementation 'org.mockito:mockito-core:4.11.0'

B. implementation 'org.mockito:mockito-core:4.11.0'

C. compileOnly 'org.mockito:mockito-core:4.11.0'

D. runtimeOnly 'org.mockito:mockito-core:4.11.0'

Solution

1. Step 1: Understand Gradle scopes

   testImplementation means the dependency is available only during test compilation and runtime.

2. Step 2: Choose correct scope for Mockito

   Mockito is used only in tests, so testImplementation is the correct scope.

3. Final Answer:

   testImplementation 'org.mockito:mockito-core:4.11.0' -> Option A

4. Quick Check:

   Mockito test dependency = testImplementation [OK]

Hint: Use testImplementation for test-only dependencies in Gradle [OK]

Common Mistakes:

• Using implementation instead of testImplementation
• Using compileOnly which excludes runtime
• Using runtimeOnly which excludes compile time

4. Given the following JUnit test code snippet using Mockito, what will be the output of System.out.println(mockService.getData());?

import static org.mockito.Mockito.*;

public class ServiceTest {
  @Test
  void testGetData() {
    DataService mockService = mock(DataService.class);
    when(mockService.getData()).thenReturn("Mocked Data");
    System.out.println(mockService.getData());
  }
}

medium

A. Original data from DataService

B. null

C. Throws NullPointerException

D. Mocked Data

Solution

1. Step 1: Understand mock behavior

   The mock object returns what is specified in when().thenReturn(), here "Mocked Data".

2. Step 2: Check the printed output

   Calling getData() on mockService returns "Mocked Data", so it prints that string.

3. Final Answer:

   Mocked Data -> Option D

4. Quick Check:

   Mockito when().thenReturn() sets output = Mocked Data [OK]

Hint: when().thenReturn() sets mock method output [OK]

Common Mistakes:

• Expecting null because it's a mock
• Assuming real method runs
• Thinking it throws an exception

5. Identify the error in the following Mockito setup code snippet:

import static org.mockito.Mockito.*;

public class UserServiceTest {
  @Mock
  UserRepository repo;

  @Test
  void testUser() {
    when(repo.findUser()).thenReturn(new User("Alice"));
    UserService service = new UserService(repo);
    assertEquals("Alice", service.getUserName());
  }
}

medium

A. Incorrect method name findUser() should be getUser()

B. UserService constructor should not accept repo

C. Missing MockitoAnnotations.openMocks(this) to initialize @Mock fields

D. assertEquals parameters are reversed

Solution

1. Step 1: Check @Mock initialization

   @Mock fields need initialization, usually by calling MockitoAnnotations.openMocks(this) in setup.

2. Step 2: Verify test setup completeness

   Without initialization, repo remains null causing NullPointerException when used.

3. Final Answer:

   Missing MockitoAnnotations.openMocks(this) to initialize @Mock fields -> Option C

4. Quick Check:

   @Mock requires initialization = Missing MockitoAnnotations.openMocks(this) to initialize @Mock fields [OK]

Hint: Always initialize @Mock with MockitoAnnotations.openMocks(this) [OK]

Common Mistakes:

• Forgetting to initialize @Mock fields
• Assuming @Mock works without setup
• Mixing method names without checking