ACS-7587 Implement bulk cancellations

amps/ags/rm-automation/rm-automation-community-rest-api/src/main/java/org/alfresco/rest/rm/community/model/hold/BulkBodyCancel.java

@@ -0,0 +1,41 @@
+/*-
+ * #%L
+ * Alfresco Records Management Module
+ * %%
+ * Copyright (C) 2005 - 2024 Alfresco Software Limited
+ * %%
+ * This file is part of the Alfresco software.
+ * -
+ * If the software was purchased under a paid Alfresco license, the terms of
+ * the paid license agreement will prevail.  Otherwise, the software is
+ * provided under the following open source license terms:
+ * -
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * -
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ * -
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ * #L%
+ */
+package org.alfresco.rest.rm.community.model.hold;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Builder
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+public class BulkBodyCancel
+{
+    private String reason;
+}

amps/ags/rm-automation/rm-automation-community-rest-api/src/main/java/org/alfresco/rest/rm/community/model/hold/HoldBulkOperation.java

@@ -31,7 +31,6 @@
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Data;
-import lombok.EqualsAndHashCode;
 import lombok.NoArgsConstructor;
 import org.alfresco.rest.search.RestRequestQueryModel;
 import org.alfresco.utility.model.TestModel;
@@ -41,7 +40,6 @@
  *
  * @author Damian Ujma
  */
-@EqualsAndHashCode(callSuper = true)
 @Builder
 @Data
 @NoArgsConstructor
@@ -57,4 +55,5 @@ public enum HoldBulkOperationType
     private RestRequestQueryModel query;
     @JsonProperty(required = true)
     private HoldBulkOperationType op;
+
 }

amps/ags/rm-automation/rm-automation-community-rest-api/src/main/java/org/alfresco/rest/rm/community/model/hold/HoldBulkStatus.java

@@ -57,12 +57,11 @@ public class HoldBulkStatus extends TestModel
 
     private String lastError;
 
-    private Status status;
+    private String status;
 
-    public enum Status
-    {
-        PENDING,
-        IN_PROGRESS,
-        DONE
-    }
+    private boolean isCancelled;
+
+    private String cancellationReason;
+
+    private HoldBulkOperation holdBulkOperation;
 }

amps/ags/rm-automation/rm-automation-community-rest-api/src/main/java/org/alfresco/rest/rm/community/requests/gscore/api/HoldsAPI.java

@@ -38,6 +38,7 @@
 import static org.springframework.http.HttpMethod.PUT;
 
 import org.alfresco.rest.core.RMRestWrapper;
+import org.alfresco.rest.rm.community.model.hold.BulkBodyCancel;
 import org.alfresco.rest.rm.community.model.hold.Hold;
 import org.alfresco.rest.rm.community.model.hold.HoldBulkOperation;
 import org.alfresco.rest.rm.community.model.hold.HoldBulkOperationEntry;
@@ -400,4 +401,46 @@ public HoldBulkStatusCollection getBulkStatuses(String holdId)
         return getBulkStatuses(holdId, EMPTY);
     }
 
+    /**
+     * Cancels a bulk operation for a hold.
+     *
+     * @param holdId The identifier of a hold
+     * @param bulkStatusId The identifier of a bulk status operation
+     * @param bulkBodyCancel The bulk body cancel model
+     * @param parameters The URL parameters to add
+     * @throws RuntimeException for the following cases:
+     * <ul>
+     *     <li>{@code holdId}, {@code bulkStatusId} or {@code bulkBodyCancel} is invalid</li>
+     *     <li>authentication fails</li>
+     *     <li>current user does not have permission to cancel the bulk operation for {@code bulkStatusId}</li>
+     *     <li>{@code holdId} or {@code bulkStatusId} does not exist</li>
+     * </ul>
+     */
+    public void cancelBulkOperation(String holdId, String bulkStatusId, BulkBodyCancel bulkBodyCancel, String parameters)
+    {
+        mandatoryString("holdId", holdId);
+        mandatoryString("bulkStatusId", bulkStatusId);
+        mandatoryObject("bulkBodyCancel", bulkBodyCancel);
+
+        getRmRestWrapper().processEmptyModel(requestWithBody(
+            POST,
+            toJson(bulkBodyCancel),
+            "holds/{holdId}/bulk-statuses/{bulkStatusId}/cancel",
+            holdId,
+            bulkStatusId,
+            parameters
+                                                          ));
+    }
+
+    /**
+     * See {@link #cancelBulkOperation(String, String, BulkBodyCancel, String)}
+     */
+    public void cancelBulkOperation(String holdId, String bulkStatusId, BulkBodyCancel bulkBodyCancel)
+    {
+        mandatoryString("holdId", holdId);
+        mandatoryString("bulkStatusId", bulkStatusId);
+        mandatoryObject("bulkBodyCancel", bulkBodyCancel);
+
+        cancelBulkOperation(holdId, bulkStatusId, bulkBodyCancel, EMPTY);
+    }
 }

