Merge pull request #9355 from michael-simons:jooqAutoconfigurationImprovements
* pr/9355: Polish jOOQ auto-configuration Polish "Auto-detect jOOQ dialect" Auto-detect jOOQ dialectpull/9227/merge
Stephane Nicoll
8 years ago
commit
80ee2a8c30
@ -0,0 +1,82 @@
|
||||
/*
|
||||
* Copyright 2012-2017 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.jooq;
|
||||
|
||||
import java.util.Collections;
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
|
||||
import javax.sql.DataSource;
|
||||
|
||||
import org.apache.commons.logging.Log;
|
||||
import org.apache.commons.logging.LogFactory;
|
||||
import org.jooq.SQLDialect;
|
||||
|
||||
import org.springframework.boot.jdbc.DatabaseDriver;
|
||||
import org.springframework.jdbc.support.JdbcUtils;
|
||||
import org.springframework.jdbc.support.MetaDataAccessException;
|
||||
|
||||
/**
|
||||
* Utility to lookup well known {@link SQLDialect SQLDialects} from a {@link DataSource}.
|
||||
*
|
||||
* @author Michael Simons
|
||||
*/
|
||||
final class SqlDialectLookup {
|
||||
|
||||
private static final Log logger = LogFactory.getLog(SqlDialectLookup.class);
|
||||
|
||||
private static final Map<DatabaseDriver, SQLDialect> LOOKUP;
|
||||
|
||||
static {
|
||||
Map<DatabaseDriver, SQLDialect> map = new HashMap<>();
|
||||
map.put(DatabaseDriver.DERBY, SQLDialect.DERBY);
|
||||
map.put(DatabaseDriver.H2, SQLDialect.H2);
|
||||
map.put(DatabaseDriver.HSQLDB, SQLDialect.HSQLDB);
|
||||
map.put(DatabaseDriver.MARIADB, SQLDialect.MARIADB);
|
||||
map.put(DatabaseDriver.MYSQL, SQLDialect.MYSQL);
|
||||
map.put(DatabaseDriver.POSTGRESQL, SQLDialect.POSTGRES);
|
||||
map.put(DatabaseDriver.SQLITE, SQLDialect.SQLITE);
|
||||
LOOKUP = Collections.unmodifiableMap(map);
|
||||
}
|
||||
|
||||
private SqlDialectLookup() {
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the most suitable {@link SQLDialect} for the given {@link DataSource}.
|
||||
* @param dataSource the source {@link DataSource}
|
||||
* @return the most suitable {@link SQLDialect}
|
||||
*/
|
||||
public static SQLDialect getDialect(DataSource dataSource) {
|
||||
if (dataSource == null) {
|
||||
return SQLDialect.DEFAULT;
|
||||
}
|
||||
try {
|
||||
String url = (String) JdbcUtils.extractDatabaseMetaData(dataSource, "getURL");
|
||||
DatabaseDriver driver = DatabaseDriver.fromJdbcUrl(url);
|
||||
SQLDialect sQLDialect = LOOKUP.get(driver);
|
||||
if (sQLDialect != null) {
|
||||
return sQLDialect;
|
||||
}
|
||||
}
|
||||
catch (MetaDataAccessException ex) {
|
||||
logger.warn("Unable to determine jdbc url from datasource", ex);
|
||||
}
|
||||
return SQLDialect.DEFAULT;
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,125 @@
|
||||
/*
|
||||
* Copyright 2012-2017 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.jooq;
|
||||
|
||||
import java.sql.Connection;
|
||||
import java.sql.DatabaseMetaData;
|
||||
import java.sql.SQLException;
|
||||
|
||||
import javax.sql.DataSource;
|
||||
|
||||
import org.jooq.SQLDialect;
|
||||
import org.junit.After;
|
||||
import org.junit.Test;
|
||||
|
||||
import org.springframework.boot.context.properties.EnableConfigurationProperties;
|
||||
import org.springframework.boot.test.util.TestPropertyValues;
|
||||
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.mockito.BDDMockito.given;
|
||||
import static org.mockito.Mockito.mock;
|
||||
import static org.mockito.Mockito.never;
|
||||
import static org.mockito.Mockito.verify;
|
||||
|
||||
/**
|
||||
* Tests for {@link JooqProperties}.
|
||||
*
|
||||
* @author Stephane Nicoll
|
||||
*/
|
||||
public class JooqPropertiesTest {
|
||||
|
||||
private AnnotationConfigApplicationContext context;
|
||||
|
||||
@After
|
||||
public void close() {
|
||||
if (this.context != null) {
|
||||
this.context.close();
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void determineSqlDialectNoCheckIfDialectIsSet() throws SQLException {
|
||||
JooqProperties properties = load("spring.jooq.sql-dialect=postgres");
|
||||
DataSource dataSource = mockStandaloneDataSource();
|
||||
SQLDialect sqlDialect = properties.determineSqlDialect(dataSource);
|
||||
assertThat(sqlDialect).isEqualTo(SQLDialect.POSTGRES);
|
||||
verify(dataSource, never()).getConnection();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void determineSqlDialectWithKnownUrl() {
|
||||
JooqProperties properties = load();
|
||||
SQLDialect sqlDialect = properties
|
||||
.determineSqlDialect(mockDataSource("jdbc:h2:mem:testdb"));
|
||||
assertThat(sqlDialect).isEqualTo(SQLDialect.H2);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void determineSqlDialectWithKnownUrlAndUserConfig() {
|
||||
JooqProperties properties = load("spring.jooq.sql-dialect=mysql");
|
||||
SQLDialect sqlDialect = properties
|
||||
.determineSqlDialect(mockDataSource("jdbc:h2:mem:testdb"));
|
||||
assertThat(sqlDialect).isEqualTo(SQLDialect.MYSQL);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void determineSqlDialectWithUnknownUrl() {
|
||||
JooqProperties properties = load();
|
||||
SQLDialect sqlDialect = properties
|
||||
.determineSqlDialect(mockDataSource("jdbc:unknown://localhost"));
|
||||
assertThat(sqlDialect).isEqualTo(SQLDialect.DEFAULT);
|
||||
}
|
||||
|
||||
private DataSource mockStandaloneDataSource() throws SQLException {
|
||||
DataSource ds = mock(DataSource.class);
|
||||
given(ds.getConnection()).willThrow(SQLException.class);
|
||||
return ds;
|
||||
}
|
||||
|
||||
private DataSource mockDataSource(String jdbcUrl) {
|
||||
DataSource ds = mock(DataSource.class);
|
||||
try {
|
||||
DatabaseMetaData metadata = mock(DatabaseMetaData.class);
|
||||
given(metadata.getURL()).willReturn(jdbcUrl);
|
||||
Connection connection = mock(Connection.class);
|
||||
given(connection.getMetaData()).willReturn(metadata);
|
||||
given(ds.getConnection()).willReturn(connection);
|
||||
}
|
||||
catch (SQLException e) {
|
||||
// Do nothing
|
||||
}
|
||||
return ds;
|
||||
}
|
||||
|
||||
private JooqProperties load(String... environment) {
|
||||
AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
|
||||
TestPropertyValues.of(environment).applyTo(ctx);
|
||||
ctx.register(TestConfiguration.class);
|
||||
ctx.refresh();
|
||||
this.context = ctx;
|
||||
return this.context.getBean(JooqProperties.class);
|
||||
}
|
||||
|
||||
@Configuration
|
||||
@EnableConfigurationProperties(JooqProperties.class)
|
||||
static class TestConfiguration {
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,105 @@
|
||||
/*
|
||||
* Copyright 2012-2017 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.jooq;
|
||||
|
||||
import java.sql.Connection;
|
||||
import java.sql.DatabaseMetaData;
|
||||
|
||||
import javax.sql.DataSource;
|
||||
|
||||
import org.jooq.SQLDialect;
|
||||
import org.junit.Test;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.mockito.BDDMockito.given;
|
||||
import static org.mockito.Mockito.mock;
|
||||
|
||||
/**
|
||||
* Tests for {@link SqlDialectLookup}.
|
||||
*
|
||||
* @author Michael Simons
|
||||
* @author Stephane Nicoll
|
||||
*/
|
||||
public class SqlDialectLookupTests {
|
||||
|
||||
@Test
|
||||
public void getSqlDialectWhenDataSourceIsNullShouldReturnDefault() throws Exception {
|
||||
assertThat(SqlDialectLookup.getDialect(null)).isEqualTo(SQLDialect.DEFAULT);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getSqlDialectWhenDataSourceIsUnknownShouldReturnDefault() throws Exception {
|
||||
testGetSqlDialect("jdbc:idontexist:", SQLDialect.DEFAULT);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getSqlDialectWhenDerbyShouldReturnDerby() throws Exception {
|
||||
testGetSqlDialect("jdbc:derby:", SQLDialect.DERBY);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getSqlDialectWhenH2ShouldReturnH2() throws Exception {
|
||||
testGetSqlDialect("jdbc:h2:", SQLDialect.H2);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getSqlDialectWhenHsqldbShouldReturnHsqldb() throws Exception {
|
||||
testGetSqlDialect("jdbc:hsqldb:", SQLDialect.HSQLDB);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getSqlDialectWhenMysqlShouldReturnMysql() throws Exception {
|
||||
testGetSqlDialect("jdbc:mysql:", SQLDialect.MYSQL);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getSqlDialectWhenOracleShouldReturnOracle() throws Exception {
|
||||
testGetSqlDialect("jdbc:oracle:", SQLDialect.DEFAULT);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getSqlDialectWhenPostgresShouldReturnPostgres() throws Exception {
|
||||
testGetSqlDialect("jdbc:postgresql:", SQLDialect.POSTGRES);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getSqlDialectWhenSqlserverShouldReturnSqlserver() throws Exception {
|
||||
testGetSqlDialect("jdbc:sqlserver:", SQLDialect.DEFAULT);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getSqlDialectWhenDb2ShouldReturnDb2() throws Exception {
|
||||
testGetSqlDialect("jdbc:db2:", SQLDialect.DEFAULT);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getSqlDialectWhenInformixShouldReturnInformix() throws Exception {
|
||||
testGetSqlDialect("jdbc:informix-sqli:", SQLDialect.DEFAULT);
|
||||
}
|
||||
|
||||
private void testGetSqlDialect(String url, SQLDialect expected) throws Exception {
|
||||
DataSource dataSource = mock(DataSource.class);
|
||||
Connection connection = mock(Connection.class);
|
||||
DatabaseMetaData metaData = mock(DatabaseMetaData.class);
|
||||
given(dataSource.getConnection()).willReturn(connection);
|
||||
given(connection.getMetaData()).willReturn(metaData);
|
||||
given(metaData.getURL()).willReturn(url);
|
||||
SQLDialect sqlDialect = SqlDialectLookup.getDialect(dataSource);
|
||||
assertThat(sqlDialect).isEqualTo(expected);
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue