Don't attempt to set null values

Update `DataSourceBuilder` so that setters are not longer called for `null` values. This restores Spring Boot 2.4 behavior. Fixes gh-26633 Co-authored-by: Phillip Webb <pwebb@vmware.com>
spring-projects · May 26, 2021 · c679b4c · c679b4c
1 parent a31e976
commit c679b4c
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 2 deletions.
diff --git a/...ot-project/spring-boot/src/main/java/org/springframework/boot/jdbc/DataSourceBuilder.java b/...ot-project/spring-boot/src/main/java/org/springframework/boot/jdbc/DataSourceBuilder.java
@@ -176,8 +176,10 @@ public T build() {
 		for (DataSourceProperty property : DataSourceProperty.values()) {
 			if (this.values.containsKey(property)) {
 				String value = this.values.get(property);
-				properties.set(dataSource, property, value);
-				applied.add(property);
+				if (value != null) {
+					properties.set(dataSource, property, value);
+					applied.add(property);
+				}
 			}
 			else if (deriveFromProperties != null && properties.canSet(property)) {
 				String value = deriveFromProperties.get(this.deriveFrom, property);

diff --git a/...oject/spring-boot/src/test/java/org/springframework/boot/jdbc/DataSourceBuilderTests.java b/...oject/spring-boot/src/test/java/org/springframework/boot/jdbc/DataSourceBuilderTests.java
@@ -73,13 +73,28 @@ void buildWhenHikariAvailableReturnsHikariDataSource() {
 		assertThat(hikariDataSource.getJdbcUrl()).isEqualTo("jdbc:h2:test");
 	}
 
+	@Test // gh-26633
+	void buildWhenHikariDataSourceWithNullPasswordReturnsHikariDataSource() {
+		this.dataSource = DataSourceBuilder.create().url("jdbc:h2:test").username("test").password(null).build();
+		assertThat(this.dataSource).isInstanceOf(HikariDataSource.class);
+		HikariDataSource hikariDataSource = (HikariDataSource) this.dataSource;
+		assertThat(hikariDataSource.getJdbcUrl()).isEqualTo("jdbc:h2:test");
+	}
+
 	@Test
 	void buildWhenHikariNotAvailableReturnsTomcatDataSource() {
 		this.dataSource = DataSourceBuilder.create(new HidePackagesClassLoader("com.zaxxer.hikari")).url("jdbc:h2:test")
 				.build();
 		assertThat(this.dataSource).isInstanceOf(org.apache.tomcat.jdbc.pool.DataSource.class);
 	}
 
+	@Test // gh-26633
+	void buildWhenTomcatDataSourceWithNullPasswordReturnsDataSource() {
+		this.dataSource = DataSourceBuilder.create(new HidePackagesClassLoader("com.zaxxer.hikari")).url("jdbc:h2:test")
+				.username("test").password(null).build();
+		assertThat(this.dataSource).isInstanceOf(org.apache.tomcat.jdbc.pool.DataSource.class);
+	}
+
 	@Test
 	void buildWhenHikariAndTomcatNotAvailableReturnsDbcp2DataSource() {
 		this.dataSource = DataSourceBuilder
@@ -88,6 +103,14 @@ void buildWhenHikariAndTomcatNotAvailableReturnsDbcp2DataSource() {
 		assertThat(this.dataSource).isInstanceOf(BasicDataSource.class);
 	}
 
+	@Test // gh-26633
+	void buildWhenDbcp2DataSourceWithNullPasswordReturnsDbcp2DataSource() {
+		this.dataSource = DataSourceBuilder
+				.create(new HidePackagesClassLoader("com.zaxxer.hikari", "org.apache.tomcat.jdbc.pool"))
+				.url("jdbc:h2:test").username("test").password(null).build();
+		assertThat(this.dataSource).isInstanceOf(BasicDataSource.class);
+	}
+
 	@Test
 	void buildWhenHikariAndTomcatAndDbcpNotAvailableReturnsOracleUcpDataSource() {
 		this.dataSource = DataSourceBuilder.create(new HidePackagesClassLoader("com.zaxxer.hikari",