ACS-3170 Implement Tests For Mail Actions (#1213)

Added tests for restApi with all 4 external endpoints kept track of (running-actions from v0 wasn't needed, as that only allows admin to run actions).
Unit tests added, 1 spring test to verify admin privilege check in AccessRestriction class.

Co-authored-by: mstrankowski <marcin.strankowski@hyland.com>
This commit is contained in:
Grzegorz Oleksy
2022-07-18 12:37:22 +02:00
committed by GitHub
parent 5cb66ebbd0
commit 57f02054c4
13 changed files with 852 additions and 2 deletions

View File

@@ -51,6 +51,10 @@ import org.junit.runners.Suite;
org.alfresco.repo.action.executer.ContentMetadataEmbedderTest.class,
org.alfresco.repo.action.executer.AsynchronousExtractorTest.class,
org.alfresco.repo.action.access.ActionAccessRestrictionAbstractBaseTest.class,
org.alfresco.repo.action.access.ActionAccessRestrictionTest.class,
org.alfresco.repo.action.access.AdminActionAccessRestrictionTest.class,
org.alfresco.repo.rule.RuleLinkTest.class,
org.alfresco.repo.rule.RuleServiceCoverageTest.class,
org.alfresco.repo.rule.RuleServiceImplTest.class,

View File

@@ -0,0 +1,127 @@
/*
* #%L
* Alfresco Repository
* %%
* Copyright (C) 2005 - 2022 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.repo.action.access;
import org.alfresco.repo.action.ActionImpl;
import org.alfresco.service.cmr.action.Action;
import org.junit.Before;
import org.junit.Test;
import org.springframework.lang.NonNull;
import java.util.Properties;
import static org.junit.Assert.assertThrows;
public class ActionAccessRestrictionAbstractBaseTest {
private static final String GLOBAL_PROPERTIES_ACTION_EXPOSE_PREFIX = "org.alfresco.repo.action";
private static final String GLOBAL_PROPERTIES_ACTION_EXPOSE_SUFFIX = ".exposed";
private static final String CONTROLLED_CONTEXT = ActionAccessRestriction.V1_ACTION_CONTEXT;
private static final String NONCONTROLLED_CONTEXT = "random321";
private static final String MAIL_ACTION = "mail";
private ActionAccessRestrictionAbstractBase accessRestriction;
private Properties globalProperties;
@Before
public void setup() {
globalProperties = new Properties();
accessRestriction = new ActionAccessRestrictionAbstractBase() {
@Override
protected void innerVerifyAccessRestriction(Action action) {
throw new ActionAccessException("Executing verification");
}
};
accessRestriction.setConfigProperties(globalProperties);
}
@Test
public void skipVerificationForNullContext() {
Action action = getActionWithContext(MAIL_ACTION, null);
accessRestriction.verifyAccessRestriction(action);
}
@Test
public void skipVerificationForNonControlledContext() {
Action action = getActionWithContext(MAIL_ACTION, NONCONTROLLED_CONTEXT);
accessRestriction.verifyAccessRestriction(action);
}
@Test
public void callVerificationForControlledContext() {
Action action = getActionWithContext(MAIL_ACTION, CONTROLLED_CONTEXT);
assertThrows(ActionAccessException.class, () -> accessRestriction.verifyAccessRestriction(action));
}
@Test
public void skipVerificationForExposedActionConfig() {
setGlobalPropertiesActionExposed(MAIL_ACTION, null, true);
Action action = getActionWithContext(MAIL_ACTION, CONTROLLED_CONTEXT);
accessRestriction.verifyAccessRestriction(action);
}
@Test
public void skipVerificationForExposedActionContextConfig() {
setGlobalPropertiesActionExposed(MAIL_ACTION, CONTROLLED_CONTEXT, true);
Action action = getActionWithContext(MAIL_ACTION, CONTROLLED_CONTEXT);
accessRestriction.verifyAccessRestriction(action);
}
@Test
public void callVerificationForNonExposedActionConfig() {
setGlobalPropertiesActionExposed(MAIL_ACTION, null, false);
Action action = getActionWithContext(MAIL_ACTION, CONTROLLED_CONTEXT);
assertThrows(ActionAccessException.class, () -> accessRestriction.verifyAccessRestriction(action));
}
@Test
public void callVerificationForNonExposedActionContextConfig() {
setGlobalPropertiesActionExposed(MAIL_ACTION, CONTROLLED_CONTEXT, false);
Action action = getActionWithContext(MAIL_ACTION, CONTROLLED_CONTEXT);
assertThrows(ActionAccessException.class, () -> accessRestriction.verifyAccessRestriction(action));
}
private Action getActionWithContext(String actionName, String context) {
Action action = new ActionImpl(null, "12345", actionName);
ActionAccessRestriction.setActionContext(action, context);
return action;
}
private void setGlobalPropertiesActionExposed(@NonNull String action, String context, boolean isExposed) {
StringBuilder property = new StringBuilder(GLOBAL_PROPERTIES_ACTION_EXPOSE_PREFIX);
property.append("." + action);
if (context != null) {
property.append("." + context);
}
property.append(GLOBAL_PROPERTIES_ACTION_EXPOSE_SUFFIX);
globalProperties.setProperty(property.toString(), Boolean.toString(isExposed));
}
}

View File

@@ -0,0 +1,43 @@
/*
* #%L
* Alfresco Repository
* %%
* Copyright (C) 2005 - 2022 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.repo.action.access;
import org.alfresco.repo.action.ActionImpl;
import org.alfresco.service.cmr.action.Action;
import org.junit.Test;
import static org.junit.Assert.assertEquals;
public class ActionAccessRestrictionTest {
@Test
public void testSettingContext() {
Action mailAction = new ActionImpl(null, "12345", "mail");
ActionAccessRestriction.setActionContext(mailAction, ActionAccessRestriction.RULE_ACTION_CONTEXT);
assertEquals(ActionAccessRestriction.RULE_ACTION_CONTEXT, ActionAccessRestriction.getActionContext(mailAction));
}
}

View File

@@ -0,0 +1,89 @@
/*
* #%L
* Alfresco Repository
* %%
* Copyright (C) 2005 - 2022 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.repo.action.access;
import org.alfresco.repo.action.ActionImpl;
import org.alfresco.repo.security.authentication.AuthenticationUtil;
import org.alfresco.service.cmr.action.Action;
import org.alfresco.util.BaseSpringTest;
import org.junit.Before;
import org.junit.Test;
import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;
import static org.junit.Assert.assertThrows;
public class AdminActionAccessRestrictionTest extends BaseSpringTest {
private static final String MAIL_ACTION = "mail";
private static final String CONTROLLED_CONTEXT = ActionAccessRestriction.V1_ACTION_CONTEXT;
private ActionAccessRestriction adminActionAccessRestriction;
@Before
public void setup() {
adminActionAccessRestriction = applicationContext.getBean("adminActionAccessRestriction", AdminActionAccessRestriction.class);
}
@Test
public void adminCanExecute() {
AuthenticationUtil.setFullyAuthenticatedUser(AuthenticationUtil.getAdminUserName());
Action action = createMailAction();
adminActionAccessRestriction.verifyAccessRestriction(action);
}
@Test
public void systemCanExecute() {
AuthenticationUtil.setRunAsUserSystem();
Action action = createMailAction();
adminActionAccessRestriction.verifyAccessRestriction(action);
}
@Test
public void userCantExecute() {
AuthenticationUtil.setFullyAuthenticatedUser(AuthenticationUtil.getGuestUserName());
Action action = createMailAction();
assertThrows(ActionAccessException.class, () -> adminActionAccessRestriction.verifyAccessRestriction(action));
}
private Action createMailAction() {
Map<String, Serializable> params = new HashMap<>();
params.put("from", "admin@alfresco.com");
params.put("to", "test@wp.pl");
params.put("subject", "test");
params.put("text", "test");
Action action = new ActionImpl(null, "123", MAIL_ACTION, params);
ActionAccessRestriction.setActionContext(action, CONTROLLED_CONTEXT);
return action;
}
}