org.springframework.boot.test.context

Class WebApplicationContextTester

java.lang.Object

org.springframework.boot.test.context.WebApplicationContextTester

public final class WebApplicationContextTester
extends Object

A ApplicationContext tester for a Servlet based ConfigurableWebApplicationContext.

See AbstractApplicationContextTester for details.

Since:

2.0.0

Author:

Andy Wilkinson, Stephane Nicoll, Phillip Webb

Constructor Summary

Constructors

Constructor and Description
WebApplicationContextTester() Create a new WebApplicationContextTester instance using an AnnotationConfigWebApplicationContext with a MockServletContext as the underlying source.
WebApplicationContextTester(Supplier<ConfigurableWebApplicationContext> contextFactory) Create a new WebApplicationContextTester instance using the specified contextFactory as the underlying source.

Method Summary

Modifier and Type	Method and Description
void	run(ContextConsumer<? super A> consumer) Create and refresh a new ApplicationContext based on the current state of this loader.
protected SELF	self()
SELF	withClassLoader(ClassLoader classLoader) Customize the ClassLoader that the ApplicationContext should use.
SELF	withConfiguration(Configurations configurations) Register the specified configuration classes with the ApplicationContext.
static Supplier<ConfigurableWebApplicationContext>	withMockServletContext(Supplier<ConfigurableWebApplicationContext> contextFactory) Decorate the specified contextFactory to set a MockServletContext on each newly created WebApplicationContext.
SELF	withParent(ApplicationContext parent) Configure the parent of the ApplicationContext.
SELF	withPropertyValue(String name, String value) Add the specified Environment property.
SELF	withPropertyValues(String... pairs) Add the specified Environment property pairs.
SELF	withSystemProperties(String... pairs) Add the specified System property pairs.
SELF	withSystemProperty(String name, String value) Add the specified System property.
SELF	withUserConfiguration(Class<?>... configurationClasses) Register the specified user configuration classes with the ApplicationContext.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebApplicationContextTester

public WebApplicationContextTester()

Create a new WebApplicationContextTester instance using an AnnotationConfigWebApplicationContext with a MockServletContext as the underlying source.

See Also:

withMockServletContext(Supplier)

WebApplicationContextTester

public WebApplicationContextTester(Supplier<ConfigurableWebApplicationContext> contextFactory)

Create a new WebApplicationContextTester instance using the specified contextFactory as the underlying source.

Parameters:

contextFactory - a supplier that returns a new instance on each call

Method Detail

withMockServletContext

public static Supplier<ConfigurableWebApplicationContext> withMockServletContext(Supplier<ConfigurableWebApplicationContext> contextFactory)

Decorate the specified contextFactory to set a MockServletContext on each newly created WebApplicationContext.

Parameters:

contextFactory - the context factory to decorate

Returns:

an updated supplier that will set the MockServletContext

withPropertyValues

public SELF withPropertyValues(String... pairs)

Add the specified Environment property pairs. Key-value pairs can be specified with colon (":") or equals ("=") separators. Override matching keys that might have been specified previously.

Parameters:

pairs - the key-value pairs for properties that need to be added to the environment

Returns:

this instance

See Also:

TestPropertyValues, withSystemProperties(String...)

withPropertyValue

public SELF withPropertyValue(String name,
                              String value)

Add the specified Environment property.

Parameters:

name - the name of the property

value - the value of the property

Returns:

this instance

See Also:

TestPropertyValues, withSystemProperties(String...)

withSystemProperties

public SELF withSystemProperties(String... pairs)

Add the specified System property pairs. Key-value pairs can be specified with colon (":") or equals ("=") separators. System properties are added before the context is run and restored when the context is closed.

Parameters:

pairs - the key-value pairs for properties that need to be added to the system

Returns:

this instance

See Also:

TestPropertyValues, withSystemProperties(String...)

withSystemProperty

public SELF withSystemProperty(String name,
                               String value)

Add the specified System property. System properties are added before the context is run and restored when the context is closed.

Parameters:

name - the property name

value - the property value

Returns:

this instance

See Also:

TestPropertyValues, withSystemProperties(String...)

withClassLoader

public SELF withClassLoader(ClassLoader classLoader)

Customize the ClassLoader that the ApplicationContext should use. Customizing the ClassLoader is an effective manner to hide resources from the classpath.

Parameters:

classLoader - the classloader to use (can be null to use the default)

Returns:

this instance

See Also:

HidePackagesClassLoader

withParent

public SELF withParent(ApplicationContext parent)

Configure the parent of the ApplicationContext.

Parameters:

parent - the parent

Returns:

this instance

withUserConfiguration

public SELF withUserConfiguration(Class<?>... configurationClasses)

Register the specified user configuration classes with the ApplicationContext.

Parameters:

configurationClasses - the user configuration classes to add

Returns:

this instance

withConfiguration

public SELF withConfiguration(Configurations configurations)

Register the specified configuration classes with the ApplicationContext.

Parameters:

configurations - the configurations to add

Returns:

this instance

self

protected final SELF self()

run

public void run(ContextConsumer<? super A> consumer)

Create and refresh a new ApplicationContext based on the current state of this loader. The context is consumed by the specified consumer and closed upon completion.

Parameters:

consumer - the consumer of the created ApplicationContext