spring-boot-test/org.springframework.boot.test.context.assertj/ApplicationContextAssertProvider

ApplicationContextAssertProvider

interface ApplicationContextAssertProvider<C : ApplicationContext?> : ApplicationContext, AssertProvider<A> , Closeable

An ApplicationContext that additionally supports AssertJ style assertions. Can be used to decorate an existing application context or an application context that failed to start.

Assertions can be applied using the standard AssertJ assertThat(...) style (see ApplicationContextAssert for a complete list). For example:

assertThat(applicationContext).hasSingleBean(MyBean.class);

If the original ApplicationContext is needed for any reason the getSourceApplicationContext method can be used.

Any ApplicationContext method called on a context that has failed to start will throw an IllegalStateException.

Author

Phillip Webb

Since

2.0.0

Parameters

<C>

the application context type

Inheritors

AssertableReactiveWebApplicationContext

AssertableApplicationContext

AssertableWebApplicationContext

Properties

CLASSPATH_ALL_URL_PREFIX

val CLASSPATH_ALL_URL_PREFIX: String = "classpath*:"

CLASSPATH_URL_PREFIX

val CLASSPATH_URL_PREFIX: String = "classpath:"

FACTORY_BEAN_PREFIX

val FACTORY_BEAN_PREFIX: String = "&"

Functions

assertThat

abstract fun ~~assertThat~~(): ApplicationContextAssert<C>

Return an assert for AspectJ.

abstract fun close()

containsBean

abstract fun containsBean(name: String): Boolean

containsBeanDefinition

abstract fun containsBeanDefinition(beanName: String): Boolean

containsLocalBean

abstract fun containsLocalBean(name: String): Boolean

findAllAnnotationsOnBean

abstract fun <A : Annotation?> findAllAnnotationsOnBean(beanName: String, annotationType: Class<A>, allowFactoryBeanInit: Boolean): Set<A>

findAnnotationOnBean

abstract fun <A : Annotation?> findAnnotationOnBean(beanName: String, annotationType: Class<A>): A

get

open fun <T : ApplicationContextAssertProvider<C>?, C : ApplicationContext?> get(type: Class<T>, contextType: Class<out C>, contextSupplier: Supplier<out C>): T

open fun <T : ApplicationContextAssertProvider<C>?, C : ApplicationContext?> get(type: Class<T>, contextType: Class<out C>, contextSupplier: Supplier<out C>, additionalContextInterfaces: Array<Class<out Any>>): T

Factory method to create a new ApplicationContextAssertProvider instance.

getAliases

abstract fun getAliases(name: String): Array<String>

getApplicationName

abstract fun getApplicationName(): String

getAutowireCapableBeanFactory

abstract fun getAutowireCapableBeanFactory(): AutowireCapableBeanFactory

getBean

abstract fun getBean(name: String): Any

abstract fun <T> getBean(name: String, requiredType: Class<T>): T

getBeanDefinitionCount

abstract fun getBeanDefinitionCount(): Int

getBeanDefinitionNames

abstract fun getBeanDefinitionNames(): Array<String>

getBeanNamesForAnnotation

abstract fun getBeanNamesForAnnotation(annotationType: Class<out Annotation>): Array<String>

getBeanNamesForType

abstract fun getBeanNamesForType(type: ResolvableType): Array<String>

getBeanProvider

abstract fun <T> getBeanProvider(requiredType: Class<T>, allowEagerInit: Boolean): ObjectProvider<T>

getBeansOfType

abstract fun <T> getBeansOfType(type: Class<T>): Map<String, T>

getBeansWithAnnotation

abstract fun getBeansWithAnnotation(annotationType: Class<out Annotation>): Map<String, Any>

getClassLoader

abstract fun getClassLoader(): ClassLoader

getDisplayName

abstract fun getDisplayName(): String

getEnvironment

abstract fun getEnvironment(): Environment

getId

abstract fun getId(): String

getMessage

abstract fun getMessage(code: String, args: Array<Any>, defaultMessage: String, locale: Locale): String

getParent

abstract fun getParent(): ApplicationContext

getParentBeanFactory

abstract fun getParentBeanFactory(): BeanFactory

getResource

abstract fun getResource(location: String): Resource

getResources

abstract fun getResources(locationPattern: String): Array<Resource>

getSourceApplicationContext

abstract fun getSourceApplicationContext(): C

Return the original source ApplicationContext.

abstract fun <T : C?> getSourceApplicationContext(requiredType: Class<T>): T

Return the original source ApplicationContext, casting it to the requested type.

getStartupDate

abstract fun getStartupDate(): Long

getStartupFailure

abstract fun getStartupFailure(): Throwable

Return the failure that caused application context to fail or null if the context started without issue.

getType

abstract fun getType(name: String): Class<out Any>

isPrototype

abstract fun isPrototype(name: String): Boolean

isSingleton

abstract fun isSingleton(name: String): Boolean

isTypeMatch

abstract fun isTypeMatch(name: String, typeToMatch: ResolvableType): Boolean

publishEvent

open fun publishEvent(event: ApplicationEvent)