org.springframework.boot.test.autoconfigure.json

Annotation Type JsonTest

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
 @Inherited
 @BootstrapWith(value=org.springframework.boot.test.autoconfigure.json.JsonTestContextBootstrapper.class)
 @ExtendWith(value=org.springframework.test.context.junit.jupiter.SpringExtension.class)
 @OverrideAutoConfiguration(enabled=false)
 @TypeExcludeFilters(value=org.springframework.boot.test.autoconfigure.json.JsonExcludeFilter.class)
 @AutoConfigureCache
 @AutoConfigureJson
 @AutoConfigureJsonTesters
 @ImportAutoConfiguration
public @interface JsonTest

Annotation for a JSON test that focuses only on JSON serialization.

Using this annotation will disable full auto-configuration and instead apply only configuration relevant to JSON tests (i.e. @JsonComponent, Jackson Module)

By default, tests annotated with JsonTest will also initialize JacksonTester, JsonbTester and GsonTester fields. More fine-grained control can be provided via the @AutoConfigureJsonTesters annotation.

When using JUnit 4, this annotation should be used in combination with @RunWith(SpringRunner.class).

Since:

1.4.0

Author:

Phillip Webb, Artsiom Yudovin

See Also:

AutoConfigureJson, AutoConfigureJsonTesters, AutoConfigureCache

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>[]	excludeAutoConfiguration Auto-configuration exclusions that should be applied for this test.
org.springframework.context.annotation.ComponentScan.Filter[]	excludeFilters A set of exclude filters which can be used to filter beans that would otherwise be added to the application context.
org.springframework.context.annotation.ComponentScan.Filter[]	includeFilters A set of include filters which can be used to add otherwise filtered beans to the application context.
String[]	properties Properties in form key=value that should be added to the Spring Environment before the test runs.
boolean	useDefaultFilters Determines if default filtering should be used with @SpringBootApplication.

Element Detail

properties

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

Since:

2.1.0

Default:

{}

useDefaultFilters

public abstract boolean useDefaultFilters

Determines if default filtering should be used with @SpringBootApplication. By default only @JsonComponent and Module beans are included.

Returns:

if default filters should be used

See Also:

includeFilters(), excludeFilters()

Default:

true

includeFilters

public abstract org.springframework.context.annotation.ComponentScan.Filter[] includeFilters

A set of include filters which can be used to add otherwise filtered beans to the application context.

Returns:

include filters to apply

Default:

{}

excludeFilters

public abstract org.springframework.context.annotation.ComponentScan.Filter[] excludeFilters

A set of exclude filters which can be used to filter beans that would otherwise be added to the application context.

Returns:

exclude filters to apply

Default:

{}

excludeAutoConfiguration

@AliasFor(annotation=ImportAutoConfiguration.class,
          attribute="exclude")
public abstract Class<?>[] excludeAutoConfiguration

Auto-configuration exclusions that should be applied for this test.

Returns:

auto-configuration exclusions to apply

Default:

{}