Polish "Auto-configure Flyway and Liquibase when there's a URL but no DataSource"

See gh-16850

Author: wilkinsona

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayAutoConfiguration.java

@@ -36,11 +36,13 @@
 import org.springframework.beans.factory.ObjectProvider;
 import org.springframework.boot.autoconfigure.AutoConfigureAfter;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.boot.autoconfigure.condition.AnyNestedCondition;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.autoconfigure.data.jpa.EntityManagerFactoryDependsOnPostProcessor;
+import org.springframework.boot.autoconfigure.flyway.FlywayAutoConfiguration.FlywayDataSourceCondition;
 import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
 import org.springframework.boot.autoconfigure.jdbc.DataSourceProperties;
 import org.springframework.boot.autoconfigure.jdbc.JdbcOperationsDependsOnPostProcessor;
@@ -52,6 +54,7 @@
 import org.springframework.boot.context.properties.PropertyMapper;
 import org.springframework.boot.jdbc.DatabaseDriver;
 import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Conditional;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.core.convert.TypeDescriptor;
 import org.springframework.core.convert.converter.GenericConverter;
@@ -82,8 +85,8 @@
 @SuppressWarnings("deprecation")
 @Configuration(proxyBeanMethods = false)
 @ConditionalOnClass(Flyway.class)
-@ConditionalOnProperty(prefix = FlywayProperties.PROPERTIES_PREFIX, name = "enabled",
-		matchIfMissing = true)
+@Conditional(FlywayDataSourceCondition.class)
+@ConditionalOnProperty(prefix = "spring.flyway", name = "enabled", matchIfMissing = true)
 @AutoConfigureAfter({ DataSourceAutoConfiguration.class,
 		JdbcTemplateAutoConfiguration.class, HibernateJpaAutoConfiguration.class })
 public class FlywayAutoConfiguration {
@@ -152,11 +155,8 @@ private DataSource configureDataSource(FluentConfiguration configuration,
 			else if (flywayDataSource != null) {
 				configuration.dataSource(flywayDataSource);
 			}
-			else if (dataSource != null) {
-				configuration.dataSource(dataSource);
-			}
 			else {
-				throw new FlywayDataSourceMissingException();
+				configuration.dataSource(dataSource);
 			}
 			return configuration.getDataSource();
 		}
@@ -465,4 +465,23 @@ public Object convert(Object source, TypeDescriptor sourceType,
 
 	}
 
+	static final class FlywayDataSourceCondition extends AnyNestedCondition {
+
+		FlywayDataSourceCondition() {
+			super(ConfigurationPhase.REGISTER_BEAN);
+		}
+
+		@ConditionalOnBean(DataSource.class)
+		private static final class DataSourceBeanCondition {
+
+		}
+
+		@ConditionalOnProperty(prefix = "spring.flyway", name = "url",
+				matchIfMissing = false)
+		private static final class FlywayUrlCondition {
+
+		}
+
+	}
+
 }

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayDataSourceMissingException.java

@@ -35,11 +35,9 @@
  * @author Stephane Nicoll
  * @since 1.1.0
  */
