org.apache.myfaces.mc.test.core

Class AbstractMyFacesTestCase

java.lang.Object

org.apache.myfaces.mc.test.core.AbstractMyFacesTestCase

Direct Known Subclasses:

AbstractMyFacesRequestTestCase

public abstract class AbstractMyFacesTestCase
extends Object

Abstract JUnit test case base class, which sets up MyFaces Core environment using mock object for the outer servlet environment.

Since jsp engine is not bundled with MyFaces, this configuration is able to handle facelet pages only.

Author:

Leonardo Uribe

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractMyFacesTestCase.JUnitFacesInitializer
protected class	AbstractMyFacesTestCase.JUnitNoCDIFacesInitializer
protected class	AbstractMyFacesTestCase.MyFacesMockFacesConfigurationProvider Mock FacesConfigurationProvider that replace the original ViewDeclarationLanguageFactory with a customized one that contains only facelets vdl and cache some FacesConfig that does not change to reduce the time required to process each test.
protected static class	AbstractMyFacesTestCase.SharedFacesConfiguration

Field Summary

Fields

Modifier and Type	Field and Description
static int	AFTER_RENDER_STEP
static int	BEFORE_RENDER_STEP
static int	BUILD_VIEW_CYCLE_STEP
protected FacesConfigurationProvider	facesConfigurationProvider
protected jakarta.faces.context.FacesContextFactory	facesContextFactory
static String	LAST_PHASE_PROCESSED
static String	LAST_RENDER_PHASE_STEP
protected jakarta.faces.lifecycle.Lifecycle	lifecycle
protected jakarta.faces.lifecycle.LifecycleFactory	lifecycleFactory
protected StartupServletContextListener	listener
static String	PHASE_MANAGER_INSTANCE
protected org.apache.myfaces.test.mock.MockServletConfig	servletConfig
protected org.apache.myfaces.test.mock.MockServletContext	servletContext
static int	VIEWHANDLER_RENDER_STEP
protected org.apache.myfaces.test.mock.MockWebContainer	webContainer

Constructor Summary

Constructors

Constructor and Description
AbstractMyFacesTestCase() Construct a new instance of this test case.

Method Summary

Modifier and Type	Method and Description
void	applyRequestValues(jakarta.faces.context.FacesContext facesContext) Execute apply request values phase.
protected jakarta.el.ExpressionFactory	createExpressionFactory() Create the ExpressionFactory instance that will be used to initialize the test environment.
protected FacesConfigurationProvider	createFacesConfigurationProvider()
protected AbstractFacesInitializer	createFacesInitializer()
void	executeAfterRender(jakarta.faces.context.FacesContext facesContext)
void	executeBeforeRender(jakarta.faces.context.FacesContext facesContext)
void	executeBuildViewCycle(jakarta.faces.context.FacesContext facesContext)
protected void	executePhase(jakarta.faces.context.FacesContext facesContext, jakarta.faces.event.PhaseId phase) Execute an specified phase, doing some reflection over LifecycleImpl.
void	executeViewHandlerRender(jakarta.faces.context.FacesContext facesContext)
protected String	getRenderedContent(jakarta.faces.context.FacesContext facesContext)
protected Class<?>	getTestJavaClass()
protected URI	getWebappContextURI() Return an URI that identifies the base path that will be used by servletContext to load resources like facelet files an others.
protected String	getWebappResourcePath() Return a path that is used to load resources like facelet files an others.
void	invokeApplication(jakarta.faces.context.FacesContext facesContext) Execute invoke application phase.
protected boolean	isScanAnnotations() Indicate if annotation scanning should be done over the classpath.
void	processLifecycleExecute(jakarta.faces.context.FacesContext facesContext) Call lifecycle.execute(facesContext)
void	processLifecycleRender(jakarta.faces.context.FacesContext facesContext)
void	processRemainingExecutePhases(jakarta.faces.context.FacesContext facesContext)
void	processRemainingPhases(jakarta.faces.context.FacesContext facesContext)
protected void	processRemainingPhasesBefore(jakarta.faces.context.FacesContext facesContext, jakarta.faces.event.PhaseId phaseId)
void	processValidations(jakarta.faces.context.FacesContext facesContext) Execute process validations phase.
void	renderResponse(jakarta.faces.context.FacesContext facesContext) Call lifecycle.render(facesContext)
void	restoreView(jakarta.faces.context.FacesContext facesContext) Execute restore view phase.
void	setUp() Set up instance variables required by this test case.
protected void	setUpClassloader() Set up the thread context classloader.
protected void	setUpFacesServlet()
protected void	setUpMyFaces()
protected void	setUpServletListeners() setup listeners avaliable in the test environment
protected void	setUpServletObjects() Setup servlet objects that will be used for the test:
protected void	setUpServlets() setup servlets avaliable in the test environment
protected void	setUpWebConfigParams() Setup web config params.
void	tearDown()
static void	tearDownClass()
protected void	tearDownClassloader()
protected void	tearDownFacesServlet()
protected void	tearDownMyFaces()
protected void	tearDownServletListeners()
protected void	tearDownServlets()
void	updateModelValues(jakarta.faces.context.FacesContext facesContext) Execute update model phase.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PHASE_MANAGER_INSTANCE

