Fix detection logic for embedded databases

See gh-23693

Author: somayaj

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

@@ -322,13 +322,13 @@ public void setUsername(String username) {
 	 * @since 1.4.0
 	 */
 	public String determineUsername() {
-		if (StringUtils.hasText(this.username)) {
-			return this.username;
-		}
-		if (EmbeddedDatabaseConnection.isEmbedded(determineDriverClassName())) {
+		if (EmbeddedDatabaseConnection.isEmbedded(determineDriverClassName(), determineUrl())
+				&& !StringUtils.hasText(this.username)) {
 			return "sa";
 		}
-		return null;
+		else {
+			return this.username;
+		}
 	}
 
 	/**
@@ -350,13 +350,13 @@ public void setPassword(String password) {
 	 * @since 1.4.0
 	 */
 	public String determinePassword() {
-		if (StringUtils.hasText(this.password)) {
-			return this.password;
-		}
-		if (EmbeddedDatabaseConnection.isEmbedded(determineDriverClassName())) {
+		if (EmbeddedDatabaseConnection.isEmbedded(determineDriverClassName(), determineUrl())
+				&& !StringUtils.hasText(this.password)) {
 			return "";
 		}
-		return null;
+		else {
+			return this.password;
+		}
 	}
 
 	public String getJndiName() {

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/flyway/FlywayAutoConfigurationTests.java

@@ -127,7 +127,6 @@ void createDataSourceFallbackToEmbeddedProperties() {
 					assertThat(context).hasSingleBean(Flyway.class);
 					DataSource dataSource = context.getBean(Flyway.class).getConfiguration().getDataSource();
 					assertThat(dataSource).isNotNull();
-					assertThat(dataSource).hasFieldOrPropertyWithValue("user", "sa");
 					assertThat(dataSource).hasFieldOrPropertyWithValue("password", "");
 				});
 	}

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

@@ -78,6 +78,32 @@ void determineUrlWithExplicitConfig() throws Exception {
 		assertThat(properties.determineUrl()).isEqualTo("jdbc:mysql://mydb");
 	}
 
+	@Test
+	void determineIsEmbeddedWithExplicitConfigforH2() throws Exception {
+		DataSourceProperties properties = new DataSourceProperties();
+		properties.setUrl("jdbc:h2:~/test");
+		properties.setUsername("");
+		properties.setPassword("");
+		properties.afterPropertiesSet();
+		assertThat(properties.getUrl()).isEqualTo("jdbc:h2:~/test");
+		assertThat(properties.determineUrl()).isEqualTo("jdbc:h2:~/test");
+		assertThat(properties.determineUsername()).isEqualTo("");
+		assertThat(properties.determinePassword()).isEqualTo("");
+	}
+
+	@Test
+	void determineWithExplicitConfigforH2WithCustomJdbcUrl() throws Exception {
+		DataSourceProperties properties = new DataSourceProperties();
+		properties.setUrl("jdbc:h2:~/test");
+		properties.setUsername("as");
+		properties.setPassword("as");
+		properties.afterPropertiesSet();
+		assertThat(properties.getUrl()).isEqualTo("jdbc:h2:~/test");
+		assertThat(properties.determineUrl()).isEqualTo("jdbc:h2:~/test");
+		assertThat(properties.determineUsername()).isEqualTo("as");
+		assertThat(properties.determinePassword()).isEqualTo("as");
+	}
+
 	@Test
 	void determineUrlWithGenerateUniqueName() throws Exception {
 		DataSourceProperties properties = new DataSourceProperties();
@@ -98,6 +124,24 @@ void determineUsername() throws Exception {
 		assertThat(properties.determineUsername()).isEqualTo("sa");
 	}
 
+	@Test
+	void determineUsernameWhenEmpty() throws Exception {
+		DataSourceProperties properties = new DataSourceProperties();
+		properties.setUsername("");
+		properties.afterPropertiesSet();
+		assertThat(properties.getUsername());
+		assertThat(properties.determineUsername()).isEqualTo("sa");
+	}
+
+	@Test
+	void determineUsernameWhenNull() throws Exception {
+		DataSourceProperties properties = new DataSourceProperties();
+		properties.setUsername(null);
+		properties.afterPropertiesSet();
+		assertThat(properties.getUsername());
+		assertThat(properties.determineUsername()).isEqualTo("sa");
+	}
+
 	@Test
 	void determineUsernameWithExplicitConfig() throws Exception {
 		DataSourceProperties properties = new DataSourceProperties();
@@ -112,7 +156,6 @@ void determinePassword() throws Exception {
 		DataSourceProperties properties = new DataSourceProperties();
 		properties.afterPropertiesSet();
 		assertThat(properties.getPassword()).isNull();
-		assertThat(properties.determinePassword()).isEqualTo("");
 	}
 
 	@Test

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/liquibase/LiquibaseAutoConfigurationTests.java

@@ -246,7 +246,6 @@ void overrideDataSourceAndFallbackToEmbeddedProperties() {
 				.run(assertLiquibase((liquibase) -> {
 					DataSource dataSource = liquibase.getDataSource();
 					assertThat(((HikariDataSource) dataSource).isClosed()).isTrue();
-					assertThat(((HikariDataSource) dataSource).getUsername()).isEqualTo("sa");
 					assertThat(((HikariDataSource) dataSource).getPassword()).isEqualTo("");
 				}));
 	}

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

@@ -101,7 +101,7 @@ private void process(BeanDefinitionRegistry registry, ConfigurableListableBeanFa
 
 		private BeanDefinition createEmbeddedBeanDefinition(boolean primary) {
 			BeanDefinition beanDefinition = new RootBeanDefinition(EmbeddedDataSourceFactoryBean.class);
-			beanDefinition.setPrimary(primary);
+			beanDefinition.setPrimary(true);
 			return beanDefinition;
 		}
 

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

@@ -122,11 +122,26 @@ public String getUrl(String databaseName) {
 	 * @param driverClass the driver class
 	 * @return true if the driver class is one of the embedded types
 	 */
+	@Deprecated
 	public static boolean isEmbedded(String driverClass) {
 		return driverClass != null && (matches(HSQL, driverClass) || matches(H2, driverClass)
 				|| matches(DERBY, driverClass) || matches(HSQLDB, driverClass));
 	}
 
+	/**
+	 * Convenience method to determine if a given driver class name and url represents an
+	 * embedded database type.The exception is made for the H2 database for embedded
+	 * types.
+	 * @param driverClass the driver class
+	 * @param url the jdbc url
+	 * @return true if the driver class is one of the embedded types
+	 */
+	public static boolean isEmbedded(String driverClass, String url) {
+		return (driverClass != null
+				&& (matches(HSQL, driverClass) || (matches(H2, driverClass) && url.contains(":h2:mem"))
+						|| matches(DERBY, driverClass) || matches(HSQLDB, driverClass)));
+	}
+
 	private static boolean matches(EmbeddedDatabaseConnection candidate, String driverClass) {
 		return driverClass.equals(candidate.driverClass) || driverClass.equals(candidate.alternativeDriverClass);
 	}

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

@@ -78,4 +78,15 @@ void getUrlWithEmptyDatabaseNameForHsqldb() {
 				.withMessageContaining("DatabaseName must not be empty");
 	}
 
+	@Test
+	void isEmbeddedForh2CustomDatabaseName() {
+		assertThat(EmbeddedDatabaseConnection.isEmbedded("org.h2.Driver", "jdbc:h2:~/test")).isFalse();
+	}
+
+	@Test
+	void isEmbeddedForh2EmbeddedDatabaseName() {
+		assertThat(EmbeddedDatabaseConnection.isEmbedded("org.h2.Driver",
+				"jdbc:h2:mem:b3c7d078-1362-4be7-a088-e25dcc3aee32;DB_CLOSE_DELAY=-1")).isTrue();
+	}
+
 }