Hacking

Author: mbhave

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/DataSourceInitializer.java

@@ -25,7 +25,6 @@
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
-import org.springframework.boot.context.properties.source.InvalidConfigurationPropertyValueException;
 import org.springframework.boot.jdbc.DataSourceBuilder;
 import org.springframework.boot.jdbc.DataSourceInitializationMode;
 import org.springframework.boot.jdbc.EmbeddedDatabaseConnection;
@@ -148,27 +147,22 @@ private boolean isEmbedded() {
 	private List<Resource> getScripts(String propertyName, List<String> resources,
 			String fallback) {
 		if (resources != null) {
-			return getResources(propertyName, resources, true);
+			return getResources(resources);
 		}
 		String platform = this.properties.getPlatform();
 		List<String> fallbackResources = new ArrayList<>();
 		fallbackResources.add("classpath*:" + fallback + "-" + platform + ".sql");
 		fallbackResources.add("classpath*:" + fallback + ".sql");
-		return getResources(propertyName, fallbackResources, false);
+		return getResources(fallbackResources);
 	}
 
-	private List<Resource> getResources(String propertyName, List<String> locations,
-			boolean validate) {
+	private List<Resource> getResources(List<String> locations) {
 		List<Resource> resources = new ArrayList<>();
 		for (String location : locations) {
 			for (Resource resource : doGetResources(location)) {
 				if (resource.exists()) {
 					resources.add(resource);
 				}
-				else if (validate) {
-					throw new InvalidConfigurationPropertyValueException(propertyName,
-							resource, "The specified resource does not exist.");
-				}
 			}
 		}
 		return resources;

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/DataSourceProperties.java

@@ -24,6 +24,7 @@
 
 import javax.sql.DataSource;
 
+import org.springframework.beans.BeansException;
 import org.springframework.beans.factory.BeanClassLoaderAware;
 import org.springframework.beans.factory.BeanCreationException;
 import org.springframework.beans.factory.InitializingBean;
@@ -32,6 +33,9 @@
 import org.springframework.boot.jdbc.DataSourceInitializationMode;
 import org.springframework.boot.jdbc.DatabaseDriver;
 import org.springframework.boot.jdbc.EmbeddedDatabaseConnection;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.ApplicationContextAware;
+import org.springframework.core.io.Resource;
 import org.springframework.util.Assert;
 import org.springframework.util.ClassUtils;
 import org.springframework.util.StringUtils;
@@ -47,7 +51,8 @@
  * @since 1.1.0
  */
 @ConfigurationProperties(prefix = "spring.datasource")
-public class DataSourceProperties implements BeanClassLoaderAware, InitializingBean {
+public class DataSourceProperties
+		implements BeanClassLoaderAware, InitializingBean, ApplicationContextAware {
 
 	private ClassLoader classLoader;
 
@@ -155,6 +160,8 @@ public class DataSourceProperties implements BeanClassLoaderAware, InitializingB
 
 	private String uniqueName;
 
+	private ApplicationContext context;
+
 	@Override
 	public void setBeanClassLoader(ClassLoader classLoader) {
 		this.classLoader = classLoader;
@@ -399,6 +406,15 @@ public List<String> getSchema() {
 	}
 
 	public void setSchema(List<String> schema) {
+		if (schema != null) {
+			for (String location : schema) {
+				Resource resource = this.context.getResource(location);
+				if (!resource.exists()) {
+					throw new InvalidDataSourcePropertyValueException(
+							resource, "The specified resource does not exist.");
+				}
+			}
+		}
 		this.schema = schema;
 	}
 
@@ -478,6 +494,12 @@ public void setXa(Xa xa) {
 		this.xa = xa;
 	}
 
+	@Override
+	public void setApplicationContext(ApplicationContext applicationContext)
+			throws BeansException {
+		this.context = applicationContext;
+	}
+
 	/**
 	 * XA Specific datasource settings.
 	 */

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/InvalidDataSourcePropertyValueException.java

@@ -0,0 +1,38 @@
+/*
+ * 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.jdbc;
+
+import org.springframework.boot.context.properties.bind.PropertyValueValidationException;
+
+/**
+ * Error thrown when a datasource property value in invalid.
+ *
+ * @author Madhura Bhave
+ */
+class InvalidDataSourcePropertyValueException extends PropertyValueValidationException {
+
+	/**
+	 * Creates a new instance for the specified property {@code value}, including a
+	 * {@code reason} why the value is invalid.
+	 * @param value the value of the property, can be {@code null}
+	 * @param reason a human-readable text that describes why the reason is invalid.
+	 * Starts with an upper-case and ends with a dots. Several sentences and carriage
+	 */
+	public InvalidDataSourcePropertyValueException(Object value, String reason) {
+		super(value, reason);
+	}
+
+}

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

@@ -16,14 +16,18 @@
 
 package org.springframework.boot.autoconfigure.jdbc;
 
+import java.util.Collections;
+
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.rules.ExpectedException;
 
 import org.springframework.boot.jdbc.EmbeddedDatabaseConnection;
 import org.springframework.boot.test.context.FilteredClassLoader;
+import org.springframework.context.annotation.AnnotationConfigApplicationContext;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
 
 /**
  * Tests for {@link DataSourceProperties}.
@@ -150,4 +154,13 @@ public void determineCredentialsForDataScripts() {
 		assertThat(properties.getDataPassword()).isEqualTo("bar");
 	}
 
+	@Test
+	public void invalidSchemaLocationThrowsException() {
+		DataSourceProperties properties = new DataSourceProperties();
+		properties.setApplicationContext(new AnnotationConfigApplicationContext());
+		assertThatExceptionOfType(InvalidDataSourcePropertyValueException.class)
+				.isThrownBy(() -> properties
+						.setSchema(Collections.singletonList("does-not-exist")));
+	}
+
 }

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/ConfigurationPropertiesBinder.java

@@ -27,6 +27,7 @@
 import org.springframework.boot.context.properties.bind.PropertySourcesPlaceholdersResolver;
 import org.springframework.boot.context.properties.bind.handler.IgnoreErrorsBindHandler;
 import org.springframework.boot.context.properties.bind.handler.IgnoreTopLevelConverterNotFoundBindHandler;
+import org.springframework.boot.context.properties.bind.handler.InvalidConfigurationPropertyValueBindHandler;
 import org.springframework.boot.context.properties.bind.handler.NoUnboundElementsBindHandler;
 import org.springframework.boot.context.properties.bind.validation.ValidationBindHandler;
 import org.springframework.boot.context.properties.source.ConfigurationPropertySource;
@@ -114,7 +115,8 @@ private Validator getJsr303Validator() {
 
 	private BindHandler getBindHandler(ConfigurationProperties annotation,
 			List<Validator> validators) {
-		BindHandler handler = new IgnoreTopLevelConverterNotFoundBindHandler();
+		BindHandler parent = new IgnoreTopLevelConverterNotFoundBindHandler();
+		BindHandler handler = new InvalidConfigurationPropertyValueBindHandler(parent);
 		if (annotation.ignoreInvalidFields()) {
 			handler = new IgnoreErrorsBindHandler(handler);
 		}

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/bind/PropertyValueValidationException.java

@@ -0,0 +1,42 @@
+/*
+ * 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.context.properties.bind;
+
+/**
+ * Error thrown when a configuration property value fails validation.
+ *
+ * @author Madhura Bhave
+ * @since 2.0.0
+ */
+public class PropertyValueValidationException extends RuntimeException {
+
+	private final Object value;
+
+	private final String reason;
+
+	public PropertyValueValidationException(Object value, String reason) {
+		this.value = value;
+		this.reason = reason;
+	}
+
+	public Object getValue() {
+		return this.value;
+	}
+
+	public String getReason() {
+		return this.reason;
+	}
+}

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/bind/handler/InvalidConfigurationPropertyValueBindHandler.java

@@ -0,0 +1,65 @@
+/*
+ * 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.context.properties.bind.handler;
+
+import org.springframework.boot.context.properties.bind.AbstractBindHandler;
+import org.springframework.boot.context.properties.bind.BindContext;
+import org.springframework.boot.context.properties.bind.BindHandler;
+import org.springframework.boot.context.properties.bind.Bindable;
+import org.springframework.boot.context.properties.bind.PropertyValueValidationException;
+import org.springframework.boot.context.properties.source.ConfigurationPropertyName;
+import org.springframework.boot.context.properties.source.InvalidConfigurationPropertyValueException;
+
+/**
+ * {@link BindHandler} that can be used to convert
+ * {@link PropertyValueValidationException} to
+ * {@link InvalidConfigurationPropertyValueException}.
+ *
+ * @author Madhura Bhave
+ */
+public class InvalidConfigurationPropertyValueBindHandler extends AbstractBindHandler {
+
+	/**
+	 * Create a new {@link InvalidConfigurationPropertyValueBindHandler} instance with a
+	 * specific parent.
+	 * @param parent the parent handler
+	 */
+	public InvalidConfigurationPropertyValueBindHandler(BindHandler parent) {
+		super(parent);
+	}
+
+	@Override
+	public Object onFailure(ConfigurationPropertyName name, Bindable<?> target,
+			BindContext context, Exception error) throws Exception {
+		PropertyValueValidationException ex = hasCause(error);
+		if (ex != null) {
+			throw new InvalidConfigurationPropertyValueException(name.toString(),
+					ex.getValue(), ex.getReason());
+		}
+		throw error;
+	}
+
+	private PropertyValueValidationException hasCause(Throwable failure) {
+		while (failure != null) {
+			if (PropertyValueValidationException.class.isInstance(failure)) {
+				return (PropertyValueValidationException) failure;
+			}
+			failure = failure.getCause();
+		}
+		return null;
+	}
+
+}

spring-boot-samples/spring-boot-sample-jpa/src/main/java/sample/jpa/SampleJpaApplication.java

@@ -23,7 +23,7 @@
 public class SampleJpaApplication {
 
 	public static void main(String[] args) {
-		SpringApplication.run(SampleJpaApplication.class, args);
+		SpringApplication.run(SampleJpaApplication.class, "--app.datasource.schema=classpath:does-not-exist.sql");
 	}
 
 }