Fix update tests related checkstyle

Author: 1whatleytay

src/test/java/org/hydev/mcpm/client/database/MockInstaller.java

@@ -13,16 +13,32 @@
 import java.util.List;
 import java.util.Set;
 
+/**
+ * Mock installer utility that keeps track of plugins that were requested to be installed.
+ */
 public class MockInstaller implements InstallBoundary {
     private final List<PluginModel> plugins;
     private final PluginTracker tracker;
     private final boolean defaultResult;
     private final Set<String> requested = new HashSet<>();
 
+    /**
+     * Creates a new MockInstaller object that always succeeds (when it is not already installed).
+     *
+     * @param plugins A list of plugins to lookup plugin related information about (to pass to PluginTracker).
+     * @param tracker A plugin tracker to query whether a plugin is installed.
+     */
     public MockInstaller(List<PluginModel> plugins, PluginTracker tracker) {
         this(plugins, tracker, true);
     }
 
+    /**
+     * Creates a new MockInstaller object.
+     *
+     * @param plugins A list of plugins to lookup plugin related information about (to pass to PluginTracker).
+     * @param tracker A plugin tracker to query whether a plugin is installed.
+     * @param defaultResult Determines what the installer should return when installPlugin is invoked.
+     */
     public MockInstaller(List<PluginModel> plugins, PluginTracker tracker, boolean defaultResult) {
         this.plugins = plugins;
         this.tracker = tracker;
@@ -53,6 +69,11 @@ public boolean installPlugin(InstallInput installInput, InstallResultPresenter r
         return defaultResult;
     }
 
+    /**
+     * Returns a list of all plugin names that were passed to installPlugin (and succeeded).
+     *
+     * @return A list of plugin names.
+     */
     Set<String> getRequested() {
         return new HashSet<>(requested);
     }

src/test/java/org/hydev/mcpm/client/database/MockPluginTracker.java

@@ -8,6 +8,12 @@
 import java.util.List;
 import java.util.Map;
 
+/**
+ * Mock implementation of the PluginTracker interface.
+ *
+ * @param entries A list of all entries in the lockfile.
+ * @param installed A list of all "Installed" PluginYml files (to be returned in listInstalled).
+ */
 public record MockPluginTracker(
     Map<String, Boolean> entries,
     List<PluginYml> installed

src/test/java/org/hydev/mcpm/client/database/PluginMockFactory.java

@@ -175,15 +175,18 @@ public static PluginModel model(long id, String name, String description, List<S
      * @return List of plugins for testing.
      */
     public static @Unmodifiable List<PluginModel> generateTestPlugins() {
-        String[] descriptions = {"WorldGuard lets you and players guard areas " +
-                "of land against griefers and undesirables as well " +
-                "as tweak and disable various gameplay features of Minecraft.",
-                "Multiverse was created at the dawn of Bukkit multiworld support. " +
-                        "It has since then grown into a complete world management " +
-                        "solution including special treatment of your nether worlds with " +
-                        "Multiverse NetherPortals.",
-                "Create futuristic holograms to display text and items to players!"
-        };
+        var worldGuardDescription = "WorldGuard lets you and players guard areas " +
+            "of land against griefers and undesirables as well " +
+            "as tweak and disable various gameplay features of Minecraft.";
+
+        var multiverseDescription = "Multiverse was created at the dawn of Bukkit multiworld support. " +
+            "It has since then grown into a complete world management " +
+            "solution including special treatment of your nether worlds with " +
+            "Multiverse NetherPortals.";
+
+        var hologramDescription = "Create futuristic holograms to display text and items to players!";
+
+        String[] descriptions = { worldGuardDescription, multiverseDescription, hologramDescription };
 
         return List.of(
                 PluginMockFactory.model(1),
@@ -193,7 +196,7 @@ public static PluginModel model(long id, String name, String description, List<S
                         createCommand(descriptions[0], List.of("/god", "/ungod"))),
                 PluginMockFactory.model(3, "Multiverse-Core", descriptions[1],
                         List.of("1.19.2", "1.19.1"),
-                        createCommand(descriptions[1],List.of("/mvlist", "/mvl"))),
+                        createCommand(descriptions[1], List.of("/mvlist", "/mvl"))),
                 PluginMockFactory.model(4, "Holographic Displays", descriptions[2],
                         List.of("1.19.2", "1.19.1", "1.19"),
                         createCommand(descriptions[2], List.of("/hd", "/ungod")))

src/test/java/org/hydev/mcpm/client/database/SilentInstallPresenter.java

@@ -3,6 +3,9 @@
 import org.hydev.mcpm.client.commands.presenters.InstallResultPresenter;
 import org.hydev.mcpm.client.installer.InstallResult;
 
+/**
+ * Mock Install Presenter that does nothing on invocation.
+ */
 public class SilentInstallPresenter implements InstallResultPresenter {
     @Override
     public void displayResult(InstallResult installResult, String name) {

src/test/java/org/hydev/mcpm/client/database/UpdateInteractorTest.java

@@ -23,6 +23,10 @@
 import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
+/**
+ * Test methods related to the Update plugins use case.
+ * To accomplish this, we use mock installers, plugin trackers and databases.
+ */
 public class UpdateInteractorTest {
     private static final InstallResultPresenter installPresenter = new SilentInstallPresenter();
 
@@ -32,6 +36,15 @@ private record MockPackage(
         MockInstaller mockInstaller
     ) { }
 
+    /**
+     * Create an interactor with provided paramters.
+     *
+     * @param plugins A repository of all plugins. Will be passed to database unless emptyDatabase is true.
+     * @param installedVersions Maps from plugin id to versions of plugins that are "installed" in the mock tracker.
+     * @param installerSucceeds Determines the return value of the mock installer (false for failure).
+     * @param emptyDatabase If true, regardless of the value of plugins, the database will contain no plugins.
+     * @return A MockPackage object, consisting of an UpdateBoundary, PluginTracker and Installer.
+     */
     private static MockPackage interactor(
         List<PluginModel> plugins,
         Map<Long, String> installedVersions,
@@ -66,6 +79,11 @@ private static MockPackage interactor(
         );
     }
 
+    /**
+     * Default plugins in a database for utility.
+     *
+     * @return A list of mock PluginModel objects.
+     */
     private static List<PluginModel> defaultPlugins() {
         return List.of(
             PluginMockFactory.model(1, "TpProtect", List.of("0.0.0.0.1", "0.0.3", "9.99")),
@@ -75,10 +93,20 @@ private static List<PluginModel> defaultPlugins() {
         );
     }
 
+    /**
+     * Returns an interactor with an empty database and empty plugin tracker.
+     *
+     * @return A MockPackage object.
+     */
     private static MockPackage emptyInteractor() {
         return interactor(List.of(), Map.of(), true, false);
     }
 
+    /**
+     * Returns an interactor with an empty database but one installed plugin (JedCore).
+     *
+     * @return A MockPackage object.
+     */
     private static MockPackage emptyWithInstalledInteractor() {
         return interactor(
             defaultPlugins(),
@@ -87,6 +115,11 @@ private static MockPackage emptyWithInstalledInteractor() {
         );
     }
 
+    /**
+     * Returns an interactor with all installed plugins marked as up-to-date.
+     *
+     * @return A MockPackage object.
+     */
     private static MockPackage upToDateInteractor() {
         return interactor(defaultPlugins(), Map.of(
             2L, "version-3",
@@ -95,6 +128,11 @@ private static MockPackage upToDateInteractor() {
         ), true, false);
     }
 
+    /**
+     * Returns an interactor with one installed plugin marked as out-of-date.
+     *
+     * @return A MockPackage object.
+     */
     private static MockPackage oneOldInteractor() {
         return interactor(defaultPlugins(), Map.of(
             2L, "version-2",
@@ -103,6 +141,11 @@ private static MockPackage oneOldInteractor() {
         ), true, false);
     }
 
+    /**
+     * Returns an interactor with one out-of-date plugin, with a strictly failing mock installer.
+     *
+     * @return A MockPackage object.
+     */
     private static MockPackage failingOneOldInteractor() {
         return interactor(defaultPlugins(), Map.of(
             2L, "version-2",
@@ -111,6 +154,11 @@ private static MockPackage failingOneOldInteractor() {
         ), false, false);
     }
 
+    /**
+     * Returns an interactor with all installed plugins marked as out-of-date.
+     *
+     * @return A MockPackage object.
+     */
     private static MockPackage outOfDateInteractor() {
         return interactor(defaultPlugins(), Map.of(
             2L, "version-2",
@@ -119,18 +167,27 @@ private static MockPackage outOfDateInteractor() {
         ), true, false);
     }
 
+    /**
+     * Asserts if the outcome is not UP_TO_DATE.
+     */
     private static void assertUpToDate(UpdateOutcome outcome, String version) {
         assertEquals(outcome.state(), UpdateOutcome.State.UP_TO_DATE);
         assertEquals(outcome.initialVersion(), version);
         assertNull(outcome.destinationVersion());
     }
 
+    /**
+     * Asserts if the outcome is not UPDATED.
+     */
     private static void assertUpdated(UpdateOutcome outcome, String version, String destination) {
         assertEquals(outcome.state(), UpdateOutcome.State.UPDATED);
         assertEquals(outcome.initialVersion(), version);
         assertEquals(outcome.destinationVersion(), destination);
     }
 
+    /**
+     * Tests that update does nothing on an empty database/plugin tracker.
+     */
     @Test
     void testEmptyDatabase() {
         var mock = emptyInteractor();
@@ -143,6 +200,9 @@ void testEmptyDatabase() {
         assertTrue(result.outcomes().isEmpty());
     }
 
+    /**
+     * Tests that update correctly marks a plugin that does not exist in the database as MISMATCHED.
+     */
     @Test
     void testMismatchedPlugin() {
         var mock = emptyWithInstalledInteractor();
@@ -155,6 +215,9 @@ void testMismatchedPlugin() {
         assertEquals(result.outcomes().get("JedCore").state(), UpdateOutcome.State.MISMATCHED);
     }
 
+    /**
+     * Tests that update correctly marks a given plugin that is not in the plugin tracker as NOT_INSTALLED.
+     */
     @Test
     void testMismatchedName() {
         var mock = emptyInteractor();
@@ -167,6 +230,9 @@ void testMismatchedName() {
         assertEquals(result.outcomes().get("JedCore").state(), UpdateOutcome.State.NOT_INSTALLED);
     }
 
+    /**
+     * Tests that update correctly marks all up-to-date plugins as UP_TO_DATE.
+     */
     @Test
     void testAllUpToDate() {
         var mock = upToDateInteractor();
@@ -182,6 +248,9 @@ void testAllUpToDate() {
         assertUpToDate(result.outcomes().get("TpProtect"), "9.99");
     }
 
+    /**
+     * Tests that update correctly marks a specific given plugin as UP_TO_DATE.
+     */
     @Test
     void testOneUpToDate() {
         var mock = upToDateInteractor();
@@ -195,6 +264,9 @@ void testOneUpToDate() {
         assertUpToDate(result.outcomes().get("Apples+"), "1.2");
     }
 
+    /**
+     * Tests that update correctly marks all installed plugins as OUT_OF_DATE.
+     */
     @Test
     void testAllOutOfDate() {
         var mock = outOfDateInteractor();
@@ -210,6 +282,9 @@ void testAllOutOfDate() {
         assertUpdated(result.outcomes().get("TpProtect"), "0.0.3", "9.99");
     }
 
+    /**
+     * Tests that update correctly marks a given plugin as OUT_OF_DATE.
+     */
     @Test
     void testOneOutOfDate() {
         var mock = outOfDateInteractor();
@@ -223,6 +298,9 @@ void testOneOutOfDate() {
         assertUpdated(result.outcomes().get("Apples+"), "1.0", "1.2");
     }
 
+    /**
+     * Tests that update correctly marks a mixture of OUT_OF_DATE and UP_TO_DATE plugins.
+     */
     @Test
     void testAllMixed() {
         var mock = oneOldInteractor();
@@ -238,6 +316,9 @@ void testAllMixed() {
         assertUpToDate(result.outcomes().get("TpProtect"), "9.99");
     }
 
+    /**
+     * Tests that update correctly conveys a NETWORK_ERROR on an installation failure.
+     */
     @Test
     void testFailingInstaller() {
         var mock = failingOneOldInteractor();

src/test/java/org/hydev/mcpm/utils/GeneralUtilsTest.java

@@ -1,5 +1,6 @@
 package org.hydev.mcpm.utils;
 
+import org.junit.jupiter.api.Tag;
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
@@ -19,6 +20,7 @@ void makeUrl()
     }
 
     @Test
+    @Tag("IntegrationTest")
     void safeSleep()
     {
         long time = System.currentTimeMillis();