refactor: preparing search for multiple backends

quintesse · quintesse · commit 867b8aae8785 · 2025-09-03T13:17:51.000+02:00
Also added IT tests for search
diff --git a/src/it/java/org/codejive/jpm/search/SearchIT.java b/src/it/java/org/codejive/jpm/search/SearchIT.java
@@ -0,0 +1,43 @@
+package org.codejive.jpm.search;
+
+import static org.assertj.core.api.Assertions.*;
+
+import java.io.IOException;
+import java.util.Arrays;
+import java.util.List;
+
+import org.codejive.jpm.search.Search;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.EnumSource;
+import org.junit.jupiter.params.provider.FieldSource;
+
+public class SearchIT {
+    @ParameterizedTest
+    @EnumSource(Search.Backends.class)
+    void testSearchSingleTerm(Search.Backends backend) throws IOException {
+        Search s = Search.getBackend(backend);
+        Search.SearchResult res = s.findArtifacts("httpclient", 10);
+        assertThat(res.count).isGreaterThan(0);
+        assertThat(res.artifacts).isNotEmpty();
+    }
+
+    @ParameterizedTest
+    @EnumSource(Search.Backends.class)
+    void testSearchDoubleTerm(Search.Backends backend) throws IOException {
+        Search s = Search.getBackend(backend);
+        Search.SearchResult res = s.findArtifacts("apache:httpclient", 10);
+        assertThat(res.count).isGreaterThan(0);
+        assertThat(res.artifacts).isNotEmpty();
+    }
+
+    @ParameterizedTest
+    @EnumSource(Search.Backends.class)
+    void testSearchTripleTerm(Search.Backends backend) throws IOException {
+        Search s = Search.getBackend(backend);
+        Search.SearchResult res = s.findArtifacts("org.apache.httpcomponents:httpclient:", 10);
+        assertThat(res.count).isGreaterThan(0);
+        assertThat(res.artifacts).isNotEmpty();
+        assertThat(res.artifacts).allMatch(a -> "org.apache.httpcomponents".equals(a.getGroupId()));
+        assertThat(res.artifacts).allMatch(a -> "httpclient".equals(a.getArtifactId()));
+    }
+}
diff --git a/src/main/java/org/codejive/jpm/Jpm.java b/src/main/java/org/codejive/jpm/Jpm.java
@@ -5,6 +5,7 @@
 import java.util.*;
 import java.util.stream.Collectors;
 import org.codejive.jpm.config.AppInfo;
+import org.codejive.jpm.search.Search;
 import org.codejive.jpm.util.*;
 import org.eclipse.aether.artifact.Artifact;
 import org.eclipse.aether.resolution.DependencyResolutionException;
