/* | |
* 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.test.jmock; | |
import java.net.URL; | |
import java.net.URLClassLoader; | |
import javax.faces.FactoryFinder; | |
import javax.faces.application.ApplicationFactory; | |
import javax.faces.component.UIViewRoot; | |
import javax.faces.lifecycle.LifecycleFactory; | |
import javax.faces.render.RenderKitFactory; | |
import org.apache.myfaces.test.mock.MockApplication; | |
import org.apache.myfaces.test.mock.MockExternalContext; | |
import org.apache.myfaces.test.mock.MockFacesContext; | |
import org.apache.myfaces.test.mock.MockFacesContextFactory; | |
import org.apache.myfaces.test.mock.MockHttpServletRequest; | |
import org.apache.myfaces.test.mock.MockHttpServletResponse; | |
import org.apache.myfaces.test.mock.MockHttpSession; | |
import org.apache.myfaces.test.mock.MockRenderKit; | |
import org.apache.myfaces.test.mock.MockServletConfig; | |
import org.apache.myfaces.test.mock.MockServletContext; | |
import org.apache.myfaces.test.mock.lifecycle.MockLifecycle; | |
import org.apache.myfaces.test.mock.lifecycle.MockLifecycleFactory; | |
import org.jmock.cglib.MockObjectTestCase; | |
/** | |
* <p>Abstract JMock test case base class, which sets up the JavaServer Faces | |
* mock object environment for a particular simulated request. The following | |
* protected variables are initialized in the <code>setUp()</code> method, and | |
* cleaned up in the <code>tearDown()</code> method:</p> | |
* <ul> | |
* <li><code>application</code> (<code>MockApplication</code>)</li> | |
* <li><code>config</code> (<code>MockServletConfig</code>)</li> | |
* <li><code>externalContext</code> (<code>MockExternalContext</code>)</li> | |
* <li><code>facesContext</code> (<code>MockFacesContext</code>)</li> | |
* <li><code>lifecycle</code> (<code>MockLifecycle</code>)</li> | |
* <li><code>request</code> (<code>MockHttpServletRequest</code></li> | |
* <li><code>response</code> (<code>MockHttpServletResponse</code>)</li> | |
* <li><code>servletContext</code> (<code>MockServletContext</code>)</li> | |
* <li><code>session</code> (<code>MockHttpSession</code>)</li> | |
* </ul> | |
* | |
* <p>In addition, appropriate factory classes will have been registered with | |
* <code>javax.faces.FactoryFinder</code> for <code>Application</code> and | |
* <code>RenderKit</code> instances. The created <code>FacesContext</code> | |
* instance will also have been registered in the apppriate thread local | |
* variable, to simulate what a servlet container would do.</p> | |
* | |
* <p><strong>WARNING</strong> - If you choose to subclass this class, be sure | |
* your <code>setUp()</code> and <code>tearDown()</code> methods call | |
* <code>super.setUp()</code> and <code>super.tearDown()</code> respectively, | |
* and that you implement your own <code>suite()</code> method that exposes | |
* the test methods for your test case.</p> | |
*/ | |
public abstract class AbstractJmockJsfTestCase extends MockObjectTestCase { | |
// ------------------------------------------------------------ Constructors | |
// Construct a new instance of this test case. | |
public AbstractJmockJsfTestCase(String name) { | |
setName(name); | |
} | |
// ---------------------------------------------------- Overall Test Methods | |
// Set up instance variables required by this test case. | |
protected void setUp() throws Exception { | |
// Set up a new thread context class loader | |
threadContextClassLoader = Thread.currentThread().getContextClassLoader(); | |
Thread.currentThread().setContextClassLoader(new URLClassLoader(new URL[0], | |
this.getClass().getClassLoader())); | |
// Set up Servlet API Objects | |
servletContext = new MockServletContext(); | |
config = new MockServletConfig(servletContext); | |
session = new MockHttpSession(); | |
session.setServletContext(servletContext); | |
request = new MockHttpServletRequest(session); | |
request.setServletContext(servletContext); | |
response = new MockHttpServletResponse(); | |
// Set up JSF API Objects | |
FactoryFinder.releaseFactories(); | |
FactoryFinder.setFactory(FactoryFinder.APPLICATION_FACTORY, | |
"org.apache.myfaces.test.mock.MockApplicationFactory"); | |
FactoryFinder.setFactory(FactoryFinder.FACES_CONTEXT_FACTORY, | |
"org.apache.myfaces.test.mock.MockFacesContextFactory"); | |
FactoryFinder.setFactory(FactoryFinder.LIFECYCLE_FACTORY, | |
"org.apache.myfaces.test.mock.lifecycle.MockLifecycleFactory"); | |
FactoryFinder.setFactory(FactoryFinder.RENDER_KIT_FACTORY, | |
"org.apache.myfaces.test.mock.MockRenderKitFactory"); | |
externalContext = | |
new MockExternalContext(servletContext, request, response); | |
lifecycleFactory = (MockLifecycleFactory) | |
FactoryFinder.getFactory(FactoryFinder.LIFECYCLE_FACTORY); | |
lifecycle = (MockLifecycle) | |
lifecycleFactory.getLifecycle(LifecycleFactory.DEFAULT_LIFECYCLE); | |
facesContextFactory = (MockFacesContextFactory) | |
FactoryFinder.getFactory(FactoryFinder.FACES_CONTEXT_FACTORY); | |
facesContext = (MockFacesContext) | |
facesContextFactory.getFacesContext(servletContext, | |
request, | |
response, | |
lifecycle); | |
externalContext = (MockExternalContext) facesContext.getExternalContext(); | |
UIViewRoot root = new UIViewRoot(); | |
root.setViewId("/viewId"); | |
root.setRenderKitId(RenderKitFactory.HTML_BASIC_RENDER_KIT); | |
facesContext.setViewRoot(root); | |
ApplicationFactory applicationFactory = (ApplicationFactory) | |
FactoryFinder.getFactory(FactoryFinder.APPLICATION_FACTORY); | |
application = (MockApplication) applicationFactory.getApplication(); | |
facesContext.setApplication(application); | |
RenderKitFactory renderKitFactory = (RenderKitFactory) | |
FactoryFinder.getFactory(FactoryFinder.RENDER_KIT_FACTORY); | |
renderKit = new MockRenderKit(); | |
renderKitFactory.addRenderKit(RenderKitFactory.HTML_BASIC_RENDER_KIT, renderKit); | |
} | |
// Tear down instance variables required by this test case. | |
protected void tearDown() throws Exception { | |
application = null; | |
config = null; | |
externalContext = null; | |
facesContext.release(); | |
facesContext = null; | |
lifecycle = null; | |
lifecycleFactory = null; | |
renderKit = null; | |
request = null; | |
response = null; | |
servletContext = null; | |
session = null; | |
FactoryFinder.releaseFactories(); | |
Thread.currentThread().setContextClassLoader(threadContextClassLoader); | |
threadContextClassLoader = null; | |
} | |
// ------------------------------------------------------ Instance Variables | |
// Mock object instances for our tests | |
protected MockApplication application = null; | |
protected MockServletConfig config = null; | |
protected MockExternalContext externalContext = null; | |
protected MockFacesContext facesContext = null; | |
protected MockFacesContextFactory facesContextFactory = null; | |
protected MockLifecycle lifecycle = null; | |
protected MockLifecycleFactory lifecycleFactory = null; | |
protected MockRenderKit renderKit = null; | |
protected MockHttpServletRequest request = null; | |
protected MockHttpServletResponse response = null; | |
protected MockServletContext servletContext = null; | |
protected MockHttpSession session = null; | |
// Thread context class loader saved and restored after each test | |
private ClassLoader threadContextClassLoader = null; | |
} |