Add IslandHomesCommand

https://github.com/BentoBoxWorld/BentoBox/issues/1737

src/main/java/world/bentobox/bentobox/api/commands/island/IslandHomesCommand.java

@@ -0,0 +1,47 @@
+package world.bentobox.bentobox.api.commands.island;
+
+import java.util.List;
+
+import org.eclipse.jdt.annotation.Nullable;
+
+import world.bentobox.bentobox.api.commands.CompositeCommand;
+import world.bentobox.bentobox.api.commands.ConfirmableCommand;
+import world.bentobox.bentobox.api.localization.TextVariables;
+import world.bentobox.bentobox.api.user.User;
+import world.bentobox.bentobox.database.objects.Island;
+
+public class IslandHomesCommand extends ConfirmableCommand {
+
+    private @Nullable Island island;
+
+    public IslandHomesCommand(CompositeCommand islandCommand) {
+        super(islandCommand, "homes");
+    }
+
+    @Override
+    public void setup() {
+        setPermission("island.homes");
+        setOnlyPlayer(true);
+        setDescription("commands.island.homes.description");
+    }
+
+    @Override
+    public boolean canExecute(User user, String label, List<String> args) {
+        island = getIslands().getIsland(getWorld(), user);
+        // Check island
+        if (island == null || island.getOwner() == null) {
+            user.sendMessage("general.errors.no-island");
+            return false;
+        }
+        return true;
+    }
+
+    @Override
+    public boolean execute(User user, String label, List<String> args) {
+        user.sendMessage("commands.island.sethome.homes-are");
+        island.getHomes().keySet().stream().filter(s -> !s.isEmpty())
+        .forEach(s -> user.sendMessage("commands.island.sethome.home-list-syntax", TextVariables.NAME, s));
+        return true;
+    }
+
+}

src/main/resources/locales/en-US.yml

@@ -496,6 +496,8 @@ commands:
     deletehome:
       description: "delete a home location"
       parameters: "[home name]"
+    homes:
+      description: "list your homes"
     info:
       description: "display info about your island or the player's island"
       parameters: "<player>"

src/test/java/world/bentobox/bentobox/api/commands/island/IslandHomesCommandTest.java

