Add auto-configuration for Spring Data Envers

spring-projects · Dec 16, 2020 · eaa3981 · eaa3981
1 parent f855256
commit eaa3981
Show file tree

Hide file tree

Showing 11 changed files with 386 additions and 152 deletions.
diff --git a/spring-boot-project/spring-boot-autoconfigure/build.gradle b/spring-boot-project/spring-boot-autoconfigure/build.gradle
@@ -113,6 +113,7 @@ dependencies {
 	optional("org.springframework.batch:spring-batch-core")
 	optional("org.springframework.data:spring-data-couchbase")
 	optional("org.springframework.data:spring-data-jpa")
+	optional("org.springframework.data:spring-data-envers")
 	optional("org.springframework.data:spring-data-rest-webmvc")
 	optional("org.springframework.data:spring-data-cassandra")
 	optional("org.springframework.data:spring-data-elasticsearch") {

diff --git a/.../org/springframework/boot/autoconfigure/data/jpa/EnversRevisionRepositoriesRegistrar.java b/.../org/springframework/boot/autoconfigure/data/jpa/EnversRevisionRepositoriesRegistrar.java
@@ -0,0 +1,41 @@
+/*
+ * Copyright 2012-2020 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.autoconfigure.data.jpa;
+
+import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
+import org.springframework.data.envers.repository.support.EnversRevisionRepositoryFactoryBean;
+import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
+
+/**
+ * {@link ImportBeanDefinitionRegistrar} used to auto-configure Spring Data Envers
+ * Repositories.
+ *
+ * @author Stefano Cordio
+ */
+class EnversRevisionRepositoriesRegistrar extends JpaRepositoriesRegistrar {
+
+	@Override
+	protected Class<?> getConfiguration() {
+		return EnableJpaRepositoriesConfiguration.class;
+	}
+
+	@EnableJpaRepositories(repositoryFactoryBeanClass = EnversRevisionRepositoryFactoryBean.class)
+	private static class EnableJpaRepositoriesConfiguration {
+
+	}
+
+}
diff --git a/...ava/org/springframework/boot/autoconfigure/data/jpa/JpaRepositoriesAutoConfiguration.java b/...ava/org/springframework/boot/autoconfigure/data/jpa/JpaRepositoriesAutoConfiguration.java
@@ -26,6 +26,7 @@
 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.ConditionalOnMissingClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.autoconfigure.orm.jpa.EntityManagerFactoryBuilderCustomizer;
 import org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration;
@@ -35,6 +36,7 @@
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
 import org.springframework.core.task.AsyncTaskExecutor;
+import org.springframework.data.envers.repository.support.EnversRevisionRepositoryFactoryBean;
 import org.springframework.data.jpa.repository.JpaRepository;
 import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
 import org.springframework.data.jpa.repository.config.JpaRepositoryConfigExtension;
@@ -52,11 +54,19 @@
  * Once in effect, the auto-configuration is the equivalent of enabling JPA repositories
  * using the {@link EnableJpaRepositories @EnableJpaRepositories} annotation.
  * <p>
+ * In case
+ * {@link org.springframework.data.envers.repository.support.EnversRevisionRepositoryFactoryBean}
+ * is on the classpath, it is used instead of
+ * {@link org.springframework.data.jpa.repository.support.JpaRepositoryFactoryBean} to
+ * support {@link org.springframework.data.repository.history.RevisionRepository} with
+ * Hibernate Envers.
+ * <p>
  * This configuration class will activate <em>after</em> the Hibernate auto-configuration.
  *
  * @author Phillip Webb
  * @author Josh Long
  * @author Scott Frederick
+ * @author Stefano Cordio
  * @since 1.0.0
  * @see EnableJpaRepositories
  */
@@ -66,7 +76,6 @@
 @ConditionalOnMissingBean({ JpaRepositoryFactoryBean.class, JpaRepositoryConfigExtension.class })
 @ConditionalOnProperty(prefix = "spring.data.jpa.repositories", name = "enabled", havingValue = "true",
 		matchIfMissing = true)
-@Import(JpaRepositoriesRegistrar.class)
 @AutoConfigureAfter({ HibernateJpaAutoConfiguration.class, TaskExecutionAutoConfiguration.class })
 public class JpaRepositoriesAutoConfiguration {
 
@@ -108,4 +117,18 @@ static class LazyBootstrapMode {
 
 	}
 
+	@Configuration(proxyBeanMethods = false)
+	@ConditionalOnClass(EnversRevisionRepositoryFactoryBean.class)
+	@Import(EnversRevisionRepositoriesRegistrar.class)
+	public static class EnversRevisionRepositoriesRegistrarConfiguration {
+
+	}
+
+	@Configuration(proxyBeanMethods = false)
+	@ConditionalOnMissingClass("org.springframework.data.envers.repository.support.EnversRevisionRepositoryFactoryBean")
+	@Import(JpaRepositoriesRegistrar.class)
+	public static class JpaRepositoriesRegistrarConfiguration {
+
+	}
+
 }
diff --git a/...gframework/boot/autoconfigure/data/jpa/AbstractJpaRepositoriesAutoConfigurationTests.java b/...gframework/boot/autoconfigure/data/jpa/AbstractJpaRepositoriesAutoConfigurationTests.java
@@ -0,0 +1,187 @@
+/*
+ * Copyright 2012-2020 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.autoconfigure.data.jpa;
+
+import javax.persistence.EntityManagerFactory;
+
+import org.junit.jupiter.api.Test;
+
+import org.springframework.boot.autoconfigure.AutoConfigurations;
+import org.springframework.boot.autoconfigure.TestAutoConfigurationPackage;
+import org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration;
+import org.springframework.boot.autoconfigure.data.alt.jpa.CityJpaRepository;
+import org.springframework.boot.autoconfigure.data.alt.mongo.CityMongoDbRepository;
+import org.springframework.boot.autoconfigure.data.alt.solr.CitySolrRepository;
+import org.springframework.boot.autoconfigure.data.jpa.city.City;
+import org.springframework.boot.autoconfigure.data.jpa.city.CityRepository;
+import org.springframework.boot.autoconfigure.data.jpa.country.Country;
+import org.springframework.boot.autoconfigure.jdbc.EmbeddedDataSourceConfiguration;
+import org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration;
+import org.springframework.boot.autoconfigure.task.TaskExecutionAutoConfiguration;
+import org.springframework.boot.autoconfigure.task.TaskSchedulingAutoConfiguration;
+import org.springframework.boot.test.context.runner.ApplicationContextRunner;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.ComponentScan.Filter;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.FilterType;
+import org.springframework.context.annotation.Import;
+import org.springframework.core.task.SimpleAsyncTaskExecutor;
+import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
+import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean;
+import org.springframework.scheduling.annotation.EnableScheduling;
+import org.springframework.transaction.PlatformTransactionManager;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Base class for {@link JpaRepositoriesAutoConfiguration} tests.
+ *
+ * @author Dave Syer
+ * @author Oliver Gierke
+ * @author Scott Frederick
+ * @author Stefano Cordio
+ */
+abstract class AbstractJpaRepositoriesAutoConfigurationTests {
+
+	final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
+			.withConfiguration(AutoConfigurations.of(HibernateJpaAutoConfiguration.class,
+					JpaRepositoriesAutoConfiguration.class, PropertyPlaceholderAutoConfiguration.class))
+			.withUserConfiguration(EmbeddedDataSourceConfiguration.class);
+
+	@Test
+	void testDefaultRepositoryConfiguration() {
+		this.contextRunner.withUserConfiguration(TestConfiguration.class).run((context) -> {
+			assertThat(context).hasSingleBean(CityRepository.class);
+			assertThat(context).hasSingleBean(PlatformTransactionManager.class);
+			assertThat(context).hasSingleBean(EntityManagerFactory.class);
+			assertThat(context.getBean(LocalContainerEntityManagerFactoryBean.class).getBootstrapExecutor()).isNull();
+		});
+	}
+
+	@Test
+	void testOverrideRepositoryConfiguration() {
+		this.contextRunner.withUserConfiguration(CustomConfiguration.class).run((context) -> {
+			assertThat(context).hasSingleBean(CityJpaRepository.class);
+			assertThat(context).hasSingleBean(PlatformTransactionManager.class);
+			assertThat(context).hasSingleBean(EntityManagerFactory.class);
+		});
+	}
+
+	@Test
+	void autoConfigurationShouldNotKickInEvenIfManualConfigDidNotCreateAnyRepositories() {
+		this.contextRunner.withUserConfiguration(SortOfInvalidCustomConfiguration.class)
+				.run((context) -> assertThat(context).doesNotHaveBean(CityRepository.class));
+	}
+
+	@Test
+	void whenBootstrapModeIsLazyWithMultipleAsyncExecutorBootstrapExecutorIsConfigured() {
+		this.contextRunner.withUserConfiguration(MultipleAsyncTaskExecutorConfiguration.class)
+				.withConfiguration(AutoConfigurations.of(TaskExecutionAutoConfiguration.class,
+						TaskSchedulingAutoConfiguration.class))
+				.withPropertyValues("spring.data.jpa.repositories.bootstrap-mode=lazy")
+				.run((context) -> assertThat(
+						context.getBean(LocalContainerEntityManagerFactoryBean.class).getBootstrapExecutor())
+								.isEqualTo(context.getBean("applicationTaskExecutor")));
+	}
+
+	@Test
+	void whenBootstrapModeIsLazyWithSingleAsyncExecutorBootstrapExecutorIsConfigured() {
+		this.contextRunner.withUserConfiguration(SingleAsyncTaskExecutorConfiguration.class)
+				.withPropertyValues("spring.data.jpa.repositories.bootstrap-mode=lazy")
+				.run((context) -> assertThat(
+						context.getBean(LocalContainerEntityManagerFactoryBean.class).getBootstrapExecutor())
+								.isEqualTo(context.getBean("testAsyncTaskExecutor")));
+	}
+
+	@Test
+	void whenBootstrapModeIsDeferredBootstrapExecutorIsConfigured() {
+		this.contextRunner.withUserConfiguration(MultipleAsyncTaskExecutorConfiguration.class)
+				.withConfiguration(AutoConfigurations.of(TaskExecutionAutoConfiguration.class,
+						TaskSchedulingAutoConfiguration.class))
+				.withPropertyValues("spring.data.jpa.repositories.bootstrap-mode=deferred")
+				.run((context) -> assertThat(
+						context.getBean(LocalContainerEntityManagerFactoryBean.class).getBootstrapExecutor())
+								.isEqualTo(context.getBean("applicationTaskExecutor")));
+	}
+
+	@Test
+	void whenBootstrapModeIsDefaultBootstrapExecutorIsNotConfigured() {
+		this.contextRunner.withUserConfiguration(MultipleAsyncTaskExecutorConfiguration.class)
+				.withConfiguration(AutoConfigurations.of(TaskExecutionAutoConfiguration.class,
+						TaskSchedulingAutoConfiguration.class))
+				.withPropertyValues("spring.data.jpa.repositories.bootstrap-mode=default").run((context) -> assertThat(
+						context.getBean(LocalContainerEntityManagerFactoryBean.class).getBootstrapExecutor()).isNull());
+	}
+
+	@Test
+	void bootstrapModeIsDefaultByDefault() {
+		this.contextRunner.withUserConfiguration(MultipleAsyncTaskExecutorConfiguration.class)
+				.withConfiguration(AutoConfigurations.of(TaskExecutionAutoConfiguration.class,
+						TaskSchedulingAutoConfiguration.class))
+				.run((context) -> assertThat(
+						context.getBean(LocalContainerEntityManagerFactoryBean.class).getBootstrapExecutor()).isNull());
+	}
+
+	@Configuration(proxyBeanMethods = false)
+	@EnableScheduling
+	@Import(TestConfiguration.class)
+	static class MultipleAsyncTaskExecutorConfiguration {
+
+	}
+
+	@Configuration(proxyBeanMethods = false)
+	@Import(TestConfiguration.class)
+	static class SingleAsyncTaskExecutorConfiguration {
+
+		@Bean
+		SimpleAsyncTaskExecutor testAsyncTaskExecutor() {
+			return new SimpleAsyncTaskExecutor();
+		}
+
+	}
+
+	@Configuration(proxyBeanMethods = false)
+	@TestAutoConfigurationPackage(City.class)
+	static class TestConfiguration {
+
+	}
+
+	@Configuration(proxyBeanMethods = false)
+	@EnableJpaRepositories(
+			basePackageClasses = org.springframework.boot.autoconfigure.data.alt.jpa.CityJpaRepository.class,
+			excludeFilters = { @Filter(type = FilterType.ASSIGNABLE_TYPE, value = CityMongoDbRepository.class),
+					@Filter(type = FilterType.ASSIGNABLE_TYPE, value = CitySolrRepository.class) })
+	@TestAutoConfigurationPackage(City.class)
+	static class CustomConfiguration {
+
+	}
+
+	@Configuration(proxyBeanMethods = false)
+	// To not find any repositories
+	@EnableJpaRepositories("foo.bar")
+	@TestAutoConfigurationPackage(City.class)
+	static class SortOfInvalidCustomConfiguration {
+
+	}
+
+	@Configuration(proxyBeanMethods = false)
+	@TestAutoConfigurationPackage(Country.class)
+	static class RevisionRepositoryConfiguration {
+
+	}
+
+}
diff --git a/...amework/boot/autoconfigure/data/jpa/EnversRevisionRepositoriesAutoConfigurationTests.java b/...amework/boot/autoconfigure/data/jpa/EnversRevisionRepositoriesAutoConfigurationTests.java
@@ -0,0 +1,39 @@
+/*
+ * Copyright 2012-2020 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.autoconfigure.data.jpa;
+
+import org.junit.jupiter.api.Test;
+
+import org.springframework.boot.autoconfigure.data.jpa.country.CountryRepository;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link JpaRepositoriesAutoConfiguration} with Spring Data Envers on the
+ * classpath.
+ *
+ * @author Stefano Cordio
+ */
+class EnversRevisionRepositoriesAutoConfigurationTests extends AbstractJpaRepositoriesAutoConfigurationTests {
+
+	@Test
+	void autoConfigurationShouldSucceedWithRevisionRepository() {
+		this.contextRunner.withUserConfiguration(RevisionRepositoryConfiguration.class)
+				.run((context) -> assertThat(context).hasSingleBean(CountryRepository.class));
+	}
+
+}