Polish 'Introduce a shared abstraction for database initialization'

See gh-46213

Author: philwebb

module/spring-boot-batch-jdbc/src/main/java/org/springframework/boot/batch/jdbc/autoconfigure/BatchDataSourceScriptDatabaseInitializer.java

@@ -20,6 +20,7 @@
 
 import org.springframework.boot.jdbc.init.DataSourceScriptDatabaseInitializer;
 import org.springframework.boot.jdbc.init.PropertiesBasedDataSourceScriptDatabaseInitializer;
+import org.springframework.boot.sql.init.DatabaseInitializationSettings;
 
 /**
  * {@link DataSourceScriptDatabaseInitializer} for the Spring Batch database. May be
@@ -44,4 +45,9 @@ public BatchDataSourceScriptDatabaseInitializer(DataSource dataSource, BatchJdbc
 		super(dataSource, properties);
 	}
 
+	@Override
+	protected DatabaseInitializationSettings getSettings() {
+		return super.getSettings();
+	}
+
 }

module/spring-boot-batch-jdbc/src/test/java/org/springframework/boot/batch/jdbc/autoconfigure/BatchDataSourceScriptDatabaseInitializerTests.java

@@ -54,8 +54,8 @@ void getSettingsWithPlatformDoesNotTouchDataSource() {
 		DataSource dataSource = mock(DataSource.class);
 		BatchJdbcProperties properties = new BatchJdbcProperties();
 		properties.setPlatform("test");
-		DatabaseInitializationSettings settings = BatchDataSourceScriptDatabaseInitializer.getSettings(dataSource,
-				properties);
+		DatabaseInitializationSettings settings = new BatchDataSourceScriptDatabaseInitializer(dataSource, properties)
+			.getSettings();
 		assertThat(settings.getSchemaLocations())
 			.containsOnly("classpath:org/springframework/batch/core/schema-test.sql");
 		then(dataSource).shouldHaveNoInteractions();
@@ -74,8 +74,8 @@ void batchSchemaCanBeLocated(DatabaseDriver driver) throws SQLException {
 		given(connection.getMetaData()).willReturn(metadata);
 		String productName = (String) ReflectionTestUtils.getField(driver, "productName");
 		given(metadata.getDatabaseProductName()).willReturn(productName);
-		DatabaseInitializationSettings settings = BatchDataSourceScriptDatabaseInitializer.getSettings(dataSource,
-				properties);
+		DatabaseInitializationSettings settings = new BatchDataSourceScriptDatabaseInitializer(dataSource, properties)
+			.getSettings();
 		List<String> schemaLocations = settings.getSchemaLocations();
 		assertThat(schemaLocations).isNotEmpty()
 			.allSatisfy((location) -> assertThat(resourceLoader.getResource(location).exists()).isTrue());

module/spring-boot-integration/src/main/java/org/springframework/boot/integration/autoconfigure/IntegrationDataSourceScriptDatabaseInitializer.java

@@ -23,6 +23,7 @@
 import org.springframework.boot.jdbc.DatabaseDriver;
 import org.springframework.boot.jdbc.init.DataSourceScriptDatabaseInitializer;
 import org.springframework.boot.jdbc.init.PropertiesBasedDataSourceScriptDatabaseInitializer;
+import org.springframework.boot.sql.init.DatabaseInitializationSettings;
 
 /**
  * {@link DataSourceScriptDatabaseInitializer} for the Spring Integration database. May be
@@ -46,4 +47,9 @@ public IntegrationDataSourceScriptDatabaseInitializer(DataSource dataSource, Int
 		super(dataSource, properties, Map.of(DatabaseDriver.MARIADB, "mysql"));
 	}
 
+	@Override
+	protected DatabaseInitializationSettings getSettings() {
+		return super.getSettings();
+	}
+
 }

module/spring-boot-integration/src/test/java/org/springframework/boot/integration/autoconfigure/IntegrationDataSourceScriptDatabaseInitializerTests.java

@@ -38,8 +38,9 @@ void getSettingsWithPlatformDoesNotTouchDataSource() {
 		DataSource dataSource = mock(DataSource.class);
 		IntegrationJdbcProperties properties = new IntegrationJdbcProperties();
 		properties.setPlatform("test");
-		DatabaseInitializationSettings settings = IntegrationDataSourceScriptDatabaseInitializer.getSettings(dataSource,
-				properties);
+		DatabaseInitializationSettings settings = new IntegrationDataSourceScriptDatabaseInitializer(dataSource,
+				properties)
+			.getSettings();
 		assertThat(settings.getSchemaLocations())
 			.containsOnly("classpath:org/springframework/integration/jdbc/schema-test.sql");
 		then(dataSource).shouldHaveNoInteractions();

module/spring-boot-jdbc/src/main/java/org/springframework/boot/jdbc/init/PropertiesBasedDataSourceScriptDatabaseInitializer.java

@@ -59,20 +59,6 @@ public PropertiesBasedDataSourceScriptDatabaseInitializer(DataSource dataSource,
 		super(dataSource, getSettings(dataSource, properties, driverMappings));
 	}
 
-	/**
-	 * Adapts {@link DatabaseInitializationProperties configuration properties} to
-	 * {@link DatabaseInitializationSettings} replacing any {@literal @@platform@@}
-	 * placeholders.
-	 * @param dataSource the data source
-	 * @param properties the configuration properties
-	 * @param <T> the {@link DatabaseInitializationProperties} type being used
-	 * @return a new {@link DatabaseInitializationSettings} instance
-	 */
-	public static <T extends DatabaseInitializationProperties> DatabaseInitializationSettings getSettings(
-			DataSource dataSource, T properties) {
-		return getSettings(dataSource, properties, Collections.emptyMap());
-	}
-
 	/**
 	 * Adapts {@link DatabaseInitializationProperties configuration properties} to
 	 * {@link DatabaseInitializationSettings} replacing any {@literal @@platform@@}
@@ -83,7 +69,7 @@ public static <T extends DatabaseInitializationProperties> DatabaseInitializatio
 	 * @param <T> the {@link DatabaseInitializationProperties} type being used
 	 * @return a new {@link DatabaseInitializationSettings} instance
 	 */
