org.springframework.boot.test.autoconfigure.orm.jpa

Annotation Type DataJpaTest

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
 @Inherited
 @BootstrapWith(value=org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTestContextBootstrapper.class)
 @ExtendWith(value=org.springframework.test.context.junit.jupiter.SpringExtension.class)
 @OverrideAutoConfiguration(enabled=false)
 @TypeExcludeFilters(value=DataJpaTypeExcludeFilter.class)
 @Transactional
 @AutoConfigureCache
 @AutoConfigureDataJpa
 @AutoConfigureTestDatabase
 @AutoConfigureTestEntityManager
 @ImportAutoConfiguration
public @interface DataJpaTest

Annotation for a JPA test that focuses only on JPA components.

Using this annotation will disable full auto-configuration and instead apply only configuration relevant to JPA tests.

By default, tests annotated with @DataJpaTest are transactional and roll back at the end of each test. They also use an embedded in-memory database (replacing any explicit or usually auto-configured DataSource). The @AutoConfigureTestDatabase annotation can be used to override these settings.

If you are looking to load your full application configuration, but use an embedded database, you should consider @SpringBootTest combined with @AutoConfigureTestDatabase rather than this annotation.

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

Since:

1.4.0

See Also:

AutoConfigureDataJpa, AutoConfigureTestDatabase, AutoConfigureTestEntityManager, AutoConfigureCache

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
org.springframework.data.repository.config.BootstrapMode	bootstrapMode The BootstrapMode for the test repository support.
java.lang.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.
java.lang.String[]	properties Properties in form key=value that should be added to the Spring Environment before the test runs.
boolean	showSql If SQL output should be logged.
boolean	useDefaultFilters Determines if default filtering should be used with @SpringBootApplication.

Element Detail

properties

public abstract java.lang.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:

{}

showSql

@PropertyMapping(value="spring.jpa.show-sql")
public abstract boolean showSql

If SQL output should be logged.

Returns:

if SQL is logged

Default:

true

bootstrapMode

@PropertyMapping(value="spring.data.jpa.repositories.bootstrap-mode")
public abstract org.springframework.data.repository.config.BootstrapMode bootstrapMode

The BootstrapMode for the test repository support. Defaults to BootstrapMode.DEFAULT.

Returns:

the BootstrapMode to use for testing the repository

Default:

org.springframework.data.repository.config.BootstrapMode.DEFAULT

useDefaultFilters

public abstract boolean useDefaultFilters

Determines if default filtering should be used with @SpringBootApplication. By default no 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=org.springframework.boot.autoconfigure.ImportAutoConfiguration.class,
          attribute="exclude")
public abstract java.lang.Class<?>[] excludeAutoConfiguration

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

Returns:

auto-configuration exclusions to apply

Default:

{}