/*
 * Copyright (C) 2005-2007 Alfresco Software Limited.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.

 * This program 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 General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

 * As a special exception to the terms and conditions of version 2.0 of 
 * the GPL, you may redistribute this Program in connection with Free/Libre 
 * and Open Source Software ("FLOSS") applications as described in Alfresco's 
 * FLOSS exception.  You should have recieved a copy of the text describing 
 * the FLOSS exception, and it is also available here: 
 * http://www.alfresco.com/legal/licensing"
 */
package org.alfresco.web.config;

import java.io.File;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.alfresco.config.Config;
import org.alfresco.config.ConfigElement;
import org.alfresco.config.ConfigException;
import org.alfresco.config.source.FileConfigSource;
import org.alfresco.config.xml.XMLConfigService;
import org.alfresco.util.BaseTest;
import org.alfresco.web.config.ActionsConfigElement.ActionDefinition;
import org.alfresco.web.config.ActionsConfigElement.ActionGroup;
import org.alfresco.web.config.AdvancedSearchConfigElement.CustomProperty;
import org.alfresco.web.config.DefaultControlsConfigElement.ControlParam;
import org.alfresco.web.config.DialogsConfigElement.DialogConfig;
import org.alfresco.web.config.PropertySheetConfigElement.ItemConfig;
import org.alfresco.web.config.WizardsConfigElement.ConditionalPageConfig;
import org.alfresco.web.config.WizardsConfigElement.PageConfig;
import org.alfresco.web.config.WizardsConfigElement.StepConfig;
import org.alfresco.web.config.WizardsConfigElement.WizardConfig;

/**
 * JUnit tests to exercise the capabilities added to the web client config
 * service
 * 
 * @author gavinc, neil
 */
public class WebClientConfigTest extends BaseTest
{
   /**
    * @see junit.framework.TestCase#setUp()
    */
   protected void setUp() throws Exception
   {
      super.setUp();
   }

   /**
    * Tests the property sheet configuration classes
    */
   public void testPropertySheetConfig()
   {
      XMLConfigService svc = initXMLConfigService("test-config.xml");

      // get hold of the property sheet config from the global section
      Config global = svc.getGlobalConfig();
      ConfigElement globalPropSheet = global.getConfigElement("property-sheet");
      assertNotNull("global property sheet element should not be null", globalPropSheet);
      assertTrue("config element should be an instance of PropertySheetConfigElement",
            (globalPropSheet instanceof PropertySheetConfigElement));

      // get the property names from the global section and make sure it is the
      // name property
      List<String> propNames = ((PropertySheetConfigElement) globalPropSheet).getItemNamesToShow();
      assertTrue("There should only be one property in the list", propNames.size() == 1);
      assertTrue("The property name should be 'name'", propNames.get(0).equals("name"));

      // get the config section representing a space aspect and make sure we get
      // 5 properties
      Config spaceAspectConfig = svc.getConfig("space-aspect");
      assertNotNull("Space aspect config should not be null", spaceAspectConfig);
      PropertySheetConfigElement spacePropConfig = (PropertySheetConfigElement) spaceAspectConfig
            .getConfigElement("property-sheet");
      assertNotNull("Space aspect property config should not be null", spacePropConfig);
      propNames = spacePropConfig.getItemNamesToShow();
      assertTrue("There should be 6 properties in the list", propNames.size() == 6);

      // make sure the property sheet config has come back with the correct data
      Map<String, ItemConfig> props = spacePropConfig.getItemsToShow();
      ItemConfig descProp = props.get("description");
      assertNotNull("description property config should not be null", descProp);
      assertEquals("display label for description should be 'Description'", descProp.getDisplayLabel(), 
            "Description");
      assertFalse("read only for description should be 'false'", descProp.isReadOnly());

      ItemConfig createdDataProp = props.get("createddate");
      assertNotNull("createddate property config should not be null", createdDataProp);
      assertEquals("display label for createddate should be null", null, createdDataProp.getDisplayLabel());
      assertTrue("read only for createddate should be 'true'", createdDataProp.isReadOnly());
      assertTrue("ignoreIfMissing for createddate should be 'true'", createdDataProp.getIgnoreIfMissing());

      ItemConfig iconProp = props.get("icon");
      assertNotNull("icon property config should not be null", iconProp);
      assertEquals("display label for icon should be null", null, iconProp.getDisplayLabel());
      assertEquals("component-generator", "SpaceIconPickerGenerator", iconProp.getComponentGenerator());
      assertFalse("read only for icon should be 'false'", iconProp.isReadOnly());
      assertFalse("ignoreIfMissing for icon should be 'false'", iconProp.getIgnoreIfMissing());
      
      // test that a call to the generic getChildren call throws an error
      try
      {
         spacePropConfig.getChildren();
         fail("getChildren() did not throw an excpetion");
      }
      catch (ConfigException ce)
      {
         // expected
      } 
   }

   
   public void testPropertyViewing()
   {
      XMLConfigService svc = initXMLConfigService("test-config.xml");
      
      Config propViewConfig = svc.getConfig("Property Viewing");
      assertNotNull("Property Viewing section should not be null", propViewConfig);
      
      PropertySheetConfigElement propSheet = (PropertySheetConfigElement)propViewConfig.
            getConfigElement("property-sheet");
      assertNotNull("property-sheet config should not be null", propSheet);
      
      // make sure the all items map works correctly
      Map<String, ItemConfig> allItems = propSheet.getItems();
      assertNotNull("allItems should not be null", allItems);
      assertEquals("Total number of properties", 5, allItems.size());
      assertNotNull("name property is missing", allItems.get("name"));
      assertNotNull("description property is missing", allItems.get("description"));
      assertNotNull("icon property is missing", allItems.get("icon"));
      assertNotNull("size property is missing", allItems.get("size"));
      assertNotNull("uuid property is missing", allItems.get("uuid"));
      
      // make sure the viewable properties list is correct
      List<String> itemsToShow = propSheet.getItemNamesToShow();
      assertNotNull("itemsToShow should not be null", itemsToShow);
      assertEquals("Number of viewable properties", 3, itemsToShow.size());
      assertEquals("first viewable property name", "name", itemsToShow.get(0));
      assertEquals("second viewable property name", "description", itemsToShow.get(1));
      assertEquals("third viewable property name", "size", itemsToShow.get(2));
      
      // make sure the editable properties list is correct
      List<String> editItems = propSheet.getEditableItemNamesToShow();
      assertNotNull("editItems should not be null", editItems);
      assertEquals("Number of editable properties", 3, editItems.size());
      assertEquals("first viewable property name", "name", editItems.get(0));
      assertEquals("second viewable property name", "description", editItems.get(1));
      assertEquals("third viewable property name", "icon", editItems.get(2));
   }
   
