TestRestoreViewPhase.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 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 com.sun.faces.lifecycle;

import com.sun.faces.cactus.ServletFacesTestCase;
import com.sun.faces.util.Util;
import com.sun.faces.renderkit.ServerSideStateHelper;

import org.apache.cactus.WebRequest;

import javax.faces.application.ViewExpiredException;
import javax.faces.component.UICommand;
import javax.faces.component.UIForm;
import javax.faces.component.UIInput;
import javax.faces.component.UIPanel;
import javax.faces.component.UIViewRoot;
import javax.faces.context.FacesContext;
import javax.faces.render.RenderKitFactory;

import javax.servlet.http.HttpSession;

import java.util.Locale;


/**
 * <B>TestReconstituteComponentTreePhase</B> is a class ...
 * <p/>
 * <B>Lifetime And Scope</B> <P>
 *
 */

public class TestRestoreViewPhase extends ServletFacesTestCase {

//
// Protected Constants
//

    public static final String TEST_URI = "/components.jsp";

//
// Class Variables
//

//
// Instance Variables
//

// Attribute Instance Variables

// Relationship Instance Variables

//
// Constructors and Initializers    
//

    public TestRestoreViewPhase() {
        super("TestRestoreViewPhase");
	initLocalHostPath();
    }


    public TestRestoreViewPhase(String name) {
        super(name);
	initLocalHostPath();
    }

    private String localHostPath = "localhost:8080";

    private void initLocalHostPath() {
	String containerPort = System.getProperty("container.port");
	if (null == containerPort || 0 == containerPort.length()) {
	    containerPort = "8080";
	}
	localHostPath = "localhost:" + containerPort;
    }

//
// Class methods
//

//
// General Methods
//

    public void beginReconstituteRequestSubmit(WebRequest theRequest) {
        theRequest.setURL(localHostPath, null, null, TEST_URI, null);
	theRequest.addParameter("javax.faces.ViewState",
				"j_id1:j_id2");
    }


    public void beginRegisterListeners(WebRequest theRequest) {
        theRequest.setURL(localHostPath, null, null, TEST_URI, null);
	theRequest.addParameter("javax.faces.ViewState",
				"j_id1:j_id2");
    }

    public void testReconstituteRequestSubmit() {

        // precreate tree and set it in session and make sure the tree is
        // restored from session.
	
	FacesContext context = getFacesContext();
        UIViewRoot root = Util.getViewHandler(context).createView(context, 
								  null);
        root.setViewId(TEST_URI);
        root.setLocale(Locale.US);
    context.setViewRoot(root);
	

        UIForm basicForm = new UIForm();
        basicForm.setId("basicForm");
        UIInput userName = new UIInput();

        userName.setId("userName");
        root.getChildren().add(basicForm);
        basicForm.getChildren().add(userName);

        Locale locale = new Locale("France", "french");
        root.setLocale(locale);

	// here we do what the StateManager does to save the state in
	// the server.
	Util.getStateManager(context).saveView(context);
	//context.setViewRoot(null);

        Phase restoreView = new RestoreViewPhase();

        try {
            restoreView.execute(getFacesContext());
        } catch (Throwable e) {
            e.printStackTrace();
            assertTrue(false);
        }
        assertTrue(!(getFacesContext().getRenderResponse()) &&
                   !(getFacesContext().getResponseComplete()));

        assertTrue(null != getFacesContext().getViewRoot());
        assertTrue(RenderKitFactory.HTML_BASIC_RENDER_KIT.equals(getFacesContext()
              .getViewRoot().getRenderKitId()));

        assertTrue(locale == getFacesContext().getViewRoot().getLocale());

        assertTrue(
            getFacesContext().getViewRoot().getViewId().equals(TEST_URI));
        root = getFacesContext().getViewRoot();
        // components should exist.
        assertTrue(root.getChildCount() == 1);
        assertTrue(basicForm.getId().equals(root.findComponent("basicForm").getId()));
	assertTrue(userName.getId().equals(basicForm.findComponent("userName").getId()));
        //getFacesContext().setViewRoot(null);
    }

