diff --git a/pom.xml b/pom.xml index 13f4c21..1f58841 100644 --- a/pom.xml +++ b/pom.xml @@ -39,13 +39,9 @@ - - codemc-snapshots - https://repo.codemc.org/repository/maven-snapshots - - codemc-releases - https://repo.codemc.org/repository/maven-releases + bentoboxworld + https://repo.codemc.org/repository/bentoboxworld/ @@ -57,14 +53,14 @@ 2.0.9 - 1.20.5-R0.1-SNAPSHOT - 2.4.1-SNAPSHOT + 1.21.3-R0.1-SNAPSHOT + 2.7.1-SNAPSHOT ${build.version}-SNAPSHOT -LOCAL - 1.25.0 + 1.26.0 BentoBoxWorld_Limits bentobox-world https://sonarcloud.io @@ -118,13 +114,13 @@ https://hub.spigotmc.org/nexus/content/repositories/snapshots - codemc - https://repo.codemc.org/repository/maven-snapshots/ + bentoboxworld + https://repo.codemc.org/repository/bentoboxworld/ - codemc-repo - https://repo.codemc.org/repository/maven-public/ - + codemc + https://repo.codemc.org/repository/maven-snapshots/ + diff --git a/src/main/java/world/bentobox/limits/Limits.java b/src/main/java/world/bentobox/limits/Limits.java index 84d1f85..94bc6e7 100644 --- a/src/main/java/world/bentobox/limits/Limits.java +++ b/src/main/java/world/bentobox/limits/Limits.java @@ -6,6 +6,7 @@ import java.util.List; import java.util.stream.Collectors; import org.bukkit.Material; +import org.bukkit.Registry; import org.bukkit.World; import org.bukkit.entity.EntityType; import org.eclipse.jdt.annotation.Nullable; @@ -137,7 +138,7 @@ public class Limits extends Addon { private void registerPlaceholders(GameModeAddon gm) { if (getPlugin().getPlaceholdersManager() == null) return; - Arrays.stream(Material.values()) + Registry.MATERIAL.stream() .filter(Material::isBlock) .forEach(m -> registerCountAndLimitPlaceholders(m, gm)); diff --git a/src/main/java/world/bentobox/limits/commands/player/LimitTab.java b/src/main/java/world/bentobox/limits/commands/player/LimitTab.java index de922c0..cf6a211 100644 --- a/src/main/java/world/bentobox/limits/commands/player/LimitTab.java +++ b/src/main/java/world/bentobox/limits/commands/player/LimitTab.java @@ -48,7 +48,7 @@ public class LimitTab implements Tab { .put(EntityType.IRON_GOLEM, Material.IRON_BLOCK) .put(EntityType.ILLUSIONER, Material.VILLAGER_SPAWN_EGG) .put(EntityType.WITHER, Material.WITHER_SKELETON_SKULL) - .put(EntityType.BOAT, Material.OAK_BOAT) + //.put(EntityType.BOAT, Material.OAK_BOAT) .put(EntityType.ARMOR_STAND, Material.ARMOR_STAND) .put(EntityType.ITEM_FRAME, Material.ITEM_FRAME) .put(EntityType.PAINTING, Material.PAINTING) @@ -58,7 +58,7 @@ public class LimitTab implements Tab { .put(EntityType.FURNACE_MINECART, Material.FURNACE_MINECART) .put(EntityType.HOPPER_MINECART, Material.HOPPER_MINECART) .put(EntityType.SPAWNER_MINECART, Material.MINECART) - .put(EntityType.CHEST_BOAT, Material.OAK_CHEST_BOAT) + //.put(EntityType.CHEST_BOAT, Material.OAK_CHEST_BOAT) .build(); // This is a map of blocks to Items private static final Map B2M; diff --git a/src/main/resources/addon.yml b/src/main/resources/addon.yml index ac388a0..9689b58 100755 --- a/src/main/resources/addon.yml +++ b/src/main/resources/addon.yml @@ -1,7 +1,7 @@ name: Limits main: world.bentobox.limits.Limits version: ${version}${build.number} -api-version: 2.3.0 +api-version: 2.7.1 authors: tastybento diff --git a/src/main/resources/locales/en-US.yml b/src/main/resources/locales/en-US.yml index 17766ab..9374b98 100755 --- a/src/main/resources/locales/en-US.yml +++ b/src/main/resources/locales/en-US.yml @@ -21,9 +21,7 @@ admin: finished: "&a Island recalc finished successfully!" offset: unknown: "&c Unknown material or entity [name]." - main: - parameters: "" - description: "allows to manage limits offsets for materials and entities" + description: "allows to manage limits offsets for materials and entities" set: parameters: " " description: "sets new offset for material or entity limit" diff --git a/src/main/resources/plugin.yml b/src/main/resources/plugin.yml index 6f9c056..188ba57 100644 --- a/src/main/resources/plugin.yml +++ b/src/main/resources/plugin.yml @@ -1,7 +1,7 @@ name: BentoBox-Limits main: world.bentobox.limits.LimitsPladdon version: ${project.version}${build.number} -api-version: "1.19" +api-version: "1.21" authors: [tastybento] contributors: ["The BentoBoxWorld Community"] diff --git a/src/test/java/bentobox/addon/limits/listeners/JoinListenerTest.java b/src/test/java/world/bentobox/limits/JoinListenerTest.java similarity index 52% rename from src/test/java/bentobox/addon/limits/listeners/JoinListenerTest.java rename to src/test/java/world/bentobox/limits/JoinListenerTest.java index 8655abb..d78fb6f 100644 --- a/src/test/java/bentobox/addon/limits/listeners/JoinListenerTest.java +++ b/src/test/java/world/bentobox/limits/JoinListenerTest.java @@ -1,4 +1,4 @@ -package bentobox.addon.limits.listeners; +package world.bentobox.limits; import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.anyString; @@ -26,6 +26,7 @@ import org.bukkit.event.player.PlayerJoinEvent; import org.bukkit.permissions.PermissionAttachmentInfo; import org.bukkit.plugin.PluginManager; import org.eclipse.jdt.annotation.Nullable; +import org.junit.After; import org.junit.Before; import org.junit.Test; import org.junit.runner.RunWith; @@ -41,11 +42,9 @@ import world.bentobox.bentobox.api.events.island.IslandEvent; import world.bentobox.bentobox.api.events.team.TeamSetownerEvent; import world.bentobox.bentobox.database.objects.Island; import world.bentobox.bentobox.managers.IslandsManager; -import world.bentobox.limits.EntityGroup; -import world.bentobox.limits.Limits; -import world.bentobox.limits.Settings; import world.bentobox.limits.listeners.BlockLimitsListener; import world.bentobox.limits.listeners.JoinListener; +import world.bentobox.limits.mocks.ServerMocks; import world.bentobox.limits.objects.IslandBlockCount; /** @@ -82,55 +81,61 @@ public class JoinListenerTest { @Before public void setUp() { - jl = new JoinListener(addon); - // Setup addon - when(addon.getGameModes()).thenReturn(Collections.singletonList(bskyblock)); - when(addon.getGameModeName(any())).thenReturn("bskyblock"); - when(addon.getGameModePermPrefix(any())).thenReturn("bskyblock."); - when(addon.getSettings()).thenReturn(settings); - // Settings - when(settings.getGroupLimitDefinitions()) - .thenReturn(new ArrayList<>(List.of(new EntityGroup("friendly", new HashSet<>(), -1, null)))); - // Island Manager - when(island.getUniqueId()).thenReturn("unique_id"); - when(island.getOwner()).thenReturn(uuid); - when(im.getIsland(any(), any(UUID.class))).thenReturn(island); - when(im.getIslands(any(), any(UUID.class))).thenReturn(List.of(island)); - // Default is that player has island - when(addon.getIslands()).thenReturn(im); - // Player - when(player.getUniqueId()).thenReturn(uuid); - when(player.getName()).thenReturn("tastybento"); - // No permissions by default - when(player.getEffectivePermissions()).thenReturn(Collections.emptySet()); - // bsKyBlock - when(bskyblock.getPermissionPrefix()).thenReturn("bskyblock."); - AddonDescription desc = new AddonDescription.Builder("main", "BSkyBlock", "1.0").build(); - when(bskyblock.getDescription()).thenReturn(desc); + ServerMocks.newServer(); + jl = new JoinListener(addon); + // Setup addon + when(addon.getGameModes()).thenReturn(Collections.singletonList(bskyblock)); + when(addon.getGameModeName(any())).thenReturn("bskyblock"); + when(addon.getGameModePermPrefix(any())).thenReturn("bskyblock."); + when(addon.getSettings()).thenReturn(settings); + // Settings + when(settings.getGroupLimitDefinitions()) + .thenReturn(new ArrayList<>(List.of(new EntityGroup("friendly", new HashSet<>(), -1, null)))); + // Island Manager + when(island.getUniqueId()).thenReturn("unique_id"); + when(island.getOwner()).thenReturn(uuid); + when(im.getIsland(any(), any(UUID.class))).thenReturn(island); + when(im.getIslands(any(), any(UUID.class))).thenReturn(List.of(island)); + // Default is that player has island + when(addon.getIslands()).thenReturn(im); + // Player + when(player.getUniqueId()).thenReturn(uuid); + when(player.getName()).thenReturn("tastybento"); + // No permissions by default + when(player.getEffectivePermissions()).thenReturn(Collections.emptySet()); + // bsKyBlock + when(bskyblock.getPermissionPrefix()).thenReturn("bskyblock."); + AddonDescription desc = new AddonDescription.Builder("main", "BSkyBlock", "1.0").build(); + when(bskyblock.getDescription()).thenReturn(desc); - // Block limit listener - when(addon.getBlockLimitListener()).thenReturn(bll); - when(bll.getIsland(anyString())).thenReturn(ibc); + // Block limit listener + when(addon.getBlockLimitListener()).thenReturn(bll); + when(bll.getIsland(anyString())).thenReturn(ibc); - // bukkit - PowerMockito.mockStatic(Bukkit.class); - // default is that owner is online - when(owner.isOnline()).thenReturn(true); - when(owner.getPlayer()).thenReturn(player); - when(Bukkit.getOfflinePlayer(any(UUID.class))).thenReturn(owner); - when(Bukkit.getPluginManager()).thenReturn(pim); + // bukkit + PowerMockito.mockStatic(Bukkit.class); + // default is that owner is online + when(owner.isOnline()).thenReturn(true); + when(owner.getPlayer()).thenReturn(player); + when(Bukkit.getOfflinePlayer(any(UUID.class))).thenReturn(owner); + when(Bukkit.getPluginManager()).thenReturn(pim); } + @After + public void tearDown() { + ServerMocks.unsetBukkitServer(); + } + /** * Test method for * {@link world.bentobox.limits.listeners.JoinListener#onNewIsland(world.bentobox.bentobox.api.events.island.IslandEvent)}. */ @Test public void testOnNewIslandWrongReason() { - IslandEvent e = new IslandEvent(island, null, false, null, IslandEvent.Reason.BAN); - jl.onNewIsland(e); - verify(island, never()).getWorld(); + IslandEvent e = new IslandEvent(island, null, false, null, IslandEvent.Reason.BAN); + jl.onNewIsland(e); + verify(island, never()).getWorld(); } /** @@ -139,9 +144,9 @@ public class JoinListenerTest { */ @Test public void testOnNewIslandRegistered() { - IslandEvent e = new IslandEvent(island, null, false, null, IslandEvent.Reason.REGISTERED); - jl.onNewIsland(e); - verify(island).getWorld(); + IslandEvent e = new IslandEvent(island, null, false, null, IslandEvent.Reason.REGISTERED); + jl.onNewIsland(e); + verify(island).getWorld(); } /** @@ -150,9 +155,9 @@ public class JoinListenerTest { */ @Test public void testOnNewIslandResetted() { - IslandEvent e = new IslandEvent(island, null, false, null, IslandEvent.Reason.RESETTED); - jl.onNewIsland(e); - verify(island).getWorld(); + IslandEvent e = new IslandEvent(island, null, false, null, IslandEvent.Reason.RESETTED); + jl.onNewIsland(e); + verify(island).getWorld(); } /** @@ -202,12 +207,12 @@ public class JoinListenerTest { */ @Test public void testOnOwnerChange() { - TeamSetownerEvent e = mock(TeamSetownerEvent.class); - when(e.getIsland()).thenReturn(island); - when(e.getNewOwner()).thenReturn(UUID.randomUUID()); - jl.onOwnerChange(e); - verify(e, Mockito.times(2)).getIsland(); - verify(e).getNewOwner(); + TeamSetownerEvent e = mock(TeamSetownerEvent.class); + when(e.getIsland()).thenReturn(island); + when(e.getNewOwner()).thenReturn(UUID.randomUUID()); + jl.onOwnerChange(e); + verify(e, Mockito.times(2)).getIsland(); + verify(e).getNewOwner(); } /** @@ -216,10 +221,10 @@ public class JoinListenerTest { */ @Test public void testOnPlayerJoin() { - PlayerJoinEvent e = new PlayerJoinEvent(player, "welcome"); - jl.onPlayerJoin(e); - verify(addon).getGameModes(); - verify(bll).setIsland("unique_id", ibc); + PlayerJoinEvent e = new PlayerJoinEvent(player, "welcome"); + jl.onPlayerJoin(e); + verify(addon).getGameModes(); + verify(bll).setIsland("unique_id", ibc); } /** @@ -228,11 +233,11 @@ public class JoinListenerTest { */ @Test public void testOnPlayerJoinIBCNull() { - ibc = null; - PlayerJoinEvent e = new PlayerJoinEvent(player, "welcome"); - jl.onPlayerJoin(e); - verify(addon).getGameModes(); - verify(bll, never()).setIsland("unique_id", ibc); + ibc = null; + PlayerJoinEvent e = new PlayerJoinEvent(player, "welcome"); + jl.onPlayerJoin(e); + verify(addon).getGameModes(); + verify(bll, never()).setIsland("unique_id", ibc); } /** @@ -241,15 +246,15 @@ public class JoinListenerTest { */ @Test public void testOnPlayerJoinWithPermNotLimits() { - Set perms = new HashSet<>(); - PermissionAttachmentInfo permAtt = mock(PermissionAttachmentInfo.class); - when(permAtt.getPermission()).thenReturn("bskyblock.my.perm.for.game"); - perms.add(permAtt); - when(player.getEffectivePermissions()).thenReturn(perms); - PlayerJoinEvent e = new PlayerJoinEvent(player, "welcome"); - jl.onPlayerJoin(e); - verify(addon).getGameModes(); - verify(bll).setIsland("unique_id", ibc); + Set perms = new HashSet<>(); + PermissionAttachmentInfo permAtt = mock(PermissionAttachmentInfo.class); + when(permAtt.getPermission()).thenReturn("bskyblock.my.perm.for.game"); + perms.add(permAtt); + when(player.getEffectivePermissions()).thenReturn(perms); + PlayerJoinEvent e = new PlayerJoinEvent(player, "welcome"); + jl.onPlayerJoin(e); + verify(addon).getGameModes(); + verify(bll).setIsland("unique_id", ibc); } /** @@ -258,16 +263,16 @@ public class JoinListenerTest { */ @Test public void testOnPlayerJoinWithPermLimitsWrongSize() { - Set perms = new HashSet<>(); - PermissionAttachmentInfo permAtt = mock(PermissionAttachmentInfo.class); - when(permAtt.getPermission()).thenReturn("bskyblock.island.limit.my.perm.for.game"); - when(permAtt.getValue()).thenReturn(true); - perms.add(permAtt); - when(player.getEffectivePermissions()).thenReturn(perms); - PlayerJoinEvent e = new PlayerJoinEvent(player, "welcome"); - jl.onPlayerJoin(e); - verify(addon).logError( - "Player tastybento has permission: 'bskyblock.island.limit.my.perm.for.game' but format must be 'bskyblock.island.limit.MATERIAL.NUMBER', 'bskyblock.island.limit.ENTITY-TYPE.NUMBER', or 'bskyblock.island.limit.ENTITY-GROUP.NUMBER' Ignoring..."); + Set perms = new HashSet<>(); + PermissionAttachmentInfo permAtt = mock(PermissionAttachmentInfo.class); + when(permAtt.getPermission()).thenReturn("bskyblock.island.limit.my.perm.for.game"); + when(permAtt.getValue()).thenReturn(true); + perms.add(permAtt); + when(player.getEffectivePermissions()).thenReturn(perms); + PlayerJoinEvent e = new PlayerJoinEvent(player, "welcome"); + jl.onPlayerJoin(e); + verify(addon).logError( + "Player tastybento has permission: 'bskyblock.island.limit.my.perm.for.game' but format must be 'bskyblock.island.limit.MATERIAL.NUMBER', 'bskyblock.island.limit.ENTITY-TYPE.NUMBER', or 'bskyblock.island.limit.ENTITY-GROUP.NUMBER' Ignoring..."); } /** @@ -276,16 +281,16 @@ public class JoinListenerTest { */ @Test public void testOnPlayerJoinWithPermLimitsInvalidMaterial() { - Set perms = new HashSet<>(); - PermissionAttachmentInfo permAtt = mock(PermissionAttachmentInfo.class); - when(permAtt.getPermission()).thenReturn("bskyblock.island.limit.mumbo.34"); - when(permAtt.getValue()).thenReturn(true); - perms.add(permAtt); - when(player.getEffectivePermissions()).thenReturn(perms); - PlayerJoinEvent e = new PlayerJoinEvent(player, "welcome"); - jl.onPlayerJoin(e); - verify(addon).logError( - "Player tastybento has permission: 'bskyblock.island.limit.mumbo.34' but MUMBO is not a valid material or entity type/group. Ignoring..."); + Set perms = new HashSet<>(); + PermissionAttachmentInfo permAtt = mock(PermissionAttachmentInfo.class); + when(permAtt.getPermission()).thenReturn("bskyblock.island.limit.mumbo.34"); + when(permAtt.getValue()).thenReturn(true); + perms.add(permAtt); + when(player.getEffectivePermissions()).thenReturn(perms); + PlayerJoinEvent e = new PlayerJoinEvent(player, "welcome"); + jl.onPlayerJoin(e); + verify(addon).logError( + "Player tastybento has permission: 'bskyblock.island.limit.mumbo.34' but MUMBO is not a valid material or entity type/group. Ignoring..."); } /** @@ -294,16 +299,16 @@ public class JoinListenerTest { */ @Test public void testOnPlayerJoinWithPermLimitsWildcard() { - Set perms = new HashSet<>(); - PermissionAttachmentInfo permAtt = mock(PermissionAttachmentInfo.class); - when(permAtt.getPermission()).thenReturn("bskyblock.island.limit.*"); - when(permAtt.getValue()).thenReturn(true); - perms.add(permAtt); - when(player.getEffectivePermissions()).thenReturn(perms); - PlayerJoinEvent e = new PlayerJoinEvent(player, "welcome"); - jl.onPlayerJoin(e); - verify(addon).logError( - "Player tastybento has permission: 'bskyblock.island.limit.*' but wildcards are not allowed. Ignoring..."); + Set perms = new HashSet<>(); + PermissionAttachmentInfo permAtt = mock(PermissionAttachmentInfo.class); + when(permAtt.getPermission()).thenReturn("bskyblock.island.limit.*"); + when(permAtt.getValue()).thenReturn(true); + perms.add(permAtt); + when(player.getEffectivePermissions()).thenReturn(perms); + PlayerJoinEvent e = new PlayerJoinEvent(player, "welcome"); + jl.onPlayerJoin(e); + verify(addon).logError( + "Player tastybento has permission: 'bskyblock.island.limit.*' but wildcards are not allowed. Ignoring..."); } /** @@ -312,16 +317,16 @@ public class JoinListenerTest { */ @Test public void testOnPlayerJoinWithPermLimitsNotNumber() { - Set perms = new HashSet<>(); - PermissionAttachmentInfo permAtt = mock(PermissionAttachmentInfo.class); - when(permAtt.getPermission()).thenReturn("bskyblock.island.limit.STONE.abc"); - when(permAtt.getValue()).thenReturn(true); - perms.add(permAtt); - when(player.getEffectivePermissions()).thenReturn(perms); - PlayerJoinEvent e = new PlayerJoinEvent(player, "welcome"); - jl.onPlayerJoin(e); - verify(addon).logError( - "Player tastybento has permission: 'bskyblock.island.limit.STONE.abc' but the last part MUST be an integer! Ignoring..."); + Set perms = new HashSet<>(); + PermissionAttachmentInfo permAtt = mock(PermissionAttachmentInfo.class); + when(permAtt.getPermission()).thenReturn("bskyblock.island.limit.STONE.abc"); + when(permAtt.getValue()).thenReturn(true); + perms.add(permAtt); + when(player.getEffectivePermissions()).thenReturn(perms); + PlayerJoinEvent e = new PlayerJoinEvent(player, "welcome"); + jl.onPlayerJoin(e); + verify(addon).logError( + "Player tastybento has permission: 'bskyblock.island.limit.STONE.abc' but the last part MUST be an integer! Ignoring..."); } /** @@ -330,16 +335,16 @@ public class JoinListenerTest { */ @Test public void testOnPlayerJoinWithPermLimitsSuccess() { - Set perms = new HashSet<>(); - PermissionAttachmentInfo permAtt = mock(PermissionAttachmentInfo.class); - when(permAtt.getPermission()).thenReturn("bskyblock.island.limit.STONE.24"); - when(permAtt.getValue()).thenReturn(true); - perms.add(permAtt); - when(player.getEffectivePermissions()).thenReturn(perms); - PlayerJoinEvent e = new PlayerJoinEvent(player, "welcome"); - jl.onPlayerJoin(e); - verify(addon, never()).logError(anyString()); - verify(ibc).setBlockLimit(eq(Material.STONE), eq(24)); + Set perms = new HashSet<>(); + PermissionAttachmentInfo permAtt = mock(PermissionAttachmentInfo.class); + when(permAtt.getPermission()).thenReturn("bskyblock.island.limit.STONE.24"); + when(permAtt.getValue()).thenReturn(true); + perms.add(permAtt); + when(player.getEffectivePermissions()).thenReturn(perms); + PlayerJoinEvent e = new PlayerJoinEvent(player, "welcome"); + jl.onPlayerJoin(e); + verify(addon, never()).logError(anyString()); + verify(ibc).setBlockLimit(eq(Material.STONE), eq(24)); } /** @@ -348,16 +353,16 @@ public class JoinListenerTest { */ @Test public void testOnPlayerJoinWithPermLimitsSuccessEntity() { - Set perms = new HashSet<>(); - PermissionAttachmentInfo permAtt = mock(PermissionAttachmentInfo.class); - when(permAtt.getPermission()).thenReturn("bskyblock.island.limit.BAT.24"); - when(permAtt.getValue()).thenReturn(true); - perms.add(permAtt); - when(player.getEffectivePermissions()).thenReturn(perms); - PlayerJoinEvent e = new PlayerJoinEvent(player, "welcome"); - jl.onPlayerJoin(e); - verify(addon, never()).logError(anyString()); - verify(ibc).setEntityLimit(eq(EntityType.BAT), eq(24)); + Set perms = new HashSet<>(); + PermissionAttachmentInfo permAtt = mock(PermissionAttachmentInfo.class); + when(permAtt.getPermission()).thenReturn("bskyblock.island.limit.BAT.24"); + when(permAtt.getValue()).thenReturn(true); + perms.add(permAtt); + when(player.getEffectivePermissions()).thenReturn(perms); + PlayerJoinEvent e = new PlayerJoinEvent(player, "welcome"); + jl.onPlayerJoin(e); + verify(addon, never()).logError(anyString()); + verify(ibc).setEntityLimit(eq(EntityType.BAT), eq(24)); } /** @@ -366,16 +371,16 @@ public class JoinListenerTest { */ @Test public void testOnPlayerJoinWithPermLimitsSuccessEntityGroup() { - Set perms = new HashSet<>(); - PermissionAttachmentInfo permAtt = mock(PermissionAttachmentInfo.class); - when(permAtt.getPermission()).thenReturn("bskyblock.island.limit.friendly.24"); - when(permAtt.getValue()).thenReturn(true); - perms.add(permAtt); - when(player.getEffectivePermissions()).thenReturn(perms); - PlayerJoinEvent e = new PlayerJoinEvent(player, "welcome"); - jl.onPlayerJoin(e); - verify(addon, never()).logError(anyString()); - verify(ibc).setEntityGroupLimit(eq("friendly"), eq(24)); + Set perms = new HashSet<>(); + PermissionAttachmentInfo permAtt = mock(PermissionAttachmentInfo.class); + when(permAtt.getPermission()).thenReturn("bskyblock.island.limit.friendly.24"); + when(permAtt.getValue()).thenReturn(true); + perms.add(permAtt); + when(player.getEffectivePermissions()).thenReturn(perms); + PlayerJoinEvent e = new PlayerJoinEvent(player, "welcome"); + jl.onPlayerJoin(e); + verify(addon, never()).logError(anyString()); + verify(ibc).setEntityGroupLimit(eq("friendly"), eq(24)); } /** @@ -384,41 +389,41 @@ public class JoinListenerTest { */ @Test public void testOnPlayerJoinWithPermLimitsMultiPerms() { - Set perms = new HashSet<>(); - PermissionAttachmentInfo permAtt = mock(PermissionAttachmentInfo.class); - when(permAtt.getPermission()).thenReturn("bskyblock.island.limit.STONE.24"); - when(permAtt.getValue()).thenReturn(true); - perms.add(permAtt); - PermissionAttachmentInfo permAtt2 = mock(PermissionAttachmentInfo.class); - when(permAtt2.getPermission()).thenReturn("bskyblock.island.limit.short_grass.14"); - when(permAtt2.getValue()).thenReturn(true); - perms.add(permAtt2); - PermissionAttachmentInfo permAtt3 = mock(PermissionAttachmentInfo.class); - when(permAtt3.getPermission()).thenReturn("bskyblock.island.limit.dirt.34"); - when(permAtt3.getValue()).thenReturn(true); - perms.add(permAtt3); - PermissionAttachmentInfo permAtt4 = mock(PermissionAttachmentInfo.class); - when(permAtt4.getPermission()).thenReturn("bskyblock.island.limit.chicken.34"); - when(permAtt4.getValue()).thenReturn(true); - perms.add(permAtt4); - PermissionAttachmentInfo permAtt5 = mock(PermissionAttachmentInfo.class); - when(permAtt5.getPermission()).thenReturn("bskyblock.island.limit.cave_spider.4"); - when(permAtt5.getValue()).thenReturn(true); - perms.add(permAtt5); - PermissionAttachmentInfo permAtt6 = mock(PermissionAttachmentInfo.class); - when(permAtt6.getPermission()).thenReturn("bskyblock.island.limit.cave_spider.4"); - when(permAtt6.getValue()).thenReturn(false); // negative perm - perms.add(permAtt6); + Set perms = new HashSet<>(); + PermissionAttachmentInfo permAtt = mock(PermissionAttachmentInfo.class); + when(permAtt.getPermission()).thenReturn("bskyblock.island.limit.STONE.24"); + when(permAtt.getValue()).thenReturn(true); + perms.add(permAtt); + PermissionAttachmentInfo permAtt2 = mock(PermissionAttachmentInfo.class); + when(permAtt2.getPermission()).thenReturn("bskyblock.island.limit.short_grass.14"); + when(permAtt2.getValue()).thenReturn(true); + perms.add(permAtt2); + PermissionAttachmentInfo permAtt3 = mock(PermissionAttachmentInfo.class); + when(permAtt3.getPermission()).thenReturn("bskyblock.island.limit.dirt.34"); + when(permAtt3.getValue()).thenReturn(true); + perms.add(permAtt3); + PermissionAttachmentInfo permAtt4 = mock(PermissionAttachmentInfo.class); + when(permAtt4.getPermission()).thenReturn("bskyblock.island.limit.chicken.34"); + when(permAtt4.getValue()).thenReturn(true); + perms.add(permAtt4); + PermissionAttachmentInfo permAtt5 = mock(PermissionAttachmentInfo.class); + when(permAtt5.getPermission()).thenReturn("bskyblock.island.limit.cave_spider.4"); + when(permAtt5.getValue()).thenReturn(true); + perms.add(permAtt5); + PermissionAttachmentInfo permAtt6 = mock(PermissionAttachmentInfo.class); + when(permAtt6.getPermission()).thenReturn("bskyblock.island.limit.cave_spider.4"); + when(permAtt6.getValue()).thenReturn(false); // negative perm + perms.add(permAtt6); - when(player.getEffectivePermissions()).thenReturn(perms); - PlayerJoinEvent e = new PlayerJoinEvent(player, "welcome"); - jl.onPlayerJoin(e); - verify(addon, never()).logError(anyString()); - verify(ibc).setBlockLimit(eq(Material.STONE), eq(24)); - verify(ibc).setBlockLimit(eq(Material.SHORT_GRASS), eq(14)); - verify(ibc).setBlockLimit(eq(Material.DIRT), eq(34)); - verify(ibc).setEntityLimit(eq(EntityType.CHICKEN), eq(34)); - verify(ibc).setEntityLimit(eq(EntityType.CAVE_SPIDER), eq(4)); + when(player.getEffectivePermissions()).thenReturn(perms); + PlayerJoinEvent e = new PlayerJoinEvent(player, "welcome"); + jl.onPlayerJoin(e); + verify(addon, never()).logError(anyString()); + verify(ibc).setBlockLimit(eq(Material.STONE), eq(24)); + verify(ibc).setBlockLimit(eq(Material.SHORT_GRASS), eq(14)); + verify(ibc).setBlockLimit(eq(Material.DIRT), eq(34)); + verify(ibc).setEntityLimit(eq(EntityType.CHICKEN), eq(34)); + verify(ibc).setEntityLimit(eq(EntityType.CAVE_SPIDER), eq(4)); } /** @@ -487,9 +492,9 @@ public class JoinListenerTest { */ @Test public void testOnUnregisterIslandNotUnregistered() { - IslandEvent e = new IslandEvent(island, null, false, null, IslandEvent.Reason.BAN); - jl.onUnregisterIsland(e); - verify(island, never()).getWorld(); + IslandEvent e = new IslandEvent(island, null, false, null, IslandEvent.Reason.BAN); + jl.onUnregisterIsland(e); + verify(island, never()).getWorld(); } /** @@ -498,10 +503,10 @@ public class JoinListenerTest { */ @Test public void testOnUnregisterIslandNotInWorld() { - IslandEvent e = new IslandEvent(island, null, false, null, IslandEvent.Reason.UNREGISTERED); - jl.onUnregisterIsland(e); - verify(island).getWorld(); - verify(addon, never()).getBlockLimitListener(); + IslandEvent e = new IslandEvent(island, null, false, null, IslandEvent.Reason.UNREGISTERED); + jl.onUnregisterIsland(e); + verify(island).getWorld(); + verify(addon, never()).getBlockLimitListener(); } /** @@ -510,15 +515,15 @@ public class JoinListenerTest { */ @Test public void testOnUnregisterIslandInWorld() { - @SuppressWarnings("unchecked") - Map map = mock(Map.class); - when(ibc.getBlockLimits()).thenReturn(map); - when(addon.inGameModeWorld(any())).thenReturn(true); - IslandEvent e = new IslandEvent(island, null, false, null, IslandEvent.Reason.UNREGISTERED); - jl.onUnregisterIsland(e); - verify(island).getWorld(); - verify(addon).getBlockLimitListener(); - verify(map).clear(); + @SuppressWarnings("unchecked") + Map map = mock(Map.class); + when(ibc.getBlockLimits()).thenReturn(map); + when(addon.inGameModeWorld(any())).thenReturn(true); + IslandEvent e = new IslandEvent(island, null, false, null, IslandEvent.Reason.UNREGISTERED); + jl.onUnregisterIsland(e); + verify(island).getWorld(); + verify(addon).getBlockLimitListener(); + verify(map).clear(); } diff --git a/src/test/java/world/bentobox/limits/LimitsTest.java b/src/test/java/world/bentobox/limits/LimitsTest.java index 36895a6..30837b7 100644 --- a/src/test/java/world/bentobox/limits/LimitsTest.java +++ b/src/test/java/world/bentobox/limits/LimitsTest.java @@ -62,6 +62,7 @@ import world.bentobox.bentobox.managers.FlagsManager; import world.bentobox.bentobox.managers.IslandWorldManager; import world.bentobox.bentobox.managers.IslandsManager; import world.bentobox.bentobox.managers.PlaceholdersManager; +import world.bentobox.limits.mocks.ServerMocks; /** * @author tastybento @@ -135,6 +136,7 @@ public class LimitsTest { */ @Before public void setUp() throws Exception { + Server server = ServerMocks.newServer(); // Set up plugin Whitebox.setInternalState(BentoBox.class, "instance", plugin); when(plugin.getLogger()).thenReturn(Logger.getAnonymousLogger()); @@ -175,7 +177,6 @@ public class LimitsTest { // Server PowerMockito.mockStatic(Bukkit.class); - Server server = mock(Server.class); when(Bukkit.getServer()).thenReturn(server); when(Bukkit.getLogger()).thenReturn(Logger.getAnonymousLogger()); when(Bukkit.getPluginManager()).thenReturn(mock(PluginManager.class)); @@ -213,7 +214,6 @@ public class LimitsTest { // Bukkit - PowerMockito.mockStatic(Bukkit.class); when(Bukkit.getScheduler()).thenReturn(scheduler); ItemMeta meta = mock(ItemMeta.class); ItemFactory itemFactory = mock(ItemFactory.class); @@ -239,6 +239,9 @@ public class LimitsTest { */ @After public void tearDown() throws Exception { + ServerMocks.unsetBukkitServer(); + User.clearUsers(); + Mockito.framework().clearInlineMocks(); deleteAll(new File("database")); } diff --git a/src/test/java/world/bentobox/limits/mocks/ServerMocks.java b/src/test/java/world/bentobox/limits/mocks/ServerMocks.java new file mode 100644 index 0000000..fbca488 --- /dev/null +++ b/src/test/java/world/bentobox/limits/mocks/ServerMocks.java @@ -0,0 +1,118 @@ +package world.bentobox.limits.mocks; + +import static org.mockito.ArgumentMatchers.notNull; +import static org.mockito.Mockito.doAnswer; +import static org.mockito.Mockito.doReturn; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +import java.lang.reflect.Field; +import java.util.HashMap; +import java.util.Locale; +import java.util.Map; +import java.util.Set; +import java.util.logging.Logger; + +import org.bukkit.Bukkit; +import org.bukkit.Keyed; +import org.bukkit.NamespacedKey; +import org.bukkit.Registry; +import org.bukkit.Server; +import org.bukkit.Tag; +import org.bukkit.UnsafeValues; +import org.eclipse.jdt.annotation.NonNull; + +public final class ServerMocks { + + public static @NonNull Server newServer() { + Server mock = mock(Server.class); + + Logger noOp = mock(Logger.class); + when(mock.getLogger()).thenReturn(noOp); + when(mock.isPrimaryThread()).thenReturn(true); + + // Unsafe + UnsafeValues unsafe = mock(UnsafeValues.class); + when(mock.getUnsafe()).thenReturn(unsafe); + + // Server must be available before tags can be mocked. + Bukkit.setServer(mock); + + // Bukkit has a lot of static constants referencing registry values. To initialize those, the + // registries must be able to be fetched before the classes are touched. + Map, Object> registers = new HashMap<>(); + + doAnswer(invocationGetRegistry -> registers.computeIfAbsent(invocationGetRegistry.getArgument(0), clazz -> { + Registry registry = mock(Registry.class); + Map cache = new HashMap<>(); + doAnswer(invocationGetEntry -> { + NamespacedKey key = invocationGetEntry.getArgument(0); + // Some classes (like BlockType and ItemType) have extra generics that will be + // erased during runtime calls. To ensure accurate typing, grab the constant's field. + // This approach also allows us to return null for unsupported keys. + Class constantClazz; + try { + //noinspection unchecked + constantClazz = (Class) clazz + .getField(key.getKey().toUpperCase(Locale.ROOT).replace('.', '_')).getType(); + } catch (ClassCastException e) { + throw new RuntimeException(e); + } catch (NoSuchFieldException e) { + return null; + } + + return cache.computeIfAbsent(key, key1 -> { + Keyed keyed = mock(constantClazz); + doReturn(key).when(keyed).getKey(); + return keyed; + }); + }).when(registry).get(notNull()); + return registry; + })).when(mock).getRegistry(notNull()); + + // Tags are dependent on registries, but use a different method. + // This will set up blank tags for each constant; all that needs to be done to render them + // functional is to re-mock Tag#getValues. + doAnswer(invocationGetTag -> { + Tag tag = mock(Tag.class); + doReturn(invocationGetTag.getArgument(1)).when(tag).getKey(); + doReturn(Set.of()).when(tag).getValues(); + doAnswer(invocationIsTagged -> { + Keyed keyed = invocationIsTagged.getArgument(0); + Class type = invocationGetTag.getArgument(2); + if (!type.isAssignableFrom(keyed.getClass())) { + return null; + } + // Since these are mocks, the exact instance might not be equal. Consider equal keys equal. + return tag.getValues().contains(keyed) + || tag.getValues().stream().anyMatch(value -> value.getKey().equals(keyed.getKey())); + }).when(tag).isTagged(notNull()); + return tag; + }).when(mock).getTag(notNull(), notNull(), notNull()); + + // Once the server is all set up, touch BlockType and ItemType to initialize. + // This prevents issues when trying to access dependent methods from a Material constant. + try { + Class.forName("org.bukkit.inventory.ItemType"); + Class.forName("org.bukkit.block.BlockType"); + } catch (ClassNotFoundException e) { + throw new RuntimeException(e); + } + + return mock; + } + + public static void unsetBukkitServer() { + try { + Field server = Bukkit.class.getDeclaredField("server"); + server.setAccessible(true); + server.set(null, null); + } catch (NoSuchFieldException | IllegalArgumentException | IllegalAccessException e) { + throw new RuntimeException(e); + } + } + + private ServerMocks() { + } + +} \ No newline at end of file