org.springframework.boot.test.context.runner

Class WebApplicationContextRunner

java.lang.Object

org.springframework.boot.test.context.runner.AbstractApplicationContextRunner<WebApplicationContextRunner,org.springframework.web.context.ConfigurableWebApplicationContext,AssertableWebApplicationContext>

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

public final class WebApplicationContextRunner
extends AbstractApplicationContextRunner<WebApplicationContextRunner,org.springframework.web.context.ConfigurableWebApplicationContext,AssertableWebApplicationContext>

An ApplicationContext runner for a Servlet based ConfigurableWebApplicationContext.

See AbstractApplicationContextRunner for details.

Since:

2.0.0

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.boot.test.context.runner.AbstractApplicationContextRunner

AbstractApplicationContextRunner.BeanRegistration<T>

Constructor Summary

Constructors

Constructor and Description
WebApplicationContextRunner() Create a new WebApplicationContextRunner instance using an AnnotationConfigServletWebApplicationContext with a MockServletContext as the underlying source.
WebApplicationContextRunner(java.util.function.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(java.util.function.Supplier<org.springframework.web.context.ConfigurableWebApplicationContext> contextFactory, boolean allowBeanDefinitionOverriding, java.util.List<org.springframework.context.ApplicationContextInitializer<? super org.springframework.web.context.ConfigurableWebApplicationContext>> initializers, TestPropertyValues environmentProperties, TestPropertyValues systemProperties, java.lang.ClassLoader classLoader, org.springframework.context.ApplicationContext parent, java.util.List<AbstractApplicationContextRunner.BeanRegistration<?>> beanRegistrations, java.util.List<org.springframework.boot.context.annotation.Configurations> configurations)
static java.util.function.Supplier<org.springframework.web.context.ConfigurableWebApplicationContext>	withMockServletContext(java.util.function.Supplier<org.springframework.web.context.ConfigurableWebApplicationContext> contextFactory) Decorate the specified contextFactory to set a MockServletContext on each newly created WebApplicationContext.

Methods inherited from class org.springframework.boot.test.context.runner.AbstractApplicationContextRunner

run, with, withAllowBeanDefinitionOverriding, withBean, withBean, withBean, withBean, withClassLoader, withConfiguration, withInitializer, withParent, withPropertyValues, withSystemProperties, withUserConfiguration

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 AnnotationConfigServletWebApplicationContext with a MockServletContext as the underlying source.

See Also:

withMockServletContext(Supplier)

WebApplicationContextRunner

public WebApplicationContextRunner(java.util.function.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(java.util.function.Supplier<org.springframework.web.context.ConfigurableWebApplicationContext> contextFactory,
                                                  boolean allowBeanDefinitionOverriding,
                                                  java.util.List<org.springframework.context.ApplicationContextInitializer<? super org.springframework.web.context.ConfigurableWebApplicationContext>> initializers,
                                                  TestPropertyValues environmentProperties,
                                                  TestPropertyValues systemProperties,
                                                  java.lang.ClassLoader classLoader,
                                                  org.springframework.context.ApplicationContext parent,
                                                  java.util.List<AbstractApplicationContextRunner.BeanRegistration<?>> beanRegistrations,
                                                  java.util.List<org.springframework.boot.context.annotation.Configurations> configurations)

Specified by:

newInstance in class AbstractApplicationContextRunner<WebApplicationContextRunner,org.springframework.web.context.ConfigurableWebApplicationContext,AssertableWebApplicationContext>

withMockServletContext

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