mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-10-08 14:51:49 +00:00
Merge branch 'feature/RM-6873_RemoveActiveContentFromHold' into 'master'
RM-6873 adding code to allow for the removal of active content from a hold See merge request records-management/records-management!1216
This commit is contained in:
Ross Gale
@@ -172,30 +172,29 @@ public class FrozenAspect extends BaseBehaviourBean
|
||||
kind = BehaviourKind.CLASS,
|
||||
notificationFrequency = NotificationFrequency.TRANSACTION_COMMIT
|
||||
)
|
||||
public void onRemoveAspect(final NodeRef record, QName aspectTypeQName)
|
||||
public void onRemoveAspect(final NodeRef nodeRef, QName aspectTypeQName)
|
||||
{
|
||||
AuthenticationUtil.runAsSystem((RunAsWork<Void>) () -> {
|
||||
if (nodeService.exists(record) &&
|
||||
isRecord(record))
|
||||
|
||||
if (nodeService.exists(nodeRef) &&
|
||||
(isRecord(nodeRef) || instanceOf(nodeRef, TYPE_CONTENT)))
|
||||
{
|
||||
// get the owning record folder
|
||||
NodeRef recordFolder = nodeService.getPrimaryParent(record).getParentRef();
|
||||
// get the owning folder
|
||||
final NodeRef owningFolder = nodeService.getPrimaryParent(nodeRef).getParentRef();
|
||||
|
||||
// check that the aspect has been added
|
||||
if (nodeService.hasAspect(recordFolder, ASPECT_HELD_CHILDREN))
|
||||
if (nodeService.hasAspect(owningFolder, ASPECT_HELD_CHILDREN))
|
||||
{
|
||||
// decrement current count
|
||||
int currentCount = (Integer) nodeService.getProperty(recordFolder, PROP_HELD_CHILDREN_COUNT);
|
||||
final int currentCount = (Integer) nodeService.getProperty(owningFolder, PROP_HELD_CHILDREN_COUNT);
|
||||
if (currentCount > 0)
|
||||
{
|
||||
currentCount = currentCount - 1;
|
||||
nodeService.setProperty(recordFolder, PROP_HELD_CHILDREN_COUNT, currentCount);
|
||||
nodeService.setProperty(owningFolder, PROP_HELD_CHILDREN_COUNT, currentCount - 1);
|
||||
}
|
||||
}
|
||||
}
|
||||
return null;
|
||||
});
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -0,0 +1,194 @@
|
||||
/*
|
||||
* #%L
|
||||
* Alfresco Records Management Module
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2019 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.module.org_alfresco_module_rm.test.integration.hold;
|
||||
|
||||
import static org.alfresco.repo.security.authentication.AuthenticationUtil.getAdminUserName;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
import org.alfresco.module.org_alfresco_module_rm.test.util.BaseRMTestCase;
|
||||
import org.alfresco.repo.security.authentication.AuthenticationUtil;
|
||||
import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork;
|
||||
import org.alfresco.repo.security.permissions.AccessDeniedException;
|
||||
import org.alfresco.service.cmr.repository.NodeRef;
|
||||
import org.springframework.extensions.webscripts.GUID;
|
||||
|
||||
/**
|
||||
* Remove active content from hold integration tests
|
||||
*
|
||||
* @author Ross Gale
|
||||
* @since 3.2
|
||||
*/
|
||||
public class RemoveActiveContentFromHoldTest extends BaseRMTestCase
|
||||
{
|
||||
@Override
|
||||
protected boolean isCollaborationSiteTest()
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
@Override
|
||||
protected boolean isUserTest()
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Given a piece of active content on hold
|
||||
* When I try to remove the active content from the hold
|
||||
* Then the active content is unfrozen
|
||||
* And the active content is not contained within the hold
|
||||
*/
|
||||
public void testRemoveDocumentFromHold()
|
||||
{
|
||||
doBehaviourDrivenTest(new BehaviourDrivenTest()
|
||||
{
|
||||
private NodeRef hold;
|
||||
Integer before;
|
||||
|
||||
public void given()
|
||||
{
|
||||
hold = holdService.createHold(filePlan, GUID.generate(), GUID.generate(), GUID.generate());
|
||||
holdService.addToHold(hold, dmDocument);
|
||||
}
|
||||
|
||||
public void when()
|
||||
{
|
||||
before = (Integer) nodeService.getProperty(dmFolder, PROP_HELD_CHILDREN_COUNT);
|
||||
holdService.removeFromHold(hold, dmDocument);
|
||||
}
|
||||
|
||||
public void then()
|
||||
{
|
||||
// active content is no longer frozen
|
||||
assertFalse(freezeService.isFrozen(dmDocument));
|
||||
|
||||
// check the content is no longer held
|
||||
assertFalse(holdService.getHeld(hold).contains(dmDocument));
|
||||
assertFalse(holdService.heldBy(dmDocument, true).contains(hold));
|
||||
|
||||
// check the held count on the folder has been reduced
|
||||
assertTrue(before > (Integer) nodeService.getProperty(dmFolder, PROP_HELD_CHILDREN_COUNT));
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Given a piece of active content in multiple holds
|
||||
* When I try to remove the active content from a single hold
|
||||
* Then the active content is still frozen
|
||||
* And the active content is not contained within the specified hold
|
||||
* And is still added to any other holds
|
||||
*/
|
||||
public void testRemoveDocumentFromASingleHold()
|
||||
{
|
||||
doBehaviourDrivenTest(new BehaviourDrivenTest()
|
||||
{
|
||||
private NodeRef hold;
|
||||
private NodeRef hold2;
|
||||
|
||||
public void given()
|
||||
{
|
||||
hold = holdService.createHold(filePlan, GUID.generate(), GUID.generate(), GUID.generate());
|
||||
hold2 = holdService.createHold(filePlan, GUID.generate(), GUID.generate(), GUID.generate());
|
||||
final List<NodeRef> holds = new ArrayList<>(2);
|
||||
holds.add(hold);
|
||||
holds.add(hold2);
|
||||
holdService.addToHolds(holds, dmDocument);
|
||||
}
|
||||
|
||||
public void when()
|
||||
{
|
||||
holdService.removeFromHold(hold, dmDocument);
|
||||
}
|
||||
|
||||
public void then()
|
||||
{
|
||||
assertTrue(freezeService.isFrozen(dmDocument));
|
||||
assertFalse(holdService.heldBy(dmDocument, true).contains(hold));
|
||||
assertTrue(holdService.heldBy(dmDocument, true).contains(hold2));
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Given a piece of active content on hold
|
||||
* When I try to remove the active content from the hold without permission
|
||||
* Then an access denied exception is thrown
|
||||
*/
|
||||
public void testRemoveDocumentFromHoldFailsWithoutFilingPermission()
|
||||
{
|
||||
doBehaviourDrivenTest(new BehaviourDrivenTest(AccessDeniedException.class)
|
||||
{
|
||||
private NodeRef hold;
|
||||
|
||||
public void given()
|
||||
{
|
||||
hold = holdService.createHold(filePlan, GUID.generate(), GUID.generate(), GUID.generate());
|
||||
holdService.addToHold(hold, dmDocument);
|
||||
}
|
||||
|
||||
public void when()
|
||||
{
|
||||
AuthenticationUtil.runAs(
|
||||
(RunAsWork<Void>) () -> {
|
||||
holdService.removeFromHold(hold, dmDocument);
|
||||
return null;
|
||||
}, recordsManagerName);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Given a piece of active content on hold
|
||||
* When I try to remove the active content from the hold without the remove hold capability
|
||||
* Then an access denied exception is thrown
|
||||
*/
|
||||
public void testRemoveDocumentFromHoldFailsWithoutRemoveHoldPermission()
|
||||
{
|
||||
doBehaviourDrivenTest(new BehaviourDrivenTest(AccessDeniedException.class, powerUserName, false)
|
||||
{
|
||||
private NodeRef hold;
|
||||
|
||||
public void given()
|
||||
{
|
||||
AuthenticationUtil.runAs(
|
||||
(RunAsWork<Void>) () -> {
|
||||
hold = holdService.createHold(filePlan, GUID.generate(), GUID.generate(), GUID.generate());
|
||||
holdService.addToHold(hold, dmDocument);
|
||||
return null;
|
||||
}, getAdminUserName());
|
||||
}
|
||||
|
||||
public void when()
|
||||
{
|
||||
holdService.removeFromHold(hold, dmDocument);
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,246 @@
|
||||
/*
|
||||
* #%L
|
||||
* Alfresco Records Management Module
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2019 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.module.org_alfresco_module_rm.model.rma.aspect;
|
||||
|
||||
import static org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel.ASPECT_HELD_CHILDREN;
|
||||
import static org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel.ASPECT_RECORD;
|
||||
import static org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel.PROP_HELD_CHILDREN_COUNT;
|
||||
import static org.mockito.Matchers.any;
|
||||
import static org.mockito.Matchers.anyMap;
|
||||
import static org.mockito.Mockito.times;
|
||||
import static org.mockito.Mockito.verify;
|
||||
import static org.mockito.Mockito.when;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import java.util.Set;
|
||||
|
||||
import org.alfresco.model.ContentModel;
|
||||
import org.alfresco.module.org_alfresco_module_rm.freeze.FreezeService;
|
||||
import org.alfresco.module.org_alfresco_module_rm.util.TransactionalResourceHelper;
|
||||
import org.alfresco.rest.framework.core.exceptions.PermissionDeniedException;
|
||||
import org.alfresco.service.cmr.dictionary.DictionaryService;
|
||||
import org.alfresco.service.cmr.repository.ChildAssociationRef;
|
||||
import org.alfresco.service.cmr.repository.NodeRef;
|
||||
import org.alfresco.service.cmr.repository.NodeService;
|
||||
import org.alfresco.service.namespace.QName;
|
||||
import org.junit.Before;
|
||||
import org.junit.Test;
|
||||
import org.mockito.InjectMocks;
|
||||
import org.mockito.Mock;
|
||||
import org.mockito.MockitoAnnotations;
|
||||
import org.springframework.context.ApplicationContext;
|
||||
|
||||
/**
|
||||
* Test class for frozen aspect
|
||||
* @author Ross Gale
|
||||
* @since 3.2
|
||||
*/
|
||||
public class FrozenAspectUnitTest
|
||||
{
|
||||
@Mock
|
||||
private NodeService mockNodeService;
|
||||
|
||||
@Mock
|
||||
private ApplicationContext mockApplicationContext;
|
||||
|
||||
@Mock
|
||||
private ChildAssociationRef mockChildAssociationRef;
|
||||
|
||||
@Mock
|
||||
private DictionaryService mockDictionaryService;
|
||||
|
||||
@Mock
|
||||
private FreezeService mockFreezeService;
|
||||
|
||||
@Mock
|
||||
private TransactionalResourceHelper mockResourceHelper;
|
||||
|
||||
@Mock
|
||||
private ChildAssociationRef mockChildRef;
|
||||
|
||||
@Mock
|
||||
private ChildAssociationRef mockParentRef;
|
||||
|
||||
@Mock
|
||||
private ChildAssociationRef mockOldRef;
|
||||
|
||||
@Mock
|
||||
private Set mockSet;
|
||||
|
||||
@InjectMocks
|
||||
private FrozenAspect frozenAspect;
|
||||
|
||||
private final List<ChildAssociationRef> children = new ArrayList<>();
|
||||
|
||||
private NodeRef record = new NodeRef("workspace://record/node");
|
||||
private NodeRef folder = new NodeRef("workspace://folder/node");
|
||||
private NodeRef content = new NodeRef("workspace://content/node");
|
||||
private NodeRef child = new NodeRef("workspace://content/child");
|
||||
private NodeRef parent = new NodeRef("workspace://content/parent");
|
||||
|
||||
@Before
|
||||
public void setUp()
|
||||
{
|
||||
MockitoAnnotations.initMocks(this);
|
||||
when(mockNodeService.exists(record)).thenReturn(true);
|
||||
when(mockNodeService.exists(content)).thenReturn(true);
|
||||
when(mockNodeService.hasAspect(folder, ASPECT_HELD_CHILDREN)).thenReturn(true);
|
||||
when(mockNodeService.getProperty(folder, PROP_HELD_CHILDREN_COUNT)).thenReturn(1);
|
||||
when(mockApplicationContext.getBean("dbNodeService")).thenReturn(mockNodeService);
|
||||
when(mockFreezeService.isFrozen(content)).thenReturn(false);
|
||||
children.add(mockChildRef);
|
||||
when(mockNodeService.getChildAssocs(content)).thenReturn(children);
|
||||
when(mockChildRef.isPrimary()).thenReturn(true);
|
||||
when(mockNodeService.hasAspect(record, ASPECT_RECORD)).thenReturn(true);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test that the held count is reduced on a record folder after the frozen aspect is removed from a record
|
||||
*/
|
||||
@Test
|
||||
public void testRemoveAspectForRecords()
|
||||
{
|
||||
when(mockNodeService.getPrimaryParent(record)).thenReturn(mockChildAssociationRef);
|
||||
when(mockChildAssociationRef.getParentRef()).thenReturn(folder);
|
||||
frozenAspect.onRemoveAspect(record, null);
|
||||
verify(mockNodeService, times(1)).setProperty(folder, PROP_HELD_CHILDREN_COUNT, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test that the held count is reduced on a folder after the frozen aspect is removed from a piece of content
|
||||
*/
|
||||
@Test
|
||||
public void testRemoveAspectForContent()
|
||||
{
|
||||
when(mockNodeService.hasAspect(content, ASPECT_RECORD)).thenReturn(false);
|
||||
when(mockNodeService.getType(content)).thenReturn(ContentModel.TYPE_CONTENT);
|
||||
when(mockNodeService.getPrimaryParent(content)).thenReturn(mockChildAssociationRef);
|
||||
when(mockChildAssociationRef.getParentRef()).thenReturn(folder);
|
||||
frozenAspect.onRemoveAspect(content, null);
|
||||
verify(mockNodeService, times(1)).setProperty(folder, PROP_HELD_CHILDREN_COUNT, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test that the remove code is only run for records or active content
|
||||
*/
|
||||
@Test
|
||||
public void testRemoveAspectForContentDoesntUpdateForOtherTypes()
|
||||
{
|
||||
when(mockNodeService.hasAspect(content, ASPECT_RECORD)).thenReturn(false);
|
||||
when(mockNodeService.getType(content)).thenReturn(ContentModel.TYPE_FOLDER);
|
||||
when(mockDictionaryService.isSubClass(ContentModel.TYPE_FOLDER, ContentModel.TYPE_CONTENT)).thenReturn(false);
|
||||
frozenAspect.onRemoveAspect(content, null);
|
||||
verify(mockNodeService, times(0)).setProperty(folder, PROP_HELD_CHILDREN_COUNT, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test before delete throws an error if a node is frozen
|
||||
*/
|
||||
@Test(expected = PermissionDeniedException.class)
|
||||
public void testBeforeDeleteNodeThrowsExceptionIfNodeFrozen()
|
||||
{
|
||||
when(mockFreezeService.isFrozen(content)).thenReturn(true);
|
||||
frozenAspect.beforeDeleteNode(content);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test before delete is fine for non-frozen nodes
|
||||
*/
|
||||
@Test
|
||||
public void testBeforeDeleteForNonFrozenNodes()
|
||||
{
|
||||
frozenAspect.beforeDeleteNode(content);
|
||||
verify(mockNodeService, times(1)).getChildAssocs(content);
|
||||
verify(mockChildRef, times(1)).getChildRef();
|
||||
}
|
||||
|
||||
/**
|
||||
* Test before delete throws an error for a node with frozen children
|
||||
*/
|
||||
@Test (expected = PermissionDeniedException.class)
|
||||
public void testBeforeDeleteThrowsExceptionForFrozenChild()
|
||||
{
|
||||
when(mockChildRef.getChildRef()).thenReturn(child);
|
||||
when(mockFreezeService.isFrozen(child)).thenReturn(true);
|
||||
frozenAspect.beforeDeleteNode(content);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test on add aspect for a record node
|
||||
*/
|
||||
@Test
|
||||
public void testOnAddAspectForRecord()
|
||||
{
|
||||
when(mockNodeService.getPrimaryParent(record)).thenReturn(mockParentRef);
|
||||
when(mockParentRef.getParentRef()).thenReturn(parent);
|
||||
when(mockNodeService.hasAspect(parent, ASPECT_HELD_CHILDREN)).thenReturn(true);
|
||||
when(mockNodeService.getProperty(parent, PROP_HELD_CHILDREN_COUNT)).thenReturn(0);
|
||||
frozenAspect.onAddAspect(record,null);
|
||||
verify(mockNodeService, times(1)).setProperty(parent, PROP_HELD_CHILDREN_COUNT,1);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test on add aspect for a content node
|
||||
*/
|
||||
@Test
|
||||
public void testOnAddAspectForContent()
|
||||
{
|
||||
when(mockNodeService.getType(content)).thenReturn(ContentModel.TYPE_CONTENT);
|
||||
when(mockNodeService.getPrimaryParent(content)).thenReturn(mockParentRef);
|
||||
when(mockParentRef.getParentRef()).thenReturn(parent);
|
||||
when(mockNodeService.hasAspect(parent, ASPECT_HELD_CHILDREN)).thenReturn(false);
|
||||
when(mockNodeService.getType(parent)).thenReturn(ContentModel.TYPE_FOLDER);
|
||||
frozenAspect.onAddAspect(content, null);
|
||||
verify(mockNodeService, times(1)).addAspect(any(NodeRef.class), any(QName.class), anyMap());
|
||||
}
|
||||
|
||||
/**
|
||||
* Test before move throws an error for a frozen node
|
||||
*/
|
||||
@Test(expected = PermissionDeniedException.class)
|
||||
public void testBeforeMoveThrowsExceptionForFrozenNode()
|
||||
{
|
||||
when(mockOldRef.getParentRef()).thenReturn(parent);
|
||||
when(mockOldRef.getChildRef()).thenReturn(child);
|
||||
when(mockNodeService.exists(child)).thenReturn(true);
|
||||
when(mockFreezeService.isFrozen(child)).thenReturn(true);
|
||||
frozenAspect.beforeMoveNode(mockOldRef, null);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test update properties throws an error for frozen nodes
|
||||
*/
|
||||
@Test(expected = PermissionDeniedException.class)
|
||||
public void testUpdatePropertiesThrowsExceptionForFrozenNode()
|
||||
{
|
||||
when(mockFreezeService.isFrozen(content)).thenReturn(true);
|
||||
when(mockResourceHelper.getSet(content)).thenReturn(mockSet);
|
||||
when(mockSet.contains("frozen")).thenReturn(false);
|
||||
frozenAspect.onUpdateProperties(content, null, null);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user