Module org.mockito
Package org.mockito.session

Interface MockitoSessionBuilder

@NotExtensible public interface MockitoSessionBuilder
Fluent builder interface for MockitoSession objects. See the documentation and examples in Javadoc for MockitoSession.
Since:
2.7.0

  • Method Details

    • initMocks

      MockitoSessionBuilder initMocks(Object testClassInstance)
      Adds the test class instance for initialization of fields annotated with Mockito annotations like Mock. When this method is invoked it does not perform initialization of mocks on the spot! Only when startMocking() is invoked then annotated fields will be initialized. Traditional API to initialize mocks, the MockitoAnnotations.openMocks(Object) method has limited support for driving cleaner tests because it does not support configuring Strictness. Want cleaner tests and better productivity? Migrate from MockitoAnnotations.openMocks(Object) to MockitoSession!

      This method may be called multiple times to add multiple, e.g. nested, test class instances.

      See code sample in MockitoSession.

      Parameters:
      testClassInstance - test class instance that contains fields with Mockito annotations to be initialized. Passing null is permitted but will be ignored.
      Returns:
      the same builder instance for fluent configuration of MockitoSession.
      Since:
      2.7.0

    • initMocks

      MockitoSessionBuilder initMocks(Object... testClassInstances)
      Adds the test class instances for initialization of fields annotated with Mockito annotations like Mock.

      In most scenarios, you only need to init mocks on a single test class instance. This method is useful for advanced framework integrations (like JUnit Jupiter), when a test uses multiple, e.g. nested, test class instances.

      This method calls initMocks(Object) for each passed test class instance.

      Parameters:
      testClassInstances - test class instances that contains fields with Mockito annotations to be initialized. Passing null or an empty array is permitted but will be ignored.
      Returns:
      the same builder instance for fluent configuration of MockitoSession.
      Since:
      2.15.0
      See Also:

    • name

      MockitoSessionBuilder name(String name)
      Configures the name of the MockitoSession instance.

      The name is used to output hints when finishing a session.

      This method is intended to be used by framework integrations, e.g. JUnit. When building a MockitoSession for direct use, users are not expected to call it.

      Parameters:
      name - of MockitoSession instance. Passing null is permitted and will make the session use a default value. The current default is the name of the last test class instance passed to initMocks(Object) or initMocks(Object...), if available; otherwise, "<Unnamed Session>" is used.
      Returns:
      the same builder instance for fluent configuration of MockitoSession.
      Since:
      2.15.0
      See Also:

    • strictness

      MockitoSessionBuilder strictness(Strictness strictness)
      Configures strictness of MockitoSession instance. See examples in MockitoSession.
      Parameters:
      strictness - for MockitoSession instance. Passing null is permitted and will make the session use a default value. The current default is Strictness.STRICT_STUBS.
      Returns:
      the same builder instance for fluent configuration of MockitoSession.
      Since:
      2.7.0

    • logger

      MockitoSessionBuilder logger(MockitoSessionLogger logger)
      Configures logger used by MockitoSession for emitting warnings when finishing the session.

      Please note that the use of strict stubs is recommended over emitting warnings because warnings are easily ignored and spoil the log output. Instead of using this method, please consider setting strictness with strictness(Strictness).

      Parameters:
      logger - for warnings emitted when finishing MockitoSession. Passing null is permitted and will make the session use a default value. By default, warnings will be logged to the console.
      Returns:
      the same builder instance for fluent configuration of MockitoSession.
      Since:
      2.15.0
      See Also:

    • startMocking

      MockitoSession startMocking() throws UnfinishedMockingSessionException
      Starts new mocking session! Creates new MockitoSession instance to initialize the session. At this point annotated fields are initialized per initMocks(Object) method. When you are done with the session it is required to invoke MockitoSession.finishMocking(). This will trigger stubbing validation, cleaning up the internal state like removal of internal listeners.

      Mockito tracks created sessions internally and prevents the user from creating new sessions without using MockitoSession.finishMocking(). When you run tests concurrently in multiple threads, it is legal for each thread to have single active Mockito session. When you attempt to start new session in a thread that already has an unfinished session UnfinishedMockingSessionException will be triggered.

      See examples in MockitoSession.

      Returns:
      new MockitoSession instance
      Throws:
      UnfinishedMockingSessionException - when previous session was not concluded with MockitoSession.finishMocking()
      Since:
      2.7.0