Spring Boot Integration

Dependencies

JUnit

dependencies {
    testImplementation(platform("io.github.seijikohara:db-tester-bom:VERSION"))
    testImplementation("io.github.seijikohara:db-tester-junit-spring-boot-starter")
}

Spock

dependencies {
    testImplementation platform("io.github.seijikohara:db-tester-bom:VERSION")
    testImplementation "io.github.seijikohara:db-tester-spock-spring-boot-starter"
}

Kotest

dependencies {
    testImplementation(platform("io.github.seijikohara:db-tester-bom:VERSION"))
    testImplementation("io.github.seijikohara:db-tester-kotest-spring-boot-starter")
}

Automatic DataSource Discovery

All three starters share the same auto-configuration behavior via db-tester-spring-support:

1. Detect the Spring ApplicationContext
2. Find DataSource beans
3. Resolve the default DataSource using the following priority:
   1. Single DataSource bean (automatic default)
   2. @Primary-annotated DataSource
   3. DataSource bean named "dataSource"
4. Register all beans with DataSourceRegistry

Manual DataSource registration is not required. The starter handles registration automatically.

Extension Registration

JUnit

@SpringBootTest
@ExtendWith(SpringBootDatabaseTestExtension.class)
class UserRepositoryTest {

    @Test
    @DataSet
    @ExpectedDataSet
    void testCreateUser() {
        // DataSource automatically registered from Spring context
    }
}

Spock

@SpringBootTest
@SpringBootDatabaseTest
class UserRepositorySpec extends Specification {

    @DataSet
    @ExpectedDataSet
    def 'should create user'() {
        // DataSource automatically registered from Spring context
    }
}

Kotest

@SpringBootTest
class UserRepositorySpec : AnnotationSpec() {

    init {
        extensions(SpringBootDatabaseTestExtension())
    }

    @Test
    @DataSet
    @ExpectedDataSet
    fun `should create user`() {
        // DataSource automatically registered from Spring context
    }
}

Framework	Registration Method
JUnit	@ExtendWith(SpringBootDatabaseTestExtension.class)
Spock	@SpringBootDatabaseTest (annotation-driven extension)
Kotest	init { extensions(SpringBootDatabaseTestExtension()) }

Multiple DataSources

For multiple data sources, define beans with @Primary and @Qualifier:

@Configuration
class DataSourceConfig {

    @Bean
    @Primary
    DataSource primaryDataSource() { }

    @Bean
    @Qualifier("secondary")
    DataSource secondaryDataSource() { }
}

Reference named data sources in annotations:

@Test
@DataSet(sources = {
    @DataSetSource(dataSourceName = ""),          // Primary (default)
    @DataSetSource(dataSourceName = "secondary")  // Secondary
})
void testMultipleDatabases() { }

Configuration Properties

Configure via application.properties or application.yml. All properties apply to all three starters.

# Enable or disable DB Tester (default: true)
db-tester.enabled=true

# Auto-register DataSource beans (default: true)
db-tester.auto-register-data-sources=true

# Data format (AUTO, CSV, TSV, JSON, or YAML)
db-tester.convention.data-format=AUTO

# Expectation directory suffix
db-tester.convention.expectation-suffix=/expected

# Scenario marker column name
db-tester.convention.scenario-marker=[Scenario]

# Table merge strategy (FIRST, LAST, UNION, UNION_ALL)
db-tester.convention.table-merge-strategy=UNION_ALL

# Default preparation operation
db-tester.operation.preparation=CLEAN_INSERT

# Default expectation operation (typically NONE for verification only)
db-tester.operation.expectation=NONE

Property names use singular form (convention, operation).

Auto-Configuration Classes

Module	Auto-Configuration Class
JUnit Starter	DbTesterJUnitAutoConfiguration
Spock Starter	DbTesterSpockAutoConfiguration
Kotest Starter	DbTesterKotestAutoConfiguration

Related Specifications

• Test Frameworks Overview - Supported frameworks summary
• JUnit - JUnit integration
• Spock - Spock integration
• Kotest - Kotest integration
• Lifecycle - Lifecycle hooks and executor classes
• Configuration - Configuration options