UICommandTestCase.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2014 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package javax.faces.component;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

import javax.faces.FactoryFinder;
import javax.faces.application.Application;
import javax.faces.context.FacesContext;
import javax.faces.el.MethodBinding;
import javax.faces.event.ActionEvent;
import javax.faces.event.ActionListener;
import javax.faces.event.PhaseId;
import javax.faces.render.RenderKit;
import javax.faces.render.RenderKitFactory;
import javax.faces.render.Renderer;

import com.sun.faces.mock.MockExternalContext;

import junit.framework.Test;
import junit.framework.TestSuite;

/**
 * <p>
 * Unit tests for {@link UICommand}.
 * </p>
 */
public class UICommandTestCase extends UIComponentBaseTestCase {

    // ------------------------------------------------------------ Constructors
    /**
     * Construct a new instance of this test case.
     *
     * @param name Name of the test case
     */
    public UICommandTestCase(String name) {
        super(name);
    }

    private static Class actionListenerSignature[] = { ActionEvent.class };

    // ---------------------------------------------------- Overall Test Methods
    // Set up instance variables required by this test case.
    @Override
    public void setUp() throws Exception {
        super.setUp();
        component = new UICommand();
        expectedFamily = UICommand.COMPONENT_FAMILY;
        expectedId = null;
        expectedRendererType = "javax.faces.Button";
    }

    // Return the tests included in this test case.
    public static Test suite() {
        return (new TestSuite(UICommandTestCase.class));
    }

    // ------------------------------------------------- Individual Test Methods
    // Test order of action listener calls with actionListener also
    public void PENDING_FIXME_testActionOrder() throws Exception {

        RenderKitFactory renderKitFactory = (RenderKitFactory) FactoryFinder.getFactory(FactoryFinder.RENDER_KIT_FACTORY);
        RenderKit renderKit = renderKitFactory.getRenderKit(facesContext, RenderKitFactory.HTML_BASIC_RENDER_KIT);
        renderKit.addRenderer(UICommand.COMPONENT_FAMILY, "javax.faces.Button", new ButtonRenderer());
        UIViewRoot root = facesContext.getApplication().getViewHandler().createView(facesContext, null);
        root.getChildren().add(component);
        UICommand command = (UICommand) component;
        MethodBinding binding = facesContext.getApplication().createMethodBinding("#{l3.processAction}", actionListenerSignature);
        MethodBinding actionBinding = facesContext.getApplication().createMethodBinding("#{l4.test}", null);
        command.setId("command");
        command.addActionListener(new CommandActionListenerTestImpl("l1"));
        command.addActionListener(new CommandActionListenerTestImpl("l2"));
        command.setActionListener(binding);
        command.setAction(actionBinding);
        command.setImmediate(true);
        request.setAttribute("l3", new CommandActionListenerTestImpl("l3"));

        // Override the default action listener to test ordering
        ActionListener oldDefaultActionListener = facesContext.getApplication().getActionListener();
        facesContext.getApplication().setActionListener(new CommandActionListenerTestImpl("14"));
        Map map = new HashMap();
        map.put(command.getClientId(facesContext), "");
        MockExternalContext econtext = (MockExternalContext) facesContext.getExternalContext();
        econtext.setRequestParameterMap(map);
        CommandActionListenerTestImpl.trace(null);
        root.processDecodes(facesContext);
        assertEquals("/l1/l2/l3/14", CommandActionListenerTestImpl.trace());

        // Restore the default action listener
        facesContext.getApplication().setActionListener(oldDefaultActionListener);
    }

