org.springframework.boot.test.context

Annotation Type SpringBootTest

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
 @Inherited
 @BootstrapWith(value=SpringBootTestContextBootstrapper.class)
 @ExtendWith(value=org.springframework.test.context.junit.jupiter.SpringExtension.class)
public @interface SpringBootTest

Annotation that can be specified on a test class that runs Spring Boot based tests. Provides the following features over and above the regular Spring TestContext Framework:

• Uses SpringBootContextLoader as the default ContextLoader when no specific @ContextConfiguration(loader=...) is defined.
• Automatically searches for a @SpringBootConfiguration when nested @Configuration is not used, and no explicit classes are specified.
• Allows custom Environment properties to be defined using the properties attribute.
• Allows application arguments to be defined using the args attribute.
• Provides support for different webEnvironment modes, including the ability to start a fully running web server listening on a defined or random port.
• Registers a TestRestTemplate and/or WebTestClient bean for use in web tests that are using a fully running web server.

Since:

1.4.0

Author:

Phillip Webb, Andy Wilkinson

See Also:

ContextConfiguration

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	args Application arguments that should be passed to the application under test.
Class<?>[]	classes The annotated classes to use for loading an ApplicationContext.
String[]	properties Properties in form key=value that should be added to the Spring Environment before the test runs.
String[]	value Alias for properties().
SpringBootTest.WebEnvironment	webEnvironment The type of web environment to create when applicable.

Element Detail

value

@AliasFor(value="properties")
public abstract String[] value

Alias for properties().

Returns:

the properties to apply

Default:

{}

properties

@AliasFor(value="value")
public abstract String[] properties

Properties in form key=value that should be added to the Spring Environment before the test runs.

Returns:

the properties to add

Default:

{}

args

public abstract String[] args

Application arguments that should be passed to the application under test.

Returns:

the application arguments to pass to the application under test.

See Also:

ApplicationArguments, SpringApplication.run(String...)

Default:

{}

classes

public abstract Class<?>[] classes

The annotated classes to use for loading an ApplicationContext. Can also be specified using @ContextConfiguration(classes=...). If no explicit classes are defined the test will look for nested @Configuration classes, before falling back to a SpringBootConfiguration search.

Returns:

the annotated classes used to load the application context

See Also:

ContextConfiguration.classes()

Default:

{}

webEnvironment

public abstract SpringBootTest.WebEnvironment webEnvironment

The type of web environment to create when applicable. Defaults to SpringBootTest.WebEnvironment.MOCK.

Returns:

the type of web environment

Default:

org.springframework.boot.test.context.SpringBootTest.WebEnvironment.MOCK