spring-boot-test/org.springframework.boot.test.context.runner/WebApplicationContextRunner

WebApplicationContextRunner

class WebApplicationContextRunner : AbstractApplicationContextRunner<SELF, C, A>

An ApplicationContext runner for a Servlet based ConfigurableWebApplicationContext.

See AbstractApplicationContextRunner for details.

Author

Andy Wilkinson

Stephane Nicoll

Phillip Webb

Since

2.0.0

Constructors

WebApplicationContextRunner

constructor()

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

constructor(contextFactory: Supplier<ConfigurableWebApplicationContext>)

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

Functions

prepare

open fun prepare(consumer: ContextConsumer<in A>): SELF

Prepare a new ApplicationContext based on the current state of this loader.

run

open fun run(consumer: ContextConsumer<in A>): SELF

Create and refresh a new ApplicationContext based on the current state of this loader.

with

open fun with(customizer: (SELF) -> SELF): SELF

Apply customization to this runner.

withAllowBeanDefinitionOverriding

open fun withAllowBeanDefinitionOverriding(allowBeanDefinitionOverriding: Boolean): SELF

Specify if bean definition overriding, by registering a definition with the same name as an existing definition, should be allowed.

withAllowCircularReferences

open fun withAllowCircularReferences(allowCircularReferences: Boolean): SELF

Specify if circular references between beans should be allowed.

withBean

open fun <T> withBean(type: Class<T>, constructorArgs: Array<Any>): SELF

open fun <T> withBean(type: Class<T>, supplier: Supplier<T>, customizers: Array<BeanDefinitionCustomizer>): SELF

open fun <T> withBean(name: String, type: Class<T>, constructorArgs: Array<Any>): SELF

open fun <T> withBean(name: String, type: Class<T>, supplier: Supplier<T>, customizers: Array<BeanDefinitionCustomizer>): SELF

withClassLoader

open fun withClassLoader(classLoader: ClassLoader): SELF

Customize the ClassLoader that the ApplicationContext should use for resource loading and bean class loading.

withConfiguration

open fun withConfiguration(configurations: Configurations): SELF

withInitializer

open fun withInitializer(initializer: ApplicationContextInitializer<in C>): SELF

Add an ApplicationContextInitializer to be called when the context is created.

withMockServletContext

open fun withMockServletContext(contextFactory: Supplier<ConfigurableWebApplicationContext>): Supplier<ConfigurableWebApplicationContext>

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

withParent

open fun withParent(parent: ApplicationContext): SELF

Configure the parent of the ApplicationContext.

withPropertyValues

open fun withPropertyValues(pairs: Array<String>): SELF

Add the specified Environment property pairs.

withSystemProperties

open fun withSystemProperties(pairs: Array<String>): SELF

Add the specified System property pairs.

withUserConfiguration

open fun withUserConfiguration(configurationClasses: Array<Class<out Any>>): SELF