Shifted to standard src layout. Added test class.

This commit is contained in:
tastybento 2018-07-30 14:24:08 -07:00
parent f8fde97edc
commit 90103bd0a7
15 changed files with 213 additions and 21 deletions

23
pom.xml
View File

@ -6,10 +6,13 @@
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<properties>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<powermock.version>1.7.4</powermock.version>
</properties>
<build>
<sourceDirectory>src</sourceDirectory>
<defaultGoal>clean package install</defaultGoal>
<resources>
<resource>
@ -65,6 +68,24 @@
<version>0.0.1-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-all</artifactId>
<version>1.10.19</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.powermock</groupId>
<artifactId>powermock-module-junit4</artifactId>
<version>${powermock.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.powermock</groupId>
<artifactId>powermock-api-mockito</artifactId>
<version>${powermock.version}</version>
<scope>test</scope>
</dependency>
</dependencies>
<repositories>
<repository>

View File

@ -6,7 +6,6 @@ import java.util.Set;
import org.bukkit.World;
import bentobox.addon.acidisland.AcidIsland;
import bskyblock.addon.warps.commands.WarpCommand;
import bskyblock.addon.warps.commands.WarpsCommand;
import bskyblock.addon.warps.config.PluginConfig;
@ -22,7 +21,7 @@ import world.bentobox.bbox.util.Util;
*/
public class Warp extends Addon {
private static final String BSKYBLOCK_LEVEL = "BSkyBlock-Level";
private static final String LEVEL_PLUGIN_NAME = "BSkyBlock-Level";
// The plugin instance.
private BentoBox plugin;
@ -59,26 +58,27 @@ public class Warp extends Addon {
getServer().getPluginManager().registerEvents(new WarpSignsListener(this, plugin), plugin);
// Register commands
getServer().getScheduler().runTask(getPlugin(), () -> {
// Register for BSkyBlock
/*
CompositeCommand bsbIslandCmd = BentoBox.getInstance().getCommandsManager().getCommand("island");
new WarpCommand(this, bsbIslandCmd);
new WarpsCommand(this, bsbIslandCmd);
registeredWorlds.add(plugin.getIWM().getBSBIslandWorld());
*/
// BSkyBlock hook in
this.getPlugin().getAddonsManager().getAddonByName("BSkyBlock").ifPresent(acidIsland -> {
CompositeCommand bsbIslandCmd = BentoBox.getInstance().getCommandsManager().getCommand("island");
if (bsbIslandCmd != null) {
new WarpCommand(this, bsbIslandCmd);
new WarpsCommand(this, bsbIslandCmd);
registeredWorlds.add(plugin.getIWM().getWorld("BSkyBlock"));
}
});
// AcidIsland hook in
this.getPlugin().getAddonsManager().getAddonByName("AcidIsland").ifPresent(acidIsland -> {
CompositeCommand acidIslandCmd = getPlugin().getCommandsManager().getCommand("ai");
if (acidIslandCmd != null) {
new WarpCommand(this, acidIslandCmd);
new WarpsCommand(this, acidIslandCmd);
registeredWorlds.add(((AcidIsland)acidIsland).getAiw().getOverWorld());
registeredWorlds.add(plugin.getIWM().getWorld("AcidIsland"));
}
});
});
// Get the level addon if it exists
setLevelAddon(getPlugin().getAddonsManager().getAddonByName(BSKYBLOCK_LEVEL));
setLevelAddon(getPlugin().getAddonsManager().getAddonByName(LEVEL_PLUGIN_NAME));
});
// Done
}

View File