   public void testPropertyEditing()
   {
      XMLConfigService svc = initXMLConfigService("test-config.xml");
      
      Config propEditConfig = svc.getConfig("Property Editing");
      assertNotNull("Property Editing section should not be null", propEditConfig);
      
      PropertySheetConfigElement propSheet = (PropertySheetConfigElement)propEditConfig.
            getConfigElement("property-sheet");
      assertNotNull("property-sheet config should not be null", propSheet);
            
      // make sure the list of names method works correctly
      List<String> itemNamesToEdit = propSheet.getEditableItemNamesToShow();
      assertNotNull("itemNamesToEdit should not be null", itemNamesToEdit);
      assertEquals("Number of properties", 3, itemNamesToEdit.size());
      
      // make sure the property names are correct
      assertEquals("first property name", "name", itemNamesToEdit.get(0));
      assertEquals("second property name", "description", itemNamesToEdit.get(1));
      assertEquals("third property name", "icon", itemNamesToEdit.get(2));
      
      // make sure the map has the correct number of items
      Map<String, ItemConfig> itemsToEditMap = propSheet.getEditableItemsToShow();
      assertNotNull("itemsToEditMap should not be null", itemsToEditMap);
      assertEquals("Number of properties", 3, itemsToEditMap.size());
      
      // make sure the icon property is set as read only
      ItemConfig item = itemsToEditMap.get("icon");
      assertNotNull("icon should not be null", item);
      assertTrue("icon property readOnly status should be true", item.isReadOnly());
      
      // make the size property is unavailable
      item = itemsToEditMap.get("size");
      assertNull("size should be null", item);
      
      // make sure the list has the correct numbe of items
      Collection<ItemConfig> itemsToEdit = propSheet.getEditableItemsToShow().values();
      assertNotNull("itemsToEdit should not be null", itemsToEdit);
      assertEquals("Number of properties", 3, itemsToEdit.size());
   }
   
   public void testPropertyOverride()
   {
      XMLConfigService svc = initXMLConfigService("test-config.xml", "test-config-override.xml");
      
      // get the config for the size property in the space-aspect property sheet
      PropertySheetConfigElement propSheet = ((PropertySheetConfigElement)svc.getConfig("space-aspect").
            getConfigElement(PropertySheetConfigElement.CONFIG_ELEMENT_ID));
      assertNotNull("propSheet should not be null", propSheet);
      
      // make sure the list and map numbers are correct
      assertEquals("prop names to show size", 6, propSheet.getItemNamesToShow().size());
      assertEquals("props to show size", 6, propSheet.getItemsToShow().size());
      assertEquals("edit prop names to show size", 5, propSheet.getEditableItemNamesToShow().size());
      assertEquals("edit props to show size", 5, propSheet.getEditableItemsToShow().size());
      
      PropertySheetConfigElement.PropertyConfig propConfig = 
         (PropertySheetConfigElement.PropertyConfig)propSheet.getItemsToShow().get("size");
      assertNotNull("propConfig should not be null", propConfig);
      
      // make sure config has been overridden
      assertTrue("size should be shown in edit mode", propConfig.isShownInEditMode());
      assertTrue("size property should be read only", propConfig.isReadOnly());
      assertNotNull("size property should be in edit map", propSheet.getEditableItemsToShow().get("size"));
      
      // get the icon 
      propConfig = (PropertySheetConfigElement.PropertyConfig)propSheet.getItemsToShow().get("icon");
      assertNotNull("propConfig should not be null", propConfig);
      
      //
      // test the overridding of viewable/editable items
      //
      
      propSheet = ((PropertySheetConfigElement)svc.getConfig("Property Viewing").
            getConfigElement(PropertySheetConfigElement.CONFIG_ELEMENT_ID));
      assertNotNull("property-sheet config should not be null", propSheet);
      
      // make sure the all items map works correctly
      Map<String, ItemConfig> allItems = propSheet.getItems();
      assertNotNull("allItems should not be null", allItems);
      assertEquals("Total number of properties", 5, allItems.size());
      assertNotNull("name property is missing", allItems.get("name"));
      assertNotNull("description property is missing", allItems.get("description"));
      assertNotNull("icon property is missing", allItems.get("icon"));
      assertNotNull("size property is missing", allItems.get("size"));
      assertNotNull("uuid property is missing", allItems.get("uuid"));
      
      // make sure the viewable properties list is correct
      List<String> itemsToShow = propSheet.getItemNamesToShow();
      assertNotNull("itemsToShow should not be null", itemsToShow);
      assertEquals("Number of viewable properties", 4, itemsToShow.size());
      assertEquals("first viewable property name", "name", itemsToShow.get(0));
      assertEquals("second viewable property name", "size", itemsToShow.get(1));
      assertEquals("third viewable property name", "icon", itemsToShow.get(2));
      assertEquals("third viewable property name", "uuid", itemsToShow.get(3));
      
      // make sure the editable properties list is correct
      List<String> editItems = propSheet.getEditableItemNamesToShow();
      assertNotNull("editItems should not be null", editItems);
      assertEquals("Number of editable properties", 3, editItems.size());
      assertEquals("first viewable property name", "name", editItems.get(0));
      assertEquals("second viewable property name", "icon", editItems.get(1));
      assertEquals("third viewable property name", "uuid", editItems.get(2));
    
      // make sure icon is no longer read-only
      ItemConfig iconCfg = propSheet.getItemsToShow().get("icon");
      assertNotNull("iconCfg not should not be null", iconCfg);
      assertFalse("icon should not be read-only", iconCfg.isReadOnly());
      assertTrue("icon should be shown in view mode", iconCfg.isShownInViewMode());
      assertTrue("icon should be shown in edit mode", iconCfg.isShownInEditMode());
      assertFalse("ignoreIfMissing for icon should be 'false'", iconCfg.getIgnoreIfMissing());
   }
   
   /**
    * Tests the custom client configuration objects 
    */
   public void testClientConfig()
   {
      XMLConfigService svc = initXMLConfigService("test-config.xml");
      
      // get the global config and from that the client config
      ClientConfigElement clientConfig = (ClientConfigElement)svc.getGlobalConfig().
         getConfigElement(ClientConfigElement.CONFIG_ELEMENT_ID);
      assertNotNull("client config", clientConfig);
      
      assertEquals("error page", "/jsp/error.jsp", clientConfig.getErrorPage());
      assertEquals("login page", "/jsp/login.jsp", clientConfig.getLoginPage());
      assertEquals("home space permission", "Consumer", clientConfig.getHomeSpacePermission());
      assertEquals("help url", "http://www.alfresco.org/help/webclient", clientConfig.getHelpUrl());
      assertEquals("edit link type", "http", clientConfig.getEditLinkType());
      assertEquals("from address", "alfresco@alfresco.org", clientConfig.getFromEmailAddress());
      assertEquals("recent spaces", 6, clientConfig.getRecentSpacesItems());
      assertEquals("search minimum", 3, clientConfig.getSearchMinimum());
      assertTrue("shelf visible", clientConfig.isShelfVisible());
   }
   
