Merge pull request #3534 from lucassaldanha/issue-#3513

* pr/3534:
  Polish
  Add configuration properties validation sample

spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc

@@ -782,7 +782,9 @@ annotations to your `@ConfigurationProperties` class:
 ----
 
 You can also add a custom Spring `Validator` by creating a bean definition called
-`configurationPropertiesValidator`.
+`configurationPropertiesValidator`. There is a
+{github-code}/spring-boot-samples/spring-boot-sample-property-validation[Validation sample]
+so you can see how to set things up.
 
 TIP: The `spring-boot-actuator` module includes an endpoint that exposes all
 `@ConfigurationProperties` beans. Simply point your web browser to `/configprops`

spring-boot-samples/README.adoc

@@ -70,6 +70,8 @@
   -- A spring integration application
 * link:spring-boot-sample-profile[spring-boot-sample-profile]
   -- example showing Spring's `@profile` support
+* link:spring-boot-sample-property-validation[spring-boot-sample-property-validation]
+  -- example showing the usage of `@ConfigurationProperties` with a Spring `Validator`
 * link:spring-boot-sample-parent-context[spring-boot-sample-parent-context]
   -- example showing an `ApplicationContext` with a parent
 * link:spring-boot-sample-aop[spring-boot-sample-aop]

spring-boot-samples/pom.xml

@@ -67,6 +67,7 @@
 		<module>spring-boot-sample-metrics-redis</module>
 		<module>spring-boot-sample-parent-context</module>
 		<module>spring-boot-sample-profile</module>
+		<module>spring-boot-sample-property-validation</module>
 		<module>spring-boot-sample-secure</module>
 		<module>spring-boot-sample-secure-oauth2</module>
 		<module>spring-boot-sample-servlet</module>

spring-boot-samples/spring-boot-sample-property-validation/pom.xml

@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+	<parent>
+		<!-- Your own application should inherit from spring-boot-starter-parent -->
+		<groupId>org.springframework.boot</groupId>
+		<artifactId>spring-boot-samples</artifactId>
+		<version>1.3.0.BUILD-SNAPSHOT</version>
+	</parent>
+	<artifactId>spring-boot-sample-property-validation</artifactId>
+	<name>Spring Boot Property Validation Sample</name>
+	<description>Spring Boot Property Validation Sample</description>
+	<url>http://projects.spring.io/spring-boot/</url>
+	<organization>
+		<name>Pivotal Software, Inc.</name>
+		<url>http://www.spring.io</url>
+	</organization>
+	<properties>
+		<main.basedir>${basedir}/../..</main.basedir>
+	</properties>
+	<dependencies>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter</artifactId>
+		</dependency>
+
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-configuration-processor</artifactId>
+			<optional>true</optional>
+		</dependency>
+
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-test</artifactId>
+			<scope>test</scope>
+		</dependency>
+	</dependencies>
+	<build>
+		<plugins>
+			<plugin>
+				<groupId>org.springframework.boot</groupId>
+				<artifactId>spring-boot-maven-plugin</artifactId>
+			</plugin>
+		</plugins>
+	</build>
+</project>

spring-boot-samples/spring-boot-sample-property-validation/src/main/java/sample/propertyvalidation/SampleProperties.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright 2012-2015 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 sample.propertyvalidation;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.stereotype.Component;
+
+@Component
+@ConfigurationProperties(prefix = "sample")
+public class SampleProperties {
+
+	/**
+	 * Sample host.
+	 */
+	private String host;
+
+	/**
+	 * Sample port.
+	 */
+	private Integer port = 8080;
+
+	public String getHost() {
+		return host;
+	}
+
+	public void setHost(String host) {
+		this.host = host;
+	}
+
+	public Integer getPort() {
+		return port;
+	}
+
+	public void setPort(Integer port) {
+		this.port = port;
+	}
+}

spring-boot-samples/spring-boot-sample-property-validation/src/main/java/sample/propertyvalidation/SamplePropertiesValidator.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2012-2015 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 sample.propertyvalidation;
+
+import java.util.regex.Pattern;
+
+import org.springframework.validation.Errors;
+import org.springframework.validation.ValidationUtils;
+import org.springframework.validation.Validator;
+
+public class SamplePropertiesValidator implements Validator {
+
+	final Pattern pattern = Pattern.compile("^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$");
+
+	@Override
+	public boolean supports(Class<?> type) {
+		return type == SampleProperties.class;
+	}
+
+	@Override
+	public void validate(Object o, Errors errors) {
+		ValidationUtils.rejectIfEmpty(errors, "host", "host.empty");
+		ValidationUtils.rejectIfEmpty(errors, "port", "port.empty");
+
+		SampleProperties properties = (SampleProperties) o;
+		if (properties.getHost() != null &&
+				!pattern.matcher(properties.getHost()).matches()) {
+			errors.rejectValue("host", "Invalid host");
+		}
+	}
+
+}

