Improve configurability of EmbeddedDatabaseBuilder

This commit improves the configurability of EmbeddedDatabaseBuilder by
exposing the following new configuration methods.

 - setDataSourceFactory(DataSourceFactory)
 - addScripts(String...)
 - setScriptEncoding(String)
 - setSeparator(String)
 - setCommentPrefix(String)
 - setBlockCommentStartDelimiter(String)
 - setBlockCommentEndDelimiter(String)
 - continueOnError(boolean)
 - ignoreFailedDrops(boolean)

If more fine grained control over the configuration of the embedded
database is required, users are recommended to use
EmbeddedDatabaseFactory with a ResourceDatabasePopulator and forego use
of the builder.

Issue: SPR-11410

spring-jdbc/src/test/java/org/springframework/jdbc/datasource/embedded/EmbeddedDatabaseBuilderTests.java

@@ -17,74 +17,153 @@
 package org.springframework.jdbc.datasource.embedded;
 
 import org.junit.Test;
-
 import org.springframework.core.io.ClassRelativeResourceLoader;
 import org.springframework.jdbc.core.JdbcTemplate;
 import org.springframework.jdbc.datasource.init.CannotReadScriptException;
 
 import static org.junit.Assert.*;
+import static org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseType.*;
 
 /**
+ * Integration tests for {@link EmbeddedDatabaseBuilder}.
+ *
  * @author Keith Donald
  * @author Sam Brannen
  */
 public class EmbeddedDatabaseBuilderTests {
 
-	@Test
-	public void testBuildDefaultScripts() {
-		EmbeddedDatabaseBuilder builder = new EmbeddedDatabaseBuilder();
-		EmbeddedDatabase db = builder.addDefaultScripts().build();
-		assertDatabaseCreatedAndShutdown(db);
+	private final EmbeddedDatabaseBuilder builder = new EmbeddedDatabaseBuilder(new ClassRelativeResourceLoader(
+		getClass()));
 
-		db = builder.addDefaultScripts().build();
-		assertDatabaseCreatedAndShutdown(db);
-	}
 
 	@Test
-	public void testBuild() {
-		EmbeddedDatabaseBuilder builder = new EmbeddedDatabaseBuilder(new ClassRelativeResourceLoader(getClass()));
-		EmbeddedDatabase db = builder.addScript("db-schema.sql").addScript("db-test-data.sql").build();
-		assertDatabaseCreatedAndShutdown(db);
+	public void addDefaultScripts() throws Exception {
+		doTwice(new Runnable() {
 
-		db = builder.addScript("db-schema.sql").addScript("db-test-data.sql").build();
-		assertDatabaseCreatedAndShutdown(db);
-	}
-
-	@Test
-	public void testBuildWithComments() {
-		EmbeddedDatabaseBuilder builder = new EmbeddedDatabaseBuilder(new ClassRelativeResourceLoader(getClass()));
-		EmbeddedDatabase db = builder.addScript("db-schema-comments.sql").addScript("db-test-data.sql").build();
-		assertDatabaseCreatedAndShutdown(db);
-
-		db = builder.addScript("db-schema-comments.sql").addScript("db-test-data.sql").build();
-		assertDatabaseCreatedAndShutdown(db);
-	}
-
-	@Test
-	public void testBuildH2() {
-		EmbeddedDatabaseBuilder builder = new EmbeddedDatabaseBuilder(new ClassRelativeResourceLoader(getClass()));
-		EmbeddedDatabase db = builder.setType(EmbeddedDatabaseType.H2).addScript("db-schema.sql").addScript("db-test-data.sql").build();
-		assertDatabaseCreatedAndShutdown(db);
-
-		db = builder.setType(EmbeddedDatabaseType.H2).addScript("db-schema.sql").addScript("db-test-data.sql").build();
-		assertDatabaseCreatedAndShutdown(db);
-	}
-
-	@Test
-	public void testBuildDerby() {
-		EmbeddedDatabaseBuilder builder = new EmbeddedDatabaseBuilder(new ClassRelativeResourceLoader(getClass()));
-		EmbeddedDatabase db = builder.setType(EmbeddedDatabaseType.DERBY).addScript("db-schema-derby.sql").addScript("db-test-data.sql").build();
-		assertDatabaseCreatedAndShutdown(db);
-
-		db = builder.setType(EmbeddedDatabaseType.DERBY).addScript("db-schema-derby-with-drop.sql").addScript("db-test-data.sql").build();
-		assertDatabaseCreatedAndShutdown(db);
+			@Override
+			public void run() {
+				EmbeddedDatabase db = new EmbeddedDatabaseBuilder()//
+				.addDefaultScripts()//
+				.build();
+				assertDatabaseCreatedAndShutdown(db);
+			}
+		});
 	}
 
 	@Test(expected = CannotReadScriptException.class)
-	public void testBuildNoSuchScript() {
+	public void addScriptWithBogusFileName() {
 		new EmbeddedDatabaseBuilder().addScript("bogus.sql").build();
 	}
 
+	@Test
+	public void addScript() throws Exception {
+		doTwice(new Runnable() {
+
+			@Override
+			public void run() {
+				EmbeddedDatabase db = builder//
+				.addScript("db-schema.sql")//
+				.addScript("db-test-data.sql")//
+				.build();
+				assertDatabaseCreatedAndShutdown(db);
+			}
+		});
+	}
+
+	@Test
+	public void addScripts() throws Exception {
+		doTwice(new Runnable() {
+
+			@Override
+			public void run() {
+				EmbeddedDatabase db = builder//
+				.addScripts("db-schema.sql", "db-test-data.sql")//
+				.build();
+				assertDatabaseCreatedAndShutdown(db);
+			}
+		});
+	}
+
+	@Test
+	public void addScriptsWithDefaultCommentPrefix() throws Exception {
+		doTwice(new Runnable() {
+
+			@Override
+			public void run() {
+				EmbeddedDatabase db = builder//
+				.addScripts("db-schema-comments.sql", "db-test-data.sql")//
+				.build();
+				assertDatabaseCreatedAndShutdown(db);
+			}
+		});
+	}
+
+	@Test
+	public void addScriptsWithCustomCommentPrefix() throws Exception {
+		doTwice(new Runnable() {
+
+			@Override
+			public void run() {
+				EmbeddedDatabase db = builder//
+				.addScripts("db-schema-custom-comments.sql", "db-test-data.sql")//
+				.setCommentPrefix("~")//
+				.build();
+				assertDatabaseCreatedAndShutdown(db);
+			}
+		});
+	}
+
+	@Test
+	public void addScriptsWithCustomBlockComments() throws Exception {
+		doTwice(new Runnable() {
+
+			@Override
+			public void run() {
+				EmbeddedDatabase db = builder//
+				.addScripts("db-schema-block-comments.sql", "db-test-data.sql")//
+				.setBlockCommentStartDelimiter("{*")//
+				.setBlockCommentEndDelimiter("*}")//
+				.build();
+				assertDatabaseCreatedAndShutdown(db);
+			}
+		});
+	}
+
+	@Test
+	public void setTypeToH2() throws Exception {
+		doTwice(new Runnable() {
+
+			@Override
+			public void run() {
+				EmbeddedDatabase db = builder//
+				.setType(H2)//
+				.addScripts("db-schema.sql", "db-test-data.sql")//
+				.build();
+				assertDatabaseCreatedAndShutdown(db);
+			}
+		});
+	}
+
+	@Test
+	public void setTypeToDerbyAndIgnoreFailedDrops() throws Exception {
+		doTwice(new Runnable() {
+
+			@Override
+			public void run() {
+				EmbeddedDatabase db = builder//
+				.setType(DERBY)//
+				.ignoreFailedDrops(true)//
+				.addScripts("db-schema-derby-with-drop.sql", "db-test-data.sql").build();
+				assertDatabaseCreatedAndShutdown(db);
+			}
+		});
+	}
+
+	private void doTwice(Runnable test) {
+		test.run();
+		test.run();
+	}
+
 	private void assertDatabaseCreatedAndShutdown(EmbeddedDatabase db) {
 		JdbcTemplate template = new JdbcTemplate(db);
 		assertEquals("Keith", template.queryForObject("select NAME from T_TEST", String.class));

spring-jdbc/src/test/java/org/springframework/jdbc/datasource/embedded/EmbeddedDatabaseFactoryBeanTests.java

@@ -19,8 +19,8 @@ package org.springframework.jdbc.datasource.embedded;
 import javax.sql.DataSource;
 
 import org.junit.Test;
-
-import org.springframework.core.io.ClassPathResource;
+import org.springframework.core.io.ClassRelativeResourceLoader;
+import org.springframework.core.io.Resource;
 import org.springframework.jdbc.core.JdbcTemplate;
 import org.springframework.jdbc.datasource.init.ResourceDatabasePopulator;
 
@@ -31,11 +31,18 @@ import static org.junit.Assert.*;
  */
 public class EmbeddedDatabaseFactoryBeanTests {
 
+	private final ClassRelativeResourceLoader resourceLoader = new ClassRelativeResourceLoader(getClass());
+
+
+	Resource resource(String path) {
+		return resourceLoader.getResource(path);
+	}
+
 	@Test
 	public void testFactoryBeanLifecycle() throws Exception {
 		EmbeddedDatabaseFactoryBean bean = new EmbeddedDatabaseFactoryBean();
-		ResourceDatabasePopulator populator = new ResourceDatabasePopulator();
-		populator.setScripts(new ClassPathResource("db-schema.sql", getClass()), new ClassPathResource("db-test-data.sql", getClass()));
+		ResourceDatabasePopulator populator = new ResourceDatabasePopulator(resource("db-schema.sql"),
+			resource("db-test-data.sql"));
 		bean.setDatabasePopulator(populator);
 		bean.afterPropertiesSet();
 		DataSource ds = bean.getObject();

spring-jdbc/src/test/resources/org/springframework/jdbc/datasource/embedded/db-schema-block-comments.sql

@@ -0,0 +1,9 @@
+{*
+	these are custom block comments
+*}
+drop table T_TEST if exists;
+
+{*
+	these are custom block comments
+*}
+create table T_TEST (NAME varchar(50) not null);

spring-jdbc/src/test/resources/org/springframework/jdbc/datasource/embedded/db-schema-custom-comments.sql

@@ -0,0 +1,5 @@
+~ Failed DROP can be ignored if necessary 
+drop table T_TEST if exists;
+
+~ Create the test table
+create table T_TEST (NAME varchar(50) not null);

spring-jdbc/src/test/resources/org/springframework/jdbc/datasource/embedded/db-schema-derby.sql

@@ -1 +0,0 @@
-create table T_TEST (NAME varchar(50) not null);