   public void testClientOverride()
   {
      XMLConfigService svc = initXMLConfigService("test-config.xml", "test-config-override.xml");
        
      // try and get the global config section
      Config globalSection = svc.getGlobalConfig();
      assertNotNull("global section", globalSection);
      
      // get the client config
      ClientConfigElement clientConfig = (ClientConfigElement)globalSection.
            getConfigElement(ClientConfigElement.CONFIG_ELEMENT_ID);
      assertNotNull("client config", clientConfig);
      
      // make sure the error page is still set as the default
      assertEquals("error page", "/jsp/error.jsp", clientConfig.getErrorPage());
      assertEquals("login page", "/jsp/login-override.jsp", clientConfig.getLoginPage());
      assertEquals("home space permission", "Editor", clientConfig.getHomeSpacePermission());
      assertEquals("help url", "http://www.somewhere.com/help", clientConfig.getHelpUrl());
      assertEquals("edit link type", "webdav", clientConfig.getEditLinkType());
      assertEquals("from address", "me@somewhere.com", clientConfig.getFromEmailAddress());
      assertEquals("recent spaces", 1, clientConfig.getRecentSpacesItems());
      assertEquals("search minimum", 10, clientConfig.getSearchMinimum());
      assertFalse("shelf visible", clientConfig.isShelfVisible());
   }
   
   /**
    * Tests the navigation config i.e. the custom element reader and config element
    */
   public void testNavigation()
   {
      XMLConfigService svc = initXMLConfigService("test-config.xml");

      // *** Test the returning of a view id override
      Config testCfg = svc.getConfig("viewid-navigation-result");
      assertNotNull("viewid-navigation-result config should not be null", testCfg);
      
      NavigationConfigElement navCfg = (NavigationConfigElement)testCfg.getConfigElement("navigation");
      assertNotNull("navigation config should not be null", navCfg);
      
      // get the result for the browse view id
      NavigationResult navResult = navCfg.getOverride("/jsp/browse/browse.jsp", null);
      assertEquals("result should be '/jsp/forums/forums.jsp'", "/jsp/forums/forums.jsp", 
            navResult.getResult());
      assertFalse("isOutcome test should be false", navResult.isOutcome());
      
      // get the result for the browse outcome
      navResult = navCfg.getOverride(null, "browse");
      assertEquals("result should be '/jsp/forums/topics.jsp'", "/jsp/forums/topics.jsp", 
            navResult.getResult());
      assertFalse("isOutcome test should be false", navResult.isOutcome());
      
      // get the result when passing both the browse view id and outcome, make
      // sure we get the result for the outcome as it should take precedence
      navResult = navCfg.getOverride("/jsp/browse/browse.jsp", "browse");
      assertEquals("result should be '/jsp/forums/topics.jsp'", "/jsp/forums/topics.jsp", 
            navResult.getResult());
      assertFalse("isOutcome test should be false", navResult.isOutcome());
      
      // *** Test the returning of an outcome override
      testCfg = svc.getConfig("outcome-navigation-result");
      assertNotNull("outcome-navigation-result config should not be null", testCfg);
      
      navCfg = (NavigationConfigElement)testCfg.getConfigElement("navigation");
      assertNotNull("navigation config should not be null", navCfg);
      
      // get the result for the browse view id
      navResult = navCfg.getOverride("/jsp/browse/browse.jsp", null);
      assertEquals("result should be 'showSomethingElse'", "showSomethingElse", 
            navResult.getResult());
      assertTrue("isOutcome test should be true", navResult.isOutcome());
      
      // get the result for the browse outcome
      navResult = navCfg.getOverride(null, "browse");
      assertEquals("result should be 'showSomethingElse'", "showSomethingElse", 
            navResult.getResult());
      assertTrue("isOutcome test should be true", navResult.isOutcome());
      
      // get the result when passing both the browse view id and outcome, make
      // sure we get the result for the outcome as it should take precedence
      navResult = navCfg.getOverride("/jsp/browse/browse.jsp", "browse");
      assertEquals("result should be 'showSomethingElse'", "showSomethingElse", 
            navResult.getResult());
      assertTrue("isOutcome test should be true", navResult.isOutcome());
      
      // *** Test the duplicate result config 
      testCfg = svc.getConfig("duplicate-navigation-overrides");
      assertNotNull("duplicate-navigation-overrides config should not be null", testCfg);
      
      navCfg = (NavigationConfigElement)testCfg.getConfigElement("navigation");
      assertNotNull("navigation config should not be null", navCfg);
      
      // make sure the outcome result is 'newOutcome'
      navResult = navCfg.getOverride(null, "browse");
      assertEquals("result should be 'newOutcome'", "newOutcome", 
            navResult.getResult());
      assertTrue("isOutcome test should be true", navResult.isOutcome());
      
      // call getOverride passing a valid view id but an invalid outcome
      // and make sure the result is null
      navResult = navCfg.getOverride("/jsp/browse/browse.jsp", "nonExistentOutcome");
      assertNull("result should be null", navResult);
   }
   
   public void testNavigationGenericConfig()
   {
      XMLConfigService svc = initXMLConfigService("test-config.xml");
      
      // do a lookup using the generic config elements and make sure the correct
      // info comes out
      Config testCfg = svc.getConfig("duplicate-navigation-overrides");
      assertNotNull("duplicate-navigation-overrides config should not be null", testCfg);
      
      ConfigElement ce = testCfg.getConfigElement("navigation");
      assertNotNull("navigation config should not be null", ce);
      
      List<ConfigElement> children = ce.getChildren();
      assertNotNull(children);
      
      // make sure there are 2 children
      assertEquals("There should be 2 children", 2, children.size());
      
      // get the first child and make sure the attributes are correct,
      // from-view-id should be '/jsp/browse/browse.jsp' and to-view-id
      // should be '/jsp/forums/forums.jsp'
      ConfigElement child = children.get(0);
      String fromViewId = child.getAttribute("from-view-id");
      String fromOutcome = child.getAttribute("from-outcome");
      String toViewId = child.getAttribute("to-view-id");
      String toOutcome = child.getAttribute("to-outcome");
      
      assertNull("fromOutcome", fromOutcome);
      assertNull("toOutcome", toOutcome);
      assertEquals("fromViewId", "/jsp/browse/browse.jsp", fromViewId);
      assertEquals("toViewId", "/jsp/forums/forums.jsp", toViewId);
      
      // get the second child and make sure the attributes are correct,
      // from-outcome should be 'browse' and to-outcome should be 'newOutcome'
      child = children.get(1);
      fromViewId = child.getAttribute("from-view-id");
      fromOutcome = child.getAttribute("from-outcome");
      toViewId = child.getAttribute("to-view-id");
      toOutcome = child.getAttribute("to-outcome");
      
      assertNull("fromViewId", fromViewId);
      assertNull("toViewId", toViewId);
      assertEquals("fromOutcome", "browse", fromOutcome);
      assertEquals("toOutcome", "newOutcome", toOutcome);
   }
   