@ -31,11 +31,11 @@ public class WarpPanelManager {
}
private PanelItem getPanelItem(World world, UUID warpOwner) {
cachedSigns.putIfAbsent(world, new HashMap<>());
// Return a sign panel item
return new PanelItemBuilder()
.icon(Material.SIGN)
.name(addon.getPlugin().getPlayers().getName(warpOwner))
.description(cachedSigns.get(world).getOrDefault(warpOwner, getSign(world, warpOwner)))
.description(getSign(world, warpOwner))
.clickHandler((panel, clicker, click, slot) -> { {
addon.getWarpSignsManager().warpPlayer(world, clicker, warpOwner);
return true;
@ -44,22 +44,26 @@ public class WarpPanelManager {
}
/**
* Gets sign text and caches it
* Gets sign text and cache it
* @param playerUUID
* @return
* @return sign text in a list
*/
private List<String> getSign(World world, UUID playerUUID) {
List<String> result = addon.getWarpSignsManager().getSignText(world, playerUUID);
// Add the worlds if we haven't seen this before
cachedSigns.putIfAbsent(world, new HashMap<>());
if (cachedSigns.get(world).containsKey(playerUUID)) {
return cachedSigns.get(world).get(playerUUID);
}
List<String> result = addon.getWarpSignsManager().getSignText(world, playerUUID);
cachedSigns.get(world).put(playerUUID, result);
return result;
}
/**
* Show the warp panel for the user
* @param world
* @param user
* @param index
* @param world - world
* @param user - user
* @param index - page to show - 0 is first
*/
public void showWarpPanel(World world, User user, int index) {
List<UUID> warps = new ArrayList<>(addon.getWarpSignsManager().getSortedWarps(world));

View File

@ -0,0 +1,167 @@
/**
*
*/
package bskyblock.addon.warps;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
import org.bukkit.Bukkit;
import org.bukkit.World;
import org.bukkit.entity.Player;
import org.bukkit.inventory.Inventory;
import org.bukkit.inventory.ItemFactory;
import org.bukkit.inventory.ItemStack;
import org.bukkit.inventory.meta.ItemMeta;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mockito;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.stubbing.Answer;
import org.powermock.api.mockito.PowerMockito;
import org.powermock.core.classloader.annotations.PrepareForTest;
import org.powermock.modules.junit4.PowerMockRunner;
import world.bentobox.bbox.BentoBox;
import world.bentobox.bbox.api.user.User;
import world.bentobox.bbox.managers.PlayersManager;
/**
* @author ben
*
*/
@RunWith(PowerMockRunner.class)
@PrepareForTest({Bukkit.class})
public class WarpPanelManagerTest {
private WarpSignsManager wsm;
private Warp addon;
private Player player;
private User user;
private World world;
private Inventory top;
private UUID uuid;
/**
* @throws java.lang.Exception
*/
@Before
public void setUp() throws Exception {
addon = mock(Warp.class);
wsm = mock(WarpSignsManager.class);
when(addon.getWarpSignsManager()).thenReturn(wsm);
// Fill with 200 fake warps (I'm banking on them all being different, but there could be a clash)
List<UUID> list = new ArrayList<>();
for (int i = 0; i< 200; i++) {
list.add(UUID.randomUUID());
}
// One final one
uuid = UUID.randomUUID();
list.add(uuid);
when(wsm.getSortedWarps(Mockito.any())).thenReturn(list);
user = mock(User.class);
player = mock(Player.class);
when(user.getPlayer()).thenReturn(player);
when(user.getTranslation(Mockito.anyVararg())).thenAnswer(new Answer<String>() {
@Override
public String answer(InvocationOnMock invocation) throws Throwable {
return invocation.getArgumentAt(0, String.class);
}});
// World
world = mock(World.class);
// BentoBox
BentoBox plugin = mock(BentoBox.class);
PlayersManager pm = mock(PlayersManager.class);
when(pm.getName(Mockito.any())).thenReturn("name");
when(plugin.getPlayers()).thenReturn(pm);
when(addon.getPlugin()).thenReturn(plugin);
// Bukkit
PowerMockito.mockStatic(Bukkit.class);
ItemFactory itemF = mock(ItemFactory.class);
ItemMeta imeta = mock(ItemMeta.class);
when(itemF.getItemMeta(Mockito.any())).thenReturn(imeta);
when(Bukkit.getItemFactory()).thenReturn(itemF);
top = mock(Inventory.class);
when(top.getSize()).thenReturn(9);
when(Bukkit.createInventory(Mockito.any(), Mockito.anyInt(), Mockito.any())).thenReturn(top); }
/**
* Test method for {@link bskyblock.addon.warps.WarpPanelManager#showWarpPanel(org.bukkit.World, world.bentobox.bbox.api.user.User, int)}.
*/
@Test
public void testShowWarpPanelFirst() {
WarpPanelManager wpm = new WarpPanelManager(addon);
wpm.showWarpPanel(world, user, 0);
Mockito.verify(player).openInventory(Mockito.eq(top));
// Just next sign
Mockito.verify(top, Mockito.times(53)).setItem(Mockito.anyInt(), Mockito.any(ItemStack.class));
}
/**
* Test method for {@link bskyblock.addon.warps.WarpPanelManager#showWarpPanel(org.bukkit.World, world.bentobox.bbox.api.user.User, int)}.
*/
@Test
public void testShowWarpPanelMiddle() {
WarpPanelManager wpm = new WarpPanelManager(addon);
wpm.showWarpPanel(world, user, 1);
Mockito.verify(player).openInventory(Mockito.eq(top));
// includes previous and next signs
Mockito.verify(top, Mockito.times(54)).setItem(Mockito.anyInt(), Mockito.any(ItemStack.class));
}
/**
* Test method for {@link bskyblock.addon.warps.WarpPanelManager#showWarpPanel(org.bukkit.World, world.bentobox.bbox.api.user.User, int)}.
*/
@Test
public void testShowWarpPanelLast() {
WarpPanelManager wpm = new WarpPanelManager(addon);
wpm.showWarpPanel(world, user, 3);
Mockito.verify(player).openInventory(Mockito.eq(top));
// Final amount, just previous sign
Mockito.verify(top, Mockito.times(46)).setItem(Mockito.anyInt(), Mockito.any(ItemStack.class));
}
/**
* Test method for {@link bskyblock.addon.warps.WarpPanelManager#showWarpPanel(org.bukkit.World, world.bentobox.bbox.api.user.User, int)}.
*/
@Test
public void testShowWarpPanelTestCache() {
WarpPanelManager wpm = new WarpPanelManager(addon);
// Do 45 initial lookups of sign text
wpm.showWarpPanel(world, user, 3);
// Get the panel again
wpm.showWarpPanel(world, user, 3);
// Should only check this 45 times because the sign text is cached
Mockito.verify(wsm, Mockito.times(45)).getSignText(Mockito.any(), Mockito.any());
}
/**
* Test method for {@link bskyblock.addon.warps.WarpPanelManager#removeWarp(org.bukkit.World, java.util.UUID)}.
*/
@Test
public void testRemoveWarp() {
WarpPanelManager wpm = new WarpPanelManager(addon);
wpm.showWarpPanel(world, user, 3);
wpm.showWarpPanel(world, user, 3);
wpm.removeWarp(world, uuid);
wpm.showWarpPanel(world, user, 3);
// Removing the UUID should force a refresh and therefore 46 lookups
Mockito.verify(wsm, Mockito.times(46)).getSignText(Mockito.any(), Mockito.any());
}
}