Package net.shibboleth.idp.plugin.authn.test.flow

Class AbstractAuthnXmlFlowExecutionTests

java.lang.Object

junit.framework.Assert

junit.framework.TestCase

org.springframework.webflow.test.execution.AbstractFlowExecutionTests

org.springframework.webflow.test.execution.AbstractExternalizedFlowExecutionTests

net.shibboleth.idp.plugin.authn.test.spring.CustomAbstractXmlFlowExecutionTests

net.shibboleth.idp.plugin.authn.test.flow.AbstractAuthnXmlFlowExecutionTests

All Implemented Interfaces:

junit.framework.Test

Direct Known Subclasses:

OIDCRPFlowTest

public abstract class AbstractAuthnXmlFlowExecutionTests
extends CustomAbstractXmlFlowExecutionTests

Base test class for testing webflows in isolation from the rest of the IdP.

Each flow test reinitialises the mock beans. See setUp() and registerMockBeanDefinitions(MockFlowBuilderContext).

Extends the CustomAbstractXmlFlowExecutionTests over the standard AbstractExternalizedFlowExecutionTests for the sole reason of being able to set a CustomFlowModelFlowBuilder with a placeholder prefix of %{ to be compatible with those used by the IdP. We also set this prefix in various other locations, but those are either ignored by the inbuilt SWF flow builder when it substitutes the placeholder inside the bean import, or do not share the same Mock properties source as is set in the registerMockPropertySource(MockFlowBuilderContext) method. If a better way is found to support that, switch back to the AbstractExternalizedFlowExecutionTests.

In addition, the AnnotationParameterNameDiscoverer class is also registered with the DefaultListableBeanFactory for the context created by the CustomFlowModelFlowBuilder.

Note, you can not use test context creation annotations e.g. @SpringJUnitWebConfig to help build the application context because the AbstractExternalizedFlowExecutionTests creates a new StaticApplicationContext when building the flow (see buildFlow). This is different from the ApplicationContext created by ContextConfiguration annotation processors. As a result, those bean configurations and environment variables need to be injected inside configureFlowBuilderContext(MockFlowBuilderContext)

These test use JUnit (for SWF test compatibility), and work with the TestNG to JUnit bridge

Field Summary

Fields

Modifier and Type	Field	Description
private String	entityId	The mocked entityID of this IdP instance.
protected MockExternalContext	externalContext	Mock external context.
private Map<String,String>	flowModelResources	Map of additional flow resources used to support the construction of the test flow.
private String	flowPath	The path resource to the authentication flow to be tested.
private org.slf4j.Logger	log	Class logger.
private Map<String,String>	mockProperties	Map of properties to set.
protected MockHttpServletRequest	mockRequest	Mock request.
protected MockHttpServletResponse	mockResponse	Mock response.
private List<Flow>	subflows	Mock flows to add as stub subflows when executing the main test flow.

Constructor Summary

Constructors

Constructor	Description
AbstractAuthnXmlFlowExecutionTests(String idpEntityID)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	addBeanDefinition(MockFlowBuilderContext builderContext, String beanName, BeanDefinition bean)	Adds the bean to the StaticApplicationContext contained in the builder context.
protected void	addBeanSingleton(MockFlowBuilderContext builderContext, String beanName, Object bean)	Adds a singleton bean to the StaticApplicationContext contained in the builder context.
void	addHttpBasicAuthHeader(String username, String password)	Add HTTP basic authentication headers to the request.
protected ProfileRequestContext	buildProfileRequestContext(String flowId, boolean forceAuthn, boolean addC14Context)	Build a ProfileRequestContext by configuring a suitable context tree e.g.
protected void	configureFlowBuilderContext(MockFlowBuilderContext builderContext)
private Set<Converter<?,?>>	createConverters()	Create a set of converters similar to those in the IdP's global-system.xml file.
protected FlowDefinitionResource[]	getModelResources(FlowDefinitionResourceFactory resourceFactory)	Template method subclasses may override to return pointers to "flow model resources" needed to build the definition of the flow being tested.
protected FlowDefinitionResource	getResource(FlowDefinitionResourceFactory resourceFactory)
protected void	loadBeanDefinitionsFromXmlFile(MockFlowBuilderContext builderContext, Resource xmlFile, Map<String,String> additionalProperties)	Load beans into the builder context from the given resource e.g.
protected void	registerMockBeanDefinitions(MockFlowBuilderContext builderContext)	Register Shibboleth IdP requred mock beans that are not necessary to configure for authentication testing but are required for authentication flows to proceed.
protected void	registerMockPropertySource(MockFlowBuilderContext builderContext)	Register a MockPropertySource with the Environment of the current flow builders ApplicationContext.
private void	registerMockSubflows(MockFlowBuilderContext builderContext)	Register the subflows with the builder context.
void	setFlowModelResources(Map<String,String> testFlowModelResources)	Set the flow model resources (parent flows) that support the assembly of the flow to test.
void	setFlowPath(String testFlowPath)	Set the path to the flow to test.
void	setMockProperties(Map<String,String> properties)	Set the mock properties to use within a property source.
void	setSubflows(List<Flow> mockSubflows)	Set the mock subflows to be used with the flow to test.
void	setUp()	Setup the mock objects before each method.

Methods inherited from class net.shibboleth.idp.plugin.authn.test.spring.CustomAbstractXmlFlowExecutionTests

createFlowBuilder, registerMockFlowBeans

Methods inherited from class org.springframework.webflow.test.execution.AbstractExternalizedFlowExecutionTests

buildFlow, createResourceLoader, getFlow, getFlowDefinition, getFlowDefinitionRegistry, getResourceFactory, isCacheFlowDefinition, setCacheFlowDefinition, setFlowExecutionAttributes, setFlowExecutionListener, setFlowExecutionListeners

Methods inherited from class org.springframework.webflow.test.execution.AbstractFlowExecutionTests

assertActiveFlowEquals, assertCurrentStateEquals, assertFlowExecutionActive, assertFlowExecutionEnded, assertFlowExecutionOutcomeEquals, assertResponseWrittenEquals, createFlowExecutionFactory, getConversationAttribute, getConversationScope, getFlowAttribute, getFlowExecution, getFlowExecutionFactory, getFlowExecutionOutcome, getFlowScope, getRequiredConversationAttribute, getRequiredConversationAttribute, getRequiredFlowAttribute, getRequiredFlowAttribute, getRequiredViewAttribute, getRequiredViewAttribute, getViewAttribute, getViewScope, resumeFlow, setCurrentState, startFlow, startFlow, updateFlowExecution

Methods inherited from class junit.framework.TestCase

assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertTrue, assertTrue, countTestCases, createResult, fail, fail, failNotEquals, failNotSame, failSame, format, getName, run, run, runBare, runTest, setName, tearDown, toString

Methods inherited from class java.lang.Object

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

Field Detail

mockRequest

protected MockHttpServletRequest mockRequest

Mock request.

mockResponse

protected MockHttpServletResponse mockResponse

Mock response.

externalContext

protected MockExternalContext externalContext

Mock external context.

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

flowPath

@Nonnull
private String flowPath

The path resource to the authentication flow to be tested.

flowModelResources

@Nonnull
private Map<String,String> flowModelResources

Map of additional flow resources used to support the construction of the test flow. These are only possible parents of the flow, and can not be used to load other flows.

The key is the path to the resource, the value is the flowID.

subflows

@Nonnull
private List<Flow> subflows

Mock flows to add as stub subflows when executing the main test flow.

mockProperties

@Nonnull
private Map<String,String> mockProperties

Map of properties to set.

entityId

@Nonnull
private final String entityId

The mocked entityID of this IdP instance.

Constructor Detail

AbstractAuthnXmlFlowExecutionTests

public AbstractAuthnXmlFlowExecutionTests(@Nonnull
                                          String idpEntityID)

Constructor.

Parameters:

idpEntityID - The mocked entityID of this IdP instance

Method Detail

setFlowModelResources

public void setFlowModelResources(@Nonnull
                                  Map<String,String> testFlowModelResources)

Set the flow model resources (parent flows) that support the assembly of the flow to test.

Parameters:

testFlowModelResources - the parent flows.

setFlowPath

public void setFlowPath(@Nonnull @NotEmpty
                        String testFlowPath)

Set the path to the flow to test.

Parameters:

testFlowPath - the path to the file to test.

setMockProperties

public void setMockProperties(@Nonnull
                              Map<String,String> properties)

Set the mock properties to use within a property source.

Parameters:

properties - the mock properties.

setSubflows

public void setSubflows(@Nonnull @NonnullElements
                        List<Flow> mockSubflows)

Set the mock subflows to be used with the flow to test.

Parameters:

mockSubflows - the mock subflows.

addHttpBasicAuthHeader

public void addHttpBasicAuthHeader(@Nonnull
                                   String username,
                                   @Nonnull
                                   String password)

Add HTTP basic authentication headers to the request.

Parameters:

username - the username

password - the password

setUp

public void setUp()
           throws NoSuchFieldException,
                  SecurityException,
                  Exception

Setup the mock objects before each method.

Overrides:

setUp in class junit.framework.TestCase

Throws:

Exception - on error

SecurityException - on error

NoSuchFieldException - on error

getResource

protected FlowDefinitionResource getResource(FlowDefinitionResourceFactory resourceFactory)

Specified by:

getResource in class AbstractExternalizedFlowExecutionTests

getModelResources

protected FlowDefinitionResource[] getModelResources(FlowDefinitionResourceFactory resourceFactory)

Description copied from class: CustomAbstractXmlFlowExecutionTests

Template method subclasses may override to return pointers to "flow model resources" needed to build the definition of the flow being tested. Typically overridden when the flow being tested extends from another flow. Default returns null, assuming no inheritance.

Overrides:

getModelResources in class CustomAbstractXmlFlowExecutionTests

Parameters:

resourceFactory - the resource factory

Returns:

the flow definition model resources

configureFlowBuilderContext

protected void configureFlowBuilderContext(MockFlowBuilderContext builderContext)

Overrides:

configureFlowBuilderContext in class AbstractExternalizedFlowExecutionTests

registerMockSubflows

private void registerMockSubflows(@Nonnull
                                  MockFlowBuilderContext builderContext)

Register the subflows with the builder context.

Parameters:

builderContext - the builder context to register the subflows with.

registerMockBeanDefinitions

protected void registerMockBeanDefinitions(@Nonnull
                                           MockFlowBuilderContext builderContext)

Register Shibboleth IdP requred mock beans that are not necessary to configure for authentication testing but are required for authentication flows to proceed.

Project specific tests should override this method, making sure to also call super().

Parameters:

builderContext - the context used to register the beans.

addBeanDefinition

protected void addBeanDefinition(@Nonnull
                                 MockFlowBuilderContext builderContext,
                                 @Nonnull
                                 String beanName,
                                 @Nonnull
                                 BeanDefinition bean)

Adds the bean to the StaticApplicationContext contained in the builder context.

Parameters:

builderContext - to add the bean to.

beanName - the name of the bean.

bean - the bean.

addBeanSingleton

protected void addBeanSingleton(@Nonnull
                                MockFlowBuilderContext builderContext,
                                @Nonnull
                                String beanName,
                                @Nonnull
                                Object bean)

Adds a singleton bean to the StaticApplicationContext contained in the builder context.

Parameters:

builderContext - to add the bean to.

beanName - the name of the bean.

bean - the bean.

loadBeanDefinitionsFromXmlFile

protected void loadBeanDefinitionsFromXmlFile(@Nonnull
                                              MockFlowBuilderContext builderContext,
                                              @Nonnull
                                              Resource xmlFile,
                                              @Nullable
                                              Map<String,String> additionalProperties)

Load beans into the builder context from the given resource e.g. a classpath resource. The loader used here is separate to the main webflow builder and as such some things need setting up specific to the correct loading of resources in the given xml file.

Parameters:

builderContext - the builder context.

xmlFile - the xml file.

additionalProperties - properties that need to be injected into the bean factory.

createConverters

private Set<Converter<?,?>> createConverters()

Create a set of converters similar to those in the IdP's global-system.xml file. For some reason, it will not register the pre-defined converters, so they are re-created here.

Returns:

a set of converters.

registerMockPropertySource

protected void registerMockPropertySource(@Nonnull
                                          MockFlowBuilderContext builderContext)

Register a MockPropertySource with the Environment of the current flow builders ApplicationContext. Set properties required to run an authentication flow.

Parameters:

builderContext - the builder context to attach the mock property source to.

buildProfileRequestContext

@Nonnull
protected ProfileRequestContext buildProfileRequestContext(@Nonnull
                                                           String flowId,
                                                           @Nonnull
                                                           boolean forceAuthn,
                                                           @Nonnull
                                                           boolean addC14Context)

Build a ProfileRequestContext by configuring a suitable context tree e.g. a AuthenticationContext.

Parameters:

flowId - the flow identifier

forceAuthn - force authentication

addC14Context - add the c14 context, yes or no.

Returns:

a profile request context.