   public void testLanguages()
   {
      XMLConfigService svc = initXMLConfigService("test-config.xml", "test-config-override.xml");
      
      LanguagesConfigElement config = (LanguagesConfigElement)svc.getConfig("Languages").
            getConfigElement(LanguagesConfigElement.CONFIG_ELEMENT_ID);
      assertNotNull("languages config", config);
      
      // make sure there are 3 languages returned
      assertEquals("number of languages", 4, config.getLanguages().size());
      
      // make sure they are returned in order
      assertEquals("first language", "en_US", config.getLanguages().get(0));
      assertEquals("second language", "fr_FR", config.getLanguages().get(1));
      assertEquals("third language", "de_DE", config.getLanguages().get(2));
      assertEquals("fourth language", "ja_JP", config.getLanguages().get(3));
      
      // make sure the labels are correct too
      assertEquals("en_US", "English", config.getLabelForLanguage("en_US"));
      assertEquals("fr_FR", "French", config.getLabelForLanguage("fr_FR"));
      assertEquals("de_DE", "German", config.getLabelForLanguage("de_DE"));
      assertEquals("ja_JP", "Japanese", config.getLabelForLanguage("ja_JP"));
      
      // make sure the getChildren method throws an exception
      try
      {
         config.getChildren();
         fail("getChildren() did not throw an excpetion");
      }
      catch (ConfigException ce)
      {
         // expected
      }
   }
   
   public void testAdvancedSearch()
   {
	  XMLConfigService svc = initXMLConfigService("test-config.xml", "test-config-override.xml");
      
      AdvancedSearchConfigElement config = (AdvancedSearchConfigElement)svc.getConfig("Advanced Search").
            getConfigElement(AdvancedSearchConfigElement.CONFIG_ELEMENT_ID);
      assertNotNull("advanced search config", config);
      
      // make sure there are 2 custom types
      assertEquals("number of content types", 2, config.getContentTypes().size());
      
      // make sure they are correct
      assertEquals("first type", "cm:dictionaryModel", config.getContentTypes().get(0));
      assertEquals("second type", "fm:post", config.getContentTypes().get(1));
      
      // make sure there are 3 custom properties
      assertEquals("number of content properties", 3, config.getCustomProperties().size());
      
      CustomProperty property = config.getCustomProperties().get(0);
      assertTrue("first property is type", property.Type != null);
      
      property = config.getCustomProperties().get(1);
      assertTrue("second property is aspect", property.Type == null);
      assertTrue("second property is aspect", property.Aspect != null);
      assertEquals("second property aspect", "app:simpleworkflow", property.Aspect);
      assertEquals("second property name", "app:approveStep", property.Property);
      
      property = config.getCustomProperties().get(2);
      assertEquals("third property name", "app:rejectStep", property.Property);
      assertEquals("third property display id", "reject_step", property.LabelId);
      
      // make sure the getChildren method throws an exception
      try
      {
         config.getChildren();
         fail("getChildren() did not throw an excpetion");
      }
      catch (ConfigException ce)
      {
         // expected
      }
   }
   
   public void testViews()
   {
	  XMLConfigService svc = initXMLConfigService("test-config.xml", "test-config-override.xml");
      
      ViewsConfigElement config = (ViewsConfigElement)svc.getConfig("Views").
            getConfigElement(ViewsConfigElement.CONFIG_ELEMENT_ID);
      assertNotNull("views config", config);
      
      // make sure there are 4 views
      List<String> views = config.getViews();
      assertEquals("configured views", 4, views.size());
      
      // make sure the views are correct
      assertEquals("details view renderer", 
            "org.alfresco.web.ui.common.renderer.data.RichListRenderer$DetailsViewRenderer", 
            views.get(0));
      assertEquals("icons view renderer", 
            "org.alfresco.web.ui.common.renderer.data.RichListRenderer$IconViewRenderer", 
            views.get(1));
      assertEquals("list view renderer", 
            "org.alfresco.web.ui.common.renderer.data.RichListRenderer$ListViewRenderer", 
            views.get(2));
      assertEquals("bubble view renderer", 
            "org.alfresco.web.bean.ForumsBean$TopicBubbleViewRenderer", views.get(3));

      // test default views 
      assertEquals("default view", "details", config.getDefaultView("not-there"));
      assertEquals("default view for topic", "bubble", config.getDefaultView("topic"));
      
      // test page sizes
      assertEquals("default page size", 10, config.getDefaultPageSize("not", "there"));
      assertEquals("forums icons page size", 20, config.getDefaultPageSize("forums", "icons"));
      assertEquals("forum details page size", 50, config.getDefaultPageSize("forum", "details"));
      assertEquals("icons view page size", 9, config.getDefaultPageSize("not-there", "icons"));
      
      // test the sort columns
      assertEquals("default sort column", "name", config.getDefaultSortColumn("not-there"));
      assertEquals("browse page sort column", "name", config.getDefaultSortColumn("browse"));
      assertEquals("forum page sort column", "modified", config.getDefaultSortColumn("forum"));
      assertEquals("topic page sort column", "created", config.getDefaultSortColumn("topic"));
      
      // test the sorting direction
      assertFalse("default sort direction should be ascending", config.hasDescendingSort("not-there"));
      assertFalse("browse screen should use an ascending sort", config.hasDescendingSort("browse"));
      assertTrue("topic screen should use a descending sort", config.hasDescendingSort("forum"));
      assertFalse("topic screen should use an ascending sort", config.hasDescendingSort("topic"));
      
      // make sure the getChildren method throws an exception
      try
      {
         config.getChildren();
         fail("getChildren() did not throw an excpetion");
      }
      catch (ConfigException ce)
      {
         // expected
      }
   }
   
