Annotation Type Mock

@Target({FIELD,PARAMETER}) @Retention(RUNTIME) @Documented public @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(strictness = Mock.Strictness.LENIENT) private ArticleConsumer articleConsumer;
      @Mock(stubOnly = true) private Logger logger;

      private ArticleManager manager;

      @Before public void setup() {
          manager = new ArticleManager(userProvider, database, calculator, articleMonitor, articleConsumer, 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. 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.

See Also: