fix: allow ignored artifacts to find the default (#37498)

closes: #37128

Signed-off-by: Steve Hawkins <shawkins@redhat.com>
This commit is contained in:
Steven Hawkins 2025-02-20 08:51:27 -05:00 committed by GitHub
parent 5d77e7ea7d
commit 5e61b03b8e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 46 additions and 50 deletions

View File

@ -16,21 +16,19 @@
*/
package org.keycloak.quarkus.runtime.configuration;
import org.keycloak.common.Profile;
import org.keycloak.config.database.Database;
import static java.util.Collections.emptySet;
import static org.keycloak.quarkus.runtime.Environment.getCurrentOrCreateFeatureProfile;
import java.util.Collection;
import java.util.HashSet;
import org.keycloak.config.HealthOptions;
import org.keycloak.config.MetricsOptions;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import static java.util.Collections.emptySet;
import static org.keycloak.quarkus.runtime.Environment.getCurrentOrCreateFeatureProfile;
import org.keycloak.common.Profile;
import org.keycloak.config.HealthOptions;
import org.keycloak.config.MetricsOptions;
import org.keycloak.config.database.Database;
/**
* Ignore particular artifacts based on build configuration
@ -131,9 +129,10 @@ public class IgnoredArtifacts {
}
});
if (vendorsOfAllDatasources.isEmpty()) {
vendorsOfAllDatasources.add(Database.Vendor.H2);
}
// since the default may not be a known property name, look for it explicitly
Configuration.getOptionalValue("quarkus.datasource.db-kind")
.flatMap(Database::getVendor)
.ifPresent(vendorsOfAllDatasources::add);
final Set<String> jdbcArtifacts = vendorsOfAllDatasources.stream()
.map(vendor -> switch (vendor) {

View File

@ -17,15 +17,16 @@
package org.keycloak.quarkus.runtime.configuration.test;
import io.quarkus.runtime.LaunchMode;
import io.quarkus.runtime.configuration.ConfigUtils;
import io.smallrye.config.ConfigValue;
import io.smallrye.config.SmallRyeConfig;
import io.smallrye.config.SmallRyeConfigProviderResolver;
import io.smallrye.config.ConfigValue.ConfigValueBuilder;
import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.CoreMatchers.notNullValue;
import static org.hamcrest.MatcherAssert.assertThat;
import java.lang.reflect.Field;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;
import java.util.function.Function;
import org.eclipse.microprofile.config.ConfigProvider;
import org.eclipse.microprofile.config.spi.ConfigProviderResolver;
import org.junit.After;
import org.junit.BeforeClass;
import org.keycloak.Config;
@ -37,15 +38,9 @@ import org.keycloak.quarkus.runtime.configuration.MicroProfileConfigProvider;
import org.keycloak.quarkus.runtime.configuration.PersistedConfigSource;
import org.keycloak.quarkus.runtime.configuration.mappers.PropertyMappers;
import java.lang.reflect.Field;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;
import java.util.function.Function;
import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.CoreMatchers.notNullValue;
import static org.hamcrest.MatcherAssert.assertThat;
import io.smallrye.config.ConfigValue;
import io.smallrye.config.ConfigValue.ConfigValueBuilder;
import io.smallrye.config.SmallRyeConfig;
public abstract class AbstractConfigurationTest {

View File

@ -17,7 +17,6 @@
package org.keycloak.quarkus.runtime.configuration.test;
import org.hamcrest.CoreMatchers;
import org.junit.Test;
import org.keycloak.common.Profile;
import org.keycloak.common.profile.PropertiesProfileConfigResolver;
@ -30,6 +29,7 @@ import org.keycloak.quarkus.runtime.configuration.Configuration;
import org.keycloak.quarkus.runtime.configuration.IgnoredArtifacts;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.Properties;
import java.util.Set;
@ -37,8 +37,8 @@ import java.util.stream.Collectors;
import java.util.stream.Stream;
import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.CoreMatchers.not;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.Assert.assertTrue;
import static org.keycloak.quarkus.runtime.configuration.IgnoredArtifacts.JDBC_H2;
import static org.keycloak.quarkus.runtime.configuration.IgnoredArtifacts.JDBC_MARIADB;
import static org.keycloak.quarkus.runtime.configuration.IgnoredArtifacts.JDBC_MSSQL;
@ -72,7 +72,7 @@ public class IgnoredArtifactsTest extends AbstractConfigurationTest {
@Test
public void jdbcH2() {
assertJdbc("h2", JDBC_H2);
assertJdbc("dev-file", JDBC_H2);
}
@Test
@ -100,15 +100,15 @@ public class IgnoredArtifactsTest extends AbstractConfigurationTest {
assertJdbc("postgres", JDBC_POSTGRES);
}
// default ignored JDBC artifacts specified in quarkus.properties
private static final Set<String> IGNORED_JDBC_FROM_PROPS = Stream.of(JDBC_MARIADB, JDBC_POSTGRES)
// default not ignored JDBC artifacts specified in quarkus.properties
private static final Set<String> NOT_IGNORED_JDBC_FROM_PROPS = Stream.of(JDBC_MARIADB, JDBC_POSTGRES)
.flatMap(Collection::stream)
.collect(Collectors.toSet());
@Test
public void multipleDatasources() {
// initialize the test with a default database
ConfigArgsConfigSource.setCliArgs("--db=dev-file");
ConfigArgsConfigSource.setCliArgs("");
createConfig();
var defaultDS = Configuration.getOptionalValue("quarkus.datasource.db-kind");
@ -123,27 +123,29 @@ public class IgnoredArtifactsTest extends AbstractConfigurationTest {
assertThat(catStoreDS.isPresent(), is(true));
assertThat(catStoreDS.get(), is("postgresql"));
assertJdbc("h2", JDBC_H2);
assertNotIgnored("dev-file", JDBC_H2);
}
private void assertJdbc(String vendor, Set<String> notIgnored) {
var notIgnoredWithDefaults = new HashSet<>(notIgnored);
notIgnoredWithDefaults.addAll(IGNORED_JDBC_FROM_PROPS);
setSystemProperty(NS_KEYCLOAK_PREFIX + DatabaseOptions.DB.getKey(), vendor, () -> {
final var resultArtifacts = IgnoredArtifacts.getDefaultIgnoredArtifacts();
assertThat(String.format("Ignored artifacts does not comply with the specified artifacts for '%s' JDBC driver", vendor),
resultArtifacts,
not(CoreMatchers.hasItems(notIgnoredWithDefaults.toArray(new String[0]))));
final var includedArtifacts = new HashSet<>(IgnoredArtifacts.JDBC_DRIVERS);
includedArtifacts.removeAll(notIgnoredWithDefaults);
assertThat("Ignored artifacts does not contain items for the other JDBC drivers",
resultArtifacts,
CoreMatchers.hasItems(includedArtifacts.toArray(new String[0])));
private void assertJdbc(String db, Set<String> notIgnored) {
setSystemProperty(NS_KEYCLOAK_PREFIX + DatabaseOptions.DB.getKey(), db, () -> {
assertNotIgnored(db, notIgnored);
});
}
private void assertNotIgnored(String db, Set<String> notIgnored) {
var notIgnoredWithDefaults = new HashSet<>(notIgnored);
notIgnoredWithDefaults.addAll(NOT_IGNORED_JDBC_FROM_PROPS);
final var actualIgnoredArtifacts = IgnoredArtifacts.getDefaultIgnoredArtifacts();
assertTrue(String.format("Ignored artifacts does not comply with the specified artifacts for '%s' JDBC driver",
db), Collections.disjoint(actualIgnoredArtifacts, notIgnored));
final var allIgnoredArtifacts = new HashSet<>(IgnoredArtifacts.JDBC_DRIVERS);
allIgnoredArtifacts.removeAll(notIgnoredWithDefaults);
assertThat("Ignored artifacts does not contain items for the other JDBC drivers",
actualIgnoredArtifacts.containsAll(allIgnoredArtifacts));
}
@Test
public void health() {
assertIgnoredArtifacts(IgnoredArtifacts.HEALTH, HealthOptions.HEALTH_ENABLED);