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

Annotation Type DataJpaTest

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

Annotation that can be used in combination with @RunWith(SpringRunner.class) for a typical JPA test. Can be used when a test 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 will 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.

Author:

Phillip Webb

See Also:

AutoConfigureDataJpa, AutoConfigureTestDatabase, AutoConfigureTestEntityManager, 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.
ComponentScan.Filter[]	excludeFilters A set of exclude filters which can be used to filter beans that would otherwise be added to the application context.
ComponentScan.Filter[]	includeFilters A set of include filters which can be used to add otherwise filtered beans to the application context.
boolean	showSql If SQL output should be logged.
boolean	useDefaultFilters Determines if default filtering should be used with @SpringBootApplication.

Element Detail

showSql

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

If SQL output should be logged.

Returns:

if SQL is logged

Default:

true

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 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 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:

{}