From 433f3d6bc465e7552e696007fb7ad5ee1fb15005 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Henning=20P=C3=B6ttker?= Date: Fri, 9 Jul 2021 01:53:36 +0200 Subject: [PATCH 1/2] Detect AbstractDataSourceInitializers as DB initializers See gh-27215 --- ...nitializerDatabaseInitializerDetector.java | 42 +++++++++++++++++++ .../main/resources/META-INF/spring.factories | 3 +- 2 files changed, 44 insertions(+), 1 deletion(-) create mode 100644 spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jdbc/AbstractDataSourceInitializerDatabaseInitializerDetector.java diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jdbc/AbstractDataSourceInitializerDatabaseInitializerDetector.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jdbc/AbstractDataSourceInitializerDatabaseInitializerDetector.java new file mode 100644 index 000000000000..4174f9d84c86 --- /dev/null +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jdbc/AbstractDataSourceInitializerDatabaseInitializerDetector.java @@ -0,0 +1,42 @@ +/* + * Copyright 2021 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.boot.jdbc; + +import java.util.Collections; +import java.util.Set; + +import org.springframework.boot.sql.init.dependency.AbstractBeansOfTypeDatabaseInitializerDetector; +import org.springframework.boot.sql.init.dependency.DatabaseInitializerDetector; + +/** + * A {@link DatabaseInitializerDetector} for {@link AbstractDataSourceInitializer}. + * + * @author Henning Pöttker + */ +class AbstractDataSourceInitializerDatabaseInitializerDetector extends AbstractBeansOfTypeDatabaseInitializerDetector { + + @Override + protected Set> getDatabaseInitializerBeanTypes() { + return Collections.singleton(AbstractDataSourceInitializer.class); + } + + @Override + public int getOrder() { + return 1; + } + +} diff --git a/spring-boot-project/spring-boot/src/main/resources/META-INF/spring.factories b/spring-boot-project/spring-boot/src/main/resources/META-INF/spring.factories index 45d7d40af230..50a3ce916114 100644 --- a/spring-boot-project/spring-boot/src/main/resources/META-INF/spring.factories +++ b/spring-boot-project/spring-boot/src/main/resources/META-INF/spring.factories @@ -85,7 +85,8 @@ org.springframework.boot.flyway.FlywayDatabaseInitializerDetector,\ org.springframework.boot.jdbc.init.DataSourceScriptDatabaseInitializerDetector,\ org.springframework.boot.liquibase.LiquibaseDatabaseInitializerDetector,\ org.springframework.boot.orm.jpa.JpaDatabaseInitializerDetector,\ -org.springframework.boot.r2dbc.init.R2dbcScriptDatabaseInitializerDetector +org.springframework.boot.r2dbc.init.R2dbcScriptDatabaseInitializerDetector,\ +org.springframework.boot.jdbc.AbstractDataSourceInitializerDatabaseInitializerDetector # Depends On Database Initialization Detectors org.springframework.boot.sql.init.dependency.DependsOnDatabaseInitializationDetector=\ From 94f94f30f531f3c8ceab6c9953b263cc9ced0c7c Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Fri, 9 Jul 2021 11:41:33 +0100 Subject: [PATCH 2/2] Polish "Detect AbstractDataSourceInitializers as DB initializers" See gh-27215 --- ...nitializerDatabaseInitializerDetector.java | 7 +- .../main/resources/META-INF/spring.factories | 4 +- ...itializerDependencyConfigurationTests.java | 84 +++++++++++++++++++ 3 files changed, 87 insertions(+), 8 deletions(-) create mode 100644 spring-boot-project/spring-boot/src/test/java/org/springframework/boot/jdbc/AbstractDataSourceInitializerDependencyConfigurationTests.java diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jdbc/AbstractDataSourceInitializerDatabaseInitializerDetector.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jdbc/AbstractDataSourceInitializerDatabaseInitializerDetector.java index 4174f9d84c86..e9ea33c233c4 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jdbc/AbstractDataSourceInitializerDatabaseInitializerDetector.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jdbc/AbstractDataSourceInitializerDatabaseInitializerDetector.java @@ -1,5 +1,5 @@ /* - * Copyright 2021 the original author or authors. + * Copyright 2012-2021 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -34,9 +34,4 @@ protected Set> getDatabaseInitializerBeanTypes() { return Collections.singleton(AbstractDataSourceInitializer.class); } - @Override - public int getOrder() { - return 1; - } - } diff --git a/spring-boot-project/spring-boot/src/main/resources/META-INF/spring.factories b/spring-boot-project/spring-boot/src/main/resources/META-INF/spring.factories index 50a3ce916114..c688a6996cf2 100644 --- a/spring-boot-project/spring-boot/src/main/resources/META-INF/spring.factories +++ b/spring-boot-project/spring-boot/src/main/resources/META-INF/spring.factories @@ -82,11 +82,11 @@ org.springframework.boot.diagnostics.LoggingFailureAnalysisReporter # Database Initializer Detectors org.springframework.boot.sql.init.dependency.DatabaseInitializerDetector=\ org.springframework.boot.flyway.FlywayDatabaseInitializerDetector,\ +org.springframework.boot.jdbc.AbstractDataSourceInitializerDatabaseInitializerDetector,\ org.springframework.boot.jdbc.init.DataSourceScriptDatabaseInitializerDetector,\ org.springframework.boot.liquibase.LiquibaseDatabaseInitializerDetector,\ org.springframework.boot.orm.jpa.JpaDatabaseInitializerDetector,\ -org.springframework.boot.r2dbc.init.R2dbcScriptDatabaseInitializerDetector,\ -org.springframework.boot.jdbc.AbstractDataSourceInitializerDatabaseInitializerDetector +org.springframework.boot.r2dbc.init.R2dbcScriptDatabaseInitializerDetector # Depends On Database Initialization Detectors org.springframework.boot.sql.init.dependency.DependsOnDatabaseInitializationDetector=\ diff --git a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/jdbc/AbstractDataSourceInitializerDependencyConfigurationTests.java b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/jdbc/AbstractDataSourceInitializerDependencyConfigurationTests.java new file mode 100644 index 000000000000..4a09876af327 --- /dev/null +++ b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/jdbc/AbstractDataSourceInitializerDependencyConfigurationTests.java @@ -0,0 +1,84 @@ +/* + * Copyright 2012-2021 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.boot.jdbc; + +import javax.sql.DataSource; + +import org.junit.jupiter.api.Test; + +import org.springframework.boot.sql.init.dependency.DatabaseInitializationDependencyConfigurer; +import org.springframework.boot.sql.init.dependency.DependsOnDatabaseInitialization; +import org.springframework.context.annotation.AnnotationConfigApplicationContext; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.Import; +import org.springframework.core.io.ResourceLoader; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Tests for the configuration of dependencies on {@link AbstractDataSourceInitializer} + * beans. + * + * @author Andy Wilkinson + */ +class AbstractDataSourceInitializerDependencyConfigurationTests { + + @Test + void beanThatDependsOnDatabaseInitializationDependsOnAbstractDataSourceInitializerBeans() { + try (AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext( + TestConfiguration.class)) { + assertThat(context.getBeanFactory().getBeanDefinition("dependsOnDataSourceInitialization").getDependsOn()) + .contains("initializer"); + } + } + + @Import(DatabaseInitializationDependencyConfigurer.class) + @Configuration(proxyBeanMethods = false) + static class TestConfiguration { + + @Bean + DataSource dataSource() { + return DataSourceBuilder.create().build(); + } + + @Bean + @DependsOnDatabaseInitialization + String dependsOnDataSourceInitialization() { + return "test"; + } + + @Bean + AbstractDataSourceInitializer initializer(DataSource dataSource, ResourceLoader resourceLoader) { + return new AbstractDataSourceInitializer(dataSource, resourceLoader) { + + @Override + protected String getSchemaLocation() { + return null; + } + + @Override + protected DataSourceInitializationMode getMode() { + return DataSourceInitializationMode.NEVER; + } + + }; + } + + } + +}