    // Test attribute-property transparency
    @Override
    public void testAttributesTransparency() {

        super.testAttributesTransparency();
        UICommand command = (UICommand) component;
        Application app = facesContext.getApplication();
        MethodBinding methodBinding = null;
        assertEquals(command.getValue(), (String) component.getAttributes().get("value"));
        
        command.setValue("foo");
        assertEquals("foo", (String) component.getAttributes().get("value"));
        
        command.setValue(null);
        assertNull((String) component.getAttributes().get("value"));
        
        component.getAttributes().put("value", "bar");
        assertEquals("bar", command.getValue());
        
        component.getAttributes().put("value", null);
        assertNull(command.getValue());
        assertEquals("command.getAction(), (MethodBinding) command.getAttributes().get(\"action\")", command.getAction(), (MethodBinding) command.getAttributes().get("action"));
        
        command.setAction(methodBinding = app.createMethodBinding("#{foo.bar}", null));
        assertEquals("methodBinding, (MethodBinding) command.getAttributes().get(\"action\")", methodBinding, (MethodBinding) command.getAttributes().get("action"));
        
        command.setAction(null);
        assertNull("(MethodBinding) command.getAttributes().get(\"action\")", (MethodBinding) command.getAttributes().get("action"));
        
        methodBinding = app.createMethodBinding("#{bar.baz}", null);
        command.getAttributes().put("action", methodBinding);
        assertEquals("methodBinding, command.getAction()", methodBinding, command.getAction());
        
        command.getAttributes().put("action", null);
        assertNull(command.getAction());
        assertEquals("command.getActionListener(), (MethodBinding) command.getAttributes().get(\"actionListener\")", command.getActionListener(), (MethodBinding) command.getAttributes().get("actionListener"));
        
        methodBinding = app.createMethodBinding("#{foo.yoyo}", actionListenerSignature);
        command.setActionListener(methodBinding);
        assertEquals("methodBinding, (MethodBinding) command.getAttributes().get(\"actionListener\")", methodBinding, (MethodBinding) command.getAttributes().get("actionListener"));
        
        command.setActionListener(null);
        assertNull((MethodBinding) command.getAttributes().get("actionListener"));
        
        methodBinding = app.createMethodBinding("#{foo.buckaroo}", actionListenerSignature);
        command.getAttributes().put("actionListener", methodBinding);
        assertEquals("methodBinding, command.getActionListener()", methodBinding, command.getActionListener());
        
        command.getAttributes().put("actionListener", null);
        assertNull(command.getActionListener());

    }

    // Test event queuing and broadcasting (any phase listeners)
    public void testEventsGeneric() {

        UICommand command = (UICommand) component;
        command.setRendererType(null);
        ActionEvent event = new ActionEvent(command);

        // Register three listeners
        command.addActionListener(new ActionListenerTestImpl("AP0"));
        command.addActionListener(new ActionListenerTestImpl("AP1"));
        command.addActionListener(new ActionListenerTestImpl("AP2"));

        // Fire events and evaluate results
        ActionListenerTestImpl.trace(null);
        UIViewRoot root = facesContext.getApplication().getViewHandler().createView(facesContext, null);
        root.getChildren().add(command);
        command.queueEvent(event);
        root.processDecodes(facesContext);
        root.processValidators(facesContext);
        root.processApplication(facesContext);
        assertEquals("/AP0@INVOKE_APPLICATION 5/AP1@INVOKE_APPLICATION 5/AP2@INVOKE_APPLICATION 5", ActionListenerTestImpl.trace());

    }

    // Test event queuing and broadcasting (mixed phase listeners)
    public void testEventsMixed() {

        UICommand command = (UICommand) component;
        command.setRendererType(null);
        ActionEvent event = new ActionEvent(command);

        // Register three listeners
        command.addActionListener(new ActionListenerTestImpl("ARV"));
        command.addActionListener(new ActionListenerTestImpl("PV"));
        command.addActionListener(new ActionListenerTestImpl("AP"));

        // Fire events and evaluate results
        ActionListenerTestImpl.trace(null);
        UIViewRoot root = facesContext.getApplication().getViewHandler().createView(facesContext, null);
        root.getChildren().add(command);
        command.queueEvent(event);
        root.processDecodes(facesContext);
        root.processValidators(facesContext);
        root.processApplication(facesContext);
        assertEquals("/ARV@INVOKE_APPLICATION 5/PV@INVOKE_APPLICATION 5/AP@INVOKE_APPLICATION 5", ActionListenerTestImpl.trace());

    }

    // Test event queuing and broadcasting (mixed phase listeners), with
    // immediate set.
    public void testEventsMixedImmediate() {

        UICommand command = (UICommand) component;
        command.setImmediate(true);
        command.setRendererType(null);
        ActionEvent event = new ActionEvent(command);

        // Register three listeners
        command.addActionListener(new ActionListenerTestImpl("ARV"));
        command.addActionListener(new ActionListenerTestImpl("PV"));
        command.addActionListener(new ActionListenerTestImpl("AP"));

        // Fire events and evaluate results
        ActionListenerTestImpl.trace(null);
        UIViewRoot root = facesContext.getApplication().getViewHandler().createView(facesContext, null);
        root.getChildren().add(command);
        command.queueEvent(event);
        root.processDecodes(facesContext);
        root.processValidators(facesContext);
        root.processApplication(facesContext);
        assertEquals("/ARV@APPLY_REQUEST_VALUES 2/PV@APPLY_REQUEST_VALUES 2/AP@APPLY_REQUEST_VALUES 2", ActionListenerTestImpl.trace());

    }