spring-boot-samples/spring-boot-sample-property-validation/src/main/java/sample/propertyvalidation/SamplePropertyValidationApplication.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2012-2015 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 sample.propertyvalidation;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.CommandLineRunner;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.builder.SpringApplicationBuilder;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Profile;
+import org.springframework.stereotype.Service;
+import org.springframework.validation.Validator;
+
+@SpringBootApplication
+@EnableConfigurationProperties
+public class SamplePropertyValidationApplication {
+
+	@Bean
+	public Validator configurationPropertiesValidator() {
+		return new SamplePropertiesValidator();
+	}
+
+	@Service
+	@Profile("app")
+	static class Startup implements CommandLineRunner {
+
+		@Autowired
+		private SampleProperties properties;
+
+		@Override
+		public void run(String... args) {
+			System.out.println("=========================================");
+			System.out.println("Sample host: " + this.properties.getHost());
+			System.out.println("Sample port: " + this.properties.getPort());
+			System.out.println("=========================================");
+		}
+	}
+
+	public static void main(String[] args) throws Exception {
+		new SpringApplicationBuilder(SamplePropertyValidationApplication.class)
+				.profiles("app").run(args);
+	}
+
+}

spring-boot-samples/spring-boot-sample-property-validation/src/main/resources/application.properties

@@ -0,0 +1,2 @@
+sample.host=192.168.0.1
+sample.port=7070

spring-boot-samples/spring-boot-sample-property-validation/src/test/java/sample/propertyvalidation/SamplePropertyValidationApplicationTests.java

@@ -0,0 +1,95 @@
+/*
+ * Copyright 2012-2015 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 sample.propertyvalidation;
+
+import org.junit.After;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.ExpectedException;
+
+import org.springframework.beans.factory.BeanCreationException;
+import org.springframework.boot.autoconfigure.web.ServerProperties;
+import org.springframework.boot.test.EnvironmentTestUtils;
+import org.springframework.context.annotation.AnnotationConfigApplicationContext;
+
+import static org.junit.Assert.assertEquals;
+
+/**
+ * Tests for {@link SamplePropertyValidationApplication}.
+ *
+ * @author Lucas Saldanha
+ * @author Stephane Nicoll
+ */
+public class SamplePropertyValidationApplicationTests {
+
+	@Rule
+	public final ExpectedException thrown = ExpectedException.none();
+
+	private final AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
+
+	@After
+	public void closeContext() {
+		context.close();
+	}
+
+	@Test
+	public void bindValidProperties() {
+		this.context.register(SamplePropertyValidationApplication.class);
+		EnvironmentTestUtils.addEnvironment(this.context,
+				"sample.host:192.168.0.1", "sample.port:9090");
+		this.context.refresh();
+
+		SampleProperties properties = this.context.getBean(SampleProperties.class);
+		assertEquals("192.168.0.1", properties.getHost());
+		assertEquals(Integer.valueOf(9090), properties.getPort());
+	}
+
+	@Test
+	public void bindInvalidHost() {
+		this.context.register(SamplePropertyValidationApplication.class);
+		EnvironmentTestUtils.addEnvironment(this.context,
+				"sample.host:xxxxxx", "sample.port:9090");
+
+		thrown.expect(BeanCreationException.class);
+		thrown.expectMessage("xxxxxx");
+		this.context.refresh();
+	}
+
+	@Test
+	public void bindNullHost() {
+		this.context.register(SamplePropertyValidationApplication.class);
+
+		thrown.expect(BeanCreationException.class);
+		thrown.expectMessage("null");
+		thrown.expectMessage("host");
+		this.context.refresh();
+	}
+
+	@Test
+	public void validatorOnlyCalledOnSupportedClass() {
+		this.context.register(SamplePropertyValidationApplication.class);
+		this.context.register(ServerProperties.class); // our validator will not apply here
+		EnvironmentTestUtils.addEnvironment(this.context,
+				"sample.host:192.168.0.1", "sample.port:9090");
+		this.context.refresh();
+
+		SampleProperties properties = this.context.getBean(SampleProperties.class);
+		assertEquals("192.168.0.1", properties.getHost());
+		assertEquals(Integer.valueOf(9090), properties.getPort());
+	}
+
+}