Add datasource meta-data for Commons DBCP2

Closes gh-4562

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/CommonsDbcp2DataSourcePoolMetadata.java

@@ -0,0 +1,57 @@
+/*
+ * Copyright 2012-2015 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
+ *
+ *      http://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.autoconfigure.jdbc.metadata;
+
+import javax.sql.DataSource;
+
+import org.apache.commons.dbcp2.BasicDataSource;
+
+/**
+ * {@link DataSourcePoolMetadata} for an Apache Commons DBCP2 {@link DataSource}.
+ *
+ * @author Stephane Nicoll
+ * @since 1.3.1
+ */
+public class CommonsDbcp2DataSourcePoolMetadata
+		extends AbstractDataSourcePoolMetadata<BasicDataSource> {
+
+	public CommonsDbcp2DataSourcePoolMetadata(BasicDataSource dataSource) {
+		super(dataSource);
+	}
+
+	@Override
+	public Integer getActive() {
+		return getDataSource().getNumActive();
+	}
+
+	@Override
+	public Integer getMax() {
+		return getDataSource().getMaxTotal();
+	}
+
+	@Override
+	public Integer getMin() {
+		return getDataSource().getMinIdle();
+	}
+
+	@Override
+	public String getValidationQuery() {
+		return getDataSource().getValidationQuery();
+	}
+
+}
+

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/DataSourcePoolMetadataProvidersConfiguration.java

@@ -98,4 +98,25 @@ public class DataSourcePoolMetadataProvidersConfiguration {
 
 	}
 
+	@Configuration
+	@ConditionalOnClass(org.apache.commons.dbcp2.BasicDataSource.class)
+	static class CommonsDbcp2PoolDataSourceMetadataProviderConfiguration {
+
+		@Bean
+		public DataSourcePoolMetadataProvider commonsDbcp2PoolDataSourceMetadataProvider() {
+			return new DataSourcePoolMetadataProvider() {
+				@Override
+				public DataSourcePoolMetadata getDataSourcePoolMetadata(
+						DataSource dataSource) {
+					if (dataSource instanceof org.apache.commons.dbcp2.BasicDataSource) {
+						return new CommonsDbcp2DataSourcePoolMetadata(
+								(org.apache.commons.dbcp2.BasicDataSource) dataSource);
+					}
+					return null;
+				}
+			};
+		}
+
+	}
+
 }

spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/jdbc/metadata/CommonsDbcp2DataSourcePoolMetadataTests.java

@@ -0,0 +1,96 @@
+/*
+ * Copyright 2012-2015 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
+ *
+ *      http://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.autoconfigure.jdbc.metadata;
+
+import org.apache.commons.dbcp2.BasicDataSource;
+import org.junit.Before;
+import org.junit.Test;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNull;
+
+/**
+ * Tests for {@link CommonsDbcp2DataSourcePoolMetadata}.
+ *
+ * @author Stephane Nicoll
+ */
+public class CommonsDbcp2DataSourcePoolMetadataTests
+		extends AbstractDataSourcePoolMetadataTests<CommonsDbcp2DataSourcePoolMetadata> {
+
+	private CommonsDbcp2DataSourcePoolMetadata dataSourceMetadata;
+
+	@Before
+	public void setup() {
+		this.dataSourceMetadata = createDataSourceMetadata(0, 2);
+	}
+
+	@Override
+	protected CommonsDbcp2DataSourcePoolMetadata getDataSourceMetadata() {
+		return this.dataSourceMetadata;
+	}
+
+	@Test
+	public void getPoolUsageWithNoCurrent() {
+		CommonsDbcp2DataSourcePoolMetadata dsm = new CommonsDbcp2DataSourcePoolMetadata(
+				createDataSource()) {
+			@Override
+			public Integer getActive() {
+				return null;
+			}
+		};
+		assertNull(dsm.getUsage());
+	}
+
+	@Test
+	public void getPoolUsageWithNoMax() {
+		CommonsDbcp2DataSourcePoolMetadata dsm = new CommonsDbcp2DataSourcePoolMetadata(
+				createDataSource()) {
+			@Override
+			public Integer getMax() {
+				return null;
+			}
+		};
+		assertNull(dsm.getUsage());
+	}
+
+	@Test
+	public void getPoolUsageWithUnlimitedPool() {
+		DataSourcePoolMetadata unlimitedDataSource = createDataSourceMetadata(0, -1);
+		assertEquals(Float.valueOf(-1F), unlimitedDataSource.getUsage());
+	}
+
+	@Override
+	public void getValidationQuery() {
+		BasicDataSource dataSource = createDataSource();
+		dataSource.setValidationQuery("SELECT FROM FOO");
+		assertEquals("SELECT FROM FOO",
+				new CommonsDbcp2DataSourcePoolMetadata(dataSource).getValidationQuery());
+	}
+
+	private CommonsDbcp2DataSourcePoolMetadata createDataSourceMetadata(int minSize,
+			int maxSize) {
+		BasicDataSource dataSource = createDataSource();
+		dataSource.setMinIdle(minSize);
+		dataSource.setMaxTotal(maxSize);
+		return new CommonsDbcp2DataSourcePoolMetadata(dataSource);
+	}
+
+	private BasicDataSource createDataSource() {
+		return (BasicDataSource) initializeBuilder().type(BasicDataSource.class).build();
+	}
+
+}