Bug and test fixes

Signed-off-by: Václav Muzikář <[email protected]>
vmuzikar · Nov 25, 2024 · 46f5001 · 46f5001
1 parent 142f185
commit 46f5001
Show file tree

Hide file tree

Showing 14 changed files with 58 additions and 8 deletions.
diff --git a/quarkus/config-api/src/main/java/org/keycloak/config/LoggingOptions.java b/quarkus/config-api/src/main/java/org/keycloak/config/LoggingOptions.java
@@ -62,7 +62,7 @@ public String toString() {
 
     public static final Option<Level> LOG_LEVEL_CATEGORY = new OptionBuilder<>("log-level-<category>", Level.class)
             .category(OptionCategory.LOGGING)
-            .description("The log level of a category.")
+            .description("The log level of a category. Takes precedence over the 'log-level' option.")
             .strictExpectedValues(false)
             .build();
 

diff --git a/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/cli/Picocli.java b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/cli/Picocli.java
@@ -47,6 +47,7 @@
 import java.util.function.BiConsumer;
 import java.util.function.Consumer;
 import java.util.function.Function;
+import java.util.stream.Collectors;
 
 import org.keycloak.common.profile.ProfileException;
 import org.keycloak.config.DeprecatedMetadata;
@@ -101,6 +102,7 @@ private static class IncludeOptions {
     }
 
     private ExecutionExceptionHandler errorHandler = new ExecutionExceptionHandler();
+    private Set<PropertyMapper<?>> allowedMappers;
     private List<String> uncrecognizedArgs = new ArrayList<>();
 
     public void parseAndRun(List<String> cliArgs) {
@@ -333,7 +335,8 @@ public void validateConfig(List<String> cliArgs, AbstractCommand abstractCommand
             if (arg.contains("=")) {
                 arg = arg.substring(0, arg.indexOf("="));
             }
-            return PropertyMappers.getMapper(arg) != null;
+            PropertyMapper<?> mapper = PropertyMappers.getMapper(arg);
+            return mapper != null && mapper.hasWildcard() && allowedMappers.contains(mapper);
         });
         if (!uncrecognizedArgs.isEmpty()) {
             throw new KcUnmatchedArgumentException(abstractCommand.getCommandLine().orElseThrow(), uncrecognizedArgs);
@@ -654,7 +657,7 @@ private static void addHelp(CommandSpec currentSpec) {
         }
     }
 
-    private static IncludeOptions getIncludeOptions(List<String> cliArgs, AbstractCommand abstractCommand, String commandName) {
+    private IncludeOptions getIncludeOptions(List<String> cliArgs, AbstractCommand abstractCommand, String commandName) {
         IncludeOptions result = new IncludeOptions();
         if (abstractCommand == null) {
             return result;
@@ -672,7 +675,7 @@ private static IncludeOptions getIncludeOptions(List<String> cliArgs, AbstractCo
         return result;
     }
 
-    private static void addCommandOptions(List<String> cliArgs, CommandLine command) {
+    private void addCommandOptions(List<String> cliArgs, CommandLine command) {
         if (command != null && command.getCommand() instanceof AbstractCommand) {
             IncludeOptions options = getIncludeOptions(cliArgs, command.getCommand(), command.getCommandName());
 
@@ -684,7 +687,7 @@ private static void addCommandOptions(List<String> cliArgs, CommandLine command)
         }
     }
 
-    private static void addOptionsToCli(CommandLine commandLine, IncludeOptions includeOptions) {
+    private void addOptionsToCli(CommandLine commandLine, IncludeOptions includeOptions) {
         final Map<OptionCategory, List<PropertyMapper<?>>> mappers = new EnumMap<>(OptionCategory.class);
 
         // Since we can't run sanitizeDisabledMappers sooner, PropertyMappers.getRuntime|BuildTimeMappers() at this point
@@ -698,6 +701,8 @@ private static void addOptionsToCli(CommandLine commandLine, IncludeOptions incl
         }
 
         addMappedOptionsToArgGroups(commandLine, mappers);
+
+        allowedMappers = mappers.values().stream().flatMap(List::stream).collect(Collectors.toUnmodifiableSet());
     }
 
     private static <T extends Map<OptionCategory, List<PropertyMapper<?>>>> void combinePropertyMappers(T origMappers, T additionalMappers) {

diff --git a/.../runtime/src/main/java/org/keycloak/quarkus/runtime/cli/command/AbstractStartCommand.java b/.../runtime/src/main/java/org/keycloak/quarkus/runtime/cli/command/AbstractStartCommand.java
@@ -39,8 +39,6 @@ public abstract class AbstractStartCommand extends AbstractCommand implements Ru
     @Override
     public void run() {
         doBeforeRun();
-        HttpPropertyMappers.validateConfig();
-        HostnameV2PropertyMappers.validateConfig();
         validateConfig();
 
         if (isDevProfile()) {
@@ -56,6 +54,13 @@ protected void doBeforeRun() {
 
     }
 
+    @Override
+    protected void validateConfig() {
+        super.validateConfig(); // need to run generic validation first as it also verifies unknown options
+        HttpPropertyMappers.validateConfig();
+        HostnameV2PropertyMappers.validateConfig();
+    }
+
     @Override
     public List<OptionCategory> getOptionCategories() {
         EnumSet<OptionCategory> excludedCategories = excludedCategories();

diff --git a/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/cli/command/Export.java b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/cli/command/Export.java
@@ -40,8 +40,8 @@ protected void doBeforeRun() {
 
     @Override
     public void validateConfig() {
-        ExportPropertyMappers.validateConfig();
         super.validateConfig();
+        ExportPropertyMappers.validateConfig();
     }
 
     @Override

diff --git a/...g/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testExportHelp.approved.txt b/...g/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testExportHelp.approved.txt
@@ -142,6 +142,10 @@ Logging:
                      The log level of the root category or a comma-separated list of individual
                        categories and their levels. For the root category, you don't need to
                        specify a category. Default: info.
+--log-level-<category> <level>
+                     The log level of a category. Takes precedence over the 'log-level' option.
+                       Possible values are: off, fatal, error, warn, info, debug, trace, all, or a
+                       custom one.
 
 Truststore:
 

diff --git a/...eycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testExportHelpAll.approved.txt b/...eycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testExportHelpAll.approved.txt
@@ -167,6 +167,10 @@ Logging:
                      The log level of the root category or a comma-separated list of individual
                        categories and their levels. For the root category, you don't need to
                        specify a category. Default: info.
+--log-level-<category> <level>
+                     The log level of a category. Takes precedence over the 'log-level' option.
+                       Possible values are: off, fatal, error, warn, info, debug, trace, all, or a
+                       custom one.
 --log-syslog-app-name <name>
                      Set the app name used when formatting the message in RFC5424 format. Default:
                        keycloak. Available only when Syslog is activated.

diff --git a/...g/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testImportHelp.approved.txt b/...g/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testImportHelp.approved.txt
@@ -142,6 +142,10 @@ Logging:
                      The log level of the root category or a comma-separated list of individual
                        categories and their levels. For the root category, you don't need to
                        specify a category. Default: info.
+--log-level-<category> <level>
+                     The log level of a category. Takes precedence over the 'log-level' option.
+                       Possible values are: off, fatal, error, warn, info, debug, trace, all, or a
+                       custom one.
 
 Truststore:
 

diff --git a/...eycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testImportHelpAll.approved.txt b/...eycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testImportHelpAll.approved.txt
@@ -167,6 +167,10 @@ Logging:
                      The log level of the root category or a comma-separated list of individual
                        categories and their levels. For the root category, you don't need to
                        specify a category. Default: info.
+--log-level-<category> <level>
+                     The log level of a category. Takes precedence over the 'log-level' option.
+                       Possible values are: off, fatal, error, warn, info, debug, trace, all, or a
+                       custom one.
 --log-syslog-app-name <name>
                      Set the app name used when formatting the message in RFC5424 format. Default:
                        keycloak. Available only when Syslog is activated.

diff --git a/...keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartDevHelp.approved.txt b/...keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartDevHelp.approved.txt
@@ -308,6 +308,10 @@ Logging:
                      The log level of the root category or a comma-separated list of individual
                        categories and their levels. For the root category, you don't need to
                        specify a category. Default: info.
+--log-level-<category> <level>
+                     The log level of a category. Takes precedence over the 'log-level' option.
+                       Possible values are: off, fatal, error, warn, info, debug, trace, all, or a
+                       custom one.
 
 Truststore:
 

diff --git a/...cloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartDevHelpAll.approved.txt b/...cloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartDevHelpAll.approved.txt
@@ -368,6 +368,10 @@ Logging:
                      The log level of the root category or a comma-separated list of individual
                        categories and their levels. For the root category, you don't need to
                        specify a category. Default: info.
+--log-level-<category> <level>
+                     The log level of a category. Takes precedence over the 'log-level' option.
+                       Possible values are: off, fatal, error, warn, info, debug, trace, all, or a
+                       custom one.
 --log-syslog-app-name <name>
                      Set the app name used when formatting the message in RFC5424 format. Default:
                        keycloak. Available only when Syslog is activated.

diff --git a/...rg/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartHelp.approved.txt b/...rg/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartHelp.approved.txt
@@ -315,6 +315,10 @@ Logging:
                      The log level of the root category or a comma-separated list of individual
                        categories and their levels. For the root category, you don't need to
                        specify a category. Default: info.
+--log-level-<category> <level>
+                     The log level of a category. Takes precedence over the 'log-level' option.
+                       Possible values are: off, fatal, error, warn, info, debug, trace, all, or a
+                       custom one.
 
 Truststore:
 

diff --git a/...keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartHelpAll.approved.txt b/...keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartHelpAll.approved.txt
@@ -369,6 +369,10 @@ Logging:
                      The log level of the root category or a comma-separated list of individual
                        categories and their levels. For the root category, you don't need to
                        specify a category. Default: info.
+--log-level-<category> <level>
+                     The log level of a category. Takes precedence over the 'log-level' option.
+                       Possible values are: off, fatal, error, warn, info, debug, trace, all, or a
+                       custom one.
 --log-syslog-app-name <name>
                      Set the app name used when formatting the message in RFC5424 format. Default:
                        keycloak. Available only when Syslog is activated.

diff --git a/...ak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartOptimizedHelp.approved.txt b/...ak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartOptimizedHelp.approved.txt
@@ -266,6 +266,10 @@ Logging:
                      The log level of the root category or a comma-separated list of individual
                        categories and their levels. For the root category, you don't need to
                        specify a category. Default: info.
+--log-level-<category> <level>
+                     The log level of a category. Takes precedence over the 'log-level' option.
+                       Possible values are: off, fatal, error, warn, info, debug, trace, all, or a
+                       custom one.
 
 Truststore:
 

diff --git a/...it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartOptimizedHelpAll.approved.txt b/...it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartOptimizedHelpAll.approved.txt
@@ -320,6 +320,10 @@ Logging:
                      The log level of the root category or a comma-separated list of individual
                        categories and their levels. For the root category, you don't need to
                        specify a category. Default: info.
+--log-level-<category> <level>
+                     The log level of a category. Takes precedence over the 'log-level' option.
+                       Possible values are: off, fatal, error, warn, info, debug, trace, all, or a
+                       custom one.
 --log-syslog-app-name <name>
                      Set the app name used when formatting the message in RFC5424 format. Default:
                        keycloak. Available only when Syslog is activated.