8000 fix: generalizing the augmentation check by shawkins · Pull Request #47748 · keycloak/keycloak · GitHub
[go: up one dir, main page]
Skip to content

fix: generalizing the augmentation check #47748

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.

Sign up for GitHub

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

Merged
vmuzikar merged 1 commit into from
Apr 29, 2026
Merged

fix: generalizing the augmentation check #47748

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 0 additions & 1 deletion quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/Environment.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ public final class Environment {

public static final String KC_CONFIG_REBUILD_CHECK = "kc.config.rebuild-check";
public static final String KC_CONFIG_BUILT = "kc.config.built";
public static final String KC_TEST_REBUILD = "kc.test.rebuild";
public static final String KC_HOME_DIR = "kc.home.dir";
public static final String PROFILE ="kc.profile";
public static final String ENV_PROFILE ="KC_PROFILE";
Expand Down
4 changes: 2 additions & 2 deletions ...ain/java/org/keycloak/quarkus/runtime/configuration/NestedPropertyMappingInterceptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,8 @@ public static Optional<String> getResolvingRoot() {
return Optional.ofNullable(recursions.get()).filter(s -> !s.isEmpty()).map(s -> s.iterator().next());
}

public static ConfigValue getValueFromPropertyMappers(ConfigSourceInterceptorContext context, String name) {
Function<String, ConfigValue> resolver = (n) -> PropertyMappers.getValue(context, n);
public static ConfigValue getValueFromPropertyMappers(ConfigSourceInterceptorContext context, String name, boolean augmenting) {
Function<String, ConfigValue> resolver = (n) -> PropertyMappers.getValue(context, n, augmenting);
return resolve(resolver, resolver, name, true);
}

Expand Down
16 changes: 12 additions & 4 deletions .../src/main/java/org/keycloak/quarkus/runtime/conf 8000 iguration/PropertyMappingInterceptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
import jakarta.annotation.Priority;

import org.keycloak.config.OptionCategory;
import org.keycloak.quarkus.runtime.Environment;
import org.keycloak.quarkus.runtime.configuration.mappers.PropertyMapper;
import org.keycloak.quarkus.runtime.configuration.mappers.PropertyMappers;
import org.keycloak.quarkus.runtime.configuration.mappers.WildcardPropertyMapper;
Expand All @@ -38,7 +37,6 @@
import io.smallrye.config.Priorities;
import org.apache.commons.collections4.IteratorUtils;

import static org.keycloak.quarkus.runtime.Environment.isRebuild;
import static org.keycloak.quarkus.runtime.configuration.MicroProfileConfigProvider.NS_KEYCLOAK_PREFIX;

/**
Expand All @@ -64,6 +62,8 @@ public class PropertyMappingInterceptor implements ConfigSourceInterceptor {

private static final ThreadLocal<Boolean> disable = new ThreadLocal<>();

private Boolean augmenting;

public static void disable() {
disable.set(true);
}
Expand Down Expand Up @@ -93,7 +93,7 @@ public Iterator<String> iterateNames(ConfigSourceInterceptorContext context) {

final Set<PropertyMapper<?>> mappersWithoutValues = PropertyMappers.getMappers();

boolean filterRuntime = isRebuild() || Boolean.getBoolean(Environment.KC_TEST_REBUILD);
boolean filterRuntime = isAugmenting(context);

// this will return different iterations when our configuration is initialized vs not.
// when the configuration is not initialized, we only need to worry about providing
Expand Down Expand Up @@ -153,6 +153,14 @@ public Iterator<String> iterateNames(ConfigSourceInterceptorContext context) {
return IteratorUtils.chainedIterator(baseStream.iterator(), inferredValueStream.iterator());
}

private boolean isAugmenting(ConfigSourceInterceptorContext context) {
if (augmenting == null) {
// see BuildTimeConfigurationReader - if a sys properties are excluded, then we're augmenting
augmenting = context.proceed("file.separator") == null;
}
return augmenting;
}

private void appendWildcardsMappedFrom(ConfigSourceInterceptorContext context, String name,
final PropertyMapper<?> mapper, List<String> names) {
var wildCards = PropertyMappers.getWildcardsMappedFrom(mapper.getOption());
Expand Down Expand Up @@ -210,6 +218,6 @@ public ConfigValue getValue(ConfigSourceInterceptorContext context, String name)
}

// Call through NestedPropertyMappingInterceptor to track what we are currently getting the value for
return NestedPropertyMappingInterceptor.getValueFromPropertyMappers(context, name);
return NestedPropertyMappingInterceptor.getValueFromPropertyMappers(context, name, isAugmenting(context));
}
}
5 changes: 2 additions & 3 deletions ...ime/src/main/java/org/keycloak/quarkus/runtime/configuration/mappers/PropertyMappers.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@
import io.smallrye.config.Expressions;
import org.jboss.logging.Logger;

import static org.keycloak.quarkus.runtime.Environment.isRebuild;
import static org.keycloak.quarkus.runtime.Environment.isRebuildCheck;
import static org.keycloak.quarkus.runtime.configuration.KeycloakConfigSourceProvider.isKeyStoreConfigSource;

Expand Down Expand Up @@ -73,7 +72,7 @@ public static void reset() {
GROUPINGS.forEach(g -> MAPPERS.addAll(g.getPropertyMappers()));
}

public static ConfigValue getValue(ConfigSourceInterceptorContext context, String name) {
public static ConfigValue getValue(ConfigSourceInterceptorContext context, String name, boolean augmenting) {
PropertyMapper<?> mapper = getMapper(name);

// During re-aug do not resolve server runtime properties and avoid including in the quarkus default value config source.
Expand All @@ -82,7 +81,7 @@ public static ConfigValue getValue(ConfigSourceInterceptorContext context, Strin
// and we need to resolve them. That should be fine as they are generally not considered security sensitive.
// If however expressions are not enabled that means quarkus is specifically looking for runtime defaults, and we should not provide a value
// See https://github.com/quarkusio/quarkus/pull/42157
if ((isRebuild() || Boolean.getBoolean(Environment.KC_TEST_REBUILD)) && isKeycloakRuntime(name, mapper)
if (augmenting && isKeycloakRuntime(name, mapper)
&& (NestedPropertyMappingInterceptor.getResolvingRoot().or(() -> Optional.of(name))
.filter(n -> n.startsWith("quarkus.log.") || n.startsWith("quarkus.console.")).isEmpty()
|| !Expressions.isEnabled())) {
Expand Down
5 changes: 3 additions & 2 deletions ...s/runtime/src/test/java/org/keycloak/quarkus/runtime/configuration/ConfigurationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
import org.keycloak.spi.infinispan.CacheEmbeddedConfigProviderSpi;
import org.keycloak.spi.infinispan.impl.embedded.DefaultCacheEmbeddedConfigProviderFactory;

import io.quarkus.runtime.configuration.ConfigUtils;
import io.smallrye.config.ConfigValue;
import io.smallrye.config.Expressions;
import io.smallrye.config.PropertiesConfigSource;
Expand Down Expand Up @@ -105,8 +106,8 @@ public void testKeycloakConfPlaceholder() {
assertTrue(Configuration.getConfig().isPropertyPresent("quarkus.log.category.\"io.k8s\".level"));
putEnvVar("SOME_LOG_LEVEL", "debug");
assertEquals("debug", createConfig().getRawValue("kc.log-level"));
Environment.setRebuild();
assertNull(Expressions.withoutExpansion(() -> Configuration.getConfigValue("kc.log-level")).getValue());
SmallRyeConfig config = ConfigUtils.emptyConfigBuilder().setAddDefaultSources(false).addDiscoveredSources().build();
assertNull(Expressions.withoutExpansion(() -> config.getConfigValue("kc.log-level")).getValue());
}

@Test
Expand Down
11 changes: 6 additions & 5 deletions quarkus/tests/integration/src/test/java/org/keycloak/it/cli/dist/BuildCommandDistTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,12 +92,13 @@ public void testFailInvalidOptionInConf(KeycloakDistribution distribution) {
@Test
@RawDistOnly(reason = "Containers are immutable")
void testDoNotRecordRuntimeOptionsDuringBuild(KeycloakDistribution distribution) {
distribution.setProperty("proxy", "edge");
distribution.run("build");
distribution.removeProperty("proxy");
distribution.setProperty("db-url", "invalid");
CLIResult cliResult = distribution.run("build");
cliResult.assertBuild();
distribution.removeProperty("db-url");

CLIResult result = distribution.run("start", "--hostname=mykeycloak", "--cache=local", OPTIMIZED_BUILD_OPTION_LONG);
result.assertError("Key material not provided to setup HTTPS");
CLIResult result = distribution.run("start", "--hostname=mykeycloak", "--cache=local", "--http-enabled=true", OPTIMIZED_BUILD_OPTION_LONG);
result.assertStarted();
}

@Test
Expand Down
3 changes: 0 additions & 3 deletions quarkus/tests/junit5/src/main/java/org/keycloak/Keycloak.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,10 +211,7 @@ private Keycloak start(List<String> args) {
if (!initSys(args.toArray(String[]::new))) {
return this;
}
System.setProperty(Environment.KC_TEST_REBUILD, "true");
StartupAction startupAction = action.createInitialRuntimeApplication();
System.getProperties().remove(Environment.KC_TEST_REBUILD);

application = startupAction.runMainClass(args.toArray(new String[0]));

return this;
Expand Down
Loading
0