Skip to content

Commit

Permalink
Make MockUtil.getMockMaker() public Mockito API
Browse files Browse the repository at this point in the history
The MockitoPlugins interface now provides access to the getMockMaker()
method.

Fixes mockito#3128
  • Loading branch information
AndreasTu committed Oct 5, 2023
1 parent edc6243 commit 7857798
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
import java.util.Set;

import org.mockito.MockMakers;
import org.mockito.internal.util.MockUtil;
import org.mockito.plugins.AnnotationEngine;
import org.mockito.plugins.DoNotMockEnforcer;
import org.mockito.plugins.InstantiatorProvider2;
Expand Down Expand Up @@ -114,4 +115,9 @@ private <T> T create(Class<T> pluginType, String className) {
public MockMaker getInlineMockMaker() {
return create(MockMaker.class, DEFAULT_PLUGINS.get(INLINE_ALIAS));
}

@Override
public MockMaker getMockMaker(String mockMaker) {
return MockUtil.getMockMaker(mockMaker);
}
}
2 changes: 1 addition & 1 deletion src/main/java/org/mockito/internal/util/MockUtil.java
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public class MockUtil {

private MockUtil() {}

private static MockMaker getMockMaker(String mockMaker) {
public static MockMaker getMockMaker(String mockMaker) {
if (mockMaker == null) {
return defaultMockMaker;
}
Expand Down
21 changes: 21 additions & 0 deletions src/main/java/org/mockito/plugins/MockitoPlugins.java
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

import org.mockito.Mockito;
import org.mockito.MockitoFramework;
import org.mockito.NotExtensible;

/**
* Instance of this interface is available via {@link MockitoFramework#getPlugins()}.
Expand All @@ -17,6 +18,7 @@
*
* @since 2.10.0
*/
@NotExtensible
public interface MockitoPlugins {

/**
Expand All @@ -39,6 +41,25 @@ public interface MockitoPlugins {
*
* @return instance of inline mock maker
* @since 2.10.0
* @deprecated Please use {@link #getMockMaker(String)} with {@link org.mockito.MockMakers#INLINE} instead.
*/
@Deprecated(since = "5.6.0", forRemoval = true)
MockMaker getInlineMockMaker();

/**
* Returns {@link MockMaker} instance used by Mockito with the passed name {@code mockMaker}.
*
* <p>This will return the instance used by Mockito itself, not a new instance of it.
*
* <p>This method can be used to increase the interop of mocks created by Mockito and other
* libraries using Mockito mock maker API.
*
* @param mockMaker the name of the mock maker or {@code null} to retrieve the default mock maker
* @return instance of the mock maker
* @throws IllegalStateException if a mock maker with the name is not found
* @since 5.6.0
*/
default MockMaker getMockMaker(String mockMaker) {
throw new UnsupportedOperationException("This method is not implemented.");
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,21 @@
import static org.mockito.internal.configuration.plugins.DefaultMockitoPlugins.PROXY_ALIAS;
import static org.mockito.internal.configuration.plugins.DefaultMockitoPlugins.SUBCLASS_ALIAS;

import org.assertj.core.api.Assertions;
import org.junit.Test;
import org.mockito.MockMakers;
import org.mockito.Mockito;
import org.mockito.internal.creation.bytebuddy.InlineByteBuddyMockMaker;
import org.mockito.internal.util.ConsoleMockitoLogger;
import org.mockito.plugins.InstantiatorProvider2;
import org.mockito.plugins.MockMaker;
import org.mockito.plugins.MockitoLogger;
import org.mockito.plugins.MockitoPlugins;
import org.mockitoutil.TestBase;

public class DefaultMockitoPluginsTest extends TestBase {

private DefaultMockitoPlugins plugins = new DefaultMockitoPlugins();
private final DefaultMockitoPlugins plugins = new DefaultMockitoPlugins();

@Test
public void provides_plugins() throws Exception {
Expand All @@ -41,4 +45,32 @@ public void provides_plugins() throws Exception {
ConsoleMockitoLogger.class,
plugins.getDefaultPlugin(MockitoLogger.class).getClass());
}

@Test
public void test_getMockMaker() {
assertNotNull(plugins.getMockMaker(null));
assertTrue(plugins.getMockMaker(MockMakers.INLINE) instanceof InlineByteBuddyMockMaker);
}

@Test
public void test_getMockMaker_throws_IllegalStateException_on_invalid_name() {
Assertions.assertThatThrownBy(
() -> {
plugins.getMockMaker("non existing");
})
.isInstanceOf(IllegalStateException.class)
.hasMessage("Failed to load MockMaker: non existing");
}

@Test
public void
test_MockitoPlugins_getMockMaker_default_method_throws_UnsupportedOperationException() {
MockitoPlugins pluginsSpy = Mockito.spy(MockitoPlugins.class);
Assertions.assertThatThrownBy(
() -> {
pluginsSpy.getMockMaker("non existing");
})
.isInstanceOf(UnsupportedOperationException.class)
.hasMessage("This method is not implemented.");
}
}

0 comments on commit 7857798

Please sign in to comment.