-	public static <T extends DatabaseInitializationProperties> DatabaseInitializationSettings getSettings(
+	private static <T extends DatabaseInitializationProperties> DatabaseInitializationSettings getSettings(
 			DataSource dataSource, T properties, Map<DatabaseDriver, String> driverMappings) {
 		DatabaseInitializationSettings settings = new DatabaseInitializationSettings();
 		settings.setSchemaLocations(resolveSchemaLocations(dataSource, properties, driverMappings));

module/spring-boot-quartz/src/main/java/org/springframework/boot/quartz/autoconfigure/QuartzDataSourceScriptDatabaseInitializer.java

@@ -26,6 +26,7 @@
 import org.springframework.boot.jdbc.DatabaseDriver;
 import org.springframework.boot.jdbc.init.DataSourceScriptDatabaseInitializer;
 import org.springframework.boot.jdbc.init.PropertiesBasedDataSourceScriptDatabaseInitializer;
+import org.springframework.boot.sql.init.DatabaseInitializationSettings;
 import org.springframework.jdbc.datasource.init.ResourceDatabasePopulator;
 import org.springframework.util.ObjectUtils;
 
@@ -57,6 +58,11 @@ public QuartzDataSourceScriptDatabaseInitializer(DataSource dataSource, QuartzJd
 		this.commentPrefixes = properties.getCommentPrefix();
 	}
 
+	@Override
+	protected DatabaseInitializationSettings getSettings() {
+		return super.getSettings();
+	}
+
 	@Override
 	protected void customize(ResourceDatabasePopulator populator) {
 		if (!ObjectUtils.isEmpty(this.commentPrefixes)) {

module/spring-boot-quartz/src/test/java/org/springframework/boot/quartz/autoconfigure/QuartzDataSourceScriptDatabaseInitializerTests.java

@@ -41,8 +41,8 @@ void getSettingsWithPlatformDoesNotTouchDataSource() {
 		DataSource dataSource = mock(DataSource.class);
 		QuartzJdbcProperties properties = new QuartzJdbcProperties();
 		properties.setPlatform("test");
-		DatabaseInitializationSettings settings = QuartzDataSourceScriptDatabaseInitializer.getSettings(dataSource,
-				properties);
+		DatabaseInitializationSettings settings = new QuartzDataSourceScriptDatabaseInitializer(dataSource, properties)
+			.getSettings();
 		assertThat(settings.getSchemaLocations())
 			.containsOnly("classpath:org/quartz/impl/jdbcjobstore/tables_test.sql");
 		then(dataSource).shouldHaveNoInteractions();

module/spring-boot-session-jdbc/src/main/java/org/springframework/boot/session/jdbc/autoconfigure/JdbcSessionDataSourceScriptDatabaseInitializer.java

@@ -23,6 +23,7 @@
 import org.springframework.boot.jdbc.DatabaseDriver;
 import org.springframework.boot.jdbc.init.DataSourceScriptDatabaseInitializer;
 import org.springframework.boot.jdbc.init.PropertiesBasedDataSourceScriptDatabaseInitializer;
+import org.springframework.boot.sql.init.DatabaseInitializationSettings;
 
 /**
  * {@link DataSourceScriptDatabaseInitializer} for the Spring Session JDBC database. May
@@ -48,4 +49,9 @@ public JdbcSessionDataSourceScriptDatabaseInitializer(DataSource dataSource, Jdb
 		super(dataSource, properties, Map.of(DatabaseDriver.MARIADB, "mysql"));
 	}
 
+	@Override
+	protected DatabaseInitializationSettings getSettings() {
+		return super.getSettings();
+	}
+
 }

module/spring-boot-session-jdbc/src/test/java/org/springframework/boot/session/jdbc/autoconfigure/JdbcSessionDataSourceScriptDatabaseInitializerTests.java

@@ -38,8 +38,9 @@ void getSettingsWithPlatformDoesNotTouchDataSource() {
 		DataSource dataSource = mock(DataSource.class);
 		JdbcSessionProperties properties = new JdbcSessionProperties();
 		properties.setPlatform("test");
-		DatabaseInitializationSettings settings = JdbcSessionDataSourceScriptDatabaseInitializer.getSettings(dataSource,
-				properties);
+		DatabaseInitializationSettings settings = new JdbcSessionDataSourceScriptDatabaseInitializer(dataSource,
+				properties)
+			.getSettings();
 		assertThat(settings.getSchemaLocations())
 			.containsOnly("classpath:org/springframework/session/jdbc/schema-test.sql");
 		then(dataSource).shouldHaveNoInteractions();

module/spring-boot-sql/src/main/java/org/springframework/boot/sql/init/AbstractScriptDatabaseInitializer.java

@@ -59,6 +59,15 @@ protected AbstractScriptDatabaseInitializer(DatabaseInitializationSettings setti
 		this.settings = settings;
 	}
 
+	/**
+	 * Return the {@link DatabaseInitializationSettings} being used by the initializer.
+	 * @return the settings being used
+	 * @since 4.0.0
+	 */
+	protected DatabaseInitializationSettings getSettings() {
+		return this.settings;
+	}
+
 	@Override
 	public void setResourceLoader(ResourceLoader resourceLoader) {
 		this.resourceLoader = resourceLoader;