inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-07-31 17:39:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

RM-7029 Audit remove from hold

Browse Source
This commit is contained in:
Chris Shields
2019-11-19 12:05:06 +00:00
parent 30e3ea689f
commit ad963bb24e
8 changed files with 400 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
rm-community/rm-community-repo/config/alfresco/module/org_alfresco_module_rm/messages/audit-service.properties
View File

@@ -16,6 +16,7 @@ rm.audit.fileTo=File to
rm.audit.createHold=Create Hold
rm.audit.deleteHold=Delete Hold
rm.audit.addToHold=Add To Hold
rm.audit.removeFromHold=Remove From Hold
rm.audit.audit-start=Audit Start
rm.audit.audit-stop=Audit Stop
rm.audit.audit-clear=Audit Clear

6
rm-community/rm-community-repo/config/alfresco/module/org_alfresco_module_rm/rm-audit-context.xml
View File

@@ -147,4 +147,10 @@
<property name="label" value="rm.audit.addToHold"/>
</bean>
<bean id="audit-event.removeFromHold" parent="audit-event" class="org.alfresco.module.org_alfresco_module_rm.audit.event.RemoveFromHoldAuditEvent">
<property name="nodeService" ref="nodeService" />
<property name="name" value="Remove From Hold"/>
<property name="label" value="rm.audit.removeFromHold"/>
</bean>
</beans>

82
rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/audit/event/RemoveFromHoldAuditEvent.java Normal file
View File

@@ -0,0 +1,82 @@
/*
* #%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.audit.event;
import java.io.Serializable;
import java.util.Map;
import org.alfresco.model.ContentModel;
import org.alfresco.module.org_alfresco_module_rm.hold.HoldServicePolicies;
import org.alfresco.repo.policy.Behaviour.NotificationFrequency;
import org.alfresco.repo.policy.annotation.Behaviour;
import org.alfresco.repo.policy.annotation.BehaviourBean;
import org.alfresco.repo.policy.annotation.BehaviourKind;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.namespace.QName;
/**
* Delete from hold audit event.
*
* @author Chris Shields
* @since 3.3
*/
@BehaviourBean
public class RemoveFromHoldAuditEvent extends AuditEvent implements HoldServicePolicies.OnRemoveFromHoldPolicy
{
/** Node Service */
private NodeService nodeService;
/**
* Sets the node service
*
* @param nodeService nodeService to set
*/
public void setNodeService(NodeService nodeService)
{
this.nodeService = nodeService;
}
/**
* @see @see org.alfresco.module.org_alfresco_module_rm.hold.HoldServicePolicies.OnRemoveFromHoldPolicy#onRemoveFromHold(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.NodeRef)
*/
@Override
@Behaviour
(
kind = BehaviourKind.CLASS,
type = "rma:hold",
notificationFrequency = NotificationFrequency.EVERY_EVENT
)
public void onRemoveFromHold(NodeRef holdNodeRef, NodeRef contentNodeRef)
{
Map<QName, Serializable> auditProperties = HoldUtils.makePropertiesMap(holdNodeRef, nodeService);
auditProperties.put(ContentModel.PROP_NAME, nodeService.getProperty(contentNodeRef, ContentModel.PROP_NAME));
recordsManagementAuditService.auditEvent(contentNodeRef, getName(), auditProperties, null, true);
}
}

17
rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/hold/HoldServiceImpl.java
View File

@@ -99,9 +99,6 @@ public class HoldServiceImpl extends ServiceBaseImpl
/** Logger */
private static Log logger = LogFactory.getLog(HoldServiceImpl.class);
/** Audit event keys */
private static final String AUDIT_REMOVE_FROM_HOLD = "removeFromHold";
/** I18N */
private static final String MSG_ERR_ACCESS_DENIED = "permissions.err_access_denied";
@@ -219,16 +216,6 @@ public class HoldServiceImpl extends ServiceBaseImpl
*/
public void init()
{
AuthenticationUtil.runAsSystem(new RunAsWork<Void>()
{
@Override
public Void doWork() throws Exception
{
recordsManagementAuditService.registerAuditEvent(new AuditEvent(AUDIT_REMOVE_FROM_HOLD, "capability.RemoveFromHold.title"));
return null;
}
});
// Register the policies
beforeCreateHoldPolicyDelegate = getPolicyComponent().registerClassPolicy(BeforeCreateHoldPolicy.class);
onCreateHoldPolicyDelegate = getPolicyComponent().registerClassPolicy(OnCreateHoldPolicy.class);
@@ -820,10 +807,6 @@ public class HoldServiceImpl extends ServiceBaseImpl
transactionalResourceHelper.getSet("frozen").add(nodeRef);
nodeService.removeChild(hold, nodeRef);
// audit that the node has been removed from the hold
// TODO add details of the hold that the node was removed from
recordsManagementAuditService.auditEvent(nodeRef, AUDIT_REMOVE_FROM_HOLD);
return null;
});
removedHolds.add(hold);

193
rm-community/rm-community-repo/test/java/org/alfresco/module/org_alfresco_module_rm/test/legacy/service/RecordsManagementAuditServiceImplTest.java
View File

