Annotation Type DataJpaTest
@Target(TYPE) @Retention(RUNTIME) @Documented @Inherited @BootstrapWith(org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTestContextBootstrapper.class) @ExtendWith(org.springframework.test.context.junit.jupiter.SpringExtension.class) @OverrideAutoConfiguration(enabled=false) @TypeExcludeFilters(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.
Optional Element Summary
Optional Elements Modifier and Type Optional Element 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 SpringEnvironment
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
String[] properties
Properties in form key=value that should be added to the SpringEnvironment
before the test runs.- Returns:
- the properties to add
- Since:
- 2.1.0
- Default:
- {}
showSql
@PropertyMapping("spring.jpa.show-sql") boolean showSql
If SQL output should be logged.- Returns:
- if SQL is logged
- Default:
- true
useDefaultFilters
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
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
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") Class<?>[] excludeAutoConfiguration
Auto-configuration exclusions that should be applied for this test.- Returns:
- auto-configuration exclusions to apply
- Default:
- {}