   public void testDialogs()
   {
	  XMLConfigService svc = initXMLConfigService("test-config-dialogs-wizards.xml");
      
      // get Dialogs config section
      Config dialogsConfig = svc.getConfig("Dialogs");
      assertNotNull("dialogsConfig should not be null", dialogsConfig);
      
      // make sure the dialog-container is correct
      assertEquals("dialog container", "/jsp/dialog/container.jsp", 
            dialogsConfig.getConfigElement("dialog-container").getValue());
      
      // make sure a non existent dialog returns null
      assertNull("non existent dialog test should return null", 
            dialogsConfig.getConfigElement("Non Existent Dialog"));
      
      // get the dialogs element
      DialogsConfigElement dialogsElement = (DialogsConfigElement)dialogsConfig.
            getConfigElement(DialogsConfigElement.CONFIG_ELEMENT_ID);
      assertNotNull("dialogsElement should not be null", dialogsElement);
      
      // make sure there are 2 items in the list and map
      assertEquals("map size", 2, dialogsElement.getDialogs().size());
      
      // get the 'createSpace' dialog
      DialogConfig dialog = dialogsElement.getDialog("createSpace");
      assertNotNull("createSpace dialog config should not be null", dialog);
      
      // make sure the info on the dialog is correct
      assertEquals("name", "createSpace", dialog.getName());
      assertEquals("page", "/jsp/dialog/create-space.jsp", dialog.getPage());
      assertEquals("managed-bean", "NewSpaceDialog", dialog.getManagedBean());
      assertEquals("icon", "/images/icons/create_space_large.gif", dialog.getIcon());
      assertEquals("title-id", "create_space_title", dialog.getTitleId());
      assertEquals("subtitle-id", "create_space_subtitle", dialog.getSubTitleId());
      assertEquals("description-id", "create_space_description", dialog.getDescriptionId());
      assertEquals("error-message-id", "error_create_space_dialog", dialog.getErrorMessageId());
      assertEquals("actions-config-id", "space-actions", dialog.getActionsConfigId());
      assertEquals("more-actions-config-id", "more-actions", dialog.getMoreActionsConfigId());
      assertTrue("actions-as-menu should be true", dialog.getActionsAsMenu());
      assertEquals("actions-menu-label-id", "actions_menu_label", dialog.getActionsMenuLabelId());
      assertEquals("more-actions-menu-label-id", "more_actions_menu_label", dialog.getMoreActionsMenuLabelId());
      assertNull("title should be null", dialog.getTitle());
      assertNull("subtitle should be null", dialog.getSubTitle());
      assertNull("description should be null", dialog.getDescription());
      assertNull("actions-menu-label should be null", dialog.getActionsMenuLabel());
      assertNull("more-actions-menu-label should be null", dialog.getMoreActionsMenuLabel());
      
      // get the 'spaceDetails' dialog
      dialog = dialogsElement.getDialog("spaceDetails");
      assertNotNull("spaceDetails dialog config should not be null", dialog);
      
      // make sure the info on the dialog is correct
      assertEquals("name", "spaceDetails", dialog.getName());
      assertEquals("page", "/jsp/spaces/space-details.jsp", dialog.getPage());
      assertEquals("managed-bean", "SpaceDetailsDialog", dialog.getManagedBean());
      assertEquals("icon", "/images/icons/create_space_large.gif", dialog.getIcon());
      assertEquals("title", "Space Details Dialog", dialog.getTitle());
      assertEquals("subtitle", "Space details subtitle", dialog.getSubTitle());
      assertEquals("description", "Space Details Dialog Decsription", dialog.getDescription());
      assertEquals("error-message-id", "error_dialog", dialog.getErrorMessageId());
      assertEquals("actions-config-id", "space-actions", dialog.getActionsConfigId());
      assertNull("more-actions-config-id should be null", dialog.getMoreActionsConfigId());
      assertFalse("actions-as-menu should be false", dialog.getActionsAsMenu());
      assertEquals("actions-menu-label", "Create" , dialog.getActionsMenuLabel());
      assertEquals("more-actions-menu-label", "More Actions" , dialog.getMoreActionsMenuLabel());
      assertNull("title-id should be null", dialog.getTitleId());
      assertNull("subtitle-id should be null", dialog.getSubTitleId());
      assertNull("description-id should be null", dialog.getDescriptionId());
      assertNull("actions-menu-label-id should be null", dialog.getActionsMenuLabelId());
      assertNull("more-actions-menu-label-id should be null", dialog.getMoreActionsMenuLabelId());
   }
   
   public void testDialogOverride()
   {
	  XMLConfigService svc = initXMLConfigService("test-config-dialogs-wizards.xml", "test-config-override.xml");
      
      // get the 'dialogs' element
      DialogsConfigElement dialogsElement = ((DialogsConfigElement)svc.getConfig("Dialogs").
            getConfigElement(DialogsConfigElement.CONFIG_ELEMENT_ID));
      
      // make sure there are 2 items in the list and map
      assertEquals("map size", 2, dialogsElement.getDialogs().size());
      
      // get the 'createSpace' dialog
      DialogConfig dialog = dialogsElement.getDialog("createSpace");
      assertNotNull("createSpace dialog should not be null", dialog);
      
      // make sure the relevant attributes have been overridden
      assertEquals("page", "/custom/my-create-space.jsp", dialog.getPage());
      assertEquals("managed-bean", "MyNewSpaceDialog", dialog.getManagedBean());
      assertEquals("title-id", "my_create_space_title", dialog.getTitleId());
      assertEquals("description-id", "my_create_space_description", dialog.getDescriptionId());
      assertEquals("subtitle-id", "my_create_space_subtitle", dialog.getSubTitleId());
      assertEquals("actions-config-id", "my-space-actions", dialog.getActionsConfigId());
   }
   