amps/ags/rm-automation/rm-automation-community-rest-api/src/test/java/org/alfresco/rest/rm/community/hold/AddToHoldsBulkV1Tests.java

@@ -41,22 +41,24 @@
 import static org.springframework.http.HttpStatus.BAD_REQUEST;
 import static org.springframework.http.HttpStatus.FORBIDDEN;
 import static org.springframework.http.HttpStatus.NOT_FOUND;
+import static org.springframework.http.HttpStatus.OK;
 import static org.springframework.http.HttpStatus.UNAUTHORIZED;
 
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
+import java.util.Objects;
 import java.util.concurrent.TimeUnit;
 
 import org.alfresco.dataprep.CMISUtil;
 import org.alfresco.dataprep.ContentActions;
 import org.alfresco.rest.rm.community.base.BaseRMRestTest;
+import org.alfresco.rest.rm.community.model.hold.BulkBodyCancel;
 import org.alfresco.rest.rm.community.model.hold.Hold;
 import org.alfresco.rest.rm.community.model.hold.HoldBulkOperation;
 import org.alfresco.rest.rm.community.model.hold.HoldBulkOperation.HoldBulkOperationType;
 import org.alfresco.rest.rm.community.model.hold.HoldBulkOperationEntry;
 import org.alfresco.rest.rm.community.model.hold.HoldBulkStatus;
-import org.alfresco.rest.rm.community.model.hold.HoldBulkStatus.Status;
 import org.alfresco.rest.rm.community.model.hold.HoldBulkStatusCollection;
 import org.alfresco.rest.rm.community.model.hold.HoldBulkStatusEntry;
 import org.alfresco.rest.rm.community.model.hold.HoldChild;
@@ -167,12 +169,13 @@ public void addContentFromTestSiteToHoldUsingBulkAPI()
         STEP("Check the bulk status.");
         HoldBulkStatus holdBulkStatus = getRestAPIFactory().getHoldsAPI(userAddHoldPermission)
             .getBulkStatus(hold.getId(), bulkOperationEntry.getBulkStatusId());
-        assertBulkProcessStatus(holdBulkStatus, NUMBER_OF_FILES, 0, null);
+        assertBulkProcessStatus(holdBulkStatus, NUMBER_OF_FILES, 0, null, holdBulkOperation);
 
         STEP("Check the bulk statuses.");
         HoldBulkStatusCollection holdBulkStatusCollection = getRestAPIFactory().getHoldsAPI(userAddHoldPermission)
             .getBulkStatuses(hold.getId());