-@ConfigurationProperties(prefix = FlywayProperties.PROPERTIES_PREFIX)
+@ConfigurationProperties(prefix = "spring.flyway")
 public class FlywayProperties {
 
-	public static final String PROPERTIES_PREFIX = "spring.flyway";
-
 	/**
 	 * Whether to enable flyway.
 	 */

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayDataSourceMissingFailureAnalyzer.java

@@ -28,6 +28,7 @@
 import org.springframework.beans.factory.ObjectProvider;
 import org.springframework.boot.autoconfigure.AutoConfigureAfter;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.boot.autoconfigure.condition.AnyNestedCondition;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
@@ -37,10 +38,12 @@
 import org.springframework.boot.autoconfigure.jdbc.DataSourceProperties;
 import org.springframework.boot.autoconfigure.jdbc.JdbcOperationsDependsOnPostProcessor;
 import org.springframework.boot.autoconfigure.jdbc.NamedParameterJdbcOperationsDependsOnPostProcessor;
+import org.springframework.boot.autoconfigure.liquibase.LiquibaseAutoConfiguration.LiquibaseDataSourceCondition;
 import org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.boot.jdbc.DataSourceBuilder;
 import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Conditional;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
 import org.springframework.core.io.Resource;
@@ -65,8 +68,9 @@
  */
 @Configuration(proxyBeanMethods = false)
 @ConditionalOnClass({ SpringLiquibase.class, DatabaseChange.class })
-@ConditionalOnProperty(prefix = LiquibaseProperties.PROPERTIES_PREFIX, name = "enabled",
+@ConditionalOnProperty(prefix = "spring.liquibase", name = "enabled",
 		matchIfMissing = true)
+@Conditional(LiquibaseDataSourceCondition.class)
 @AutoConfigureAfter({ DataSourceAutoConfiguration.class,
 		HibernateJpaAutoConfiguration.class })
 public class LiquibaseAutoConfiguration {
@@ -140,20 +144,17 @@ private SpringLiquibase createSpringLiquibase(DataSource liquibaseDatasource,
 				liquibase.setDataSource(liquibaseDataSource);
 				return liquibase;
 			}
-			else if (this.properties.isCreateDataSource()) {
-				SpringLiquibase liquibase = new DataSourceClosingSpringLiquibase();
-				liquibase.setDataSource(createNewDataSource(dataSourceProperties));
-				return liquibase;
-			}
-			throw new LiquibaseDataSourceMissingException();
+			SpringLiquibase liquibase = new DataSourceClosingSpringLiquibase();
+			liquibase.setDataSource(createNewDataSource(dataSourceProperties));
+			return liquibase;
 		}
 
 		private DataSource getDataSource(DataSource liquibaseDataSource,
 				DataSource dataSource) {
 			if (liquibaseDataSource != null) {
 				return liquibaseDataSource;
 			}
-			if (!this.properties.isCreateDataSource()) {
+			if (this.properties.getUrl() == null && this.properties.getUser() == null) {
 				return dataSource;
 			}
 			return null;
@@ -227,4 +228,23 @@ public LiquibaseNamedParameterJdbcOperationsDependencyConfiguration() {
 
 	}
 
+	static final class LiquibaseDataSourceCondition extends AnyNestedCondition {
+
+		LiquibaseDataSourceCondition() {
+			super(ConfigurationPhase.REGISTER_BEAN);
+		}
+
+		@ConditionalOnBean(DataSource.class)
+		private static final class DataSourceBeanCondition {
+
+		}
+
+		@ConditionalOnProperty(prefix = "spring.liquibase", name = "url",
+				matchIfMissing = false)
+		private static final class LiquibaseUrlCondition {
+
+		}
+
+	}
+
 }

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayProperties.java

@@ -30,12 +30,9 @@
  * @author Marcel Overdijk
  * @since 1.1.0
  */
-@ConfigurationProperties(prefix = LiquibaseProperties.PROPERTIES_PREFIX,
-		ignoreUnknownFields = false)
+@ConfigurationProperties(prefix = "spring.liquibase", ignoreUnknownFields = false)
 public class LiquibaseProperties {
 
-	public static final String PROPERTIES_PREFIX = "spring.liquibase";
-
 	/**
 	 * Change log configuration path.
 	 */
@@ -219,10 +216,6 @@ public void setPassword(String password) {
 		this.password = password;
 	}
 
-	public boolean isCreateDataSource() {
-		return this.url != null || this.user != null;
-	}
-
 	public String getUrl() {
 		return this.url;
 	}

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

@@ -146,8 +146,6 @@ org.springframework.boot.autoconfigure.webservices.client.WebServiceTemplateAuto
 org.springframework.boot.diagnostics.FailureAnalyzer=\
 org.springframework.boot.autoconfigure.diagnostics.analyzer.NoSuchBeanDefinitionFailureAnalyzer,\
 org.springframework.boot.autoconfigure.flyway.FlywayMigrationScriptMissingFailureAnalyzer,\
-org.springframework.boot.autoconfigure.flyway.FlywayDataSourceMissingFailureAnalyzer,\
-org.springframework.boot.autoconfigure.liquibase.LiquibaseDataSourceMissingFailureAnalyzer,\
 org.springframework.boot.autoconfigure.jdbc.DataSourceBeanCreationFailureAnalyzer,\
 org.springframework.boot.autoconfigure.jdbc.HikariDriverConfigurationFailureAnalyzer,\
 org.springframework.boot.autoconfigure.session.NonUniqueSessionRepositoryFailureAnalyzer

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/liquibase/LiquibaseDataSourceMissingException.java

@@ -79,19 +79,13 @@ public class FlywayAutoConfigurationTests {
 			.withPropertyValues("spring.datasource.generate-unique-name=true");
 
 	@Test
-	public void noDataSource() {
-		this.contextRunner.run((context) -> {
-			assertThat(context).hasFailed();
-			assertThat(context).getFailure().isInstanceOf(BeanCreationException.class);
-			assertThat(context).getFailure()
-					.hasRootCauseInstanceOf(FlywayDataSourceMissingException.class);
-			assertThat(context).getFailure()
-					.hasMessageContaining("Flyway is present in classpath and enabled");
-		});
+	public void backsOffWithNoDataSourceBeanAndNoFlywayUrl() {
+		this.contextRunner
+				.run((context) -> assertThat(context).doesNotHaveBean(Flyway.class));
 	}
 
 	@Test
-	public void noDataSourceCreateOneWithUrl() {
+	public void createsDataSourceWithNoDataSourceBeanAndFlywayUrl() {
 		this.contextRunner
 				.withPropertyValues(
 						"spring.flyway.url:jdbc:hsqldb:mem:" + UUID.randomUUID())