Never run data.sql scripts if spring.datasource.initialize is false

Previously, the data scripts were always run in response to the
publication of a DataSourceInitializedEvent, irrespective of
spring.datasource.initialize. While the event won't be published by
DataSourceInitializer if spring.datasource.initialize is false, it
will be published if spring.jpa.hibernate.hbm2ddl.auto has been set.

This commit updates DataSourceInitializer's handling of
DataSourceInitializedEvent to only run the data scripts if
spring.datasource.initialize is true.

Fixes #1336

Author: wilkinsona

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

@@ -88,6 +88,10 @@ private void runSchemaScripts() {
 
 	@Override
 	public void onApplicationEvent(DataSourceInitializedEvent event) {
+		if (!this.properties.isInitialize()) {
+			logger.debug("Initialization disabled (not running data scripts)");
+			return;
+		}
 		// NOTE the event can happen more than once and
 		// the event datasource is not used here
 		if (!this.initialized) {

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

@@ -16,6 +16,7 @@
 
 package org.springframework.boot.autoconfigure.jdbc;
 
+import java.sql.SQLException;
 import java.util.Random;
 
 import javax.sql.DataSource;
@@ -31,13 +32,15 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Primary;
+import org.springframework.jdbc.BadSqlGrammarException;
 import org.springframework.jdbc.core.JdbcOperations;
 import org.springframework.jdbc.core.JdbcTemplate;
 import org.springframework.util.ClassUtils;
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
 
 /**
  * Tests for {@link DataSourceInitializer}.
@@ -96,48 +99,56 @@ public void testDataSourceInitialized() throws Exception {
 		assertTrue(dataSource instanceof org.apache.tomcat.jdbc.pool.DataSource);
 		assertNotNull(dataSource);
 		JdbcOperations template = new JdbcTemplate(dataSource);
-		assertEquals(new Integer(0),
+		assertEquals(new Integer(1),
 				template.queryForObject("SELECT COUNT(*) from BAR", Integer.class));
 	}
 
 	@Test
 	public void testDataSourceInitializedWithExplicitScript() throws Exception {
 		this.context.register(DataSourceAutoConfiguration.class,
 				PropertyPlaceholderAutoConfiguration.class);
-		EnvironmentTestUtils.addEnvironment(
-				this.context,
-				"spring.datasource.initialize:true",
-				"spring.datasource.schema:"
-						+ ClassUtils.addResourcePathToPackagePath(getClass(),
-								"schema.sql"));
+		EnvironmentTestUtils
+				.addEnvironment(
+						this.context,
+						"spring.datasource.initialize:true",
+						"spring.datasource.schema:"
+								+ ClassUtils.addResourcePathToPackagePath(getClass(),
+										"schema.sql"),
+						"spring.datasource.data:"
+								+ ClassUtils.addResourcePathToPackagePath(getClass(),
+										"data.sql"));
 		this.context.refresh();
 		DataSource dataSource = this.context.getBean(DataSource.class);
 		assertTrue(dataSource instanceof org.apache.tomcat.jdbc.pool.DataSource);
 		assertNotNull(dataSource);
 		JdbcOperations template = new JdbcTemplate(dataSource);
-		assertEquals(new Integer(0),
+		assertEquals(new Integer(1),
 				template.queryForObject("SELECT COUNT(*) from FOO", Integer.class));
 	}
 
 	@Test
 	public void testDataSourceInitializedWithMultipleScripts() throws Exception {
-		EnvironmentTestUtils.addEnvironment(
-				this.context,
-				"spring.datasource.initialize:true",
-				"spring.datasource.schema:"
-						+ ClassUtils.addResourcePathToPackagePath(getClass(),
-								"schema.sql")
-						+ ","
-						+ ClassUtils.addResourcePathToPackagePath(getClass(),
-								"another.sql"));
+		EnvironmentTestUtils
+				.addEnvironment(
+						this.context,
+						"spring.datasource.initialize:true",
+						"spring.datasource.schema:"
+								+ ClassUtils.addResourcePathToPackagePath(getClass(),
+										"schema.sql")
+								+ ","
+								+ ClassUtils.addResourcePathToPackagePath(getClass(),
+										"another.sql"),
+						"spring.datasource.data:"
+								+ ClassUtils.addResourcePathToPackagePath(getClass(),
+										"data.sql"));
 		this.context.register(DataSourceAutoConfiguration.class,
 				PropertyPlaceholderAutoConfiguration.class);
 		this.context.refresh();
 		DataSource dataSource = this.context.getBean(DataSource.class);
 		assertTrue(dataSource instanceof org.apache.tomcat.jdbc.pool.DataSource);
 		assertNotNull(dataSource);
 		JdbcOperations template = new JdbcTemplate(dataSource);
-		assertEquals(new Integer(0),
+		assertEquals(new Integer(1),
 				template.queryForObject("SELECT COUNT(*) from FOO", Integer.class));
 		assertEquals(new Integer(0),
 				template.queryForObject("SELECT COUNT(*) from SPAM", Integer.class));
@@ -170,6 +181,31 @@ public void testDataSourceInitializedWithExplicitSqlScriptEncoding() throws Exce
 				template.queryForObject("SELECT name from BAR WHERE id=2", String.class));
 	}
 
+	@Test
+	public void testInitializationDisabled() throws Exception {
+		this.context.register(DataSourceAutoConfiguration.class,
+				PropertyPlaceholderAutoConfiguration.class);
+		this.context.refresh();
+
+		DataSource dataSource = this.context.getBean(DataSource.class);
+
+		this.context.publishEvent(new DataSourceInitializedEvent(dataSource));
+
+		assertTrue(dataSource instanceof org.apache.tomcat.jdbc.pool.DataSource);
+		assertNotNull(dataSource);
+		JdbcOperations template = new JdbcTemplate(dataSource);
+
+		try {
+			template.queryForObject("SELECT COUNT(*) from BAR", Integer.class);
+			fail("Query should have failed as BAR table does not exist");
+		}
+		catch (BadSqlGrammarException ex) {
+			SQLException sqlException = ex.getSQLException();
+			int expectedCode = -5501; // user lacks privilege or object not found
+			assertEquals(expectedCode, sqlException.getErrorCode());
+		}
+	}
+
 	@Configuration
 	@EnableConfigurationProperties
 	protected static class TwoDataSources {

spring-boot-autoconfigure/src/test/resources/data.sql

@@ -0,0 +1 @@
+INSERT INTO BAR VALUES (1, 'Andy');

spring-boot-autoconfigure/src/test/resources/org/springframework/boot/autoconfigure/jdbc/data.sql

@@ -0,0 +1 @@
+INSERT INTO FOO VALUES (1, 'Andy');