    /**
     * This method will test the <code>registerActionListeners</code> method.
     * It will first create a simple tree consisting of a couple of <code>UICommand</code>
     * components added to a facet;  Then the <code>ReconstituteComponentTree.execute</code>
     * method is run;  And finally, an assertion is done to ensure that default action
     * listeners have been registered on the <code>UICommand</code> components;
     */
    public void testRegisterListeners() {

        // precreate tree and set it in session and make sure the tree is
        // restored from session.
	FacesContext context = getFacesContext();

        UIViewRoot root = Util.getViewHandler(context).createView(context, 
								  null);
        root.setLocale(Locale.US);
        root.setViewId(TEST_URI);
	context.setViewRoot(root);

        UIForm basicForm = new UIForm();
        basicForm.setId("basicForm");
        root.getChildren().add(basicForm);
        UIPanel panel = new UIPanel();
        basicForm.getChildren().add(panel);
        UIPanel commandPanel = new UIPanel();
        commandPanel.setId("commandPanel");
        UICommand command1 = new UICommand();
        UICommand command2 = new UICommand();
        commandPanel.getChildren().add(command1);
        commandPanel.getChildren().add(command2);
        panel.getFacets().put("commandPanel", commandPanel);

	// here we do what the StateManager does to save the state in
	// the server.
	Util.getStateManager(context).saveView(context);
	//context.setViewRoot(null);

        Phase restoreView = new RestoreViewPhase();

        try {
            restoreView.execute(context);
        } catch (Throwable e) {
            e.printStackTrace();
            assertTrue(false);
        }
        assertTrue(!(context.getRenderResponse()) &&
                   !(context.getResponseComplete()));
        assertTrue(context.getViewRoot() != null);

        // Now test with no facets... Listeners should still be registered on UICommand
        // components....
        //
        //context.setViewRoot(null);

        root = Util.getViewHandler(context).createView(context, null);
        root.setViewId(TEST_URI);
        root.setLocale(Locale.US);
    context.setViewRoot(root);

        basicForm = new UIForm();
        basicForm.setId("basicForm");
        root.getChildren().add(basicForm);
        command1 = new UICommand();
        command2 = new UICommand();
        basicForm.getChildren().add(command1);
        basicForm.getChildren().add(command2);

	// here we do what the StateManager does to save the state in
	// the server.
	context.getExternalContext().getSessionMap().remove(ServerSideStateHelper.STATEMANAGED_SERIAL_ID_KEY);
	Util.getStateManager(context).saveView(context);
	//context.setViewRoot(null);

        restoreView = new RestoreViewPhase();

        try {
            restoreView.execute(context);
        } catch (Throwable e) {
            assertTrue(false);
        }
        assertTrue(!(context.getRenderResponse()) &&
                   !(context.getResponseComplete()));

        //context.setViewRoot(null);
    }

    public void beginRestoreViewExpired(WebRequest theRequest) {
        theRequest.setURL(localHostPath, null, null, TEST_URI, null);
        theRequest.addParameter("javax.faces.ViewState",
                                "j_id1:j_id2");
    }

    public void testRestoreViewExpired() {
        // precreate tree and set it in session and make sure the tree is
        // restored from session.
                                                                                                                        
        FacesContext context = getFacesContext();
        UIViewRoot root = Util.getViewHandler(context).createView(context,
                                                                  null);
        root.setLocale(Locale.US);
        root.setViewId(TEST_URI);
        context.setViewRoot(root);
                                                                                                                        
                                                                                                                        
        UIForm basicForm = new UIForm();
        basicForm.setId("basicForm");
        UIInput userName = new UIInput();
                                                                                                                        
        userName.setId("userName");
        root.getChildren().add(basicForm);
        basicForm.getChildren().add(userName);
                                                                                                                        
        Locale locale = new Locale("France", "french");
        root.setLocale(locale);
                                                                                                                        
        // here we do what the StateManager does to save the state in
        // the server.
        Util.getStateManager(context).saveView(context);
        //context.setViewRoot(null);
                                                                                                                        
        // invalidate the session before we attempt to restore
        ((HttpSession)context.getExternalContext().getSession(true)).invalidate();
                                                                                                                        
        Phase restoreView = new RestoreViewPhase();
                                                                                                                        
        boolean exceptionThrown = false;
        try {
            restoreView.execute(context);
        } catch (ViewExpiredException e) {
            exceptionThrown = true;
            assertTrue(e.getViewId().equals(TEST_URI));
            String expected = "viewId:"+e.getViewId()+" - View "+e.getViewId()+" could not be restored.";
            assertTrue(e.getMessage().equals(expected));
        }
        assertTrue(exceptionThrown);
    }



} // end of class TestRestoreViewPhase