#1034 Debug commands: permission checker + data statistics

- Create debug command to check if a player has the given permission
- Create debug command that outputs the size of various caches / DB info / number of saved instances in injector
This commit is contained in:
ljacqu
2017-03-21 22:00:21 +01:00
parent 3c45ca8425
commit d19748fe5b
7 changed files with 370 additions and 39 deletions
@@ -1,11 +1,20 @@
package fr.xephi.authme.command.executable.authme.debug;
import fr.xephi.authme.ReflectionTestUtils;
import fr.xephi.authme.TestHelper;
import fr.xephi.authme.data.limbo.LimboPlayer;
import fr.xephi.authme.data.limbo.LimboService;
import org.bukkit.Location;
import org.junit.Test;
import java.util.HashMap;
import java.util.Map;
import java.util.function.Function;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.sameInstance;
import static org.junit.Assert.assertThat;
import static org.mockito.Mockito.mock;
/**
* Test for {@link DebugSectionUtils}.
@@ -43,4 +52,18 @@ public class DebugSectionUtilsTest {
public void shouldHaveHiddenConstructor() {
TestHelper.validateHasOnlyPrivateEmptyConstructor(DebugSectionUtils.class);
}
@Test
public void shouldFetchMapInLimboService() {
// given
LimboService limboService = mock(LimboService.class);
Map<String, LimboPlayer> limboMap = new HashMap<>();
ReflectionTestUtils.setField(LimboService.class, limboService, "entries", limboMap);
// when
Map map = DebugSectionUtils.applyToLimboPlayersMap(limboService, Function.identity());
// then
assertThat(map, sameInstance(limboMap));
}
}
@@ -0,0 +1,97 @@
package fr.xephi.authme.command.executable.authme.debug;
import fr.xephi.authme.ClassCollector;
import fr.xephi.authme.TestHelper;
import fr.xephi.authme.permission.AdminPermission;
import fr.xephi.authme.permission.PermissionNode;
import fr.xephi.authme.permission.PermissionsManager;
import fr.xephi.authme.service.BukkitService;
import org.bukkit.command.CommandSender;
import org.bukkit.entity.Player;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.ArgumentCaptor;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnitRunner;
import java.util.List;
import java.util.stream.Collectors;
import static java.util.Arrays.asList;
import static java.util.Collections.emptyList;
import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.hasSize;
import static org.junit.Assert.assertThat;
import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.atLeast;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.hamcrest.MockitoHamcrest.argThat;
/**
* Test for {@link HasPermissionChecker}.
*/
@RunWith(MockitoJUnitRunner.class)
public class HasPermissionCheckerTest {
@InjectMocks
private HasPermissionChecker hasPermissionChecker;
@Mock
private PermissionsManager permissionsManager;
@Mock
private BukkitService bukkitService;
@Test
public void shouldListAllPermissionNodeClasses() {
// given
List<Class<? extends PermissionNode>> permissionClasses =
new ClassCollector(TestHelper.SOURCES_FOLDER, TestHelper.PROJECT_ROOT)
.collectClasses(PermissionNode.class).stream()
.filter(clz -> !clz.isInterface())
.collect(Collectors.toList());
// when / then
assertThat(HasPermissionChecker.PERMISSION_NODE_CLASSES.containsAll(permissionClasses), equalTo(true));
assertThat(HasPermissionChecker.PERMISSION_NODE_CLASSES, hasSize(permissionClasses.size()));
}
@Test
public void shouldShowUsageInfo() {
// given
CommandSender sender = mock(CommandSender.class);
// when
hasPermissionChecker.execute(sender, emptyList());
// then
ArgumentCaptor<String> msgCaptor = ArgumentCaptor.forClass(String.class);
verify(sender, atLeast(2)).sendMessage(msgCaptor.capture());
assertThat(
msgCaptor.getAllValues().stream().anyMatch(msg -> msg.contains("/authme debug perm bobby my.perm.node")),
equalTo(true));
}
@Test
public void shouldShowSuccessfulTestWithRegularPlayer() {
// given
String name = "Chuck";
Player player = mock(Player.class);
given(bukkitService.getPlayerExact(name)).willReturn(player);
PermissionNode permission = AdminPermission.CHANGE_EMAIL;
given(permissionsManager.hasPermission(player, permission)).willReturn(true);
CommandSender sender = mock(CommandSender.class);
// when
hasPermissionChecker.execute(sender, asList(name, permission.getNode()));
// then
verify(bukkitService).getPlayerExact(name);
verify(permissionsManager).hasPermission(player, permission);
verify(sender).sendMessage(argThat(containsString("Success: player '" + player.getName()
+ "' has permission '" + permission.getNode() + "'")));
}
}