-        assertEquals(Arrays.asList(holdBulkStatus), holdBulkStatusCollection.getEntries().stream().map(HoldBulkStatusEntry::getEntry).toList());
+        assertEquals(Arrays.asList(holdBulkStatus),
+            holdBulkStatusCollection.getEntries().stream().map(HoldBulkStatusEntry::getEntry).toList());
     }
 
     /**
@@ -217,12 +220,13 @@ public void addContentFromFolderAndAllSubfoldersToHoldUsingBulkAPI()
         STEP("Check the bulk status.");
         HoldBulkStatus holdBulkStatus = getRestAPIFactory().getHoldsAPI(userAddHoldPermission)
             .getBulkStatus(hold3.getId(), bulkOperationEntry.getBulkStatusId());
-        assertBulkProcessStatus(holdBulkStatus, NUMBER_OF_FILES, 0, null);
+        assertBulkProcessStatus(holdBulkStatus, NUMBER_OF_FILES, 0, null, bulkOperation);
 
         STEP("Check the bulk statuses.");
         HoldBulkStatusCollection holdBulkStatusCollection = getRestAPIFactory().getHoldsAPI(userAddHoldPermission)
             .getBulkStatuses(hold3.getId());
-        assertEquals(Arrays.asList(holdBulkStatus), holdBulkStatusCollection.getEntries().stream().map(HoldBulkStatusEntry::getEntry).toList());
+        assertEquals(List.of(holdBulkStatus),
+            holdBulkStatusCollection.getEntries().stream().map(HoldBulkStatusEntry::getEntry).toList());
     }
 
     /**
@@ -300,12 +304,13 @@ public void testBulkProcessWithUserWithoutWritePermissionOnTheContent()
         assertStatusCode(ACCEPTED);
 
         await().atMost(20, TimeUnit.SECONDS).until(() ->
-            getRestAPIFactory().getHoldsAPI(userWithoutPermission)
-                .getBulkStatus(hold.getId(), bulkOperationEntry.getBulkStatusId()).getStatus() == Status.DONE);
+            Objects.equals(getRestAPIFactory().getHoldsAPI(userWithoutPermission)
+                .getBulkStatus(hold.getId(), bulkOperationEntry.getBulkStatusId()).getStatus(), "DONE"));
 
         HoldBulkStatus holdBulkStatus = getRestAPIFactory().getHoldsAPI(userWithoutPermission)
             .getBulkStatus(hold.getId(), bulkOperationEntry.getBulkStatusId());
-        assertBulkProcessStatus(holdBulkStatus, NUMBER_OF_FILES, NUMBER_OF_FILES, ACCESS_DENIED_ERROR_MESSAGE);
+        assertBulkProcessStatus(holdBulkStatus, NUMBER_OF_FILES, NUMBER_OF_FILES, ACCESS_DENIED_ERROR_MESSAGE,
+            holdBulkOperation);
     }
 
     /**
@@ -344,7 +349,8 @@ public void testBulkProcessWithUserWithoutWritePermissionOnOneFile()
                 == NUMBER_OF_FILES - 1);
         await().atMost(30, TimeUnit.SECONDS).until(
             () -> getRestAPIFactory().getHoldsAPI(userAddHoldPermission)
-                .getBulkStatus(hold2.getId(), bulkOperationEntry.getBulkStatusId()).getProcessedItems() == NUMBER_OF_FILES);
+                .getBulkStatus(hold2.getId(), bulkOperationEntry.getBulkStatusId()).getProcessedItems()
+                == NUMBER_OF_FILES);
         List<String> holdChildrenNodeRefs = getRestAPIFactory().getHoldsAPI(userAddHoldPermission)
             .getChildren(hold2.getId()).getEntries().stream().map(HoldChildEntry::getEntry).map(
                 HoldChild::getId).toList();
@@ -354,12 +360,13 @@ public void testBulkProcessWithUserWithoutWritePermissionOnOneFile()
         STEP("Check the bulk status.");
         HoldBulkStatus holdBulkStatus = getRestAPIFactory().getHoldsAPI(userAddHoldPermission)
             .getBulkStatus(hold2.getId(), bulkOperationEntry.getBulkStatusId());
-        assertBulkProcessStatus(holdBulkStatus, NUMBER_OF_FILES, 1, ACCESS_DENIED_ERROR_MESSAGE);
+        assertBulkProcessStatus(holdBulkStatus, NUMBER_OF_FILES, 1, ACCESS_DENIED_ERROR_MESSAGE, holdBulkOperation);
 
         STEP("Check the bulk statuses.");
         HoldBulkStatusCollection holdBulkStatusCollection = getRestAPIFactory().getHoldsAPI(userAddHoldPermission)
             .getBulkStatuses(hold2.getId());
-        assertEquals(Arrays.asList(holdBulkStatus), holdBulkStatusCollection.getEntries().stream().map(HoldBulkStatusEntry::getEntry).toList());
+        assertEquals(List.of(holdBulkStatus),
+            holdBulkStatusCollection.getEntries().stream().map(HoldBulkStatusEntry::getEntry).toList());
 
         // Revert the permissions
         contentActions.setPermissionForUser(getAdminUser().getUsername(), getAdminUser().getPassword(),
@@ -489,14 +496,89 @@ public void testExceedingBulkOperationLimit()
         assertStatusCode(BAD_REQUEST);
     }
 
+    /**
+     * Given a user with the add to hold capability and hold filing permission
+     * When the user adds content from a site to a hold using the bulk API
+     * And then the user cancels the bulk operation
+     * Then the user receives OK status code
+     */
+    @Test
+    public void testBulkProcessCancellationWithAllowedUser()
+    {
+        Hold hold4 = getRestAPIFactory().getFilePlansAPI(getAdminUser()).createHold(
+            Hold.builder().name("HOLD" + generateTestPrefix(AddToHoldsV1Tests.class)).description(HOLD_DESCRIPTION)
+                .reason(HOLD_REASON).build(), FILE_PLAN_ALIAS);
+        holds.add(hold4);
+
+        UserModel userAddHoldPermission = roleService.createUserWithSiteRoleRMRoleAndPermission(testSite,
+            UserRole.SiteCollaborator, hold4.getId(), UserRoles.ROLE_RM_MANAGER, PERMISSION_FILING);
+        users.add(userAddHoldPermission);
+
+        STEP("Add content from the site to the hold using the bulk API.");
+        HoldBulkOperationEntry bulkOperationEntry = getRestAPIFactory().getHoldsAPI(userAddHoldPermission)
+            .startBulkProcess(holdBulkOperation, hold4.getId());
+
+        // Verify the status code
+        assertStatusCode(ACCEPTED);
+        assertEquals(NUMBER_OF_FILES, bulkOperationEntry.getTotalItems());
+
+        STEP("Cancel the bulk operation.");
+        getRestAPIFactory().getHoldsAPI(userAddHoldPermission)
+            .cancelBulkOperation(hold4.getId(), bulkOperationEntry.getBulkStatusId(), new BulkBodyCancel());
+
+        // Verify the status code
+        assertStatusCode(OK);
+    }
+
+    /**
+     * Given a user with the add to hold capability and hold filing permission
+     * When the user adds content from a site to a hold using the bulk API
+     * And a 2nd user without the add to hold capability cancels the bulk operation
+     * Then the 2nd user receives access denied error
+     */
+    @Test
+    public void testBulkProcessCancellationWithUserWithoutAddToHoldCapability()
+    {
+        Hold hold5 = getRestAPIFactory().getFilePlansAPI(getAdminUser()).createHold(
+            Hold.builder().name("HOLD" + generateTestPrefix(AddToHoldsV1Tests.class)).description(HOLD_DESCRIPTION)
+                .reason(HOLD_REASON).build(), FILE_PLAN_ALIAS);
+        holds.add(hold5);
+
+        UserModel userAddHoldPermission = roleService.createUserWithSiteRoleRMRoleAndPermission(testSite,
+            UserRole.SiteCollaborator, hold5.getId(), UserRoles.ROLE_RM_MANAGER, PERMISSION_FILING);
+        users.add(userAddHoldPermission);
+
+        STEP("Add content from the site to the hold using the bulk API.");
+        HoldBulkOperationEntry bulkOperationEntry = getRestAPIFactory().getHoldsAPI(userAddHoldPermission)
+            .startBulkProcess(holdBulkOperation, hold5.getId());
+
+        // Verify the status code
+        assertStatusCode(ACCEPTED);
+        assertEquals(NUMBER_OF_FILES, bulkOperationEntry.getTotalItems());
+
+        UserModel userWithoutAddToHoldCapability = roleService.createUserWithSiteRoleRMRoleAndPermission(testSite,
+            UserRole
+                .SiteCollaborator,
+            hold5.getId(), UserRoles.ROLE_RM_POWER_USER, PERMISSION_FILING);
+        users.add(userWithoutAddToHoldCapability);
+
+        STEP("Cancel the bulk operation.");
+        getRestAPIFactory().getHoldsAPI(userWithoutAddToHoldCapability)
+            .cancelBulkOperation(hold5.getId(), bulkOperationEntry.getBulkStatusId(), new BulkBodyCancel());
+
+        STEP("Verify the response status code and the error message.");
+        assertStatusCode(FORBIDDEN);
+        getRestAPIFactory().getRmRestWrapper().assertLastError().containsSummary(ACCESS_DENIED_ERROR_MESSAGE);
+    }
 
     private void assertBulkProcessStatus(HoldBulkStatus holdBulkStatus, long expectedProcessedItems,
-        int expectedErrorsCount, String expectedErrorMessage)
+        int expectedErrorsCount, String expectedErrorMessage, HoldBulkOperation holdBulkOperation)
     {
-        assertEquals(Status.DONE, holdBulkStatus.getStatus());
+        assertEquals("DONE", holdBulkStatus.getStatus());
         assertEquals(expectedProcessedItems, holdBulkStatus.getTotalItems());
         assertEquals(expectedProcessedItems, holdBulkStatus.getProcessedItems());
         assertEquals(expectedErrorsCount, holdBulkStatus.getErrorsCount());
+        assertEquals(holdBulkStatus.getHoldBulkOperation(), holdBulkOperation);
         assertNotNull(holdBulkStatus.getStartTime());
         assertNotNull(holdBulkStatus.getEndTime());
 

amps/ags/rm-automation/rm-automation-community-rest-api/src/test/resources/default.properties

@@ -45,9 +45,9 @@ serverHealth.showTenants=false
 # testManagement.username=<username>
 # testManagement.apiKey=<api-key>
 # testManagement.project=<id-of-your-project
-# testManagement.testRun=<test-run-name> 
+# testManagement.testRun=<test-run-name>
 # testManagement.includeOnlyTestCasesExecuted=true #if you want to include in your run ONLY the test cases that you run, then set this value to false
-# testManagement.rateLimitInSeconds=1 #is the default rate limit after what minimum time, should we upload the next request. http://docs.gurock.com/testrail-api2/introduction #Rate Limit 
+# testManagement.rateLimitInSeconds=1 #is the default rate limit after what minimum time, should we upload the next request. http://docs.gurock.com/testrail-api2/introduction #Rate Limit
 # testManagement.suiteId=23 (the id of the Master suite)
 # ------------------------------------------------------
 testManagement.enabled=false
@@ -72,7 +72,7 @@ reports.path=./target/reports
 #
 # MySQL:
 # db.url = jdbc:mysql://${alfresco.server}:3306/alfresco
-# 
+#
 # PostgreSQL:
 # db.url = jdbc:postgresql://<your-DB-IP>:3306/alfresco
 #

amps/ags/rm-community/rm-community-repo/config/alfresco/module/org_alfresco_module_rm/alfresco-global.properties

@@ -153,7 +153,12 @@ rm.hold.bulk.batchSize=100
 rm.hold.bulk.logging.interval=100
 # The number of entries we process at a time in a transaction.
 rm.hold.bulk.itemsPerTransaction=1
+# The maximum number of bulk requests we can process in parallel.
+rm.hold.bulk.maxParallelRequests=10
 
 cache.bulkHoldStatusCache.cluster.type=fully-distributed
+cache.bulkHoldStatusCache.timeToLiveSeconds=2592000
 cache.bulkHoldRegistryCache.cluster.type=fully-distributed
-
+cache.bulkHoldRegistryCache.timeToLiveSeconds=2592000
+cache.bulkCancellationsCache.cluster.type=fully-distributed
+cache.bulkCancellationsCache.timeToLiveSeconds=2592000

amps/ags/rm-community/rm-community-repo/config/alfresco/module/org_alfresco_module_rm/rm-bulk-context.xml

@@ -32,11 +32,15 @@
       <property name="itemsPerTransaction">
          <value>${rm.hold.bulk.itemsPerTransaction}</value>
       </property>
+      <property name="maxParallelRequests">
+         <value>${rm.hold.bulk.maxParallelRequests}</value>
+      </property>
    </bean>
 
    <bean id="holdBulkMonitor" class="org.alfresco.module.org_alfresco_module_rm.bulk.hold.DefaultHoldBulkMonitor">
       <property name="holdProgressCache" ref="holdProgressCache" />
       <property name="holdProcessRegistry" ref="holdProcessRegistry" />
+      <property name="bulkCancellationsCache" ref="bulkCancellationsCache" />
    </bean>
 
 
@@ -48,4 +52,8 @@
       <constructor-arg value="cache.bulkHoldRegistryCache" />
    </bean>
 
+   <bean name="bulkCancellationsCache" factory-bean="cacheFactory" factory-method="createCache">
+      <constructor-arg value="cache.bulkCancellationsCache" />
+   </bean>
+
 </beans>