@@ -28,11 +28,13 @@
package org.alfresco.module.org_alfresco_module_rm.test.legacy.service;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.stream.Collectors;
import org.alfresco.model.ContentModel;
import org.alfresco.module.org_alfresco_module_rm.audit.RecordsManagementAuditEntry;
@@ -735,6 +737,183 @@ public class RecordsManagementAuditServiceImplTest extends BaseRMTestCase
});
}
/**
* Given I have an item in a hold
* When I remove the item from the hold
* Then there will be an audit entry for the item removed from the hold, including both the item name and hold name
*/
@org.junit.Test
public void testAuditForRemoveContentFromHold()
{
doBehaviourDrivenTest(new BehaviourDrivenTest()
{
final static String REMOVE_FROM_HOLD_AUDIT_EVENT = "Remove From Hold";
String holdName = "Hold " + GUID.generate();
NodeRef hold;
Map<QName, Serializable> auditEventProperties;
@Override
public void given()
{
rmAuditService.clearAuditLog(filePlan);
hold = utils.createHold(filePlan, holdName, "Reason " + GUID.generate());
utils.addItemToHold(hold, dmDocument);
}
@Override
public void when()
{
utils.removeItemFromHold(hold, dmDocument);
}
@Override
public void then()
{
auditEventProperties = getAuditEntry(REMOVE_FROM_HOLD_AUDIT_EVENT).getBeforeProperties();
// check remove from hold audit event includes the hold name
assertEquals("Remove From Hold event does not include hold name.", holdName,
auditEventProperties.get(HOLD_NAME));
// check remove from hold audit event includes the content name
String contentName = (String) nodeService.getProperty(dmDocument, PROP_NAME);
assertEquals("Remove From Hold event does not include content name.", contentName,
auditEventProperties.get(PROP_NAME));
}
@Override
public void after()
{
// Stop and delete all entries
rmAuditService.stopAuditLog(filePlan);
rmAuditService.clearAuditLog(filePlan);
}
});
}
/**
* Given I have removed an item from multiple holds
* When I will get the RM audit filter by remove from hold events
* Then there will be entries for the item removed from each hold, including both the item name and hold name
*/
@org.junit.Test
public void testAuditForRemoveContentFromMultipleHolds()
{
doBehaviourDrivenTest(new BehaviourDrivenTest()
{
final static String REMOVE_FROM_HOLD_AUDIT_EVENT = "Remove From Hold";
String holdName1 = "Hold " + GUID.generate();
String holdName2 = "Hold " + GUID.generate();
NodeRef hold1, hold2;
List<Map<QName, Serializable>> auditEventPropertiesList;
@Override
public void given()
{
rmAuditService.clearAuditLog(filePlan);
hold1 = utils.createHold(filePlan, holdName1, "Reason " + GUID.generate());
hold2 = utils.createHold(filePlan, holdName2, "Reason " + GUID.generate());
utils.addItemToHold(hold1, dmDocument);
utils.addItemToHold(hold2, dmDocument);
}
@Override
public void when()
{
utils.removeItemFromHold(hold1, dmDocument);
utils.removeItemFromHold(hold2, dmDocument);
}
@Override
public void then()
{
auditEventPropertiesList = getAuditEntries(REMOVE_FROM_HOLD_AUDIT_EVENT)
.stream()
.map(RecordsManagementAuditEntry::getBeforeProperties)
.collect(Collectors.toList());
// check remove from hold audit event exists for both records
assertEquals(2, auditEventPropertiesList.size());
}
@Override
public void after()
{
// Stop and delete all entries
rmAuditService.stopAuditLog(filePlan);
rmAuditService.clearAuditLog(filePlan);
}
});
}
/**
* Given I have removed items from a hold
* When I will get the RM audit filter by remove from hold events
* Then there will be entries for the items removed from the hold, including both the item name and hold name
*/
@org.junit.Test
public void testAuditForRemoveMultipleContentFromHold()
{
doBehaviourDrivenTest(new BehaviourDrivenTest()
{
final static String REMOVE_FROM_HOLD_AUDIT_EVENT = "Remove From Hold";
String holdName = "Hold " + GUID.generate();
NodeRef hold;
List<Map<QName, Serializable>> auditEventPropertiesList;
@Override
public void given()
{
rmAuditService.clearAuditLog(filePlan);
hold = utils.createHold(filePlan, holdName, "Reason " + GUID.generate());
utils.addItemToHold(hold, dmDocument);
utils.addItemToHold(hold, dmDocument1);
}
@Override
public void when()
{
utils.removeItemsFromHolds(Arrays.asList(hold), Arrays.asList(dmDocument, dmDocument1));
}
@Override
public void then()
{
auditEventPropertiesList = getAuditEntries(REMOVE_FROM_HOLD_AUDIT_EVENT)
.stream()
.map(RecordsManagementAuditEntry::getBeforeProperties)
.collect(Collectors.toList());
// check remove from hold audit event exists for both records
assertEquals(2, auditEventPropertiesList.size());
}
@Override
public void after()
{
// Stop and delete all entries
rmAuditService.stopAuditLog(filePlan);
rmAuditService.clearAuditLog(filePlan);
}
});
}
/** === Helper methods === */
private List<RecordsManagementAuditEntry> getAuditTrail(String asUser)
@@ -800,4 +979,18 @@ public class RecordsManagementAuditServiceImplTest extends BaseRMTestCase
// return the properties of the audit event
return auditEntry;
}
private List<RecordsManagementAuditEntry> getAuditEntries(String auditEvent)
{
// set the audit query param for the given event
RecordsManagementAuditQueryParameters params = new RecordsManagementAuditQueryParameters();
params.setEvent(auditEvent);
// get the audit entries for the given event
List<RecordsManagementAuditEntry> auditEntries;
auditEntries = getAuditTrail(params, -1, ADMIN_USER);
return auditEntries;
}
}

