Upstream/Challenges
1
0
Fork 0
mirror of https://github.com/BentoBoxWorld/Challenges.git synced 2024-11-25 03:55:10 +01:00
Code Issues Projects Releases Wiki Activity

Test coverage (#199)

Browse Source 
* Test coverage for Challenges Command

* Added CompleteChallengeCommand test class

* Added Utils test class

* Added ChallengesGUI test class

* Fix code smells from sonarcloud analysis

* Added .gitignore

* Added Travis CI config file

* WIP ChallengesManager Test class

* Added ChallengesManager test class

* Removed debug

* Removed code smells.

* Added ChallengesAddon test class.

* Added onDisbale test

* Added new TryToComplete test class - WIP

Covers inventory challenges.

* Added Island Challenge entity tests to TryToComplete test class
This commit is contained in:
tastybento 2019-10-29 23:44:26 -07:00 committed by BONNe
parent d1c9e8fd44
commit 9d45f08fb1
23 changed files with 4830 additions and 1861 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -131,3 +131,4 @@ local.properties
/target/ /target/
checkstyle.xml checkstyle.xml
classes/ classes/
/.DS_Store

21
.travis.yml Normal file
View File

@ -0,0 +1,21 @@
language: java
sudo: false
addons:
sonarcloud:
organization: "bentobox-world"
token:
secure: $SONAR_TOKEN
branches:
- develop
- master
jdk:
- openjdk8
script:
#- sonar-scanner
- mvn clean org.jacoco:jacoco-maven-plugin:prepare-agent package -P sonar sonar:sonar -B
#- echo "${TRAVIS_PULL_REQUEST_BRANCH:-$TRAVIS_BRANCH}"
cache:
directories:
- '$HOME/.m2/repository'
- '$HOME/.sonar/cache'

39
pom.xml
View File

@ -33,7 +33,7 @@
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version> <java.version>1.8</java.version>
<powermock.version>1.7.4</powermock.version> <powermock.version>2.0.2</powermock.version>
<!-- More visible way how to change dependency versions --> <!-- More visible way how to change dependency versions -->
<spigot.version>1.14.4-R0.1-SNAPSHOT</spigot.version> <spigot.version>1.14.4-R0.1-SNAPSHOT</spigot.version>
<bentobox.version>1.7.0</bentobox.version> <bentobox.version>1.7.0</bentobox.version>
@ -129,24 +129,25 @@
<version>${spigot.version}</version> <version>${spigot.version}</version>
<scope>provided</scope> <scope>provided</scope>
</dependency> </dependency>
<dependency> <!-- Mockito (Unit testing) -->
<groupId>org.mockito</groupId> <dependency>
<artifactId>mockito-all</artifactId> <groupId>org.mockito</groupId>
<version>1.10.19</version> <artifactId>mockito-core</artifactId>
<scope>test</scope> <version>3.0.0</version>
</dependency> <scope>test</scope>
<dependency> </dependency>
<groupId>org.powermock</groupId> <dependency>
<artifactId>powermock-module-junit4</artifactId> <groupId>org.powermock</groupId>
<version>${powermock.version}</version> <artifactId>powermock-module-junit4</artifactId>
<scope>test</scope> <version>${powermock.version}</version>
</dependency> <scope>test</scope>
<dependency> </dependency>
<groupId>org.powermock</groupId> <dependency>
<artifactId>powermock-api-mockito</artifactId> <groupId>org.powermock</groupId>
<version>${powermock.version}</version> <artifactId>powermock-api-mockito2</artifactId>
<scope>test</scope> <version>${powermock.version}</version>
</dependency> <scope>test</scope>
</dependency>
<dependency> <dependency>
<groupId>world.bentobox</groupId> <groupId>world.bentobox</groupId>
<artifactId>bentobox</artifactId> <artifactId>bentobox</artifactId>

15
src/main/java/world/bentobox/challenges/ChallengesAddon.java
View File

@ -5,6 +5,7 @@ import java.util.ArrayList;
import java.util.List; import java.util.List;
import java.util.Optional; import java.util.Optional;
import org.bukkit.Bukkit;
import org.bukkit.Material; import org.bukkit.Material;
import world.bentobox.bentobox.api.addons.Addon; import world.bentobox.bentobox.api.addons.Addon;
@ -88,7 +89,7 @@ public class ChallengesAddon extends Addon {
* This flag allows to complete challenges in any part of the world. It will not limit * This flag allows to complete challenges in any part of the world. It will not limit
* player to their island. Useful for skygrid without protection flags. * player to their island. Useful for skygrid without protection flags.
*/ */
public static Flag CHALLENGES_WORLD_PROTECTION = public static final Flag CHALLENGES_WORLD_PROTECTION =
new Flag.Builder("CHALLENGES_WORLD_PROTECTION", Material.GRASS_BLOCK).type(Flag.Type.WORLD_SETTING).defaultSetting(true).build(); new Flag.Builder("CHALLENGES_WORLD_PROTECTION", Material.GRASS_BLOCK).type(Flag.Type.WORLD_SETTING).defaultSetting(true).build();
/** /**
@ -96,7 +97,7 @@ public class ChallengesAddon extends Addon {
* that only Island owner can complete challenge. * that only Island owner can complete challenge.
* By default it is set to Visitor. * By default it is set to Visitor.
*/ */
public static Flag CHALLENGES_ISLAND_PROTECTION = public static final Flag CHALLENGES_ISLAND_PROTECTION =
new Flag.Builder("CHALLENGES_ISLAND_PROTECTION", Material.COMMAND_BLOCK).defaultRank(RanksManager.VISITOR_RANK).build(); new Flag.Builder("CHALLENGES_ISLAND_PROTECTION", Material.COMMAND_BLOCK).defaultRank(RanksManager.VISITOR_RANK).build();
@ -155,7 +156,11 @@ public class ChallengesAddon extends Addon {
List<GameModeAddon> hookedGameModes = new ArrayList<>(); List<GameModeAddon> hookedGameModes = new ArrayList<>();
this.getPlugin().getAddonsManager().getGameModeAddons().forEach(gameModeAddon -> { this.getPlugin().getAddonsManager().getGameModeAddons().forEach(gameModeAddon -> {
if (!this.settings.getDisabledGameModes().contains(gameModeAddon.getDescription().getName())) if (!this.settings
.getDisabledGameModes()
.contains(gameModeAddon
.getDescription()
.getName()))
{ {
if (gameModeAddon.getPlayerCommand().isPresent()) if (gameModeAddon.getPlayerCommand().isPresent())
{ {
@ -238,7 +243,7 @@ public class ChallengesAddon extends Addon {
if (this.settings.getAutoSaveTimer() > 0) if (this.settings.getAutoSaveTimer() > 0)
{ {
this.getPlugin().getServer().getScheduler().runTaskTimerAsynchronously( Bukkit.getScheduler().runTaskTimerAsynchronously(
this.getPlugin(), this.getPlugin(),
bukkitTask -> ChallengesAddon.this.challengesManager.save(), bukkitTask -> ChallengesAddon.this.challengesManager.save(),
this.settings.getAutoSaveTimer() * 60 * 20, this.settings.getAutoSaveTimer() * 60 * 20,
@ -264,7 +269,7 @@ public class ChallengesAddon extends Addon {
{ {
this.loadSettings(); this.loadSettings();
this.challengesManager.reload(); this.challengesManager.reload();
this.getLogger().info("Challenges addon reloaded."); this.log("Challenges addon reloaded.");
} }
} }

711
src/main/java/world/bentobox/challenges/ChallengesImportManager.java
View File

@ -43,14 +43,14 @@ public class ChallengesImportManager
* @param challengesAddon * @param challengesAddon
*/ */
public ChallengesImportManager(ChallengesAddon challengesAddon) public ChallengesImportManager(ChallengesAddon challengesAddon)
{ {
this.addon = challengesAddon; this.addon = challengesAddon;
} }
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
// Section: Default Challenge Loader // Section: Default Challenge Loader
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
/** /**
@ -79,45 +79,46 @@ public class ChallengesImportManager
} }
// default configuration should be removed. // default configuration should be removed.
// user made configuration should not!. // user made configuration should not!.
boolean removeAtEnd = boolean removeAtEnd =
!Files.exists(Paths.get(this.addon.getDataFolder().getPath() + "/default.json")); !Files.exists(Paths.get(this.addon.getDataFolder().getPath() + "/default.json"));
// Safe json configuration to Challenges folder. // Safe json configuration to Challenges folder.
this.addon.saveResource("default.json", false); this.addon.saveResource("default.json", false);
try try
{ {
// This prefix will be used to all challenges. That is a unique way how to separate challenged for // This prefix will be used to all challenges. That is a unique way how to separate challenged for
// each game mode. // each game mode.
String uniqueIDPrefix = Utils.getGameMode(world) + "_"; String uniqueIDPrefix = Utils.getGameMode(world) + "_";
DefaultDataHolder defaultChallenges = new DefaultJSONHandler(this.addon).loadObject(); DefaultDataHolder defaultChallenges = new DefaultJSONHandler(this.addon).loadObject();
if (defaultChallenges != null) {
// All new challenges should get correct ID. So we need to map it to loaded challenges.
defaultChallenges.getChallengeList().forEach(challenge -> {
// Set correct challenge ID
challenge.setUniqueId(uniqueIDPrefix + challenge.getUniqueId());
// Set up correct level ID if it is necessary
if (!challenge.getLevel().isEmpty())
{
challenge.setLevel(uniqueIDPrefix + challenge.getLevel());
}
// Load challenge in memory
manager.loadChallenge(challenge, false, user, user == null);
});
// All new challenges should get correct ID. So we need to map it to loaded challenges. defaultChallenges.getLevelList().forEach(challengeLevel -> {
defaultChallenges.getChallengeList().forEach(challenge -> { // Set correct level ID
// Set correct challenge ID challengeLevel.setUniqueId(uniqueIDPrefix + challengeLevel.getUniqueId());
challenge.setUniqueId(uniqueIDPrefix + challenge.getUniqueId()); // Set correct world name
// Set up correct level ID if it is necessary challengeLevel.setWorld(Util.getWorld(world).getName());
if (!challenge.getLevel().isEmpty()) // Reset names for all challenges.
{ challengeLevel.setChallenges(challengeLevel.getChallenges().stream().
challenge.setLevel(uniqueIDPrefix + challenge.getLevel()); map(challenge -> uniqueIDPrefix + challenge).
} collect(Collectors.toSet()));
// Load challenge in memory // Load level in memory
manager.loadChallenge(challenge, false, user, user == null); manager.loadLevel(challengeLevel, false, user, user == null);
}); });
}
defaultChallenges.getLevelList().forEach(challengeLevel -> {
// Set correct level ID
challengeLevel.setUniqueId(uniqueIDPrefix + challengeLevel.getUniqueId());
// Set correct world name
challengeLevel.setWorld(Util.getWorld(world).getName());
// Reset names for all challenges.
challengeLevel.setChallenges(challengeLevel.getChallenges().stream().
map(challenge -> uniqueIDPrefix + challenge).
collect(Collectors.toSet()));
// Load level in memory
manager.loadLevel(challengeLevel, false, user, user == null);
});
} }
catch (Exception e) catch (Exception e)
{ {
@ -128,132 +129,132 @@ public class ChallengesImportManager
this.addon.getChallengesManager().save(); this.addon.getChallengesManager().save();
if (removeAtEnd) if (removeAtEnd)
{ {
// Remove default.yml file from resources to avoid interacting with it. // Remove default.yml file from resources to avoid interacting with it.
new File(this.addon.getDataFolder(), "default.json").delete(); return new File(this.addon.getDataFolder(), "default.json").delete();
} }
return true; return true;
} }
/** /**
* This method loads downloaded challenges into memory. * This method loads downloaded challenges into memory.
* @param user User who calls downloaded challenge loading * @param user User who calls downloaded challenge loading
* @param world Target world. * @param world Target world.
* @param downloadString String that need to be loaded via DefaultDataHolder. * @param downloadString String that need to be loaded via DefaultDataHolder.
* @return <code>true</code> if everything was successful, otherwise <code>false</code>. * @return <code>true</code> if everything was successful, otherwise <code>false</code>.
*/ */
public boolean loadDownloadedChallenges(User user, World world, String downloadString) public boolean loadDownloadedChallenges(User user, World world, String downloadString)
{ {
ChallengesManager manager = this.addon.getChallengesManager(); ChallengesManager manager = this.addon.getChallengesManager();
// If exist any challenge or level that is bound to current world, then do not load default challenges. // If exist any challenge or level that is bound to current world, then do not load default challenges.
if (manager.hasAnyChallengeData(world.getName())) if (manager.hasAnyChallengeData(world.getName()))
{ {
if (user.isPlayer()) if (user.isPlayer())
{ {
user.sendMessage("challenges.errors.exist-challenges-or-levels"); user.sendMessage("challenges.errors.exist-challenges-or-levels");
} }
else else
{ {
this.addon.logWarning("challenges.errors.exist-challenges-or-levels"); this.addon.logWarning("challenges.errors.exist-challenges-or-levels");
} }
return false; return false;
} }
try try
{ {
// This prefix will be used to all challenges. That is a unique way how to separate challenged for // This prefix will be used to all challenges. That is a unique way how to separate challenged for
// each game mode. // each game mode.
String uniqueIDPrefix = Utils.getGameMode(world) + "_"; String uniqueIDPrefix = Utils.getGameMode(world) + "_";
DefaultDataHolder downloadedChallenges = new DefaultJSONHandler(this.addon).loadWebObject(downloadString); DefaultDataHolder downloadedChallenges = new DefaultJSONHandler(this.addon).loadWebObject(downloadString);
// All new challenges should get correct ID. So we need to map it to loaded challenges. // All new challenges should get correct ID. So we need to map it to loaded challenges.
downloadedChallenges.getChallengeList().forEach(challenge -> { downloadedChallenges.getChallengeList().forEach(challenge -> {
// Set correct challenge ID // Set correct challenge ID
challenge.setUniqueId(uniqueIDPrefix + challenge.getUniqueId()); challenge.setUniqueId(uniqueIDPrefix + challenge.getUniqueId());
// Set up correct level ID if it is necessary // Set up correct level ID if it is necessary
if (!challenge.getLevel().isEmpty()) if (!challenge.getLevel().isEmpty())
{ {
challenge.setLevel(uniqueIDPrefix + challenge.getLevel()); challenge.setLevel(uniqueIDPrefix + challenge.getLevel());
} }
// Load challenge in memory // Load challenge in memory
manager.loadChallenge(challenge, false, user, user == null); manager.loadChallenge(challenge, false, user, user == null);
}); });
downloadedChallenges.getLevelList().forEach(challengeLevel -> { downloadedChallenges.getLevelList().forEach(challengeLevel -> {
// Set correct level ID // Set correct level ID
challengeLevel.setUniqueId(uniqueIDPrefix + challengeLevel.getUniqueId()); challengeLevel.setUniqueId(uniqueIDPrefix + challengeLevel.getUniqueId());
// Set correct world name // Set correct world name
challengeLevel.setWorld(Util.getWorld(world).getName()); challengeLevel.setWorld(Util.getWorld(world).getName());
// Reset names for all challenges. // Reset names for all challenges.
challengeLevel.setChallenges(challengeLevel.getChallenges().stream(). challengeLevel.setChallenges(challengeLevel.getChallenges().stream().
map(challenge -> uniqueIDPrefix + challenge). map(challenge -> uniqueIDPrefix + challenge).
collect(Collectors.toSet())); collect(Collectors.toSet()));
// Load level in memory // Load level in memory
manager.loadLevel(challengeLevel, false, user, user == null); manager.loadLevel(challengeLevel, false, user, user == null);
}); });
} }
catch (Exception e) catch (Exception e)
{ {
e.printStackTrace(); addon.getPlugin().logStacktrace(e);
return false; return false;
} }
this.addon.getChallengesManager().save(); this.addon.getChallengesManager().save();
return true; return true;
} }
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
// Section: Default generation // Section: Default generation
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
/** /**
* Create method that can generate default challenge file from existing challenges in given world. * Create method that can generate default challenge file from existing challenges in given world.
* This method will create default.json file in Challenges folder. * This method will create default.json file in Challenges folder.
* @param user User who calls this method. * @param user User who calls this method.
* @param world from which challenges must be stored. * @param world from which challenges must be stored.
* @param overwrite indicates if existing default.json file can be overwritten. * @param overwrite indicates if existing default.json file can be overwritten.
* @return <code>true</code> if everything was successful, otherwise <code>false</code> * @return <code>true</code> if everything was successful, otherwise <code>false</code>
*/ */
public boolean generateDefaultChallengeFile(User user, World world, boolean overwrite) public boolean generateDefaultChallengeFile(User user, World world, boolean overwrite)
{ {
File defaultFile = new File(this.addon.getDataFolder(), "default.json"); File defaultFile = new File(this.addon.getDataFolder(), "default.json");
if (defaultFile.exists()) if (defaultFile.exists())
{ {
if (overwrite) if (overwrite)
{ {
if (user.isPlayer()) if (user.isPlayer())
{ {
user.sendMessage("challenges.messages.defaults-file-overwrite"); user.sendMessage("challenges.messages.defaults-file-overwrite");
} }
else else
{ {
this.addon.logWarning("challenges.messages.defaults-file-overwrite"); this.addon.logWarning("challenges.messages.defaults-file-overwrite");
} }
defaultFile.delete(); defaultFile.delete();
} }
else else
{ {
if (user.isPlayer()) if (user.isPlayer())
{ {
user.sendMessage("challenges.errors.defaults-file-exist"); user.sendMessage("challenges.errors.defaults-file-exist");
} }
else else
{ {
this.addon.logWarning("challenges.errors.defaults-file-exist"); this.addon.logWarning("challenges.errors.defaults-file-exist");
} }
return false; return false;
} }
} }
try try
{ {
@ -262,102 +263,102 @@ public class ChallengesImportManager
String replacementString = Utils.getGameMode(world) + "_"; String replacementString = Utils.getGameMode(world) + "_";
ChallengesManager manager = this.addon.getChallengesManager(); ChallengesManager manager = this.addon.getChallengesManager();
List<Challenge> challengeList = manager.getAllChallenges(world). List<Challenge> challengeList = manager.getAllChallenges(world).
stream(). stream().
map(challenge -> { map(challenge -> {
// Use clone to avoid any changes in existing challenges. // Use clone to avoid any changes in existing challenges.
Challenge clone = challenge.clone(); Challenge clone = challenge.clone();
// Remove world name from challenge id. // Remove world name from challenge id.
clone.setUniqueId(challenge.getUniqueId().replaceFirst(replacementString, "")); clone.setUniqueId(challenge.getUniqueId().replaceFirst(replacementString, ""));
// Remove world name from level id. // Remove world name from level id.
clone.setLevel(challenge.getLevel().replaceFirst(replacementString, "")); clone.setLevel(challenge.getLevel().replaceFirst(replacementString, ""));
return clone; return clone;
}). }).
collect(Collectors.toList()); collect(Collectors.toList());
List<ChallengeLevel> levelList = manager.getLevels(world). List<ChallengeLevel> levelList = manager.getLevels(world).
stream(). stream().
map(challengeLevel -> { map(challengeLevel -> {
// Use clone to avoid any changes in existing levels. // Use clone to avoid any changes in existing levels.
ChallengeLevel clone = challengeLevel.clone(); ChallengeLevel clone = challengeLevel.clone();
// Remove world name from level ID. // Remove world name from level ID.
clone.setUniqueId(challengeLevel.getUniqueId().replaceFirst(replacementString, "")); clone.setUniqueId(challengeLevel.getUniqueId().replaceFirst(replacementString, ""));
// Remove world name. // Remove world name.
clone.setWorld(""); clone.setWorld("");
// Challenges must be reassign, as they also contains world name. // Challenges must be reassign, as they also contains world name.
clone.setChallenges(challengeLevel.getChallenges().stream(). clone.setChallenges(challengeLevel.getChallenges().stream().
map(challenge -> challenge.replaceFirst(replacementString, "")). map(challenge -> challenge.replaceFirst(replacementString, "")).
collect(Collectors.toSet())); collect(Collectors.toSet()));
return clone; return clone;
}). }).
collect(Collectors.toList()); collect(Collectors.toList());
DefaultDataHolder defaultChallenges = new DefaultDataHolder(); DefaultDataHolder defaultChallenges = new DefaultDataHolder();
defaultChallenges.setChallengeList(challengeList); defaultChallenges.setChallengeList(challengeList);
defaultChallenges.setLevelList(levelList); defaultChallenges.setLevelList(levelList);
defaultChallenges.setVersion(this.addon.getDescription().getVersion()); defaultChallenges.setVersion(this.addon.getDescription().getVersion());
BufferedWriter writer = new BufferedWriter( try (BufferedWriter writer = new BufferedWriter(
new OutputStreamWriter(new FileOutputStream(defaultFile), StandardCharsets.UTF_8)); new OutputStreamWriter(new FileOutputStream(defaultFile), StandardCharsets.UTF_8))) {
writer.write(Objects.requireNonNull( writer.write(Objects.requireNonNull(
new DefaultJSONHandler(this.addon).toJsonString(defaultChallenges))); new DefaultJSONHandler(this.addon).toJsonString(defaultChallenges)));
writer.close(); }
} }
} }
catch (IOException e) catch (IOException e)
{ {
if (user.isPlayer()) if (user.isPlayer())
{ {
user.sendMessage("challenges.errors.defaults-file-error"); user.sendMessage("challenges.errors.defaults-file-error");
} }
this.addon.logError("Could not save json file: " + e.getMessage()); this.addon.logError("Could not save json file: " + e.getMessage());
return false; return false;
} }
finally finally
{ {
if (user.isPlayer()) if (user.isPlayer())
{ {
user.sendMessage("challenges.messages.defaults-file-completed", "[world]", world.getName()); user.sendMessage("challenges.messages.defaults-file-completed", "[world]", world.getName());
} }
else else
{ {
this.addon.logWarning("challenges.messages.defaults-file-completed"); this.addon.logWarning("challenges.messages.defaults-file-completed");
} }
} }
return true; return true;
} }
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
// Section: Private classes for default challenges // Section: Private classes for default challenges
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
/** /**
* This Class allows to load default challenges and their levels as objects much easier. * This Class allows to load default challenges and their levels as objects much easier.
*/ */
private static final class DefaultJSONHandler private static final class DefaultJSONHandler
{ {
/** /**
* This constructor inits JSON builder that will be used to parse challenges. * This constructor inits JSON builder that will be used to parse challenges.
* @param addon Challenges Adddon * @param addon Challenges Adddon
*/ */
DefaultJSONHandler(ChallengesAddon addon) DefaultJSONHandler(ChallengesAddon addon)
{ {
GsonBuilder builder = new GsonBuilder().excludeFieldsWithoutExposeAnnotation().enableComplexMapKeySerialization(); GsonBuilder builder = new GsonBuilder().excludeFieldsWithoutExposeAnnotation().enableComplexMapKeySerialization();
// Register adapters // Register adapters
builder.registerTypeAdapterFactory(new BentoboxTypeAdapterFactory(addon.getPlugin())); builder.registerTypeAdapterFactory(new BentoboxTypeAdapterFactory(addon.getPlugin()));
// Keep null in the database // Keep null in the database
builder.serializeNulls(); builder.serializeNulls();
// Allow characters like < or > without escaping them // Allow characters like < or > without escaping them
builder.disableHtmlEscaping(); builder.disableHtmlEscaping();
this.addon = addon; this.addon = addon;
this.gson = builder.setPrettyPrinting().create(); this.gson = builder.setPrettyPrinting().create();
} }
@ -366,7 +367,7 @@ public class ChallengesImportManager
* @param instance Instance that must be parsed to json string. * @param instance Instance that must be parsed to json string.
* @return String that contains JSON information from instance object. * @return String that contains JSON information from instance object.
*/ */
String toJsonString(DefaultDataHolder instance) String toJsonString(DefaultDataHolder instance)
{ {
// Null check // Null check
if (instance == null) if (instance == null)
@ -375,193 +376,193 @@ public class ChallengesImportManager
return null; return null;
} }
return this.gson.toJson(instance); return this.gson.toJson(instance);
} }
/** /**
* This method creates and adds to list all objects from default.json file. * This method creates and adds to list all objects from default.json file.
* @return List of all objects from default.json that is with T instance. * @return List of all objects from default.json that is with T instance.
*/ */
DefaultDataHolder loadObject() DefaultDataHolder loadObject()
{ {
File defaultFile = new File(this.addon.getDataFolder(), "default.json"); File defaultFile = new File(this.addon.getDataFolder(), "default.json");
try (InputStreamReader reader = new InputStreamReader(new FileInputStream(defaultFile), StandardCharsets.UTF_8)) try (InputStreamReader reader = new InputStreamReader(new FileInputStream(defaultFile), StandardCharsets.UTF_8))
{ {
DefaultDataHolder object = this.gson.fromJson(reader, DefaultDataHolder.class); DefaultDataHolder object = this.gson.fromJson(reader, DefaultDataHolder.class);
reader.close(); // NOSONAR Required to keep OS file handlers low and not rely on GC reader.close(); // NOSONAR Required to keep OS file handlers low and not rely on GC
return object; return object;
} }
catch (FileNotFoundException e) catch (FileNotFoundException e)
{ {
this.addon.logError("Could not load file '" + defaultFile.getName() + "': File not found."); this.addon.logError("Could not load file '" + defaultFile.getName() + "': File not found.");
} }
catch (Exception e) catch (Exception e)
{ {
this.addon.logError("Could not load objects " + defaultFile.getName() + " " + e.getMessage()); this.addon.logError("Could not load objects " + defaultFile.getName() + " " + e.getMessage());
} }
return null; return null;
} }
/** /**
* This method creates and adds to list all objects from default.json file. * This method creates and adds to list all objects from default.json file.
* @return List of all objects from default.json that is with T instance. * @return List of all objects from default.json that is with T instance.
*/ */
DefaultDataHolder loadWebObject(String downloadedObject) DefaultDataHolder loadWebObject(String downloadedObject)
{ {
return this.gson.fromJson(downloadedObject, DefaultDataHolder.class); return this.gson.fromJson(downloadedObject, DefaultDataHolder.class);
} }
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
// Section: Variables // Section: Variables
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
/** /**
* Holds JSON builder object. * Holds JSON builder object.
*/ */
private Gson gson; private Gson gson;
/** /**
* Holds ChallengesAddon object. * Holds ChallengesAddon object.
*/ */
private ChallengesAddon addon; private ChallengesAddon addon;
} }
/** /**
* This is simple object that will allow to store all current challenges and levels * This is simple object that will allow to store all current challenges and levels
* in single file. * in single file.
*/ */
private static final class DefaultDataHolder implements DataObject private static final class DefaultDataHolder implements DataObject
{ {
/** /**
* Default constructor. Creates object with empty lists. * Default constructor. Creates object with empty lists.
*/ */
DefaultDataHolder() DefaultDataHolder()
{ {
this.challengeList = Collections.emptyList(); this.challengeList = Collections.emptyList();
this.challengeLevelList = Collections.emptyList(); this.challengeLevelList = Collections.emptyList();
this.version = ""; this.version = "";
} }
/** /**
* This method returns stored challenge list. * This method returns stored challenge list.
* @return list that contains default challenges. * @return list that contains default challenges.
*/ */
List<Challenge> getChallengeList() List<Challenge> getChallengeList()
{ {
return challengeList; return challengeList;
} }
/** /**
* This method sets given list as default challenge list. * This method sets given list as default challenge list.
* @param challengeList new default challenge list. * @param challengeList new default challenge list.
*/ */
void setChallengeList(List<Challenge> challengeList) void setChallengeList(List<Challenge> challengeList)
{ {
this.challengeList = challengeList; this.challengeList = challengeList;
} }
/** /**
* This method returns list of default challenge levels. * This method returns list of default challenge levels.
* @return List that contains default challenge levels. * @return List that contains default challenge levels.
*/ */
List<ChallengeLevel> getLevelList() List<ChallengeLevel> getLevelList()
{ {
return challengeLevelList; return challengeLevelList;
} }
/** /**
* This method sets given list as default challenge level list. * This method sets given list as default challenge level list.
* @param levelList new default challenge level list. * @param levelList new default challenge level list.
*/ */
void setLevelList(List<ChallengeLevel> levelList) void setLevelList(List<ChallengeLevel> levelList)
{ {
this.challengeLevelList = levelList; this.challengeLevelList = levelList;
} }
/** /**
* This method returns the version value. * This method returns the version value.
* @return the value of version. * @return the value of version.
*/ */
public String getVersion() public String getVersion()
{ {
return version; return version;
} }
/** /**
* This method sets the version value. * This method sets the version value.
* @param version the version new value. * @param version the version new value.
* *
*/ */
public void setVersion(String version) public void setVersion(String version)
{ {
this.version = version; this.version = version;
} }
/** /**
* @return default.json * @return default.json
*/ */
@Override @Override
public String getUniqueId() public String getUniqueId()
{ {
return "default.json"; return "default.json";
} }
/** /**
* @param uniqueId - unique ID the uniqueId to set * @param uniqueId - unique ID the uniqueId to set
*/ */
@Override @Override
public void setUniqueId(String uniqueId) public void setUniqueId(String uniqueId)
{ {
// method not used. // method not used.
} }
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
// Section: Variables // Section: Variables
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
/** /**
* Holds a list with default challenges. * Holds a list with default challenges.
*/ */
@Expose @Expose
private List<Challenge> challengeList; private List<Challenge> challengeList;
/** /**
* Holds a list with default levels. * Holds a list with default levels.
*/ */
@Expose @Expose
private List<ChallengeLevel> challengeLevelList; private List<ChallengeLevel> challengeLevelList;
/** /**
* Holds a variable that stores in which addon version file was made. * Holds a variable that stores in which addon version file was made.
*/ */
@Expose @Expose
private String version; private String version;
} }
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
// Section: Variables // Section: Variables
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
private ChallengesAddon addon; private ChallengesAddon addon;
} }

403
src/main/java/world/bentobox/challenges/ChallengesManager.java
View File

@ -19,6 +19,7 @@ import java.util.stream.Collectors;
import org.bukkit.Bukkit; import org.bukkit.Bukkit;
import org.bukkit.World; import org.bukkit.World;
import org.eclipse.jdt.annotation.NonNull; import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import world.bentobox.bentobox.api.logs.LogEntry; import world.bentobox.bentobox.api.logs.LogEntry;
import world.bentobox.bentobox.api.user.User; import world.bentobox.bentobox.api.user.User;
@ -43,7 +44,7 @@ import world.bentobox.challenges.utils.Utils;
/** /**
* This class manges challenges. It allows access to all data that is stored to database. * This class manages challenges. It allows access to all data that is stored to database.
* It also provides information about challenge level status for each user. * It also provides information about challenge level status for each user.
*/ */
public class ChallengesManager public class ChallengesManager
@ -107,6 +108,11 @@ public class ChallengesManager
* String for free Challenge Level. * String for free Challenge Level.
*/ */
public static final String FREE = ""; public static final String FREE = "";
public static final String VALUE = "[value]";
public static final String USER_ID = "user-id";
public static final String CHALLENGE_ID = "challenge-id";
public static final String ADMIN_ID = "admin-id";
public static final String RESET = "RESET";
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
@ -142,7 +148,7 @@ public class ChallengesManager
{ {
// Sort by challenges level order numbers // Sort by challenges level order numbers
return Integer.compare(this.getLevel(o1.getLevel()).getOrder(), return Integer.compare(this.getLevel(o1.getLevel()).getOrder(),
this.getLevel(o2.getLevel()).getOrder()); this.getLevel(o2.getLevel()).getOrder());
} }
} }
}; };
@ -189,6 +195,7 @@ public class ChallengesManager
*/ */
public void load() public void load()
{ {
this.addon.log("Loading challenges...");
this.challengeCacheData.clear(); this.challengeCacheData.clear();
this.levelCacheData.clear(); this.levelCacheData.clear();
@ -199,17 +206,15 @@ public class ChallengesManager
} }
this.playerCacheData.clear(); this.playerCacheData.clear();
loadAndValidate();
}
this.addon.getLogger().info("Loading challenges...");
private void loadAndValidate() {
this.challengeDatabase.loadObjects().forEach(this::loadChallenge); this.challengeDatabase.loadObjects().forEach(this::loadChallenge);
this.levelDatabase.loadObjects().forEach(this::loadLevel); this.levelDatabase.loadObjects().forEach(this::loadLevel);
// this validate challenge levels // this validate challenge levels
this.validateChallenges(); this.validateChallenges();
// It is not necessary to load all players in memory.
// this.playersDatabase.loadObjects().forEach(this::loadPlayerData);
} }
@ -218,24 +223,17 @@ public class ChallengesManager
*/ */
public void reload() public void reload()
{ {
this.addon.log("Reloading challenges...");
if (!this.playerCacheData.isEmpty()) if (!this.playerCacheData.isEmpty())
{ {
// store player data before cleaning. // store player data before cleaning.
this.savePlayersData(); this.savePlayersData();
} }
//this.challengeDatabase = new Database<>(addon, Challenge.class);
//this.levelDatabase = new Database<>(addon, ChallengeLevel.class);
//this.playersDatabase = new Database<>(addon, ChallengesPlayerData.class);
this.addon.getLogger().info("Reloading challenges..."); loadAndValidate();
this.challengeDatabase = new Database<>(addon, Challenge.class);
this.levelDatabase = new Database<>(addon, ChallengeLevel.class);
this.playersDatabase = new Database<>(addon, ChallengesPlayerData.class);
this.challengeDatabase.loadObjects().forEach(this::loadChallenge);
this.levelDatabase.loadObjects().forEach(this::loadLevel);
this.validateChallenges();
// It is not necessary to load all players in memory.
// this.playersDatabase.loadObjects().forEach(this::loadPlayerData);
} }
@ -261,17 +259,10 @@ public class ChallengesManager
* @return - true if imported * @return - true if imported
*/ */
public boolean loadChallenge(@NonNull Challenge challenge, public boolean loadChallenge(@NonNull Challenge challenge,
boolean overwrite, boolean overwrite,
User user, User user,
boolean silent) boolean silent)
{ {
if (challenge == null)
{
this.addon.logError(
"Tried to load NULL element from Database. One challenge is broken and will not work.");
return false;
}
if (this.challengeCacheData.containsKey(challenge.getUniqueId())) if (this.challengeCacheData.containsKey(challenge.getUniqueId()))
{ {
if (!overwrite) if (!overwrite)
@ -279,7 +270,7 @@ public class ChallengesManager
if (!silent) if (!silent)
{ {
user.sendMessage("challenges.messages.load-skipping", user.sendMessage("challenges.messages.load-skipping",
"[value]", challenge.getFriendlyName()); VALUE, challenge.getFriendlyName());
} }
return false; return false;
@ -289,7 +280,7 @@ public class ChallengesManager
if (!silent) if (!silent)
{ {
user.sendMessage("challenges.messages.load-overwriting", user.sendMessage("challenges.messages.load-overwriting",
"[value]", challenge.getFriendlyName()); VALUE, challenge.getFriendlyName());
} }
} }
} }
@ -298,7 +289,7 @@ public class ChallengesManager
if (!silent) if (!silent)
{ {
user.sendMessage("challenges.messages.load-add", user.sendMessage("challenges.messages.load-add",
"[value]", challenge.getFriendlyName()); VALUE, challenge.getFriendlyName());
} }
} }
@ -329,28 +320,21 @@ public class ChallengesManager
* @return boolean that indicate about load status. * @return boolean that indicate about load status.
*/ */
public boolean loadLevel(@NonNull ChallengeLevel level, public boolean loadLevel(@NonNull ChallengeLevel level,
boolean overwrite, boolean overwrite,
User user, User user,
boolean silent) boolean silent)
{ {
if (level == null)
{
this.addon.logError(
"Tried to load NULL element from Database. One level is broken and will not work.");
return false;
}
if (!this.isValidLevel(level)) if (!this.isValidLevel(level))
{ {
if (user != null) if (user != null)
{ {
user.sendMessage("challenges.errors.load-error", user.sendMessage("challenges.errors.load-error",
"[value]", level.getFriendlyName()); VALUE, level.getFriendlyName());
} }
else else
{ {
this.addon.logError( this.addon.logError(
"Challenge Level '" + level.getUniqueId() + "' is not valid and skipped"); "Challenge Level '" + level.getUniqueId() + "' is not valid and skipped");
} }
return false; return false;
@ -363,7 +347,7 @@ public class ChallengesManager
if (!silent) if (!silent)
{ {
user.sendMessage("challenges.messages.load-skipping", user.sendMessage("challenges.messages.load-skipping",
"[value]", level.getFriendlyName()); VALUE, level.getFriendlyName());
} }
return false; return false;
@ -373,7 +357,7 @@ public class ChallengesManager
if (!silent) if (!silent)
{ {
user.sendMessage("challenges.messages.load-overwriting", user.sendMessage("challenges.messages.load-overwriting",
"[value]", level.getFriendlyName()); VALUE, level.getFriendlyName());
} }
} }
} }
@ -382,7 +366,7 @@ public class ChallengesManager
if (!silent) if (!silent)
{ {
user.sendMessage("challenges.messages.load-add", user.sendMessage("challenges.messages.load-add",
"[value]", level.getFriendlyName()); VALUE, level.getFriendlyName());
} }
} }
@ -416,14 +400,11 @@ public class ChallengesManager
*/ */
public void removeFromCache(UUID playerID) public void removeFromCache(UUID playerID)
{ {
if (!this.settings.isStoreAsIslandData()) if (!this.settings.isStoreAsIslandData() && this.playerCacheData.containsKey(playerID.toString()))
{ {
if (this.playerCacheData.containsKey(playerID.toString())) // save before remove
{ this.savePlayerData(playerID.toString());
// save before remove this.playerCacheData.remove(playerID.toString());
this.savePlayerData(playerID.toString());
this.playerCacheData.remove(playerID.toString());
}
} }
// TODO: It would be necessary to remove also data, if they stores islands. // TODO: It would be necessary to remove also data, if they stores islands.
@ -449,7 +430,7 @@ public class ChallengesManager
// If challenge's level is not found, then set it as free challenge. // If challenge's level is not found, then set it as free challenge.
challenge.setLevel(FREE); challenge.setLevel(FREE);
this.addon.logWarning("Challenge's " + challenge.getUniqueId() + " level was not found in the database. " + this.addon.logWarning("Challenge's " + challenge.getUniqueId() + " level was not found in the database. " +
"To avoid any errors with missing level, challenge was added to the FREE level!"); "To avoid any errors with missing level, challenge was added to the FREE level!");
} }
}); });
} }
@ -680,13 +661,13 @@ public class ChallengesManager
this.levelCacheData.remove(level.getUniqueId()); this.levelCacheData.remove(level.getUniqueId());
level.setUniqueId( level.setUniqueId(
addonName + level.getUniqueId().substring(world.getName().length())); addonName + level.getUniqueId().substring(world.getName().length()));
Set<String> challengesID = new HashSet<>(level.getChallenges()); Set<String> challengesID = new HashSet<>(level.getChallenges());
level.getChallenges().clear(); level.getChallenges().clear();
challengesID.forEach(challenge -> challengesID.forEach(challenge ->
level.getChallenges().add(addonName + challenge.substring(world.getName().length()))); level.getChallenges().add(addonName + challenge.substring(world.getName().length())));
this.levelDatabase.saveObject(level); this.levelDatabase.saveObject(level);
this.levelCacheData.put(level.getUniqueId(), level); this.levelCacheData.put(level.getUniqueId(), level);
@ -740,36 +721,36 @@ public class ChallengesManager
{ {
switch (challenge.getChallengeType()) switch (challenge.getChallengeType())
{ {
case INVENTORY: case INVENTORY:
InventoryRequirements inventoryRequirements = new InventoryRequirements(); InventoryRequirements inventoryRequirements = new InventoryRequirements();
inventoryRequirements.setRequiredItems(challenge.getRequiredItems()); inventoryRequirements.setRequiredItems(challenge.getRequiredItems());
inventoryRequirements.setTakeItems(challenge.isTakeItems()); inventoryRequirements.setTakeItems(challenge.isTakeItems());
inventoryRequirements.setRequiredPermissions(challenge.getRequiredPermissions()); inventoryRequirements.setRequiredPermissions(challenge.getRequiredPermissions());
challenge.setRequirements(inventoryRequirements); challenge.setRequirements(inventoryRequirements);
break; break;
case ISLAND: case ISLAND:
IslandRequirements islandRequirements = new IslandRequirements(); IslandRequirements islandRequirements = new IslandRequirements();
islandRequirements.setRemoveBlocks(challenge.isRemoveBlocks()); islandRequirements.setRemoveBlocks(challenge.isRemoveBlocks());
islandRequirements.setRemoveEntities(challenge.isRemoveEntities()); islandRequirements.setRemoveEntities(challenge.isRemoveEntities());
islandRequirements.setRequiredBlocks(challenge.getRequiredBlocks()); islandRequirements.setRequiredBlocks(challenge.getRequiredBlocks());
islandRequirements.setRequiredEntities(challenge.getRequiredEntities()); islandRequirements.setRequiredEntities(challenge.getRequiredEntities());
islandRequirements.setSearchRadius(challenge.getSearchRadius()); islandRequirements.setSearchRadius(challenge.getSearchRadius());
islandRequirements.setRequiredPermissions(challenge.getRequiredPermissions()); islandRequirements.setRequiredPermissions(challenge.getRequiredPermissions());
challenge.setRequirements(islandRequirements); challenge.setRequirements(islandRequirements);
break; break;
case OTHER: case OTHER:
OtherRequirements otherRequirements = new OtherRequirements(); OtherRequirements otherRequirements = new OtherRequirements();
otherRequirements.setRequiredExperience(challenge.getRequiredExperience()); otherRequirements.setRequiredExperience(challenge.getRequiredExperience());
otherRequirements.setRequiredIslandLevel(challenge.getRequiredIslandLevel()); otherRequirements.setRequiredIslandLevel(challenge.getRequiredIslandLevel());
otherRequirements.setRequiredMoney(challenge.getRequiredMoney()); otherRequirements.setRequiredMoney(challenge.getRequiredMoney());
otherRequirements.setTakeExperience(challenge.isTakeExperience()); otherRequirements.setTakeExperience(challenge.isTakeExperience());
otherRequirements.setTakeMoney(challenge.isTakeMoney()); otherRequirements.setTakeMoney(challenge.isTakeMoney());
otherRequirements.setRequiredPermissions(challenge.getRequiredPermissions()); otherRequirements.setRequiredPermissions(challenge.getRequiredPermissions());
challenge.setRequirements(otherRequirements); challenge.setRequirements(otherRequirements);
break; break;
} }
// This save should not involve any upgrades in other parts. // This save should not involve any upgrades in other parts.
@ -1082,6 +1063,7 @@ public class ChallengesManager
* @param gameMode - World Name where levels should be searched. * @param gameMode - World Name where levels should be searched.
* @return Level status - how many challenges still to do on which level * @return Level status - how many challenges still to do on which level
*/ */
@NonNull
private List<LevelStatus> getAllChallengeLevelStatus(String storageDataID, String gameMode) private List<LevelStatus> getAllChallengeLevelStatus(String storageDataID, String gameMode)
{ {
this.addPlayerData(storageDataID); this.addPlayerData(storageDataID);
@ -1109,15 +1091,14 @@ public class ChallengesManager
doneChallengeCount = (int) level.getChallenges().stream().filter(playerData::isChallengeDone).count(); doneChallengeCount = (int) level.getChallenges().stream().filter(playerData::isChallengeDone).count();
result.add(new LevelStatus( result.add(new LevelStatus(
level, level,
previousLevel, previousLevel,
challengesToDo, challengesToDo,
level.getChallenges().size() == doneChallengeCount, level.getChallenges().size() == doneChallengeCount,
challengesToDo <= 0)); challengesToDo <= 0));
previousLevel = level; previousLevel = level;
} }
return result; return result;
} }
@ -1129,6 +1110,7 @@ public class ChallengesManager
* @param level Level which status must be calculated. * @param level Level which status must be calculated.
* @return LevelStatus of given level. * @return LevelStatus of given level.
*/ */
@Nullable
private LevelStatus getChallengeLevelStatus(@NonNull String storageDataID, World world, @NonNull ChallengeLevel level) private LevelStatus getChallengeLevelStatus(@NonNull String storageDataID, World world, @NonNull ChallengeLevel level)
{ {
this.addPlayerData(storageDataID); this.addPlayerData(storageDataID);
@ -1148,43 +1130,20 @@ public class ChallengesManager
int challengesToDo = previousLevel == null ? 0 : int challengesToDo = previousLevel == null ? 0 :
(previousLevel.getChallenges().size() - level.getWaiverAmount()) - (previousLevel.getChallenges().size() - level.getWaiverAmount()) -
(int) previousLevel.getChallenges().stream().filter(playerData::isChallengeDone).count(); (int) previousLevel.getChallenges().stream().filter(playerData::isChallengeDone).count();
// As level already contains unique ids of challenges, just iterate through them. // As level already contains unique ids of challenges, just iterate through them.
int doneChallengeCount = (int) level.getChallenges().stream().filter(playerData::isChallengeDone).count(); int doneChallengeCount = (int) level.getChallenges().stream().filter(playerData::isChallengeDone).count();
return new LevelStatus( return new LevelStatus(
level, level,
previousLevel, previousLevel,
challengesToDo, challengesToDo,
level.getChallenges().size() == doneChallengeCount, level.getChallenges().size() == doneChallengeCount,
challengesToDo <= 0); challengesToDo <= 0);
} }
} }
/**
* Check is playerData can see given level.
* TODO: not an optimal way. Faster would be to check previous level challenges.
* @param storageDataID - playerData ID
* @param level - level
* @return true if level is unlocked
*/
private boolean isLevelUnlocked(@NonNull String storageDataID,
World world,
ChallengeLevel level)
{
this.addPlayerData(storageDataID);
return this.islandWorldManager.getAddon(world).filter(gameMode ->
this.getAllChallengeLevelStatus(storageDataID, gameMode.getDescription().getName()).
stream().
filter(LevelStatus::isUnlocked).
anyMatch(lv -> lv.getLevel().equals(level))).
isPresent();
}
/** /**
* This method returns if given user has been already completed given level. * This method returns if given user has been already completed given level.
* @param levelID Level that must be checked. * @param levelID Level that must be checked.
@ -1316,17 +1275,17 @@ public class ChallengesManager
String storageID = this.getDataUniqueID(userID, Util.getWorld(world)); String storageID = this.getDataUniqueID(userID, Util.getWorld(world));
this.setChallengeComplete(storageID, challenge.getUniqueId(), completionCount); this.setChallengeComplete(storageID, challenge.getUniqueId(), completionCount);
this.addLogEntry(storageID, new LogEntry.Builder("COMPLETE"). this.addLogEntry(storageID, new LogEntry.Builder("COMPLETE").
data("user-id", userID.toString()). data(USER_ID, userID.toString()).
data("challenge-id", challenge.getUniqueId()). data(CHALLENGE_ID, challenge.getUniqueId()).
data("completion-count", Integer.toString(completionCount)). data("completion-count", Integer.toString(completionCount)).
build()); build());
// Fire event that user completes challenge // Fire event that user completes challenge
Bukkit.getServer().getPluginManager().callEvent( Bukkit.getPluginManager().callEvent(
new ChallengeCompletedEvent(challenge.getUniqueId(), new ChallengeCompletedEvent(challenge.getUniqueId(),
userID, userID,
false, false,
completionCount)); completionCount));
} }
@ -1343,17 +1302,17 @@ public class ChallengesManager
this.setChallengeComplete(storageID, challenge.getUniqueId()); this.setChallengeComplete(storageID, challenge.getUniqueId());
this.addLogEntry(storageID, new LogEntry.Builder("COMPLETE"). this.addLogEntry(storageID, new LogEntry.Builder("COMPLETE").
data("user-id", userID.toString()). data(USER_ID, userID.toString()).
data("challenge-id", challenge.getUniqueId()). data(CHALLENGE_ID, challenge.getUniqueId()).
data("admin-id", adminID == null ? "OP" : adminID.toString()). data(ADMIN_ID, adminID == null ? "OP" : adminID.toString()).
build()); build());
// Fire event that admin completes user challenge // Fire event that admin completes user challenge
Bukkit.getServer().getPluginManager().callEvent( Bukkit.getPluginManager().callEvent(
new ChallengeCompletedEvent(challenge.getUniqueId(), new ChallengeCompletedEvent(challenge.getUniqueId(),
userID, userID,
true, true,
1)); 1));
} }
@ -1368,18 +1327,18 @@ public class ChallengesManager
String storageID = this.getDataUniqueID(userID, Util.getWorld(world)); String storageID = this.getDataUniqueID(userID, Util.getWorld(world));
this.resetChallenge(storageID, challenge.getUniqueId()); this.resetChallenge(storageID, challenge.getUniqueId());
this.addLogEntry(storageID, new LogEntry.Builder("RESET"). this.addLogEntry(storageID, new LogEntry.Builder(RESET).
data("user-id", userID.toString()). data(USER_ID, userID.toString()).
data("challenge-id", challenge.getUniqueId()). data(CHALLENGE_ID, challenge.getUniqueId()).
data("admin-id", adminID == null ? "RESET" : adminID.toString()). data(ADMIN_ID, adminID == null ? RESET : adminID.toString()).
build()); build());
// Fire event that admin resets user challenge // Fire event that admin resets user challenge
Bukkit.getServer().getPluginManager().callEvent( Bukkit.getPluginManager().callEvent(
new ChallengeResetEvent(challenge.getUniqueId(), new ChallengeResetEvent(challenge.getUniqueId(),
userID, userID,
true, true,
"RESET")); RESET));
} }
@ -1407,16 +1366,16 @@ public class ChallengesManager
this.islandWorldManager.getAddon(world).ifPresent(gameMode -> { this.islandWorldManager.getAddon(world).ifPresent(gameMode -> {
this.resetAllChallenges(storageID, gameMode.getDescription().getName()); this.resetAllChallenges(storageID, gameMode.getDescription().getName());
this.addLogEntry(storageID, new LogEntry.Builder("RESET_ALL"). this.addLogEntry(storageID, new LogEntry.Builder("RESET_ALL").
data("user-id", userID.toString()). data(USER_ID, userID.toString()).
data("admin-id", adminID == null ? "ISLAND_RESET" : adminID.toString()). data(ADMIN_ID, adminID == null ? "ISLAND_RESET" : adminID.toString()).
build()); build());
// Fire event that admin resets user challenge // Fire event that admin resets user challenge
Bukkit.getServer().getPluginManager().callEvent( Bukkit.getPluginManager().callEvent(
new ChallengeResetAllEvent(gameMode.getDescription().getName(), new ChallengeResetAllEvent(gameMode.getDescription().getName(),
userID, userID,
adminID != null, adminID != null,
adminID == null ? "ISLAND_RESET" : "RESET_ALL")); adminID == null ? "ISLAND_RESET" : "RESET_ALL"));
}); });
} }
@ -1468,11 +1427,19 @@ public class ChallengesManager
* @param world World where level must be checked. * @param world World where level must be checked.
* @param level Level that must be checked. * @param level Level that must be checked.
* @param user User who need to be checked. * @param user User who need to be checked.
* @return true, if level is already completed. * @return true, if level is unlocked.
*/ */
public boolean isLevelUnlocked(User user, World world, ChallengeLevel level) public boolean isLevelUnlocked(User user, World world, ChallengeLevel level)
{ {
return this.isLevelUnlocked(this.getDataUniqueID(user, Util.getWorld(world)), world, level); String storageDataID = this.getDataUniqueID(user, Util.getWorld(world));
this.addPlayerData(storageDataID);
return this.islandWorldManager.getAddon(world).filter(gameMode -> this.getAllChallengeLevelStatus(storageDataID, gameMode.getDescription().getName()).
stream().
filter(LevelStatus::isUnlocked).
anyMatch(lv -> lv.getLevel().equals(level))).
isPresent();
} }
@ -1488,14 +1455,14 @@ public class ChallengesManager
this.setLevelComplete(storageID, level.getUniqueId()); this.setLevelComplete(storageID, level.getUniqueId());
this.addLogEntry(storageID, new LogEntry.Builder("COMPLETE_LEVEL"). this.addLogEntry(storageID, new LogEntry.Builder("COMPLETE_LEVEL").
data("user-id", user.getUniqueId().toString()). data(USER_ID, user.getUniqueId().toString()).
data("level", level.getUniqueId()).build()); data("level", level.getUniqueId()).build());
// Fire event that user completes level // Fire event that user completes level
Bukkit.getServer().getPluginManager().callEvent( Bukkit.getPluginManager().callEvent(
new LevelCompletedEvent(level.getUniqueId(), new LevelCompletedEvent(level.getUniqueId(),
user.getUniqueId(), user.getUniqueId(),
false)); false));
} }
@ -1514,14 +1481,15 @@ public class ChallengesManager
/** /**
* This method returns LevelStatus object for given challenge level. * This method returns LevelStatus object for given challenge level.
* @param uniqueId UUID of user who need to be validated.
* @param world World where level must be validated. * @param world World where level must be validated.
* @param level Level that must be validated. * @param level Level that must be validated.
* @param user User who need to be validated.
* @return LevelStatus of given level. * @return LevelStatus of given level.
*/ */
public LevelStatus getChallengeLevelStatus(UUID user, World world, ChallengeLevel level) @Nullable
public LevelStatus getChallengeLevelStatus(UUID uniqueId, World world, ChallengeLevel level)
{ {
return this.getChallengeLevelStatus(this.getDataUniqueID(user, Util.getWorld(world)), world, level); return this.getChallengeLevelStatus(this.getDataUniqueID(uniqueId, Util.getWorld(world)), world, level);
} }
@ -1532,13 +1500,14 @@ public class ChallengesManager
* @param world - World where levels should be searched. * @param world - World where levels should be searched.
* @return Level status - how many challenges still to do on which level * @return Level status - how many challenges still to do on which level
*/ */
@NonNull
public List<LevelStatus> getAllChallengeLevelStatus(User user, World world) public List<LevelStatus> getAllChallengeLevelStatus(User user, World world)
{ {
return this.islandWorldManager.getAddon(world).map(gameMode -> return this.islandWorldManager.getAddon(world).map(gameMode ->
this.getAllChallengeLevelStatus( this.getAllChallengeLevelStatus(
this.getDataUniqueID(user, Util.getWorld(world)), this.getDataUniqueID(user, Util.getWorld(world)),
gameMode.getDescription().getName())). gameMode.getDescription().getName())).
orElse(Collections.emptyList()); orElse(Collections.emptyList());
} }
@ -1556,12 +1525,12 @@ public class ChallengesManager
public List<String> getAllChallengesNames(@NonNull World world) public List<String> getAllChallengesNames(@NonNull World world)
{ {
return this.islandWorldManager.getAddon(world).map(gameMode -> return this.islandWorldManager.getAddon(world).map(gameMode ->
this.challengeCacheData.values().stream(). this.challengeCacheData.values().stream().
filter(challenge -> challenge.matchGameMode(gameMode.getDescription().getName())). filter(challenge -> challenge.matchGameMode(gameMode.getDescription().getName())).
sorted(this.challengeComparator). sorted(this.challengeComparator).
map(Challenge::getUniqueId). map(Challenge::getUniqueId).
collect(Collectors.toList())). collect(Collectors.toList())).
orElse(Collections.emptyList()); orElse(Collections.emptyList());
} }
@ -1574,11 +1543,11 @@ public class ChallengesManager
public List<Challenge> getAllChallenges(@NonNull World world) public List<Challenge> getAllChallenges(@NonNull World world)
{ {
return this.islandWorldManager.getAddon(world).map(gameMode -> return this.islandWorldManager.getAddon(world).map(gameMode ->
this.challengeCacheData.values().stream(). this.challengeCacheData.values().stream().
filter(challenge -> challenge.matchGameMode(gameMode.getDescription().getName())). filter(challenge -> challenge.matchGameMode(gameMode.getDescription().getName())).
sorted(this.challengeComparator). sorted(this.challengeComparator).
collect(Collectors.toList())). collect(Collectors.toList())).
orElse(Collections.emptyList()); orElse(Collections.emptyList());
} }
@ -1591,12 +1560,12 @@ public class ChallengesManager
{ {
// Free Challenges hides under FREE level. // Free Challenges hides under FREE level.
return this.islandWorldManager.getAddon(world).map(gameMode -> return this.islandWorldManager.getAddon(world).map(gameMode ->
this.challengeCacheData.values().stream(). this.challengeCacheData.values().stream().
filter(challenge -> challenge.getLevel().equals(FREE) && filter(challenge -> challenge.getLevel().equals(FREE) &&
challenge.matchGameMode(gameMode.getDescription().getName())). challenge.matchGameMode(gameMode.getDescription().getName())).
sorted(Comparator.comparing(Challenge::getOrder)). sorted(Comparator.comparing(Challenge::getOrder)).
collect(Collectors.toList())). collect(Collectors.toList())).
orElse(Collections.emptyList()); orElse(Collections.emptyList());
} }
@ -1608,10 +1577,10 @@ public class ChallengesManager
public List<Challenge> getLevelChallenges(ChallengeLevel level) public List<Challenge> getLevelChallenges(ChallengeLevel level)
{ {
return level.getChallenges().stream(). return level.getChallenges().stream().
map(this::getChallenge). map(this::getChallenge).
filter(Objects::nonNull). filter(Objects::nonNull).
sorted(Comparator.comparing(Challenge::getOrder)). sorted(Comparator.comparing(Challenge::getOrder)).
collect(Collectors.toList()); collect(Collectors.toList());
} }
@ -1621,6 +1590,7 @@ public class ChallengesManager
* @param name - unique name of challenge * @param name - unique name of challenge
* @return - challenge or null if it does not exist * @return - challenge or null if it does not exist
*/ */
@Nullable
public Challenge getChallenge(String name) public Challenge getChallenge(String name)
{ {
if (this.challengeCacheData.containsKey(name)) if (this.challengeCacheData.containsKey(name))
@ -1658,30 +1628,7 @@ public class ChallengesManager
*/ */
public boolean containsChallenge(String name) public boolean containsChallenge(String name)
{ {
if (this.challengeCacheData.containsKey(name)) return getChallenge(name) != null;
{
return true;
}
else
{
// check database.
if (this.challengeDatabase.objectExists(name))
{
Challenge challenge = this.challengeDatabase.loadObject(name);
if (challenge != null)
{
this.challengeCacheData.put(name, challenge);
return true;
}
else
{
this.addon.logError("Tried to load NULL challenge object!");
}
}
}
return false;
} }
@ -1691,6 +1638,7 @@ public class ChallengesManager
* @param requirements - requirements object, as it is not changeable anymore. * @param requirements - requirements object, as it is not changeable anymore.
* @return Challenge that is currently created. * @return Challenge that is currently created.
*/ */
@Nullable
public Challenge createChallenge(String uniqueID, Challenge.ChallengeType type, Requirements requirements) public Challenge createChallenge(String uniqueID, Challenge.ChallengeType type, Requirements requirements)
{ {
if (!this.containsChallenge(uniqueID)) if (!this.containsChallenge(uniqueID))
@ -1725,7 +1673,7 @@ public class ChallengesManager
this.challengeDatabase.deleteObject(challenge); this.challengeDatabase.deleteObject(challenge);
this.addon.getPlugin().getPlaceholdersManager(). this.addon.getPlugin().getPlaceholdersManager().
unregisterPlaceholder("challenges_challenge_repetition_count_" + challenge.getUniqueId()); unregisterPlaceholder("challenges_challenge_repetition_count_" + challenge.getUniqueId());
} }
} }
@ -1743,8 +1691,8 @@ public class ChallengesManager
public List<ChallengeLevel> getLevels(@NonNull World world) public List<ChallengeLevel> getLevels(@NonNull World world)
{ {
return this.islandWorldManager.getAddon(world).map(gameMode -> return this.islandWorldManager.getAddon(world).map(gameMode ->
this.getLevels(gameMode.getDescription().getName())). this.getLevels(gameMode.getDescription().getName())).
orElse(Collections.emptyList()); orElse(Collections.emptyList());
} }
@ -1757,9 +1705,9 @@ public class ChallengesManager
{ {
// TODO: Probably need to check also database. // TODO: Probably need to check also database.
return this.levelCacheData.values().stream(). return this.levelCacheData.values().stream().
sorted(ChallengeLevel::compareTo). sorted(ChallengeLevel::compareTo).
filter(level -> level.matchGameMode(gameMode)). filter(level -> level.matchGameMode(gameMode)).
collect(Collectors.toList()); collect(Collectors.toList());
} }
@ -1769,6 +1717,7 @@ public class ChallengesManager
* @param challenge - challenge which level must be returned. * @param challenge - challenge which level must be returned.
* @return - challenge level or null if it does not exist * @return - challenge level or null if it does not exist
*/ */
@Nullable
public ChallengeLevel getLevel(Challenge challenge) public ChallengeLevel getLevel(Challenge challenge)
{ {
if (!challenge.getLevel().equals(FREE)) if (!challenge.getLevel().equals(FREE))
@ -1786,6 +1735,7 @@ public class ChallengesManager
* @param name - unique name of challenge level * @param name - unique name of challenge level
* @return - challenge level or null if it does not exist * @return - challenge level or null if it does not exist
*/ */
@Nullable
public ChallengeLevel getLevel(String name) public ChallengeLevel getLevel(String name)
{ {
if (this.levelCacheData.containsKey(name)) if (this.levelCacheData.containsKey(name))
@ -1853,7 +1803,7 @@ public class ChallengesManager
/** /**
* This method adds given challenge to given challenge level. * This method adds given challenge to given challenge level.
* @param newChallenge Challenge who must change owner. * @param newChallenge Challenge who must change owner.
* @param newLevel Level who must add new challenge * @param newLevel Level to add to - must exist already
*/ */
public void addChallengeToLevel(Challenge newChallenge, ChallengeLevel newLevel) public void addChallengeToLevel(Challenge newChallenge, ChallengeLevel newLevel)
{ {
@ -1869,7 +1819,7 @@ public class ChallengesManager
{ {
ChallengeLevel oldLevel = this.getLevel(newChallenge.getLevel()); ChallengeLevel oldLevel = this.getLevel(newChallenge.getLevel());
if (!oldLevel.equals(newLevel)) if (oldLevel == null || !oldLevel.equals(newLevel))
{ {
this.removeChallengeFromLevel(newChallenge, newLevel); this.removeChallengeFromLevel(newChallenge, newLevel);
newLevel.getChallenges().add(newChallenge.getUniqueId()); newLevel.getChallenges().add(newChallenge.getUniqueId());
@ -1904,6 +1854,7 @@ public class ChallengesManager
* @param uniqueID - new ID for challenge level. * @param uniqueID - new ID for challenge level.
* @return ChallengeLevel that is currently created. * @return ChallengeLevel that is currently created.
*/ */
@Nullable
public ChallengeLevel createLevel(String uniqueID, World world) public ChallengeLevel createLevel(String uniqueID, World world)
{ {
if (!this.containsLevel(uniqueID)) if (!this.containsLevel(uniqueID))
@ -1951,7 +1902,7 @@ public class ChallengesManager
this.levelDatabase.deleteObject(challengeLevel); this.levelDatabase.deleteObject(challengeLevel);
this.addon.getPlugin().getPlaceholdersManager(). this.addon.getPlugin().getPlaceholdersManager().
unregisterPlaceholder("challenges_completed_challenge_count_per_level_" + challengeLevel.getUniqueId()); unregisterPlaceholder("challenges_completed_challenge_count_per_level_" + challengeLevel.getUniqueId());
} }
} }
@ -1964,7 +1915,7 @@ public class ChallengesManager
public boolean hasAnyChallengeData(@NonNull World world) public boolean hasAnyChallengeData(@NonNull World world)
{ {
return this.islandWorldManager.getAddon(world).filter(gameMode -> return this.islandWorldManager.getAddon(world).filter(gameMode ->
this.hasAnyChallengeData(gameMode.getDescription().getName())).isPresent(); this.hasAnyChallengeData(gameMode.getDescription().getName())).isPresent();
} }
@ -1976,8 +1927,8 @@ public class ChallengesManager
public boolean hasAnyChallengeData(@NonNull String gameMode) public boolean hasAnyChallengeData(@NonNull String gameMode)
{ {
return this.challengeDatabase.loadObjects().stream().anyMatch( return this.challengeDatabase.loadObjects().stream().anyMatch(
challenge -> challenge.matchGameMode(gameMode)) || challenge -> challenge.matchGameMode(gameMode)) ||
this.levelDatabase.loadObjects().stream().anyMatch( this.levelDatabase.loadObjects().stream().anyMatch(
level -> level.matchGameMode(gameMode)); level -> level.matchGameMode(gameMode));
} }
} }

15
src/main/java/world/bentobox/challenges/commands/ChallengesCommand.java
View File

@ -1,7 +1,6 @@
package world.bentobox.challenges.commands; package world.bentobox.challenges.commands;
import java.util.List; import java.util.List;
import java.util.Optional;
import world.bentobox.bentobox.api.addons.GameModeAddon; import world.bentobox.bentobox.api.addons.GameModeAddon;
import world.bentobox.bentobox.api.commands.CompositeCommand; import world.bentobox.bentobox.api.commands.CompositeCommand;
@ -27,10 +26,7 @@ public class ChallengesCommand extends CompositeCommand
@Override @Override
public boolean canExecute(User user, String label, List<String> args) public boolean canExecute(User user, String label, List<String> args)
{ {
Optional<GameModeAddon> optionalAddon = this.getAddon().getPlugin().getIWM().getAddon(this.getWorld()); if (!getIWM().inWorld(getWorld())) {
if (!optionalAddon.isPresent())
{
// Not a GameMode world. // Not a GameMode world.
user.sendMessage("general.errors.wrong-world"); user.sendMessage("general.errors.wrong-world");
return false; return false;
@ -39,13 +35,14 @@ public class ChallengesCommand extends CompositeCommand
if (!((ChallengesAddon) this.getAddon()).getChallengesManager().hasAnyChallengeData(this.getWorld())) if (!((ChallengesAddon) this.getAddon()).getChallengesManager().hasAnyChallengeData(this.getWorld()))
{ {
// Do not open gui if there is no challenges. // Do not open gui if there is no challenges.
this.getAddon().logError("There are no challenges set up in " + this.getWorld() + "!");
this.getAddon().getLogger().severe("There are no challenges set up in " + this.getWorld() + "!");
// Show admin better explanation. // Show admin better explanation.
if (user.isOp() || user.hasPermission(this.getPermissionPrefix() + "admin.challenges")) if (user.isOp() || user.hasPermission(this.getPermissionPrefix() + "admin.challenges"))
{ {
String topLabel = optionalAddon.get().getAdminCommand().orElseGet(this::getParent).getTopLabel(); String topLabel = getIWM().getAddon(this.getWorld())
.map(GameModeAddon::getAdminCommand)
.map(optionalAdminCommand -> optionalAdminCommand.map(ac -> ac.getTopLabel()).orElse(this.getTopLabel())).orElse(this.getTopLabel());
user.sendMessage("challenges.errors.no-challenges-admin", "[command]", topLabel + " challenges"); user.sendMessage("challenges.errors.no-challenges-admin", "[command]", topLabel + " challenges");
} }
else else
@ -56,7 +53,7 @@ public class ChallengesCommand extends CompositeCommand
return false; return false;
} }
if (this.getPlugin().getIslands().getIsland(this.getWorld(), user.getUniqueId()) == null) if (this.getIslands().getIsland(this.getWorld(), user) == null)
{ {
// Do not open gui if there is no island for this player. // Do not open gui if there is no island for this player.
user.sendMessage("general.errors.no-island"); user.sendMessage("general.errors.no-island");

212
src/main/java/world/bentobox/challenges/commands/CompleteChallengeCommand.java
View File

@ -21,128 +21,128 @@ import world.bentobox.challenges.utils.Utils;
*/ */
public class CompleteChallengeCommand extends CompositeCommand public class CompleteChallengeCommand extends CompositeCommand
{ {
/** /**
* Default constructor for Composite Command. * Default constructor for Composite Command.
* @param addon Challenges addon. * @param addon Challenges addon.
* @param cmd Parent Command. * @param cmd Parent Command.
*/ */
public CompleteChallengeCommand(Addon addon, CompositeCommand cmd) public CompleteChallengeCommand(Addon addon, CompositeCommand cmd)
{ {
super(addon, cmd, "complete"); super(addon, cmd, "complete");
this.addon = (ChallengesAddon) addon; this.addon = (ChallengesAddon) addon;
} }
/** /**
* {@inheritDoc} * {@inheritDoc}
*/ */
@Override @Override
public void setup() public void setup()
{ {
this.setOnlyPlayer(true); this.setOnlyPlayer(true);
this.setPermission("complete"); this.setPermission("complete");
this.setParametersHelp("challenges.commands.user.complete.parameters"); this.setParametersHelp("challenges.commands.user.complete.parameters");
this.setDescription("challenges.commands.user.complete.description"); this.setDescription("challenges.commands.user.complete.description");
} }
/** /**
* {@inheritDoc} * {@inheritDoc}
*/ */
@Override @Override
public boolean execute(User user, String label, List<String> args) public boolean execute(User user, String label, List<String> args)
{ {
if (args.isEmpty()) if (args.isEmpty())
{ {
user.sendMessage("challenges.errors.no-name"); user.sendMessage("challenges.errors.no-name");
this.showHelp(this, user); this.showHelp(this, user);
return false; return false;
} }
else if (!args.get(0).isEmpty()) else
{ {
// Add world name back at the start // Add world name back at the start
String challengeName = Utils.getGameMode(this.getWorld()) + "_" + args.get(0); String challengeName = Utils.getGameMode(this.getWorld()) + "_" + args.get(0);
Challenge challenge = this.addon.getChallengesManager().getChallenge(challengeName); Challenge challenge = this.addon.getChallengesManager().getChallenge(challengeName);
if (challenge != null) if (challenge != null)
{ {
int count = args.size() == 2 ? Integer.valueOf(args.get(1)) : 1; int count = args.size() == 2 ? Integer.valueOf(args.get(1)) : 1;
boolean canMultipleTimes = boolean canMultipleTimes =
user.hasPermission(this.getPermission() + ".multiple"); user.hasPermission(this.getPermission() + ".multiple");
if (!canMultipleTimes && count > 1) if (!canMultipleTimes && count > 1)
{ {
user.sendMessage("challenges.error.no-multiple-permission"); user.sendMessage("challenges.error.no-multiple-permission");
count = 1; count = 1;
} }
return TryToComplete.complete(this.addon, return TryToComplete.complete(this.addon,
user, user,
challenge, challenge,
this.getWorld(), this.getWorld(),
this.getTopLabel(), this.getTopLabel(),
this.getPermissionPrefix(), this.getPermissionPrefix(),
count); count);
} }
else else
{ {
user.sendMessage("challenges.errors.unknown-challenge"); user.sendMessage("challenges.errors.unknown-challenge");
this.showHelp(this, user); this.showHelp(this, user);
return false; return false;
} }
} }
}
this.showHelp(this, user);
return false;
}
/** /**
* {@inheritDoc} * {@inheritDoc}
*/ */
@Override @Override
public Optional<List<String>> tabComplete(User user, String alias, List<String> args) public Optional<List<String>> tabComplete(User user, String alias, List<String> args)
{ {
String lastString = args.get(args.size() - 1); if (args.isEmpty()) return Optional.empty();
final List<String> returnList = new ArrayList<>(); String lastString = args.get(args.size() - 1);
final int size = args.size();
switch (size) final List<String> returnList = new ArrayList<>();
{ final int size = args.size();
case 3:
// Create suggestions with all challenges that is available for users.
returnList.addAll(this.addon.getChallengesManager().getAllChallengesNames(this.getWorld()).stream().
map(challenge -> challenge.substring(Utils.getGameMode(this.getWorld()).length() + 1)).
collect(Collectors.toList()));
break; switch (size)
case 4: {
// Suggest a number of completions. case 3:
if (lastString.isEmpty() || lastString.matches("[0-9]*"))
{
returnList.add("<number>");
}
break; // Create suggestions with all challenges that is available for users.
default: returnList.addAll(this.addon.getChallengesManager().getAllChallengesNames(this.getWorld()).stream().
{ filter(challenge -> challenge.startsWith(Utils.getGameMode(this.getWorld()) + "_")).
returnList.add("help"); map(challenge -> challenge.substring(Utils.getGameMode(this.getWorld()).length() + 1)).
break; collect(Collectors.toList()));
} break;
} case 4:
// Suggest a number of completions.
if (lastString.isEmpty() || lastString.matches("[0-9]*"))
{
returnList.add("<number>");
}
return Optional.of(Util.tabLimit(returnList, lastString)); break;
} default:
{
returnList.add("help");
break;
}
}
return Optional.of(Util.tabLimit(returnList, lastString));
}
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
// Section: Variables // Section: Variables
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
/** /**
* Variable that holds challenge addon. Single casting. * Variable that holds challenge addon. Single casting.
*/ */
private ChallengesAddon addon; private ChallengesAddon addon;
} }

9
src/main/java/world/bentobox/challenges/database/object/Challenge.java
View File

@ -13,6 +13,7 @@ import org.bukkit.Material;
import org.bukkit.World; import org.bukkit.World;
import org.bukkit.entity.EntityType; import org.bukkit.entity.EntityType;
import org.bukkit.inventory.ItemStack; import org.bukkit.inventory.ItemStack;
import org.eclipse.jdt.annotation.NonNull;
import com.google.gson.annotations.Expose; import com.google.gson.annotations.Expose;
import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.JsonAdapter;
@ -717,7 +718,7 @@ public class Challenge implements DataObject
* This method sets the level value. * This method sets the level value.
* @param level the level new value. * @param level the level new value.
*/ */
public void setLevel(String level) public void setLevel(@NonNull String level)
{ {
this.level = level; this.level = level;
} }
@ -1050,7 +1051,7 @@ public class Challenge implements DataObject
public boolean matchGameMode(String gameMode) public boolean matchGameMode(String gameMode)
{ {
return gameMode != null && return gameMode != null &&
this.uniqueId.regionMatches(true, 0, gameMode, 0, gameMode.length()); this.uniqueId.regionMatches(true, 0, gameMode, 0, gameMode.length());
} }
@ -1129,7 +1130,7 @@ public class Challenge implements DataObject
clone.setRequirements(this.requirements.clone()); clone.setRequirements(this.requirements.clone());
clone.setRewardText(this.rewardText); clone.setRewardText(this.rewardText);
clone.setRewardItems(this.rewardItems.stream().map(ItemStack::clone). clone.setRewardItems(this.rewardItems.stream().map(ItemStack::clone).
collect(Collectors.toCollection(() -> new ArrayList<>(this.rewardItems.size())))); collect(Collectors.toCollection(() -> new ArrayList<>(this.rewardItems.size()))));
clone.setRewardExperience(this.rewardExperience); clone.setRewardExperience(this.rewardExperience);
clone.setRewardMoney(this.rewardMoney); clone.setRewardMoney(this.rewardMoney);
clone.setRewardCommands(new ArrayList<>(this.rewardCommands)); clone.setRewardCommands(new ArrayList<>(this.rewardCommands));
@ -1138,7 +1139,7 @@ public class Challenge implements DataObject
clone.setMaxTimes(this.maxTimes); clone.setMaxTimes(this.maxTimes);
clone.setRepeatExperienceReward(this.repeatExperienceReward); clone.setRepeatExperienceReward(this.repeatExperienceReward);
clone.setRepeatItemReward(this.repeatItemReward.stream().map(ItemStack::clone). clone.setRepeatItemReward(this.repeatItemReward.stream().map(ItemStack::clone).
collect(Collectors.toCollection(() -> new ArrayList<>(this.repeatItemReward.size())))); collect(Collectors.toCollection(() -> new ArrayList<>(this.repeatItemReward.size()))));
clone.setRepeatMoneyReward(this.repeatMoneyReward); clone.setRepeatMoneyReward(this.repeatMoneyReward);
clone.setRepeatRewardCommands(new ArrayList<>(this.repeatRewardCommands)); clone.setRepeatRewardCommands(new ArrayList<>(this.repeatRewardCommands));
} }

538
src/main/java/world/bentobox/challenges/database/object/ChallengesPlayerData.java
View File

@ -25,334 +25,334 @@ import world.bentobox.bentobox.database.objects.adapters.LogEntryListAdapter;
*/ */
public class ChallengesPlayerData implements DataObject public class ChallengesPlayerData implements DataObject
{ {
/** /**
* Constructor ChallengesPlayerData creates a new ChallengesPlayerData instance. * Constructor ChallengesPlayerData creates a new ChallengesPlayerData instance.
*/ */
public ChallengesPlayerData() public ChallengesPlayerData()
{ {
} }
/** /**
* Creates a player data entry * Creates a player data entry
* *
* @param uniqueId - the player's UUID in string format * @param uniqueId - the player's UUID in string format
*/ */
public ChallengesPlayerData(String uniqueId) public ChallengesPlayerData(String uniqueId)
{ {
this.uniqueId = uniqueId; this.uniqueId = uniqueId;
} }
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
// Section: Variables // Section: Variables
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
/** /**
* This variable stores each player UUID as string. * This variable stores each player UUID as string.
*/ */
@Expose @Expose
private String uniqueId = ""; private String uniqueId = "";
/** /**
* Challenge map, where key = unique challenge name and Value = number of times * Challenge map, where key = unique challenge name and Value = number of times
* completed * completed
*/ */
@Expose @Expose
private Map<String, Integer> challengeStatus = new TreeMap<>(String.CASE_INSENSITIVE_ORDER); private Map<String, Integer> challengeStatus = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
/** /**
* Map of challenges completion time where key is challenges unique id and value is * Map of challenges completion time where key is challenges unique id and value is
* timestamp when challenge was completed last time. * timestamp when challenge was completed last time.
*/ */
@Expose @Expose
private Map<String, Long> challengesTimestamp = new TreeMap<>(String.CASE_INSENSITIVE_ORDER); private Map<String, Long> challengesTimestamp = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
/** /**
* Set of Strings that contains all challenge levels that are completed. * Set of Strings that contains all challenge levels that are completed.
*/ */
@Expose @Expose
private Set<String> levelsDone = new TreeSet<>(String.CASE_INSENSITIVE_ORDER); private Set<String> levelsDone = new TreeSet<>(String.CASE_INSENSITIVE_ORDER);
/** /**
* Stores history about challenge completion. * Stores history about challenge completion.
*/ */
@Adapter(LogEntryListAdapter.class) @Adapter(LogEntryListAdapter.class)
@Expose @Expose
private List<LogEntry> history = new LinkedList<>(); private List<LogEntry> history = new LinkedList<>();
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
// Section: Getters // Section: Getters
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
/** /**
* @return uniqueID * @return uniqueID
* @see DataObject#getUniqueId() * @see DataObject#getUniqueId()
*/ */
@Override @Override
public String getUniqueId() public String getUniqueId()
{ {
return uniqueId; return uniqueId;
} }
/** /**
* This method returns the challengeStatus value. * This method returns the challengeStatus value.
* @return the value of challengeStatus. * @return the value of challengeStatus.
*/ */
public Map<String, Integer> getChallengeStatus() public Map<String, Integer> getChallengeStatus()
{ {
return challengeStatus; return challengeStatus;
} }
/** /**
* This method returns the challengesTimestamp value. * This method returns the challengesTimestamp value.
* @return the value of challengesTimestamp. * @return the value of challengesTimestamp.
*/ */
public Map<String, Long> getChallengesTimestamp() public Map<String, Long> getChallengesTimestamp()
{ {
return challengesTimestamp; return challengesTimestamp;
} }
/** /**
* This method returns the levelsDone value. * This method returns the levelsDone value.
* @return the value of levelsDone. * @return the value of levelsDone.
*/ */
public Set<String> getLevelsDone() public Set<String> getLevelsDone()
{ {
return levelsDone; return levelsDone;
} }
/** /**
* This method returns the history object. * This method returns the history object.
* @return the history object. * @return the history object.
*/ */
public List<LogEntry> getHistory() public List<LogEntry> getHistory()
{ {
return history; return history;
} }
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
// Section: Setters // Section: Setters
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
/** /**
* @param uniqueId - unique ID the uniqueId to set * @param uniqueId - unique ID the uniqueId to set
* @see DataObject#setUniqueId(String) * @see DataObject#setUniqueId(String)
*/ */
@Override @Override
public void setUniqueId(String uniqueId) public void setUniqueId(String uniqueId)
{ {
this.uniqueId = uniqueId; this.uniqueId = uniqueId;
} }
/** /**
* This method sets the challengeStatus value. * This method sets the challengeStatus value.
* @param challengeStatus the challengeStatus new value. * @param challengeStatus the challengeStatus new value.
* *
*/ */
public void setChallengeStatus(Map<String, Integer> challengeStatus) public void setChallengeStatus(Map<String, Integer> challengeStatus)
{ {
this.challengeStatus = challengeStatus; this.challengeStatus = challengeStatus;
} }
/** /**
* This method sets the challengesTimestamp value. * This method sets the challengesTimestamp value.
* @param challengesTimestamp the challengesTimestamp new value. * @param challengesTimestamp the challengesTimestamp new value.
* *
*/ */
public void setChallengesTimestamp(Map<String, Long> challengesTimestamp) public void setChallengesTimestamp(Map<String, Long> challengesTimestamp)
{ {
this.challengesTimestamp = challengesTimestamp; this.challengesTimestamp = challengesTimestamp;
} }
/** /**
* This method sets the levelsDone value. * This method sets the levelsDone value.
* @param levelsDone the levelsDone new value. * @param levelsDone the levelsDone new value.
* *
*/ */
public void setLevelsDone(Set<String> levelsDone) public void setLevelsDone(Set<String> levelsDone)
{ {
this.levelsDone = levelsDone; this.levelsDone = levelsDone;
} }
/** /**
* This method sets the history object value. * This method sets the history object value.
* @param history the history object new value. * @param history the history object new value.
*/ */
public void setHistory(List<LogEntry> history) public void setHistory(List<LogEntry> history)
{ {
this.history = history; this.history = history;
} }
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
// Section: Other Methods // Section: Other Methods
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
/** /**
* Resets all challenges and levels in GameMode for this player * Resets all challenges and levels in GameMode for this player
* *
* @param gameMode GameMode which challenges must be reset. * @param gameMode GameMode which challenges must be reset.
*/ */
public void reset(@NonNull String gameMode) public void reset(@NonNull String gameMode)
{ {
challengeStatus.keySet().removeIf(n -> n.regionMatches(true, 0, gameMode, 0, gameMode.length())); challengeStatus.keySet().removeIf(n -> n.regionMatches(true, 0, gameMode, 0, gameMode.length()));
challengesTimestamp.keySet().removeIf(n -> n.regionMatches(true, 0, gameMode, 0, gameMode.length())); challengesTimestamp.keySet().removeIf(n -> n.regionMatches(true, 0, gameMode, 0, gameMode.length()));
levelsDone.removeIf(n -> n.regionMatches(true, 0, gameMode, 0, gameMode.length())); levelsDone.removeIf(n -> n.regionMatches(true, 0, gameMode, 0, gameMode.length()));
} }
/** /**
* Mark a challenge as having been completed. Will increment the number of times and * Mark a challenge as having been completed. Will increment the number of times and
* timestamp * timestamp
* *
* @param challengeName - unique challenge name * @param challengeName - unique challenge name
*/ */
public void setChallengeDone(@NonNull String challengeName) public void setChallengeDone(@NonNull String challengeName)
{ {
this.addChallengeDone(challengeName, 1); this.addChallengeDone(challengeName, 1);
} }
/** /**
* Mark a challenge as having been completed. Will increment the number of times and * Mark a challenge as having been completed. Will increment the number of times and
* timestamp * timestamp
* *
* @param challengeName - unique challenge name * @param challengeName - unique challenge name
* @param times - how many new times should be added * @param times - how many new times should be added
*/ */
public void addChallengeDone(@NonNull String challengeName, int times) public void addChallengeDone(@NonNull String challengeName, int times)
{ {
int newTimes = challengeStatus.getOrDefault(challengeName, 0) + times; int newTimes = challengeStatus.getOrDefault(challengeName, 0) + times;
challengeStatus.put(challengeName, newTimes); challengeStatus.put(challengeName, newTimes);
challengesTimestamp.put(challengeName, System.currentTimeMillis()); challengesTimestamp.put(challengeName, System.currentTimeMillis());
} }
/** /**
* Set the number of times a challenge has been done * Set the number of times a challenge has been done
* *
* @param challengeName - unique challenge name * @param challengeName - unique challenge name
* @param times - the number of times to set * @param times - the number of times to set
*/ */
public void setChallengeTimes(@NonNull String challengeName, @NonNull int times) public void setChallengeTimes(@NonNull String challengeName, @NonNull int times)
{ {
challengeStatus.put(challengeName, times); challengeStatus.put(challengeName, times);
challengesTimestamp.put(challengeName, System.currentTimeMillis()); challengesTimestamp.put(challengeName, System.currentTimeMillis());
} }
/** /**
* Check if a challenge has been done * Check if a challenge has been done
* *
* @param challengeName - unique challenge name * @param challengeName - unique challenge name
* @return true if done at least once * @return true if done at least once
*/ */
public boolean isChallengeDone(@NonNull String challengeName) public boolean isChallengeDone(@NonNull String challengeName)
{ {
return this.getTimes(challengeName) > 0; return this.getTimes(challengeName) > 0;
} }
/** /**
* Check how many times a challenge has been done * Check how many times a challenge has been done
* *
* @param challengeName - unique challenge name * @param challengeName - unique challenge name
* @return - number of times * @return - number of times
*/ */
public int getTimes(@NonNull String challengeName) public int getTimes(@NonNull String challengeName)
{ {
return challengeStatus.getOrDefault(challengeName, 0); return challengeStatus.getOrDefault(challengeName, 0);
} }
/** /**
* This method adds given level id to completed level set. * This method adds given level id to completed level set.
* @param uniqueId from ChallengeLevel object. * @param uniqueId from ChallengeLevel object.
*/ */
public void addCompletedLevel(@NonNull String uniqueId) public void addCompletedLevel(@NonNull String uniqueId)
{ {
this.levelsDone.add(uniqueId); this.levelsDone.add(uniqueId);
} }
/** /**
* This method returns if given level is done. * This method returns if given level is done.
* @param uniqueId of ChallengeLevel object. * @param uniqueId of ChallengeLevel object.
* @return <code>true</code> if level is completed, otherwise <code>false</code> * @return <code>true</code> if level is completed, otherwise <code>false</code>
*/ */
public boolean isLevelDone(@NonNull String uniqueId) public boolean isLevelDone(@NonNull String uniqueId)
{ {
return !this.levelsDone.isEmpty() && this.levelsDone.contains(uniqueId); return !this.levelsDone.isEmpty() && this.levelsDone.contains(uniqueId);
} }
/** /**
* This method adds given LogEntry to history. * This method adds given LogEntry to history.
* *
* @param entry of type LogEntry * @param entry of type LogEntry
*/ */
public void addHistoryRecord(@NonNull LogEntry entry) public void addHistoryRecord(@NonNull LogEntry entry)
{ {
this.history.add(entry); this.history.add(entry);
} }
/** /**
* @see Object#hashCode() * @see Object#hashCode()
* @return object hashCode value. * @return object hashCode value.
*/ */
@Override @Override
public int hashCode() public int hashCode()
{ {
final int prime = 31; final int prime = 31;
int result = 1; int result = 1;
result = prime * result + ((uniqueId == null) ? 0 : uniqueId.hashCode()); result = prime * result + ((uniqueId == null) ? 0 : uniqueId.hashCode());
return result; return result;
} }
/** /**
* @see java.lang.Object#equals(java.lang.Object) * @see java.lang.Object#equals(java.lang.Object)
* @param obj Other object. * @param obj Other object.
* @return boolean that indicate if objects are equals. * @return boolean that indicate if objects are equals.
*/ */
@Override @Override
public boolean equals(Object obj) public boolean equals(Object obj)
{ {
if (this == obj) if (this == obj)
{ {
return true; return true;
} }
if (!(obj instanceof ChallengesPlayerData)) if (!(obj instanceof ChallengesPlayerData))
{ {
return false; return false;
} }
ChallengesPlayerData other = (ChallengesPlayerData) obj; ChallengesPlayerData other = (ChallengesPlayerData) obj;
if (uniqueId == null) if (uniqueId == null)
{ {
return other.uniqueId == null; return other.uniqueId == null;
} }
else else
{ {
return uniqueId.equalsIgnoreCase(other.uniqueId); return uniqueId.equalsIgnoreCase(other.uniqueId);
} }
} }
} }

1205
src/main/java/world/bentobox/challenges/panel/admin/EditLoreGUI.java
View File

File diff suppressed because it is too large Load Diff

2
src/main/java/world/bentobox/challenges/panel/user/ChallengesGUI.java
View File

@ -78,7 +78,7 @@ public class ChallengesGUI extends CommonGUI
// Do not open gui if there is no challenges. // Do not open gui if there is no challenges.
if (!this.challengesManager.hasAnyChallengeData(this.world)) if (!this.challengesManager.hasAnyChallengeData(this.world))
{ {
this.addon.getLogger().severe("There are no challenges set up!"); this.addon.logError("There are no challenges set up!");
this.user.sendMessage("challenges.errors.no-challenges"); this.user.sendMessage("challenges.errors.no-challenges");
return; return;
} }

23
src/main/java/world/bentobox/challenges/tasks/TryToComplete.java
View File

@ -1,6 +1,3 @@
/**
*
*/
package world.bentobox.challenges.tasks; package world.bentobox.challenges.tasks;
@ -16,6 +13,7 @@ import java.util.PriorityQueue;
import java.util.Queue; import java.util.Queue;
import java.util.stream.Collectors; import java.util.stream.Collectors;
import org.bukkit.Bukkit;
import org.bukkit.ChatColor; import org.bukkit.ChatColor;
import org.bukkit.GameMode; import org.bukkit.GameMode;
import org.bukkit.Material; import org.bukkit.Material;
@ -178,7 +176,7 @@ public class TryToComplete
this.permissionPrefix = permissionPrefix; this.permissionPrefix = permissionPrefix;
this.user = user; this.user = user;
this.manager = addon.getChallengesManager(); this.manager = addon.getChallengesManager();
// To avoid any modifications that may accure to challenges in current completion // To avoid any modifications that may occur to challenges in current completion
// just clone it. // just clone it.
this.challenge = challenge.clone(); this.challenge = challenge.clone();
this.topLabel = topLabel; this.topLabel = topLabel;
@ -239,7 +237,7 @@ public class TryToComplete
* This method checks if challenge can be done, and complete it, if it is possible. * This method checks if challenge can be done, and complete it, if it is possible.
* @return ChallengeResult object, that contains completion status. * @return ChallengeResult object, that contains completion status.
*/ */
public ChallengeResult build(int maxTimes) ChallengeResult build(int maxTimes)
{ {
// Check if can complete challenge // Check if can complete challenge
ChallengeResult result = this.checkIfCanCompleteChallenge(maxTimes); ChallengeResult result = this.checkIfCanCompleteChallenge(maxTimes);
@ -304,7 +302,7 @@ public class TryToComplete
if (this.addon.getChallengesSettings().isBroadcastMessages()) if (this.addon.getChallengesSettings().isBroadcastMessages())
{ {
for (Player player : this.addon.getServer().getOnlinePlayers()) for (Player player : Bukkit.getOnlinePlayers())
{ {
// Only other players should see message. // Only other players should see message.
if (!player.getUniqueId().equals(this.user.getUniqueId())) if (!player.getUniqueId().equals(this.user.getUniqueId()))
@ -349,7 +347,7 @@ public class TryToComplete
if (this.addon.isEconomyProvided()) if (this.addon.isEconomyProvided())
{ {
this.addon.getEconomyProvider().deposit(this.user, this.addon.getEconomyProvider().deposit(this.user,
this.challenge.getRepeatMoneyReward() * rewardFactor); (double)this.challenge.getRepeatMoneyReward() * rewardFactor);
} }
// Experience Repeat Reward // Experience Repeat Reward
@ -521,7 +519,6 @@ public class TryToComplete
ChallengeResult result; ChallengeResult result;
ChallengeType type = this.challenge.getChallengeType(); ChallengeType type = this.challenge.getChallengeType();
// Check the world // Check the world
if (!this.challenge.isDeployed()) if (!this.challenge.isDeployed())
{ {
@ -609,7 +606,6 @@ public class TryToComplete
{ {
result.setCompleted(this.manager.isChallengeComplete(this.user, this.world, this.challenge)); result.setCompleted(this.manager.isChallengeComplete(this.user, this.world, this.challenge));
} }
// Everything fails till this point. // Everything fails till this point.
return result; return result;
} }
@ -882,6 +878,11 @@ public class TryToComplete
Island island = this.addon.getIslands().getIsland(this.world, this.user); Island island = this.addon.getIslands().getIsland(this.world, this.user);
if (island == null) {
// Just in case. Should never hit because there is a check if the player is on this island further up
return EMPTY_RESULT;
}
if (boundingBox.getMinX() < island.getMinX()) if (boundingBox.getMinX() < island.getMinX())
{ {
boundingBox.expand(BlockFace.EAST, Math.abs(island.getMinX() - boundingBox.getMinX())); boundingBox.expand(BlockFace.EAST, Math.abs(island.getMinX() - boundingBox.getMinX()));
@ -1316,7 +1317,7 @@ public class TryToComplete
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
// Section: Private classes // Section: Result classes
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
@ -1325,7 +1326,7 @@ public class TryToComplete
* *
* @author tastybento * @author tastybento
*/ */
private class ChallengeResult class ChallengeResult
{ {
/** /**
* This method sets that challenge meets all requirements at least once. * This method sets that challenge meets all requirements at least once.

2
src/main/java/world/bentobox/challenges/utils/Utils.java
View File

@ -26,7 +26,7 @@ public class Utils
{ {
List<ItemStack> returnItems = new ArrayList<>(requiredItems.size()); List<ItemStack> returnItems = new ArrayList<>(requiredItems.size());
// Group all equal items in singe stack, as otherwise it will be too complicated to check if all // Group all equal items in single stack, as otherwise it will be too complicated to check if all
// items are in players inventory. // items are in players inventory.
for (ItemStack item : requiredItems) for (ItemStack item : requiredItems)
{ {

1
src/main/java/world/bentobox/challenges/web/WebManager.java
View File

@ -126,7 +126,6 @@ public class WebManager
* @param user User who inits request. * @param user User who inits request.
* @param world Target world where challenges should be loaded. * @param world Target world where challenges should be loaded.
* @param entry Entry that contains information about requested object. * @param entry Entry that contains information about requested object.
* @return {@code true} if request was successful, {@code false} otherwise.
*/ */
public void requestEntryGitHubData(User user, World world, LibraryEntry entry) public void requestEntryGitHubData(User user, World world, LibraryEntry entry)
{ {

443
src/test/java/world/bentobox/challenges/ChallengesAddonTest.java
View File

@ -1,117 +1,414 @@
/**
*
*/
package world.bentobox.challenges; package world.bentobox.challenges;
import static org.mockito.Matchers.any; 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.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when; import static org.mockito.Mockito.when;
import java.util.ArrayList; import java.io.File;
import java.util.HashMap; 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.List;
import java.util.Map; import java.util.Optional;
import java.util.UUID; import java.util.UUID;
import java.util.jar.JarEntry;
import java.util.jar.JarOutputStream;
import java.util.logging.Logger; import java.util.logging.Logger;
import org.bukkit.Bukkit; import org.bukkit.Bukkit;
import org.bukkit.Material;
import org.bukkit.OfflinePlayer;
import org.bukkit.Server; import org.bukkit.Server;
import org.bukkit.World; import org.bukkit.UnsafeValues;
import org.bukkit.enchantments.Enchantment; import org.bukkit.entity.Player;
import org.bukkit.inventory.ItemFactory; import org.bukkit.inventory.ItemFactory;
import org.bukkit.inventory.ItemStack; import org.bukkit.inventory.meta.ItemMeta;
import org.bukkit.inventory.meta.PotionMeta;
import org.bukkit.plugin.PluginManager; import org.bukkit.plugin.PluginManager;
import org.bukkit.potion.PotionData; import org.bukkit.scheduler.BukkitScheduler;
import org.bukkit.potion.PotionType; import org.eclipse.jdt.annotation.NonNull;
import org.junit.BeforeClass; import org.junit.After;
import org.junit.Before;
import org.junit.Test; import org.junit.Test;
import org.junit.runner.RunWith; import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.Mockito; 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.modules.junit4.PowerMockRunner;
import org.powermock.reflect.Whitebox;
import com.google.gson.Gson; import world.bentobox.bentobox.BentoBox;
import com.google.gson.GsonBuilder; import world.bentobox.bentobox.Settings;
import world.bentobox.bentobox.api.addons.Addon;
import world.bentobox.challenges.database.object.Challenge; import world.bentobox.bentobox.api.addons.Addon.State;
import world.bentobox.challenges.database.object.Challenge.ChallengeType; 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 * @author tastybento
* *
*/ */
@RunWith(PowerMockRunner.class) @RunWith(PowerMockRunner.class)
@PrepareForTest({Bukkit.class, BentoBox.class, User.class, Config.class })
public class ChallengesAddonTest { 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 * @throws java.lang.Exception
*/ */
@BeforeClass @Before
public static void setUpBeforeClass() throws Exception { 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); Server server = mock(Server.class);
World world = mock(World.class); when(Bukkit.getServer()).thenReturn(server);
world = mock(World.class);
Mockito.when(server.getLogger()).thenReturn(Logger.getAnonymousLogger());
Mockito.when(server.getWorld("world")).thenReturn(world);
Mockito.when(server.getVersion()).thenReturn("BSB_Mocking");
PluginManager pluginManager = mock(PluginManager.class);
when(server.getPluginManager()).thenReturn(pluginManager);
ItemFactory itemFactory = mock(ItemFactory.class);
when(server.getItemFactory()).thenReturn(itemFactory);
Bukkit.setServer(server);
PotionMeta potionMeta = mock(PotionMeta.class);
when(itemFactory.getItemMeta(any())).thenReturn(potionMeta);
OfflinePlayer offlinePlayer = mock(OfflinePlayer.class);
when(Bukkit.getOfflinePlayer(any(UUID.class))).thenReturn(offlinePlayer);
when(offlinePlayer.getName()).thenReturn("tastybento");
when(Bukkit.getItemFactory()).thenReturn(itemFactory);
when(Bukkit.getLogger()).thenReturn(Logger.getAnonymousLogger()); 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 @Test
public void 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());
}
Gson gson = new GsonBuilder().setPrettyPrinting().create(); /**
Challenge challenges = new Challenge(); * Test method for {@link world.bentobox.challenges.ChallengesAddon#onEnable()}.
challenges.setChallengeType(ChallengeType.ISLAND); */
Map<Material, Integer> map = new HashMap<>(); @Test
map.put(Material.DIRT, 5); public void testOnEnableDisabledPlugin() {
map.put(Material.ACACIA_FENCE_GATE, 3); when(plugin.isEnabled()).thenReturn(false);
challenges.setRequiredBlocks(map); addon.onEnable();
challenges.setIcon(new ItemStack(Material.ACACIA_FENCE_GATE)); verify(plugin).logError("[challenges] BentoBox is not available or disabled!");
List<ItemStack> requiredItems = new ArrayList<>(); assertEquals(Addon.State.DISABLED, addon.getState());
ItemStack result = new ItemStack(Material.POTION, 55); }
ItemStack result2 = new ItemStack(Material.SPLASH_POTION, 22);
ItemStack result3 = new ItemStack(Material.LINGERING_POTION, 11);
PotionMeta potionMeta = (PotionMeta) result.getItemMeta(); /**
PotionData potionData = new PotionData(PotionType.FIRE_RESISTANCE, true, false); * Test method for {@link world.bentobox.challenges.ChallengesAddon#onEnable()}.
potionMeta.setBasePotionData(potionData); */
result.setItemMeta(potionMeta); @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!");
}
PotionMeta potionMeta2 = (PotionMeta) result2.getItemMeta(); /**
PotionData potionData2 = new PotionData(PotionType.SPEED, true, false); * Test method for {@link world.bentobox.challenges.ChallengesAddon#onEnable()}.
potionMeta2.setBasePotionData(potionData2); */
potionMeta2.addEnchant(Enchantment.BINDING_CURSE, 1, true); @Test
result2.setItemMeta(potionMeta2); 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());
}
requiredItems.add(result); /**
requiredItems.add(result2); * Test method for {@link world.bentobox.challenges.ChallengesAddon#onEnable()}.
requiredItems.add(result3); */
challenges.setRequiredItems(requiredItems); @Test
String json = gson.toJson(challenges); 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!");
Logger.getAnonymousLogger().info(json); }
/**
* 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());
} }
} }

870
src/test/java/world/bentobox/challenges/ChallengesManagerTest.java Normal file
View File

@ -0,0 +1,870 @@
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.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.io.BufferedReader;
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.Optional;
import java.util.UUID;
import org.bukkit.Bukkit;
import org.bukkit.Server;
import org.bukkit.UnsafeValues;
import org.bukkit.World;
import org.bukkit.inventory.ItemFactory;
import org.bukkit.inventory.meta.ItemMeta;
import org.bukkit.plugin.PluginManager;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
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.api.addons.AddonDescription;
import world.bentobox.bentobox.api.addons.GameModeAddon;
import world.bentobox.bentobox.api.user.User;
import world.bentobox.bentobox.database.DatabaseSetup.DatabaseType;
import world.bentobox.bentobox.managers.IslandWorldManager;
import world.bentobox.bentobox.managers.PlaceholdersManager;
import world.bentobox.bentobox.util.Util;
import world.bentobox.challenges.config.Settings;
import world.bentobox.challenges.database.object.Challenge;
import world.bentobox.challenges.database.object.Challenge.ChallengeType;
import world.bentobox.challenges.database.object.ChallengeLevel;
import world.bentobox.challenges.events.ChallengeCompletedEvent;
import world.bentobox.challenges.events.ChallengeResetAllEvent;
import world.bentobox.challenges.events.ChallengeResetEvent;
import world.bentobox.challenges.events.LevelCompletedEvent;
import world.bentobox.challenges.utils.LevelStatus;
/**
* @author tastybento
*
*/
@SuppressWarnings("deprecation")
@RunWith(PowerMockRunner.class)
@PrepareForTest({Bukkit.class, BentoBox.class, Util.class})
public class ChallengesManagerTest {
// Constants
private static final String GAME_MODE_NAME = "BSkyBlock";
// Mocks
@Mock
private ChallengesAddon addon;
@Mock
private Settings settings;
@Mock
private IslandWorldManager iwm;
@Mock
private Server server;
@Mock
private PluginManager pim;
@Mock
private ItemFactory itemFactory;
@Mock
private User user;
@Mock
private World world;
@Mock
private GameModeAddon gameModeAddon;
@Mock
private PlaceholdersManager plhm;
// Variable fields
private ChallengesManager cm;
private File database;
private String uuid;
private Challenge challenge;
private @NonNull ChallengeLevel level;
private UUID playerID = UUID.randomUUID();
private String cName;
private String levelName;
/**
* @throws java.lang.Exception
*/
@Before
public void setUp() throws Exception {
// Set up plugin
BentoBox plugin = mock(BentoBox.class);
Whitebox.setInternalState(BentoBox.class, "instance", plugin);
when(addon.getPlugin()).thenReturn(plugin);
// IWM
when(plugin.getIWM()).thenReturn(iwm);
when(iwm.inWorld(any(World.class))).thenReturn(true);
// Placeholders
when(plugin.getPlaceholdersManager()).thenReturn(plhm);
// Settings for Database
world.bentobox.bentobox.Settings s = mock(world.bentobox.bentobox.Settings.class);
when(plugin.getSettings()).thenReturn(s);
when(s.getDatabaseType()).thenReturn(DatabaseType.JSON);
// Addon Settings
when(addon.getChallengesSettings()).thenReturn(settings);
when(settings.isStoreHistory()).thenReturn(true);
when(settings.getLifeSpan()).thenReturn(10);
// Database
database = new File("database");
tearDown();
// Bukkit
PowerMockito.mockStatic(Bukkit.class);
when(Bukkit.getServer()).thenReturn(server);
when(Bukkit.getPluginManager()).thenReturn(pim);
when(Bukkit.getWorld(anyString())).thenReturn(world);
ItemMeta meta = mock(ItemMeta.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);
// Challenge
challenge = new Challenge();
uuid = UUID.randomUUID().toString();
challenge.setUniqueId(GAME_MODE_NAME + "_" + uuid);
challenge.setFriendlyName("name");
challenge.setLevel(GAME_MODE_NAME + "_novice");
challenge.setDescription(Collections.singletonList("A description"));
// Challenge Level
level = new ChallengeLevel();
levelName = GAME_MODE_NAME + "_novice";
level.setUniqueId(levelName);
level.setFriendlyName("Novice");
// User
when(user.getUniqueId()).thenReturn(playerID);
// Util
PowerMockito.mockStatic(Util.class);
when(Util.getWorld(any())).thenReturn(world);
// Addon
AddonDescription desc = new AddonDescription.Builder("main", GAME_MODE_NAME, "1.0").build();
when(gameModeAddon.getDescription()).thenReturn(desc);
Optional<GameModeAddon> opAddon = Optional.of(gameModeAddon);
when(iwm.getAddon(any())).thenReturn(opAddon);
// Challenge name
cName = GAME_MODE_NAME + "_" + uuid;
// Class under test
cm = new ChallengesManager(addon);
}
/**
* @throws java.lang.Exception
*/
@After
public void tearDown() throws Exception {
// Clean up JSON database
// Clean up file system
if (database.exists()) {
Files.walk(database.toPath())
.sorted(Comparator.reverseOrder())
.map(Path::toFile)
.forEach(File::delete);
}
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#load()}.
* @throws InterruptedException
*/
@Test
public void testLoad() throws InterruptedException {
verify(addon).log("Loading challenges...");
verify(addon, never()).logError(anyString());
this.testSaveLevel();
this.testSaveChallenge();
cm.load();
verify(addon, times(2)).log("Loading challenges...");
verify(addon, never()).logError(anyString());
assertTrue(cm.containsChallenge(cName));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#reload()}.
* @throws InterruptedException
*/
@Test
public void testReload() throws InterruptedException {
cm.reload();
verify(addon).log("Reloading challenges...");
this.testSaveLevel();
this.testSaveChallenge();
cm.reload();
verify(addon, times(2)).log("Reloading challenges...");
verify(addon, never()).logError(anyString());
assertTrue(cm.containsChallenge(cName));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#loadChallenge(world.bentobox.challenges.database.object.Challenge, boolean, world.bentobox.bentobox.api.user.User, boolean)}.
*/
@Test
public void testLoadChallengeNoOverwriteSilent() {
// load once
assertTrue(cm.loadChallenge(challenge, false, user, true));
// load twice - no overwrite
assertFalse(cm.loadChallenge(challenge, false, user, true));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#loadChallenge(world.bentobox.challenges.database.object.Challenge, boolean, world.bentobox.bentobox.api.user.User, boolean)}.
*/
@Test
public void testLoadChallengeNoOverwriteNotSilent() {
// load once
assertTrue(cm.loadChallenge(challenge, false, user, true));
// load twice - no overwrite, not silent
assertFalse(cm.loadChallenge(challenge, false, user, false));
verify(user).sendMessage("challenges.messages.load-skipping", "[value]", "name");
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#loadChallenge(world.bentobox.challenges.database.object.Challenge, boolean, world.bentobox.bentobox.api.user.User, boolean)}.
*/
@Test
public void testLoadChallengeOverwriteSilent() {
// load once
assertTrue(cm.loadChallenge(challenge, false, user, true));
// overwrite
assertTrue(cm.loadChallenge(challenge, true, user, true));
verify(user, never()).sendMessage(anyString(), anyString(), anyString());
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#loadChallenge(world.bentobox.challenges.database.object.Challenge, boolean, world.bentobox.bentobox.api.user.User, boolean)}.
*/
@Test
public void testLoadChallengeOverwriteNotSilent() {
// load once
assertTrue(cm.loadChallenge(challenge, false, user, true));
// overwrite not silent
assertTrue(cm.loadChallenge(challenge, true, user, false));
verify(user).sendMessage("challenges.messages.load-overwriting", "[value]", "name");
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#loadLevel(world.bentobox.challenges.database.object.ChallengeLevel, boolean, world.bentobox.bentobox.api.user.User, boolean)}.
*/
@Test
public void testLoadLevelNoOverwriteSilent() {
// load once
assertTrue(cm.loadLevel(level, false, user, true));
// load twice - no overwrite
assertFalse(cm.loadLevel(level, false, user, true));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#loadLevel(world.bentobox.challenges.database.object.ChallengeLevel, boolean, world.bentobox.bentobox.api.user.User, boolean)}.
*/
@Test
public void testLoadLevelNoOverwriteNotSilent() {
// load once
assertTrue(cm.loadLevel(level, false, user, true));
// load twice - no overwrite, not silent
assertFalse(cm.loadLevel(level, false, user, false));
verify(user).sendMessage("challenges.messages.load-skipping", "[value]", "Novice");
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#loadLevel(world.bentobox.challenges.database.object.ChallengeLevel, boolean, world.bentobox.bentobox.api.user.User, boolean)}.
*/
@Test
public void testLoadLevelOverwriteSilent() {
// load once
assertTrue(cm.loadLevel(level, false, user, true));
// overwrite
assertTrue(cm.loadLevel(level, true, user, true));
verify(user, never()).sendMessage(anyString(), anyString(), anyString());
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#loadLevel(world.bentobox.challenges.database.object.ChallengeLevel, boolean, world.bentobox.bentobox.api.user.User, boolean)}.
*/
@Test
public void testLoadLevelOverwriteNotSilent() {
// load once
assertTrue(cm.loadLevel(level, false, user, true));
// overwrite not silent
assertTrue(cm.loadLevel(level, true, user, false));
verify(user).sendMessage("challenges.messages.load-overwriting", "[value]", "Novice");
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#removeFromCache(java.util.UUID)}.
*/
@Test
public void testRemoveFromCache() {
cm.removeFromCache(playerID);
verify(settings).isStoreAsIslandData();
// TODO there should be a test where isStoreAsIslandData returns true
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#wipeDatabase(boolean)}.
* @throws InterruptedException
*/
@Test
public void testWipeDatabase() throws InterruptedException {
// Create some database
this.testLoad();
// Verify file exists
File chDir = new File(database, "Challenge");
File check = new File(chDir, cName + ".json");
assertTrue(check.exists());
File lvDir = new File(database, "ChallengeLevel");
File checkLv = new File(lvDir, levelName + ".json");
assertTrue(checkLv.exists());
cm.setChallengeComplete(user, world, challenge, 20);
//cm.save();
File plData = new File(database, "ChallengesPlayerData");
File checkPd = new File(plData, playerID.toString() + ".json");
assertTrue(checkPd.exists());
// Wipe it
cm.wipeDatabase(false);
// Verify
assertFalse(check.exists());
assertFalse(checkLv.exists());
assertTrue(checkPd.exists());
cm.wipeDatabase(true);
assertFalse(checkPd.exists());
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#wipePlayers()}.
* @throws InterruptedException
*/
@Test
public void testWipePlayers() throws InterruptedException {
this.testLoad();
cm.setChallengeComplete(user, world, challenge, 20);
cm.save();
File plData = new File(database, "ChallengesPlayerData");
File checkLv = new File(plData, playerID.toString() + ".json");
assertTrue(checkLv.exists());
cm.wipePlayers();
assertFalse(checkLv.exists());
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#migrateDatabase(world.bentobox.bentobox.api.user.User, org.bukkit.World)}.
*/
@Test
public void testMigrateDatabase() {
cm.migrateDatabase(user, world);
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#save()}.
*/
@Test
public void testSave() {
cm.save();
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#saveChallenge(world.bentobox.challenges.database.object.Challenge)}.
* @throws InterruptedException
*/
@Test
public void testSaveChallenge() throws InterruptedException {
// Async - may not happen quickly
cm.saveChallenge(challenge);
Thread.sleep(500);
File chDir = new File(database, "Challenge");
assertTrue(chDir.exists());
File check = new File(chDir, cName + ".json");
assertTrue(check.exists());
// Remove icon becauseit has mockito meta in it
removeLine(check);
}
private boolean removeLine(File inputFile) {
File tempFile = new File("myTempFile.json");
try (BufferedReader reader = new BufferedReader(new FileReader(inputFile))) {
try (BufferedWriter writer = new BufferedWriter(new FileWriter(tempFile))) {
String lineToRemove = "\"icon";
String currentLine;
while((currentLine = reader.readLine()) != null) {
// trim newline when comparing with lineToRemove
String trimmedLine = currentLine.trim();
if(trimmedLine.startsWith(lineToRemove)) continue;
writer.write(currentLine + System.getProperty("line.separator"));
}
}
} catch (FileNotFoundException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
return tempFile.renameTo(inputFile);
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#saveLevel(world.bentobox.challenges.database.object.ChallengeLevel)}.
* @throws InterruptedException
*/
@Test
public void testSaveLevel() throws InterruptedException {
cm.saveLevel(level);
Thread.sleep(500);
File chDir = new File(database, "ChallengeLevel");
assertTrue(chDir.exists());
File check = new File(chDir, GAME_MODE_NAME + "_novice.json");
assertTrue(check.exists());
// Remove icon becauseit has mockito meta in it
removeLine(check);
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#isChallengeComplete(world.bentobox.bentobox.api.user.User, org.bukkit.World, world.bentobox.challenges.database.object.Challenge)}.
*/
@Test
public void testIsChallengeCompleteUserWorldChallenge() {
assertFalse(cm.isChallengeComplete(user, world, challenge));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#isChallengeComplete(java.util.UUID, org.bukkit.World, world.bentobox.challenges.database.object.Challenge)}.
*/
@Test
public void testIsChallengeCompleteUUIDWorldChallenge() {
assertFalse(cm.isChallengeComplete(playerID, world, challenge));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#isChallengeComplete(java.util.UUID, org.bukkit.World, java.lang.String)}.
*/
@Test
public void testIsChallengeCompleteUUIDWorldString() {
assertFalse(cm.isChallengeComplete(playerID, world, "Novice"));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#setChallengeComplete(world.bentobox.bentobox.api.user.User, org.bukkit.World, world.bentobox.challenges.database.object.Challenge, int)}.
*/
@Test
public void testSetChallengeCompleteUserWorldChallengeInt() {
cm.setChallengeComplete(user, world, challenge, 3);
assertTrue(cm.isChallengeComplete(user, world, challenge));
verify(pim).callEvent(any(ChallengeCompletedEvent.class));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#setChallengeComplete(java.util.UUID, org.bukkit.World, world.bentobox.challenges.database.object.Challenge, int)}.
*/
@Test
public void testSetChallengeCompleteUUIDWorldChallengeInt() {
cm.setChallengeComplete(playerID, world, challenge, 3);
assertTrue(cm.isChallengeComplete(playerID, world, challenge));
verify(pim).callEvent(any(ChallengeCompletedEvent.class));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#setChallengeComplete(java.util.UUID, org.bukkit.World, world.bentobox.challenges.database.object.Challenge, java.util.UUID)}.
*/
@Test
public void testSetChallengeCompleteUUIDWorldChallengeUUID() {
UUID adminID = UUID.randomUUID();
cm.setChallengeComplete(playerID, world, challenge, adminID);
assertTrue(cm.isChallengeComplete(playerID, world, challenge));
verify(pim).callEvent(any(ChallengeCompletedEvent.class));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#resetChallenge(java.util.UUID, org.bukkit.World, world.bentobox.challenges.database.object.Challenge, java.util.UUID)}.
*/
@Test
public void testResetChallenge() {
cm.setChallengeComplete(user, world, challenge, 3);
assertTrue(cm.isChallengeComplete(user, world, challenge));
cm.resetChallenge(playerID, world, challenge, playerID);
assertFalse(cm.isChallengeComplete(user, world, challenge));
verify(pim).callEvent(any(ChallengeResetEvent.class));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#resetAllChallenges(world.bentobox.bentobox.api.user.User, org.bukkit.World)}.
*/
@Test
public void testResetAllChallengesUserWorld() {
cm.setChallengeComplete(user, world, challenge, 3);
assertTrue(cm.isChallengeComplete(user, world, challenge));
cm.resetAllChallenges(user, world);
assertFalse(cm.isChallengeComplete(user, world, challenge));
verify(pim).callEvent(any(ChallengeResetAllEvent.class));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#resetAllChallenges(java.util.UUID, org.bukkit.World, java.util.UUID)}.
*/
@Test
public void testResetAllChallengesUUIDWorldUUID() {
cm.setChallengeComplete(user, world, challenge, 3);
assertTrue(cm.isChallengeComplete(user, world, challenge));
cm.resetAllChallenges(playerID, world, playerID);
assertFalse(cm.isChallengeComplete(user, world, challenge));
verify(pim).callEvent(any(ChallengeResetAllEvent.class));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#getChallengeTimes(world.bentobox.bentobox.api.user.User, org.bukkit.World, world.bentobox.challenges.database.object.Challenge)}.
*/
@Test
public void testGetChallengeTimesUserWorldChallenge() {
assertEquals(0L, cm.getChallengeTimes(user, world, challenge));
cm.setChallengeComplete(user, world, challenge, 6);
assertEquals(6L, cm.getChallengeTimes(user, world, challenge));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#getChallengeTimes(world.bentobox.bentobox.api.user.User, org.bukkit.World, java.lang.String)}.
*/
@Test
public void testGetChallengeTimesUserWorldString() {
assertEquals(0L, cm.getChallengeTimes(user, world, cName));
cm.setChallengeComplete(user, world, challenge, 6);
assertEquals(6L, cm.getChallengeTimes(user, world, cName));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#isLevelCompleted(world.bentobox.bentobox.api.user.User, org.bukkit.World, world.bentobox.challenges.database.object.ChallengeLevel)}.
*/
@Test
public void testIsLevelCompleted() {
assertFalse(cm.isLevelCompleted(user, world, level));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#isLevelUnlocked(world.bentobox.bentobox.api.user.User, org.bukkit.World, world.bentobox.challenges.database.object.ChallengeLevel)}.
*/
@Test
public void testIsLevelUnlocked() {
assertFalse(cm.isLevelUnlocked(user, world, level));
this.testLoadLevelNoOverwriteSilent();
assertTrue(cm.isLevelUnlocked(user, world, level));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#setLevelComplete(world.bentobox.bentobox.api.user.User, org.bukkit.World, world.bentobox.challenges.database.object.ChallengeLevel)}.
*/
@Test
public void testSetLevelComplete() {
assertFalse(cm.isLevelCompleted(user, world, level));
cm.setLevelComplete(user, world, level);
assertTrue(cm.isLevelCompleted(user, world, level));
verify(pim).callEvent(any(LevelCompletedEvent.class));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#validateLevelCompletion(world.bentobox.bentobox.api.user.User, org.bukkit.World, world.bentobox.challenges.database.object.ChallengeLevel)}.
*/
@Test
public void testValidateLevelCompletion() {
assertTrue(cm.validateLevelCompletion(user, world, level));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#getChallengeLevelStatus(java.util.UUID, org.bukkit.World, world.bentobox.challenges.database.object.ChallengeLevel)}.
*/
@Test
public void testGetChallengeLevelStatus() {
this.testLoadLevelNoOverwriteSilent();
LevelStatus cls = cm.getChallengeLevelStatus(playerID, world, level);
assertTrue(cls.getNumberOfChallengesStillToDo() == 0);
assertEquals(level, cls.getLevel());
assertTrue(cls.isComplete());
assertTrue(cls.isUnlocked());
assertEquals("BSkyBlock_novice", cls.getLevel().getUniqueId());
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#getAllChallengeLevelStatus(world.bentobox.bentobox.api.user.User, org.bukkit.World)}.
*/
@Test
public void testGetAllChallengeLevelStatus() {
this.testLoadLevelNoOverwriteSilent();
List<LevelStatus> list = cm.getAllChallengeLevelStatus(user, world);
assertTrue(list.size() == 1);
LevelStatus cls = list.get(0);
assertTrue(cls.getNumberOfChallengesStillToDo() == 0);
assertEquals(level, cls.getLevel());
assertTrue(cls.isComplete());
assertTrue(cls.isUnlocked());
assertEquals("BSkyBlock_novice", cls.getLevel().getUniqueId());
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#getAllChallengesNames(org.bukkit.World)}.
*/
@Test
public void testGetAllChallengesNames() {
assertTrue(cm.getAllChallengesNames(world).isEmpty());
cm.saveChallenge(challenge);
cm.loadChallenge(challenge, false, user, true);
List<String> list = cm.getAllChallengesNames(world);
assertFalse(list.isEmpty());
assertEquals(cName, list.get(0));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#getAllChallenges(org.bukkit.World)}.
*/
@Test
public void testGetAllChallenges() {
assertTrue(cm.getAllChallenges(world).isEmpty());
cm.saveChallenge(challenge);
cm.loadChallenge(challenge, false, user, true);
List<Challenge> list = cm.getAllChallenges(world);
assertFalse(list.isEmpty());
assertEquals(challenge, list.get(0));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#getFreeChallenges(org.bukkit.World)}.
*/
@Test
public void testGetFreeChallenges() {
// Empty
assertTrue(cm.getFreeChallenges(world).isEmpty());
// One normal
cm.saveChallenge(challenge);
cm.loadChallenge(challenge, false, user, true);
assertTrue(cm.getFreeChallenges(world).isEmpty());
// One free
challenge.setLevel("");
cm.saveChallenge(challenge);
cm.loadChallenge(challenge, false, user, true);
List<Challenge> list = cm.getFreeChallenges(world);
assertFalse(list.isEmpty());
assertEquals(challenge, list.get(0));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#getLevelChallenges(world.bentobox.challenges.database.object.ChallengeLevel)}.
* @throws InterruptedException
*/
@Test
public void testGetLevelChallenges() throws InterruptedException {
assertTrue(cm.getLevelChallenges(level).isEmpty());
// make some challenges
this.testSaveLevel();
this.testSaveChallenge();
level.setChallenges(Collections.singleton(challenge.getUniqueId()));
// Test again
List<Challenge> list = cm.getLevelChallenges(level);
assertFalse(list.isEmpty());
assertEquals(challenge, list.get(0));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#getChallenge(java.lang.String)}.
* @throws InterruptedException
*/
@Test
public void testGetChallenge() throws InterruptedException {
assertNull(cm.getChallenge(cName));
this.testSaveLevel();
this.testSaveChallenge();
Challenge ch = cm.getChallenge(cName);
assertNotNull(ch);
assertEquals(cName, ch.getUniqueId());
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#containsChallenge(java.lang.String)}.
*/
@Test
public void testContainsChallenge() {
assertFalse(cm.containsChallenge("no-such-challenge"));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#createChallenge(java.lang.String, world.bentobox.challenges.database.object.Challenge.ChallengeType, world.bentobox.challenges.database.object.requirements.Requirements)}.
*/
@Test
public void testCreateChallenge() {
@Nullable
Challenge ch = cm.createChallenge("newChal", ChallengeType.ISLAND, null);
assertEquals(ChallengeType.ISLAND, ch.getChallengeType());
assertEquals("newChal", ch.getUniqueId());
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#deleteChallenge(world.bentobox.challenges.database.object.Challenge)}.
* @throws InterruptedException
*/
@Test
public void testDeleteChallenge() throws InterruptedException {
this.testSaveLevel();
this.testSaveChallenge();
Challenge ch = cm.getChallenge(cName);
assertNotNull(ch);
assertEquals(cName, ch.getUniqueId());
cm.deleteChallenge(challenge);
ch = cm.getChallenge(cName);
assertNull(ch);
verify(plhm).unregisterPlaceholder(eq("challenges_challenge_repetition_count_" + cName));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#getLevels(org.bukkit.World)}.
*/
@Test
public void testGetLevels() {
this.testGetLevelString();
List<ChallengeLevel> lvs = cm.getLevels(world);
assertFalse(lvs.isEmpty());
assertEquals(level, lvs.get(0));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#getLevel(world.bentobox.challenges.database.object.Challenge)}.
*/
@Test
public void testGetLevelChallenge() {
this.testGetLevelString();
assertEquals(level, cm.getLevel(challenge));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#getLevel(java.lang.String)}.
*/
@Test
public void testGetLevelString() {
assertNull(cm.getLevel("dss"));
cm.saveLevel(level);
cm.loadLevel(level, false, user, true);
assertEquals(level, cm.getLevel(levelName));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#containsLevel(java.lang.String)}.
*/
@Test
public void testContainsLevel() {
this.testGetLevelString();
assertFalse(cm.containsLevel("sdsd"));
assertTrue(cm.containsLevel(levelName));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#addChallengeToLevel(world.bentobox.challenges.database.object.Challenge, world.bentobox.challenges.database.object.ChallengeLevel)}.
* @throws InterruptedException
*/
@Test
public void testAddChallengeToLevel() throws InterruptedException {
this.testLoad();
cm.deleteChallenge(challenge);
assertFalse(cm.containsChallenge(cName));
cm.addChallengeToLevel(challenge, level);
assertEquals(level, cm.getLevel(challenge));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#removeChallengeFromLevel(world.bentobox.challenges.database.object.Challenge, world.bentobox.challenges.database.object.ChallengeLevel)}.
* @throws InterruptedException
*/
@Test
public void testRemoveChallengeFromLevel() throws InterruptedException {
this.testAddChallengeToLevel();
cm.removeChallengeFromLevel(challenge, level);
assertFalse(cm.containsChallenge(cName));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#createLevel(java.lang.String, org.bukkit.World)}.
*/
@Test
public void testCreateLevel() {
@Nullable
ChallengeLevel cl = cm.createLevel("Expert", world);
assertEquals("Expert", cl.getUniqueId());
assertEquals(world.getName(), cl.getWorld());
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#deleteChallengeLevel(world.bentobox.challenges.database.object.ChallengeLevel)}.
* @throws InterruptedException
*/
@Test
public void testDeleteChallengeLevel() throws InterruptedException {
this.testAddChallengeToLevel();
assertTrue(cm.containsLevel(levelName));
cm.deleteChallengeLevel(level);
assertFalse(cm.containsLevel(levelName));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#hasAnyChallengeData(org.bukkit.World)}.
* @throws InterruptedException
*/
@Test
public void testHasAnyChallengeDataWorld() throws InterruptedException {
assertFalse(cm.hasAnyChallengeData(world));
this.testLoad();
assertTrue(cm.hasAnyChallengeData(world));
}
/**
* Test method for {@link world.bentobox.challenges.ChallengesManager#hasAnyChallengeData(java.lang.String)}.
* @throws InterruptedException
*/
@Test
public void testHasAnyChallengeDataString() throws InterruptedException {
assertFalse(cm.hasAnyChallengeData("BSkyBlock"));
this.testLoad();
assertTrue(cm.hasAnyChallengeData("BSkyBlock"));
}
}

268
src/test/java/world/bentobox/challenges/commands/ChallengesCommandTest.java Normal file
View File

@ -0,0 +1,268 @@
package world.bentobox.challenges.commands;
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.anyInt;
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.verify;
import static org.mockito.Mockito.when;
import java.util.Collections;
import java.util.Optional;
import java.util.UUID;
import org.bukkit.Bukkit;
import org.bukkit.ChatColor;
import org.bukkit.World;
import org.bukkit.entity.Player;
import org.bukkit.inventory.ItemFactory;
import org.bukkit.inventory.meta.ItemMeta;
import org.eclipse.jdt.annotation.NonNull;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
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.api.addons.GameModeAddon;
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.challenges.ChallengesAddon;
import world.bentobox.challenges.ChallengesManager;
import world.bentobox.challenges.config.Settings;
import world.bentobox.challenges.config.SettingsUtils.VisibilityMode;
/**
* @author tastybento
*
*/
@RunWith(PowerMockRunner.class)
@PrepareForTest({Bukkit.class, BentoBox.class, ChatColor.class})
public class ChallengesCommandTest {
@Mock
private CompositeCommand ic;
private UUID uuid;
@Mock
private User user;
@Mock
private IslandsManager im;
@Mock
private Island island;
@Mock
private ChallengesAddon addon;
private ChallengesCommand cc;
@Mock
private World world;
@Mock
private ChallengesManager chm;
@Mock
private IslandWorldManager iwm;
@Mock
private GameModeAddon gameModeAddon;
@Mock
private Settings settings;
/**
* @throws java.lang.Exception
*/
@Before
public void setUp() throws Exception {
// Set up plugin
BentoBox plugin = mock(BentoBox.class);
Whitebox.setInternalState(BentoBox.class, "instance", plugin);
User.setPlugin(plugin);
// Command manager
CommandsManager cm = mock(CommandsManager.class);
when(plugin.getCommandsManager()).thenReturn(cm);
// Addon
when(ic.getAddon()).thenReturn(addon);
when(ic.getPermissionPrefix()).thenReturn("bskyblock.");
when(ic.getLabel()).thenReturn("island");
when(ic.getTopLabel()).thenReturn("island");
when(ic.getWorld()).thenReturn(world);
when(ic.getTopLabel()).thenReturn("bsb");
// IWM friendly name
when(iwm.getFriendlyName(any())).thenReturn("BSkyBlock");
when(iwm.inWorld(any(World.class))).thenReturn(true);
Optional<GameModeAddon> optionalAddon = Optional.of(gameModeAddon);
when(iwm.getAddon(any())).thenReturn(optionalAddon);
when(plugin.getIWM()).thenReturn(iwm);
// Game Mode Addon
@NonNull
Optional<CompositeCommand> optionalAdmin = Optional.of(ic);
when(gameModeAddon.getAdminCommand()).thenReturn(optionalAdmin);
// World
when(world.toString()).thenReturn("world");
// Player
Player p = mock(Player.class);
// Sometimes use Mockito.withSettings().verboseLogging()
when(user.isOp()).thenReturn(false);
uuid = UUID.randomUUID();
when(user.getUniqueId()).thenReturn(uuid);
when(user.getPlayer()).thenReturn(p);
when(user.getName()).thenReturn("tastybento");
when(user.getPermissionValue(anyString(), anyInt())).thenReturn(-1);
when(user.isPlayer()).thenReturn(true);
// Mock item factory (for itemstacks)
PowerMockito.mockStatic(Bukkit.class);
ItemFactory itemFactory = mock(ItemFactory.class);
when(Bukkit.getItemFactory()).thenReturn(itemFactory);
ItemMeta itemMeta = mock(ItemMeta.class);
when(itemFactory.getItemMeta(any())).thenReturn(itemMeta);
// Addon
when(addon.getChallengesManager()).thenReturn(chm);
when(chm.getAllChallengeLevelStatus(any(), any())).thenReturn(Collections.emptyList());
// Challenges exist
when(chm.hasAnyChallengeData(any(World.class))).thenReturn(true);
// ChatColor
PowerMockito.mockStatic(ChatColor.class);
when(ChatColor.translateAlternateColorCodes(any(char.class), anyString())).thenAnswer((Answer<String>) invocation -> invocation.getArgument(1, String.class));
// Settings
when(addon.getChallengesSettings()).thenReturn(settings);
when(settings.getVisibilityMode()).thenReturn(VisibilityMode.VISIBLE);
// Island
when(plugin.getIslands()).thenReturn(im);
when(im.getIsland(any(), any(User.class))).thenReturn(island);
// Command under test
cc = new ChallengesCommand(addon, ic);
}
/**
* Test method for {@link world.bentobox.challenges.commands.ChallengesCommand#canExecute(world.bentobox.bentobox.api.user.User, java.lang.String, java.util.List)}.
*/
@Test
public void testCanExecuteWrongWorld() {
when(iwm.inWorld(any(World.class))).thenReturn(false);
assertFalse(cc.canExecute(user, "challenges", Collections.emptyList()));
verify(user).sendMessage("general.errors.wrong-world");
}
/**
* Test method for {@link world.bentobox.challenges.commands.ChallengesCommand#canExecute(world.bentobox.bentobox.api.user.User, java.lang.String, java.util.List)}.
*/
@Test
public void testCanExecuteNoChallenges() {
when(chm.hasAnyChallengeData(any(World.class))).thenReturn(false);
assertFalse(cc.canExecute(user, "challenges", Collections.emptyList()));
verify(addon).logError("There are no challenges set up in world!");
verify(user).sendMessage("challenges.errors.no-challenges");
}
/**
* Test method for {@link world.bentobox.challenges.commands.ChallengesCommand#canExecute(world.bentobox.bentobox.api.user.User, java.lang.String, java.util.List)}.
*/
@Test
public void testCanExecuteNoChallengesOp() {
when(user.isOp()).thenReturn(true);
when(chm.hasAnyChallengeData(any(World.class))).thenReturn(false);
assertFalse(cc.canExecute(user, "challenges", Collections.emptyList()));
verify(addon).logError("There are no challenges set up in world!");
verify(user).sendMessage("challenges.errors.no-challenges-admin", "[command]", "bsb challenges");
verify(user, never()).sendMessage("challenges.errors.no-challenges");
}
/**
* Test method for {@link world.bentobox.challenges.commands.ChallengesCommand#canExecute(world.bentobox.bentobox.api.user.User, java.lang.String, java.util.List)}.
*/
@Test
public void testCanExecuteNoChallengesHasPerm() {
when(user.hasPermission(anyString())).thenReturn(true);
when(chm.hasAnyChallengeData(any(World.class))).thenReturn(false);
assertFalse(cc.canExecute(user, "challenges", Collections.emptyList()));
verify(addon).logError("There are no challenges set up in world!");
verify(user).sendMessage("challenges.errors.no-challenges-admin", "[command]", "bsb challenges");
verify(user, never()).sendMessage("challenges.errors.no-challenges");
}
/**
* Test method for {@link world.bentobox.challenges.commands.ChallengesCommand#canExecute(world.bentobox.bentobox.api.user.User, java.lang.String, java.util.List)}.
*/
@Test
public void testCanExecuteNoAdminCommand() {
when(gameModeAddon.getAdminCommand()).thenReturn(Optional.empty());
when(user.isOp()).thenReturn(true);
when(chm.hasAnyChallengeData(any(World.class))).thenReturn(false);
assertFalse(cc.canExecute(user, "challenges", Collections.emptyList()));
verify(addon).logError("There are no challenges set up in world!");
verify(user).sendMessage("challenges.errors.no-challenges-admin", "[command]", "bsb challenges");
verify(user, never()).sendMessage("challenges.errors.no-challenges");
}
/**
* Test method for {@link world.bentobox.challenges.commands.ChallengesCommand#canExecute(world.bentobox.bentobox.api.user.User, java.lang.String, java.util.List)}.
*/
@Test
public void testCanExecuteNoIsland() {
when(im.getIsland(any(), any(User.class))).thenReturn(null);
assertFalse(cc.canExecute(user, "challenges", Collections.emptyList()));
verify(user).sendMessage("general.errors.no-island");
}
/**
* Test method for {@link world.bentobox.challenges.commands.ChallengesCommand#canExecute(world.bentobox.bentobox.api.user.User, java.lang.String, java.util.List)}.
*/
@Test
public void testCanExecuteSuccess() {
assertTrue(cc.canExecute(user, "challenges", Collections.emptyList()));
verify(user, never()).sendMessage(anyString());
}
/**
* Test method for {@link world.bentobox.challenges.commands.ChallengesCommand#execute(world.bentobox.bentobox.api.user.User, java.lang.String, java.util.List)}.
*/
@Test
public void testExecuteUserStringListOfStringConsole() {
User console = mock(User.class);
assertFalse(cc.execute(console, "challenges", Collections.emptyList()));
verify(console).sendMessage(eq("commands.help.header"), eq(TextVariables.LABEL), eq("BSkyBlock"));
}
/**
* Test method for {@link world.bentobox.challenges.commands.ChallengesCommand#execute(world.bentobox.bentobox.api.user.User, java.lang.String, java.util.List)}.
*/
@Test
public void testExecuteUserStringListOfStringUser() {
assertTrue(cc.execute(user, "challenges", Collections.emptyList()));
}
/**
* Test method for {@link world.bentobox.challenges.commands.ChallengesCommand#setup()}.
*/
@Test
public void testSetup() {
assertEquals("bskyblock." + ChallengesCommand.CHALLENGE_COMMAND, cc.getPermission());
assertEquals("challenges.commands.user.main.parameters", cc.getParameters());
assertEquals("challenges.commands.user.main.description", cc.getDescription());
assertTrue(cc.isOnlyPlayer());
// CompleteChallengeCommand
assertEquals(1, cc.getSubCommands(true).size());
}
}

342
src/test/java/world/bentobox/challenges/commands/CompleteChallengeCommandTest.java Normal file
View File

@ -0,0 +1,342 @@
package world.bentobox.challenges.commands;
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.anyInt;
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.verify;
import static org.mockito.Mockito.when;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.UUID;
import org.bukkit.Bukkit;
import org.bukkit.ChatColor;
import org.bukkit.World;
import org.bukkit.entity.Player;
import org.bukkit.inventory.ItemFactory;
import org.bukkit.inventory.meta.ItemMeta;
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.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.api.addons.GameModeAddon;
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.util.Util;
import world.bentobox.challenges.ChallengesAddon;
import world.bentobox.challenges.ChallengesManager;
import world.bentobox.challenges.config.Settings;
import world.bentobox.challenges.config.SettingsUtils.VisibilityMode;
import world.bentobox.challenges.database.object.Challenge;
import world.bentobox.challenges.tasks.TryToComplete;
import world.bentobox.challenges.utils.Utils;
/**
* @author tastybento
*
*/
@RunWith(PowerMockRunner.class)
@PrepareForTest({Bukkit.class, BentoBox.class, ChatColor.class, Utils.class, TryToComplete.class, Util.class})
public class CompleteChallengeCommandTest {
@Mock
private CompositeCommand ic;
private UUID uuid;
@Mock
private User user;
@Mock
private IslandsManager im;
@Mock
private Island island;
@Mock
private ChallengesAddon addon;
private CompleteChallengeCommand cc;
@Mock
private World world;
@Mock
private ChallengesManager chm;
@Mock
private IslandWorldManager iwm;
@Mock
private GameModeAddon gameModeAddon;
@Mock
private Settings settings;
@Mock
private Challenge challenge;
/**
* @throws java.lang.Exception
*/
@SuppressWarnings("unchecked")
@Before
public void setUp() throws Exception {
// Set up plugin
BentoBox plugin = mock(BentoBox.class);
Whitebox.setInternalState(BentoBox.class, "instance", plugin);
User.setPlugin(plugin);
// Command manager
CommandsManager cm = mock(CommandsManager.class);
when(plugin.getCommandsManager()).thenReturn(cm);
// Addon
when(ic.getAddon()).thenReturn(addon);
when(ic.getPermissionPrefix()).thenReturn("bskyblock.");
when(ic.getLabel()).thenReturn("island");
when(ic.getTopLabel()).thenReturn("island");
when(ic.getWorld()).thenReturn(world);
when(ic.getTopLabel()).thenReturn("bsb");
// IWM friendly name
when(iwm.getFriendlyName(any())).thenReturn("BSkyBlock");
when(iwm.inWorld(any(World.class))).thenReturn(true);
Optional<GameModeAddon> optionalAddon = Optional.of(gameModeAddon);
when(iwm.getAddon(any())).thenReturn(optionalAddon);
when(plugin.getIWM()).thenReturn(iwm);
// Game Mode Addon
@NonNull
Optional<CompositeCommand> optionalAdmin = Optional.of(ic);
when(gameModeAddon.getAdminCommand()).thenReturn(optionalAdmin);
// World
when(world.toString()).thenReturn("world");
// Player
Player p = mock(Player.class);
// Sometimes use Mockito.withSettings().verboseLogging()
when(user.isOp()).thenReturn(false);
uuid = UUID.randomUUID();
when(user.getUniqueId()).thenReturn(uuid);
when(user.getPlayer()).thenReturn(p);
when(user.getName()).thenReturn("tastybento");
when(user.getPermissionValue(anyString(), anyInt())).thenReturn(-1);
when(user.isPlayer()).thenReturn(true);
// Mock item factory (for itemstacks)
PowerMockito.mockStatic(Bukkit.class);
ItemFactory itemFactory = mock(ItemFactory.class);
when(Bukkit.getItemFactory()).thenReturn(itemFactory);
ItemMeta itemMeta = mock(ItemMeta.class);
when(itemFactory.getItemMeta(any())).thenReturn(itemMeta);
// Addon & Challenge Manager
when(addon.getChallengesManager()).thenReturn(chm);
when(chm.getAllChallengeLevelStatus(any(), any())).thenReturn(Collections.emptyList());
// Challenges exist
when(chm.hasAnyChallengeData(any(World.class))).thenReturn(true);
// Challenges
when(chm.getChallenge(anyString())).thenReturn(challenge);
List<String> nameList = Arrays.asList("world_maker", "world_placer", "bad_challenge_name", "world_breaker");
when(chm.getAllChallengesNames(any())).thenReturn(nameList);
// ChatColor
PowerMockito.mockStatic(ChatColor.class);
when(ChatColor.translateAlternateColorCodes(any(char.class), anyString())).thenAnswer((Answer<String>) invocation -> invocation.getArgument(1, String.class));
// Settings
when(addon.getChallengesSettings()).thenReturn(settings);
when(settings.getVisibilityMode()).thenReturn(VisibilityMode.VISIBLE);
// Island
when(plugin.getIslands()).thenReturn(im);
when(im.getIsland(any(), any(User.class))).thenReturn(island);
// Utils
PowerMockito.mockStatic(Utils.class);
when(Utils.getGameMode(any())).thenReturn("world");
// Try to complete
PowerMockito.mockStatic(TryToComplete.class);
// All challenges are successful!
when(TryToComplete.complete(any(), any(), any(), any(), anyString(), anyString(), anyInt())).thenReturn(true);
// Util
PowerMockito.mockStatic(Util.class);
when(Util.tabLimit(any(), any())).thenAnswer((Answer<List<String>>) invocation -> (List<String>)invocation.getArgument(0, List.class));
// Command under test
cc = new CompleteChallengeCommand(addon, ic);
}
/**
* @throws java.lang.Exception
*/
@After
public void tearDown() throws Exception {
}
/**
* Test method for {@link world.bentobox.challenges.commands.CompleteChallengeCommand#CompleteChallengeCommand(world.bentobox.bentobox.api.addons.Addon, world.bentobox.bentobox.api.commands.CompositeCommand)}.
*/
@Test
public void testCompleteChallengeCommand() {
assertEquals("complete", cc.getLabel());
}
/**
* Test method for {@link world.bentobox.challenges.commands.CompleteChallengeCommand#setup()}.
*/
@Test
public void testSetup() {
assertEquals("bskyblock.complete", cc.getPermission());
assertEquals("challenges.commands.user.complete.parameters", cc.getParameters());
assertEquals("challenges.commands.user.complete.description", cc.getDescription());
assertTrue(cc.isOnlyPlayer());
// No sub commands
assertEquals(0, cc.getSubCommands(true).size());
}
/**
* Test method for {@link world.bentobox.challenges.commands.CompleteChallengeCommand#execute(world.bentobox.bentobox.api.user.User, java.lang.String, java.util.List)}.
*/
@Test
public void testExecuteUserStringListOfStringNoArgs() {
assertFalse(cc.execute(user, "complete", Collections.emptyList()));
verify(user).sendMessage(eq("challenges.errors.no-name"));
verify(user).sendMessage(eq("commands.help.header"), eq(TextVariables.LABEL), eq("BSkyBlock"));
}
/**
* Test method for {@link world.bentobox.challenges.commands.CompleteChallengeCommand#execute(world.bentobox.bentobox.api.user.User, java.lang.String, java.util.List)}.
*/
@Test
public void testExecuteUserStringListOfStringUnknownChallenge() {
when(chm.getChallenge(anyString())).thenReturn(null);
assertFalse(cc.execute(user, "complete", Collections.singletonList("mychal")));
verify(user).sendMessage(eq("challenges.errors.unknown-challenge"));
verify(user).sendMessage(eq("commands.help.header"), eq(TextVariables.LABEL), eq("BSkyBlock"));
}
/**
* Test method for {@link world.bentobox.challenges.commands.CompleteChallengeCommand#execute(world.bentobox.bentobox.api.user.User, java.lang.String, java.util.List)}.
*/
@Test
public void testExecuteUserStringListOfStringKnownChallengeFail() {
when(TryToComplete.complete(any(), any(), any(), any(), anyString(), anyString(), anyInt())).thenReturn(false);
assertFalse(cc.execute(user, "complete", Collections.singletonList("mychal")));
verify(user, never()).sendMessage(any());
}
/**
* Test method for {@link world.bentobox.challenges.commands.CompleteChallengeCommand#execute(world.bentobox.bentobox.api.user.User, java.lang.String, java.util.List)}.
*/
@Test
public void testExecuteUserStringListOfStringKnownChallengeSuccess() {
assertTrue(cc.execute(user, "complete", Collections.singletonList("mychal")));
verify(user, never()).sendMessage(any());
}
/**
* Test method for {@link world.bentobox.challenges.commands.CompleteChallengeCommand#execute(world.bentobox.bentobox.api.user.User, java.lang.String, java.util.List)}.
*/
@Test
public void testExecuteUserStringListOfStringKnownChallengeSuccessMultipleTimesNoPerm() {
assertTrue(cc.execute(user, "complete", Arrays.asList("mychal", "5")));
verify(user).sendMessage(eq("challenges.error.no-multiple-permission"));
}
/**
* Test method for {@link world.bentobox.challenges.commands.CompleteChallengeCommand#execute(world.bentobox.bentobox.api.user.User, java.lang.String, java.util.List)}.
*/
@Test
public void testExecuteUserStringListOfStringKnownChallengeSuccessMultipleTimesHasPerm() {
when(user.hasPermission(anyString())).thenReturn(true);
assertTrue(cc.execute(user, "complete", Arrays.asList("mychal", "5")));
verify(user, never()).sendMessage(any());
}
/**
* Test method for {@link world.bentobox.challenges.commands.CompleteChallengeCommand#tabComplete(world.bentobox.bentobox.api.user.User, java.lang.String, java.util.List)}.
*/
@Test
public void testTabCompleteUserStringListOfStringNoArgs() {
cc.tabComplete(user, "complete", Collections.emptyList());
}
/**
* Test method for {@link world.bentobox.challenges.commands.CompleteChallengeCommand#tabComplete(world.bentobox.bentobox.api.user.User, java.lang.String, java.util.List)}.
*/
@Test
public void testTabCompleteUserStringListOfStringOneArg() {
List<String> list = cc.tabComplete(user, "complete", Collections.singletonList("arg")).get();
assertFalse(list.isEmpty());
assertEquals("help", list.get(0));
}
/**
* Test method for {@link world.bentobox.challenges.commands.CompleteChallengeCommand#tabComplete(world.bentobox.bentobox.api.user.User, java.lang.String, java.util.List)}.
*/
@Test
public void testTabCompleteUserStringListOfStringTwoArgs() {
List<String> list = cc.tabComplete(user, "complete", Arrays.asList("arg1", "arg2")).get();
assertFalse(list.isEmpty());
assertEquals("help", list.get(0));
}
/**
* Test method for {@link world.bentobox.challenges.commands.CompleteChallengeCommand#tabComplete(world.bentobox.bentobox.api.user.User, java.lang.String, java.util.List)}.
*/
@Test
public void testTabCompleteUserStringListOfStringThreeArgs() {
List<String> list = cc.tabComplete(user, "complete", Arrays.asList("arg1", "arg2", "arg3")).get();
assertFalse(list.isEmpty());
assertEquals("maker", list.get(0));
assertEquals("placer", list.get(1));
assertEquals("breaker", list.get(2));
}
/**
* Test method for {@link world.bentobox.challenges.commands.CompleteChallengeCommand#tabComplete(world.bentobox.bentobox.api.user.User, java.lang.String, java.util.List)}.
*/
@Test
public void testTabCompleteUserStringListOfStringFourArgs() {
List<String> list = cc.tabComplete(user, "complete", Arrays.asList("arg1", "arg2", "arg3", "arg4")).get();
assertTrue(list.isEmpty());
}
/**
* Test method for {@link world.bentobox.challenges.commands.CompleteChallengeCommand#tabComplete(world.bentobox.bentobox.api.user.User, java.lang.String, java.util.List)}.
*/
@Test
public void testTabCompleteUserStringListOfStringFourArgsNumber() {
List<String> list = cc.tabComplete(user, "complete", Arrays.asList("arg1", "arg2", "arg3", "4")).get();
assertFalse(list.isEmpty());
assertEquals("<number>", list.get(0));
}
/**
* Test method for {@link world.bentobox.challenges.commands.CompleteChallengeCommand#tabComplete(world.bentobox.bentobox.api.user.User, java.lang.String, java.util.List)}.
*/
@Test
public void testTabCompleteUserStringListOfStringFiveArgs() {
List<String> list = cc.tabComplete(user, "complete", Arrays.asList("arg1", "arg2", "arg23", "arg4", "arg5")).get();
assertFalse(list.isEmpty());
assertEquals("help", list.get(0));
}
}

392
src/test/java/world/bentobox/challenges/panel/user/ChallengesGUITest.java Normal file
View File

@ -0,0 +1,392 @@
package world.bentobox.challenges.panel.user;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyInt;
import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.UUID;
import org.bukkit.Bukkit;
import org.bukkit.ChatColor;
import org.bukkit.Material;
import org.bukkit.World;
import org.bukkit.World.Environment;
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.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.ArgumentCaptor;
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.api.commands.CompositeCommand;
import world.bentobox.bentobox.api.user.User;
import world.bentobox.bentobox.managers.BlueprintsManager;
import world.bentobox.bentobox.managers.IslandWorldManager;
import world.bentobox.bentobox.managers.IslandsManager;
import world.bentobox.challenges.ChallengesAddon;
import world.bentobox.challenges.ChallengesManager;
import world.bentobox.challenges.config.Settings;
import world.bentobox.challenges.config.SettingsUtils.VisibilityMode;
import world.bentobox.challenges.database.object.Challenge;
import world.bentobox.challenges.database.object.Challenge.ChallengeType;
import world.bentobox.challenges.database.object.ChallengeLevel;
import world.bentobox.challenges.utils.LevelStatus;
/**
* @author tastybento
*
*/
@RunWith(PowerMockRunner.class)
@PrepareForTest({Bukkit.class, BentoBox.class, ChatColor.class})
public class ChallengesGUITest {
@Mock
private User user;
@Mock
private IslandsManager im;
@Mock
private IslandWorldManager iwm;
@Mock
private BentoBox plugin;
@Mock
private Settings settings;
@Mock
private CompositeCommand ic;
@Mock
private BlueprintsManager bpm;
@Mock
private Inventory inv;
@Mock
private ItemMeta meta;
@Mock
private ChallengesAddon addon;
@Mock
private World world;
private ChallengesGUI cg;
@Mock
private ChallengesManager chm;
private UUID uuid;
@Mock
private Challenge challenge1;
@Mock
private Challenge challenge2;
@Mock
private Challenge challenge3;
@Mock
private Challenge challenge4;
@Mock
private LevelStatus levelStatus;
private List<Challenge> freeChalls = new ArrayList<>();
private List<Challenge> levelChalls = new ArrayList<>();
/**
* @throws java.lang.Exception
*/
@Before
public void setUp() throws Exception {
// Set up plugin
Whitebox.setInternalState(BentoBox.class, "instance", plugin);
PowerMockito.mockStatic(Bukkit.class);
// Item Factory (needed for ItemStack)
ItemFactory itemF = mock(ItemFactory.class);
when(itemF.getItemMeta(Mockito.any())).thenReturn(meta);
when(Bukkit.getItemFactory()).thenReturn(itemF);
// Inventory
when(Bukkit.createInventory(eq(null), anyInt(), anyString())).thenReturn(inv);
// Addon
when(addon.getChallengesManager()).thenReturn(chm);
// Levels
when(levelStatus.isUnlocked()).thenReturn(true);
ChallengeLevel level = mock(ChallengeLevel.class);
when(level.getFriendlyName()).thenReturn("Novice");
when(level.getUniqueId()).thenReturn("novice");
when(level.getIcon()).thenReturn(new ItemStack(Material.BIRCH_BOAT));
when(level.getLockedIcon()).thenReturn(new ItemStack(Material.DARK_OAK_BOAT));
when(levelStatus.getLevel()).thenReturn(level);
List<LevelStatus> levels = Collections.singletonList(levelStatus);
when(chm.getAllChallengeLevelStatus(any(), any())).thenReturn(levels);
when(chm.getChallengeLevelStatus(any(), any(), any())).thenReturn(levelStatus);
// Challenges exist
when(chm.hasAnyChallengeData(any(World.class))).thenReturn(true);
// Free challenges - have more than 18 so that the special processing kicks in
when(chm.getFreeChallenges(any())).thenReturn(freeChalls);
when(challenge1.isDeployed()).thenReturn(true);
when(challenge2.isDeployed()).thenReturn(true);
// 1 is repeatable, 2 is not
when(challenge1.isRepeatable()).thenReturn(true);
// Level challenges
when(chm.getLevelChallenges(any())).thenReturn(levelChalls);
// ChatColor
PowerMockito.mockStatic(ChatColor.class);
when(ChatColor.translateAlternateColorCodes(any(char.class), anyString())).thenAnswer((Answer<String>) invocation -> invocation.getArgument(1, String.class));
// Settings
when(addon.getChallengesSettings()).thenReturn(settings);
when(settings.getVisibilityMode()).thenReturn(VisibilityMode.VISIBLE);
when(settings.isFreeChallengesFirst()).thenReturn(false);
when(settings.isRemoveCompleteOneTimeChallenges()).thenReturn(false);
// Player
Player p = mock(Player.class);
when(user.isOp()).thenReturn(false);
uuid = UUID.randomUUID();
when(user.getUniqueId()).thenReturn(uuid);
when(user.getPlayer()).thenReturn(p);
when(user.getName()).thenReturn("tastybento");
when(user.getPermissionValue(anyString(), anyInt())).thenReturn(-1);
when(user.isPlayer()).thenReturn(true);
when(user.getTranslation(anyString())).thenAnswer((Answer<String>) invocation -> invocation.getArgument(0, String.class));
cg = new ChallengesGUI(addon, world, user, "island", "bskyblock.");
}
private void addLevelChallenges(int number) {
for (int i = 0; i < number; i++) {
Challenge c = mock(Challenge.class);
when(c.isRepeatable()).thenReturn(true);
when(c.getUniqueId()).thenReturn(String.valueOf(i) + "unique");
when(c.getIcon()).thenReturn(new ItemStack(Material.EMERALD));
when(c.getFriendlyName()).thenReturn(String.valueOf(i) + "name");
when(c.getChallengeType()).thenReturn(ChallengeType.INVENTORY);
when(c.getDescription()).thenReturn(Collections.singletonList("Description"));
when(c.getEnvironment()).thenReturn(Collections.singleton(Environment.NORMAL));
when(c.getLevel()).thenReturn("Novice");
when(c.getRewardItems()).thenReturn(Collections.emptyList());
when(c.isDeployed()).thenReturn(true);
levelChalls.add(c);
}
}
private void addFreeChallenges(int number) {
for (int i = 0; i < number; i++) {
Challenge c = mock(Challenge.class);
when(c.getUniqueId()).thenReturn(String.valueOf(i) + "unique");
when(c.getIcon()).thenReturn(new ItemStack(Material.DIAMOND));
when(c.getFriendlyName()).thenReturn(String.valueOf(i) + "name");
when(c.getChallengeType()).thenReturn(ChallengeType.INVENTORY);
when(c.getDescription()).thenReturn(Collections.singletonList("Description"));
when(c.getEnvironment()).thenReturn(Collections.singleton(Environment.NORMAL));
when(c.getLevel()).thenReturn("Novice");
when(c.getRewardItems()).thenReturn(Collections.emptyList());
when(c.isDeployed()).thenReturn(true);
when(c.isRepeatable()).thenReturn(true);
freeChalls.add(c);
}
}
/**
* @throws java.lang.Exception
*/
@After
public void tearDown() throws Exception {
}
/**
* Test method for {@link world.bentobox.challenges.panel.user.ChallengesGUI#build()}.
*/
@Test
public void testBuildNoChallenges() {
when(chm.hasAnyChallengeData(any(World.class))).thenReturn(false);
cg.build();
verify(addon).logError("There are no challenges set up!");
verify(user).sendMessage("challenges.errors.no-challenges");
}
/**
* Test method for {@link world.bentobox.challenges.panel.user.ChallengesGUI#build()}.
*/
@Test
public void testBuild0Free0LevelChallenge() {
when(settings.isFreeChallengesFirst()).thenReturn(true);
cg.build();
verify(user).getTranslation("challenges.gui.title.challenges");
ArgumentCaptor<Integer> argument = ArgumentCaptor.forClass(Integer.class);
ArgumentCaptor<ItemStack> argument2 = ArgumentCaptor.forClass(ItemStack.class);
verify(inv).setItem(argument.capture(), argument2.capture());
// Level
assertTrue(argument.getAllValues().get(0) == 0);
assertEquals(Material.BIRCH_BOAT, argument2.getAllValues().get(0).getType());
}
/**
* Test method for {@link world.bentobox.challenges.panel.user.ChallengesGUI#build()}.
*/
@Test
public void testBuild10Free10LevelChallenge() {
addFreeChallenges(10);
addLevelChallenges(10);
when(settings.isFreeChallengesFirst()).thenReturn(true);
cg.build();
verify(user).getTranslation("challenges.gui.title.challenges");
ArgumentCaptor<Integer> argument = ArgumentCaptor.forClass(Integer.class);
ArgumentCaptor<ItemStack> argument2 = ArgumentCaptor.forClass(ItemStack.class);
verify(inv, times(21)).setItem(argument.capture(), argument2.capture());
List<ItemStack> values = argument2.getAllValues();
// Free challenges
for (int i = 0; i < 10; i++) {
assertEquals("Failed on " + i, Material.DIAMOND, values.get(i).getType());
}
// Level challenges
for (int i = 11; i < 20; i++) {
assertEquals("Failed on " + i, Material.EMERALD, values.get(i).getType());
}
// Level icons
assertTrue(argument.getAllValues().get(20) == 36);
assertEquals(Material.BIRCH_BOAT, argument2.getAllValues().get(20).getType());
}
/**
* Test method for {@link world.bentobox.challenges.panel.user.ChallengesGUI#build()}.
*/
@Test
public void testBuild20Free20LevelChallenge() {
addFreeChallenges(20);
addLevelChallenges(20);
when(settings.isFreeChallengesFirst()).thenReturn(true);
cg.build();
verify(user).getTranslation("challenges.gui.title.challenges");
ArgumentCaptor<Integer> argument = ArgumentCaptor.forClass(Integer.class);
ArgumentCaptor<ItemStack> argument2 = ArgumentCaptor.forClass(ItemStack.class);
verify(inv, times(38)).setItem(argument.capture(), argument2.capture());
List<ItemStack> values = argument2.getAllValues();
// Free challenges
for (int i = 0; i < 18; i++) {
assertEquals("Failed on " + i, Material.DIAMOND, values.get(i).getType());
}
// Next page
assertTrue(argument.getAllValues().get(18) == 18);
assertEquals(Material.OAK_SIGN, argument2.getAllValues().get(18).getType());
// Level challenges
for (int i = 19; i < 37; i++) {
assertEquals("Failed on " + i, Material.EMERALD, values.get(i).getType());
}
// Next page
assertTrue(argument.getAllValues().get(37) == 45);
assertEquals(Material.OAK_SIGN, argument2.getAllValues().get(37).getType());
}
/**
* Test method for {@link world.bentobox.challenges.panel.user.ChallengesGUI#build()}.
*/
@Test
public void testBuildFreeChallenges10Free20LevelChallenge() {
addFreeChallenges(10);
addLevelChallenges(20);
when(settings.isFreeChallengesFirst()).thenReturn(true);
cg.build();
verify(user).getTranslation("challenges.gui.title.challenges");
ArgumentCaptor<Integer> argument = ArgumentCaptor.forClass(Integer.class);
ArgumentCaptor<ItemStack> argument2 = ArgumentCaptor.forClass(ItemStack.class);
verify(inv, times(30)).setItem(argument.capture(), argument2.capture());
List<ItemStack> values = argument2.getAllValues();
// Free challenges
for (int i = 0; i < 10; i++) {
assertEquals("Failed on " + i, Material.DIAMOND, values.get(i).getType());
}
// Level challenges
for (int i = 10; i < 27; i++) {
assertEquals("Failed on " + i, Material.EMERALD, values.get(i).getType());
}
// Next page
assertTrue(argument.getAllValues().get(28) == 36);
assertEquals(Material.OAK_SIGN, argument2.getAllValues().get(28).getType());
// Level
assertTrue(argument.getAllValues().get(29) == 45);
assertEquals(Material.BIRCH_BOAT, argument2.getAllValues().get(29).getType());
}
/**
* Test method for {@link world.bentobox.challenges.panel.user.ChallengesGUI#build()}.
*/
@Test
public void testBuildFreeChallenges20Free10LevelChallenge() {
addFreeChallenges(20);
addLevelChallenges(10);
when(settings.isFreeChallengesFirst()).thenReturn(true);
cg.build();
verify(user).getTranslation("challenges.gui.title.challenges");
ArgumentCaptor<Integer> argument = ArgumentCaptor.forClass(Integer.class);
ArgumentCaptor<ItemStack> argument2 = ArgumentCaptor.forClass(ItemStack.class);
verify(inv, times(30)).setItem(argument.capture(), argument2.capture());
List<ItemStack> values = argument2.getAllValues();
// Free challenges
for (int i = 0; i < 18; i++) {
assertEquals("Failed on " + i, Material.DIAMOND, values.get(i).getType());
}
// Next page
assertTrue(argument.getAllValues().get(18) == 18);
assertEquals(Material.OAK_SIGN, argument2.getAllValues().get(18).getType());
// Level challenges
for (int i = 19; i < 29; i++) {
assertEquals("Failed on " + i, Material.EMERALD, values.get(i).getType());
}
// Level
assertTrue(argument.getAllValues().get(29) == 45);
assertEquals(Material.BIRCH_BOAT, argument2.getAllValues().get(29).getType());
}
/**
* Test method for {@link world.bentobox.challenges.panel.user.ChallengesGUI#build()}.
*/
@Test
public void testBuildFreeChallengesLast20Free10LevelChallenge() {
addFreeChallenges(20);
addLevelChallenges(10);
when(settings.isFreeChallengesFirst()).thenReturn(false);
cg.build();
verify(user).getTranslation("challenges.gui.title.challenges");
ArgumentCaptor<Integer> argument = ArgumentCaptor.forClass(Integer.class);
ArgumentCaptor<ItemStack> argument2 = ArgumentCaptor.forClass(ItemStack.class);
verify(inv, times(30)).setItem(argument.capture(), argument2.capture());
List<ItemStack> values = argument2.getAllValues();
// Level challenges
for (int i = 0; i < 10; i++) {
assertEquals("Failed on " + i, Material.EMERALD, values.get(i).getType());
}
// Next page
assertTrue(argument.getAllValues().get(10) == 18);
assertEquals(Material.BIRCH_BOAT, argument2.getAllValues().get(10).getType());
// Free challenges
for (int i = 11; i < 29; i++) {
assertEquals("Failed on " + i, Material.DIAMOND, values.get(i).getType());
}
// Level
assertTrue(argument.getAllValues().get(29) == 45);
assertEquals(Material.OAK_SIGN, argument2.getAllValues().get(29).getType());
}
}

725
src/test/java/world/bentobox/challenges/tasks/TryToCompleteTest.java
View File

@ -1,233 +1,618 @@
package world.bentobox.challenges.tasks; package world.bentobox.challenges.tasks;
import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotEquals;
import static org.junit.Assert.assertTrue; import static org.junit.Assert.assertTrue;
import static org.mockito.Matchers.any; 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.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when; import static org.mockito.Mockito.when;
import java.util.ArrayList; import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.logging.Logger; import java.util.Optional;
import java.util.Set;
import java.util.UUID;
import org.bukkit.Bukkit; import org.bukkit.Bukkit;
import org.bukkit.GameMode;
import org.bukkit.Location;
import org.bukkit.Material; import org.bukkit.Material;
import org.bukkit.Server; import org.bukkit.World;
import org.bukkit.World.Environment;
import org.bukkit.entity.Entity;
import org.bukkit.entity.EntityType;
import org.bukkit.entity.Player;
import org.bukkit.inventory.ItemFactory; import org.bukkit.inventory.ItemFactory;
import org.bukkit.inventory.ItemStack; import org.bukkit.inventory.ItemStack;
import org.bukkit.inventory.PlayerInventory; import org.bukkit.inventory.PlayerInventory;
import org.bukkit.util.BoundingBox;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.junit.After;
import org.junit.Before; import org.junit.Before;
import org.junit.Test; import org.junit.Test;
import org.junit.runner.RunWith; import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.Mockito; import org.mockito.Mockito;
import org.mockito.stubbing.Answer;
import org.powermock.api.mockito.PowerMockito; import org.powermock.api.mockito.PowerMockito;
import org.powermock.core.classloader.annotations.PrepareForTest; import org.powermock.core.classloader.annotations.PrepareForTest;
import org.powermock.modules.junit4.PowerMockRunner; import org.powermock.modules.junit4.PowerMockRunner;
import org.powermock.reflect.Whitebox;
import world.bentobox.bentobox.BentoBox;
import world.bentobox.bentobox.api.addons.AddonDescription;
import world.bentobox.bentobox.api.addons.GameModeAddon;
import world.bentobox.bentobox.api.configuration.WorldSettings;
import world.bentobox.bentobox.api.user.User; import world.bentobox.bentobox.api.user.User;
import world.bentobox.bentobox.database.objects.Island;
import world.bentobox.bentobox.managers.AddonsManager;
import world.bentobox.bentobox.managers.IslandWorldManager;
import world.bentobox.bentobox.managers.IslandsManager;
import world.bentobox.bentobox.managers.LocalesManager;
import world.bentobox.bentobox.managers.PlaceholdersManager;
import world.bentobox.bentobox.util.Util;
import world.bentobox.challenges.ChallengesAddon; import world.bentobox.challenges.ChallengesAddon;
import world.bentobox.challenges.ChallengesManager;
import world.bentobox.challenges.config.Settings;
import world.bentobox.challenges.database.object.Challenge;
import world.bentobox.challenges.database.object.Challenge.ChallengeType;
import world.bentobox.challenges.database.object.ChallengeLevel;
import world.bentobox.challenges.database.object.requirements.InventoryRequirements;
import world.bentobox.challenges.database.object.requirements.IslandRequirements;
import world.bentobox.challenges.tasks.TryToComplete.ChallengeResult;
import world.bentobox.challenges.utils.Utils;
/** /**
* @author tastybento * @author tastybento
*
*/ */
@RunWith(PowerMockRunner.class) @RunWith(PowerMockRunner.class)
@PrepareForTest({ Bukkit.class}) @PrepareForTest({Bukkit.class, BentoBox.class, Util.class, Utils.class})
public class TryToCompleteTest { public class TryToCompleteTest {
private User user; // Constants
ItemStack[] stacks = { new ItemStack(Material.PAPER, 32), private static final String GAME_MODE_NAME = "BSkyBlock";
new ItemStack(Material.ACACIA_BOAT), private static final String[] NAMES = {"adam", "ben", "cara", "dave", "ed", "frank", "freddy", "george", "harry", "ian", "joe"};
null,
null,
new ItemStack(Material.CACTUS, 32),
new ItemStack(Material.CACTUS, 32),
new ItemStack(Material.CACTUS, 32),
new ItemStack(Material.BRICK_STAIRS, 64),
new ItemStack(Material.BRICK_STAIRS, 64),
new ItemStack(Material.BRICK_STAIRS, 5),
new ItemStack(Material.GOLD_BLOCK, 32)
};
List<ItemStack> required;
private ChallengesAddon addon;
private PlayerInventory inv;
/** private TryToComplete ttc;
* @throws java.lang.Exception private Challenge challenge;
*/ private @NonNull ChallengeLevel level;
@Before @Mock
public void setUp() throws Exception { private ChallengesAddon addon;
Server server = mock(Server.class); @Mock
PowerMockito.mockStatic(Bukkit.class); private User user;
when(Bukkit.getServer()).thenReturn(server); @Mock
when(Bukkit.getBukkitVersion()).thenReturn("1.13.2"); private World world;
private String topLabel = "island";
private String permissionPrefix = "perm.";
private String cName;
private String levelName;
@Mock
private ChallengesManager cm;
@Mock
private BentoBox plugin;
@Mock
private GameModeAddon gameMode;
@Mock
private AddonsManager am;
@Mock
private IslandsManager im;
@Mock
private Island island;
@Mock
private Player player;
@Mock
private Settings settings;
@Mock
private WorldSettings mySettings;
private Map<String, Boolean> map;
@Mock
private @Nullable PlayerInventory inv;
private ItemStack[] contents = {};
@Mock
private BoundingBox bb;
user = mock(User.class); /**
inv = mock(PlayerInventory.class); * @throws java.lang.Exception
when(inv.getContents()).thenReturn(stacks); */
when(user.getInventory()).thenReturn(inv); @Before
addon = mock(ChallengesAddon.class); public void setUp() throws Exception {
required = new ArrayList<>(); // Set up plugin
Whitebox.setInternalState(BentoBox.class, "instance", plugin);
when(addon.getPlugin()).thenReturn(plugin);
// World
when(user.getWorld()).thenReturn(world);
when(world.getEnvironment()).thenReturn(Environment.NORMAL);
ItemFactory itemFactory = mock(ItemFactory.class); // Addons manager
when(server.getItemFactory()).thenReturn(itemFactory); when(plugin.getAddonsManager()).thenReturn(am);
// One game mode
when(am.getGameModeAddons()).thenReturn(Collections.singletonList(gameMode));
AddonDescription desc2 = new AddonDescription.Builder("bentobox", GAME_MODE_NAME, "1.3").description("test").authors("tasty").build();
when(gameMode.getDescription()).thenReturn(desc2);
// Test will not work with items that has meta data. // Challenge Level
when(itemFactory.getItemMeta(any())).thenReturn(null); level = new ChallengeLevel();
when(itemFactory.equals(null, null)).thenReturn(true); levelName = GAME_MODE_NAME + "_novice";
level.setUniqueId(levelName);
level.setFriendlyName("Novice");
// Set up challenge
String uuid = UUID.randomUUID().toString();
challenge = new Challenge();
challenge.setUniqueId(GAME_MODE_NAME + "_" + uuid);
challenge.setFriendlyName("name");
challenge.setLevel(GAME_MODE_NAME + "_novice");
challenge.setDescription(Collections.singletonList("A description"));
challenge.setChallengeType(ChallengeType.INVENTORY);
challenge.setDeployed(true);
challenge.setIcon(new ItemStack(Material.EMERALD));
challenge.setEnvironment(Collections.singleton(World.Environment.NORMAL));
challenge.setLevel(levelName);
challenge.setRepeatable(true);
challenge.setMaxTimes(10);
InventoryRequirements req = new InventoryRequirements();
when(Bukkit.getItemFactory()).thenReturn(itemFactory); challenge.setRequirements(req);
when(Bukkit.getLogger()).thenReturn(Logger.getAnonymousLogger()); // Util
} PowerMockito.mockStatic(Util.class);
when(Util.getWorld(any())).thenReturn(world);
when(Util.prettifyText(anyString())).thenCallRealMethod();
/** // Island World Manager
* Test method for {@link TryToComplete#removeItems(java.util.List, int)}. IslandWorldManager iwm = mock(IslandWorldManager.class);
*/ when(plugin.getIWM()).thenReturn(iwm);
@Test Optional<GameModeAddon> optionalGameMode = Optional.of(gameMode);
public void testRemoveItemsSuccess() { when(iwm.getAddon(any())).thenReturn(optionalGameMode);
Material requiredMaterial = Material.PAPER; when(iwm.getIslandDistance(any())).thenReturn(400);
int requiredQuantity = 21;
this.required.add(new ItemStack(requiredMaterial, requiredQuantity)); // Island Manager
TryToComplete x = new TryToComplete(this.addon); when(addon.getIslands()).thenReturn(im);
x.user(this.user); Optional<Island> opIsland = Optional.of(island);
Map<ItemStack, Integer> removed = x.removeItems(this.required, 1); when(im.getIslandAt(any())).thenReturn(opIsland);
when(im.getIsland(any(), any(User.class))).thenReturn(island);
// Player is on island
when(im.locationIsOnIsland(any(), any())).thenReturn(true);
// Island flags - everything is allowed by default
when(island.isAllowed(any(), any())).thenReturn(true);
// Island
assertEquals((int) removed.getOrDefault(new ItemStack(requiredMaterial, 1), 0), requiredQuantity); @Nullable
} Location loc = mock(Location.class);
when(loc.toString()).thenReturn("center");
when(island.getCenter()).thenReturn(loc);
/** // Challenges Manager
* Test method for {@link TryToComplete#removeItems(java.util.List, int)}. when(addon.getChallengesManager()).thenReturn(cm);
*/ // All levels unlocked by default
@Test when(cm.isLevelUnlocked(any(), any(), any())).thenReturn(true);
public void testRemoveItemsMax() { // Player has done this challenge 3 times (default max is 10)
Material requiredMaterial = Material.PAPER; when(cm.getChallengeTimes(any(), any(), any(Challenge.class))).thenReturn(3L);
int requiredQuantity = 50;
this.required.add(new ItemStack(requiredMaterial, requiredQuantity)); // User has all perms by default
TryToComplete x = new TryToComplete(this.addon); when(user.hasPermission(anyString())).thenReturn(true);
x.user(this.user); when(user.getPlayer()).thenReturn(player);
Map<ItemStack, Integer> removed = x.removeItems(this.required, 1); when(user.getTranslation(Mockito.anyString())).thenAnswer((Answer<String>) invocation -> invocation.getArgument(0, String.class));
when(user.getName()).thenReturn("tastybento");
@Nullable
Location userLoc = mock(Location.class);
when(userLoc.toString()).thenReturn("location");
when(user.getLocation()).thenReturn(userLoc);
when(user.getInventory()).thenReturn(inv);
when(inv.getContents()).thenReturn(contents);
when(player.getBoundingBox()).thenReturn(bb);
when(bb.clone()).thenReturn(bb);
when(bb.toString()).thenReturn("BoundingBox");
// Locales
User.setPlugin(plugin);
LocalesManager lm = mock(LocalesManager.class);
when(plugin.getLocalesManager()).thenReturn(lm);
when(lm.get(any(), any())).thenAnswer((Answer<String>) invocation -> invocation.getArgument(1, String.class));
PlaceholdersManager phm = mock(PlaceholdersManager.class);
when(plugin.getPlaceholdersManager()).thenReturn(phm);
when(phm.replacePlaceholders(any(), any())).thenAnswer((Answer<String>) invocation -> invocation.getArgument(1, String.class));
assertNotEquals((int) removed.getOrDefault(new ItemStack(requiredMaterial, 1), 0), requiredQuantity); // Survival by default
} when(player.getGameMode()).thenReturn(GameMode.SURVIVAL);
/** // Addon
* Test method for {@link TryToComplete#removeItems(java.util.List, int)}. when(addon.getChallengesSettings()).thenReturn(settings);
*/ when(settings.isBroadcastMessages()).thenReturn(true);
@Test
public void testRemoveItemsZero() {
Material requiredMaterial = Material.PAPER;
int requiredQuantity = 0;
this.required.add(new ItemStack(requiredMaterial, requiredQuantity)); // Bukkit - online players
TryToComplete x = new TryToComplete(this.addon); Map<UUID, String> online = new HashMap<>();
x.user(this.user);
Map<ItemStack, Integer> removed = x.removeItems(this.required, 1);
assertTrue(removed.isEmpty()); Set<Player> onlinePlayers = new HashSet<>();
} for (int j = 0; j < NAMES.length; j++) {
Player p1 = mock(Player.class);
UUID uuid2 = UUID.randomUUID();
when(p1.getUniqueId()).thenReturn(uuid2);
when(p1.getName()).thenReturn(NAMES[j]);
online.put(uuid2, NAMES[j]);
onlinePlayers.add(p1);
}
PowerMockito.mockStatic(Bukkit.class);
when(Bukkit.getOnlinePlayers()).then((Answer<Set<Player>>) invocation -> onlinePlayers);
/** // World settings
* Test method for {@link TryToComplete#removeItems(java.util.List, int)}. map = new HashMap<>();
*/ when(mySettings.getWorldFlags()).thenReturn(map);
@Test when(iwm.getWorldSettings(any())).thenReturn(mySettings);
public void testRemoveItemsSuccessMultiple() { ChallengesAddon.CHALLENGES_WORLD_PROTECTION.setSetting(world, true);
required.add(new ItemStack(Material.PAPER, 11));
required.add(new ItemStack(Material.PAPER, 5));
required.add(new ItemStack(Material.PAPER, 5));
TryToComplete x = new TryToComplete(addon);
x.user(user);
Map<ItemStack, Integer> removed = x.removeItems(required, 1);
assertEquals((int) removed.getOrDefault(new ItemStack(Material.PAPER, 1), 0), 21); // ItemFactory
} ItemFactory itemFactory = mock(ItemFactory.class);
when(Bukkit.getItemFactory()).thenReturn(itemFactory);
/** }
* Test method for {@link TryToComplete#removeItems(java.util.List, int)}.
*/
@Test
public void testRemoveItemsSuccessMultipleOther() {
required.add(new ItemStack(Material.CACTUS, 5));
required.add(new ItemStack(Material.PAPER, 11));
required.add(new ItemStack(Material.PAPER, 5));
required.add(new ItemStack(Material.PAPER, 5));
required.add(new ItemStack(Material.CACTUS, 5));
TryToComplete x = new TryToComplete(addon);
x.user(user);
Map<ItemStack, Integer> removed = x.removeItems(required, 1);
assertEquals((int) removed.getOrDefault(new ItemStack(Material.PAPER, 1), 0), 21); /**
assertEquals((int) removed.getOrDefault(new ItemStack(Material.CACTUS, 1), 0), 10); * @throws java.lang.Exception
} */
@After
public void tearDown() throws Exception {
}
/** /**
* Test method for {@link TryToComplete#removeItems(java.util.List, int)}. * Test method for {@link world.bentobox.challenges.tasks.TryToComplete#TryToComplete(world.bentobox.challenges.ChallengesAddon, world.bentobox.bentobox.api.user.User, world.bentobox.challenges.database.object.Challenge, org.bukkit.World, java.lang.String, java.lang.String)}.
*/ */
@Test @Test
public void testRemoveItemsMultipleOtherFail() { public void testTryToCompleteChallengesAddonUserChallengeWorldStringString() {
required.add(new ItemStack(Material.ACACIA_FENCE, 5)); ttc = new TryToComplete(addon,
required.add(new ItemStack(Material.ARROW, 11)); user,
required.add(new ItemStack(Material.STONE, 5)); challenge,
required.add(new ItemStack(Material.BAKED_POTATO, 5)); world,
required.add(new ItemStack(Material.GHAST_SPAWN_EGG, 5)); topLabel,
TryToComplete x = new TryToComplete(addon); permissionPrefix);
x.user(user); verify(addon).getChallengesManager();
Map<ItemStack, Integer> removed = x.removeItems(required, 1);
assertTrue(removed.isEmpty());
}
/** }
* Test method for {@link TryToComplete#removeItems(java.util.List, int)}.
*/
@Test
public void testRemoveItemsFail() {
ItemStack input = new ItemStack(Material.GOLD_BLOCK, 55);
required.add(input);
TryToComplete x = new TryToComplete(addon);
x.user(user);
Map<ItemStack, Integer> removed = x.removeItems(required, 1);
// It will remove 32, but not any more /**
assertEquals((int) removed.getOrDefault(new ItemStack(Material.GOLD_BLOCK, 1), 0), 32); * Test method for {@link world.bentobox.challenges.tasks.TryToComplete#complete(world.bentobox.challenges.ChallengesAddon, world.bentobox.bentobox.api.user.User, world.bentobox.challenges.database.object.Challenge, org.bukkit.World, java.lang.String, java.lang.String)}.
*/
@Test
public void testCompleteChallengesAddonUserChallengeWorldStringStringNotDeployed() {
challenge.setDeployed(false);
assertFalse(TryToComplete.complete(addon, user, challenge, world, topLabel, permissionPrefix));
verify(user).sendMessage("challenges.errors.not-deployed");
}
// An error will be thrown /**
Mockito.verify(addon, Mockito.times(1)).logError(Mockito.anyString()); * Test method for {@link world.bentobox.challenges.tasks.TryToComplete#complete(world.bentobox.challenges.ChallengesAddon, world.bentobox.bentobox.api.user.User, world.bentobox.challenges.database.object.Challenge, org.bukkit.World, java.lang.String, java.lang.String)}.
} */
@Test
public void testCompleteChallengesAddonUserChallengeWorldStringStringWrongWorld() {
challenge.setUniqueId("test");
assertFalse(TryToComplete.complete(addon, user, challenge, world, topLabel, permissionPrefix));
verify(user).sendMessage("general.errors.wrong-world");
}
/**
* Test method for {@link world.bentobox.challenges.tasks.TryToComplete#complete(world.bentobox.challenges.ChallengesAddon, world.bentobox.bentobox.api.user.User, world.bentobox.challenges.database.object.Challenge, org.bukkit.World, java.lang.String, java.lang.String)}.
*/
@Test
public void testCompleteChallengesAddonUserChallengeWorldStringStringNotOnIsland() {
ChallengesAddon.CHALLENGES_WORLD_PROTECTION.setSetting(world, true);
when(im.locationIsOnIsland(any(Player.class), any(Location.class))).thenReturn(false);
assertFalse(TryToComplete.complete(addon, user, challenge, world, topLabel, permissionPrefix));
verify(user).sendMessage("challenges.errors.not-on-island");
}
/**
* Test method for {@link world.bentobox.challenges.tasks.TryToComplete#complete(world.bentobox.challenges.ChallengesAddon, world.bentobox.bentobox.api.user.User, world.bentobox.challenges.database.object.Challenge, org.bukkit.World, java.lang.String, java.lang.String)}.
*/
@Test
public void testCompleteChallengesAddonUserChallengeWorldStringStringNotOnIslandButOk() {
ChallengesAddon.CHALLENGES_WORLD_PROTECTION.setSetting(world, false);
when(im.locationIsOnIsland(any(Player.class), any(Location.class))).thenReturn(false);
assertTrue(TryToComplete.complete(addon, user, challenge, world, topLabel, permissionPrefix));
verify(user).sendMessage("challenges.messages.you-completed-challenge", "[value]", "name");
}
/** /**
* Test method for {@link TryToComplete#removeItems(java.util.List, int)}. * Test method for {@link world.bentobox.challenges.tasks.TryToComplete#complete(world.bentobox.challenges.ChallengesAddon, world.bentobox.bentobox.api.user.User, world.bentobox.challenges.database.object.Challenge, org.bukkit.World, java.lang.String, java.lang.String)}.
*/ */
@Test @Test
public void testRequireTwoStacks() { public void testCompleteChallengesAddonUserChallengeWorldStringStringLevelNotUnlocked() {
required.add(new ItemStack(Material.BRICK_STAIRS, 64)); when(cm.isLevelUnlocked(any(), any(), any())).thenReturn(false);
required.add(new ItemStack(Material.BRICK_STAIRS, 64)); assertFalse(TryToComplete.complete(addon, user, challenge, world, topLabel, permissionPrefix));
verify(user).sendMessage("challenges.errors.challenge-level-not-available");
}
TryToComplete x = new TryToComplete(addon); /**
x.user(user); * Test method for {@link world.bentobox.challenges.tasks.TryToComplete#complete(world.bentobox.challenges.ChallengesAddon, world.bentobox.bentobox.api.user.User, world.bentobox.challenges.database.object.Challenge, org.bukkit.World, java.lang.String, java.lang.String)}.
Map<ItemStack, Integer> removed = x.removeItems(required, 1); */
@Test
public void testCompleteChallengesAddonUserChallengeWorldStringStringNotRepeatable() {
challenge.setRepeatable(false);
when(cm.isChallengeComplete(any(User.class), any(), any())).thenReturn(true);
assertFalse(TryToComplete.complete(addon, user, challenge, world, topLabel, permissionPrefix));
verify(user).sendMessage("challenges.errors.not-repeatable");
}
// It should remove both stacks /**
assertEquals((int) removed.getOrDefault(new ItemStack(Material.BRICK_STAIRS, 1), 0), 128); * Test method for {@link world.bentobox.challenges.tasks.TryToComplete#complete(world.bentobox.challenges.ChallengesAddon, world.bentobox.bentobox.api.user.User, world.bentobox.challenges.database.object.Challenge, org.bukkit.World, java.lang.String, java.lang.String)}.
} */
@Test
public void testCompleteChallengesAddonUserChallengeWorldStringStringNotRepeatableFirstTime() {
challenge.setRepeatable(false);
challenge.setMaxTimes(0);
when(cm.getChallengeTimes(any(), any(), any(Challenge.class))).thenReturn(0L);
assertTrue(TryToComplete.complete(addon, user, challenge, world, topLabel, permissionPrefix));
verify(user).sendMessage("challenges.messages.you-completed-challenge", "[value]", "name");
}
/**
* Test method for {@link world.bentobox.challenges.tasks.TryToComplete#complete(world.bentobox.challenges.ChallengesAddon, world.bentobox.bentobox.api.user.User, world.bentobox.challenges.database.object.Challenge, org.bukkit.World, java.lang.String, java.lang.String)}.
*/
@Test
public void testCompleteChallengesAddonUserChallengeWorldStringStringNoRank() {
when(island.isAllowed(any(), any())).thenReturn(false);
assertFalse(TryToComplete.complete(addon, user, challenge, world, topLabel, permissionPrefix));
verify(user).sendMessage("challenges.errors.no-rank");
}
/** /**
* Test method for {@link TryToComplete#removeItems(java.util.List, int)}. * Test method for {@link world.bentobox.challenges.tasks.TryToComplete#complete(world.bentobox.challenges.ChallengesAddon, world.bentobox.bentobox.api.user.User, world.bentobox.challenges.database.object.Challenge, org.bukkit.World, java.lang.String, java.lang.String, int)}.
*/ */
@Test @Test
public void testFactorStacks() { public void testCompleteChallengesAddonUserChallengeWorldStringStringIntZero() {
required.add(new ItemStack(Material.BRICK_STAIRS, 32)); assertFalse(TryToComplete.complete(addon, user, challenge, world, topLabel, permissionPrefix, 0));
verify(user).sendMessage("challenges.errors.not-valid-integer");
}
TryToComplete x = new TryToComplete(addon); /**
x.user(user); * Test method for {@link world.bentobox.challenges.tasks.TryToComplete#complete(world.bentobox.challenges.ChallengesAddon, world.bentobox.bentobox.api.user.User, world.bentobox.challenges.database.object.Challenge, org.bukkit.World, java.lang.String, java.lang.String, int)}.
Map<ItemStack, Integer> removed = x.removeItems(required, 4); */
@Test
public void testCompleteChallengesAddonUserChallengeWorldStringStringIntNegative() {
assertFalse(TryToComplete.complete(addon, user, challenge, world, topLabel, permissionPrefix, -10));
verify(user).sendMessage("challenges.errors.not-valid-integer");
}
/**
* Test method for {@link world.bentobox.challenges.tasks.TryToComplete#complete(world.bentobox.challenges.ChallengesAddon, world.bentobox.bentobox.api.user.User, world.bentobox.challenges.database.object.Challenge, org.bukkit.World, java.lang.String, java.lang.String, int)}.
*/
@Test
public void testCompleteChallengesAddonUserChallengeWorldStringStringIntPositiveWrongEnvinonment() {
challenge.setEnvironment(Collections.singleton(Environment.NETHER));
assertFalse(TryToComplete.complete(addon, user, challenge, world, topLabel, permissionPrefix, 100));
verify(user).sendMessage("challenges.errors.wrong-environment");
}
/**
* Test method for {@link world.bentobox.challenges.tasks.TryToComplete#complete(world.bentobox.challenges.ChallengesAddon, world.bentobox.bentobox.api.user.User, world.bentobox.challenges.database.object.Challenge, org.bukkit.World, java.lang.String, java.lang.String, int)}.
*/
@Test
public void testCompleteChallengesAddonUserChallengeWorldStringStringIntPositiveNoPerm() {
InventoryRequirements req = new InventoryRequirements();
req.setRequiredPermissions(Collections.singleton("perm-you-dont-have"));
when(user.hasPermission(anyString())).thenReturn(false);
challenge.setRequirements(req);
assertFalse(TryToComplete.complete(addon, user, challenge, world, topLabel, permissionPrefix, 100));
verify(user).sendMessage("general.errors.no-permission");
}
/**
* Test method for {@link world.bentobox.challenges.tasks.TryToComplete#complete(world.bentobox.challenges.ChallengesAddon, world.bentobox.bentobox.api.user.User, world.bentobox.challenges.database.object.Challenge, org.bukkit.World, java.lang.String, java.lang.String)}.
*/
@Test
public void testCompleteChallengesAddonUserChallengeWorldStringStringSuccess() {
assertTrue(TryToComplete.complete(addon, user, challenge, world, topLabel, permissionPrefix));
verify(user).sendMessage("challenges.messages.you-completed-challenge", "[value]", "name");
}
/**
* Test method for {@link world.bentobox.challenges.tasks.TryToComplete#complete(world.bentobox.challenges.ChallengesAddon, world.bentobox.bentobox.api.user.User, world.bentobox.challenges.database.object.Challenge, org.bukkit.World, java.lang.String, java.lang.String)}.
*/
@Test
public void testCompleteChallengesAddonUserChallengeWorldStringStringSuccessSingleReq() {
InventoryRequirements req = new InventoryRequirements();
req.setRequiredItems(Collections.singletonList(new ItemStack(Material.EMERALD_BLOCK)));
challenge.setRequirements(req);
assertFalse(TryToComplete.complete(addon, user, challenge, world, topLabel, permissionPrefix));
verify(user).sendMessage("challenges.errors.not-enough-items", "[items]", "Emerald Block");
}
/**
* Test method for {@link world.bentobox.challenges.tasks.TryToComplete#complete(world.bentobox.challenges.ChallengesAddon, world.bentobox.bentobox.api.user.User, world.bentobox.challenges.database.object.Challenge, org.bukkit.World, java.lang.String, java.lang.String)}.
*/
@Test
public void testCompleteChallengesAddonUserChallengeWorldStringStringSuccessMultipleReq() {
InventoryRequirements req = new InventoryRequirements();
ItemStack itemStackMock = mock(ItemStack.class);
when(itemStackMock.getAmount()).thenReturn(3);
when(itemStackMock.getType()).thenReturn(Material.EMERALD_BLOCK);
when(itemStackMock.clone()).thenReturn(itemStackMock);
ItemStack itemStackMock2 = mock(ItemStack.class);
when(itemStackMock2.getType()).thenReturn(Material.ENCHANTED_BOOK);
when(itemStackMock2.getAmount()).thenReturn(10);
when(itemStackMock2.clone()).thenReturn(itemStackMock2);
ItemStack itemStackMock3 = mock(ItemStack.class);
when(itemStackMock3.getType()).thenReturn(Material.EMERALD_BLOCK);
when(itemStackMock3.getAmount()).thenReturn(15);
when(itemStackMock3.clone()).thenReturn(itemStackMock3);
// itemStackMock and 3 are same type
when(itemStackMock3.isSimilar(eq(itemStackMock))).thenReturn(true);
when(itemStackMock.isSimilar(eq(itemStackMock3))).thenReturn(true);
req.setRequiredItems(Arrays.asList(itemStackMock , itemStackMock2));
challenge.setRequirements(req);
ItemStack[] newContents = {itemStackMock3};
when(inv.getContents()).thenReturn(newContents);
assertFalse(TryToComplete.complete(addon, user, challenge, world, topLabel, permissionPrefix));
// Sufficient emerald blocks
verify(user, never()).sendMessage("challenges.errors.not-enough-items", "[items]", "Emerald Block");
// Not enough books
verify(user).sendMessage("challenges.errors.not-enough-items", "[items]", "Enchanted Book");
}
/**
* Test method for {@link world.bentobox.challenges.tasks.TryToComplete#complete(world.bentobox.challenges.ChallengesAddon, world.bentobox.bentobox.api.user.User, world.bentobox.challenges.database.object.Challenge, org.bukkit.World, java.lang.String, java.lang.String)}.
*/
@Test
public void testCompleteChallengesAddonUserChallengeWorldStringStringSuccessCreative() {
when(player.getGameMode()).thenReturn(GameMode.CREATIVE);
assertTrue(TryToComplete.complete(addon, user, challenge, world, topLabel, permissionPrefix));
verify(user).sendMessage("challenges.messages.you-completed-challenge", "[value]", "name");
}
/**
* Test method for {@link world.bentobox.challenges.tasks.TryToComplete#complete(world.bentobox.challenges.ChallengesAddon, world.bentobox.bentobox.api.user.User, world.bentobox.challenges.database.object.Challenge, org.bukkit.World, java.lang.String, java.lang.String)}.
*/
@Test
public void testCompleteChallengesAddonUserChallengeWorldStringStringIslandBBTooLarge() {
challenge.setChallengeType(ChallengeType.ISLAND);
IslandRequirements req = new IslandRequirements();
req.setSearchRadius(1);
challenge.setRequirements(req);
// Trigger big bounding box error
when(bb.getWidthX()).thenReturn(50000D);
assertFalse(TryToComplete.complete(addon, user, challenge, world, topLabel, permissionPrefix));
verify(addon).logError("BoundingBox is larger than SearchRadius. | BoundingBox: BoundingBox | Search Distance: 1 | Location: location | Center: center | Range: 0");
verify(bb).expand(1);
}
/**
* Test method for {@link world.bentobox.challenges.tasks.TryToComplete#complete(world.bentobox.challenges.ChallengesAddon, world.bentobox.bentobox.api.user.User, world.bentobox.challenges.database.object.Challenge, org.bukkit.World, java.lang.String, java.lang.String)}.
*/
@Test
public void testCompleteChallengesAddonUserChallengeWorldStringStringIslandSuccessNoEntities() {
challenge.setChallengeType(ChallengeType.ISLAND);
IslandRequirements req = new IslandRequirements();
req.setSearchRadius(1);
challenge.setRequirements(req);
assertTrue(TryToComplete.complete(addon, user, challenge, world, topLabel, permissionPrefix));
verify(user).sendMessage("challenges.messages.you-completed-challenge", "[value]", "name");
}
/**
* Test method for {@link world.bentobox.challenges.tasks.TryToComplete#complete(world.bentobox.challenges.ChallengesAddon, world.bentobox.bentobox.api.user.User, world.bentobox.challenges.database.object.Challenge, org.bukkit.World, java.lang.String, java.lang.String)}.
*/
@Test
public void testCompleteChallengesAddonUserChallengeWorldStringStringIslandFailEntities() {
challenge.setChallengeType(ChallengeType.ISLAND);
IslandRequirements req = new IslandRequirements();
Map<EntityType, Integer> requiredEntities = Collections.singletonMap(EntityType.GHAST, 3);
req.setRequiredEntities(requiredEntities);
req.setSearchRadius(1);
challenge.setRequirements(req);
assertFalse(TryToComplete.complete(addon, user, challenge, world, topLabel, permissionPrefix));
verify(user).sendMessage("challenges.errors.you-still-need", "[amount]", "3", "[item]", "Ghast");
}
/**
* Test method for {@link world.bentobox.challenges.tasks.TryToComplete#complete(world.bentobox.challenges.ChallengesAddon, world.bentobox.bentobox.api.user.User, world.bentobox.challenges.database.object.Challenge, org.bukkit.World, java.lang.String, java.lang.String)}.
*/
@Test
public void testCompleteChallengesAddonUserChallengeWorldStringStringIslandFailMultipleEntities() {
challenge.setChallengeType(ChallengeType.ISLAND);
IslandRequirements req = new IslandRequirements();
Map<EntityType, Integer> requiredEntities = new HashMap<>();
requiredEntities.put(EntityType.GHAST, 3);
requiredEntities.put(EntityType.CHICKEN, 5);
requiredEntities.put(EntityType.PUFFERFISH, 1);
req.setRequiredEntities(requiredEntities);
req.setSearchRadius(1);
challenge.setRequirements(req);
assertFalse(TryToComplete.complete(addon, user, challenge, world, topLabel, permissionPrefix));
verify(user).sendMessage("challenges.errors.you-still-need", "[amount]", "3", "[item]", "Ghast");
verify(user).sendMessage("challenges.errors.you-still-need", "[amount]", "1", "[item]", "Pufferfish");
verify(user).sendMessage("challenges.errors.you-still-need", "[amount]", "5", "[item]", "Chicken");
}
/**
* Test method for {@link world.bentobox.challenges.tasks.TryToComplete#complete(world.bentobox.challenges.ChallengesAddon, world.bentobox.bentobox.api.user.User, world.bentobox.challenges.database.object.Challenge, org.bukkit.World, java.lang.String, java.lang.String)}.
*/
@Test
public void testCompleteChallengesAddonUserChallengeWorldStringStringIslandFailPartialMultipleEntities() {
challenge.setChallengeType(ChallengeType.ISLAND);
IslandRequirements req = new IslandRequirements();
Map<EntityType, Integer> requiredEntities = new HashMap<>();
requiredEntities.put(EntityType.GHAST, 3);
requiredEntities.put(EntityType.CHICKEN, 5);
requiredEntities.put(EntityType.PUFFERFISH, 1);
req.setRequiredEntities(requiredEntities);
req.setSearchRadius(1);
challenge.setRequirements(req);
Entity ent = mock(Entity.class);
when(ent.getType()).thenReturn(EntityType.PUFFERFISH);
Location loc = mock(Location.class);
when(ent.getLocation()).thenReturn(loc);
List<Entity> list = Collections.singletonList(ent);
when(world.getNearbyEntities(any(BoundingBox.class))).thenReturn(list);
assertFalse(TryToComplete.complete(addon, user, challenge, world, topLabel, permissionPrefix));
verify(user).sendMessage("challenges.errors.you-still-need", "[amount]", "3", "[item]", "Ghast");
verify(user, never()).sendMessage("challenges.errors.you-still-need", "[amount]", "1", "[item]", "Pufferfish");
verify(user).sendMessage("challenges.errors.you-still-need", "[amount]", "5", "[item]", "Chicken");
}
/**
* Test method for {@link world.bentobox.challenges.tasks.TryToComplete#complete(world.bentobox.challenges.ChallengesAddon, world.bentobox.bentobox.api.user.User, world.bentobox.challenges.database.object.Challenge, org.bukkit.World, java.lang.String, java.lang.String)}.
*/
@Test
public void testCompleteChallengesAddonUserChallengeWorldStringStringIslandSuccess() {
challenge.setChallengeType(ChallengeType.ISLAND);
IslandRequirements req = new IslandRequirements();
Map<EntityType, Integer> requiredEntities = new HashMap<>();
requiredEntities.put(EntityType.PUFFERFISH, 1);
req.setRequiredEntities(requiredEntities);
req.setSearchRadius(1);
challenge.setRequirements(req);
Entity ent = mock(Entity.class);
when(ent.getType()).thenReturn(EntityType.PUFFERFISH);
Location loc = mock(Location.class);
when(ent.getLocation()).thenReturn(loc);
List<Entity> list = Collections.singletonList(ent);
when(world.getNearbyEntities(any(BoundingBox.class))).thenReturn(list);
assertTrue(TryToComplete.complete(addon, user, challenge, world, topLabel, permissionPrefix));
verify(user).sendMessage("challenges.messages.you-completed-challenge", "[value]", "name");
}
/**
* Test method for {@link world.bentobox.challenges.tasks.TryToComplete#complete(world.bentobox.challenges.ChallengesAddon, world.bentobox.bentobox.api.user.User, world.bentobox.challenges.database.object.Challenge, org.bukkit.World, java.lang.String, java.lang.String, int)}.
*/
@Test
public void testCompleteChallengesAddonUserChallengeWorldStringStringIntMultipleTimesPositiveSuccess() {
// Try to complete 10 times. Already done 3 times, and max is 10, so it should be only done 7 times
assertTrue(TryToComplete.complete(addon, user, challenge, world, topLabel, permissionPrefix, 10));
verify(user).sendMessage("challenges.messages.you-repeated-challenge-multiple", "[value]", "name", "[count]", "7");
}
/**
* Test method for {@link world.bentobox.challenges.tasks.TryToComplete#build(int)}.
*/
@Test
public void testBuild() {
this.testTryToCompleteChallengesAddonUserChallengeWorldStringString();
ChallengeResult result = this.ttc.build(10);
}
/**
* Test method for {@link world.bentobox.challenges.tasks.TryToComplete#removeItems(java.util.List, int)}.
*/
@Test
public void testRemoveItems() {
this.testTryToCompleteChallengesAddonUserChallengeWorldStringString();
ttc.removeItems(Collections.emptyList(), 1);
}
// It should remove both stacks
assertEquals((int) removed.getOrDefault(new ItemStack(Material.BRICK_STAIRS, 1), 0), 128);
}
} }

233
src/test/java/world/bentobox/challenges/tasks/TryToCompleteTestOld.java Normal file
View File

@ -0,0 +1,233 @@
package world.bentobox.challenges.tasks;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotEquals;
import static org.junit.Assert.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.logging.Logger;
import org.bukkit.Bukkit;
import org.bukkit.Material;
import org.bukkit.Server;
import org.bukkit.inventory.ItemFactory;
import org.bukkit.inventory.ItemStack;
import org.bukkit.inventory.PlayerInventory;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mockito;
import org.powermock.api.mockito.PowerMockito;
import org.powermock.core.classloader.annotations.PrepareForTest;
import org.powermock.modules.junit4.PowerMockRunner;
import world.bentobox.bentobox.api.user.User;
import world.bentobox.challenges.ChallengesAddon;
/**
* @author tastybento
*/
@RunWith(PowerMockRunner.class)
@PrepareForTest({ Bukkit.class})
public class TryToCompleteTestOld {
private User user;
ItemStack[] stacks = { new ItemStack(Material.PAPER, 32),
new ItemStack(Material.ACACIA_BOAT),
null,
null,
new ItemStack(Material.CACTUS, 32),
new ItemStack(Material.CACTUS, 32),
new ItemStack(Material.CACTUS, 32),
new ItemStack(Material.BRICK_STAIRS, 64),
new ItemStack(Material.BRICK_STAIRS, 64),
new ItemStack(Material.BRICK_STAIRS, 5),
new ItemStack(Material.GOLD_BLOCK, 32)
};
List<ItemStack> required;
private ChallengesAddon addon;
private PlayerInventory inv;
/**
* @throws java.lang.Exception
*/
@Before
public void setUp() throws Exception {
Server server = mock(Server.class);
PowerMockito.mockStatic(Bukkit.class);
when(Bukkit.getServer()).thenReturn(server);
when(Bukkit.getBukkitVersion()).thenReturn("1.13.2");
user = mock(User.class);
inv = mock(PlayerInventory.class);
when(inv.getContents()).thenReturn(stacks);
when(user.getInventory()).thenReturn(inv);
addon = mock(ChallengesAddon.class);
required = new ArrayList<>();
ItemFactory itemFactory = mock(ItemFactory.class);
when(server.getItemFactory()).thenReturn(itemFactory);
// Test will not work with items that has meta data.
when(itemFactory.getItemMeta(any())).thenReturn(null);
when(itemFactory.equals(null, null)).thenReturn(true);
when(Bukkit.getItemFactory()).thenReturn(itemFactory);
when(Bukkit.getLogger()).thenReturn(Logger.getAnonymousLogger());
}
/**
* Test method for {@link TryToComplete#removeItems(java.util.List, int)}.
*/
@Test
public void testRemoveItemsSuccess() {
Material requiredMaterial = Material.PAPER;
int requiredQuantity = 21;
this.required.add(new ItemStack(requiredMaterial, requiredQuantity));
TryToComplete x = new TryToComplete(this.addon);
x.user(this.user);
Map<ItemStack, Integer> removed = x.removeItems(this.required, 1);
assertEquals((int) removed.getOrDefault(new ItemStack(requiredMaterial, 1), 0), requiredQuantity);
}
/**
* Test method for {@link TryToComplete#removeItems(java.util.List, int)}.
*/
@Test
public void testRemoveItemsMax() {
Material requiredMaterial = Material.PAPER;
int requiredQuantity = 50;
this.required.add(new ItemStack(requiredMaterial, requiredQuantity));
TryToComplete x = new TryToComplete(this.addon);
x.user(this.user);
Map<ItemStack, Integer> removed = x.removeItems(this.required, 1);
assertNotEquals((int) removed.getOrDefault(new ItemStack(requiredMaterial, 1), 0), requiredQuantity);
}
/**
* Test method for {@link TryToComplete#removeItems(java.util.List, int)}.
*/
@Test
public void testRemoveItemsZero() {
Material requiredMaterial = Material.PAPER;
int requiredQuantity = 0;
this.required.add(new ItemStack(requiredMaterial, requiredQuantity));
TryToComplete x = new TryToComplete(this.addon);
x.user(this.user);
Map<ItemStack, Integer> removed = x.removeItems(this.required, 1);
assertTrue(removed.isEmpty());
}
/**
* Test method for {@link TryToComplete#removeItems(java.util.List, int)}.
*/
@Test
public void testRemoveItemsSuccessMultiple() {
required.add(new ItemStack(Material.PAPER, 11));
required.add(new ItemStack(Material.PAPER, 5));
required.add(new ItemStack(Material.PAPER, 5));
TryToComplete x = new TryToComplete(addon);
x.user(user);
Map<ItemStack, Integer> removed = x.removeItems(required, 1);
assertEquals((int) removed.getOrDefault(new ItemStack(Material.PAPER, 1), 0), 21);
}
/**
* Test method for {@link TryToComplete#removeItems(java.util.List, int)}.
*/
@Test
public void testRemoveItemsSuccessMultipleOther() {
required.add(new ItemStack(Material.CACTUS, 5));
required.add(new ItemStack(Material.PAPER, 11));
required.add(new ItemStack(Material.PAPER, 5));
required.add(new ItemStack(Material.PAPER, 5));
required.add(new ItemStack(Material.CACTUS, 5));
TryToComplete x = new TryToComplete(addon);
x.user(user);
Map<ItemStack, Integer> removed = x.removeItems(required, 1);
assertEquals((int) removed.getOrDefault(new ItemStack(Material.PAPER, 1), 0), 21);
assertEquals((int) removed.getOrDefault(new ItemStack(Material.CACTUS, 1), 0), 10);
}
/**
* Test method for {@link TryToComplete#removeItems(java.util.List, int)}.
*/
@Test
public void testRemoveItemsMultipleOtherFail() {
required.add(new ItemStack(Material.ACACIA_FENCE, 5));
required.add(new ItemStack(Material.ARROW, 11));
required.add(new ItemStack(Material.STONE, 5));
required.add(new ItemStack(Material.BAKED_POTATO, 5));
required.add(new ItemStack(Material.GHAST_SPAWN_EGG, 5));
TryToComplete x = new TryToComplete(addon);
x.user(user);
Map<ItemStack, Integer> removed = x.removeItems(required, 1);
assertTrue(removed.isEmpty());
}
/**
* Test method for {@link TryToComplete#removeItems(java.util.List, int)}.
*/
@Test
public void testRemoveItemsFail() {
ItemStack input = new ItemStack(Material.GOLD_BLOCK, 55);
required.add(input);
TryToComplete x = new TryToComplete(addon);
x.user(user);
Map<ItemStack, Integer> removed = x.removeItems(required, 1);
// It will remove 32, but not any more
assertEquals((int) removed.getOrDefault(new ItemStack(Material.GOLD_BLOCK, 1), 0), 32);
// An error will be thrown
Mockito.verify(addon, Mockito.times(1)).logError(Mockito.anyString());
}
/**
* Test method for {@link TryToComplete#removeItems(java.util.List, int)}.
*/
@Test
public void testRequireTwoStacks() {
required.add(new ItemStack(Material.BRICK_STAIRS, 64));
required.add(new ItemStack(Material.BRICK_STAIRS, 64));
TryToComplete x = new TryToComplete(addon);
x.user(user);
Map<ItemStack, Integer> removed = x.removeItems(required, 1);
// It should remove both stacks
assertEquals((int) removed.getOrDefault(new ItemStack(Material.BRICK_STAIRS, 1), 0), 128);
}
/**
* Test method for {@link TryToComplete#removeItems(java.util.List, int)}.
*/
@Test
public void testFactorStacks() {
required.add(new ItemStack(Material.BRICK_STAIRS, 32));
TryToComplete x = new TryToComplete(addon);
x.user(user);
Map<ItemStack, Integer> removed = x.removeItems(required, 4);
// It should remove both stacks
assertEquals((int) removed.getOrDefault(new ItemStack(Material.BRICK_STAIRS, 1), 0), 128);
}
}

199
src/test/java/world/bentobox/challenges/utils/UtilsTest.java Normal file
View File

@ -0,0 +1,199 @@
package world.bentobox.challenges.utils;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.mockito.ArgumentMatchers.any;
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.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import org.bukkit.Bukkit;
import org.bukkit.Material;
import org.bukkit.World;
import org.bukkit.inventory.ItemFactory;
import org.bukkit.inventory.ItemStack;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
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.api.addons.AddonDescription;
import world.bentobox.bentobox.api.addons.GameModeAddon;
import world.bentobox.bentobox.managers.IslandWorldManager;
import world.bentobox.challenges.config.SettingsUtils.VisibilityMode;
/**
* @author tastybento
*
*/
@RunWith(PowerMockRunner.class)
@PrepareForTest({Bukkit.class})
public class UtilsTest {
@Mock
private IslandWorldManager iwm;
@Mock
private GameModeAddon gameModeAddon;
/**
* @throws java.lang.Exception
*/
@Before
public void setUp() throws Exception {
// Set up plugin
BentoBox plugin = mock(BentoBox.class);
Whitebox.setInternalState(BentoBox.class, "instance", plugin);
// Mock item factory (for itemstacks)
PowerMockito.mockStatic(Bukkit.class);
ItemFactory itemFactory = mock(ItemFactory.class);
when(Bukkit.getItemFactory()).thenReturn(itemFactory);
// IWM getAddon
AddonDescription desc = new AddonDescription.Builder("main", "name", "1.0").build();
when(gameModeAddon.getDescription()).thenReturn(desc);
Optional<GameModeAddon> optionalAddon = Optional.of(gameModeAddon);
when(iwm.getAddon(any())).thenReturn(optionalAddon);
when(plugin.getIWM()).thenReturn(iwm);
}
/**
* @throws java.lang.Exception
*/
@After
public void tearDown() throws Exception {
}
/**
* Test method for {@link world.bentobox.challenges.utils.Utils#groupEqualItems(java.util.List)}.
*/
@Test
public void testGroupEqualItemsEmpty() {
assertTrue(Utils.groupEqualItems(Collections.emptyList()).isEmpty());
}
/**
* Test method for {@link world.bentobox.challenges.utils.Utils#groupEqualItems(java.util.List)}.
*/
@Test
public void testGroupEqualItems() {
List<ItemStack> requiredItems = new ArrayList<>();
// First item
ItemStack is = mock(ItemStack.class);
when(is.getAmount()).thenReturn(1);
when(is.getType()).thenReturn(Material.ACACIA_FENCE);
when(is.getMaxStackSize()).thenReturn(64);
when(is.isSimilar(any())).thenReturn(true);
when(is.clone()).thenReturn(is);
requiredItems.add(is);
for (int i = 0; i < 9; i++) {
ItemStack is2 = mock(ItemStack.class);
when(is2.getAmount()).thenReturn(1);
when(is2.getType()).thenReturn(Material.ACACIA_FENCE);
when(is2.getMaxStackSize()).thenReturn(64);
when(is2.isSimilar(any())).thenReturn(true);
when(is2.clone()).thenReturn(is);
requiredItems.add(is2);
}
List<ItemStack> list = Utils.groupEqualItems(requiredItems);
// Result should be two stacks stack of 64 doors and 36 doors
assertEquals(1, list.size());
verify(is, times(9)).setAmount(2);
}
/**
* Test method for {@link world.bentobox.challenges.utils.Utils#groupEqualItems(java.util.List)}.
*/
@Test
public void testGroupEqualItemsUnique() {
List<ItemStack> requiredItems = new ArrayList<>();
// First item
ItemStack is = mock(ItemStack.class);
when(is.getAmount()).thenReturn(1);
when(is.getType()).thenReturn(Material.ACACIA_FENCE);
when(is.getMaxStackSize()).thenReturn(64);
when(is.isSimilar(any())).thenReturn(false);
when(is.clone()).thenReturn(is);
requiredItems.add(is);
for (int i = 0; i < 9; i++) {
ItemStack is2 = mock(ItemStack.class);
when(is2.getAmount()).thenReturn(1);
when(is2.getType()).thenReturn(Material.values()[i+20]);
when(is2.getMaxStackSize()).thenReturn(64);
when(is2.isSimilar(any())).thenReturn(false);
when(is2.clone()).thenReturn(is);
requiredItems.add(is2);
}
List<ItemStack> list = Utils.groupEqualItems(requiredItems);
// Result should be two stacks stack of 64 doors and 36 doors
assertEquals(10, list.size());
verify(is, never()).setAmount(2);
}
/**
* Test method for {@link world.bentobox.challenges.utils.Utils#canIgnoreMeta(org.bukkit.Material)}.
*/
@Test
public void testCanIgnoreMeta() {
assertTrue(Utils.canIgnoreMeta(Material.FIREWORK_ROCKET));
assertTrue(Utils.canIgnoreMeta(Material.ENCHANTED_BOOK));
assertTrue(Utils.canIgnoreMeta(Material.WRITTEN_BOOK));
assertTrue(Utils.canIgnoreMeta(Material.FILLED_MAP));
assertFalse(Utils.canIgnoreMeta(Material.CHISELED_RED_SANDSTONE));
}
/**
* Test method for {@link world.bentobox.challenges.utils.Utils#getGameMode(org.bukkit.World)}.
*/
@Test
public void testGetGameModeNoGameMode() {
when(iwm.getAddon(any())).thenReturn(Optional.empty());
assertNull(Utils.getGameMode(mock(World.class)));
}
/**
* Test method for {@link world.bentobox.challenges.utils.Utils#getGameMode(org.bukkit.World)}.
*/
@Test
public void testGetGameMode() {
assertEquals("name", Utils.getGameMode(mock(World.class)));
}
/**
* Test method for {@link world.bentobox.challenges.utils.Utils#getNextValue(T[], java.lang.Object)}.
*/
@Test
public void testGetNextValue() {
assertEquals(VisibilityMode.HIDDEN, Utils.getNextValue(VisibilityMode.values(), VisibilityMode.VISIBLE));
assertEquals(VisibilityMode.TOGGLEABLE, Utils.getNextValue(VisibilityMode.values(), VisibilityMode.HIDDEN));
assertEquals(VisibilityMode.VISIBLE, Utils.getNextValue(VisibilityMode.values(), VisibilityMode.TOGGLEABLE));
}
/**
* Test method for {@link world.bentobox.challenges.utils.Utils#getPreviousValue(T[], java.lang.Object)}.
*/
@Test
public void testGetPreviousValue() {
assertEquals(VisibilityMode.TOGGLEABLE, Utils.getPreviousValue(VisibilityMode.values(), VisibilityMode.VISIBLE));
assertEquals(VisibilityMode.VISIBLE, Utils.getPreviousValue(VisibilityMode.values(), VisibilityMode.HIDDEN));
assertEquals(VisibilityMode.HIDDEN, Utils.getPreviousValue(VisibilityMode.values(), VisibilityMode.TOGGLEABLE));
}
}