Fix WSDL locations condition to work with a list

See gh-14285
spring-projects · Sep 3, 2018 · 80358f7 · 80358f7
1 parent 6078865
commit 80358f7
Show file tree

Hide file tree

Showing 6 changed files with 203 additions and 28 deletions.
diff --git a/...src/main/java/org/springframework/boot/autoconfigure/condition/AbstractListCondition.java b/...src/main/java/org/springframework/boot/autoconfigure/condition/AbstractListCondition.java
@@ -0,0 +1,57 @@
+/*
+ * Copyright 2012-2018 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.autoconfigure.condition;
+
+import java.util.List;
+
+import org.springframework.boot.context.properties.bind.BindResult;
+import org.springframework.boot.context.properties.bind.Bindable;
+import org.springframework.boot.context.properties.bind.Binder;
+import org.springframework.context.annotation.ConditionContext;
+import org.springframework.core.type.AnnotatedTypeMetadata;
+
+/**
+ * Abstract base class for list conditions.
+ *
+ * @author Eneias Silva
+ *
+ */
+public abstract class AbstractListCondition extends SpringBootCondition {
+
+	private static final Bindable<List<String>> STRING_LIST = Bindable
+			.listOf(String.class);
+
+	@Override
+	public ConditionOutcome getMatchOutcome(ConditionContext context,
+			AnnotatedTypeMetadata metadata) {
+		BindResult<?> property = Binder.get(context.getEnvironment())
+				.bind(getPropertyName(), STRING_LIST);
+		if (property.isBound()) {
+			return ConditionOutcome.match(ConditionMessage.forCondition(getClassName())
+					.found("property").items(getPropertyName()));
+		}
+		return ConditionOutcome.noMatch(ConditionMessage.forCondition(getClassName())
+				.didNotFind("property").items(getPropertyName()));
+	}
+
+
+	protected abstract String getPropertyName();
+
+
+	protected abstract String getClassName();
+
+}
diff --git a/...main/java/org/springframework/boot/autoconfigure/couchbase/OnBootstrapHostsCondition.java b/...main/java/org/springframework/boot/autoconfigure/couchbase/OnBootstrapHostsCondition.java
@@ -16,42 +16,25 @@
 
 package org.springframework.boot.autoconfigure.couchbase;
 
-import java.util.List;
-
-import org.springframework.boot.autoconfigure.condition.ConditionMessage;
-import org.springframework.boot.autoconfigure.condition.ConditionOutcome;
-import org.springframework.boot.autoconfigure.condition.SpringBootCondition;
-import org.springframework.boot.context.properties.bind.BindResult;
-import org.springframework.boot.context.properties.bind.Bindable;
-import org.springframework.boot.context.properties.bind.Binder;
-import org.springframework.context.annotation.ConditionContext;
-import org.springframework.core.type.AnnotatedTypeMetadata;
+import org.springframework.boot.autoconfigure.condition.AbstractListCondition;
 
 /**
  * Condition to determine if {@code spring.couchbase.bootstrap-hosts} is specified.
  *
  * @author Stephane Nicoll
  * @author Madhura Bhave
+ * @author Eneias Silva
  */