23
rm-community/rm-community-repo/test/java/org/alfresco/module/org_alfresco_module_rm/test/util/CommonRMTestUtils.java
View File

@@ -441,4 +441,27 @@ public class CommonRMTestUtils implements RecordsManagementModel
{
holdService.addToHold(holdNodeRef, contentNodeRef);
}
/**
* Util method to remove content from a hold.
*
* @param holdNodeRef hold node reference
* @param contentNodeRef content node reference
*/
public void removeItemFromHold(NodeRef holdNodeRef, NodeRef contentNodeRef)
{
holdService.removeFromHold(holdNodeRef, contentNodeRef);
}
/**
* Util method to remove items from a holds.
*
* @param holdNodeRefs the list {@link NodeRef}s of the holds
* @param contentNodeRef the list of items which will be removed from the given holds
*/
public void removeItemsFromHolds(List<NodeRef> holdNodeRefs, List<NodeRef> contentNodeRef)
{
holdService.removeFromHolds(holdNodeRefs, contentNodeRef);
}
}

95
rm-community/rm-community-repo/unit-test/java/org/alfresco/module/org_alfresco_module_rm/audit/event/RemoveFromHoldAuditEventUnitTest.java Normal file
View File

@@ -0,0 +1,95 @@
/*
* #%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.audit.event;
import static org.mockito.Matchers.any;
import static org.mockito.Matchers.eq;
import static org.mockito.Matchers.isNull;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import static org.mockito.MockitoAnnotations.initMocks;
import java.util.Map;
import org.alfresco.module.org_alfresco_module_rm.test.util.BaseUnitTest;
import org.alfresco.service.cmr.repository.ChildAssociationRef;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.util.GUID;
import org.junit.Before;
import org.junit.Test;
import org.mockito.InjectMocks;
import org.mockito.Mock;
/**
* Unit tests for {@link CreateHoldAuditEvent}.
*
* @author Chris Shields
* @since 3.3
*/
public class RemoveFromHoldAuditEventUnitTest extends BaseUnitTest
{
@InjectMocks
private RemoveFromHoldAuditEvent removeFromHoldAuditEvent;
@Mock
private NodeService mockedNodeService;
private NodeRef holdNodeRef;
private NodeRef contentNodeRef;
/**
* Set up the mocks.
*/
@Before
public void setUp()
{
initMocks(this);
holdNodeRef = generateNodeRef();
String holdName = "Hold " + GUID.generate();
contentNodeRef = generateNodeRef();
String contentName = "Content " + GUID.generate();
when(mockedNodeService.getProperty(holdNodeRef, PROP_NAME)).thenReturn(holdName);
when(mockedNodeService.getProperty(contentNodeRef, PROP_NAME)).thenReturn(contentName);
}
/**
* Check that the remove from hold event calls an audit event.
*/
@Test
public void testAddToHoldCausesAuditEvent()
{
removeFromHoldAuditEvent.onRemoveFromHold(holdNodeRef, contentNodeRef);
verify(mockedRecordsManagementAuditService, times(1)).auditEvent(eq(contentNodeRef), any(String.class), any(Map.class), isNull(Map.class), eq(true));
}
}

2
rm-community/rm-community-repo/unit-test/java/org/alfresco/module/org_alfresco_module_rm/hold/HoldServiceImplUnitTest.java
View File

@@ -494,7 +494,6 @@ public class HoldServiceImplUnitTest extends BaseUnitTest
verify(mockedNodeService, times(1)).removeChild(hold, recordFolder);
verify(mockedNodeService, times(1)).removeAspect(recordFolder, ASPECT_FROZEN);
verify(mockedNodeService, times(1)).removeAspect(record, ASPECT_FROZEN);
verify(mockedRecordsManagementAuditService, times(1)).auditEvent(eq(recordFolder), anyString());
}
@Test
@@ -518,7 +517,6 @@ public class HoldServiceImplUnitTest extends BaseUnitTest
verify(mockedNodeService, times(1)).removeChild(hold2, recordFolder);
verify(mockedNodeService, times(1)).removeAspect(recordFolder, ASPECT_FROZEN);
verify(mockedNodeService, times(1)).removeAspect(record, ASPECT_FROZEN);
verify(mockedRecordsManagementAuditService, times(2)).auditEvent(any(NodeRef.class), anyString());
}
@Test