public static final String PHASE_MANAGER_INSTANCE

See Also:

Constant Field Values

LAST_PHASE_PROCESSED

public static final String LAST_PHASE_PROCESSED

See Also:

Constant Field Values

LAST_RENDER_PHASE_STEP

public static final String LAST_RENDER_PHASE_STEP

See Also:

Constant Field Values

BEFORE_RENDER_STEP

public static final int BEFORE_RENDER_STEP

See Also:

Constant Field Values

BUILD_VIEW_CYCLE_STEP

public static final int BUILD_VIEW_CYCLE_STEP

See Also:

Constant Field Values

VIEWHANDLER_RENDER_STEP

public static final int VIEWHANDLER_RENDER_STEP

See Also:

Constant Field Values

AFTER_RENDER_STEP

public static final int AFTER_RENDER_STEP

See Also:

Constant Field Values

servletConfig

protected org.apache.myfaces.test.mock.MockServletConfig servletConfig

servletContext

protected org.apache.myfaces.test.mock.MockServletContext servletContext

webContainer

protected org.apache.myfaces.test.mock.MockWebContainer webContainer

listener

protected StartupServletContextListener listener

facesConfigurationProvider

protected FacesConfigurationProvider facesConfigurationProvider

facesContextFactory

protected jakarta.faces.context.FacesContextFactory facesContextFactory

lifecycleFactory

protected jakarta.faces.lifecycle.LifecycleFactory lifecycleFactory

lifecycle

protected jakarta.faces.lifecycle.Lifecycle lifecycle

Constructor Detail

AbstractMyFacesTestCase

public AbstractMyFacesTestCase()

Construct a new instance of this test case.

Method Detail

setUp

public void setUp()
           throws Exception

Set up instance variables required by this test case.

Throws:

Exception

setUpClassloader

protected void setUpClassloader()
                         throws Exception

Set up the thread context classloader. JSF uses the this classloader in order to find related factory classes and other resources, but in some selected cases, the default classloader cannot be properly set.

Throws:

Exception

setUpServletObjects

protected void setUpServletObjects()
                            throws Exception

Setup servlet objects that will be used for the test:

• servletConfig (MockServletConfig)
• servletContext (MockServletContext)

Throws:

Exception

setUpWebConfigParams

protected void setUpWebConfigParams()
                             throws Exception

Setup web config params. By default it sets the following params

• "org.apache.myfaces.INITIALIZE_ALWAYS_STANDALONE", "true"
• "jakarta.faces.PROJECT_STAGE", "UnitTest"
• "jakarta.faces.PARTIAL_STATE_SAVING", "true"
• "jakarta.faces.FACELETS_REFRESH_PERIOD", "-1"

Throws:

Exception

getWebappContextURI

protected URI getWebappContextURI()

Return an URI that identifies the base path that will be used by servletContext to load resources like facelet files an others. By default it points to the directory path calculated from the package name of the child test class.

Returns:

getWebappResourcePath

protected String getWebappResourcePath()

Return a path that is used to load resources like facelet files an others. By default it points to the directory path calculated from the package name of the child test class.

Returns:

createExpressionFactory

protected jakarta.el.ExpressionFactory createExpressionFactory()