-class OnBootstrapHostsCondition extends SpringBootCondition {
+class OnBootstrapHostsCondition extends AbstractListCondition {
 
-	private static final Bindable<List<String>> STRING_LIST = Bindable
-			.listOf(String.class);
+	@Override
+	protected String getPropertyName() {
+		return "spring.couchbase.bootstrap-hosts";
+	}
 
 	@Override
-	public ConditionOutcome getMatchOutcome(ConditionContext context,
-			AnnotatedTypeMetadata metadata) {
-		String name = "spring.couchbase.bootstrap-hosts";
-		BindResult<?> property = Binder.get(context.getEnvironment()).bind(name,
-				STRING_LIST);
-		if (property.isBound()) {
-			return ConditionOutcome.match(ConditionMessage
-					.forCondition(OnBootstrapHostsCondition.class.getName())
-					.found("property").items(name));
-		}
-		return ConditionOutcome.noMatch(
-				ConditionMessage.forCondition(OnBootstrapHostsCondition.class.getName())
-						.didNotFind("property").items(name));
+	protected String getClassName() {
+		return OnBootstrapHostsCondition.class.getName();
 	}
 
 }
diff --git a/...ain/java/org/springframework/boot/autoconfigure/webservices/OnWsdlLocationsCondition.java b/...ain/java/org/springframework/boot/autoconfigure/webservices/OnWsdlLocationsCondition.java
@@ -0,0 +1,38 @@
+/*
+ * Copyright 2012-2017 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.autoconfigure.webservices;
+
+import org.springframework.boot.autoconfigure.condition.AbstractListCondition;
+
+/**
+ * Condition to determine if {@code spring.webservices.wsdl-locations} is specified.
+ *
+ * @author Eneias Silva
+ */
+class OnWsdlLocationsCondition extends AbstractListCondition {
+
+	@Override
+	protected String getPropertyName() {
+		return "spring.webservices.wsdl-locations";
+	}
+
+	@Override
+	protected String getClassName() {
+		return OnWsdlLocationsCondition.class.getName();
+	}
+
+}
diff --git a/...java/org/springframework/boot/autoconfigure/webservices/WebServicesAutoConfiguration.java b/...java/org/springframework/boot/autoconfigure/webservices/WebServicesAutoConfiguration.java
@@ -30,7 +30,6 @@
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 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.condition.ConditionalOnWebApplication;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication.Type;
 import org.springframework.boot.autoconfigure.web.servlet.ServletWebServerFactoryAutoConfiguration;
@@ -41,6 +40,7 @@
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.ApplicationContextAware;
 import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Conditional;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.core.io.Resource;
 import org.springframework.util.StringUtils;
@@ -55,6 +55,7 @@
  *
  * @author Vedran Pavic
  * @author Stephane Nicoll
+ * @author Eneias Silva
  * @since 1.4.0
  */
 @Configuration
@@ -87,7 +88,7 @@ public ServletRegistrationBean<MessageDispatcherServlet> messageDispatcherServle
 	}
 
 	@Bean
-	@ConditionalOnProperty(prefix = "spring.webservices", name = "wsdl-locations")
+	@Conditional(OnWsdlLocationsCondition.class)
 	public static WsdlDefinitionBeanFactoryPostProcessor wsdlDefinitionBeanFactoryPostProcessor() {
 		return new WsdlDefinitionBeanFactoryPostProcessor();
 	}

diff --git a/...ava/org/springframework/boot/autoconfigure/webservices/OnWsdlLocationsConditionTests.java b/...ava/org/springframework/boot/autoconfigure/webservices/OnWsdlLocationsConditionTests.java
@@ -0,0 +1,82 @@
+/*
+ * Copyright 2012-2017 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.autoconfigure.webservices;
+
+import org.junit.After;
+import org.junit.Test;
+
+import org.springframework.boot.test.util.TestPropertyValues;
+import org.springframework.context.annotation.AnnotationConfigApplicationContext;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Conditional;
+import org.springframework.context.annotation.Configuration;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link OnWsdlLocationsCondition}.
+ *
+ * @author Eneias Silva
+ */
+public class OnWsdlLocationsConditionTests {
+
+	private AnnotationConfigApplicationContext context;
+
+	@After
+	public void tearDown() {
+		if (this.context != null) {
+			this.context.close();
+		}
+	}
+
+	@Test
+	public void wsdlLocationsNotDefined() {
+		load(TestConfig.class);
+		assertThat(this.context.containsBean("foo")).isFalse();
+	}
+
+	@Test
+	public void wsdlLocationsDefinedAsCommaSeparated() {
+		load(TestConfig.class, "spring.webservices.wsdl-locations=value1");
+		assertThat(this.context.containsBean("foo")).isTrue();
+	}
+
+	@Test
+	public void wsdlLocationsDefinedAsList() {
+		load(TestConfig.class, "spring.webservices.wsdl-locations[0]=value1");
+		assertThat(this.context.containsBean("foo")).isTrue();
+	}
+
+	private void load(Class<?> config, String... environment) {
+		this.context = new AnnotationConfigApplicationContext();
+		TestPropertyValues.of(environment).applyTo(this.context);
+		this.context.register(config);
+		this.context.refresh();
+	}
+
+	@Configuration
+	@Conditional(OnWsdlLocationsCondition.class)
+	protected static class TestConfig {
+
+		@Bean
+		public String foo() {
+			return "foo";
+		}
+
+	}
+
+}
diff --git a/...org/springframework/boot/autoconfigure/webservices/WebServicesAutoConfigurationTests.java b/...org/springframework/boot/autoconfigure/webservices/WebServicesAutoConfigurationTests.java
@@ -37,6 +37,7 @@
  * @author Vedran Pavic
  * @author Stephane Nicoll
  * @author Andy Wilkinson
+ * @author Eneias Silva
  */
 public class WebServicesAutoConfigurationTests {
 
@@ -104,6 +105,19 @@ public void withWsdlBeans() {
 				});
 	}
 
+	@Test
+	public void withWsdlBeansAsList() {
+		this.contextRunner
+				.withPropertyValues(
+						"spring.webservices.wsdl-locations[0]=classpath:/wsdl")
+				.run((context) -> {
+					assertThat(context.getBeansOfType(SimpleWsdl11Definition.class))
+							.hasSize(1).containsKey("service");
+					assertThat(context.getBeansOfType(SimpleXsdSchema.class)).hasSize(1)
+							.containsKey("types");
+				});
+	}
+
 	private Collection<String> getUrlMappings(ApplicationContext context) {
 		return getServletRegistrationBean(context).getUrlMappings();
 	}