    // Test listener registration and deregistration
    public void testListeners() {

        CommandTestImpl command = new CommandTestImpl();
        ActionListenerTestImpl listener = null;

        command.addActionListener(new ActionListenerTestImpl("ARV0"));
        command.addActionListener(new ActionListenerTestImpl("ARV1"));
        command.addActionListener(new ActionListenerTestImpl("PV0"));
        command.addActionListener(new ActionListenerTestImpl("PV1"));
        command.addActionListener(new ActionListenerTestImpl("PV2"));

        ActionListener listeners[] = command.getActionListeners();
        assertEquals(5, listeners.length);
        command.removeActionListener(listeners[2]);
        listeners = command.getActionListeners();
        assertEquals(4, listeners.length);

    }

    // Test empty listener list
    public void testEmptyListeners() {

        CommandTestImpl command = new CommandTestImpl();
        ActionListenerTestImpl listener = null;

        // No listeners added, should be empty
        ActionListener listeners[] = command.getActionListeners();
        assertEquals(0, listeners.length);

    }

    // Suppress lifecycle tests since we do not have a renderer
    @Override
    public void testLifecycleManagement() {
    }

    // Test a pristine UICommand instance
    @Override
    public void testPristine() {

        super.testPristine();
        UICommand command = (UICommand) component;

        assertNull("no value", command.getValue());
        assertNull("no action", command.getAction());
        assertNull("no actionListener", command.getActionListener());

    }

    // Test setting properties to invalid values
    @Override
    public void testPropertiesInvalid() throws Exception {
        super.testPropertiesInvalid();
        UICommand command = (UICommand) component;
    }

    // Test setting properties to valid values
    @Override
    public void testPropertiesValid() throws Exception {
        super.testPropertiesValid();
        UICommand command = (UICommand) component;
        Application app = facesContext.getApplication();

        // value
        command.setValue("foo.bar");
        assertEquals("expected value", "foo.bar", command.getValue());
        command.setValue(null);
        assertNull("erased value", command.getValue());

        MethodBinding methodBinding = null;

        command.setAction(methodBinding = app.createMethodBinding("#{foo.bar}", null));
        assertEquals(methodBinding, command.getAction());
        command.setAction(null);
        assertNull(command.getAction());

        methodBinding = app.createMethodBinding("#{foo.yoyo}", actionListenerSignature);
        command.setActionListener(methodBinding);
        assertEquals(methodBinding, command.getActionListener());
        command.setActionListener(null);
        assertNull(command.getActionListener());

    }

    public void testNestedCommands() {
        UIViewRoot root = new UIViewRoot();
        UICommand c1 = new UICommand();
        UICommand c2 = new UICommand();
        root.getChildren().add(c1);
        c2.setImmediate(true);
        c1.getChildren().add(c2);
        ActionEvent ae = new ActionEvent(c2);
        c2.queueEvent(ae);
        assertTrue(ae.getPhaseId().equals(PhaseId.APPLY_REQUEST_VALUES));

        root = new UIViewRoot();
        c1 = new UICommand();
        c2 = new UICommand();
        root.getChildren().add(c1);
        c1.setImmediate(true);
        c2.setImmediate(false);
        c1.getChildren().add(c2);
        ae = new ActionEvent(c2);
        c2.queueEvent(ae);
        assertTrue(ae.getPhaseId().equals(PhaseId.INVOKE_APPLICATION));
    }