@@ -122,10 +123,11 @@ public SyncResult copy(String[] artifactNames, Map<String, String> repos, boolea
     public String[] search(String artifactPattern, int count) throws IOException {
         List<Artifact> artifacts = new ArrayList<>();
         int max = count <= 0 || count > 200 ? 200 : count;
-        SearchResult result = SearchUtils.findArtifacts(artifactPattern, max);
+        Search s = Search.getBackend(null);
+        Search.SearchResult result = s.findArtifacts(artifactPattern, max);
         while (result != null) {
             artifacts.addAll(result.artifacts);
-            result = count <= 0 ? SearchUtils.findNextArtifacts(result) : null;
+            result = count <= 0 ? s.findNextArtifacts(result) : null;
         }
         return artifacts.stream().map(Jpm::artifactGav).toArray(String[]::new);
     }
diff --git a/src/main/java/org/codejive/jpm/Main.java b/src/main/java/org/codejive/jpm/Main.java
@@ -45,16 +45,16 @@
         versionProvider = Version.class,
         description = "Simple command line tool for managing Maven artifacts",
         subcommands = {
-            Main.Copy.class,
             Main.Search.class,
             Main.Install.class,
+            Main.Copy.class,
             Main.PrintPath.class,
-            Main.Exec.class,
             Main.Do.class,
             Main.Clean.class,
             Main.Build.class,
             Main.Run.class,
-            Main.Test.class
+            Main.Test.class,
+            Main.Exec.class
         })
 public class Main {
 
diff --git a/src/main/java/org/codejive/jpm/search/Search.java b/src/main/java/org/codejive/jpm/search/Search.java
@@ -0,0 +1,92 @@
+package org.codejive.jpm.search;
+
+import java.io.IOException;
+import java.util.Collections;
+import java.util.List;
+import java.util.Objects;
+
+import org.eclipse.aether.artifact.Artifact;
+
+public interface Search {
+
+    /**
+     * Find artifacts matching the given pattern. This will return the first page of results. If the
+     * pattern to search for is a simple name (there are no colons in the string), the search will
+     * match any part of an artifact's group or name. If there's a single colon, the search will
+     * match any part of the group id and artifact id separately. If there are two colons, the
+     * search will match the group id and artifact id exactly, and will return the artifact's
+     * versions.
+     *
+     * @param artifactPattern The pattern to search for.
+     * @param count The maximum number of results to return.
+     * @return The search result as an instance of {@link SearchResult}.
+     * @throws IOException If an error occurred during the search.
+     */
+    SearchResult findArtifacts(String artifactPattern, int count) throws IOException;
+
+    /**
+     * Find the next page of artifacts. This takes a {@link SearchResult} returned by a previous
+     * call to {@link #findArtifacts(String, int)} and returns the next page of results.
+     *
+     * @param prevResult The previous search result.
+     * @return The next search result as an instance of {@link SearchResult}.
+     * @throws IOException If an error occurred during the search.
+     */
+    SearchResult findNextArtifacts(SearchResult prevResult) throws IOException;
+
+    enum Backends {
+        SMO_REST("smo-rest");
+
+        public final String label;
+
+        Backends(String label) {
+            this.label = label;
+        }
+    }
+
+    static Search getBackend(Backends backend) {
+        if (backend == Backends.SMO_REST) {
+            return new SearchSmoRestImpl();
+        }
+        return new SearchSmoRestImpl();
+    }
+
+    /**
+     * Hold the result of a search while also functioning as a kind of bookmark for paging purposes.
+     */
+    class SearchResult {
+        /** The artifacts that matched the search query. */
+        public final List<? extends Artifact> artifacts;
+
+        /** The search query that produced this result. */
+        public final String query;
+
+        /** The index of the first artifact in this result relative to the total result set. */
+        public final int start;
+
+        /** The maximum number of results to return */
+        public final int count;
+
+        /** The total number of artifacts that matched the search query. */
+        public final int total;
+
+        /**
+         * Create a new search result.
+         *
+         * @param artifacts The artifacts that matched the search query.
+         * @param query The search query that produced this result.
+         * @param start The index of the first artifact in this result relative to the total result
+         *     set.
+         * @param count The maximum number of results to return.
+         * @param total The total number of artifacts that matched the search query.
+         */
+        public SearchResult(
+                List<? extends Artifact> artifacts, String query, int start, int count, int total) {
+            this.artifacts = Collections.unmodifiableList(artifacts);
+            this.query = query;
+            this.start = start;
+            this.count = count;
+            this.total = total;
+        }
+    }
+}
diff --git a/src/main/java/org/codejive/jpm/search/SearchSmoRestImpl.java b/src/main/java/org/codejive/jpm/search/SearchSmoRestImpl.java
@@ -1,4 +1,4 @@
-package org.codejive.jpm.util;
+package org.codejive.jpm.search;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -10,6 +10,7 @@
 import org.apache.http.client.methods.HttpGet;
 import org.apache.http.impl.client.CloseableHttpClient;
 import org.apache.http.impl.client.HttpClients;
+import org.codejive.jpm.util.Version;
 import org.eclipse.aether.artifact.DefaultArtifact;
 import org.yaml.snakeyaml.DumperOptions;
 import org.yaml.snakeyaml.LoaderOptions;
@@ -18,7 +19,7 @@
 import org.yaml.snakeyaml.representer.Representer;
 
 /** Utility class for searching Maven artifacts. */
-public class SearchUtils {
+public class SearchSmoRestImpl implements Search {
 
     /**
      * Find artifacts matching the given pattern. This will return the first page of results. If the
@@ -30,31 +31,33 @@ public class SearchUtils {
      *
      * @param artifactPattern The pattern to search for.
      * @param count The maximum number of results to return.
-     * @return The search result as an instance of {@link SearchResult}.
+     * @return The search result as an instance of {@link Search.SearchResult}.
      * @throws IOException If an error occurred during the search.
      */
-    public static SearchResult findArtifacts(String artifactPattern, int count) throws IOException {
+    public Search.SearchResult findArtifacts(String artifactPattern, int count) throws IOException {
         return select(artifactPattern, 0, count);
     }
 
     /**
-     * Find the next page of artifacts. This takes a {@link SearchResult} returned by a previous
-     * call to {@link #findArtifacts(String, int)} and returns the next page of results.
+     * Find the next page of artifacts. This takes a {@link Search.SearchResult} returned by a
+     * previous call to {@link #findArtifacts(String, int)} and returns the next page of results.
      *
      * @param prevResult The previous search result.
-     * @return The next search result as an instance of {@link SearchResult}.
+     * @return The next search result as an instance of {@link Search.SearchResult}.
      * @throws IOException If an error occurred during the search.
      */
-    public static SearchResult findNextArtifacts(SearchResult prevResult) throws IOException {
+    public Search.SearchResult findNextArtifacts(Search.SearchResult prevResult)
+            throws IOException {
         if (prevResult.start + prevResult.count >= prevResult.total) {
             return null;
         }
-        SearchResult result =
+        Search.SearchResult result =
                 select(prevResult.query, prevResult.start + prevResult.count, prevResult.count);
         return result.artifacts.isEmpty() ? null : result;
     }
 
-    private static SearchResult select(String query, int start, int count) throws IOException {
+    private static Search.SearchResult select(String query, int start, int count)
+            throws IOException {
         String[] parts = query.split(":", -1);
         String finalQuery;
         if (parts.length >= 3) {
@@ -106,9 +109,10 @@ private static SearchResult select(String query, int start, int count) throws IO
                 List<DefaultArtifact> artifacts =
                         result.response.docs.stream()
                                 .filter(d -> acceptDoc(d, parts))
-                                .map(SearchUtils::toArtifact)
+                                .map(SearchSmoRestImpl::toArtifact)
                                 .collect(Collectors.toList());
-                return new SearchResult(artifacts, query, start, count, result.response.numFound);
+                return new Search.SearchResult(
+                        artifacts, query, start, count, result.response.numFound);
             }
         }
     }
diff --git a/src/main/java/org/codejive/jpm/util/SearchResult.java b/src/main/java/org/codejive/jpm/util/SearchResult.java
