Challenges/src/test/java/world/bentobox/challenges/ChallengesAddonTest.java

415 lines
14 KiB
Java

package world.bentobox.challenges;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.nio.charset.Charset;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Arrays;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.Optional;
import java.util.UUID;
import java.util.jar.JarEntry;
import java.util.jar.JarOutputStream;
import java.util.logging.Logger;
import org.bukkit.Bukkit;
import org.bukkit.Server;
import org.bukkit.UnsafeValues;
import org.bukkit.entity.Player;
import org.bukkit.inventory.ItemFactory;
import org.bukkit.inventory.meta.ItemMeta;
import org.bukkit.plugin.PluginManager;
import org.bukkit.scheduler.BukkitScheduler;
import org.eclipse.jdt.annotation.NonNull;
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.mockito.stubbing.Answer;
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.addons.Addon;
import world.bentobox.bentobox.api.addons.Addon.State;
import world.bentobox.bentobox.api.addons.AddonDescription;
import world.bentobox.bentobox.api.addons.GameModeAddon;
import world.bentobox.bentobox.api.commands.CompositeCommand;
import world.bentobox.bentobox.api.configuration.Config;
import world.bentobox.bentobox.api.user.User;
import world.bentobox.bentobox.database.DatabaseSetup.DatabaseType;
import world.bentobox.bentobox.database.objects.Island;
import world.bentobox.bentobox.managers.AddonsManager;
import world.bentobox.bentobox.managers.CommandsManager;
import world.bentobox.bentobox.managers.FlagsManager;
import world.bentobox.bentobox.managers.IslandWorldManager;
import world.bentobox.bentobox.managers.IslandsManager;
/**
* @author tastybento
*
*/
@RunWith(PowerMockRunner.class)
@PrepareForTest({Bukkit.class, BentoBox.class, User.class, Config.class })
public class ChallengesAddonTest {
@Mock
private User user;
@Mock
private IslandsManager im;
@Mock
private Island island;
private ChallengesAddon addon;
@Mock
private BentoBox plugin;
@Mock
private FlagsManager fm;
@Mock
private Settings settings;
@Mock
private GameModeAddon gameMode;
@Mock
private AddonsManager am;
@Mock
private BukkitScheduler scheduler;
/**
* @throws java.lang.Exception
*/
@Before
public void setUp() throws Exception {
// Set up plugin
Whitebox.setInternalState(BentoBox.class, "instance", plugin);
when(plugin.getLogger()).thenReturn(Logger.getAnonymousLogger());
//when(plugin.isEnabled()).thenReturn(true);
// Command manager
CommandsManager cm = mock(CommandsManager.class);
when(plugin.getCommandsManager()).thenReturn(cm);
// Player
Player p = mock(Player.class);
// Sometimes use Mockito.withSettings().verboseLogging()
when(user.isOp()).thenReturn(false);
UUID uuid = UUID.randomUUID();
when(user.getUniqueId()).thenReturn(uuid);
when(user.getPlayer()).thenReturn(p);
when(user.getName()).thenReturn("tastybento");
User.setPlugin(plugin);
// Island World Manager
IslandWorldManager iwm = mock(IslandWorldManager.class);
when(plugin.getIWM()).thenReturn(iwm);
// Player has island to begin with
island = mock(Island.class);
when(im.getIsland(Mockito.any(), Mockito.any(UUID.class))).thenReturn(island);
when(plugin.getIslands()).thenReturn(im);
// Locales
// Return the reference (USE THIS IN THE FUTURE)
when(user.getTranslation(Mockito.anyString())).thenAnswer((Answer<String>) invocation -> invocation.getArgument(0, String.class));
// 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));
// Addon
addon = new ChallengesAddon();
File jFile = new File("addon.jar");
List<String> lines = Arrays.asList("# ChallengesAddon Configuration", "uniqueId: config");
Path path = Paths.get("config.yml");
Files.write(path, lines, Charset.forName("UTF-8"));
try (JarOutputStream tempJarOutputStream = new JarOutputStream(new FileOutputStream(jFile))) {
//Added the new files to the jar.
try (FileInputStream fis = new FileInputStream(path.toFile())) {
byte[] buffer = new byte[1024];
int bytesRead = 0;
JarEntry entry = new JarEntry(path.toString());
tempJarOutputStream.putNextEntry(entry);
while((bytesRead = fis.read(buffer)) != -1) {
tempJarOutputStream.write(buffer, 0, bytesRead);
}
}
}
File dataFolder = new File("addons/Challenges");
addon.setDataFolder(dataFolder);
addon.setFile(jFile);
AddonDescription desc = new AddonDescription.Builder("bentobox", "challenges", "1.3").description("test").authors("BONNe").build();
addon.setDescription(desc);
// Addons manager
when(plugin.getAddonsManager()).thenReturn(am);
// One game mode
when(am.getGameModeAddons()).thenReturn(Collections.singletonList(gameMode));
AddonDescription desc2 = new AddonDescription.Builder("bentobox", "BSkyBlock", "1.3").description("test").authors("tasty").build();
when(gameMode.getDescription()).thenReturn(desc2);
// Player command
CompositeCommand cmd = mock(CompositeCommand.class);
@NonNull
Optional<CompositeCommand> opCmd = Optional.of(cmd);
when(gameMode.getPlayerCommand()).thenReturn(opCmd);
// Admin command
when(gameMode.getAdminCommand()).thenReturn(opCmd);
// Flags manager
when(plugin.getFlagsManager()).thenReturn(fm);
when(fm.getFlags()).thenReturn(Collections.emptyList());
// The database type has to be created one line before the thenReturn() to work!
when(plugin.getSettings()).thenReturn(settings);
DatabaseType value = DatabaseType.JSON;
when(settings.getDatabaseType()).thenReturn(value);
// Bukkit
PowerMockito.mockStatic(Bukkit.class);
when(Bukkit.getScheduler()).thenReturn(scheduler);
ItemMeta meta = mock(ItemMeta.class);
ItemFactory itemFactory = mock(ItemFactory.class);
when(itemFactory.getItemMeta(any())).thenReturn(meta);
when(Bukkit.getItemFactory()).thenReturn(itemFactory);
UnsafeValues unsafe = mock(UnsafeValues.class);
when(unsafe.getDataVersion()).thenReturn(777);
when(Bukkit.getUnsafe()).thenReturn(unsafe);
}
/**
* @throws java.lang.Exception
*/
@After
public void tearDown() throws Exception {
new File("addon.jar").delete();
new File("config.yml").delete();
deleteAll(new File("addons"));
deleteAll(new File("database"));
}
private void deleteAll(File file) throws IOException {
if (file.exists()) {
Files.walk(file.toPath())
.sorted(Comparator.reverseOrder())
.map(Path::toFile)
.forEach(File::delete);
}
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesAddon#onLoad()}.
*/
@Test
public void testOnLoad() {
addon.onLoad();
// Check that config.yml file has been saved
File check = new File("addons/Challenges","config.yml");
assertTrue(check.exists());
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesAddon#onEnable()}.
*/
@Test
public void testOnEnableDisabledPlugin() {
when(plugin.isEnabled()).thenReturn(false);
addon.onEnable();
verify(plugin).logError("[challenges] BentoBox is not available or disabled!");
assertEquals(Addon.State.DISABLED, addon.getState());
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesAddon#onEnable()}.
*/
@Test
public void testOnEnableDisabledAddon() {
when(plugin.isEnabled()).thenReturn(true);
addon.setState(State.DISABLED);
addon.onEnable();
verify(plugin).logError("[challenges] Challenges Addon is not available or disabled!");
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesAddon#onEnable()}.
*/
@Test
public void testOnEnableIncompatibleDatabase() {
// The database type has to be created one line before the thenReturn() to work!
DatabaseType value = DatabaseType.YAML;
when(settings.getDatabaseType()).thenReturn(value);
when(plugin.isEnabled()).thenReturn(true);
addon.setState(State.LOADED);
addon.onEnable();
verify(plugin).logError("[challenges] BentoBox database is not compatible with Challenges Addon.");
verify(plugin).logError("[challenges] Please use JSON based database type.");
assertEquals(State.INCOMPATIBLE, addon.getState());
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesAddon#onEnable()}.
*/
@Test
public void testOnEnableHooked() {
addon.onLoad();
when(plugin.isEnabled()).thenReturn(true);
addon.setState(State.LOADED);
addon.onEnable();
verify(plugin).logWarning("[challenges] Level add-on not found so level challenges will not work!");
verify(plugin).logWarning("[challenges] Economy plugin not found so money options will not work!");
verify(plugin).log("[challenges] Loading challenges...");
verify(plugin, never()).logError("Challenges could not hook into AcidIsland or BSkyBlock so will not do anything!");
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesAddon#onEnable()}.
*/
@Test
public void testOnEnableNotHooked() {
addon.onLoad();
when(am.getGameModeAddons()).thenReturn(Collections.emptyList());
when(plugin.isEnabled()).thenReturn(true);
addon.setState(State.LOADED);
addon.onEnable();
verify(plugin).log("[challenges] Loading challenges...");
verify(plugin).logError("[challenges] Challenges could not hook into AcidIsland or BSkyBlock so will not do anything!");
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesAddon#onReload()}.
*/
@Test
public void testOnReloadNotHooked() {
addon.onReload();
verify(plugin, never()).log(anyString());
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesAddon#onDisable()}.
*/
@Test
public void testOnDisable() {
this.testOnEnableHooked();
addon.onDisable();
// Verify database saved exists
File chDir = new File("database", "Challenge");
assertTrue(chDir.exists());
File lvDir = new File("database", "ChallengeLevel");
assertTrue(lvDir.exists());
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesAddon#getChallengesManager()}.
*/
@Test
public void testGetChallengesManager() {
assertNull(addon.getChallengesManager());
this.testOnEnableHooked();
assertNotNull(addon.getChallengesManager());
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesAddon#getPermissionPrefix()}.
*/
@Test
public void testGetPermissionPrefix() {
assertEquals("addon.", addon.getPermissionPrefix());
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesAddon#getImportManager()}.
*/
@Test
public void testGetImportManager() {
assertNull(addon.getImportManager());
this.testOnEnableHooked();
assertNotNull(addon.getImportManager());
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesAddon#getWebManager()}.
*/
@Test
public void testGetWebManager() {
assertNull(addon.getWebManager());
this.testOnEnableHooked();
assertNotNull(addon.getWebManager());
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesAddon#getChallengesSettings()}.
*/
@Test
public void testGetChallengesSettings() {
assertNull(addon.getChallengesSettings());
addon.onLoad();
assertNotNull(addon.getChallengesSettings());
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesAddon#isEconomyProvided()}.
*/
@Test
public void testIsEconomyProvided() {
assertFalse(addon.isEconomyProvided());
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesAddon#getEconomyProvider()}.
*/
@Test
public void testGetEconomyProvider() {
assertNull(addon.getEconomyProvider());
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesAddon#isLevelProvided()}.
*/
@Test
public void testIsLevelProvided() {
assertFalse(addon.isLevelProvided());
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesAddon#getLevelAddon()}.
*/
@Test
public void testGetLevelAddon() {
assertNull(addon.getLevelAddon());
}
}