org.opencms.ui.contextmenu.TestCmsContextMenu Maven / Gradle / Ivy
Show all versions of opencms-test Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* This library 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 2.1 of the License, or (at your option) any later version.
*
* This library 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.
*
* For further information about Alkacon Software, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.ui.contextmenu;
import org.opencms.file.CmsObject;
import org.opencms.file.CmsProject;
import org.opencms.file.CmsResource;
import org.opencms.test.OpenCmsTestCase;
import org.opencms.ui.I_CmsDialogContext;
import org.opencms.ui.components.CmsBasicDialog.DialogWidth;
import org.opencms.util.CmsTreeNode;
import org.opencms.util.CmsUUID;
import java.lang.reflect.InvocationTargetException;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Locale;
import com.vaadin.ui.Component;
import com.vaadin.ui.Window;
import junit.framework.TestSuite;
/**
* Tests context menu construction.
*/
public class TestCmsContextMenu extends OpenCmsTestCase {
public TestCmsContextMenu(String name) {
super(name);
}
public static TestSuite suite() {
try {
return generateTestSuite(TestCmsContextMenu.class);
} catch (NoSuchMethodException | InstantiationException | IllegalAccessException
| InvocationTargetException e) {
e.printStackTrace();
return null;
}
}
/**
* Tests building the context menu tree.
*/
public void testBuildTree() {
List items = Arrays.asList(
entry("foo", null, 0, 0),
entry("bar", null, 0, 1),
entry("baz", "foo", 0, 2),
entry("qux", "foo", 0, 3));
I_CmsDialogContext context = createDummyContext();
CmsContextMenuTreeBuilder builder = new CmsContextMenuTreeBuilder(context);
CmsTreeNode root = builder.buildTree(items);
List> topLevel = root.getChildren();
assertEquals(2, topLevel.size());
assertEquals("foo", topLevel.get(0).getData().getId());
assertEquals("bar", topLevel.get(1).getData().getId());
assertEquals(2, topLevel.get(0).getChildren().size());
assertEquals(0, topLevel.get(1).getChildren().size());
assertEquals("baz", topLevel.get(0).getChildren().get(0).getData().getId());
assertEquals("qux", topLevel.get(0).getChildren().get(1).getData().getId());
}
/**
* Tests that context menu items with higher priorities override those with lower ones.
*/
public void testOverride() {
List items = Arrays.asList(
entry("foo", null, 0, 0),
entry("foo", null, 100, 100),
entry("foo", null, 1, 1));
I_CmsDialogContext context = createDummyContext();
CmsContextMenuTreeBuilder builder = new CmsContextMenuTreeBuilder(context);
CmsTreeNode root = builder.buildTree(items);
List> topLevel = root.getChildren();
assertEquals(1, topLevel.size());
assertEquals(100, topLevel.get(0).getData().getPriority());
}
/**
* Tests that items cyclically referring to each other via the parent id are not included in the context menu tree.
*/
public void testRemoveCycles() {
List items = Arrays.asList(
entry("foo", null, 0, 0),
entry("bar", "baz", 0, 1),
entry("baz", "bar", 0, 2));
I_CmsDialogContext context = createDummyContext();
CmsContextMenuTreeBuilder builder = new CmsContextMenuTreeBuilder(context);
CmsTreeNode root = builder.buildTree(items);
List> topLevel = root.getChildren();
assertEquals(1, topLevel.size());
assertEquals("foo", topLevel.get(0).getData().getId());
}
/**
* Tests the USE_NEXT visibility mode.
*/
public void testUseNext1() {
I_CmsContextMenuItem foo1 = entry("foo", null, 1, 100, CmsMenuItemVisibilityMode.VISIBILITY_ACTIVE);
I_CmsContextMenuItem foo2 = entry("foo", null, 2, 200, CmsMenuItemVisibilityMode.VISIBILITY_USE_NEXT);
I_CmsContextMenuItem bar = entry("bar", null, 3, 200, CmsMenuItemVisibilityMode.VISIBILITY_ACTIVE);
List items = Arrays.asList(foo1, foo2, bar);
I_CmsDialogContext context = createDummyContext();
CmsContextMenuTreeBuilder builder = new CmsContextMenuTreeBuilder(context);
CmsTreeNode root = builder.buildTree(items);
List> topLevel = root.getChildren();
assertEquals(2, topLevel.size());
assertIsIdentical(foo1, topLevel.get(0).getData());
assertIsIdentical(bar, topLevel.get(1).getData());
}
/**
* Tests the USE_NEXT visibility mode.
*/
public void testUseNext2() {
I_CmsContextMenuItem foo1 = entry("foo", null, 1, 100, CmsMenuItemVisibilityMode.VISIBILITY_USE_NEXT);
I_CmsContextMenuItem foo2 = entry("foo", null, 2, 200, CmsMenuItemVisibilityMode.VISIBILITY_USE_NEXT);
I_CmsContextMenuItem bar = entry("bar", null, 3, 200, CmsMenuItemVisibilityMode.VISIBILITY_ACTIVE);
List items = Arrays.asList(foo1, foo2, bar);
I_CmsDialogContext context = createDummyContext();
CmsContextMenuTreeBuilder builder = new CmsContextMenuTreeBuilder(context);
CmsTreeNode root = builder.buildTree(items);
List> topLevel = root.getChildren();
assertEquals(1, topLevel.size());
assertIsIdentical(bar, topLevel.get(0).getData());
}
/**
* Tests the USE_NEXT visibility mode.
*/
public void testUseNext3() {
I_CmsContextMenuItem foo1 = entry("foo", null, 1, 100, CmsMenuItemVisibilityMode.VISIBILITY_ACTIVE);
I_CmsContextMenuItem foo2 = entry("foo", null, 1, 150, CmsMenuItemVisibilityMode.VISIBILITY_USE_NEXT);
I_CmsContextMenuItem foo3 = entry("foo", null, 2, 200, CmsMenuItemVisibilityMode.VISIBILITY_INVISIBLE);
I_CmsContextMenuItem bar = entry("bar", null, 3, 200, CmsMenuItemVisibilityMode.VISIBILITY_ACTIVE);
List items = Arrays.asList(foo1, foo2, foo3, bar);
I_CmsDialogContext context = createDummyContext();
CmsContextMenuTreeBuilder builder = new CmsContextMenuTreeBuilder(context);
CmsTreeNode root = builder.buildTree(items);
List> topLevel = root.getChildren();
assertEquals(1, topLevel.size());
assertIsIdentical(bar, topLevel.get(0).getData());
}
I_CmsDialogContext createDummyContext() {
return new I_CmsDialogContext() {
@Override
public void error(Throwable error) {
// TODO Auto-generated method stub
}
@Override
public void finish(CmsProject project, String siteRoot) {
// TODO Auto-generated method stub
}
@Override
public void finish(Collection result) {
// TODO Auto-generated method stub
}
@Override
public void focus(CmsUUID structureId) {
// TODO Auto-generated method stub
}
@Override
public List getAllStructureIdsInView() {
// TODO Auto-generated method stub
return null;
}
@Override
public String getAppId() {
// TODO Auto-generated method stub
return null;
}
@Override
public CmsObject getCms() {
// TODO Auto-generated method stub
return null;
}
@Override
public ContextType getContextType() {
// TODO Auto-generated method stub
return null;
}
@Override
public List getResources() {
return Collections.emptyList();
}
@Override
public void navigateTo(String appId) {
// TODO Auto-generated method stub
}
@Override
public void onViewChange() {
// TODO Auto-generated method stub
}
@Override
public void reload() {
// TODO Auto-generated method stub
}
@Override
public void setWindow(Window window) {
// TODO Auto-generated method stub
}
@Override
public void start(String title, Component dialog) {
// TODO Auto-generated method stub
}
@Override
public void start(String title, Component dialog, DialogWidth width) {
// TODO Auto-generated method stub
}
@Override
public void updateUserInfo() {
// TODO Auto-generated method stub
}
};
}
/**
* Helper method to construct a context menu item.
*
* @param id the id
* @param parentId the parent id
* @param priority the priority
* @param order the order
*
* @return the context menu item
*/
private I_CmsContextMenuItem entry(final String id, final String parentId, final int priority, final float order) {
return new I_CmsContextMenuItem() {
public void executeAction(I_CmsDialogContext context) {
// TODO Auto-generated method stub
}
public String getId() {
return id;
}
public float getOrder() {
return order;
}
public String getParentId() {
return parentId;
}
public int getPriority() {
return priority;
}
public String getTitle(Locale locale) {
return id;
}
public CmsMenuItemVisibilityMode getVisibility(CmsObject cms, List resources) {
return CmsMenuItemVisibilityMode.VISIBILITY_ACTIVE;
}
public CmsMenuItemVisibilityMode getVisibility(I_CmsDialogContext context) {
return CmsMenuItemVisibilityMode.VISIBILITY_ACTIVE;
}
public boolean isLeafItem() {
return false;
}
};
}
/**
* Helper method to construct a context menu item.
*
* @param id the id
* @param parentId the parent id
* @param priority the priority
* @param order the order
*
* @return the context menu item
*/
private I_CmsContextMenuItem entry(
final String id,
final String parentId,
final int priority,
final float order,
CmsMenuItemVisibilityMode visibility) {
return new I_CmsContextMenuItem() {
public void executeAction(I_CmsDialogContext context) {
// TODO Auto-generated method stub
}
public String getId() {
return id;
}
public float getOrder() {
return order;
}
public String getParentId() {
return parentId;
}
public int getPriority() {
return priority;
}
public String getTitle(Locale locale) {
return id;
}
public CmsMenuItemVisibilityMode getVisibility(CmsObject cms, List resources) {
return visibility;
}
public CmsMenuItemVisibilityMode getVisibility(I_CmsDialogContext context) {
return visibility;
}
public boolean isLeafItem() {
return false;
}
};
}
}