Package ru.vyarus.dropwizard.guice.test.jupiter.ext.mock

Annotation Interface MockBean

@Retention(RUNTIME) @Target(FIELD) public @interface MockBean
Replace any guice service with mockito mock in test (using guice module overrides).

Important: requires mockito dependency!

Example: @MockBean Service mock. May be used for static and instance fields.

Note: could be used for spy objects creation: @MockBean Service spy = Mockito.spy(instance). This might be useful in cases when service bound by instance and automatic spy (@SpyBean) can't be used.

Mock field might be initialized manually: @MockBean Service mock = Mockito.mock(Service.class). Manual mocks in instance field must be synchronized with the correct guicey extension declaration (by default, injector created per test class and test instance created per method, so it is impossible to "see" mocks declared in instance fields). Incorrect usage would be immediately reported with error.

Mock stubs could be configured in test beforeEach method: Mockito.when(mock).something().thenReturn("ok").

Note that you can use StubBean with manual mock initialization with the almost same result, except it would not be cleared before each test.

Mocks reset called after each test method. Could be disabled with autoReset()

Could also be used for spy objects registration of beans bound by instance (!) (so SpyBean could not be used): @MockBean Service spy = Mockito.spy(new Service()). Spy should also be used when mock must be created from an abstract class (preserving abstract methods): @MockBean AbstractService mock = Mockito.spy(AbstractService.class).

Mockito provide the detailed report of used mock methods and redundant stub definitions. Use printSummary() to enable this report (printed after each test method).

Guicey extension debug (TestGuiceyApp.debug()) enables mock fields debug: all recognized annotated fields would be printed to console.

Limitation: any aop, applied to the original bean, will not work with mock (because guice can't apply aop to instances)! Use SpyBean instead if aop is important. Does not work for HK2 beans.

Since:
10.02.2025

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    autoReset
    Note: mock could be reset manually with Mockito.reset(Object[]).
    boolean
    printSummary
    Native mockito mock usage report: shows called methods and stubbed, but not used methods.

  • Element Details

    • autoReset

      boolean autoReset
      Note: mock could be reset manually with Mockito.reset(Object[]).
      Returns:
      true to reset mock after each test method
      Default:
      true

    • printSummary

      boolean printSummary
      Native mockito mock usage report: shows called methods and stubbed, but not used methods.
      Returns:
      true to print mock summary after each test
      Default:
      false