   public void testWizards()
   {
	  XMLConfigService svc = initXMLConfigService("test-config-dialogs-wizards.xml");
      
      // get Dialogs config section
      Config wizardsConfig = svc.getConfig("Wizards");
      assertNotNull("wizardsConfig should not be null", wizardsConfig);
      
      // make sure the wizard-container is correct
      assertEquals("wizard container", "/jsp/wizard/container.jsp", 
            wizardsConfig.getConfigElement("wizard-container").getValue());
      
      // make sure a non existent wizard returns null
      assertNull("non existent wizard should not be null", 
            wizardsConfig.getConfigElement("Non Existent Wizard"));
      
      // get the wizards element
      WizardsConfigElement wizardsElement = (WizardsConfigElement)wizardsConfig.
            getConfigElement(WizardsConfigElement.CONFIG_ELEMENT_ID);
      assertNotNull("wizardsElement should not be null", wizardsElement);
      
      // make sure there are 2 items in the map
      assertEquals("map size", 2, wizardsElement.getWizards().size());
      
      // get the 'exampleWizard' wizard
      WizardConfig wizard = wizardsElement.getWizard("exampleWizard");
      assertNotNull("exampleWizard wizard should not be null", wizard);
            
      // make sure data is correct
      assertEquals("name", "exampleWizard", wizard.getName());
      assertEquals("exampleWizard steps", 2, wizard.getNumberSteps());
      assertEquals("managed-bean", "ExampleWizard", wizard.getManagedBean());
      assertEquals("icon", "/images/icons/example-logo.gif", wizard.getIcon());
      assertEquals("title", "Example Wizard Title", wizard.getTitle());
      assertEquals("subtitle", "Example wizard sub title", wizard.getSubTitle());
      assertEquals("description", "Example Wizard Description", wizard.getDescription());
      assertEquals("error-message-id", "error_wizard", wizard.getErrorMessageId());
      assertNull("title-id should be null", wizard.getTitleId());
      assertNull("subtitle-id should be null", wizard.getSubTitleId());
      assertNull("description-id should be null", wizard.getDescriptionId());
      
      // retrive step 1 config and check it is correct
      Map<String, StepConfig> stepsMap = wizard.getSteps();
      StepConfig step1 = stepsMap.get("details");
      assertNotNull("step 1 of example wizard should not be null", step1);
      assertEquals("step title", "Details", step1.getTitle());
      assertNull("step 1 title-id should be null", step1.getTitleId());
      
      // get the 'createSpace' wizard and ensure all the data is correct
      wizard = wizardsElement.getWizard("createSpace");
      assertEquals("name", "createSpace", wizard.getName());
      assertEquals("createSpace steps", 3, wizard.getNumberSteps());
      assertEquals("managed-bean", "AdvancedSpaceWizard", wizard.getManagedBean());
      assertEquals("icon", "/images/icons/create_space_large.gif", wizard.getIcon());
      assertEquals("title-id", "advanced_space_details_title", wizard.getTitleId());
      assertEquals("subtitle-id", "advanced_space_details_subtitle", wizard.getSubTitleId());
      assertEquals("description-id", "advanced_space_details_description", wizard.getDescriptionId());
      assertEquals("error-message-id", "error_create_space_wizard", wizard.getErrorMessageId());
      assertNull("title should be null", wizard.getTitle());
      assertNull("subtitle should be null", wizard.getSubTitle());
      assertNull("description should be null", wizard.getDescription());
      List<StepConfig> steps = wizard.getStepsAsList();
      assertNotNull("steps should not be null", steps);
      
      // retrieve step1 information and check it is correct
      step1 = steps.get(0);
      assertEquals("step 1 name", "details", step1.getName());
      assertEquals("step 1 title-id", "starting_space", step1.getTitleId());
      assertFalse("step 1 should not have conditional pages", step1.hasConditionalPages());
      PageConfig step1Page = step1.getDefaultPage();
      assertNotNull("step1Page should not be null", step1Page);
      assertEquals("step 1 page", "/jsp/wizard/new-space/create-from.jsp", step1Page.getPath());
      assertEquals("step 1 title-id", "create_space_details_title", step1Page.getTitleId());
      assertEquals("step 1 description-id", "create_space_details_desc", step1Page.getDescriptionId());
      assertEquals("step 1 instruction-id", "create_space_details_instruction", step1Page.getInstructionId());
      assertNull("step 1 title should be null", step1Page.getTitle());
      assertNull("step 1 description should be null", step1Page.getDescription());
      
      // check the conditional step2 data
      StepConfig step2 = steps.get(1);
      assertEquals("step 2 name", "properties", step2.getName());
      assertEquals("step 2 title-id", "space_options", step2.getTitleId());
      assertTrue("step 2 should have conditional pages", step2.hasConditionalPages());
      PageConfig step2DefaultPage = step2.getDefaultPage();
      assertNotNull("step 2 default page should not be null", step2DefaultPage);
      assertEquals("step 2 default page", "/jsp/wizard/new-space/from-scratch.jsp", step2DefaultPage.getPath());
      assertEquals("step 2 default title-id", "create_space_scratch_title", step2DefaultPage.getTitleId());
      assertEquals("step 2 default description-id", "create_space_scratch_desc", step2DefaultPage.getDescriptionId());
      assertEquals("step 2 default instruction-id", "create_space_scratch_instruction", step2DefaultPage.getInstructionId());
      assertNull("step 2 default title should be null", step2DefaultPage.getTitle());
      assertNull("step 2 default description should be null", step2DefaultPage.getDescription());
      List<ConditionalPageConfig> conditionalPages = step2.getConditionalPages();
      assertEquals("number of conditional pages for step 2", 1, conditionalPages.size());
      ConditionalPageConfig step2CondPage = conditionalPages.get(0);
      assertNotNull("step 2 cond page should not be null", step2CondPage);
      assertEquals("step 2 conditon", "#{AdvancedSpaceWizard.createFrom == 'template'}", step2CondPage.getCondition());
      assertEquals("step 2 cond page", "/jsp/wizard/new-space/from-template.jsp", step2CondPage.getPath());
      assertEquals("step 2 cond title-id", "create_space_template_title", step2CondPage.getTitleId());
      assertEquals("step 2 cond description-id", "create_space_template_desc", step2CondPage.getDescriptionId());
      assertEquals("step 2 cond instruction-id", "create_space_template_instruction", step2CondPage.getInstructionId());
      assertNull("step 2 cond title should be null", step2CondPage.getTitle());
      assertNull("step 2 cond description should be null", step2CondPage.getDescription());
      
      // check step 3 data
      StepConfig step3 = steps.get(2);
      assertEquals("step 3 name", "summary", step3.getName());
      assertEquals("step 3 title-id", "summary", step3.getTitleId());
      assertFalse("step 3 should not have conditional pages", step3.hasConditionalPages());
      PageConfig step3Page = step3.getDefaultPage();
      assertNotNull("step3Page should not be null", step3Page);
      assertEquals("step 3 page", "/jsp/wizard/new-space/summary.jsp", step3Page.getPath());
      assertEquals("step 3 title-id", "create_space_summary_title", step3Page.getTitleId());
      assertEquals("step 3 description-id", "create_space_summary_desc", step3Page.getDescriptionId());
      assertEquals("step 3 instruction-id", "create_space_summary_instruction", step3Page.getInstructionId());
      assertNull("step 3 title should be null", step3Page.getTitle());
      assertNull("step 3 description should be null", step3Page.getDescription());
   }
   
   public void testActions()
   {
      XMLConfigService svc = initXMLConfigService("test-config.xml");
      
      // get the "Actions" config
      Config cfg = svc.getGlobalConfig();
      assertNotNull("cfg should not be null", cfg);   
      
      // get the <actions> config element
      ActionsConfigElement actionsConfig = (ActionsConfigElement)cfg.
            getConfigElement(ActionsConfigElement.CONFIG_ELEMENT_ID);
      assertNotNull("actions config element should not be null", actionsConfig);
      
      // get the individual actions
      ActionDefinition docDetails = actionsConfig.getActionDefinition("details_doc");
      assertNotNull("details_doc action definition should not be null", docDetails);
      assertEquals("details_doc action", "dialog:showDocDetails", docDetails.Action);
      
      ActionDefinition spaceDetails = actionsConfig.getActionDefinition("details_space");
      assertNotNull("details_space action definition should not be null", spaceDetails);
      assertEquals("details_space action", "dialog:showSpaceDetails", spaceDetails.Action);
      
      // get the action group
      ActionGroup group = actionsConfig.getActionGroup("document_browse");
      assertNotNull("group definition should not be null", group);
      assertFalse("showLink for document_browse group should be false", group.ShowLink);
      for (String actionId : group)
      {
         if (actionId.equals("details_doc") == false &&
             actionId.equals("details_space") == false)
         {
            fail("Unrecognised action-id '" + actionId + "' in action group '" + group.getId() + "'");
         }
      }
   }
   
   public void testActionsOverriding()
   {
	  XMLConfigService svc = initXMLConfigService("test-config.xml", "test-config-override.xml");
      
      // get the "Actions" config
      Config cfg = svc.getConfig("Actions Override");
      assertNotNull("cfg should not be null", cfg);
      
      // get the <actions> config element
      ActionsConfigElement actionsConfig = (ActionsConfigElement)cfg.
            getConfigElement(ActionsConfigElement.CONFIG_ELEMENT_ID);
      assertNotNull("actions config element should not be null", actionsConfig);
      
      // get the individual actions
      ActionDefinition docDetails = actionsConfig.getActionDefinition("details_doc");
      assertNotNull("details_doc action definition should not be null", docDetails);
      assertEquals("details_doc action", "dialog:showCustomDocDetails", docDetails.Action);
      
      ActionDefinition spaceDetails = actionsConfig.getActionDefinition("details_space");
      assertNotNull("details_space action definition should not be null", spaceDetails);
      assertEquals("details_space action", "dialog:showSpaceDetails", spaceDetails.Action);
      
      ActionDefinition customAction = actionsConfig.getActionDefinition("custom_action");
      assertNotNull("custom_action action definition should not be null", customAction);
      assertEquals("custom_action action", "customAction", customAction.Action);
      
      // get the document_browse action group
      ActionGroup group = actionsConfig.getActionGroup("document_browse");
      assertNotNull("group definition should not be null", group);
      assertTrue("showLink for document_browse group should be true", group.ShowLink);
      assertEquals("document_browse group style class", "inlineAction", group.StyleClass);
      assertNull("Style for document_browse group should be null", group.Style);
      
      // make sure there are 2 items (as one was hidden in the override)
      ArrayList<String> actions = new ArrayList<String>(3);
      for (String actionId : group)
      {
         actions.add(actionId);
      }
      
      assertEquals("number of items in document_browse group", 2, actions.size());
      
      // make sure they are in the correct order
      assertEquals("first action", "details_doc", actions.get(0));
      assertEquals("second action", "custom_action", actions.get(1));
      
      // get the new_group action group
      ActionGroup newGroup = actionsConfig.getActionGroup("new_group");
      assertNotNull("new_group definition should not be null", newGroup);
      
      // make sure there is only 1 item and it's id is correct
      actions = new ArrayList<String>(1);
      for (String actionId : newGroup)
      {
         actions.add(actionId);
      }
      
      assertEquals("number of items in new_group group", 1, actions.size());
      assertEquals("action", "custom_action", actions.get(0));
   }

