Add support for property spring.test.database.replace

Closes gh-7229

spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/jdbc/AutoConfigureTestDatabase.java

@@ -28,6 +28,7 @@ import javax.sql.DataSource;
 import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
 import org.springframework.boot.autoconfigure.jdbc.EmbeddedDatabaseConnection;
 import org.springframework.boot.test.autoconfigure.properties.PropertyMapping;
+import org.springframework.boot.test.autoconfigure.properties.SkipPropertyMapping;
 
 /**
  * Annotation that can be applied to a test class to configure a test database to use
@@ -48,6 +49,7 @@ public @interface AutoConfigureTestDatabase {
 	 * Determines what type of existing DataSource beans can be replaced.
 	 * @return the type of existing DataSource to replace
 	 */
+	@PropertyMapping(skip = SkipPropertyMapping.ON_DEFAULT_VALUE)
 	Replace replace() default Replace.ANY;
 
 	/**

spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/jdbc/TestDatabaseAutoConfiguration.java

@@ -31,16 +31,22 @@ import org.springframework.beans.factory.support.BeanDefinitionRegistry;
 import org.springframework.beans.factory.support.BeanDefinitionRegistryPostProcessor;
 import org.springframework.beans.factory.support.RootBeanDefinition;
 import org.springframework.boot.autoconfigure.AutoConfigureBefore;
+import org.springframework.boot.autoconfigure.condition.ConditionMessage;
+import org.springframework.boot.autoconfigure.condition.ConditionOutcome;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.autoconfigure.condition.SpringBootCondition;
 import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
 import org.springframework.boot.autoconfigure.jdbc.EmbeddedDatabaseConnection;
+import org.springframework.boot.bind.RelaxedPropertyResolver;
 import org.springframework.context.EnvironmentAware;
 import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.ConditionContext;
+import org.springframework.context.annotation.Conditional;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.core.Ordered;
 import org.springframework.core.annotation.Order;
 import org.springframework.core.env.Environment;
+import org.springframework.core.type.AnnotatedTypeMetadata;
 import org.springframework.jdbc.datasource.embedded.EmbeddedDatabase;
 import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder;
 import org.springframework.util.Assert;
@@ -50,6 +56,7 @@ import org.springframework.util.ObjectUtils;
  * Auto-configuration for a test database.
  *
  * @author Phillip Webb
+ * @author Eddú Meléndez
  * @since 1.4.0
  * @see AutoConfigureTestDatabase
  */
