RANGER-5577:API for update and delete of resources in DataShare

Author: Ramesh Mani

agents-common/src/main/java/org/apache/ranger/plugin/store/AbstractGdsStore.java

@@ -132,6 +132,10 @@ public RangerSharedResource updateSharedResource(RangerSharedResource resource)
         return null;
     }
 
+    @Override
+    public void updateSharedResources(List<Long> sharedResourceIds) throws Exception {
+    }
+
     @Override
     public void removeSharedResources(List<Long> sharedResourceIds) throws Exception {
     }

agents-common/src/main/java/org/apache/ranger/plugin/store/GdsStore.java

@@ -102,6 +102,8 @@ public interface GdsStore {
 
     RangerSharedResource updateSharedResource(RangerSharedResource resource) throws Exception;
 
+    void updateSharedResources(List<Long> sharedResourceIds) throws Exception;
+
     void removeSharedResources(List<Long> sharedResourceIds) throws Exception;
 
     RangerSharedResource getSharedResource(Long sharedResourceId) throws Exception;

security-admin/src/main/java/org/apache/ranger/biz/GdsDBStore.java

@@ -719,6 +719,27 @@ public RangerSharedResource updateSharedResource(RangerSharedResource resource)
         return ret;
     }
 
+    @Override
+    public void updateSharedResources(List<Long> sharedResourceIds) {
+        LOG.debug("==> updateSharedResources({})", sharedResourceIds);
+
+        for (Long sharedResourceId : sharedResourceIds) {
+            RangerSharedResource existing = null;
+
+            try {
+                existing = sharedResourceService.read(sharedResourceId);
+            } catch (Exception excp) {
+                // ignore
+            }
+
+            if (existing != null) {
+                updateSharedResource(existing);
+            }
+        }
+
+        LOG.debug("<== updateSharedResources({})", sharedResourceIds);
+    }
+
     @Override
     public void removeSharedResources(List<Long> sharedResourceIds) {
         LOG.debug("==> removeSharedResources({})", sharedResourceIds);

security-admin/src/main/java/org/apache/ranger/rest/GdsREST.java

@@ -1261,6 +1261,47 @@ public RangerSharedResource updateSharedResource(@PathParam("id") Long resourceI
         return ret;
     }
 
+    @PUT
+    @Path("/resources")
+    @Consumes("application/json")
+    @Produces("application/json")
+    @PreAuthorize("@rangerPreAuthSecurityHandler.isAPIAccessible(\"" + RangerAPIList.UPDATE_SHARED_RESOURCES + "\")")
+    public void updateSharedResources(@QueryParam("forceDelete") @DefaultValue("false") boolean forceDelete, List<Long> resourceIds) {
+        LOG.debug("==> GdsREST.updateSharedResources(resourceIds={}, forceDelete={})", resourceIds, forceDelete);
+
+        RangerPerfTracer perf = null;
+
+        try {
+            if (resourceIds == null) {
+                throw new Exception("resourceIds must not be null");
+            }
+
+            if (resourceIds.size() > SHARED_RESOURCES_MAX_BATCH_SIZE) {
+                throw new Exception("updateSharedResources batch size exceeded the configured limit: Maximum allowed is " + SHARED_RESOURCES_MAX_BATCH_SIZE);
+            }
+
+            if (RangerPerfTracer.isPerfTraceEnabled(PERF_LOG)) {
+                perf = RangerPerfTracer.getPerfTracer(PERF_LOG, "GdsREST.updateSharedResources(" + resourceIds + ",forceDelete=" + forceDelete + ")");
+            }
+
+            if (forceDelete) {
+                gdsStore.removeSharedResources(resourceIds);
+            } else {
+                gdsStore.updateSharedResources(resourceIds);
+            }
+        } catch (WebApplicationException excp) {
+            throw excp;
+        } catch (Throwable excp) {
+            LOG.error("updateSharedResources(resourceIds={}, forceDelete={}) failed", resourceIds, forceDelete, excp);
+
+            throw restErrorUtil.createRESTException(excp.getMessage());
+        } finally {
+            RangerPerfTracer.log(perf);
+        }
+
+        LOG.debug("<== GdsREST.updateSharedResources(resourceIds={}, forceDelete={})", resourceIds, forceDelete);
+    }
+
     @DELETE
     @Path("/resource/{id}")
     @Produces("application/json")

security-admin/src/main/java/org/apache/ranger/security/context/RangerAPIList.java

@@ -237,6 +237,7 @@ public class RangerAPIList {
     public static final String ADD_SHARED_RESOURCE     = "GdsREST.addSharedResource";
     public static final String ADD_SHARED_RESOURCES    = "GdsREST.addSharedResources";
     public static final String UPDATE_SHARED_RESOURCE  = "GdsREST.updateSharedResource";
+    public static final String UPDATE_SHARED_RESOURCES = "GdsREST.updateSharedResources";
     public static final String REMOVE_SHARED_RESOURCE  = "GdsREST.removeSharedResource";
     public static final String REMOVE_SHARED_RESOURCES = "GdsREST.removeSharedResources";
     public static final String GET_SHARED_RESOURCE     = "GdsREST.getSharedResource";

security-admin/src/main/java/org/apache/ranger/security/context/RangerAPIMapping.java

@@ -547,6 +547,7 @@ private void mapGDSWithAPIs() {
         apiAssociatedWithGDS.add(RangerAPIList.ADD_SHARED_RESOURCE);
         apiAssociatedWithGDS.add(RangerAPIList.ADD_SHARED_RESOURCES);
         apiAssociatedWithGDS.add(RangerAPIList.UPDATE_SHARED_RESOURCE);
+        apiAssociatedWithGDS.add(RangerAPIList.UPDATE_SHARED_RESOURCES);
         apiAssociatedWithGDS.add(RangerAPIList.REMOVE_SHARED_RESOURCE);
         apiAssociatedWithGDS.add(RangerAPIList.REMOVE_SHARED_RESOURCES);
         apiAssociatedWithGDS.add(RangerAPIList.GET_SHARED_RESOURCE);

security-admin/src/test/java/org/apache/ranger/rest/TestGdsREST.java

@@ -924,6 +924,48 @@ public void testRemoveSharedResource() {
         verify(gdsStore).removeSharedResources(Arrays.asList(resourceId));
     }
 
+    @Test
+    public void testUpdateSharedResources_updatesWhenNotForceDelete() throws Exception {
+        List<Long> resourceIds = Arrays.asList(1L, 2L, 3L);
+
+        doNothing().when(gdsStore).updateSharedResources(resourceIds);
+
+        gdsREST.updateSharedResources(false, resourceIds);
+
+        verify(gdsStore).updateSharedResources(resourceIds);
+        verify(gdsStore, Mockito.never()).removeSharedResources(Mockito.anyList());
+    }
+
+    @Test
+    public void testUpdateSharedResources_deletesWhenForceDelete() throws Exception {
+        List<Long> resourceIds = Arrays.asList(1L, 2L, 3L);
+
+        doNothing().when(gdsStore).removeSharedResources(resourceIds);
+
+        gdsREST.updateSharedResources(true, resourceIds);
+
+        verify(gdsStore).removeSharedResources(resourceIds);
+        verify(gdsStore, Mockito.never()).updateSharedResources(Mockito.anyList());
+    }
+
+    @Test
+    public void testUpdateSharedResourcesBatchSizeExceeded() {
+        List<Long> resourceIds = new ArrayList<>();
+        for (long i = 0; i < 101; i++) {
+            resourceIds.add(i);
+        }
+        Mockito.when(restErrorUtil.createRESTException(Mockito.anyString())).thenReturn(new WebApplicationException());
+
+        assertThrows(WebApplicationException.class, () -> gdsREST.updateSharedResources(false, resourceIds));
+    }
+
+    @Test
+    public void testUpdateSharedResourcesNullResourceIds() {
+        Mockito.when(restErrorUtil.createRESTException(Mockito.anyString())).thenReturn(new WebApplicationException());
+
+        assertThrows(WebApplicationException.class, () -> gdsREST.updateSharedResources(false, null));
+    }
+
     @Test
     public void testRemoveSharedResourceException() {
         Mockito.doThrow(new RuntimeException("err")).when(gdsStore).removeSharedResources(any(List.class));