/*
* Copyright (C) 2005-2010 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* 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 .
*/
package org.alfresco.repo.audit;
import java.io.Serializable;
import java.net.URL;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import junit.framework.TestCase;
import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.repo.audit.model.AuditApplication;
import org.alfresco.repo.audit.model.AuditModelException;
import org.alfresco.repo.audit.model.AuditModelRegistryImpl;
import org.alfresco.repo.security.authentication.AuthenticationException;
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.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback;
import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.audit.AuditQueryParameters;
import org.alfresco.service.cmr.audit.AuditService;
import org.alfresco.service.cmr.audit.AuditService.AuditQueryCallback;
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.MutableAuthenticationService;
import org.alfresco.service.cmr.security.PermissionService;
import org.alfresco.service.transaction.TransactionService;
import org.alfresco.util.ApplicationContextHelper;
import org.alfresco.util.EqualsHelper;
import org.apache.commons.lang.mutable.MutableInt;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.context.ApplicationContext;
import org.springframework.extensions.webscripts.GUID;
import org.springframework.util.ResourceUtils;
/**
* Tests component-level auditing i.e. audit sessions and audit logging.
*
* @see AuditComponent
* @see AuditComponentImpl
*
* @author Derek Hulley
* @since 3.2
*/
public class AuditComponentTest extends TestCase
{
private static final String APPLICATION_TEST = "Alfresco Test";
private static final String APPLICATION_ACTIONS_TEST = "Actions Test";
private static final String APPLICATION_API_TEST = "Test AuthenticationService";
private static final String APPLICATION_ALF12638_TEST = "Test ALF-12638";
private static final Log logger = LogFactory.getLog(AuditComponentTest.class);
private static ApplicationContext ctx = ApplicationContextHelper.getApplicationContext();
private AuditModelRegistryImpl auditModelRegistry;
private AuditComponent auditComponent;
private AuditService auditService;
private ServiceRegistry serviceRegistry;
private TransactionService transactionService;
private NodeService nodeService;
private NodeRef nodeRef;
private String user;
@Override
public void setUp() throws Exception
{
auditModelRegistry = (AuditModelRegistryImpl) ctx.getBean("auditModel.modelRegistry");
auditComponent = (AuditComponent) ctx.getBean("auditComponent");
serviceRegistry = (ServiceRegistry) ctx.getBean(ServiceRegistry.SERVICE_REGISTRY);
auditService = serviceRegistry.getAuditService();
transactionService = serviceRegistry.getTransactionService();
nodeService = serviceRegistry.getNodeService();
// Register the test model
URL testModelUrl = ResourceUtils.getURL("classpath:alfresco/testaudit/alfresco-audit-test.xml");
auditModelRegistry.registerModel(testModelUrl);
auditModelRegistry.loadAuditModels();
RunAsWork testRunAs = new RunAsWork()
{
public NodeRef doWork() throws Exception
{
return nodeService.getRootNode(StoreRef.STORE_REF_WORKSPACE_SPACESSTORE);
}
};
nodeRef = AuthenticationUtil.runAs(testRunAs, AuthenticationUtil.getSystemUserName());
// Authenticate
user = "User-" + getName();
AuthenticationUtil.setFullyAuthenticatedUser(user);
final RetryingTransactionCallback resetDisabledPathsCallback = new RetryingTransactionCallback()
{
public Void execute() throws Throwable
{
auditComponent.resetDisabledPaths(APPLICATION_TEST);
auditComponent.resetDisabledPaths(APPLICATION_ACTIONS_TEST);
return null;
}
};
transactionService.getRetryingTransactionHelper().doInTransaction(resetDisabledPathsCallback);
}
@Override
public void tearDown() throws Exception
{
AuthenticationUtil.clearCurrentSecurityContext();
// Throw away the reconfigured registry state
auditModelRegistry.destroy();
}
public void testSetUp()
{
// Just here to fail if the basic startup fails
}
public void testAreAuditValuesRequired()
{
boolean auditRequiredAtAll = auditComponent.areAuditValuesRequired();
assertTrue("Auditing should be enabled for this test", auditRequiredAtAll);
boolean auditRequiredForBogus = auditComponent.areAuditValuesRequired("bogus");
assertFalse("Path 'bogus' should not have any audit associated with it.", auditRequiredForBogus);
boolean auditRequiredForTest = auditComponent.areAuditValuesRequired("/test");
assertTrue("'test' is recording audit values", auditRequiredForTest);
}
public void testAuditWithBadPath() throws Exception
{
// Should start an appropriate txn
auditComponent.recordAuditValues("/test", Collections.emptyMap());
RetryingTransactionCallback testCallback = new RetryingTransactionCallback()
{
public Void execute() throws Throwable
{
try
{
auditComponent.recordAuditValues("test", null);
fail("Failed to detect illegal path");
}
catch (AuditModelException e)
{
// Expected
}
try
{
auditComponent.recordAuditValues("/test/", null);
fail("Failed to detect illegal path");
}
catch (AuditModelException e)
{
// Expected
}
Map auditedValues = auditComponent.recordAuditValues("/bogus", null);
assertNotNull(auditedValues);
assertTrue("Invalid application should not audit anything", auditedValues.isEmpty());
return null;
}
};
transactionService.getRetryingTransactionHelper().doInTransaction(testCallback);
}
/**
* Start a session and use it within a single txn
*/
public void testAudit_Basic() throws Exception
{
final RetryingTransactionCallback testCallback = new RetryingTransactionCallback()
{
public Void execute() throws Throwable
{
Map values = new HashMap(13);
values.put("/3.1/4.1", new Long(41));
values.put("/3.1/4.2", "42");
values.put("/3.1/4.3", new Date());
values.put("/3.1/4.4", "");
values.put("/3.1/4.5", null);
auditComponent.recordAuditValues("/test/one.one/two.one", values);
return null;
}
};
RunAsWork testRunAs = new RunAsWork()
{
public Void doWork() throws Exception
{
return transactionService.getRetryingTransactionHelper().doInTransaction(testCallback);
}
};
AuthenticationUtil.runAs(testRunAs, "SomeOtherUser");
}
private Map auditTestAction(
final String action,
NodeRef nodeRef,
Map parameters)
{
final Map adjustedValues = new HashMap(parameters.size() * 2);
// Add the noderef
adjustedValues.put(AuditApplication.buildPath("context-node"), nodeRef);
// Compile path-name snippets for the parameters
for (Map.Entry entry : parameters.entrySet())
{
String paramName = entry.getKey();
String path = AuditApplication.buildPath(action, "params", paramName);
adjustedValues.put(path, entry.getValue());
}
RetryingTransactionCallback