How to use MockitoSession class of org.mockito package

Best Mockito code snippet using org.mockito.MockitoSession

Source:MockitoSessionBuilder.java

...4 */5package org.mockito.session;6import org.mockito.Incubating;7import org.mockito.MockitoAnnotations;8import org.mockito.MockitoSession;9import org.mockito.exceptions.misusing.UnfinishedMockingSessionException;10import org.mockito.quality.Strictness;11/**12 * Fluent builder interface for {@code MockitoSession} objects.13 * See the documentation and examples in Javadoc for {@link MockitoSession}.14 *15 * @since 2.7.016 */17@Incubating18public interface MockitoSessionBuilder {19    /**20     * Adds the test class instance for initialization of fields annotated with Mockito annotations21     * like {@link org.mockito.Mock}.22     * When this method is invoked it <strong>does not perform</strong> initialization of mocks on the spot!23     * Only when {@link #startMocking()} is invoked then annotated fields will be initialized.24     * Traditional API to initialize mocks, the {@link MockitoAnnotations#initMocks(Object)} method25     * has limited support for driving cleaner tests because it does not support configuring {@link Strictness}.26     * Want cleaner tests and better productivity?27     * Migrate from {@link MockitoAnnotations#initMocks(Object)}28     * to {@link MockitoSession}!29     * <p>30     * This method may be called multiple times to add multiple, e.g. nested, test class instances.31     * <p>32     * See code sample in {@link MockitoSession}.33     *34     * @param testClassInstance test class instance that contains fields with Mockito annotations to be initialized.35     *  Passing {@code null} is permitted but will be ignored.36     * @return the same builder instance for fluent configuration of {@code MockitoSession}.37     * @since 2.7.038     */39    @Incubating40    MockitoSessionBuilder initMocks(Object testClassInstance);41    /**42     * Adds the test class instances for initialization of fields annotated with Mockito annotations43     * like {@link org.mockito.Mock}.44     * <p>45     * In most scenarios, you only need to init mocks on a single test class instance.46     * This method is useful for advanced framework integrations (like JUnit5), when a test uses multiple, e.g. nested, test class instances.47     * <p>48     * This method calls {@link #initMocks(Object)} for each passed test class instance.49     *50     * @param testClassInstances test class instances that contains fields with Mockito annotations to be initialized.51     *  Passing {@code null} or an empty array is permitted but will be ignored.52     * @return the same builder instance for fluent configuration of {@code MockitoSession}.53     * @see #initMocks(Object)54     * @since 2.15.055     */56    @Incubating57    MockitoSessionBuilder initMocks(Object... testClassInstances);58    /**59     * Configures the name of the {@code MockitoSession} instance.60     * <p>61     * The name is used to output {@linkplain org.mockito.quality.MockitoHint hints} when62     * {@linkplain MockitoSession#finishMocking() finishing} a session.63     * <p>64     * This method is intended to be used by framework integrations, e.g. JUnit. When building65     * a {@code MockitoSession} for direct use, users are not expected to call it.66     *67     * @param name of {@code MockitoSession} instance.68     *  Passing {@code null} is permitted and will make the session use a default value.69     *  The current default is the name of the last test class instance passed to70     *  {@link #initMocks(Object)} or {@link #initMocks(Object...)}, if available;71     *  otherwise, {@code "<Unnamed Session>"} is used.72     *73     * @return the same builder instance for fluent configuration of {@code MockitoSession}.74     * @see org.mockito.quality.MockitoHint75     * @since 2.15.076     */77    @Incubating78    MockitoSessionBuilder name(String name);79    /**80     * Configures strictness of {@code MockitoSession} instance.81     * See examples in {@link MockitoSession}.82     *83     * @param strictness for {@code MockitoSession} instance.84     *  Passing {@code null} is permitted and will make the session use a default value.85     *  The current default is {@link Strictness#STRICT_STUBS}.86     *87     * @return the same builder instance for fluent configuration of {@code MockitoSession}.88     * @since 2.7.089     */90    @Incubating91    MockitoSessionBuilder strictness(Strictness strictness);92    /**93     * Configures logger used by {@code MockitoSession} for emitting94     * {@linkplain org.mockito.quality.MockitoHint warnings} when finishing the session.95     * <p>96     * Please note that the use of {@linkplain Strictness#STRICT_STUBS strict stubs} is97     * recommended over emitting warnings because warnings are easily ignored and spoil the log output.98     * Instead of using this method, please consider setting strictness with {@link #strictness(Strictness)}.99     *100     * @param logger for warnings emitted when finishing {@code MockitoSession}.101     *  Passing {@code null} is permitted and will make the session use a default value.102     *  By default, warnings will be logged to the console.103     *104     * @return the same builder instance for fluent configuration of {@code MockitoSession}.105     * @see org.mockito.quality.MockitoHint106     * @since 2.15.0107     */108    @Incubating109    MockitoSessionBuilder logger(MockitoSessionLogger logger);110    /**111     * Starts new mocking session! Creates new {@code MockitoSession} instance to initialize the session.112     * At this point annotated fields are initialized per {@link #initMocks(Object)} method.113     * When you are done with the session it is required to invoke {@link MockitoSession#finishMocking()}.114     * This will trigger stubbing validation, cleaning up the internal state like removal of internal listeners.115     * <p>116     * Mockito tracks created sessions internally and prevents the user from creating new sessions without117     * using {@link MockitoSession#finishMocking()}.118     * When you run tests concurrently in multiple threads, it is legal for each thread to have single active Mockito session.119     * When you attempt to start new session in a thread that already has an unfinished session120     * {@link UnfinishedMockingSessionException} will be triggered.121     * <p>122     * See examples in {@link MockitoSession}.123     *124     * @return new {@code MockitoSession} instance125     * @since 2.7.0126     * @throws UnfinishedMockingSessionException127     *  when previous session was not concluded with {@link MockitoSession#finishMocking()}128     */129    @Incubating130    MockitoSession startMocking() throws UnfinishedMockingSessionException;131}...

