From edfe5d2f18c7a746bedff350d9cdbc4ec13f7222 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kevin=20Sch=C3=B6nfeld?= Date: Wed, 22 Jun 2022 20:44:04 +0200 Subject: [PATCH 1/2] Fix DataSourceUtils inconsistent exception handling Align IllegalStateException with SQLException handling and propagate the original exception. See gh-28669 Co-authored-by: Christoph Mies --- .../CannotGetJdbcConnectionException.java | 3 + .../jdbc/datasource/DataSourceUtils.java | 4 +- .../jdbc/datasource/DataSourceUtilsTests.java | 60 +++++++++++++++++++ 3 files changed, 65 insertions(+), 2 deletions(-) create mode 100644 spring-jdbc/src/test/java/org/springframework/jdbc/datasource/DataSourceUtilsTests.java diff --git a/spring-jdbc/src/main/java/org/springframework/jdbc/CannotGetJdbcConnectionException.java b/spring-jdbc/src/main/java/org/springframework/jdbc/CannotGetJdbcConnectionException.java index bbac56f6e6..28b6c21140 100644 --- a/spring-jdbc/src/main/java/org/springframework/jdbc/CannotGetJdbcConnectionException.java +++ b/spring-jdbc/src/main/java/org/springframework/jdbc/CannotGetJdbcConnectionException.java @@ -48,4 +48,7 @@ public class CannotGetJdbcConnectionException extends DataAccessResourceFailureE super(msg, ex); } + public CannotGetJdbcConnectionException(String msg, IllegalStateException ex) { + super(msg, ex); + } } diff --git a/spring-jdbc/src/main/java/org/springframework/jdbc/datasource/DataSourceUtils.java b/spring-jdbc/src/main/java/org/springframework/jdbc/datasource/DataSourceUtils.java index ae708030bc..8452c89fc7 100644 --- a/spring-jdbc/src/main/java/org/springframework/jdbc/datasource/DataSourceUtils.java +++ b/spring-jdbc/src/main/java/org/springframework/jdbc/datasource/DataSourceUtils.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2021 the original author or authors. + * Copyright 2002-2022 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. @@ -83,7 +83,7 @@ public abstract class DataSourceUtils { throw new CannotGetJdbcConnectionException("Failed to obtain JDBC Connection", ex); } catch (IllegalStateException ex) { - throw new CannotGetJdbcConnectionException("Failed to obtain JDBC Connection: " + ex.getMessage()); + throw new CannotGetJdbcConnectionException("Failed to obtain JDBC Connection", ex); } } diff --git a/spring-jdbc/src/test/java/org/springframework/jdbc/datasource/DataSourceUtilsTests.java b/spring-jdbc/src/test/java/org/springframework/jdbc/datasource/DataSourceUtilsTests.java new file mode 100644 index 0000000000..67f9129943 --- /dev/null +++ b/spring-jdbc/src/test/java/org/springframework/jdbc/datasource/DataSourceUtilsTests.java @@ -0,0 +1,60 @@ +/* + * Copyright 2002-2022 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 + * + * https://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.jdbc.datasource; + +import java.sql.SQLException; + +import javax.sql.DataSource; + +import org.junit.jupiter.api.Test; + +import org.springframework.jdbc.CannotGetJdbcConnectionException; + +import static org.assertj.core.api.Assertions.assertThatThrownBy; +import static org.mockito.BDDMockito.when; +import static org.mockito.Mockito.mock; + +/** + * @author Kevin Schoenfeld + * @see org.springframework.jdbc.datasource.DataSourceUtilsTests + * @since 21.06.2022 + */ + +class DataSourceUtilsTests { + + @Test + void testConnectionNotAcquiredExceptionIsPropagated() throws SQLException { + final DataSource dataSource = mock(DataSource.class); + when(dataSource.getConnection()).thenReturn(null); + + assertThatThrownBy(() -> DataSourceUtils.getConnection(dataSource)) + .isInstanceOf(CannotGetJdbcConnectionException.class) + .hasMessageStartingWith("Failed to obtain JDBC Connection") + .hasCauseInstanceOf(IllegalStateException.class); + } + + @Test + void testConnectionSQLExceptionIsPropagated() throws SQLException { + final DataSource dataSource = mock(DataSource.class); + when(dataSource.getConnection()).thenThrow(new SQLException("my dummy exception")); + + assertThatThrownBy(() -> DataSourceUtils.getConnection(dataSource)) + .isInstanceOf(CannotGetJdbcConnectionException.class) + .hasMessageStartingWith("Failed to obtain JDBC Connection") + .hasCauseInstanceOf(SQLException.class); + } +} From e98b602d4fd121097ebc8f74ec2dcbcb9c3afd1f Mon Sep 17 00:00:00 2001 From: Stephane Nicoll Date: Thu, 23 Jun 2022 08:59:42 +0200 Subject: [PATCH 2/2] Polish "Fix DataSourceUtils inconsistent exception handling" See gh-28669 --- .../jdbc/CannotGetJdbcConnectionException.java | 7 ++++++- .../jdbc/datasource/DataSourceUtilsTests.java | 17 +++++++++-------- 2 files changed, 15 insertions(+), 9 deletions(-) diff --git a/spring-jdbc/src/main/java/org/springframework/jdbc/CannotGetJdbcConnectionException.java b/spring-jdbc/src/main/java/org/springframework/jdbc/CannotGetJdbcConnectionException.java index 28b6c21140..a8b87b760e 100644 --- a/spring-jdbc/src/main/java/org/springframework/jdbc/CannotGetJdbcConnectionException.java +++ b/spring-jdbc/src/main/java/org/springframework/jdbc/CannotGetJdbcConnectionException.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2018 the original author or authors. + * Copyright 2002-2022 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. @@ -48,6 +48,11 @@ public class CannotGetJdbcConnectionException extends DataAccessResourceFailureE super(msg, ex); } + /** + * Constructor for CannotGetJdbcConnectionException. + * @param msg the detail message + * @param ex the root cause IllegalStateException + */ public CannotGetJdbcConnectionException(String msg, IllegalStateException ex) { super(msg, ex); } diff --git a/spring-jdbc/src/test/java/org/springframework/jdbc/datasource/DataSourceUtilsTests.java b/spring-jdbc/src/test/java/org/springframework/jdbc/datasource/DataSourceUtilsTests.java index 67f9129943..399b6894bc 100644 --- a/spring-jdbc/src/test/java/org/springframework/jdbc/datasource/DataSourceUtilsTests.java +++ b/spring-jdbc/src/test/java/org/springframework/jdbc/datasource/DataSourceUtilsTests.java @@ -29,18 +29,17 @@ import static org.mockito.BDDMockito.when; import static org.mockito.Mockito.mock; /** + * Tests for {@link DataSourceUtils}. + * * @author Kevin Schoenfeld - * @see org.springframework.jdbc.datasource.DataSourceUtilsTests - * @since 21.06.2022 + * @author Stephane Nicoll */ - class DataSourceUtilsTests { @Test void testConnectionNotAcquiredExceptionIsPropagated() throws SQLException { - final DataSource dataSource = mock(DataSource.class); + DataSource dataSource = mock(DataSource.class); when(dataSource.getConnection()).thenReturn(null); - assertThatThrownBy(() -> DataSourceUtils.getConnection(dataSource)) .isInstanceOf(CannotGetJdbcConnectionException.class) .hasMessageStartingWith("Failed to obtain JDBC Connection") @@ -49,12 +48,14 @@ class DataSourceUtilsTests { @Test void testConnectionSQLExceptionIsPropagated() throws SQLException { - final DataSource dataSource = mock(DataSource.class); + DataSource dataSource = mock(DataSource.class); when(dataSource.getConnection()).thenThrow(new SQLException("my dummy exception")); - assertThatThrownBy(() -> DataSourceUtils.getConnection(dataSource)) .isInstanceOf(CannotGetJdbcConnectionException.class) .hasMessageStartingWith("Failed to obtain JDBC Connection") - .hasCauseInstanceOf(SQLException.class); + .cause().isInstanceOf(SQLException.class) + .hasMessage("my dummy exception"); } + } +