/*
    * 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.myfaces.renderkit.html;
  
  import java.io.StringWriter;
  
  import javax.faces.component.UIParameter;
  import javax.faces.component.behavior.AjaxBehavior;
  import javax.faces.component.html.HtmlForm;
  import javax.faces.component.html.HtmlOutcomeTargetButton;
  
  import junit.framework.Test;
  import junit.framework.TestSuite;
  
  import org.apache.myfaces.application.NavigationHandlerImpl;
  import org.apache.myfaces.shared.renderkit.JSFAttr;
  import org.apache.myfaces.shared.renderkit.html.HTML;
  import org.apache.myfaces.test.base.AbstractJsfTestCase;
  import org.apache.myfaces.test.mock.MockRenderKitFactory;
  import org.apache.myfaces.test.mock.MockResponseWriter;
  
  /**
   * Tests for HtmlOutcomeTargetButtonRenderer.
   * 
   * @author Jakob Korherr (latest modification by $Author: lu4242 $)
   * @version $Revision: 1151650 $ $Date: 2011-07-27 17:14:17 -0500 (Wed, 27 Jul 2011) $
   */
  public class HtmlOutcomeTargetButtonRendererTest extends AbstractJsfTestCase 
  {
  
      private MockResponseWriter writer;
      private HtmlOutcomeTargetButton outcomeTargetButton;
      private HtmlForm form;
      
      public HtmlOutcomeTargetButtonRendererTest(String name) 
      {
          super(name);
      }
      
      public static Test suite() 
      {
          return new TestSuite(HtmlOutcomeTargetButtonRendererTest.class);
      }
      
      public void setUp() throws Exception 
      {
          super.setUp();
          writer = new MockResponseWriter(new StringWriter(), null, null);
          facesContext.setResponseWriter(writer);
          facesContext.getApplication().setNavigationHandler(new NavigationHandlerImpl());
          outcomeTargetButton = new HtmlOutcomeTargetButton();
          form = new HtmlForm();
          outcomeTargetButton.setParent(form);
          
          facesContext.getViewRoot().setRenderKitId(MockRenderKitFactory.HTML_BASIC_RENDER_KIT);
          facesContext.getRenderKit().addRenderer(
                  outcomeTargetButton.getFamily(),
                  outcomeTargetButton.getRendererType(),
                  new HtmlOutcomeTargetButtonRenderer());
          facesContext.getRenderKit().addRenderer(
                  form.getFamily(),
                  form.getRendererType(),
                  new HtmlFormRenderer());
          
          facesContext.getAttributes().put("org.apache.myfaces.RENDERED_JSF_JS", Boolean.TRUE);
      }
      
      public void tearDown() throws Exception 
      {
          super.tearDown();
          writer = null;
          form = null;
          outcomeTargetButton = null;
      }
      
      /**
       * Components that render client behaviors should always render "id" and "name" attribute
       */
      public void testClientBehaviorHolderRendersIdAndName() 
      {
          outcomeTargetButton.addClientBehavior("keypress", new AjaxBehavior());
          try 
          {
             outcomeTargetButton.encodeAll(facesContext);
             String output = ((StringWriter) writer.getWriter()).getBuffer().toString();
             assertTrue(output.matches(".+id=\".+\".+"));
             assertTrue(output.matches(".+name=\".+\".+"));
         }
         catch (Exception e)
         {
             fail(e.getMessage());
         }
         
     }
     
     /**
      * Tests if h:button correctly includes all parameters of the implicit
      * navigation case created from the outcome.
      * 
      * @throws Exception
      */
     public void testOutcomeTargetRendersNavigationCaseParameters() throws Exception
     {
         // configure the button
         outcomeTargetButton.getAttributes().put("includeViewParams", false);
         outcomeTargetButton.getAttributes().put("outcome", 
                 "test.xhtml?param1=value1&param2=value2");
         
         // render the button
         outcomeTargetButton.encodeAll(facesContext);
         String output = ((StringWriter) writer.getWriter()).getBuffer().toString();
         
         // make sure the parameters are rendered
         assertTrue(output.contains("param1=value1"));
         assertTrue(output.contains("param2=value2"));
     }
     
     /**
      * Tests if the fragment attribute is correctly rendered.
      * @throws Exception
      */
     public void testFragment() throws Exception
     {
         // configure the button
         final String fragment = "end";
         outcomeTargetButton.getAttributes().put("fragment", fragment);
         outcomeTargetButton.getAttributes().put("outcome", 
                 "test.xhtml?param1=value1");
         
         // render the button
         outcomeTargetButton.encodeAll(facesContext);
         String output = ((StringWriter) writer.getWriter()).getBuffer().toString();
         
         // make sure the fragment is rendered
         assertTrue(output.contains("param1=value1#" + fragment));
     }
     
     /**
      * Tests if the h:button correctly includes an UIParameter
      * with a non-null-name when creating the URL.
      */
     public void testIncludesUIParameterInURL()
     {
         // create the UIParameter and attach it
         UIParameter param = new UIParameter();
         param.setName("myParameter");
         param.setValue("myValue");
         outcomeTargetButton.getChildren().add(param);
         
         try
         {
             outcomeTargetButton.encodeAll(facesContext);
             String output = ((StringWriter) writer.getWriter()).getBuffer().toString();
             assertTrue(output.contains("myParameter=myValue"));
         }
         catch (Exception e)
         {
             fail(e.getMessage());
         }
     }
     
     /**
      * Tests if the h:button correctly skips an UIParameter
      * with a null-name when creating the URL.
      */
     public void testSkipsNullValueOfUIParameterInURL()
     {
         // create the UIParameter with value = null and attach it
         UIParameter param = new UIParameter();
         param.setName("myNullParameter");
         param.setValue(null);
         outcomeTargetButton.getChildren().add(param);
         
         try
         {
             outcomeTargetButton.encodeAll(facesContext);
             String output = ((StringWriter) writer.getWriter()).getBuffer().toString();
             assertFalse(output.contains("myNullParameter"));
         }
         catch (Exception e)
         {
             fail(e.getMessage());
         }
     }
     
     /**
      * Tests if the h:button is rendered accordingly if disabled is true.
      */
     public void testDisabledAttribute() 
     {
         outcomeTargetButton.getAttributes().put(JSFAttr.DISABLED_ATTR, "true");
         try 
         {
             outcomeTargetButton.encodeAll(facesContext);
             String output = ((StringWriter) writer.getWriter()).getBuffer().toString();
             
             // Assertions
             assertFalse(output.contains(HTML.ONCLICK_ATTR)); // the output must not contain onclick 
             assertTrue(output.contains(HTML.DISABLED_ATTR)); // the ouput must contain disabled
         }
         catch (Exception e)
         {
             fail(e.getMessage());
         }
         
     }
     
 }