Source:JUnitRule.java

2import org.junit.runners.model.FrameworkMethod;3import org.junit.runners.model.Statement;4import org.mockito.Mockito;5import org.mockito.MockitoAnnotations;6import org.mockito.MockitoSession;7import org.mockito.internal.session.MockitoSessionLoggerAdapter;8import org.mockito.junit.MockitoRule;9import org.mockito.plugins.MockitoLogger;10import org.mockito.quality.Strictness;11import org.mockito.session.MockitoSessionBuilder;12public class JUnitRule implements MockitoRule {13    /* access modifiers changed from: private */14    public final MockitoLogger logger;15    /* access modifiers changed from: private */16    public MockitoSession session;17    /* access modifiers changed from: private */18    public Strictness strictness;19    public JUnitRule(MockitoLogger mockitoLogger, Strictness strictness2) {20        this.logger = mockitoLogger;21        this.strictness = strictness2;22    }23    public Statement apply(final Statement statement, final FrameworkMethod frameworkMethod, final Object obj) {24        return new Statement() {25            public void evaluate() throws Throwable {26                if (JUnitRule.this.session == null) {27                    JUnitRule jUnitRule = JUnitRule.this;28                    MockitoSessionBuilder mockitoSession = Mockito.mockitoSession();29                    MockitoSession unused = jUnitRule.session = mockitoSession.name(obj.getClass().getSimpleName() + "." + frameworkMethod.getName()).strictness(JUnitRule.this.strictness).logger(new MockitoSessionLoggerAdapter(JUnitRule.this.logger)).initMocks(obj).startMocking();30                } else {31                    MockitoAnnotations.initMocks(obj);32                }33                Throwable evaluateSafely = evaluateSafely(statement);34                JUnitRule.this.session.finishMocking(evaluateSafely);35                if (evaluateSafely != null) {36                    throw evaluateSafely;37                }38            }39            private Throwable evaluateSafely(Statement statement) {40                try {41                    statement.evaluate();42                    return null;43                } catch (Throwable th) {44                    return th;45                }46            }47        };48    }49    public MockitoRule silent() {50        return strictness(Strictness.LENIENT);51    }52    public MockitoRule strictness(Strictness strictness2) {53        this.strictness = strictness2;54        MockitoSession mockitoSession = this.session;55        if (mockitoSession != null) {56            mockitoSession.setStrictness(strictness2);57        }58        return this;59    }60}

Source:MockitoSessionTestBase.java