    public void PENDING_FIXME_testValueBindings() {

        super.testValueBindings();
        UICommand test = (UICommand) component;

        // "immediate" property
        request.setAttribute("foo", Boolean.FALSE);
        boolean initial = test.isImmediate();
        if (initial) {
            request.setAttribute("foo", Boolean.FALSE);
        } else {
            request.setAttribute("foo", Boolean.TRUE);
        }
        test.setValueBinding("immediate", application.createValueBinding("#{foo}"));
        assertEquals(!initial, test.isImmediate());
        test.setImmediate(initial);
        assertEquals(initial, test.isImmediate());
        assertNotNull(test.getValueBinding("immediate"));

        // "value" property
        request.setAttribute("foo", "bar");
        test.setValue(null);
        assertNull(test.getValue());
        test.setValueBinding("value", application.createValueBinding("#{foo}"));
        assertNotNull(test.getValueBinding("value"));
        assertEquals("bar", test.getValue());
        test.setValue("baz");
        assertEquals("baz", test.getValue());
        test.setValue(null);
        assertEquals("bar", test.getValue());
        test.setValueBinding("value", null);
        assertNull(test.getValueBinding("value"));
        assertNull(test.getValue());

    }

    public void testGetActionListeners() throws Exception {
        UICommand command = (UICommand) component;
        UIViewRoot root = facesContext.getApplication().getViewHandler().createView(facesContext, null);
        root.getChildren().add(command);

        ActionListenerTestImpl ta1 = new ActionListenerTestImpl("ta1"), ta2 = new ActionListenerTestImpl("ta2");

        command.addActionListener(ta1);
        command.addActionListener(ta2);
        ActionListener[] listeners = (ActionListener[]) command.getActionListeners();
        assertEquals(2, listeners.length);
        ActionListenerTestImpl[] taListeners = (ActionListenerTestImpl[]) command.getFacesListeners(ActionListenerTestImpl.class);
    }

    // --------------------------------------------------------- Support Methods
    // Check that the properties on the specified components are equal
    @Override
    protected void checkProperties(UIComponent comp1, UIComponent comp2) {
        super.checkProperties(comp1, comp2);
        UICommand c1 = (UICommand) comp1;
        UICommand c2 = (UICommand) comp2;
        assertEquals(c1.getAction(), c2.getAction());
        assertEquals(c1.getActionListener(), c2.getActionListener());
    }

    // Create a pristine component of the type to be used in state holder tests
    @Override
    protected UIComponent createComponent() {
        UIComponent component = new UICommand();
        component.setRendererType(null);
        return (component);
    }

    // Populate a pristine component to be used in state holder tests
    @Override
    protected void populateComponent(UIComponent component) {
        super.populateComponent(component);
        UICommand c = (UICommand) component;
        Application app = facesContext.getApplication();
        MethodBinding methodBinding = null;

        c.setAction(methodBinding = app.createMethodBinding("#{foo.bar}", null));
        c.setActionListener(methodBinding = app.createMethodBinding("#{baz.bop}", actionListenerSignature));
    }

    protected boolean listenersAreEqual(FacesContext context, UICommand comp1, UICommand comp2) {
        ActionListener[] list1 = comp1.getActionListeners();
        ActionListener[] list2 = comp2.getActionListeners();
        // make sure they're either both null or both non-null
        if ((null == list1 && null != list2) || (null != list1 && null == list2)) {
            return false;
        }
        if (null == list1) {
            return true;
        }
        int j = 0, outerLen = list1.length;
        boolean result = true;
        if (outerLen != list2.length) {
            return false;
        }
        for (j = 0; j < outerLen; j++) {
            result = list1[j].equals(list2[j]);
            if (!result) {
                return false;
            }
        }
        return true;
    }

    // --------------------------------------------------------- Private Classes
    // "Button" Renderer
    class ButtonRenderer extends Renderer {

        @Override
        public void decode(FacesContext context, UIComponent component) {

            if ((context == null) || (component == null)) {
                throw new NullPointerException();
            }

            if (!(component instanceof ActionSource)) {
                return;
            }
            String clientId = component.getClientId(context);
            Map params = context.getExternalContext().getRequestParameterMap();
            if (params.containsKey(clientId)) {
                component.queueEvent(new ActionEvent(component));
            }
        }

        @Override
        public void encodeBegin(FacesContext context, UIComponent component) throws IOException {
            if ((context == null) || (component == null)) {
                throw new NullPointerException();
            }
        }

        @Override
        public void encodeChildren(FacesContext context, UIComponent component) throws IOException {
            if ((context == null) || (component == null)) {
                throw new NullPointerException();
            }
        }

        @Override
        public void encodeEnd(FacesContext context, UIComponent component) throws IOException {
            if ((context == null) || (component == null)) {
                throw new NullPointerException();
            }
        }
    }
}