/*
* $Id: TestNavigationHandler.java,v 1.28.4.2 2008/09/17 18:25:06 rlubke Exp $
*/
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. 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.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/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 glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [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.
*/
// TestNavigationHandler.java
package com.sun.faces.application;
import com.sun.faces.cactus.ServletFacesTestCase;
import com.sun.faces.util.Util;
import com.sun.faces.config.DbfFactory;
import javax.faces.FactoryFinder;
import javax.faces.application.Application;
import javax.faces.application.ApplicationFactory;
import javax.faces.application.NavigationHandler;
import javax.faces.component.UIViewRoot;
import javax.faces.context.FacesContext;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.DocumentBuilder;
import java.util.*;
import org.w3c.dom.Node;
import org.w3c.dom.Document;
import org.w3c.dom.NodeList;
import org.w3c.dom.NamedNodeMap;
/**
* This class test the <code>NavigationHandlerImpl</code> functionality.
* It uses two xml files:
* 1) faces-navigation.xml --> contains the navigation cases themselves.
* 2) navigation-cases.xml --> contains the test cases including expected
* view identifier outcomes for this test to validate against.
* Both files exist under <code>web/test/WEB-INF</code>.
* <p/>
* <B>Lifetime And Scope</B> <P>
*
* @version $Id: TestNavigationHandler.java,v 1.28.4.2 2008/09/17 18:25:06 rlubke Exp $
*/
public class TestNavigationHandler extends ServletFacesTestCase {
//
// Protected Constants
//
//
// Class Variables
//
//
// Instance Variables
//
private List testResultList = null;
private ApplicationImpl application = null;
private NavigationHandlerTestImpl navHandler = null;
// Attribute Instance Variables
// Relationship Instance Variables
//
// Constructors and Initializers
//
public TestNavigationHandler() {
super("TestNavigationHandler");
}
public TestNavigationHandler(String name) {
super(name);
}
//
// Class methods
//
//
// Methods from TestCase
//
public void setUp() {
super.setUp();
loadConfigFile();
}
//
// General Methods
//
private void loadConfigFile() {
loadFromInitParam("/WEB-INF/faces-navigation.xml");
}
private void loadTestResultList() throws Exception {
DocumentBuilderFactory f = DbfFactory.getFactory();
f.setNamespaceAware(false);
f.setValidating(false);
DocumentBuilder builder = f.newDocumentBuilder();
Document d = builder.parse(config.getServletContext().getResourceAsStream("/WEB-INF/navigation-cases.xml"));
NodeList navigationRules = d.getDocumentElement()
.getElementsByTagName("test");
for (int i = 0; i < navigationRules.getLength(); i++) {
Node test = navigationRules.item(i);
NamedNodeMap attributes = test.getAttributes();
Node fromViewId = attributes.getNamedItem("fromViewId");
Node fromAction = attributes.getNamedItem("fromAction");
Node fromOutput = attributes.getNamedItem("fromOutcome");
Node toViewId = attributes.getNamedItem("toViewId");
createAndAccrueTestResult(((fromViewId != null) ? fromViewId.getTextContent().trim() : null),
((fromAction != null) ? fromAction.getTextContent().trim() : null),
((fromOutput != null) ? fromOutput.getTextContent().trim() : null),
((toViewId != null) ? toViewId.getTextContent().trim() : null));
}
}
public void createAndAccrueTestResult(String fromViewId, String fromAction,
String fromOutcome, String toViewId) {
if (testResultList == null) {
testResultList = new ArrayList();
}
TestResult testResult = new TestResult();
testResult.fromViewId = fromViewId;
testResult.fromAction = fromAction;
testResult.fromOutcome = fromOutcome;
testResult.toViewId = toViewId;
testResultList.add(testResult);
}
public void testNavigationHandler() {
ApplicationFactory aFactory =
(ApplicationFactory) FactoryFinder.getFactory(
FactoryFinder.APPLICATION_FACTORY);
Application application = (ApplicationImpl) aFactory.getApplication();
try {
loadTestResultList();
} catch (Exception e) {
throw new RuntimeException(e);
}
NavigationHandlerImpl navHandler = (NavigationHandlerImpl) application.getNavigationHandler();
FacesContext context = getFacesContext();
String newViewId = null;
UIViewRoot page = null;
boolean gotException = false;
for (int i = 0; i < testResultList.size(); i++) {
TestResult testResult = (TestResult) testResultList.get(i);
System.out.println("Testing from-view-id=" + testResult.fromViewId +
" from-action=" + testResult.fromAction +
" from-outcome=" + testResult.fromOutcome);
page = Util.getViewHandler(getFacesContext()).createView(getFacesContext(), null);
page.setViewId(testResult.fromViewId);
page.setLocale(Locale.US);
context.setViewRoot(page);
try {
navHandler.handleNavigation(context, testResult.fromAction,
testResult.fromOutcome);
} catch (Exception e) {
// exception is valid only if context or fromoutcome is null.
assertTrue(testResult.fromOutcome == null);
gotException = true;
}
if (!gotException) {
newViewId = context.getViewRoot().getViewId();
if (testResult.fromOutcome == null) {
System.out.println(
"assertTrue(" + newViewId + ".equals(" +
testResult.fromViewId +
"))");
assertTrue(newViewId.equals(testResult.fromViewId));
} else {
System.out.println(
"assertTrue(" + newViewId + ".equals(" +
testResult.toViewId +
"))");
assertTrue(newViewId.equals(testResult.toViewId));
}
}
}
}
public void testSimilarFromViewId() {
ApplicationFactory aFactory =
(ApplicationFactory) FactoryFinder.getFactory(
FactoryFinder.APPLICATION_FACTORY);
Application application = aFactory.getApplication();
NavigationHandler navHandler = application.getNavigationHandler();
UIViewRoot root = application.getViewHandler().createView(getFacesContext(), "/dir1/dir2/dir3/test.jsp");
root.setLocale(Locale.US);
getFacesContext().setViewRoot(root);
try {
navHandler.handleNavigation(getFacesContext(), null, "home");
} catch (Exception e) {
e.printStackTrace();
assert(false);
}
String newViewId = getFacesContext().getViewRoot().getViewId();
assertTrue("newViewId is: " + newViewId, "/dir1/dir2/dir3/home.jsp".equals(newViewId));
}
// This tests that the same <from-view-id> element value existing in a seperate
// navigation rule, gets combined with the other rules with the same <from-view-id>.
// Specifically, it will to make sure that after loading, there are the correct number of
// cases with the common <from-view-id>;
public void testSeperateRule() {
int cnt = 0;
ApplicationFactory aFactory =
(ApplicationFactory) FactoryFinder.getFactory(
FactoryFinder.APPLICATION_FACTORY);
Application application = aFactory.getApplication();
assertTrue(application instanceof ApplicationImpl);
ApplicationAssociate associate = ApplicationAssociate.getInstance(getFacesContext().getExternalContext());
assertNotNull(associate);
Map caseListMap = associate.getNavigationCaseListMappings();
Iterator iter = caseListMap.keySet().iterator();
while (iter.hasNext()) {
String fromViewId = (String) iter.next();
if (fromViewId.equals("/login.jsp")) {
List caseList = (List) caseListMap.get(fromViewId);
for (int i = 0; i < caseList.size(); i++) {
ConfigNavigationCase cnc = (ConfigNavigationCase) caseList.get(
i);
if (cnc.getFromViewId().equals("/login.jsp")) {
cnt++;
}
}
}
}
assertTrue(cnt == 6);
}
class TestResult extends Object {
public String fromViewId = null;
public String fromAction = null;
public String fromOutcome = null;
public String toViewId = null;
}
} // end of class TestNavigationHandler