Add test documentation for parser tests

Author: 1whatleytay

src/main/java/org/hydev/mcpm/client/arguments/ControllerFactory.java

@@ -39,7 +39,7 @@ public ListController listController() {
 
     @Override
     public SearchPackagesController searchController() {
-        return new SearchPackagesController(boundary.searchBoundary(), pageBoundary());
+        return new SearchPackagesController(boundary.searchBoundary());
     }
 
     @Override

src/main/java/org/hydev/mcpm/client/arguments/InteractorFactory.java

@@ -1,6 +1,5 @@
 package org.hydev.mcpm.client.arguments;
 
-import org.hydev.mcpm.client.DatabaseManager;
 import org.hydev.mcpm.client.Downloader;
 import org.hydev.mcpm.client.database.fetcher.DatabaseFetcher;
 import org.hydev.mcpm.client.database.fetcher.DatabaseFetcherListener;
@@ -151,10 +150,9 @@ public InstallBoundary installBoundary() {
         var tracker = pluginTracker();
         var searcher = searchBoundary();
         var downloader = pluginDownloader();
-        var manager = new DatabaseManager(tracker, searcher);
         var loader = loadBoundary();
 
-        return cache(InstallInteractor.class, () -> new InstallInteractor(downloader, manager, loader));
+        return cache(InstallInteractor.class, () -> new InstallInteractor(downloader, loader, searcher, tracker));
     }
 
     @Override

src/main/java/org/hydev/mcpm/client/arguments/ParserFactory.java

@@ -14,6 +14,8 @@
 import org.hydev.mcpm.client.arguments.parsers.UninstallParser;
 import org.hydev.mcpm.client.arguments.parsers.UnloadParser;
 import org.hydev.mcpm.client.arguments.parsers.UpdateParser;
+import org.hydev.mcpm.client.display.presenters.InstallPresenter;
+import org.hydev.mcpm.client.display.presenters.SearchPresenter;
 
 import java.util.List;
 import java.util.stream.Stream;
@@ -31,6 +33,9 @@ private ParserFactory() { }
      * @return Returns a list of argument parsers that work in any environment (Server & CLI).
      */
     public static List<CommandParser> baseParsers(ControllerFactoryBoundary factory) {
+        var searchPresenter = new SearchPresenter(factory.pageBoundary());
+        var installPresenter = new InstallPresenter();
+
         /*
          * Add general parsers to this list!
          * All versions of MCPM will have access to these parsers.
@@ -39,10 +44,10 @@ public static List<CommandParser> baseParsers(ControllerFactoryBoundary factory)
         return List.of(
             new ExportPluginsParser(factory.exportController()),
             new ListParser(factory.listController()),
-            new SearchParser(factory.searchController()),
+            new SearchParser(factory.searchController(), searchPresenter),
             new MirrorParser(factory.mirrorController()),
             new InfoParser(factory.infoController()),
-            new InstallParser(factory.installController()),
+            new InstallParser(factory.installController(), installPresenter),
             new RefreshParser(factory.refreshController()),
             new PageParser(factory.pageBoundary()),
             new UninstallParser(factory.uninstallController()),

src/test/java/org/hydev/mcpm/client/arguments/ArgsParserTest.java

@@ -14,7 +14,7 @@
 import static org.junit.jupiter.api.Assertions.assertThrows;
 
 /**
- * Tests for ArgsParser.
+ * Tests for the ArgsParser class (whether it can handle parsing basic commands, etc).
  */
 class ArgsParserTest
 {
@@ -46,8 +46,11 @@ public void configure(Subparser parser)
         }
     }
 
+    /**
+     * Tests whether the argument parser can parse basic strings for a test command.
+     */
     @Test
-    void parse() throws ArgumentParserException
+    void testParse() throws ArgumentParserException
     {
         Consumer<String> out = System.out::println;
         var p = new ArgsParser(List.of(new TestCommand()));
@@ -61,8 +64,11 @@ void parse() throws ArgumentParserException
         assertEquals(p.getRawSubparsers().size(), 1);
     }
 
+    /**
+     * Tests whether the argument parser will fail on invalid invocations.
+     */
     @Test
-    void fail()
+    void testFail()
     {
         Consumer<String> out = System.out::println;
 

src/test/java/org/hydev/mcpm/client/arguments/ExportParserTest.java

@@ -23,12 +23,20 @@
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
+/**
+ * Contains tests for testing the export controller and parser objects.
+ * E.g. whether strings commands will result in correct inputs, call the right methods in the boundary, etc.
+ */
 public class ExportParserTest {
     private MockExportBoundary exporter;
     private ExportPluginsController controller;
 
     private ArgsParser args;
 
+
+    /**
+     * Initializes the various fields (controllers, etc.) before a test starts.
+     */
     @BeforeEach
     public void setup() {
         exporter = new MockExportBoundary();
@@ -37,6 +45,9 @@ public void setup() {
         args = new ArgsParser(List.of(parser));
     }
 
+    /**
+     * Tests if export parser will correctly fail when no arguments are passed.
+     */
     @Test
     void testNoArguments() {
         var exception = assertThrows(
@@ -47,6 +58,9 @@ void testNoArguments() {
         assertEquals(exception.getMessage(), "too few arguments");
     }
 
+    /**
+     * Tests whether an output stream is created when passed an outfile.
+     */
     @Test
     @Tag("IntegrationTest")
     void testWithOutfile() throws ArgumentParserException, IOException {
@@ -64,6 +78,9 @@ void testWithOutfile() throws ArgumentParserException, IOException {
         assertTrue(input.cache());
     }
 
+    /**
+     * Tests whether no-cache is correctly set when the --cache option is provided.
+     */
     @Test
     @Tag("IntegrationTest")
     void testWithNoCache() throws ArgumentParserException, IOException {
@@ -80,6 +97,9 @@ void testWithNoCache() throws ArgumentParserException, IOException {
         assertFalse(input.cache());
     }
 
+    /**
+     * Tests whether the controller will properly generate an input object when invoked.
+     */
     @Test
     void testControllerWithRegularStream() {
         ByteArrayOutputStream stream = new ByteArrayOutputStream();
@@ -93,6 +113,9 @@ void testControllerWithRegularStream() {
         assertTrue(input.cache());
     }
 
+    /**
+     * Tests whether a controller will still fail gracefully when passed a default result.
+     */
     @Test
     void testControllerWithFailState() {
         exporter.setDefaultResult(ExportPluginsResult.State.FAILED_TO_FETCH_PLUGINS);

src/test/java/org/hydev/mcpm/client/arguments/InfoParserTest.java

@@ -18,14 +18,20 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 
+/**
+ * Contains tests for testing the info controller and parser objects.
+ * E.g. whether strings commands will result in correct inputs, call the right methods in the boundary, etc.
+ */
 public class InfoParserTest {
     private AtomicReference<String> output;
     private Consumer<String> log;
-    private MockPluginTracker tracker;
     private InfoController controller;
 
     private ArgsParser args;
 
+    /**
+     * Initializes the various fields (controllers, etc.) before a test starts.
+     */
     @BeforeEach
     public void setup() {
         output = new AtomicReference<>("");
@@ -43,12 +49,16 @@ public void setup() {
             PluginMockFactory.meta("Plugin Plus", "v1.2", "def")
         );
 
-        tracker = new MockPluginTracker(plugins);
+        var tracker = new MockPluginTracker(plugins);
         controller = new InfoController(tracker);
         var parser = new InfoParser(controller);
         args = new ArgsParser(List.of(parser));
     }
 
+
+    /**
+     * Tests if info parser will correctly fail when no arguments are passed.
+     */
     @Test
     void testNoArguments() {
         var exception = assertThrows(
@@ -60,9 +70,12 @@ void testNoArguments() {
     }
 
     // Here we'll be interacting with log strings more since info only writes to log.
-    // Not sure how we can do better than this, we're gonna lock in InfoController into a format.
+    // Not sure how we can do better than this, we will lock in InfoController into a format.
     // This would be moved to presenter when info is moved to presenter.
 
+    /**
+     * Tests whether the info parser will present the correct message when passed a plugin that does not exist.
+     */
     @Test
     void testPluginAbsent() throws ArgumentParserException {
         args.parse(new String[] { "info", "what" }, log);
@@ -71,6 +84,9 @@ void testPluginAbsent() throws ArgumentParserException {
         assertEquals(ColorLogger.trimNoColor(output.get()), expected);
     }
 
+    /**
+     * Tests whether the info parser will print the correct plugin details for a small plugin.
+     */
     @Test
     void testPluginDetails() throws ArgumentParserException {
         args.parse(new String[] { "info", "My Plugin" }, log);
@@ -85,6 +101,9 @@ void testPluginDetails() throws ArgumentParserException {
         assertEquals(ColorLogger.trimNoColor(output.get()), expected);
     }
 
+    /**
+     * Tests whether the info parser will present the correct message when pass a plugin with non-null list/map values.
+     */
     @Test
     void testPluginDetailsExtended() throws ArgumentParserException {
         args.parse(new String[] { "info", "My Plugin2" }, log);
@@ -96,6 +115,25 @@ void testPluginDetailsExtended() throws ArgumentParserException {
 > Version      : v1.1
 > Description  : bc
 > Authors      : Hello world
+> Commands     : comm
+            """.trim() + "\n";
+        assertEquals(ColorLogger.trimNoColor(output.get()), expected);
+    }
+
+    /**
+     * Tests whether the info parser will present the correct message when invoked via controller.
+     */
+    @Test
+    void testPluginDetailsDirectly() {
+        controller.info("My Plugin2", log);
+
+        var expected = """
+Plugin Info:
+> Name         : My Plugin2
+> Main         : org.My Plugin2
+> Version      : v1.1
+> Description  : bc
+> Authors      : Hello world
 > Commands     : comm
             """.trim() + "\n";
         assertEquals(ColorLogger.trimNoColor(output.get()), expected);

src/test/java/org/hydev/mcpm/client/arguments/InstallParserTest.java

@@ -25,6 +25,9 @@ public class InstallParserTest {
 
     private ArgsParser args;
 
+    /**
+     * Initializes the various fields (controllers, etc.) before a test starts.
+     */
     @BeforeEach
     public void setup() {
         installer = new MockInstallBoundary();
@@ -41,6 +44,9 @@ void assertAcceptable(InstallInput input, String name, boolean load) {
         assertTrue(input.isManuallyInstalled());
     }
 
+    /**
+     * Tests if install parser will correctly fail when no arguments are passed.
+     */
     @Test
     void testNoArguments() {
         var exception = assertThrows(
@@ -51,6 +57,9 @@ void testNoArguments() {
         assertEquals(exception.getMessage(), "too few arguments");
     }
 
+    /**
+     * Tests whether the `install` parser will correctly invoke the boundary with one name.
+     */
     @Test
     void testInstallSingleName() throws ArgumentParserException {
 
@@ -61,6 +70,9 @@ void testInstallSingleName() throws ArgumentParserException {
         assertAcceptable(inputs.get(0), "JedCore", true);
     }
 
+    /**
+     * Tests whether the `install` parser will correctly set the noLoad parameter when the --no-load option is provided.
+     */
     @Test
     void testInstallNoLoad() throws ArgumentParserException {
         args.parse(new String[] { "install", "ABC", "--no-load" }, log -> {});
@@ -70,7 +82,9 @@ void testInstallNoLoad() throws ArgumentParserException {
         assertAcceptable(inputs.get(0), "ABC", false);
     }
 
-
+    /**
+     * Tests whether the `install` controller will correctly invoke the boundary (with different package types).
+     */
     @Test
     void testInstallController() {
         controller.install("MyPlugin", SearchPackagesType.BY_COMMAND, false);