Polish

Closes gh-3534

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

@@ -20,12 +20,18 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.stereotype.Component;
 
 @Component
-@ConfigurationProperties
+@ConfigurationProperties(prefix = "sample")
 public class SampleProperties {
 
+	/**
+	 * Sample host.
+	 */
 	private String host;
 
-	private Integer port;
+	/**
+	 * Sample port.
+	 */
+	private Integer port = 8080;
 
 	public String getHost() {
 		return host;

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

@@ -16,46 +16,29 @@
 
 package sample.propertyvalidation;
 
-import org.springframework.boot.context.properties.ConfigurationProperties;
-import org.springframework.core.annotation.AnnotationUtils;
-import org.springframework.stereotype.Component;
+import java.util.regex.Pattern;
+
 import org.springframework.validation.Errors;
 import org.springframework.validation.ValidationUtils;
 import org.springframework.validation.Validator;
 
-import java.util.HashSet;
-import java.util.Set;
-import java.util.regex.Pattern;
+public class SamplePropertiesValidator implements Validator {
 
-@Component(value = "configurationPropertiesValidator")
-public class ConfigurationPropertiesValidator implements Validator {
-
-	public static final String IP_REGEX = "^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$";
-
-	final Pattern pattern = Pattern.compile(IP_REGEX);
-
-	private Set<String> validatedClasses = new HashSet<String>() {{
-		add(SampleProperties.class.getName());
-	}};
+	final Pattern pattern = Pattern.compile("^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$");
 
 	@Override
-	public boolean supports(Class<?> aClass) {
-		return AnnotationUtils.findAnnotation(aClass, ConfigurationProperties.class) != null;
+	public boolean supports(Class<?> type) {
+		return type == SampleProperties.class;
 	}
 
 	@Override
 	public void validate(Object o, Errors errors) {
-		if(validatedClasses.contains(o.getClass().getName())) {
-			doValidation(o, errors);
-		}
-	}
-
-	private void doValidation(Object o, Errors errors) {
 		ValidationUtils.rejectIfEmpty(errors, "host", "host.empty");
 		ValidationUtils.rejectIfEmpty(errors, "port", "port.empty");
 
 		SampleProperties properties = (SampleProperties) o;
-		if(!pattern.matcher(properties.getHost()).matches()) {
+		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

@@ -18,26 +18,42 @@ package sample.propertyvalidation;
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.CommandLineRunner;
-import org.springframework.boot.SpringApplication;
 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 implements CommandLineRunner {
+public class SamplePropertyValidationApplication {
 
-	@Autowired
-	private SampleProperties properties;
+	@Bean
+	public Validator configurationPropertiesValidator() {
+		return new SamplePropertiesValidator();
+	}
 
-	@Override
-	public void run(String... args) {
-		System.out.println("host: " + this.properties.getHost());
-		System.out.println("port:" + this.properties.getPort());
+	@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 {
-		SpringApplication.run(SamplePropertyValidationApplication.class, args);
+		new SpringApplicationBuilder(SamplePropertyValidationApplication.class)
+				.profiles("app").run(args);
 	}
 
 }

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

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

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

@@ -16,15 +16,15 @@
 
 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.context.properties.EnableConfigurationProperties;
 import org.springframework.boot.test.EnvironmentTestUtils;
 import org.springframework.context.annotation.AnnotationConfigApplicationContext;
-import org.springframework.context.annotation.Bean;
-import org.springframework.context.annotation.Configuration;
-import org.springframework.validation.Validator;
 
 import static org.junit.Assert.assertEquals;
 
@@ -32,54 +32,64 @@ 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();
 
-	@Test
-	public void testBindingValidProperties() {
-		this.context.register(TestConfiguration.class);
-		EnvironmentTestUtils.addEnvironment(this.context, "host:192.168.0.1");
-		EnvironmentTestUtils.addEnvironment(this.context, "port:8080");
-		this.context.refresh();
-
-		assertEquals(1, this.context.getBeanNamesForType(SampleProperties.class).length);
-		SampleProperties properties = this.context.getBean(SampleProperties.class);
-		assertEquals("192.168.0.1", properties.getHost());
-		assertEquals(8080, (int) properties.getPort());
+	@After
+	public void closeContext() {
+		context.close();
 	}
 
-	@Test(expected = BeanCreationException.class)
-	public void testBindingInvalidProperties() {
-		this.context.register(TestConfiguration.class);
-		EnvironmentTestUtils.addEnvironment(this.context, "host:xxxxxx");
-		EnvironmentTestUtils.addEnvironment(this.context, "port:8080");
+	@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 testBindingValidPropertiesWithMultipleConfigurationPropertiesClasses() {
-		this.context.register(TestConfiguration.class);
-		this.context.register(ServerProperties.class);
-		EnvironmentTestUtils.addEnvironment(this.context, "host:192.168.0.1");
-		EnvironmentTestUtils.addEnvironment(this.context, "port:8080");
-		this.context.refresh();
+	public void bindNullHost() {
+		this.context.register(SamplePropertyValidationApplication.class);
 
-		assertEquals(1, this.context.getBeanNamesForType(SampleProperties.class).length);
-		SampleProperties properties = this.context.getBean(SampleProperties.class);
-		assertEquals("192.168.0.1", properties.getHost());
-		assertEquals(8080, (int) properties.getPort());
+		thrown.expect(BeanCreationException.class);
+		thrown.expectMessage("null");
+		thrown.expectMessage("host");
+		this.context.refresh();
 	}
 
-	@Configuration
-	@EnableConfigurationProperties(SampleProperties.class)
-	protected static class TestConfiguration {
+	@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();
 
-		@Bean
-		public Validator configurationPropertiesValidator() {
-			return new ConfigurationPropertiesValidator();
-		}
+		SampleProperties properties = this.context.getBean(SampleProperties.class);
+		assertEquals("192.168.0.1", properties.getHost());
+		assertEquals(Integer.valueOf(9090), properties.getPort());
 	}
 
 }

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

@@ -1,2 +0,0 @@
-host: 192.168.0.1
-port: 8080