Create the ExpressionFactory instance that will be used to initialize the test environment. By default it uses MockExpressionFactory.

Returns:

setUpServlets

protected void setUpServlets()
                      throws Exception

setup servlets avaliable in the test environment

Throws:

Exception

setUpServletListeners

protected void setUpServletListeners()
                              throws Exception

setup listeners avaliable in the test environment

Throws:

Exception

createFacesConfigurationProvider

protected FacesConfigurationProvider createFacesConfigurationProvider()

Returns:

createFacesInitializer

protected AbstractFacesInitializer createFacesInitializer()

setUpMyFaces

protected void setUpMyFaces()
                     throws Exception

Throws:

Exception

tearDownMyFaces

protected void tearDownMyFaces()

setUpFacesServlet

protected void setUpFacesServlet()
                          throws Exception

Throws:

Exception

tearDownFacesServlet

protected void tearDownFacesServlet()
                             throws Exception

Throws:

Exception

tearDownServlets

protected void tearDownServlets()
                         throws Exception

Throws:

Exception

tearDownServletListeners

protected void tearDownServletListeners()
                                 throws Exception

Throws:

Exception

tearDown

public void tearDown()
              throws Exception

Throws:

Exception

tearDownClassloader

protected void tearDownClassloader()
                            throws Exception

Throws:

Exception

tearDownClass

public static void tearDownClass()

processLifecycleExecute

public void processLifecycleExecute(jakarta.faces.context.FacesContext facesContext)

Call lifecycle.execute(facesContext)

Parameters:

facesContext -

restoreView

public void restoreView(jakarta.faces.context.FacesContext facesContext)

Execute restore view phase.

Parameters:

facesContext -

applyRequestValues

public void applyRequestValues(jakarta.faces.context.FacesContext facesContext)

Execute apply request values phase. If the responseComplete or renderResponse flags are set, it returns without do any action.

Parameters:

facesContext -

processValidations

public void processValidations(jakarta.faces.context.FacesContext facesContext)

Execute process validations phase. If the responseComplete or renderResponse flags are set, it returns without do any action.

Parameters:

facesContext -

updateModelValues

public void updateModelValues(jakarta.faces.context.FacesContext facesContext)

Execute update model phase. If the responseComplete or renderResponse flags are set, it returns without do any action.

Parameters:

facesContext -

invokeApplication

public void invokeApplication(jakarta.faces.context.FacesContext facesContext)

Execute invoke application phase. If the responseComplete or renderResponse flags are set, it returns without do any action.

Parameters:

facesContext -

processLifecycleRender

public void processLifecycleRender(jakarta.faces.context.FacesContext facesContext)

renderResponse

public void renderResponse(jakarta.faces.context.FacesContext facesContext)

Call lifecycle.render(facesContext)

Parameters:

facesContext -

processRemainingPhasesBefore

protected void processRemainingPhasesBefore(jakarta.faces.context.FacesContext facesContext,
                                            jakarta.faces.event.PhaseId phaseId)

processRemainingExecutePhases

public void processRemainingExecutePhases(jakarta.faces.context.FacesContext facesContext)

processRemainingPhases

public void processRemainingPhases(jakarta.faces.context.FacesContext facesContext)

isScanAnnotations

protected boolean isScanAnnotations()

Indicate if annotation scanning should be done over the classpath. By default it is set to false.

Returns:

executeBeforeRender

public void executeBeforeRender(jakarta.faces.context.FacesContext facesContext)

executeBuildViewCycle

public void executeBuildViewCycle(jakarta.faces.context.FacesContext facesContext)

executeViewHandlerRender

public void executeViewHandlerRender(jakarta.faces.context.FacesContext facesContext)

executeAfterRender

public void executeAfterRender(jakarta.faces.context.FacesContext facesContext)

executePhase

protected void executePhase(jakarta.faces.context.FacesContext facesContext,
                            jakarta.faces.event.PhaseId phase)

Execute an specified phase, doing some reflection over LifecycleImpl.

Parameters:

facesContext -

phase -

getRenderedContent

protected String getRenderedContent(jakarta.faces.context.FacesContext facesContext)
                             throws IOException

Throws:

IOException

getTestJavaClass

protected Class<?> getTestJavaClass()