Create Wrapper for instances / revise MockUtils

- Add test resources folder
- Create basic test for Messages (todo: add concrete tests)
- Create WrapperMock
- Change UtilsTest (todo: make it work)
This commit is contained in:
ljacqu
2015-11-23 23:25:03 +01:00
parent 8719cce334
commit 6422f90114
11 changed files with 261 additions and 51 deletions
@@ -1,6 +1,7 @@
package fr.xephi.authme;
import fr.xephi.authme.settings.Messages;
import fr.xephi.authme.util.Wrapper;
import org.mockito.Mockito;
import java.lang.reflect.Field;
@@ -15,15 +16,18 @@ public final class AuthMeMockUtil {
}
/**
* Sets the AuthMe plugin instance to a mock object. Use {@link AuthMe#getInstance()} to retrieve the mock.
* Set the AuthMe plugin instance to a mock object. Use {@link AuthMe#getInstance()} to retrieve the mock.
*
* @return The generated mock for the AuthMe instance
*/
public static void mockAuthMeInstance() {
public static AuthMe mockAuthMeInstance() {
AuthMe mock = Mockito.mock(AuthMe.class);
mockSingletonForClass(AuthMe.class, "plugin", mock);
return mock;
}
/**
* Creates a mock Messages object for the instance returned from {@link Messages#getInstance()}.
* Create a mock Messages object for the instance returned from {@link Messages#getInstance()}.
*/
public static void mockMessagesInstance() {
Messages mock = Mockito.mock(Messages.class);
@@ -31,11 +35,39 @@ public final class AuthMeMockUtil {
}
/**
* Sets a field of a class to the given mock.
* Set the given class' {@link Wrapper} field to a mock implementation.
*
* @param clazz the class to modify
* @param fieldName the field name
* @param mock the mock to set for the given field
* @param clazz The class to modify
* @param fieldName The name of the field containing the Wrapper in the class
*
* @return The generated Wrapper mock
* @see WrapperMock
*/
public static Wrapper insertMockWrapperInstance(Class<?> clazz, String fieldName) {
Wrapper wrapperMock = new WrapperMock();
mockSingletonForClass(clazz, fieldName, wrapperMock);
return wrapperMock;
}
public static Wrapper insertMockWrapperInstance(Class<?> clazz, String fieldName, AuthMe authMe) {
Wrapper wrapperMock = new WrapperMock(authMe);
mockSingletonForClass(clazz, fieldName, wrapperMock);
return wrapperMock;
}
// TODO ljacqu 20151123: Find the use cases for the WrapperMock and remove any of these
// methods that will end up unused
public static Wrapper insertMockWrapperInstance(Class<?> clazz, String fieldName, WrapperMock wrapperMock) {
mockSingletonForClass(clazz, fieldName, wrapperMock);
return wrapperMock;
}
/**
* Set a field of a class to the given mock.
*
* @param clazz The class to modify
* @param fieldName The field name
* @param mock The mock to set for the given field
*/
private static void mockSingletonForClass(Class<?> clazz, String fieldName, Object mock) {
try {
@@ -0,0 +1,54 @@
package fr.xephi.authme;
import fr.xephi.authme.util.Wrapper;
import org.bukkit.Server;
import org.mockito.Mockito;
import java.util.HashMap;
import java.util.Map;
import java.util.logging.Logger;
/**
* Class returning mocks for all calls in {@link Wrapper}.
* This class keeps track of its mocks and will always return
* the same one for each type.
*/
public class WrapperMock extends Wrapper {
private static Map<Class<?>, Object> mocks = new HashMap<>();
public WrapperMock() {
this((AuthMe) getMock(AuthMe.class));
}
public WrapperMock(AuthMe authMe) {
super(authMe);
}
@Override
public Logger getLogger() {
return getMock(Logger.class);
}
@Override
public Server getServer() {
return getMock(Server.class);
}
@Override
public AuthMe getAuthMe() {
return getMock(AuthMe.class);
}
@SuppressWarnings("unchecked")
private static <T> T getMock(Class<?> clazz) {
Object o = mocks.get(clazz);
if (o == null) {
o = Mockito.mock(clazz);
mocks.put(clazz, o);
}
return (T) o;
}
}
@@ -0,0 +1,28 @@
package fr.xephi.authme.settings;
import fr.xephi.authme.AuthMe;
import fr.xephi.authme.AuthMeMockUtil;
import fr.xephi.authme.ConsoleLogger;
import org.junit.Before;
import org.junit.Test;
import java.io.File;
/**
* Test for {@link Messages}.
*/
public class MessagesTest {
@Before
public void setUpMessages() {
AuthMe authMe = AuthMeMockUtil.mockAuthMeInstance();
AuthMeMockUtil.insertMockWrapperInstance(ConsoleLogger.class, "wrapper", authMe);
File file = new File("messages_test.yml");
Messages messages = new Messages(file, "en");
}
@Test
public void shouldLoadMessages() {
}
}
@@ -2,6 +2,7 @@ package fr.xephi.authme.util;
import fr.xephi.authme.AuthMe;
import fr.xephi.authme.AuthMeMockUtil;
import fr.xephi.authme.WrapperMock;
import fr.xephi.authme.permission.PermissionsManager;
import org.bukkit.Server;
import org.bukkit.entity.Player;
@@ -9,6 +10,7 @@ import org.bukkit.plugin.Plugin;
import org.bukkit.scheduler.BukkitScheduler;
import org.bukkit.scheduler.BukkitTask;
import org.junit.Before;
import org.junit.Ignore;
import org.junit.Test;
import java.lang.reflect.Field;
@@ -23,26 +25,32 @@ import static org.mockito.Mockito.when;
/**
* Test for the {@link Utils} class.
*/
@Ignore
// TODO ljacqu 20151123: Fix test setup
public class UtilsTest {
private AuthMe authMeMock;
private PermissionsManager permissionsManagerMock;
private Wrapper wrapperMock;
@Before
public void setUpMocks() {
AuthMeMockUtil.mockAuthMeInstance();
authMeMock = AuthMe.getInstance();
authMeMock = AuthMeMockUtil.mockAuthMeInstance();
permissionsManagerMock = mock(PermissionsManager.class);
when(authMeMock.getPermissionsManager()).thenReturn(permissionsManagerMock);
Server serverMock = mock(Server.class);
when(authMeMock.getGameServer()).thenReturn(serverMock);
// We need to create the Wrapper mock before injecting it into Utils because it runs a lot of code in
// a static block which needs the proper mocks to be set up.
wrapperMock = new WrapperMock(authMeMock);
Server serverMock = wrapperMock.getServer();
BukkitScheduler schedulerMock = mock(BukkitScheduler.class);
when(serverMock.getScheduler()).thenReturn(schedulerMock);
when(schedulerMock.runTaskAsynchronously(any(Plugin.class), any(Runnable.class)))
.thenReturn(mock(BukkitTask.class));
.thenReturn(mock(BukkitTask.class));
AuthMeMockUtil.insertMockWrapperInstance(Utils.class, "wrapper", (WrapperMock) wrapperMock);
permissionsManagerMock = mock(PermissionsManager.class);
when(authMeMock.getPermissionsManager()).thenReturn(permissionsManagerMock);
}
// TODO ljacques 20151122: The tests for Utils.forceGM somehow can't be set up with the mocks correctly