org.broadleafcommerce.test

Class BroadleafGenericGroovyXmlWebContextLoader

java.lang.Object

org.springframework.test.context.support.AbstractContextLoader

org.broadleafcommerce.test.BroadleafGenericGroovyXmlWebContextLoader

All Implemented Interfaces:

org.springframework.test.context.ContextLoader, org.springframework.test.context.SmartContextLoader

public class BroadleafGenericGroovyXmlWebContextLoader
extends org.springframework.test.context.support.AbstractContextLoader

This class was created due to AbstractGenericWebContextLoader utilizing the qualifier "final" for its loadContext(MergedContextConfiguration) method which we needed to override and provide our Broadleaf created MergeXmlWebApplicationContext object in place of the GenericWebApplicationContext it used. Since we are using Groovy/Spock, the other methods included are to support Groovy test classes. As such, are included some methods from the GenericGroovyXmlWebContextLoader and GenericXmlWebContextLoader classes, refactored to compensate for the levels of inheritance between them.

This class loader should be used with the @ContextConfiguration annotation to be placed in the 'loader' parameter for all Broadleaf integration tests which use the Spock testing framework.

Author:

austinrooke

Constructor Summary

Constructors

Constructor and Description
BroadleafGenericGroovyXmlWebContextLoader()

Method Summary

Modifier and Type	Method and Description
protected void	configureWebResources(org.broadleafcommerce.common.web.extensibility.MergeXmlWebApplicationContext context, org.springframework.test.context.web.WebMergedContextConfiguration webMergedConfig) Configures web resources for the supplied web application context (WAC).
protected String	getResourceSuffix() BroadleafGenericGroovyXmlWebContextLoader supports the XML merging that Broadleaf's framework features, but this is handled during the .refresh() method in the loadContext method so this method was only pulled from the original class GenericGroovyXmlWebContextLoader in case of the Spring-Test framework requiring this method to have a particular behavior.
protected String[]	getResourceSuffixes() BroadleafGenericGroovyXmlWebContextLoader supports the XML merging that Broadleaf's framework features, but this is handled during the .refresh() method in the loadContext method so this method was only pulled from the original class GenericGroovyXmlWebContextLoader in case of the Spring-Test framework requiring this method to have a particular behavior.
org.springframework.context.ConfigurableApplicationContext	loadContext(org.springframework.test.context.MergedContextConfiguration mergedConfig) Load a MergeXmlWebApplicationContext from the supplied MergedContextConfiguration
org.springframework.context.ApplicationContext	loadContext(String... locations) BroadleafGenericGroovyXmlWebContextLoader should be used as a SmartContextLoader, not as a legacy ContextLoader.
protected void	validateMergedContextConfiguration(org.springframework.test.context.web.WebMergedContextConfiguration webMergedConfig) BroadleafGenericGroovyXmlWebContextLoader supports the XML merging that Broadleaf's framework features, but this is handled during the .refresh() method in the loadContext method so this method was only pulled from the original class GenericXmlWebContextLoader in case of the Spring-Test framework requiring this method to have a particular behavior.

Methods inherited from class org.springframework.test.context.support.AbstractContextLoader

generateDefaultLocations, isGenerateDefaultLocations, modifyLocations, prepareContext, processContextConfiguration, processLocations

Methods inherited from class java.lang.Object

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

Constructor Detail

BroadleafGenericGroovyXmlWebContextLoader

public BroadleafGenericGroovyXmlWebContextLoader()

Method Detail

getResourceSuffixes

protected String[] getResourceSuffixes()

BroadleafGenericGroovyXmlWebContextLoader supports the XML merging that Broadleaf's framework features, but this is handled during the .refresh() method in the loadContext method so this method was only pulled from the original class GenericGroovyXmlWebContextLoader in case of the Spring-Test framework requiring this method to have a particular behavior.

Overrides:

getResourceSuffixes in class org.springframework.test.context.support.AbstractContextLoader

getResourceSuffix

protected String getResourceSuffix()

BroadleafGenericGroovyXmlWebContextLoader supports the XML merging that Broadleaf's framework features, but this is handled during the .refresh() method in the loadContext method so this method was only pulled from the original class GenericGroovyXmlWebContextLoader in case of the Spring-Test framework requiring this method to have a particular behavior.