1package uk.nhs.digital.test.mockito;2import org.junit.After;3import org.junit.Before;4import org.mockito.Mockito;5import org.mockito.MockitoSession;6import org.mockito.quality.Strictness;7/**8 * Makes it easier to use {@linkplain MockitoSession} (recommended by Mockito team)9 * in favour of, say, recently deprecated {@linkplain org.mockito.MockitoAnnotations#initMocks}.10 */11public class MockitoSessionTestBase {12    private MockitoSession mockitoSession;13    @Before14    public void initMocks() {15        mockitoSession = Mockito.mockitoSession()16            .initMocks(this)17            .strictness(Strictness.WARN)18            .startMocking();19    }20    @After21    public void releaseMocks() throws Exception {22        mockitoSession.finishMocking();23    }24}...

MockitoSession

Using AI Code Generation

1package com.automationrhapsody.mockito;2import org.junit.Test;3import org.junit.runner.RunWith;4import org.mockito.Mock;5import org.mockito.junit.MockitoJUnitRunner;6import java.util.ArrayList;7import java.util.List;8import static org.assertj.core.api.Assertions.assertThat;9import static org.mockito.Mockito.mock;10import static org.mockito.Mockito.when;11@RunWith(MockitoJUnitRunner.class)12public class MockitoSessionTest {13    private List<String> mockedList;14    public void testMockitoSession() {15        MockitoSession mockitoSession = Mockito.mockitoSession()16                .initMocks(this)17                .startMocking();18        mockedList.add("one");19        mockedList.clear();20        mockitoSession.finishMocking();21        assertThat(mockedList).isEmpty();22    }23}24MockitoSession.Builder.initMocks(Object) method25MockitoSession.Builder.startMocking() method26MockitoSession.finishMocking() method27MockitoSession mockitoSession() method28MockitoSession mockitoSession(MockitoSession.Builder) method29MockitoSession mockitoSession(MockitoSession.Builder, MockitoSession) method30MockitoSession mockitoSession(MockitoSession) method31MockitoSession mockitoSession(MockitoSession, MockitoSession) method32MockitoSession mockitoSession(MockitoSession, MockitoSession.Builder) method33MockitoSession mockitoSession(MockitoSession.Builder, MockitoSession.Builder) method34MockitoSession mockitoSession(Mockito

MockitoSession

Using AI Code Generation

1import org.mockito.*;2import org.mockito.exceptions.*;3import org.mockito.exceptions.misusing.*;4import org.mockito.exceptions.misusing.missingmethod.*;5import org.mockito.exceptions.verification.*;6import org.mockito.exceptions.verification.junit.ArgumentsAreDifferent;7import org.mockito.exceptions.verification.junit.NoInteractionsWanted;8import org.mockito.exceptions.verification.junit.TooLittleActualInvocations;9import org.mockito.exceptions.verification.junit.TooManyActualInvocations;10import org.mockito.exceptions.verification.junit.WantedButNotInvoked;11import org.mockito.exceptions.verifi

MockitoSession

Using AI Code Generation

1import org.mockito.MockitoSession;2import org.mockito.MockitoAnnotations;3import org.mockito.Mockito;4import static org.mockito.Mockito.when;5import static org.mockito.Mockito.mock;6import static org.mockito.Mockito.doThrow;7import static org.mockito.Mockito.verify;8import static org.mockito.Mockito.times;9import static org.mockito.Mockito.verifyNoMoreInteractions;10import static org.mockito.Mockito.verifyNoInteractions;11import static org.mockito.Mockito.never;12import static org.mockito.Mockito.atLeast;13import static org.mockito.Mockito.atLeastOnce;14import static org.mockito.Mockito.atMost;15import static org.mockito.Mockito.atMostOnce;16import static org.mockito.Mockito.only;17import static org.mockito.Mockito.timeout;18import static org.mockito.Mockito.only;19import static org.mockito.Mockito.withSettings;20import static org.mockito.Mockito.spy;21import static org.mockito.Mockito.reset;22import static org.mockito.Mockito.inOrder;23import static org.mockito.Mockito.after;24import static org.mockito.Mockito.verifyZeroInteractions;25import static org.mockito.Mockito.verifyNoMoreInteraction

MockitoSession

Using AI Code Generation

1package com.automationrhapsody.mockito;2import static org.mockito.Mockito.*;3import org.mockito.MockSettings;4import org.mockito.MockitoSession;5import org.mockito.quality.Strictness;6import org.mockito.Mock;7import org.junit.Test;8import org.junit.runner.RunWith;9import org.mockito.junit.MockitoJUnitRunner;10import java.util.List;11import java.util.LinkedList;12import java.util.ArrayList;13@RunWith(MockitoJUnitRunner.class)14public class MockitoSessionTest {15    public void testMockitoSession() {16        MockitoSession session = Mockito.mockitoSession()17                .initMocks(this)18                .strictness(Strictness.LENIENT)19                .startMocking();20        List mockedList = mock(List.class);21        mockedList.add("one");22        mockedList.clear();23        session.finishMocking();24    }25}26MockitoSessionTest.java:21: warning: [unchecked] unchecked call to add(E) as a member of the raw type List27        mockedList.add("one");28MockitoSessionTest.java:22: warning: [unchecked] unchecked call to clear() as a member of the raw type List29        mockedList.clear();

MockitoSession

Using AI Code Generation

1import org.mockito.*;2import org.mockito.junit.*;3import org.mockito.stubbing.*;4import org.mockito.invocation.*;5import org.mockito.exceptions.*;6import org.mockito.mock.*;7import org.mockito.verification.*;8import org.mockito.internal.stubbing.*;9import org.mockito.internal.verification.*;10import org.mockito.internal.invocation.*;11import org.mockito.internal.exceptions.*;12import org.mockito.internal.matchers.*;13import org.mockito.internal.progress.*;14import org.mockito.internal.debugging.*;15import org.mockito.internal.configuration.*;16import org.mockito.internal.creation.*;17import org.mockito.internal.util.*;18import org.mockito.internal.stubbing.defaultanswers.*;19import org.mockito.internal.stubbing.answers.*;20import org.mockito.internal.stubbing.defaultanswers.ReturnsEmptyValues;21import org.mockito.internal.stubbing.defaultanswers.ReturnsMocks;22import org.mockito.internal.stubbing.defaultanswers.ReturnsSmartNulls;23import org.mockito.internal.stubbing.defaultanswers.ReturnsDeepStubs;24import org.mockito.internal.stubbing.defaultanswers.ReturnsMoreEmptyValues;25import org.mockito.internal.stubbing.defaultanswers.Returns;26import

MockitoSession

Using AI Code Generation

1import org.mockito.MockitoSession;2import org.mockito.quality.Strictness;3import org.mockito.Mockito;4import org.mockito.Mock;5import org.mockito.MockitoAnnotations;6import org.mockito.Spy;7import org.mockito.MockitoSessionBuilder;8public class MockitoSessionClass {9    public static void main(String[] args) {10        MockitoSession mockitoSession = Mockito.mockitoSession()11                .initMocks(this)12                .strictness(Strictness.STRICT_STUBS)13                .startMocking();14    }15}16Recommended Posts: Mockito | when() method17Mockito | verify() method18Mockito | doThrow() method19Mockito | doReturn() method20Mockito | doAnswer() method21Mockito | doNothing() method22Mockito | doCallRealMethod() method23Mockito | doAnswer() method24Mockito | doThrow() method25Mockito | doReturn() method26Mockito | doNothing() method27Mockito | doCallRealMethod() method28Mockito | doAnswer() method29Mockito | doThrow() method30Mockito | doReturn() method31Mockito | doNothing() method32Mockito | doCallRealMethod() method33Mockito | doAnswer() method34Mockito | doThrow() method35Mockito | doReturn() method36Mockito | doNothing() method37Mockito | doCallRealMethod() method38Mockito | doAnswer() method39Mockito | doThrow() method40Mockito | doReturn() method41Mockito | doNothing() method42Mockito | doCallRealMethod() method43Mockito | doAnswer() method44Mockito | doThrow() method45Mockito | doReturn() method46Mockito | doNothing() method47Mockito | doCallRealMethod() method48Mockito | doAnswer() method49Mockito | doThrow() method50Mockito | doReturn() method

MockitoSession

Using AI Code Generation

1package org.mockito;2{3 public void initMocks(Object target)4 {5 }6}

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.