Added: tweaks and IT for getUserSelectableRoles

Author: GPortas

src/main/java/edu/harvard/iq/dataverse/RoleAssigneeServiceBean.java

@@ -157,21 +157,21 @@ private String getRoleIdListClause(List<Long> roleIdList) {
     }
 
     /**
-     * Retrieves the list of {@link DataverseRole}s relevant for the given {@link DataverseRequest}.
+     * Retrieves the list of {@link DataverseRole}s selectable for the given {@link DataverseRequest}.
      * <p>
      * - If the user is a superuser, all roles are returned.<br>
      * - If the user is not a superuser, their assigned roles are returned. If none are assigned,
      *   all roles are returned as a fallback.
      * <p>
      * This method is based on the logic from {@code MyDataPage.getRolesUsedToCreateCheckboxes}.
      * It has been implemented in this service to make the logic reusable from parts of the application
-     * other than the UI.
+     * other than the JSF UI.
      *
      * @param request the dataverse request containing user context
      * @return a list of relevant {@link DataverseRole}s for the user
      * @throws NullPointerException if the request is null
      */
-    public List<DataverseRole> getAllOrAssigneeDataverseRolesFor(DataverseRequest request) {
+    public List<DataverseRole> getSelectableDataverseRolesFor(DataverseRequest request) {
         if (request == null) {
             throw new NullPointerException(BundleUtil.getStringFromBundle("roleAssigneeServiceBean.error.dataverseRequestCannotBeNull"));
         }

src/main/java/edu/harvard/iq/dataverse/api/Roles.java

@@ -69,8 +69,8 @@ public Response createNewRole(@Context ContainerRequestContext crc,
 
     @GET
     @AuthRequired
-    @Path("assignedRoles")
-    public Response getAssignedRoles(@Context ContainerRequestContext crc) {
-        return response(req -> ok(jsonDataverseRoles(roleAssigneeSvc.getAllOrAssigneeDataverseRolesFor(req))), getRequestUser(crc));
+    @Path("userSelectable")
+    public Response getUserSelectableRoles(@Context ContainerRequestContext crc) {
+        return response(req -> ok(jsonDataverseRoles(roleAssigneeSvc.getSelectableDataverseRolesFor(req))), getRequestUser(crc));
     }
 }

src/test/java/edu/harvard/iq/dataverse/api/RolesIT.java

@@ -1,15 +1,17 @@
 
 package edu.harvard.iq.dataverse.api;
 
+import edu.harvard.iq.dataverse.authorization.DataverseRole;
 import io.restassured.RestAssured;
 import io.restassured.path.json.JsonPath;
 import io.restassured.response.Response;
-import static jakarta.ws.rs.core.Response.Status.FORBIDDEN;
+
 import java.util.logging.Logger;
+
+import static jakarta.ws.rs.core.Response.Status.*;
 import static org.hamcrest.CoreMatchers.equalTo;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
-import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
 
@@ -108,5 +110,48 @@ public void testCreateDeleteRoles() {
         assertEquals("OK", status);
 
     }
-    
+
+    @Test
+    public void testGetUserSelectableRoles() {
+        Response createAdminUser = UtilIT.createRandomUser();
+
+        String adminUsername = UtilIT.getUsernameFromResponse(createAdminUser);
+        String adminApiToken = UtilIT.getApiTokenFromResponse(createAdminUser);
+        UtilIT.makeSuperUser(adminUsername);
+
+        Response createUser = UtilIT.createRandomUser();
+
+        String username = UtilIT.getUsernameFromResponse(createUser);
+        String apiToken = UtilIT.getApiTokenFromResponse(createUser);
+
+        // Non-superuser with no assigned roles: return all roles as fallback.
+
+        Response getUserSelectableRolesResponse = UtilIT.getUserSelectableRoles(apiToken);
+        getUserSelectableRolesResponse.prettyPrint();
+
+        getUserSelectableRolesResponse.then().assertThat()
+                .statusCode(OK.getStatusCode())
+                .body("data.size()", equalTo(8));
+
+        // Non-superuser with assigned role: return assigned role.
+
+        Response createDataverseResponse = UtilIT.createRandomDataverse(adminApiToken);
+        createDataverseResponse.then().assertThat()
+                .statusCode(CREATED.getStatusCode());
+
+        String dataverseAlias = UtilIT.getAliasFromResponse(createDataverseResponse);
+
+        Response grantUserAddDataset = UtilIT.grantRoleOnDataverse(dataverseAlias, DataverseRole.DS_CONTRIBUTOR, "@" + username, adminApiToken);
+
+        grantUserAddDataset.then().assertThat()
+                .statusCode(OK.getStatusCode())
+                .body("data.assignee", equalTo("@" + username))
+                .body("data._roleAlias", equalTo("dsContributor"));
+
+        getUserSelectableRolesResponse = UtilIT.getUserSelectableRoles(apiToken);
+        getUserSelectableRolesResponse.then().assertThat()
+                .statusCode(OK.getStatusCode())
+                .body("data.size()", equalTo(1))
+                .body("data[0].alias", equalTo(DataverseRole.DS_CONTRIBUTOR));
+    }
 }

src/test/java/edu/harvard/iq/dataverse/api/UtilIT.java

@@ -4815,4 +4815,11 @@ public static Response updateDatasetFilesMetadata(String datasetIdOrPersistentId
         return given().header(API_TOKEN_HTTP_HEADER, apiToken).contentType(ContentType.JSON).body(jsonArray.toString())
                 .post("/api/datasets/" + idInPath + "/files/metadata" + optionalQueryParam);
     }
+
+    static Response getUserSelectableRoles(String apiToken) {
+        return given()
+                .header(API_TOKEN_HTTP_HEADER, apiToken)
+                .contentType("application/json")
+                .get("/api/roles/userSelectable");
+    }
 }