@@ -0,0 +1,205 @@
+package world.bentobox.bentobox.api.commands.island;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.UUID;
+
+import org.bukkit.Bukkit;
+import org.bukkit.Location;
+import org.bukkit.World;
+import org.bukkit.entity.Player;
+import org.bukkit.scheduler.BukkitScheduler;
+import org.jetbrains.annotations.NotNull;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.Mockito;
+import org.powermock.api.mockito.PowerMockito;
+import org.powermock.core.classloader.annotations.PrepareForTest;
+import org.powermock.modules.junit4.PowerMockRunner;
+import org.powermock.reflect.Whitebox;
+
+import world.bentobox.bentobox.BentoBox;
+import world.bentobox.bentobox.Settings;
+import world.bentobox.bentobox.api.commands.CompositeCommand;
+import world.bentobox.bentobox.api.localization.TextVariables;
+import world.bentobox.bentobox.api.user.User;
+import world.bentobox.bentobox.database.objects.Island;
+import world.bentobox.bentobox.managers.CommandsManager;
+import world.bentobox.bentobox.managers.IslandWorldManager;
+import world.bentobox.bentobox.managers.IslandsManager;
+import world.bentobox.bentobox.managers.PlayersManager;
+import world.bentobox.bentobox.util.Util;
+
+/**
+ * @author tastybento
+ *
+ */
+@RunWith(PowerMockRunner.class)
+@PrepareForTest({Bukkit.class, BentoBox.class, Util.class})
+public class IslandHomesCommandTest {
+
+    @Mock
+    private CompositeCommand ic;
+    @Mock
+    private User user;
+    private UUID uuid;
+    @Mock
+    private IslandsManager im;
+    @Mock
+    private Island island;
+    @Mock
+    private IslandWorldManager iwm;
+
+    /**
+     * @throws java.lang.Exception
+     */
+    @Before
+    public void setUp() throws Exception {
+        // Set up plugin
+        BentoBox plugin = mock(BentoBox.class);
+        Whitebox.setInternalState(BentoBox.class, "instance", plugin);
+
+        // Command manager
+        CommandsManager cm = mock(CommandsManager.class);
+        when(plugin.getCommandsManager()).thenReturn(cm);
+
+        // Settings
+        Settings s = mock(Settings.class);
+        when(plugin.getSettings()).thenReturn(s);
+
+        // Player
+        Player player = mock(Player.class);
+        when(user.isOp()).thenReturn(false);
+        uuid = UUID.randomUUID();
+        when(user.getUniqueId()).thenReturn(uuid);
+        when(user.getPlayer()).thenReturn(player);
+        when(user.getName()).thenReturn("tastybento");
+        when(user.getWorld()).thenReturn(mock(World.class));
+        when(user.getTranslation(anyString())).thenAnswer(i -> i.getArgument(0, String.class));
+
+        // Parent command has no aliases
+        when(ic.getSubCommandAliases()).thenReturn(new HashMap<>());
+        when(ic.getTopLabel()).thenReturn("island");
+        when(ic.getPermissionPrefix()).thenReturn("bskyblock.");
+
+        // No island for player to begin with (set it later in the tests)
+        when(im.hasIsland(any(), any(User.class))).thenReturn(false);
+        when(im.isOwner(any(), eq(uuid))).thenReturn(false);
+        when(plugin.getIslands()).thenReturn(im);
+
+        // Has team
+        PlayersManager pm = mock(PlayersManager.class);
+        when(im.inTeam(any(), eq(uuid))).thenReturn(true);
+        when(plugin.getPlayers()).thenReturn(pm);
+
+        // Server & Scheduler
+        BukkitScheduler sch = mock(BukkitScheduler.class);
+        PowerMockito.mockStatic(Bukkit.class);
+        when(Bukkit.getScheduler()).thenReturn(sch);
+
+        // Island
+        when(island.getOwner()).thenReturn(uuid);
+        when(island.onIsland(any())).thenReturn(true);
+        when(im.getIsland(any(), any(UUID.class))).thenReturn(island);
+        when(im.getIsland(any(), any(User.class))).thenReturn(island);
+        @NotNull
+        Map<String, Location> homeMap = new HashMap<>();
+        homeMap.put("Home", null);
+        homeMap.put("Home2", null);
+        homeMap.put("Home3", null);
+        homeMap.put("Home4", null);
+        when(island.getHomes()).thenReturn(homeMap);
+
+        // IWM friendly name
+        when(iwm.getFriendlyName(any())).thenReturn("BSkyBlock");
+        // Not in nether
+        when(iwm.isNether(any())).thenReturn(false);
+        // Not in end
+        when(iwm.isEnd(any())).thenReturn(false);
+        // Number of homes default
+        when(iwm.getMaxHomes(any())).thenReturn(3);
+        when(plugin.getIWM()).thenReturn(iwm);
+
+        // Number of homes
+        PowerMockito.mockStatic(Util.class);
+
+    }
+
+    @After
+    public void tearDown() {
+        Mockito.framework().clearInlineMocks();
+    }
+
+    /**
+     * Test method for {@link world.bentobox.bentobox.api.commands.island.IslandHomesCommand#IslandHomesCommand(world.bentobox.bentobox.api.commands.CompositeCommand)}.
+     */
+    @Test
+    public void testIslandHomesCommand() {
+        IslandHomesCommand cmd = new IslandHomesCommand(ic);
+        assertEquals("homes", cmd.getName());
+    }
+
+    /**
+     * Test method for {@link world.bentobox.bentobox.api.commands.island.IslandHomesCommand#setup()}.
+     */
+    @Test
+    public void testSetup() {
+        IslandHomesCommand isc = new IslandHomesCommand(ic);
+        assertEquals("bskyblock.island.homes", isc.getPermission());
+        assertTrue(isc.isOnlyPlayer());
+        assertEquals("commands.island.homes.description", isc.getDescription());
+    }
+
+    /**
+     * Test method for {@link world.bentobox.bentobox.api.commands.island.IslandHomesCommand#canExecute(world.bentobox.bentobox.api.user.User, java.lang.String, java.util.List)}.
+     */
+    @Test
+    public void testCanExecuteNoIsland() {
+        // Player doesn't have an island
+        when(im.getIsland(any(), eq(user))).thenReturn(null);
+
+        IslandHomesCommand isc = new IslandHomesCommand(ic);
+        assertFalse(isc.canExecute(user, "island", Collections.emptyList()));
+        verify(user).sendMessage("general.errors.no-island");
+    }
+
+    /**
+     * Test method for {@link world.bentobox.bentobox.api.commands.island.IslandHomesCommand#canExecute(world.bentobox.bentobox.api.user.User, java.lang.String, java.util.List)}.
+     */
+    @Test
+    public void testCanExecute() {
+        IslandHomesCommand isc = new IslandHomesCommand(ic);
+        assertTrue(isc.canExecute(user, "island", Collections.emptyList()));
+        verify(user, never()).sendMessage("general.errors.no-island");
+    }
+
+    /**
+     * Test method for {@link world.bentobox.bentobox.api.commands.island.IslandHomesCommand#execute(world.bentobox.bentobox.api.user.User, java.lang.String, java.util.List)}.
+     */
+    @Test
+    public void testExecuteUserStringListOfString() {
+        IslandHomesCommand isc = new IslandHomesCommand(ic);
+        assertTrue(isc.canExecute(user, "island", Collections.emptyList()));
+        assertTrue(isc.execute(user, "island", Collections.emptyList()));
+        verify(user).sendMessage("commands.island.sethome.homes-are");
+        verify(user, times(4)).sendMessage(eq("commands.island.sethome.home-list-syntax"), eq(TextVariables.NAME), anyString());
+    }
+
+
+}