mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-07-24 17:32:48 +00:00
Low-level archive and restore functionality
- Full tests of archive and restore against the contentModel.xml - TODO: Test permissions of archive store - Currently on a single, simple restoreNode method on NodeService - TODO: NodeRestoreService implementation to provide helpers around mass restoration, purging, etc git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@2782 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Derek Hulley
@@ -0,0 +1,464 @@
|
||||
/*
|
||||
* Copyright (C) 2005 Alfresco, Inc.
|
||||
*
|
||||
* Licensed under the Mozilla Public License version 1.1
|
||||
* with a permitted attribution clause. You may obtain a
|
||||
* copy of the License at
|
||||
*
|
||||
* http://www.alfresco.org/legal/license.txt
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
||||
* either express or implied. See the License for the specific
|
||||
* language governing permissions and limitations under the
|
||||
* License.
|
||||
*/
|
||||
package org.alfresco.repo.node.archive;
|
||||
|
||||
import java.io.Serializable;
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import javax.transaction.Status;
|
||||
import javax.transaction.UserTransaction;
|
||||
|
||||
import junit.framework.TestCase;
|
||||
|
||||
import org.alfresco.model.ContentModel;
|
||||
import org.alfresco.repo.node.StoreArchiveMap;
|
||||
import org.alfresco.repo.security.authentication.AuthenticationComponent;
|
||||
import org.alfresco.service.ServiceRegistry;
|
||||
import org.alfresco.service.cmr.repository.AssociationRef;
|
||||
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.cmr.repository.StoreRef;
|
||||
import org.alfresco.service.cmr.security.AuthenticationService;
|
||||
import org.alfresco.service.cmr.security.PermissionService;
|
||||
import org.alfresco.service.namespace.NamespaceService;
|
||||
import org.alfresco.service.namespace.QName;
|
||||
import org.alfresco.service.transaction.TransactionService;
|
||||
import org.alfresco.util.ApplicationContextHelper;
|
||||
import org.alfresco.util.TestWithUserUtils;
|
||||
import org.springframework.context.ApplicationContext;
|
||||
|
||||
/**
|
||||
* Test the archive and restore functionality provided by the low-level
|
||||
* node service.
|
||||
*
|
||||
* @author Derek Hulley
|
||||
*/
|
||||
public class ArchiveAndRestoreTest extends TestCase
|
||||
{
|
||||
private static final String USER_A = "AAAAA";
|
||||
private static final String USER_B = "BBBBB";
|
||||
private static final QName ASSOC_ATTACHMENTS = QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, "attachments");
|
||||
private static final QName QNAME_A = QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, "a");
|
||||
private static final QName QNAME_B = QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, "b");
|
||||
private static final QName QNAME_AA = QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, "aa");
|
||||
private static final QName QNAME_BB = QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, "bb");
|
||||
|
||||
private static ApplicationContext ctx = ApplicationContextHelper.getApplicationContext();
|
||||
|
||||
private NodeService nodeService;
|
||||
private PermissionService permissionService;
|
||||
private AuthenticationComponent authenticationComponent;
|
||||
private AuthenticationService authenticationService;
|
||||
private TransactionService transactionService;
|
||||
|
||||
private UserTransaction txn;
|
||||
private StoreRef workStoreRef;
|
||||
private NodeRef workStoreRootNodeRef;
|
||||
private StoreRef archiveStoreRef;
|
||||
private NodeRef archiveStoreRootNodeRef;
|
||||
|
||||
private NodeRef a;
|
||||
private NodeRef b;
|
||||
private NodeRef aa;
|
||||
private NodeRef bb;
|
||||
AssociationRef assocAtoB;
|
||||
AssociationRef assocAAtoBB;
|
||||
ChildAssociationRef childAssocAtoAA;
|
||||
ChildAssociationRef childAssocBtoBB;
|
||||
ChildAssociationRef childAssocBtoAA;
|
||||
ChildAssociationRef childAssocAtoBB;
|
||||
private NodeRef a_;
|
||||
private NodeRef b_;
|
||||
private NodeRef aa_;
|
||||
private NodeRef bb_;
|
||||
ChildAssociationRef childAssocAtoAA_;
|
||||
ChildAssociationRef childAssocBtoBB_;
|
||||
|
||||
@Override
|
||||
public void setUp() throws Exception
|
||||
{
|
||||
ServiceRegistry serviceRegistry = (ServiceRegistry) ctx.getBean("ServiceRegistry");
|
||||
nodeService = serviceRegistry.getNodeService();
|
||||
permissionService = serviceRegistry.getPermissionService();
|
||||
authenticationService = serviceRegistry.getAuthenticationService();
|
||||
authenticationComponent = (AuthenticationComponent) ctx.getBean("authenticationComponent");
|
||||
transactionService = serviceRegistry.getTransactionService();
|
||||
|
||||
// Start a transaction
|
||||
txn = transactionService.getUserTransaction();
|
||||
txn.begin();
|
||||
|
||||
try
|
||||
{
|
||||
authenticationComponent.setSystemUserAsCurrentUser();
|
||||
// Create the work store
|
||||
workStoreRef = nodeService.createStore(StoreRef.PROTOCOL_WORKSPACE, getName() + System.currentTimeMillis());
|
||||
workStoreRootNodeRef = nodeService.getRootNode(workStoreRef);
|
||||
archiveStoreRef = nodeService.createStore("archive", getName() + System.currentTimeMillis());
|
||||
archiveStoreRootNodeRef = nodeService.getRootNode(archiveStoreRef);
|
||||
|
||||
// Map the work store to the archive store. This will already be wired into the NodeService.
|
||||
StoreArchiveMap archiveMap = (StoreArchiveMap) ctx.getBean("storeArchiveMap");
|
||||
archiveMap.getArchiveMap().put(workStoreRef, archiveStoreRef);
|
||||
|
||||
// grant everyone rights to the work store
|
||||
permissionService.setPermission(
|
||||
workStoreRootNodeRef,
|
||||
PermissionService.ALL_AUTHORITIES,
|
||||
PermissionService.ALL_PERMISSIONS,
|
||||
true);
|
||||
|
||||
TestWithUserUtils.createUser(USER_A, USER_A, workStoreRootNodeRef, nodeService, authenticationService);
|
||||
TestWithUserUtils.createUser(USER_B, USER_B, workStoreRootNodeRef, nodeService, authenticationService);
|
||||
}
|
||||
finally
|
||||
{
|
||||
authenticationComponent.clearCurrentSecurityContext();
|
||||
}
|
||||
// authenticate as normal user
|
||||
authenticationService.authenticate(USER_A, USER_A.toCharArray());
|
||||
createNodeStructure();
|
||||
}
|
||||
|
||||
@Override
|
||||
public void tearDown() throws Exception
|
||||
{
|
||||
try
|
||||
{
|
||||
if (txn.getStatus() == Status.STATUS_ACTIVE)
|
||||
{
|
||||
txn.rollback();
|
||||
}
|
||||
}
|
||||
catch (Throwable e)
|
||||
{
|
||||
e.printStackTrace();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Create the following:
|
||||
* <pre>
|
||||
* root
|
||||
* / | \
|
||||
* / | \
|
||||
* / | \
|
||||
* / | \
|
||||
* A <-> B X
|
||||
* |\ /|
|
||||
* | \ / |
|
||||
* | \/ |
|
||||
* | /\ |
|
||||
* | / \ |
|
||||
* |/ \|
|
||||
* AA <-> BB
|
||||
* </pre>
|
||||
* Explicit UUIDs are used for debugging purposes.
|
||||
* <p>
|
||||
* <b>A</b>, <b>B</b>, <b>AA</b> and <b>BB</b> are set up to archive automatically
|
||||
* on deletion.
|
||||
*/
|
||||
private void createNodeStructure() throws Exception
|
||||
{
|
||||
Map<QName, Serializable> properties = new HashMap<QName, Serializable>(5);
|
||||
|
||||
properties.put(ContentModel.PROP_NODE_UUID, "a");
|
||||
a = nodeService.createNode(
|
||||
workStoreRootNodeRef,
|
||||
ContentModel.ASSOC_CHILDREN,
|
||||
QNAME_A,
|
||||
ContentModel.TYPE_FOLDER,
|
||||
properties).getChildRef();
|
||||
properties.put(ContentModel.PROP_NODE_UUID, "aa");
|
||||
childAssocAtoAA = nodeService.createNode(
|
||||
a,
|
||||
ContentModel.ASSOC_CONTAINS,
|
||||
QNAME_AA,
|
||||
ContentModel.TYPE_CONTENT,
|
||||
properties);
|
||||
aa = childAssocAtoAA.getChildRef();
|
||||
properties.put(ContentModel.PROP_NODE_UUID, "b");
|
||||
b = nodeService.createNode(
|
||||
workStoreRootNodeRef,
|
||||
ContentModel.ASSOC_CHILDREN,
|
||||
QNAME_B,
|
||||
ContentModel.TYPE_FOLDER,
|
||||
properties).getChildRef();
|
||||
properties.put(ContentModel.PROP_NODE_UUID, "bb");
|
||||
childAssocBtoBB = nodeService.createNode(
|
||||
b,
|
||||
ContentModel.ASSOC_CONTAINS,
|
||||
QNAME_BB,
|
||||
ContentModel.TYPE_CONTENT,
|
||||
properties);
|
||||
bb = childAssocBtoBB.getChildRef();
|
||||
assocAtoB = nodeService.createAssociation(a, b, ASSOC_ATTACHMENTS);
|
||||
assocAAtoBB = nodeService.createAssociation(aa, bb, ASSOC_ATTACHMENTS);
|
||||
childAssocBtoAA = nodeService.addChild(
|
||||
b,
|
||||
aa,
|
||||
ContentModel.ASSOC_CONTAINS,
|
||||
QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, "aa"));
|
||||
childAssocAtoBB = nodeService.addChild(
|
||||
a,
|
||||
bb,
|
||||
ContentModel.ASSOC_CONTAINS,
|
||||
QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, "bb"));
|
||||
|
||||
// deduce the references
|
||||
a_ = new NodeRef(archiveStoreRef, a.getId());
|
||||
b_ = new NodeRef(archiveStoreRef, b.getId());
|
||||
aa_ = new NodeRef(archiveStoreRef, aa.getId());
|
||||
bb_ = new NodeRef(archiveStoreRef, bb.getId());
|
||||
childAssocAtoAA_ = new ChildAssociationRef(
|
||||
childAssocAtoAA.getTypeQName(),
|
||||
a_,
|
||||
childAssocAtoAA.getQName(),
|
||||
aa_);
|
||||
childAssocBtoBB_ = new ChildAssociationRef(
|
||||
childAssocBtoBB.getTypeQName(),
|
||||
b_,
|
||||
childAssocBtoBB.getQName(),
|
||||
bb_);
|
||||
}
|
||||
|
||||
private void verifyNodeExistence(NodeRef nodeRef, boolean exists)
|
||||
{
|
||||
assertEquals("Node should " + (exists ? "" : "not") + "exist", exists, nodeService.exists(nodeRef));
|
||||
}
|
||||
|
||||
private void verifyChildAssocExistence(ChildAssociationRef childAssocRef, boolean exists)
|
||||
{
|
||||
List<ChildAssociationRef> childAssocs = nodeService.getChildAssocs(
|
||||
childAssocRef.getParentRef(),
|
||||
childAssocRef.getTypeQName(),
|
||||
childAssocRef.getQName());
|
||||
if (exists)
|
||||
{
|
||||
assertEquals("Expected exactly one match for child association: " + childAssocRef, 1, childAssocs.size());
|
||||
}
|
||||
else
|
||||
{
|
||||
assertEquals("Expected zero matches for child association: " + childAssocRef, 0, childAssocs.size());
|
||||
}
|
||||
}
|
||||
|
||||
private void verifyTargetAssocExistence(AssociationRef assocRef, boolean exists)
|
||||
{
|
||||
List<AssociationRef> assocs = nodeService.getTargetAssocs(
|
||||
assocRef.getSourceRef(),
|
||||
assocRef.getTypeQName());
|
||||
if (exists)
|
||||
{
|
||||
assertEquals("Expected exactly one match for target association: " + assocRef, 1, assocs.size());
|
||||
}
|
||||
else
|
||||
{
|
||||
assertEquals("Expected zero matches for target association: " + assocRef, 0, assocs.size());
|
||||
}
|
||||
}
|
||||
|
||||
public void verifyAll()
|
||||
{
|
||||
// work store references
|
||||
verifyNodeExistence(a, true);
|
||||
verifyNodeExistence(b, true);
|
||||
verifyNodeExistence(aa, true);
|
||||
verifyNodeExistence(bb, true);
|
||||
verifyChildAssocExistence(childAssocAtoAA, true);
|
||||
verifyChildAssocExistence(childAssocBtoBB, true);
|
||||
verifyChildAssocExistence(childAssocAtoBB, true);
|
||||
verifyChildAssocExistence(childAssocBtoAA, true);
|
||||
verifyTargetAssocExistence(assocAtoB, true);
|
||||
verifyTargetAssocExistence(assocAAtoBB, true);
|
||||
// archive store references
|
||||
verifyNodeExistence(a_, false);
|
||||
verifyNodeExistence(b_, false);
|
||||
verifyNodeExistence(aa_, false);
|
||||
verifyNodeExistence(bb_, false);
|
||||
}
|
||||
|
||||
public void testSetUp() throws Exception
|
||||
{
|
||||
verifyAll();
|
||||
}
|
||||
|
||||
public void testGetStoreArchiveNode() throws Exception
|
||||
{
|
||||
NodeRef archiveNodeRef = nodeService.getStoreArchiveNode(workStoreRef);
|
||||
assertEquals("Mapping of archived store is not correct", archiveStoreRootNodeRef, archiveNodeRef);
|
||||
}
|
||||
|
||||
public void testArchiveAndRestoreNodeBB() throws Exception
|
||||
{
|
||||
// delete a child
|
||||
nodeService.deleteNode(bb);
|
||||
// check
|
||||
verifyNodeExistence(b, true);
|
||||
verifyNodeExistence(bb, false);
|
||||
verifyChildAssocExistence(childAssocAtoBB, false);
|
||||
verifyChildAssocExistence(childAssocBtoBB, false);
|
||||
verifyNodeExistence(b_, false);
|
||||
verifyNodeExistence(bb_, true);
|
||||
|
||||
// restore the node
|
||||
nodeService.restoreNode(bb_, null, null, null);
|
||||
// check
|
||||
verifyAll();
|
||||
}
|
||||
|
||||
public void testArchiveAndRestoreNodeB() throws Exception
|
||||
{
|
||||
// delete a child
|
||||
nodeService.deleteNode(b);
|
||||
// check
|
||||
verifyNodeExistence(b, false);
|
||||
verifyNodeExistence(bb, false);
|
||||
verifyChildAssocExistence(childAssocAtoBB, false);
|
||||
verifyTargetAssocExistence(assocAtoB, false);
|
||||
verifyTargetAssocExistence(assocAAtoBB, false);
|
||||
verifyNodeExistence(b_, true);
|
||||
verifyNodeExistence(bb_, true);
|
||||
verifyChildAssocExistence(childAssocBtoBB_, true);
|
||||
|
||||
// restore the node
|
||||
nodeService.restoreNode(b_, null, null, null);
|
||||
// check
|
||||
verifyAll();
|
||||
}
|
||||
|
||||
public void testArchiveAndRestoreAll_B_A() throws Exception
|
||||
{
|
||||
// delete both trees in order 'b', 'a'
|
||||
nodeService.deleteNode(b);
|
||||
nodeService.deleteNode(a);
|
||||
// restore in reverse order
|
||||
nodeService.restoreNode(a_, null, null, null);
|
||||
nodeService.restoreNode(b_, null, null, null);
|
||||
// check
|
||||
verifyAll();
|
||||
}
|
||||
|
||||
public void testArchiveAndRestoreAll_A_B() throws Exception
|
||||
{
|
||||
// delete both trees in order 'b', 'a'
|
||||
nodeService.deleteNode(a);
|
||||
nodeService.deleteNode(b);
|
||||
// restore in reverse order
|
||||
nodeService.restoreNode(b_, null, null, null);
|
||||
nodeService.restoreNode(a_, null, null, null);
|
||||
// check
|
||||
verifyAll();
|
||||
}
|
||||
|
||||
public void testArchiveAndRestoreWithMissingAssocTargets() throws Exception
|
||||
{
|
||||
// delete a then b
|
||||
nodeService.deleteNode(a);
|
||||
nodeService.deleteNode(b);
|
||||
// in restoring 'a' first, there will be some associations that won't be recreated
|
||||
nodeService.restoreNode(a_, null, null, null);
|
||||
nodeService.restoreNode(b_, null, null, null);
|
||||
|
||||
// check
|
||||
verifyNodeExistence(a, true);
|
||||
verifyNodeExistence(b, true);
|
||||
verifyNodeExistence(aa, true);
|
||||
verifyNodeExistence(bb, true);
|
||||
verifyChildAssocExistence(childAssocAtoAA, true);
|
||||
verifyChildAssocExistence(childAssocBtoBB, true);
|
||||
verifyChildAssocExistence(childAssocAtoBB, false);
|
||||
verifyChildAssocExistence(childAssocBtoAA, false);
|
||||
verifyTargetAssocExistence(assocAtoB, false);
|
||||
verifyTargetAssocExistence(assocAAtoBB, false);
|
||||
verifyNodeExistence(a_, false);
|
||||
verifyNodeExistence(b_, false);
|
||||
verifyNodeExistence(aa_, false);
|
||||
verifyNodeExistence(bb_, false);
|
||||
}
|
||||
|
||||
/**
|
||||
* Ensures that the archival is performed based on the node type.
|
||||
*/
|
||||
public void testTypeDetection()
|
||||
{
|
||||
// change the type of 'a'
|
||||
nodeService.setType(a, ContentModel.TYPE_CONTAINER);
|
||||
// delete it
|
||||
nodeService.deleteNode(a);
|
||||
// it must be gone
|
||||
verifyNodeExistence(a, false);
|
||||
verifyNodeExistence(a_, false);
|
||||
}
|
||||
|
||||
/**
|
||||
* Attempt to measure how much archiving affects the deletion performance.
|
||||
*/
|
||||
public void testArchiveVsDeletePerformance() throws Exception
|
||||
{
|
||||
// Start by deleting the node structure and then recreating it.
|
||||
// Only measure the delete speed
|
||||
int iterations = 100;
|
||||
long cumulatedArchiveTimeNs = 0;
|
||||
long cumulatedRestoreTimeNs = 0;
|
||||
for (int i = 0; i < iterations; i++)
|
||||
{
|
||||
// timed delete
|
||||
long start = System.nanoTime();
|
||||
nodeService.deleteNode(b);
|
||||
long end = System.nanoTime();
|
||||
cumulatedArchiveTimeNs += (end - start);
|
||||
// now restore
|
||||
start = System.nanoTime();
|
||||
nodeService.restoreNode(b_, null, null, null);
|
||||
end = System.nanoTime();
|
||||
cumulatedRestoreTimeNs += (end - start);
|
||||
}
|
||||
double averageArchiveTimeMs = (double)cumulatedArchiveTimeNs / 1E6 / (double)iterations;
|
||||
double averageRestoreTimeMs = (double)cumulatedRestoreTimeNs / 1E6 / (double)iterations;
|
||||
System.out.println("Average archive time: " + averageArchiveTimeMs + " ms");
|
||||
System.out.println("Average restore time: " + averageRestoreTimeMs + " ms");
|
||||
|
||||
// Now force full deletions and creations
|
||||
StoreArchiveMap archiveMap = (StoreArchiveMap) ctx.getBean("storeArchiveMap");
|
||||
archiveMap.getArchiveMap().clear();
|
||||
long cumulatedDeleteTimeNs = 0;
|
||||
long cumulatedCreateTimeNs = 0;
|
||||
for (int i = 0; i < iterations; i++)
|
||||
{
|
||||
// timed delete
|
||||
long start = System.nanoTime();
|
||||
nodeService.deleteNode(b);
|
||||
long end = System.nanoTime();
|
||||
cumulatedDeleteTimeNs += (end - start);
|
||||
// delete 'a' as well
|
||||
nodeService.deleteNode(a);
|
||||
// now rebuild
|
||||
start = System.nanoTime();
|
||||
createNodeStructure();
|
||||
end = System.nanoTime();
|
||||
cumulatedCreateTimeNs += (end - start);
|
||||
}
|
||||
double averageDeleteTimeMs = (double)cumulatedDeleteTimeNs / 1E6 / (double)iterations;
|
||||
double averageCreateTimeMs = (double)cumulatedCreateTimeNs / 1E6 / (double)iterations;
|
||||
System.out.println("Average delete time: " + averageDeleteTimeMs + " ms");
|
||||
System.out.println("Average create time: " + averageCreateTimeMs + " ms");
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user