org.mockito.junit.jupiter.MockitoExtension Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mockito-junit-jupiter Show documentation
Mockito JUnit 5 support
There is a newer version: 5.15.2
Show newest version
/*
 * Copyright (c) 2018 Mockito contributors
 * This program is made available under the terms of the MIT License.
 */
package org.mockito.junit.jupiter;

import static org.junit.jupiter.api.extension.ExtensionContext.Namespace.create;
import static org.junit.platform.commons.support.AnnotationSupport.findAnnotation;

import java.lang.reflect.Parameter;
import java.util.HashSet;
import java.util.List;
import java.util.Optional;
import java.util.Set;

import org.junit.jupiter.api.extension.AfterEachCallback;
import org.junit.jupiter.api.extension.BeforeEachCallback;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.junit.jupiter.api.extension.ExtensionContext.Namespace;
import org.junit.jupiter.api.extension.ParameterContext;
import org.junit.jupiter.api.extension.ParameterResolutionException;
import org.junit.jupiter.api.extension.ParameterResolver;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.MockitoSession;
import org.mockito.ScopedMock;
import org.mockito.internal.configuration.MockAnnotationProcessor;
import org.mockito.internal.configuration.plugins.Plugins;
import org.mockito.internal.session.MockitoSessionLoggerAdapter;
import org.mockito.junit.MockitoJUnitRunner;
import org.mockito.quality.Strictness;

/**
 * Extension that initializes mocks and handles strict stubbings. This extension is the JUnit Jupiter equivalent
 * of our JUnit4 {@link MockitoJUnitRunner}.
 *
 * Example usage:
 *
 * 
 * @ExtendWith(MockitoExtension.class)
 * public class ExampleTest {
 *
 *     @Mock
 *     private List<Integer> list;
 *
 *     @Test
 *     public void shouldDoSomething() {
 *         list.add(100);
 *     }
 * }
 * 
 *
 * If you would like to configure the used strictness for the test class, use {@link MockitoSettings}.
 *
 * 
 * @MockitoSettings(strictness = Strictness.STRICT_STUBS)
 * public class ExampleTest {
 *
 *     @Mock
 *     private List<Integer> list;
 *
 *     @Test
 *     public void shouldDoSomething() {
 *         list.add(100);
 *     }
 * }
 * 
 *
 * This extension also supports JUnit Jupiter's method parameters.
 * Use parameters for initialization of mocks that you use only in that specific test method.
 * In other words, where you would initialize local mocks in JUnit 4 by calling {@link Mockito#mock(Class)},
 * use the method parameter. This is especially beneficial when initializing a mock with generics, as you no
 * longer get a warning about "Unchecked assignment".
 * Please refer to JUnit Jupiter's documentation to learn when method parameters are useful.
 *
 * 
 * @ExtendWith(MockitoExtension.class)
 * public class ExampleTest {
 *
 *     @Mock
 *     private List<Integer> sharedList;
 *
 *     @Test
 *     public void shouldDoSomething() {
 *         sharedList.add(100);
 *     }
 *
 *     @Test
 *     public void hasLocalMockInThisTest(@Mock List<Integer> localList) {
 *         localList.add(100);
 *         sharedList.add(100);
 *     }
 * }
 * 
 *
 * Lastly, the extension supports JUnit Jupiter's constructor parameters.
 * This allows you to do setup work in the constructor and set
 * your fields to final.
 * Please refer to JUnit Jupiter's documentation to learn when constructor parameters are useful.
 *
 * 
 * @ExtendWith(MockitoExtension.class)
 * public class ExampleTest {
 *
 *      private final List<Integer> sharedList;
 *
 *      ExampleTest(@Mock sharedList) {
 *          this.sharedList = sharedList;
 *      }
 *
 *      @Test
 *      public void shouldDoSomething() {
 *          sharedList.add(100);
 *      }
 * }
 * 
 */
public class MockitoExtension implements BeforeEachCallback, AfterEachCallback, ParameterResolver {

    private final static Namespace MOCKITO = create("org.mockito");

    private final static String SESSION = "session", MOCKS = "mocks";

    private final Strictness strictness;

    // This constructor is invoked by JUnit Jupiter via reflection or ServiceLoader
    @SuppressWarnings("unused")
    public MockitoExtension() {
        this(Strictness.STRICT_STUBS);
    }

    private MockitoExtension(Strictness strictness) {
        this.strictness = strictness;
    }

    /**
     * Callback that is invoked before each test is invoked.
     *
     * @param context the current extension context; never {@code null}
     */
    @Override
    public void beforeEach(final ExtensionContext context) {
        List