Move liquibase provider registration to during SpringLiquibase creation and align code standards to match Spring Boot convention.

Signed-off-by: Dylan Miska <[email protected]>

Author: dmiska25

module/spring-boot-liquibase/src/main/java/org/springframework/boot/liquibase/autoconfigure/EnvironmentConfigurationValueProvider.java

@@ -64,12 +64,9 @@ public int getPrecedence() {
 			if (requestedKey == null) {
 				continue;
 			}
-			// Exact pass-through: no rewriting of the Liquibase key
 			String propertyName = PREFIX + requestedKey;
 			String value = this.environment.getProperty(propertyName);
 			if (value != null) {
-				// requestedKey: the key Liquibase asked for
-				// propertyName: the exact Spring Environment property we read
 				return new ProvidedValue(requestedKey, requestedKey, value,
 						"Spring Environment property '" + propertyName + "'", this);
 			}

module/spring-boot-liquibase/src/main/java/org/springframework/boot/liquibase/autoconfigure/LiquibaseAutoConfiguration.java

@@ -19,6 +19,7 @@
 import javax.sql.DataSource;
 
 import liquibase.Liquibase;
+import liquibase.Scope;
 import liquibase.UpdateSummaryEnum;
 import liquibase.UpdateSummaryOutputEnum;
 import liquibase.change.DatabaseChange;
@@ -30,7 +31,6 @@
 import org.springframework.aot.hint.RuntimeHints;
 import org.springframework.aot.hint.RuntimeHintsRegistrar;
 import org.springframework.beans.factory.ObjectProvider;
-import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.AnyNestedCondition;
@@ -103,7 +103,9 @@ PropertiesLiquibaseConnectionDetails liquibaseConnectionDetails(LiquibasePropert
 		@Bean
 		SpringLiquibase liquibase(ObjectProvider<DataSource> dataSource,
 				@LiquibaseDataSource ObjectProvider<DataSource> liquibaseDataSource, LiquibaseProperties properties,
-				ObjectProvider<SpringLiquibaseCustomizer> customizers, LiquibaseConnectionDetails connectionDetails) {
+				ObjectProvider<SpringLiquibaseCustomizer> customizers, LiquibaseConnectionDetails connectionDetails,
+				Environment environment) {
+			registerLiquibaseConfigurationValueProvider(environment);
 			SpringLiquibase liquibase = createSpringLiquibase(liquibaseDataSource.getIfAvailable(),
 					dataSource.getIfUnique(), connectionDetails);
 			liquibase.setChangeLog(properties.getChangeLog());
@@ -155,6 +157,20 @@ private SpringLiquibase createSpringLiquibase(@Nullable DataSource liquibaseData
 			return liquibase;
 		}
 
+		private void registerLiquibaseConfigurationValueProvider(Environment environment) {
+			liquibase.configuration.LiquibaseConfiguration liquibaseConfiguration = Scope.getCurrentScope()
+				.getSingleton(liquibase.configuration.LiquibaseConfiguration.class);
+
+			// Remove any previously registered instance of our provider class
+			liquibaseConfiguration.getProviders()
+				.stream()
+				.filter((provider) -> provider.getClass() == EnvironmentConfigurationValueProvider.class)
+				.toList()
+				.forEach(liquibaseConfiguration::unregisterProvider);
+
+			liquibaseConfiguration.registerProvider(new EnvironmentConfigurationValueProvider(environment));
+		}
+
 		private DataSource getMigrationDataSource(@Nullable DataSource liquibaseDataSource,
 				@Nullable DataSource dataSource, LiquibaseConnectionDetails connectionDetails) {
 			if (liquibaseDataSource != null) {
@@ -190,24 +206,6 @@ private void applyConnectionDetails(LiquibaseConnectionDetails connectionDetails
 
 	}
 
-	@Bean
-	static BeanFactoryPostProcessor liquibaseConfigurationValueProviderRegistrar(Environment environment) {
-
-		return (beanFactory) -> {
-			var liquibaseConfiguration = liquibase.Scope.getCurrentScope()
-				.getSingleton(liquibase.configuration.LiquibaseConfiguration.class);
-
-			// Remove any previously registered instance of our provider class
-			liquibaseConfiguration.getProviders()
-				.stream()
-				.filter((provider) -> provider.getClass() == EnvironmentConfigurationValueProvider.class)
-				.toList()
-				.forEach(liquibaseConfiguration::unregisterProvider);
-
-			liquibaseConfiguration.registerProvider(new EnvironmentConfigurationValueProvider(environment));
-		};
-	}
-
 	@ConditionalOnClass(Customizer.class)
 	@Configuration(proxyBeanMethods = false)
 	static class CustomizerConfiguration {

module/spring-boot-liquibase/src/test/java/org/springframework/boot/liquibase/autoconfigure/EnvironmentConfigurationValueProviderTests.java

@@ -22,6 +22,9 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
+/**
+ * Tests for {@link EnvironmentConfigurationValueProvider}.
+ */
 class EnvironmentConfigurationValueProviderTests {
 
 	@Test