mirror/keycloak
1
0
Fork 0
mirror of https://github.com/keycloak/keycloak.git synced 2025-12-17 12:34:51 -06:00
Code Issues Packages Projects Releases Wiki Activity

fix: auto-defaulting log console color (#42669)

Browse Source 
closes: #42445

Signed-off-by: Steve Hawkins <shawkins@redhat.com>
Co-authored-by: Martin Bartoš <mabartos@redhat.com>
This commit is contained in:
Steven Hawkins
2025-10-06 13:14:30 -04:00
committed by GitHub
parent abcc5d418f
commit 7bfc33fd5f
22 changed files with 87 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/documentation/upgrading/topics/changes/changes-26_5_0.adoc Normal file
View File

@@ -0,0 +1,26 @@
// ------------------------ Breaking changes ------------------------ //
== Breaking changes
// ------------------------ Notable changes ------------------------ //
== Notable changes
Notable changes may include internal behavior changes that prevent common misconfigurations, bugs that are fixed, or changes to simplify running {project_name}.
=== `log-console-color` will automatically enable if supported by the terminal
The `log-console-color` previously defaulted to `false`, but it will now instead check if the terminal supports color.
You may still explicitly disable color support by setting the option to `false`.
// ------------------------ Deprecated features ------------------------ //
== Deprecated features
The following sections provide details on deprecated features.
// ------------------------ Removed features ------------------------ //
== Removed features
The following features have been removed from this release.
=== <TODO>

4
docs/documentation/upgrading/topics/changes/changes.adoc
View File

@@ -1,6 +1,10 @@
[[migration-changes]]
== Migration Changes
=== Migrating to 26.5.0
include::changes-26_5_0.adoc[leveloffset=2]
=== Migrating to 26.4.0
include::changes-26_4_0.adoc[leveloffset=2]

5
quarkus/config-api/src/main/java/org/keycloak/config/LoggingOptions.java
View File

@@ -7,6 +7,7 @@ import java.io.File;
import java.util.Arrays;
import java.util.List;
import java.util.Locale;
import java.util.Optional;
import java.util.function.Function;
import static java.lang.String.format;
@@ -133,8 +134,8 @@ public class LoggingOptions {
public static final Option<Boolean> LOG_CONSOLE_COLOR = new OptionBuilder<>("log-console-color", Boolean.class)
.category(OptionCategory.LOGGING)
.description("Enable or disable colors when logging to console.")
.defaultValue(Boolean.FALSE) // :-(
.description("Enable or disable colors when logging to console. If this is not present then an attempt will be made to guess if the terminal supports color.")
.defaultValue(Optional.empty())
.build();
public static final Option<Boolean> LOG_CONSOLE_ENABLED = new OptionBuilder<>("log-console-enabled", Boolean.class)

9
quarkus/config-api/src/main/java/org/keycloak/config/OptionBuilder.java
View File

@@ -54,7 +54,6 @@ public class OptionBuilder<T> {
hidden = false;
build = false;
description = null;
defaultValue = Optional.empty();
strictExpectedValues = true;
}
@@ -178,8 +177,12 @@ public class OptionBuilder<T> {
}
}
if (defaultValue.isEmpty() && Boolean.class.equals(expected)) {
defaultValue = Optional.of((T) Boolean.FALSE);
if (defaultValue == null) {
if (Boolean.class.equals(expected)) {
defaultValue = Optional.of((T) Boolean.FALSE);
} else {
defaultValue = Optional.empty();
}
}
if (transformEnumValues) {

9
quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/mappers/LoggingPropertyMappers.java
View File

@@ -16,13 +16,13 @@ import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.function.BiFunction;
import java.util.logging.Level;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import io.quarkus.runtime.configuration.MemorySizeConverter;
import org.jboss.logmanager.LogContext;
import org.keycloak.common.Profile;
import org.keycloak.config.LoggingOptions;
@@ -31,6 +31,8 @@ import org.keycloak.quarkus.runtime.Messages;
import org.keycloak.quarkus.runtime.cli.PropertyException;
import org.keycloak.quarkus.runtime.configuration.Configuration;
import io.quarkus.dev.console.QuarkusConsole;
import io.quarkus.runtime.configuration.MemorySizeConverter;
import io.smallrye.config.ConfigSourceInterceptorContext;
public final class LoggingPropertyMappers implements PropertyMapperGrouping {
@@ -87,6 +89,7 @@ public final class LoggingPropertyMappers implements PropertyMapperGrouping {
fromOption(LoggingOptions.LOG_CONSOLE_COLOR)
.isEnabled(LoggingPropertyMappers::isConsoleEnabled, CONSOLE_ENABLED_MSG)
.to("quarkus.console.color")
.transformer(this::transformConsoleColor)
.build(),
fromOption(LoggingOptions.LOG_CONSOLE_ENABLED)
.mapFrom(LoggingOptions.LOG, LoggingPropertyMappers.resolveLogHandler(LoggingOptions.DEFAULT_LOG_HANDLER.name()))
@@ -263,6 +266,10 @@ public final class LoggingPropertyMappers implements PropertyMapperGrouping {
);
}
private String transformConsoleColor(String value, ConfigSourceInterceptorContext context) {
return Optional.ofNullable(value).orElseGet(() -> Boolean.toString(QuarkusConsole.hasColorSupport()));
}
public static boolean isConsoleEnabled() {
return isHandlerEnabled(LoggingOptions.Handler.console);
}

8
quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/configuration/LoggingConfigurationTest.java
View File

@@ -20,6 +20,7 @@ package org.keycloak.quarkus.runtime.configuration;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.keycloak.config.LoggingOptions.DEFAULT_LOG_FORMAT;
@@ -40,6 +41,13 @@ import io.smallrye.config.SmallRyeConfig;
public class LoggingConfigurationTest extends AbstractConfigurationTest {
@Test
public void testDefaultLogColor() {
SmallRyeConfig config = createConfig();
assertNull(config.getConfigValue("kc.log-console-color").getValue());
assertNotNull(config.getConfigValue("quarkus.console.color").getValue());
}
@Test
public void logHandlerConfig() {
ConfigArgsConfigSource.setCliArgs("--log=console,file");

3
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testBootstrapAdminService.approved.txt vendored
View File

@@ -226,7 +226,8 @@ Logging:
parent property 'log-async' is used. Default: false. Available only when
Console log handler is activated.
--log-console-color <true|false>
Enable or disable colors when logging to console. Default: false. Available
Enable or disable colors when logging to console. If this is not present then
an attempt will be made to guess if the terminal supports color. Available
only when Console log handler is activated.
--log-console-format <format>
The format of unstructured console log entries. If the format has spaces in

3
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testBootstrapAdminUser.approved.txt vendored
View File

@@ -228,7 +228,8 @@ Logging:
parent property 'log-async' is used. Default: false. Available only when
Console log handler is activated.
--log-console-color <true|false>
Enable or disable colors when logging to console. Default: false. Available
Enable or disable colors when logging to console. If this is not present then
an attempt will be made to guess if the terminal supports color. Available
only when Console log handler is activated.
--log-console-format <format>
The format of unstructured console log entries. If the format has spaces in

3
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testExportHelp.approved.txt vendored
View File

@@ -221,7 +221,8 @@ Logging:
parent property 'log-async' is used. Default: false. Available only when
Console log handler is activated.
--log-console-color <true|false>
Enable or disable colors when logging to console. Default: false. Available
Enable or disable colors when logging to console. If this is not present then
an attempt will be made to guess if the terminal supports color. Available
only when Console log handler is activated.
--log-console-format <format>
The format of unstructured console log entries. If the format has spaces in

3
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testExportHelpAll.approved.txt vendored
View File

@@ -239,7 +239,8 @@ Logging:
Default: 512. Available only when Console log handler is activated and
asynchronous logging is enabled.
--log-console-color <true|false>
Enable or disable colors when logging to console. Default: false. Available
Enable or disable colors when logging to console. If this is not present then
an attempt will be made to guess if the terminal supports color. Available
only when Console log handler is activated.
--log-console-format <format>
The format of unstructured console log entries. If the format has spaces in

3
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testImportHelp.approved.txt vendored
View File

@@ -221,7 +221,8 @@ Logging:
parent property 'log-async' is used. Default: false. Available only when
Console log handler is activated.
--log-console-color <true|false>
Enable or disable colors when logging to console. Default: false. Available
Enable or disable colors when logging to console. If this is not present then
an attempt will be made to guess if the terminal supports color. Available
only when Console log handler is activated.
--log-console-format <format>
The format of unstructured console log entries. If the format has spaces in

3
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testImportHelpAll.approved.txt vendored
View File

@@ -239,7 +239,8 @@ Logging:
Default: 512. Available only when Console log handler is activated and
asynchronous logging is enabled.
--log-console-color <true|false>
Enable or disable colors when logging to console. Default: false. Available
Enable or disable colors when logging to console. If this is not present then
an attempt will be made to guess if the terminal supports color. Available
only when Console log handler is activated.
--log-console-format <format>
The format of unstructured console log entries. If the format has spaces in

3
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartDevHelp.approved.txt vendored
View File

@@ -382,7 +382,8 @@ Logging:
parent property 'log-async' is used. Default: false. Available only when
Console log handler is activated.
--log-console-color <true|false>
Enable or disable colors when logging to console. Default: false. Available
Enable or disable colors when logging to console. If this is not present then
an attempt will be made to guess if the terminal supports color. Available
only when Console log handler is activated.
--log-console-format <format>
The format of unstructured console log entries. If the format has spaces in

3
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartDevHelpAll.approved.txt vendored
View File

@@ -479,7 +479,8 @@ Logging:
Default: 512. Available only when Console log handler is activated and
asynchronous logging is enabled.
--log-console-color <true|false>
Enable or disable colors when logging to console. Default: false. Available
Enable or disable colors when logging to console. If this is not present then
an attempt will be made to guess if the terminal supports color. Available
only when Console log handler is activated.
--log-console-format <format>
The format of unstructured console log entries. If the format has spaces in

3
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartHelp.approved.txt vendored
View File

@@ -430,7 +430,8 @@ Logging:
parent property 'log-async' is used. Default: false. Available only when
Console log handler is activated.
--log-console-color <true|false>
Enable or disable colors when logging to console. Default: false. Available
Enable or disable colors when logging to console. If this is not present then
an attempt will be made to guess if the terminal supports color. Available
only when Console log handler is activated.
--log-console-format <format>
The format of unstructured console log entries. If the format has spaces in

3
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartHelpAll.approved.txt vendored
View File

@@ -480,7 +480,8 @@ Logging:
Default: 512. Available only when Console log handler is activated and
asynchronous logging is enabled.
--log-console-color <true|false>
Enable or disable colors when logging to console. Default: false. Available
Enable or disable colors when logging to console. If this is not present then
an attempt will be made to guess if the terminal supports color. Available
only when Console log handler is activated.
--log-console-format <format>
The format of unstructured console log entries. If the format has spaces in

3
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartOptimizedHelp.approved.txt vendored
View File

@@ -368,7 +368,8 @@ Logging:
parent property 'log-async' is used. Default: false. Available only when
Console log handler is activated.
--log-console-color <true|false>
Enable or disable colors when logging to console. Default: false. Available
Enable or disable colors when logging to console. If this is not present then
an attempt will be made to guess if the terminal supports color. Available
only when Console log handler is activated.
--log-console-format <format>
The format of unstructured console log entries. If the format has spaces in

3
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartOptimizedHelpAll.approved.txt vendored
View File

@@ -414,7 +414,8 @@ Logging:
Default: 512. Available only when Console log handler is activated and
asynchronous logging is enabled.
--log-console-color <true|false>
Enable or disable colors when logging to console. Default: false. Available
Enable or disable colors when logging to console. If this is not present then
an attempt will be made to guess if the terminal supports color. Available
only when Console log handler is activated.
--log-console-format <format>
The format of unstructured console log entries. If the format has spaces in

3
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testUpdateCompatibilityCheckHelp.approved.txt vendored
View File

@@ -429,7 +429,8 @@ Logging:
parent property 'log-async' is used. Default: false. Available only when
Console log handler is activated.
--log-console-color <true|false>
Enable or disable colors when logging to console. Default: false. Available
Enable or disable colors when logging to console. If this is not present then
an attempt will be made to guess if the terminal supports color. Available
only when Console log handler is activated.
--log-console-format <format>
The format of unstructured console log entries. If the format has spaces in

3
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testUpdateCompatibilityCheckHelpAll.approved.txt vendored
View File

@@ -479,7 +479,8 @@ Logging:
Default: 512. Available only when Console log handler is activated and
asynchronous logging is enabled.
--log-console-color <true|false>
Enable or disable colors when logging to console. Default: false. Available
Enable or disable colors when logging to console. If this is not present then
an attempt will be made to guess if the terminal supports color. Available
only when Console log handler is activated.
--log-console-format <format>
The format of unstructured console log entries. If the format has spaces in

3
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testUpdateCompatibilityMetadataHelp.approved.txt vendored
View File

@@ -427,7 +427,8 @@ Logging:
parent property 'log-async' is used. Default: false. Available only when
Console log handler is activated.
--log-console-color <true|false>
Enable or disable colors when logging to console. Default: false. Available
Enable or disable colors when logging to console. If this is not present then
an attempt will be made to guess if the terminal supports color. Available
only when Console log handler is activated.
--log-console-format <format>
The format of unstructured console log entries. If the format has spaces in

3
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testUpdateCompatibilityMetadataHelpAll.approved.txt vendored
View File

@@ -477,7 +477,8 @@ Logging:
Default: 512. Available only when Console log handler is activated and
asynchronous logging is enabled.
--log-console-color <true|false>
Enable or disable colors when logging to console. Default: false. Available
Enable or disable colors when logging to console. If this is not present then
an attempt will be made to guess if the terminal supports color. Available
only when Console log handler is activated.
--log-console-format <format>
The format of unstructured console log entries. If the format has spaces in