Hacking

See gh-17582

Author: snicoll

spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/jdbc/QueryLessDatasourceHealthIndicator.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2012-2019 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.boot.actuate.jdbc;
+
+import java.sql.Connection;
+
+import javax.sql.DataSource;
+
+import org.springframework.boot.actuate.health.AbstractHealthIndicator;
+import org.springframework.boot.actuate.health.Health.Builder;
+import org.springframework.boot.actuate.health.HealthIndicator;
+import org.springframework.boot.actuate.health.Status;
+
+/**
+ * {@link HealthIndicator} that tests the status of a {@link DataSource} using
+ * {@link Connection#isValid(int) Connection#isValid}.
+ *
+ * @author Stephane Nicoll
+ * @since 2.3.0
+ */
+public class QueryLessDatasourceHealthIndicator extends AbstractHealthIndicator {
+
+	private final DataSource dataSource;
+
+	/**
+	 * Create a new instance with the {@link DataSource} to monitor.
+	 * @param dataSource the data source to monitor
+	 */
+	public QueryLessDatasourceHealthIndicator(DataSource dataSource) {
+		this.dataSource = dataSource;
+	}
+
+	@Override
+	protected void doHealthCheck(Builder builder) throws Exception {
+		try (Connection connection = this.dataSource.getConnection()) {
+			boolean valid = connection.isValid(0);
+			builder.status((valid) ? Status.UP : Status.DOWN);
+		}
+	}
+
+}

spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/jdbc/QueryLessDatasourceHealthIndicatorTests.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright 2012-2019 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.boot.actuate.jdbc;
+
+import org.junit.jupiter.api.Test;
+
+import org.springframework.boot.actuate.health.Health;
+import org.springframework.boot.actuate.health.Status;
+import org.springframework.boot.jdbc.EmbeddedDatabaseConnection;
+import org.springframework.jdbc.datasource.SingleConnectionDataSource;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link QueryLessDatasourceHealthIndicator}.
+ *
+ * @author Stephane Nicoll
+ */
+class QueryLessDatasourceHealthIndicatorTests {
+
+	@Test
+	void healthIndicatorWithDefaultSettings() {
+		EmbeddedDatabaseConnection db = EmbeddedDatabaseConnection.HSQL;
+		SingleConnectionDataSource dataSource = new SingleConnectionDataSource(db.getUrl("testdb") + ";shutdown=true",
+				"sa", "", false);
+		try {
+			dataSource.setDriverClassName(db.getDriverClassName());
+			QueryLessDatasourceHealthIndicator indicator = new QueryLessDatasourceHealthIndicator(dataSource);
+			Health health = indicator.health();
+			assertThat(health.getStatus()).isEqualTo(Status.UP);
+			assertThat(health.getDetails()).isEmpty();
+		}
+		finally {
+			dataSource.destroy();
+		}
+	}
+
+}