Make filtering parameters dynamic for LIST namespace API (#505)

* Namespace controller search param

* Javadoc

Author: ThomasCAI-mlv

src/main/java/com/michelin/ns4kafka/controller/NamespaceController.java

@@ -46,6 +46,7 @@
 import java.util.Collections;
 import java.util.Date;
 import java.util.List;
+import java.util.Map;
 import java.util.Optional;
 
 /**
@@ -59,21 +60,21 @@ public class NamespaceController extends NonNamespacedResourceController {
     NamespaceService namespaceService;
 
     /**
-     * List namespaces, filtered by namespace name and topic name parameters.
+     * List namespaces, which can be filtered based on optional search query parameters.
      *
-     * @param name  The namespace name parameter
-     * @param topic The topic name parameter
+     * @param search The map of optional query parameters used to filter namespaces. Supported parameters are:
+     *               - name: matches the namespace name. Wildcard supported.
+     *               - topic: find namespace owner of the given topic name.
      * @return A list of namespaces
      */
-    @Get
-    public List<Namespace> list(@QueryValue(defaultValue = "*") String name,
-                                @QueryValue(defaultValue = "") String topic) {
-        List<Namespace> namespaces = namespaceService.findByWildcardName(name);
+    @Get("{?search*}")
+    public List<Namespace> list(@QueryValue Map<String, String> search) {
+        List<Namespace> namespaces = namespaceService.findByWildcardName(search.getOrDefault("name", "*"));
 
-        return topic.isEmpty() ? namespaces :
-            namespaceService.findByTopicName(namespaces, topic)
+        return search.containsKey("topic")
+            ? namespaceService.findByTopicName(namespaces, search.get("topic"))
                 .map(Collections::singletonList)
-                .orElse(List.of());
+                .orElse(List.of()) : namespaces;
     }
 
     /**

src/main/java/com/michelin/ns4kafka/service/NamespaceService.java

@@ -101,7 +101,7 @@ public List<Namespace> findByWildcardName(String name) {
     }
 
     /**
-     * Find the namespace which are owner of the given topic name, out of the given list.
+     * Find the namespace which is owner of the given topic name, out of the given list.
      *
      * @param namespaces The namespaces list
      * @param topic      The topic name to search

src/test/java/com/michelin/ns4kafka/controller/NamespaceControllerTest.java

@@ -63,7 +63,7 @@ class NamespaceControllerTest {
     NamespaceController namespaceController;
 
     @Test
-    void shouldListNamespacesWithWildcardParameter() {
+    void shouldListNamespaces() {
         Namespace ns1 = Namespace.builder()
             .metadata(Metadata.builder()
                 .name("ns1")
@@ -79,7 +79,27 @@ void shouldListNamespacesWithWildcardParameter() {
         when(namespaceService.findByWildcardName("*"))
             .thenReturn(List.of(ns1, ns2));
 
-        assertEquals(List.of(ns1, ns2), namespaceController.list("*", ""));
+        assertEquals(List.of(ns1, ns2), namespaceController.list(Map.of()));
+    }
+
+    @Test
+    void shouldListNamespacesWithWildcardNameParameter() {
+        Namespace ns1 = Namespace.builder()
+            .metadata(Metadata.builder()
+                .name("ns1")
+                .build())
+            .build();
+
+        Namespace ns2 = Namespace.builder()
+            .metadata(Metadata.builder()
+                .name("ns2")
+                .build())
+            .build();
+
+        when(namespaceService.findByWildcardName("*"))
+            .thenReturn(List.of(ns1, ns2));
+
+        assertEquals(List.of(ns1, ns2), namespaceController.list(Map.of("name", "*")));
     }
 
     @Test
@@ -93,7 +113,7 @@ void shouldListNamespacesWithNameParameter() {
         when(namespaceService.findByWildcardName("ns"))
             .thenReturn(List.of(ns));
 
-        assertEquals(List.of(ns), namespaceController.list("ns", ""));
+        assertEquals(List.of(ns), namespaceController.list(Map.of("name", "ns")));
     }
 
     @Test
@@ -106,10 +126,10 @@ void shouldListNamespaceFilteredByTopic() {
 
         when(namespaceService.findByWildcardName("*"))
             .thenReturn(List.of(ns));
-        when(namespaceService.findByTopicName(List.of(ns), "topic"))
+        when(namespaceService.findByTopicName(List.of(ns), "myTopicName"))
             .thenReturn(Optional.of(ns));
 
-        assertEquals(List.of(ns), namespaceController.list("*", "topic"));
+        assertEquals(List.of(ns), namespaceController.list(Map.of("topic", "myTopicName")));
     }
 
     @Test
@@ -122,16 +142,16 @@ void shouldListNoNamespaceFilteredByTopic() {
 
         when(namespaceService.findByWildcardName("*"))
             .thenReturn(List.of(ns));
-        when(namespaceService.findByTopicName(List.of(ns), "topic"))
+        when(namespaceService.findByTopicName(List.of(ns), "myTopicName"))
             .thenReturn(Optional.empty());
 
-        assertEquals(List.of(), namespaceController.list("*", "topic"));
+        assertEquals(List.of(), namespaceController.list(Map.of("topic", "myTopicName")));
     }
 
     @Test
     void shouldListNamespacesWhenEmpty() {
         when(namespaceService.findByWildcardName("*")).thenReturn(List.of());
-        assertEquals(List.of(), namespaceController.list("*", ""));
+        assertEquals(List.of(), namespaceController.list(Map.of()));
     }
 
     @Test