    @SuppressWarnings("unchecked")
    public void testDefaultControlsConfig()
    {
        XMLConfigService svc = initXMLConfigService("test-config-forms.xml");

        // get hold of the default-controls config from the global section
        Config globalConfig = svc.getGlobalConfig();
        ConfigElement globalDefaultControls = globalConfig
                .getConfigElement("default-controls");
        assertNotNull("global default-controls element should not be null",
                globalDefaultControls);
        assertTrue(
                "config element should be an instance of DefaultControlsConfigElement",
                (globalDefaultControls instanceof DefaultControlsConfigElement));

        // Test that the default-control types are read from the config file
        Map<String, String> expectedDataMappings = new HashMap<String, String>();
        expectedDataMappings.put("d:text",
                "org/alfresco/forms/controls/textfield.ftl");
        expectedDataMappings.put("d:boolean",
                "org/alfresco/forms/controls/checkbox.ftl");
        expectedDataMappings.put("association",
                "org/alfresco/forms/controls/association-picker.ftl");
        expectedDataMappings.put("abc", "org/alfresco/abc.ftl");

        DefaultControlsConfigElement dcConfigElement = (DefaultControlsConfigElement) globalDefaultControls;
        Set<String> actualNames = dcConfigElement.getNames();
        assertEquals("Incorrect name count, expected "
                + expectedDataMappings.size(), expectedDataMappings.size(),
                actualNames.size());

        // Ugly hack to get around JUnit 3.8.1 not having
        // assertEquals(Collection, Collection)
        for (String nextName : expectedDataMappings.keySet())
        {
            assertTrue("actualNames was missing " + nextName, actualNames
                    .contains(nextName));
        }
        for (String nextName : actualNames)
        {
            assertTrue("expectedDataMappings was missing " + nextName,
                    expectedDataMappings.keySet().contains(nextName));
        }

        // Test that the datatypes map to the expected template.
        for (String nextKey : expectedDataMappings.keySet())
        {
            String nextExpectedValue = expectedDataMappings.get(nextKey);
            String nextActualValue = dcConfigElement.getTemplateFor(nextKey);
            assertTrue("Incorrect template for " + nextKey + ": "
                    + nextActualValue, nextExpectedValue
                    .equals(nextActualValue));
        }

        Map<String, List<ControlParam>> expectedControlParams = new HashMap<String, List<ControlParam>>();

        List<ControlParam> textParams = new ArrayList<ControlParam>();
        textParams.add(new ControlParam("size", "50"));

        List<ControlParam> abcParams = new ArrayList<ControlParam>();
        abcParams.add(new ControlParam("a", "1"));
        abcParams.add(new ControlParam("b", "Hello"));
        abcParams.add(new ControlParam("c", "For ever and ever."));
        abcParams.add(new ControlParam("d", ""));

        expectedControlParams.put("d:text", textParams);
        expectedControlParams.put("d:boolean", Collections.EMPTY_LIST);
        expectedControlParams.put("association", Collections.EMPTY_LIST);
        expectedControlParams.put("abc", abcParams);

        for (String name : expectedControlParams.keySet())
        {
            List<ControlParam> actualControlParams = dcConfigElement
                    .getControlParamsFor(name);
            assertEquals("Incorrect params for " + name, expectedControlParams
                    .get(name), actualControlParams);
        }

        // test that a call to the generic getChildren call throws an error
        try
        {
            dcConfigElement.getChildren();
            fail("getChildren() did not throw an exception");
        } catch (ConfigException ce)
        {
            // expected
        }
    }
   
    public void testDefaultControlsOverride()
    {
        XMLConfigService svc = initXMLConfigService("test-config-forms.xml",
                "test-config-forms-override.xml");

        // get hold of the default-controls config from the global section
        Config globalConfig = svc.getGlobalConfig();
        ConfigElement globalDefaultControls = globalConfig
                .getConfigElement("default-controls");
        assertNotNull("global default-controls element should not be null",
                globalDefaultControls);
        assertTrue(
                "config element should be an instance of DefaultControlsConfigElement",
                (globalDefaultControls instanceof DefaultControlsConfigElement));
        DefaultControlsConfigElement dcCE = (DefaultControlsConfigElement) globalDefaultControls;

        assertTrue("New template is missing.", dcCE.getNames().contains("xyz"));
        assertEquals("Expected template incorrect.", "org/alfresco/xyz.ftl",
                dcCE.getTemplateFor("xyz"));

        ControlParam expectedNewControlParam = new ControlParam("c", "Never.");
        assertTrue("New control-param missing.", dcCE
                .getControlParamsFor("abc").contains(expectedNewControlParam));
    }
   
   /**
     * Tests the combination of a DefaultControlsConfigElement with another that
     * contains additional data.
     */
    public void testDefaultControlsCombine_Addition()
    {
        DefaultControlsConfigElement basicElement = new DefaultControlsConfigElement();
        basicElement.addDataMapping("text", "path/textbox.ftl", null);

        // This element is the same as the above, but adds a control-param.
        DefaultControlsConfigElement parameterisedElement = new DefaultControlsConfigElement();
        List<ControlParam> testParams = new ArrayList<ControlParam>();
        testParams.add(new ControlParam("A", "1"));
        parameterisedElement.addDataMapping("text", "path/textbox.ftl",
                testParams);

        ConfigElement combinedElem = basicElement.combine(parameterisedElement);
        assertEquals("Combined elem incorrect.", parameterisedElement,
                combinedElem);
    }

   /**
     * Tests the combination of a DefaultControlsConfigElement with another that
     * contains modified data.
     */
    public void testDefaultControlsCombine_Modification()
    {
        DefaultControlsConfigElement initialElement = new DefaultControlsConfigElement();
        List<ControlParam> testParams = new ArrayList<ControlParam>();
        testParams.add(new ControlParam("A", "1"));
        initialElement.addDataMapping("text", "path/textbox.ftl", testParams);

        // This element is the same as the above, but modifies the
        // control-param.
        DefaultControlsConfigElement modifiedElement = new DefaultControlsConfigElement();
        List<ControlParam> modifiedTestParams = new ArrayList<ControlParam>();
        modifiedTestParams.add(new ControlParam("A", "5"));
        modifiedElement.addDataMapping("text", "path/textbox.ftl",
                modifiedTestParams);

        ConfigElement combinedElem = initialElement.combine(modifiedElement);
        assertEquals("Combined elem incorrect.", modifiedElement, combinedElem);
    }

