Improve JDBC driver dependency management and class name test coverage

Previously, the DatabaseDriver enumeration contained entries for
some databases without having dependency management for the database
driver dependency. This leads to the possibility of a user inadvertently
using the wrong version of a driver where the class names do not match
those listed in the enumeration. A further problem is that we do not
test that the class names listed in the enumeration match the
names of Driver and XADataSource implementations in the database driver.

This commit completes the database driver dependency management so that
dependency management is provided for every driver that is both listed
in DatabaseDriver and available in Maven Central. It also adds tests
for DatabaseDriver that ensures that each class that is listed exists
and implements the required interface (java.sql.Driver or
javax.sql.XADataSource).

Closes gh-4946

spring-boot-dependencies/pom.xml

@@ -45,6 +45,7 @@
 	<properties>
 		<activemq.version>5.12.2</activemq.version>
 		<antlr2.version>2.7.7</antlr2.version>
+		<appengine.version>1.9.31</appengine.version>
 		<artemis.version>1.1.0</artemis.version>
 		<aspectj.version>1.8.8</aspectj.version>
 		<assertj.version>2.3.0</assertj.version>
@@ -106,6 +107,7 @@
 		<jsonassert.version>1.2.3</jsonassert.version>
 		<json-path.version>2.0.0</json-path.version>
 		<jstl.version>1.2</jstl.version>
+		<jtds.version>1.3.1</jtds.version>
 		<junit.version>4.12</junit.version>
 		<liquibase.version>3.4.2</liquibase.version>
 		<log4j2.version>2.4.1</log4j2.version>
@@ -147,6 +149,7 @@
 		<spring-social-linkedin.version>1.0.2.RELEASE</spring-social-linkedin.version>
 		<spring-social-twitter.version>1.1.2.RELEASE</spring-social-twitter.version>
 		<spring-ws.version>2.2.3.RELEASE</spring-ws.version>
+		<sqlite-jdbc.version>3.8.11.2</sqlite-jdbc.version>
 		<statsd-client.version>3.1.0</statsd-client.version>
 		<sun-mail.version>${javax-mail.version}</sun-mail.version>
 		<thymeleaf.version>2.1.4.RELEASE</thymeleaf.version>
@@ -615,6 +618,11 @@
 				<artifactId>thymeleaf-extras-data-attribute</artifactId>
 				<version>${thymeleaf-extras-data-attribute.version}</version>
 			</dependency>
+			<dependency>
+				<groupId>com.google.appengine</groupId>
+				<artifactId>appengine-api-1.0-sdk</artifactId>
+				<version>${appengine.version}</version>
+			</dependency>
 			<dependency>
 				<groupId>com.google.code.gson</groupId>
 				<artifactId>gson</artifactId>
@@ -873,6 +881,11 @@
 				<artifactId>ehcache</artifactId>
 				<version>${ehcache.version}</version>
 			</dependency>
+			<dependency>
+				<groupId>net.sourceforge.jtds</groupId>
+				<artifactId>jtds</artifactId>
+				<version>${jtds.version}</version>
+			</dependency>
 			<dependency>
 				<groupId>net.sourceforge.nekohtml</groupId>
 				<artifactId>nekohtml</artifactId>
@@ -1980,6 +1993,11 @@
 					</exclusion>
 				</exclusions>
 			</dependency>
+			<dependency>
+				<groupId>org.xerial</groupId>
+				<artifactId>sqlite-jdbc</artifactId>
+				<version>${sqlite-jdbc.version}</version>
+			</dependency>
 			<dependency>
 				<groupId>org.thymeleaf</groupId>
 				<artifactId>thymeleaf</artifactId>

spring-boot/pom.xml

@@ -231,11 +231,56 @@
 			<optional>true</optional>
 		</dependency>
 		<!-- Test -->
