Package org.mockito
Annotation Interface Mock
Mark a field as a mock.
- Allows shorthand mock creation.
- Minimizes repetitive mock creation code.
- Makes the test class more readable.
- Makes the verification error easier to read because the field name is used to identify the mock.
- Automatically detects static mocks of type
MockedStatic
and infers the static mock type of the type parameter.
public class ArticleManagerTest extends SampleBaseTestCase {
@Mock private ArticleCalculator calculator;
@Mock(name = "database") private ArticleDatabase dbMock;
@Mock(answer = RETURNS_MOCKS) private UserProvider userProvider;
@Mock(extraInterfaces = {Queue.class, Observer.class}) private ArticleMonitor articleMonitor;
@Mock(stubOnly = true) private Logger logger;
private ArticleManager manager;
@Before public void setup() {
manager = new ArticleManager(userProvider, database, calculator, articleMonitor, logger);
}
}
public class SampleBaseTestCase {
private AutoCloseable closeable;
@Before public void openMocks() {
closeable = MockitoAnnotations.openMocks(this);
}
@After public void releaseMocks() throws Exception {
closeable.close();
}
}
MockitoAnnotations.openMocks(this)
method has to be called to initialize annotated objects.
In above example, openMocks()
is called in @Before (JUnit4) method of test's base class.
For JUnit3 openMocks()
can go to setup()
method of a base class.
Instead you can also put openMocks() in your JUnit runner (@RunWith) or use the built-in
MockitoJUnitRunner
. Also, make sure to release any mocks after disposing your test class with a corresponding hook.
-
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionMock will have custom answer, seeMockSettings.defaultAnswer(Answer)
.Class<?>[]
Mock will have extra interfaces, seeMockSettings.extraInterfaces(Class[])
.boolean
Mock will be lenient, seeMockSettings.lenient()
.Mock will have custom name (shown in verification errors), seeMockSettings.name(String)
.boolean
Mock will be serializable, seeMockSettings.serializable()
.boolean
Mock will be 'stubOnly', seeMockSettings.stubOnly()
.
-
Element Details
-
answer
Answers answerMock will have custom answer, seeMockSettings.defaultAnswer(Answer)
. For examples how to use 'Mock' annotation and parameters seeMock
.- Default:
- RETURNS_DEFAULTS
-
stubOnly
boolean stubOnlyMock will be 'stubOnly', seeMockSettings.stubOnly()
. For examples how to use 'Mock' annotation and parameters seeMock
.- Default:
- false
-
name
String nameMock will have custom name (shown in verification errors), seeMockSettings.name(String)
. For examples how to use 'Mock' annotation and parameters seeMock
.- Default:
- ""
-
extraInterfaces
Class<?>[] extraInterfacesMock will have extra interfaces, seeMockSettings.extraInterfaces(Class[])
. For examples how to use 'Mock' annotation and parameters seeMock
.- Default:
- {}
-
serializable
boolean serializableMock will be serializable, seeMockSettings.serializable()
. For examples how to use 'Mock' annotation and parameters seeMock
.- Default:
- false
-
lenient
boolean lenientMock will be lenient, seeMockSettings.lenient()
. For examples how to use 'Mock' annotation and parameters seeMock
.- Since:
- 2.23.3
- Default:
- false
-