/*
    * Licensed to the Apache Software Foundation (ASF) under one or more
    * contributor license agreements.  See the NOTICE file distributed with
    * this work for additional information regarding copyright ownership.
    * The ASF licenses this file to You under the Apache License, Version 2.0
    * (the "License"); you may not use this file except in compliance with
    * the License.  You may obtain a copy of the License at
    * 
    *      http://www.apache.org/licenses/LICENSE-2.0
   * 
   * 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.apache.jetspeed.tools.pamanager;
  
  import java.io.File;
  
  import junit.framework.Test;
  import junit.framework.TestSuite;
  import junit.textui.TestRunner;
  
  import org.apache.jetspeed.AbstractRequestContextTestCase;
  import org.apache.jetspeed.om.common.portlet.MutablePortletApplication;
  import org.apache.jetspeed.om.common.servlet.MutableWebApplication;
  import org.apache.jetspeed.om.servlet.impl.SecurityRoleImpl;
  import org.apache.jetspeed.util.DirectoryHelper;
  import org.apache.jetspeed.util.descriptor.PortletApplicationWar;
  import org.apache.pluto.om.common.SecurityRole;
  import org.apache.pluto.om.common.SecurityRoleRef;
  import org.apache.pluto.om.common.SecurityRoleRefSet;
  import org.apache.pluto.om.common.SecurityRoleSet;
  import org.apache.pluto.om.portlet.PortletDefinition;
  
  /***
   * TestPortletDescriptorSecurityRoles - test and validate security roles and
   * security role references from portlet.xml and web.xml deployment descriptor.
   *
   * @author <a href="ate@douma.nu">Ate Douma </a>
   *
   * @version $Id: TestPortletDescriptorSecurityRoles.java,v 1.4 2004/05/27
   *                19:57:24 weaver Exp $
   */
  public class TestPortletDescriptorSecurityRoles extends AbstractRequestContextTestCase
  {
  
      /***
       * Start the tests.
       *
       * @param args
       *                  the arguments. Not used
       */
      public static void main( String args[] )
      {
          TestRunner.main(new String[]{TestPortletDescriptorSecurityRoles.class.getName()});
      }
  
      /***
       * Creates the test suite.
       *
       * @return a test suite (<code>TestSuite</code>) that includes all
       *              methods starting with "test"
       */
      public static Test suite()
      {
          // All methods starting with "test" will be executed in the test suite.
          return new TestSuite(TestPortletDescriptorSecurityRoles.class);
      }
  
      public void setUp() throws Exception
      {
          super.setUp();
          
      }
      
      public void testSecurityRoles() throws Exception
      {
          System.out.println("Testing securityRoles");
          File warFile = new File("./test/testdata/deploy/webapp");
          PortletApplicationWar paWar = new PortletApplicationWar(new DirectoryHelper(warFile), "unit-test", "/" );
  
          MutablePortletApplication app = paWar.createPortletApp();
          assertNotNull("App is null", app);
  
          MutableWebApplication webApp = paWar.createWebApp();
          assertNotNull("WebApp is null", webApp);
  
          app.setWebApplicationDefinition(webApp);
  
          PortletDefinition portlet = app.getPortletDefinitionByName("TestPortlet");
          assertNotNull("TestPortlet is null", portlet);
          checkWebSecurityRoles(webApp);
          checkPortletSecurityRoleRefs(portlet);
          boolean validateFailed = false;
          try
          {
              paWar.validate();
         }
         catch (PortletApplicationException e)
         {
             validateFailed = true;
         }
         assertTrue("Invalid PortletDescriptor validation result", validateFailed);
         SecurityRoleImpl role = new SecurityRoleImpl();
         role.setRoleName("users.manager");
         webApp.addSecurityRole(role);
         try
         {
             paWar.validate();
             validateFailed = false;
         }
         catch (PortletApplicationException e)
         {
         }
         assertEquals("Invalid PortletDescriptor validation result", false, validateFailed);
 
         // persist the app
         try
         {
             
             portletRegistry.registerPortletApplication(app);
             
         }
         catch (Exception e)
         {
             String msg = "Unable to register portlet application, " + app.getName()
                     + ", through the portlet registry: " + e.toString();
             
             throw new Exception(msg, e);
         }
         // clear cache
         
 
         // read back in
         app = portletRegistry.getPortletApplication("unit-test");
         validateFailed = true;
         try
         {
             paWar.validate();
             validateFailed = false;
         }
         catch (PortletApplicationException e)
         {
         }
         assertEquals("Invalid loaded PortletDescriptor validation result", false, validateFailed);
 
         // remove the app
         try
         {
             
             portletRegistry.removeApplication(app);
             
         }
         catch (Exception e)
         {
             String msg = "Unable to remove portlet application, " + app.getName()
                     + ", through the portlet portletRegistry: " + e.toString();
             throw new Exception(msg, e);
         }
 
     }
 
     private void checkWebSecurityRoles( MutableWebApplication webApp )
     {
         SecurityRoleSet roles = webApp.getSecurityRoles();
         assertEquals("Invalid number of security role definitions found", 1, roles.size());
         SecurityRole role = roles.get("users.admin");
         assertNotNull("Role users.admin undefined", role);
     }
 
     private void checkPortletSecurityRoleRefs( PortletDefinition portlet )
     {
         SecurityRoleRefSet roleRefs = portlet.getInitSecurityRoleRefSet();
         assertEquals("Invalid number of security role references found", 2, roleRefs.size());
         SecurityRoleRef roleRef = roleRefs.get("admin");
         assertNotNull("Security Role Ref admin undefined", roleRef);
         assertEquals("security Role link expected", "users.admin", roleRef.getRoleLink());
         roleRef = roleRefs.get("users.manager");
         assertNotNull("Security Role Ref users.manager undefined", roleRef);
         assertNull("Undefined security Role link for users.managers expected", roleRef.getRoleLink());
     }
 }