org.springframework.boot.test.context.runner

Class WebApplicationContextRunner

java.lang.Object

org.springframework.boot.test.context.runner.WebApplicationContextRunner

public final class WebApplicationContextRunner
extends Object

A ApplicationContext runner for a Servlet based ConfigurableWebApplicationContext.

See AbstractApplicationContextRunner for details.

Since:

2.0.0

Author:

Andy Wilkinson, Stephane Nicoll, Phillip Webb

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected WebApplicationContextRunner	newInstance(Supplier<org.springframework.web.context.ConfigurableWebApplicationContext> contextFactory, TestPropertyValues environmentProperties, TestPropertyValues systemProperties, ClassLoader classLoader, org.springframework.context.ApplicationContext parent, List<Configurations> configurations)
SELF	run(ContextConsumer<? super A> consumer) Create and refresh a new ApplicationContext based on the current state of this loader.
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<org.springframework.web.context.ConfigurableWebApplicationContext>	withMockServletContext(Supplier<org.springframework.web.context.ConfigurableWebApplicationContext> contextFactory) Decorate the specified contextFactory to set a MockServletContext on each newly created WebApplicationContext.
SELF	withParent(org.springframework.context.ApplicationContext parent) Configure the parent of the ApplicationContext.
SELF	withPropertyValues(String... pairs) Add the specified Environment property pairs.
SELF	withSystemProperties(String... pairs) Add the specified System property pairs.
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

WebApplicationContextRunner

public WebApplicationContextRunner()

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

See Also:

withMockServletContext(Supplier)

WebApplicationContextRunner

public WebApplicationContextRunner(Supplier<org.springframework.web.context.ConfigurableWebApplicationContext> contextFactory)

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

Parameters:

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

Method Detail

newInstance

protected WebApplicationContextRunner newInstance(Supplier<org.springframework.web.context.ConfigurableWebApplicationContext> contextFactory,
                                                  TestPropertyValues environmentProperties,
                                                  TestPropertyValues systemProperties,
                                                  ClassLoader classLoader,
                                                  org.springframework.context.ApplicationContext parent,
                                                  List<Configurations> configurations)

withMockServletContext

public static Supplier<org.springframework.web.context.ConfigurableWebApplicationContext> withMockServletContext(Supplier<org.springframework.web.context.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:

a new instance with the updated property values

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:

a new instance with the updated system properties

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:

a new instance with the updated class loader

See Also:

HidePackagesClassLoader

withParent

public SELF withParent(org.springframework.context.ApplicationContext parent)

Configure the parent of the ApplicationContext.

Parameters:

parent - the parent

Returns:

a new instance with the updated parent

withUserConfiguration

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

Register the specified user configuration classes with the ApplicationContext.

Parameters:

configurationClasses - the user configuration classes to add

Returns:

a new instance with the updated configuration

withConfiguration

public SELF withConfiguration(Configurations configurations)

Register the specified configuration classes with the ApplicationContext.

Parameters:

configurations - the configurations to add

Returns:

a new instance with the updated configuration

run

public SELF 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

Returns:

this instance