+		<dependency>
+			<groupId>com.google.appengine</groupId>
+			<artifactId>appengine-api-1.0-sdk</artifactId>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>com.h2database</groupId>
+			<artifactId>h2</artifactId>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>mysql</groupId>
+			<artifactId>mysql-connector-java</artifactId>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>net.sourceforge.jtds</groupId>
+			<artifactId>jtds</artifactId>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.apache.derby</groupId>
+			<artifactId>derby</artifactId>
+			<scope>test</scope>
+		</dependency>
 		<dependency>
 			<groupId>org.apache.httpcomponents</groupId>
 			<artifactId>httpasyncclient</artifactId>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+			<groupId>org.firebirdsql.jdbc</groupId>
+			<artifactId>jaybird-jdk18</artifactId>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.hsqldb</groupId>
+			<artifactId>hsqldb</artifactId>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.mariadb.jdbc</groupId>
+			<artifactId>mariadb-java-client</artifactId>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.postgresql</groupId>
+			<artifactId>postgresql</artifactId>
+			<scope>test</scope>
+		</dependency>
 		<dependency>
 			<groupId>org.slf4j</groupId>
 			<artifactId>jcl-over-slf4j</artifactId>
@@ -251,6 +296,11 @@
 			<artifactId>spring-data-redis</artifactId>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+			<groupId>org.xerial</groupId>
+			<artifactId>sqlite-jdbc</artifactId>
+			<scope>test</scope>
+		</dependency>
 	</dependencies>
 	<build>
 		<plugins>

spring-boot/src/test/java/org/springframework/boot/jdbc/DatabaseDriverClassNameTests.java

+/*
+ * Copyright 2012-2016 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.jdbc;
+
+import java.io.IOException;
+import java.sql.Driver;
+import java.util.ArrayList;
+import java.util.EnumSet;
+import java.util.List;
+
+import javax.sql.XADataSource;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.Parameterized;
+import org.junit.runners.Parameterized.Parameters;
+
+import org.springframework.asm.ClassReader;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for the class names in the {@link DatabaseDriver} enumeration.
+ *
+ * @author Andy Wilkinson
+ */
+@RunWith(Parameterized.class)
+public class DatabaseDriverClassNameTests {
+
+	private static final EnumSet<DatabaseDriver> excludedDrivers = EnumSet.of(
+			DatabaseDriver.UNKNOWN, DatabaseDriver.ORACLE, DatabaseDriver.SQLSERVER,
+			DatabaseDriver.DB2, DatabaseDriver.DB2_AS400, DatabaseDriver.INFORMIX,
+			DatabaseDriver.TERADATA);
+
+	private final String className;
+
+	private final Class<?> requiredType;
+
+	@Parameters(name = "{0} {2}")
+	public static List<Object[]> parameters() {
+		DatabaseDriver[] databaseDrivers = DatabaseDriver.values();
+		List<Object[]> parameters = new ArrayList<Object[]>();
+		for (DatabaseDriver databaseDriver : databaseDrivers) {
+			if (excludedDrivers.contains(databaseDriver)) {
+				continue;
+			}
+			parameters.add(new Object[] { databaseDriver,
+					databaseDriver.getDriverClassName(), Driver.class });
+			if (databaseDriver.getXaDataSourceClassName() != null) {
+				parameters.add(new Object[] { databaseDriver,
+						databaseDriver.getXaDataSourceClassName(), XADataSource.class });
+			}
+		}
+		return parameters;
+	}
+
+	public DatabaseDriverClassNameTests(DatabaseDriver driver, String className,
+			Class<?> requiredType) {
+		this.className = className;
+		this.requiredType = requiredType;
+	}
+
+	@Test
+	public void databaseClassIsOfRequiredType() throws Exception {
+		assertThat(getInterfaceNames(this.className.replace('.', '/'))
+				.contains(this.requiredType.getName().replace('.', '/')));
+	}
+
+	private List<String> getInterfaceNames(String className) throws IOException {
+		// Use ASM to avoid unwanted side-effects of loading JDBC drivers
+		ClassReader classReader = new ClassReader(
+				getClass().getResourceAsStream("/" + className + ".class"));
+		List<String> interfaceNames = new ArrayList<String>();
+		for (String name : classReader.getInterfaces()) {
+			interfaceNames.add(name);
+			interfaceNames.addAll(getInterfaceNames(name));
+		}
+		return interfaceNames;
+	}
+
+}