Skip to content

Auto-configure SpringLiquibase with Liquibase Customizer #40986

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

Auto-configure SpringLiquibase with Liquibase Customizer #40986

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0bf9399
Upgrade to Liquibase 4.28.0
asashour May 29, 2024
3e48a00
Use Liquibase Customizer.
asashour May 30, 2024
fd82970
Format.
asashour Jun 4, 2024
ddd7a78
Set customizer if available.
asashour Jun 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion ...ain/java/org/springframework/boot/autoconfigure/liquibase/LiquibaseAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,11 @@

import javax.sql.DataSource;

import liquibase.Liquibase;
import liquibase.UpdateSummaryEnum;
import liquibase.UpdateSummaryOutputEnum;
import liquibase.change.DatabaseChange;
import liquibase.integration.spring.Customizer;
import liquibase.integration.spring.SpringLiquibase;
import liquibase.ui.UIServiceEnum;

Expand Down Expand Up @@ -66,6 +68,7 @@
* @author Ferenc Gratzer
* @author Evgeniy Cheban
* @author Moritz Halbritter
* @author Ahmed Ashour
* @since 1.1.0
*/
@AutoConfiguration(after = { DataSourceAutoConfiguration.class, HibernateJpaAutoConfiguration.class })
Expand Down Expand Up @@ -97,7 +100,7 @@ PropertiesLiquibaseConnectionDetails liquibaseConnectionDetails(LiquibasePropert
@Bean
public SpringLiquibase liquibase(ObjectProvider<DataSource> dataSource,
@LiquibaseDataSource ObjectProvider<DataSource> liquibaseDataSource, LiquibaseProperties properties,
LiquibaseConnectionDetails connectionDetails) {
ObjectProvider<Customizer<Liquibase>> customizer, LiquibaseConnectionDetails connectionDetails) {
SpringLiquibase liquibase = createSpringLiquibase(liquibaseDataSource.getIfAvailable(),
dataSource.getIfUnique(), connectionDetails);
liquibase.setChangeLog(properties.getChangeLog());
Expand Down Expand Up @@ -125,6 +128,7 @@ public SpringLiquibase liquibase(ObjectProvider<DataSource> dataSource,
if (properties.getUiService() != null) {
liquibase.setUiService(UIServiceEnum.valueOf(properties.getUiService().name()));
}
liquibase.setCustomizer(customizer.getIfAvailable());
return liquibase;
}

Expand Down
21 changes: 21 additions & 0 deletions ...ava/org/springframework/boot/autoconfigure/liquibase/LiquibaseAutoConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,11 @@
import javax.sql.DataSource;

import com.zaxxer.hikari.HikariDataSource;
import liquibase.Liquibase;
import liquibase.UpdateSummaryEnum;
import liquibase.UpdateSummaryOutputEnum;
import liquibase.command.core.helpers.ShowSummaryArgument;
import liquibase.integration.spring.Customizer;
import liquibase.integration.spring.SpringLiquibase;
import liquibase.ui.UIServiceEnum;
import org.junit.jupiter.api.Test;
Expand Down Expand Up @@ -83,6 +85,7 @@
* @author Evgeniy Cheban
* @author Moritz Halbritter
* @author Phillip Webb
* @author Ahmed Ashour
*/
@ExtendWith(OutputCaptureExtension.class)
class LiquibaseAutoConfigurationTests {
Expand Down Expand Up @@ -532,6 +535,14 @@ void shouldRegisterHints() {
assertThat(RuntimeHintsPredicates.resource().forResource("db/changelog/tables/init.sql")).accepts(hints);
}

@Test
void customizer() {
this.contextRunner.withUserConfiguration(EmbeddedDataSourceConfiguration.class, CustomizerConfiguration.class)
.run(assertLiquibase((liquibase) -> {
assertThat(liquibase.getCustomizer()).isNotNull();
}));
}

private ContextConsumer<AssertableApplicationContext> assertLiquibase(Consumer<SpringLiquibase> consumer) {
return (context) -> {
assertThat(context).hasSingleBean(SpringLiquibase.class);
Expand Down Expand Up @@ -668,6 +679,16 @@ public String getPassword() {

}

@Configuration(proxyBeanMethods = false)
static class CustomizerConfiguration {

@Bean
Customizer<Liquibase> customizer() {
return liquibase -> liquibase.setChangeLogParameter("some key", "some value");
}

}

static class CustomH2Driver extends org.h2.Driver {

}
Expand Down
2 changes: 1 addition & 1 deletion spring-boot-project/spring-boot-dependencies/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1054,7 +1054,7 @@ bom {
releaseNotes("https://github.com/lettuce-io/lettuce-core/releases/tag/{version}")
}
}
library("Liquibase", "4.27.0") {
library("Liquibase", "4.28.0") {
group("org.liquibase") {
modules = [
"liquibase-cdi",
Expand Down
Loading