@@ -57,6 +64,9 @@ import org.springframework.util.ObjectUtils;
 @AutoConfigureBefore(DataSourceAutoConfiguration.class)
 public class TestDatabaseAutoConfiguration {
 
+	private static final String SPRING_TEST_DATABASE_PREFIX = "spring.test.database.";
+	private static final String REPLACE_PROPERTY = "replace";
+
 	private final Environment environment;
 
 	TestDatabaseAutoConfiguration(Environment environment) {
@@ -64,18 +74,55 @@ public class TestDatabaseAutoConfiguration {
 	}
 
 	@Bean
-	@ConditionalOnProperty(prefix = "spring.test.database", name = "replace", havingValue = "AUTO_CONFIGURED")
+	@Conditional(TestDatabaseReplaceAutoConfiguredCondition.class)
 	@ConditionalOnMissingBean
 	public DataSource dataSource() {
 		return new EmbeddedDataSourceFactory(this.environment).getEmbeddedDatabase();
 	}
 
 	@Bean
-	@ConditionalOnProperty(prefix = "spring.test.database", name = "replace", havingValue = "ANY", matchIfMissing = true)
+	@Conditional(TestDatabaseReplaceAnyCondition.class)
 	public static EmbeddedDataSourceBeanFactoryPostProcessor embeddedDataSourceBeanFactoryPostProcessor() {
 		return new EmbeddedDataSourceBeanFactoryPostProcessor();
 	}
 
+	static class TestDatabaseReplaceAutoConfiguredCondition extends SpringBootCondition {
+
+		@Override
+		public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata
+				metadata) {
+			RelaxedPropertyResolver resolver = new RelaxedPropertyResolver(context.getEnvironment(), SPRING_TEST_DATABASE_PREFIX);
+			ConditionMessage.Builder message = ConditionMessage
+					.forCondition("Test Database Replace Property");
+			if (resolver.containsProperty(REPLACE_PROPERTY) && "NONE".equals(resolver.getProperty(REPLACE_PROPERTY))) {
+				return ConditionOutcome.noMatch(message.didNotFind("NONE").atAll());
+			}
+			else if (resolver.containsProperty(REPLACE_PROPERTY) && "AUTO_CONFIGURED".equals(resolver.getProperty(REPLACE_PROPERTY))) {
+				return ConditionOutcome.match(message.found("AUTO_CONFIGURED").atAll());
+			}
+			return ConditionOutcome.noMatch(message.didNotFind("spring.test.database.replace").atAll());
+		}
+
+	}
+
+	static class TestDatabaseReplaceAnyCondition extends SpringBootCondition {
+
+		@Override
+		public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) {
+			RelaxedPropertyResolver resolver = new RelaxedPropertyResolver(context.getEnvironment(), SPRING_TEST_DATABASE_PREFIX);
+			ConditionMessage.Builder message = ConditionMessage
+					.forCondition("Test Database Replace Property");
+			if (resolver.containsProperty(REPLACE_PROPERTY) && "NONE".equals(resolver.getProperty(REPLACE_PROPERTY))) {
+				return ConditionOutcome.noMatch(message.didNotFind("NONE").atAll());
+			}
+			else if (!resolver.containsProperty(REPLACE_PROPERTY) || "ANY".equals(resolver.getProperty(REPLACE_PROPERTY))) {
+				return ConditionOutcome.match(message.found("ANY").atAll());
+			}
+			return ConditionOutcome.noMatch(message.didNotFind("spring.test.database.replace").atAll());
+		}
+
+	}
+
 	@Order(Ordered.LOWEST_PRECEDENCE)
 	private static class EmbeddedDataSourceBeanFactoryPostProcessor
 			implements BeanDefinitionRegistryPostProcessor {

spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/jdbc/JdbcTestWithAutoConfigureTestDatabaseReplacePropertyAnyIntegrationTests.java

+/*
+ * Copyright 2012-2016 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
+ *
+ *      http://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.test.autoconfigure.jdbc;
+
+import javax.sql.DataSource;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.boot.autoconfigure.jdbc.EmbeddedDatabaseConnection;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder;
+import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseType;
+import org.springframework.test.context.TestPropertySource;
+import org.springframework.test.context.junit4.SpringRunner;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Integration tests for {@link JdbcTest}.
+ *
+ * @author Phillip Webb
+ * @author Stephane Nicoll
+ */
+@RunWith(SpringRunner.class)
+@JdbcTest
+@AutoConfigureTestDatabase(connection = EmbeddedDatabaseConnection.HSQL)
+@TestPropertySource(properties = "spring.test.database.replace=ANY")
+public class JdbcTestWithAutoConfigureTestDatabaseReplacePropertyAnyIntegrationTests {
+
+	@Autowired
+	private DataSource dataSource;
+
+	@Test
+	public void replacesDefinedDataSourceWithExplicit() throws Exception {
+		// H2 is explicitly defined but HSQL is the override.
+		String product = this.dataSource.getConnection().getMetaData()
+				.getDatabaseProductName();
+		assertThat(product).startsWith("HSQL");
+	}
+
+	@Configuration
+	@EnableAutoConfiguration
+	static class Config {
+
+		@Bean
+		public DataSource dataSource() {
+			EmbeddedDatabaseBuilder builder = new EmbeddedDatabaseBuilder()
+					.generateUniqueName(true)
+					.setType(EmbeddedDatabaseType.H2);
+			return builder.build();
+		}
+
+	}
+
+}

spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/jdbc/JdbcTestWithAutoConfigureTestDatabaseReplacePropertyAutoConfiguredIntegrationTests.java

+/*
+ * Copyright 2012-2016 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
+ *
+ *      http://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.test.autoconfigure.jdbc;
+
+import javax.sql.DataSource;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.boot.autoconfigure.jdbc.EmbeddedDatabaseConnection;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.test.context.TestPropertySource;
+import org.springframework.test.context.junit4.SpringRunner;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Integration tests for {@link JdbcTest}.
+ *
+ * @author Phillip Webb
+ * @author Stephane Nicoll
+ */
+@RunWith(SpringRunner.class)
+@JdbcTest
+@AutoConfigureTestDatabase(connection = EmbeddedDatabaseConnection.HSQL)
+@TestPropertySource(properties = "spring.test.database.replace=AUTO_CONFIGURED")
+public class JdbcTestWithAutoConfigureTestDatabaseReplacePropertyAutoConfiguredIntegrationTests {
+
+	@Autowired
+	private DataSource dataSource;
+
+	@Test
+	public void replacesAutoConfiguredDataSource() throws Exception {
+		String product = this.dataSource.getConnection().getMetaData()
+				.getDatabaseProductName();
+		assertThat(product).startsWith("HSQL");
+	}
+
+	@Configuration
+	@EnableAutoConfiguration // Will auto-configure H2
+	static class Config {
+
+	}
+
+}

spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/jdbc/JdbcTestWithAutoConfigureTestDatabaseReplacePropertyNoneIntegrationTests.java

+/*
+ * Copyright 2012-2016 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
+ *
+ *      http://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.test.autoconfigure.jdbc;
+
+import javax.sql.DataSource;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.test.context.TestPropertySource;
+import org.springframework.test.context.junit4.SpringRunner;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Integration tests for {@link JdbcTest}.
+ *
+ * @author Phillip Webb
+ * @author Stephane Nicoll
+ */
+@RunWith(SpringRunner.class)
+@JdbcTest
+@TestPropertySource(properties = "spring.test.database.replace=NONE")
+public class JdbcTestWithAutoConfigureTestDatabaseReplacePropertyNoneIntegrationTests {
+
+	@Autowired
+	private DataSource dataSource;
+
+	@Test
+	public void usesDefaultEmbeddedDatabase() throws Exception {
+		// HSQL is explicitly defined and should not be replaced
+		String product = this.dataSource.getConnection().getMetaData()
+				.getDatabaseProductName();
+		assertThat(product).startsWith("HSQL");
+	}
+
+}