Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Throw a build exception if the deprecated datasource config is used #12141

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,12 @@ void build(
BuildProducer<NativeImageResourceBuildItem> resource,
BuildProducer<ExtensionSslNativeSupportBuildItem> sslNativeSupport,
BuildProducer<AggregatedDataSourceBuildTimeConfigBuildItem> aggregatedConfig) throws Exception {
if (dataSourcesBuildTimeConfig.driver.isPresent() || dataSourcesBuildTimeConfig.url.isPresent()) {
throw new ConfigurationException(
"quarkus.datasource.url and quarkus.datasource.driver have been deprecated in Quarkus 1.3 and removed in 1.9. "
+ "Please use the new datasource configuration as explained in https://quarkus.io/guides/datasource.");
}

List<AggregatedDataSourceBuildTimeConfigBuildItem> aggregatedDataSourceBuildTimeConfigs = getAggregatedConfigBuildItems(
dataSourcesBuildTimeConfig,
dataSourcesJdbcBuildTimeConfig,
Expand Down Expand Up @@ -252,7 +258,6 @@ private List<AggregatedDataSourceBuildTimeConfigBuildItem> getAggregatedConfigBu
List<JdbcDriverBuildItem> jdbcDriverBuildItems) {
List<AggregatedDataSourceBuildTimeConfigBuildItem> dataSources = new ArrayList<>();

// New configuration
if (dataSourcesBuildTimeConfig.defaultDataSource.dbKind.isPresent()) {
if (dataSourcesJdbcBuildTimeConfig.jdbc.enabled) {
dataSources.add(new AggregatedDataSourceBuildTimeConfigBuildItem(DataSourceUtil.DEFAULT_DATASOURCE_NAME,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
package io.quarkus.agroal.test;

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertTrue;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;

import io.quarkus.runtime.configuration.ConfigurationException;
import io.quarkus.test.QuarkusUnitTest;

public class DeprecatedDataSourceConfigTest {

@RegisterExtension
static final QuarkusUnitTest config = new QuarkusUnitTest()
.withConfigurationResource("application-deprecated-config.properties")
.assertException(e -> {
assertThat(e).isInstanceOf(ConfigurationException.class);
assertThat(e)
.hasMessageStartingWith("quarkus.datasource.url and quarkus.datasource.driver have been deprecated");
});

@Test
public void deprecatedConfigThrowsException() {
// Should not be reached: verify
assertTrue(false);
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
quarkus.datasource.driver=org.h2.Driver
quarkus.datasource.username=username-default
quarkus.datasource.url=jdbc:h2:tcp://localhost/mem:default
quarkus.datasource.max-size=13
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package io.quarkus.datasource.runtime;

import java.util.Map;
import java.util.Optional;

import io.quarkus.runtime.annotations.ConfigDocMapKey;
import io.quarkus.runtime.annotations.ConfigDocSection;
Expand Down Expand Up @@ -44,4 +45,22 @@ public class DataSourcesBuildTimeConfig {
@ConfigItem(name = "metrics.enabled")
public boolean metricsEnabled;

/**
* Only here to detect configuration errors.
* <p>
* This used to be runtime but we don't really care, we just want to catch invalid configurations.
*
* @deprecated
*/
@Deprecated
public Optional<String> url;

/**
* Only here to detect configuration errors.
*
* @deprecated
*/
@Deprecated
public Optional<String> driver;

}