Specified by:

getResourceSuffix in class org.springframework.test.context.support.AbstractContextLoader

validateMergedContextConfiguration

protected void validateMergedContextConfiguration(org.springframework.test.context.web.WebMergedContextConfiguration webMergedConfig)

BroadleafGenericGroovyXmlWebContextLoader supports the XML merging that Broadleaf's framework features, but this is handled during the .refresh() method in the loadContext method so this method was only pulled from the original class GenericXmlWebContextLoader in case of the Spring-Test framework requiring this method to have a particular behavior.

See Also:

AbstractGenericWebContextLoader.validateMergedContextConfiguration(org.springframework.test.context.web.WebMergedContextConfiguration)

loadContext

public final org.springframework.context.ApplicationContext loadContext(String... locations)
                                                                 throws Exception

BroadleafGenericGroovyXmlWebContextLoader should be used as a SmartContextLoader, not as a legacy ContextLoader. Consequently, this method is not supported. This method was pulled from AbstractGenericWebContextLoader.

Throws:

UnsupportedOperationException

Exception

See Also:

ContextLoader.loadContext(java.lang.String[])

loadContext

public org.springframework.context.ConfigurableApplicationContext loadContext(org.springframework.test.context.MergedContextConfiguration mergedConfig)
                                                                       throws Exception

Load a MergeXmlWebApplicationContext from the supplied MergedContextConfiguration

Implementation details:

• Calls validateMergedContextConfiguration(WebMergedContextConfiguration) to allow subclasses to validate the supplied configuration before proceeding.
• Creates a MergeXmlWebApplicationContext instance.
• If the supplied MergeXmlWebApplicationContext references a parent configuration, the corresponding ApplicationContext will be retrieved and set as the parent for the context created by this method.
• Converts the patch locations into a single string to be set via MergeXmlWebApplicationContext.setPatchLocation(String)
• Sets the patch locations via MergeXmlWebApplicationContext#setStandardLocationTypes(String) to the StandardConfigLocations.TESTCONTEXTTYPE for integration tests.
• Delegates to configureWebResources(org.broadleafcommerce.common.web.extensibility.MergeXmlWebApplicationContext, org.springframework.test.context.web.WebMergedContextConfiguration) to create the MockServletContext and set it in the MergeXmlWebApplicationContext.
• Calls AbstractContextLoader.prepareContext(org.springframework.context.ConfigurableApplicationContext, org.springframework.test.context.MergedContextConfiguration) to allow for customizing the context before bean definitions are loaded.
• Refreshes the context and registers a JVM shutdown hook for it.

Refactored from AbstractGenericWebContextLoader.loadContext(MergedContextConfiguration)

Returns:

a new merge xml web application context

Throws:

Exception

See Also:

SmartContextLoader.loadContext(MergedContextConfiguration), MergeXmlWebApplicationContext

configureWebResources

protected void configureWebResources(org.broadleafcommerce.common.web.extensibility.MergeXmlWebApplicationContext context,
                                     org.springframework.test.context.web.WebMergedContextConfiguration webMergedConfig)

Configures web resources for the supplied web application context (WAC).

Implementation Details

If the supplied WAC has no parent or its parent is not a WAC, the supplied WAC will be configured as the Root WAC (see "Root WAC Configuration" below).

Otherwise the context hierarchy of the supplied WAC will be traversed to find the top-most WAC (i.e., the root); and the ServletContext of the Root WAC will be set as the ServletContext for the supplied WAC.

Root WAC Configuration

• The resource base path is retrieved from the supplied WebMergedContextConfiguration.
• A ResourceLoader is instantiated for the MockServletContext: if the resource base path is prefixed with "classpath:/", a DefaultResourceLoader will be used; otherwise, a FileSystemResourceLoader will be used.
• A MockServletContext will be created using the resource base path and resource loader.
• The supplied MergeXmlWebApplicationContext is then stored in the MockServletContext under the WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE key.
• Finally, the MockServletContext is set in the MergeXmlWebApplicationContext.

Parameters:

context - the merge xml web application context for which to configure the web resources

webMergedConfig - the merged context configuration to use to load the merge xml web application context