8000 [Quarkus 4] Use supported Quarkus logging and OpenAPI properties by Pepo48 · Pull Request #54619 · keycloak/keycloak · GitHub
[go: up one dir, main page]
Skip to content

[Quarkus 4] Use supported Quarkus logging and OpenAPI properties #54619

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
Nov 6, 2026
+31 −28
Merged

[Quarkus 4] Use supported Quarkus logging and OpenAPI properties #54619

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
12 changes: 6 additions & 6 deletions .../main/java/org/keycloak/quarkus/runtime/configuration/mappers/LoggingPropertyMappers.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,13 +107,13 @@ public List<PropertyMapper<?>> getPropertyMappers() {
.build(),
fromOption(LoggingOptions.LOG_CONSOLE_ENABLED)
.mapFrom(LoggingOptions.LOG, LoggingPropertyMappers.resolveLogHandler(LoggingOptions.DEFAULT_LOG_HANDLER.name()))
.to("quarkus.log.console.enable")
.to("quarkus.log.console.enabled")
.build(),
// Console async
fromOption(LoggingOptions.LOG_CONSOLE_ASYNC)
.mapFrom(LoggingOptions.LOG_ASYNC)
.isEnabled(LoggingPropertyMappers::isConsoleEnabled, CONSOLE_ENABLED_MSG)
.to("quarkus.log.console.async")
.to("quarkus.log.console.async.enabled")
.build(),
fromOption(LoggingOptions.LOG_CONSOLE_ASYNC_QUEUE_LENGTH)
.isEnabled(LoggingPropertyMappers::isConsoleAsyncEnabled, "%s and asynchronous logging is enabled".formatted(CONSOLE_ENABLED_MSG))
Expand All @@ -123,7 +123,7 @@ public List<PropertyMapper<?>> getPropertyMappers() {
// File
fromOption(LoggingOptions.LOG_FILE_ENABLED)
.mapFrom(LoggingOptions.LOG, LoggingPropertyMappers.resolveLogHandler("file"))
.to("quarkus.log.file.enable")
.to("quarkus.log.file.enabled")
.build(),
fromOption(LoggingOptions.LOG_FILE)
.isEnabled(LoggingPropertyMappers::isFileEnabled, FILE_ENABLED_MSG)
Expand Down Expand Up @@ -174,7 +174,7 @@ public List<PropertyMapper<?>> getPropertyMappers() {
fromOption(LoggingOptions.LOG_FILE_ASYNC)
.mapFrom(LoggingOptions.LOG_ASYNC)
.isEnabled(LoggingPropertyMappers::isFileEnabled, FILE_ENABLED_MSG)
.to("quarkus.log.file.async")
.to("quarkus.log.file.async.enabled")
.build(),
fromOption(LoggingOptions.LOG_FILE_ASYNC_QUEUE_LENGTH)
.isEnabled(LoggingPropertyMappers::isFileAsyncEnabled, "%s and asynchronous logging is enabled".formatted(FILE_ENABLED_MSG))
Expand Down Expand Up @@ -223,7 +223,7 @@ public List<PropertyMapper<?>> getPropertyMappers() {
// Syslog
fromOption(LoggingOptions.LOG_SYSLOG_ENABLED)
.mapFrom(LoggingOptions.LOG, LoggingPropertyMappers.resolveLogHandler("syslog"))
.to("quarkus.log.syslog.enable")
.to("quarkus.log.syslog.enabled")
.build(),
fromOption(LoggingOptions.LOG_SYSLOG_ENDPOINT)
.isEnabled(LoggingPropertyMappers::isSyslogEnabled, SYSLOG_ENABLED_MSG)
Expand Down Expand Up @@ -299,7 +299,7 @@ public List<PropertyMapper<?>> getPropertyMappers() {
fromOption(LoggingOptions.LOG_SYSLOG_ASYNC)
.mapFrom(LoggingOptions.LOG_ASYNC)
.isEnabled(LoggingPropertyMappers::isSyslogEnabled, SYSLOG_ENABLED_MSG)
.to("quarkus.log.syslog.async")
.to("quarkus.log.syslog.async.enabled")
.build(),
fromOption(LoggingOptions.LOG_SYSLOG_ASYNC_QUEUE_LENGTH)
.isEnabled(LoggingPropertyMappers::isSyslogAsyncEnabled, "%s and asynchronous logging is enabled".formatted(SYSLOG_ENABLED_MSG))
Expand Down
4 changes: 2 additions & 2 deletions .../main/java/org/keycloak/quarkus/runtime/configuration/mappers/OpenApiPropertyMappers.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ public List<? extends PropertyMapper<?>> getPropertyMappers() {
return List.of(
fromOption(OpenApiOptions.OPENAPI_ENABLED)
.isEnabled(OpenApiPropertyMappers::isClientApiEnabled, "OpenAPI feature is enabled")
.to("quarkus.smallrye-openapi.enable")
.to("quarkus.smallrye-openapi.enabled")
.build(),
fromOption(OpenApiOptions.OPENAPI_UI_ENABLED)
.isEnabled(OpenApiPropertyMappers::isOpenApiEnabled, "OpenAPI Endpoint is enabled")
.to("quarkus.swagger-ui.enable")
.to("quarkus.swagger-ui.enabled")
.build()
);
}
Expand Down
40 changes: 20 additions & 20 deletions ...me/src/test/java/org/keycloak/quarkus/runtime/configuration/LoggingConfigurationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,33 +54,33 @@ public void testDefaultLogColor() {
public void logHandlerConfig() {
ConfigArgsConfigSource.setCliArgs("--log=console,file");
SmallRyeConfig config = createConfig();
assertEquals("true", config.getConfigValue("quarkus.log.console.enable").getValue());
assertEquals("true", config.getConfigValue("quarkus.log.file.enable").getValue());
assertEquals("false", config.getConfigValue("quarkus.log.syslog.enable").getValue());
assertEquals("true", config.getConfigValue("quarkus.log.console.enabled").getValue());
assertEquals("true", config.getConfigValue("quarkus.log.file.enabled").getValue());
assertEquals("false", config.getConfigValue("quarkus.log.syslog.enabled").getValue());

ConfigArgsConfigSource.setCliArgs("--log=file");
SmallRyeConfig config2 = createConfig();
assertEquals("false", config2.getConfigValue("quarkus.log.console.enable").getValue());
assertEquals("true", config2.getConfigValue("quarkus.log.file.enable").getValue());
assertEquals("false", config2.getConfigValue("quarkus.log.syslog.enable").getValue());
assertEquals("false", config2.getConfigValue("quarkus.log.console.enabled").getValue());
assertEquals("true", config2.getConfigValue("quarkus.log.file.enabled").getValue());
assertEquals("false", config2.getConfigValue("quarkus.log.syslog.enabled").getValue());

ConfigArgsConfigSource.setCliArgs("--log=console");
SmallRyeConfig config3 = createConfig();
assertEquals("true", config3.getConfigValue("quarkus.log.console.enable").getValue());
assertEquals("false", config3.getConfigValue("quarkus.log.file.enable").getValue());
assertEquals("false", config3.getConfigValue("quarkus.log.syslog.enable").getValue());
assertEquals("true", config3.getConfigValue("quarkus.log.console.enabled").getValue());
assertEquals("false", config3.getConfigValue("quarkus.log.file.enabled").getValue());
assertEquals("false", config3.getConfigValue("quarkus.log.syslog.enabled").getValue());

ConfigArgsConfigSource.setCliArgs("--log=console,syslog");
SmallRyeConfig config5 = createConfig();
assertEquals("true", config5.getConfigValue("quarkus.log.console.enable").getValue());
assertEquals("false", config5.getConfigValue("quarkus.log.file.enable").getValue());
assertEquals("true", config5.getConfigValue("quarkus.log.syslog.enable").getValue());
assertEquals("true", config5.getConfigValue("quarkus.log.console.enabled").getValue());
assertEquals("false", config5.getConfigValue("quarkus.log.file.enabled").getValue());
assertEquals("true", config5.getConfigValue("quarkus.log.syslog.enabled").getValue());

ConfigArgsConfigSource.setCliArgs("--log=syslog");
SmallRyeConfig config6 = createConfig();
assertEquals("false", config6.getConfigValue("quarkus.log.console.enable").getValue());
assertEquals("false", config6.getConfigValue("quarkus.log.file.enable").getValue());
assertEquals("true", config6.getConfigValue("quarkus.log.syslog.enable").getValue());
assertEquals("false", config6.getConfigValue("quarkus.log.console.enabled").getValue());
assertEquals("false", config6.getConfigValue("quarkus.log.file.enabled").getValue());
assertEquals("true", config6.getConfigValue("quarkus.log.syslog.enabled").getValue());
}

@Test
Expand All @@ -100,7 +100,7 @@ public void syslogDefaults() {
assertThat(Configuration.getOptionalKcValue(LoggingOptions.LOG_SYSLOG_MAX_LENGTH).orElse(null), CoreMatchers.nullValue());

assertExternalConfig(Map.of(
"quarkus.log.syslog.enable", "false",
"quarkus.log.syslog.enabled", "false",
"quarkus.log.syslog.endpoint", "localhost:514",
"quarkus.log.syslog.syslog-type", "rfc5424",
"quarkus.log.syslog.app-name", "keycloak",
Expand Down Expand Up @@ -143,7 +143,7 @@ public void syslogDifferentValues() {
));

assertExternalConfig(Map.of(
"quarkus.log.syslog.enable", "true",
"quarkus.log.syslog.enabled", "true",
"quarkus.log.syslog.endpoint", "192.168.0.42:515",
"quarkus.log.syslog.syslog-type", "rfc3164",
"quarkus.log.syslog.max-length", "4096",
Expand Down Expand Up @@ -201,7 +201,7 @@ protected void assertSyslogCountingFraming(LogRuntimeConfig.SyslogConfig.Countin
"log-syslog-counting-framing", countingFraming.toString()
));
assertExternalConfig(Map.of(
"quarkus.log.syslog.enable", "true",
"quarkus.log.syslog.enabled", "true",
"quarkus.log.syslog.use-counting-framing", countingFraming.toString()
));
onAfter();
Expand Down Expand Up @@ -393,7 +393,7 @@ public void testInvalidLogLevel() {
public void testNestedBuildTimeLogging() {
Environment.setRebuildCheck(true); // will be reset by the system properties logic
ConfigArgsConfigSource.setCliArgs("");
assertEquals("true", createConfig().getConfigValue("quarkus.log.console.enable").getValue());
assertEquals("true", createConfig().getConfigValue("quarkus.log.console.enabled").getValue());
}

@Test
Expand Down Expand Up @@ -510,7 +510,7 @@ protected void setAsyncProperties(LoggingOptions.Handler handler, Boolean enable
protected void assertAsyncLoggingEnabled(LoggingOptions.Handler handler, Boolean expectedEnabled) {
var handlerName = handler.toString();
assertConfig("log-%s-async".formatted(handlerName), expectedEnabled.toString());
assertExternalConfig("quarkus.log.%s.async".formatted(handlerName), expectedEnabled.toString());
assertExternalConfig("quarkus.log.%s.async.enabled".formatted(handlerName), expectedEnabled.toString());
}

protected void assertAsyncProperties(LoggingOptions.Handler handler, Boolean enabled, Integer queueLength) {
Expand Down
3 changes: 3 additions & 0 deletions quarkus/tests/integration/src/test/java/org/keycloak/it/cli/dist/OpenApiDistTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,9 @@ void testOpenApiEndpointEnabled(KeycloakDistribution distribution) {
when().get(OPENAPI_ENDPOINT)
.then()
.statusCode(200);
when().get(OPENAPI_UI_ENDPOINT)
.then()
.statusCode(404);
}

@Test
Expand Down
Loading
0