add group match endpoint

Author: vladak

apiary.apib

@@ -325,6 +325,23 @@ This includes also projects of any sub-groups.
 
             ^foo-.*
 
+## Group match [/groups/{group}/match]
+
+### check if (project) name matches group pattern [POST]
+
++ Request (text/plain)
+  + Body
+
+            name of the project
+
++ Response 200
+
+    match
+
++ Response 204
+
+    no match
+
 ## Projects [/projects]
 
 ### returns a list of all projects [GET]

opengrok-indexer/src/main/java/org/opengrok/indexer/configuration/Group.java

@@ -234,10 +234,20 @@ public void setFlag(int flag) {
      * Test group for a match.
      *
      * @param p project
-     * @return true if project's description matches the group pattern
+     * @return true if project's name matches the group pattern
      */
     public boolean match(Project p) {
-        return compiledPattern.matcher(p.getName()).matches();
+        return match(p.getName());
+    }
+
+    /**
+     * Test group for a match.
+     *
+     * @param name string to match
+     * @return true if given name matches the group pattern
+     */
+    public boolean match(String name) {
+        return compiledPattern.matcher(name).matches();
     }
 
     @Override

opengrok-web/src/main/java/org/opengrok/web/api/v1/controller/GroupsController.java

@@ -22,7 +22,9 @@
  */
 package org.opengrok.web.api.v1.controller;
 
+import jakarta.ws.rs.Consumes;
 import jakarta.ws.rs.GET;
+import jakarta.ws.rs.POST;
 import jakarta.ws.rs.Path;
 import jakarta.ws.rs.PathParam;
 import jakarta.ws.rs.Produces;
@@ -58,6 +60,7 @@ public List<String> listGroups() {
     @Path("/{group}/allprojects")
     @Produces(MediaType.APPLICATION_JSON)
     public Response getAllProjectsForGroup(@PathParam("group") String groupName) {
+        // Avoid classification as a taint bug.
         groupName = Laundromat.launderInput(groupName);
         Group group;
         group = Group.getByName(groupName);
@@ -78,6 +81,7 @@ public Response getAllProjectsForGroup(@PathParam("group") String groupName) {
     @Path("/{group}/pattern")
     @Produces(MediaType.TEXT_PLAIN)
     public Response getPattern(@PathParam("group") String groupName) {
+        // Avoid classification as a taint bug.
         groupName = Laundromat.launderInput(groupName);
         Group group;
         group = Group.getByName(groupName);
@@ -87,4 +91,26 @@ public Response getPattern(@PathParam("group") String groupName) {
 
         return Response.ok().entity(group.getPattern()).build();
     }
+
+    @POST
+    @Consumes(MediaType.TEXT_PLAIN)
+    @Path("/{group}/match")
+    public Response matchProject(@PathParam("group") String groupName, String projectNameParam) {
+        // Avoid classification as a taint bug.
+        final String projectName = Laundromat.launderInput(projectNameParam);
+
+        // Avoid classification as a taint bug.
+        groupName = Laundromat.launderInput(groupName);
+        Group group;
+        group = Group.getByName(groupName);
+        if (group == null) {
+            return Response.status(Response.Status.NOT_FOUND).build();
+        }
+
+        if (group.match(projectName)) {
+            return Response.ok().build();
+        } else {
+            return Response.status(Response.Status.NO_CONTENT).build();
+        }
+    }
 }

opengrok-web/src/test/java/org/opengrok/web/api/v1/controller/GroupsControllerTest.java

@@ -23,8 +23,10 @@
 package org.opengrok.web.api.v1.controller;
 
 import jakarta.ws.rs.NotFoundException;
+import jakarta.ws.rs.client.Entity;
 import jakarta.ws.rs.core.Application;
 import jakarta.ws.rs.core.GenericType;
+import jakarta.ws.rs.core.Response;
 import org.glassfish.jersey.server.ResourceConfig;
 import org.junit.jupiter.api.Test;
 import org.opengrok.indexer.configuration.Group;
@@ -154,6 +156,22 @@ void testGetAllProjects() {
                 groupsResult);
     }
 
+    @Test
+    void testGetPatternNoGroup() {
+        String groupName = "group-pattern";
+        final String groupPattern = "^project-.*";
+        setGroup(groupName, groupPattern);
+
+        GenericType<String> type = new GenericType<>() {
+        };
+
+        assertThrows(NotFoundException.class, () -> target("groups")
+                .path(groupName + "1")
+                .path("pattern")
+                .request()
+                .get(type));
+    }
+
     @Test
     void testGetPattern() {
         String groupName = "group-pattern";
@@ -171,4 +189,46 @@ void testGetPattern() {
         assertNotNull(pattern);
         assertEquals(groupPattern, pattern);
     }
+
+    @Test
+    void testMatchNoGroup() {
+        String groupName = "group-pattern-positive";
+        final String groupPattern = "^project-.*";
+        setGroup(groupName, groupPattern);
+
+        Response response = target("groups")
+                .path(groupName + "bar")
+                .path("match")
+                .request()
+                .post(Entity.text("project-foo"));
+        assertEquals(Response.Status.NOT_FOUND.getStatusCode(), response.getStatus());
+    }
+
+    @Test
+    void testMatchPositive() {
+        String groupName = "group-pattern-positive";
+        final String groupPattern = "^project-.*";
+        setGroup(groupName, groupPattern);
+
+        Response response = target("groups")
+                .path(groupName)
+                .path("match")
+                .request()
+                .post(Entity.text("project-foo"));
+        assertEquals(Response.Status.OK.getStatusCode(), response.getStatus());
+    }
+
+    @Test
+    void testMatchNegative() {
+        String groupName = "group-pattern-negative";
+        final String groupPattern = "^project-.*";
+        setGroup(groupName, groupPattern);
+
+        Response response = target("groups")
+                .path(groupName)
+                .path("match")
+                .request()
+                .post(Entity.text("proj"));
+        assertEquals(Response.Status.NO_CONTENT.getStatusCode(), response.getStatus());
+    }
 }