   /**
     * Tests the combination of a DefaultControlsConfigElement with another that
     * contains deleted data. TODO Do we actually need to support this type of
     * customisation?
     */
    public void testDefaultControlsCombine_Deletion()
    {
        DefaultControlsConfigElement initialElement = new DefaultControlsConfigElement();
        List<ControlParam> testParams = new ArrayList<ControlParam>();
        testParams.add(new ControlParam("A", "1"));
        initialElement.addDataMapping("text", "path/textbox.ftl", testParams);

        // This element is the same as the above, but modifies the
        // control-param.
        DefaultControlsConfigElement modifiedElement = new DefaultControlsConfigElement();
        modifiedElement.addDataMapping("text", "path/textbox.ftl", null);

        ConfigElement combinedElem = initialElement.combine(modifiedElement);
        assertEquals("Combined elem incorrect.", modifiedElement, combinedElem);
    }

    public void testConstraintHandlersConfig()
    {
        XMLConfigService svc = initXMLConfigService("test-config-forms.xml");

        // get hold of the constraint-handlers config from the global section
        Config globalConfig = svc.getGlobalConfig();
        ConfigElement globalConstraintHandlers = globalConfig
                .getConfigElement("constraint-handlers");
        assertNotNull("global constraint-handlers element should not be null",
                globalConstraintHandlers);
        assertTrue(
                "config element should be an instance of ConstraintHandlersConfigElement",
                (globalConstraintHandlers instanceof ConstraintHandlersConfigElement));

        // Test that the constraint-handlers' constraints are read from the
        // config file
        Map<String, String> expectedValidationHandlers = new HashMap<String, String>();
        expectedValidationHandlers.put("REGEX",
                "Alfresco.forms.validation.regexMatch");
        expectedValidationHandlers.put("NUMERIC",
                "Alfresco.forms.validation.numericMatch");

        ConstraintHandlersConfigElement chConfigElement = (ConstraintHandlersConfigElement) globalConstraintHandlers;
        List<String> actualTypes = chConfigElement.getConstraintTypes();
        assertEquals("Incorrect type count.",
                expectedValidationHandlers.size(), actualTypes.size());

        // Ugly hack to get around JUnit 3.8.1 not having
        // assertEquals(Collection, Collection)
        for (String nextType : expectedValidationHandlers.keySet())
        {
            assertTrue("actualTypes was missing " + nextType, actualTypes
                    .contains(nextType));
        }
        for (String nextType : actualTypes)
        {
            assertTrue("expectedValidationHandlers missing " + nextType,
                    expectedValidationHandlers.keySet().contains(nextType));
        }

        // Test that the types map to the expected validation handler.
        for (String nextKey : expectedValidationHandlers.keySet())
        {
            String nextExpectedValue = expectedValidationHandlers.get(nextKey);
            String nextActualValue = chConfigElement
                    .getValidationHandlerFor(nextKey);
            assertTrue("Incorrect handler for " + nextKey + ": "
                    + nextActualValue, nextExpectedValue
                    .equals(nextActualValue));
        }

        // Test that the constraint-handlers' messages are read from the config
        // file
        Map<String, String> expectedMessages = new HashMap<String, String>();
        expectedMessages.put("REGEX", null);
        expectedMessages.put("NUMERIC", "Test Message");

        // Test that the types map to the expected message.
        for (String nextKey : expectedValidationHandlers.keySet())
        {
            String nextExpectedValue = expectedMessages.get(nextKey);
            String nextActualValue = chConfigElement.getMessageFor(nextKey);
            assertEquals("Incorrect message for " + nextKey + ".",
                    nextExpectedValue, nextActualValue);
        }

        // Test that the constraint-handlers' message-ids are read from the config
        // file
        Map<String, String> expectedMessageIDs = new HashMap<String, String>();
        expectedMessageIDs.put("REGEX", null);
        expectedMessageIDs.put("NUMERIC", "regex_error");
        
        // Test that the types map to the expected message-id.
        for (String nextKey : expectedValidationHandlers.keySet())
        {
            String nextExpectedValue = expectedMessageIDs.get(nextKey);
            String nextActualValue = chConfigElement.getMessageIdFor(nextKey);
            assertEquals("Incorrect message-id for " + nextKey + ".",
                    nextExpectedValue, nextActualValue);
        }

        // test that a call to the generic getChildren call throws an error
        try
        {
            chConfigElement.getChildren();
            fail("getChildren() did not throw an exception");
        } catch (ConfigException ce)
        {
            // expected
        }
    }
   
    public void testConstraintHandlersOverride()
    {
        XMLConfigService svc = initXMLConfigService("test-config-forms.xml",
                "test-config-forms-override.xml");

        // get hold of the constraint-handlers config from the global section
        Config globalConfig = svc.getGlobalConfig();
        ConfigElement globalConstraintHandlers = globalConfig
                .getConfigElement("constraint-handlers");
        assertNotNull("global constraint-handlers element should not be null",
                globalConstraintHandlers);
        assertTrue(
                "config element should be an instance of ConstraintHandlersConfigElement",
                (globalConstraintHandlers instanceof ConstraintHandlersConfigElement));
        ConstraintHandlersConfigElement chCE = (ConstraintHandlersConfigElement) globalConstraintHandlers;

        assertTrue("New type is missing.", chCE.getConstraintTypes().contains(
                "RANGE"));
        assertEquals("Expected handler incorrect.",
                "Alfresco.forms.validation.rangeMatch", chCE
                        .getValidationHandlerFor("RANGE"));

        assertEquals("Modified message is wrong.", "Overridden Message", chCE
                .getMessageFor("NUMERIC"));
    }
    
    private XMLConfigService initXMLConfigService(String xmlConfigFile)
    {
        String fullFileName = getResourcesDir() + xmlConfigFile;
        assertFileIsValid(fullFileName);

        XMLConfigService svc = new XMLConfigService(new FileConfigSource(
                fullFileName));
        svc.initConfig();
        return svc;
    }

    private XMLConfigService initXMLConfigService(String xmlConfigFile,
            String overridingXmlConfigFile)
    {
        String mainConfigFile = getResourcesDir() + xmlConfigFile;
        String overridingConfigFile = getResourcesDir()
                + overridingXmlConfigFile;
        assertFileIsValid(mainConfigFile);
        assertFileIsValid(overridingConfigFile);

        List<String> configFiles = new ArrayList<String>();
        configFiles.add(mainConfigFile);
        configFiles.add(overridingConfigFile);
        XMLConfigService svc = new XMLConfigService(new FileConfigSource(
                configFiles));
        svc.initConfig();
        return svc;
    }
   
    private void assertFileIsValid(String fullFileName)
    {
        File f = new File(fullFileName);
        assertTrue("Required file missing: " + fullFileName, f.exists());
        assertTrue("Required file not readable: " + fullFileName, f.canRead());
    }
}