JBEAP-26480: add --debug option to CLI

wildfly-extras · Feb 7, 2024 · 8fe7967 · 8fe7967
1 parent e09006e
commit 8fe7967
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 0 deletions.
diff --git a/...on/src/main/resources/packages/org.jboss.prospero/content/bin/prospero-logging.properties b/...on/src/main/resources/packages/org.jboss.prospero/content/bin/prospero-logging.properties
@@ -16,6 +16,7 @@ logger.level=INFO
 # Declare handlers for the root logger
 logger.handlers=FILE
 
+handlers=CONSOLE,FILE
 # Console handler configuration
 handler.CONSOLE=org.jboss.logmanager.handlers.ConsoleHandler
 handler.CONSOLE.properties=autoFlush

diff --git a/prospero-cli/src/main/java/org/wildfly/prospero/cli/CliMain.java b/prospero-cli/src/main/java/org/wildfly/prospero/cli/CliMain.java
@@ -18,6 +18,10 @@
 package org.wildfly.prospero.cli;
 
 import org.jboss.logging.Logger;
+import org.jboss.logmanager.Configurator;
+import org.jboss.logmanager.Level;
+import org.jboss.logmanager.PropertyConfigurator;
+import org.jboss.logmanager.config.LogContextConfiguration;
 import org.wildfly.prospero.cli.commands.ChannelCommand;
 import org.wildfly.prospero.cli.commands.CliConstants;
 import org.wildfly.prospero.cli.commands.CloneCommand;
@@ -105,6 +109,20 @@ public static CommandLine createCommandLine(CliConsole console, String[] args, A
 
         commandLine.setParameterExceptionHandler(new UnknownCommandParameterExceptionHandler(rootParameterExceptionHandler, System.err));
 
+        final boolean isDebug = Arrays.stream(args).anyMatch(CliConstants.DEBUG::equals);
+        if (isDebug) {
+            Configurator c = org.jboss.logmanager.Logger.getLogger("").getAttachment(Configurator.ATTACHMENT_KEY);
+            if (c instanceof PropertyConfigurator) {
+                LogContextConfiguration lcc = ((PropertyConfigurator) c).getLogContextConfiguration();
+                lcc.getLoggerConfiguration("org.wildfly.prospero").setLevel(Level.DEBUG.getName());
+                lcc.getLoggerConfiguration("org.wildfly.prospero").addHandlerName("CONSOLE");
+                lcc.getHandlerConfiguration("CONSOLE").setLevel(Level.DEBUG.getName());
+                lcc.commit();
+            } else {
+                logger.warn("Cannot change logging level, using default.");
+            }
+        }
+
         return commandLine;
     }
 

diff --git a/prospero-cli/src/main/java/org/wildfly/prospero/cli/commands/AbstractCommand.java b/prospero-cli/src/main/java/org/wildfly/prospero/cli/commands/AbstractCommand.java
@@ -54,6 +54,13 @@ public abstract class AbstractCommand implements Callable<Integer> {
     )
     boolean verbose;
 
+    @SuppressWarnings("unused")
+    @CommandLine.Option(
+            names = {CliConstants.DEBUG},
+            order = 102
+    )
+    boolean debug;
+
     public AbstractCommand(CliConsole console, ActionFactory actionFactory) {
         this.console = console;
         this.actionFactory = actionFactory;

diff --git a/prospero-cli/src/main/java/org/wildfly/prospero/cli/commands/CliConstants.java b/prospero-cli/src/main/java/org/wildfly/prospero/cli/commands/CliConstants.java
@@ -95,6 +95,7 @@ private Commands() {
     public static final String VERSION = "--version";
     public static final String VV = "-vv";
     public static final String VERBOSE = "--verbose";
+    public static final String DEBUG = "--debug";
     public static final String Y = "-y";
     public static final String YES = "--yes";
 

diff --git a/prospero-cli/src/main/resources/UsageMessages.properties b/prospero-cli/src/main/resources/UsageMessages.properties
@@ -156,6 +156,8 @@ help = Displays the help information for this command.
 ${prospero.dist.name}.help = Displays the help information for the command.
 verbose = Prints additional information if the command fails.
 ${prospero.dist.name}.verbose = Prints additional information if the command fails.
+debug = Prints debug messages.
+${prospero.dist.name}.debug = Prints debug messages.
 local-cache = Path to the local Maven repository cache. It overrides the default Maven repository at ~/.m2/repository.
 no-resolve-local-cache.0 = Perform the operation without resolving or installing artifacts in the local maven cache.
 no-resolve-local-cache.1 = WARNING: Deprecated, please see --use-default-local-cache for alternatives.

diff --git a/prospero-cli/src/main/resources/logging.properties b/prospero-cli/src/main/resources/logging.properties
@@ -10,6 +10,7 @@ logger.level=ERROR
 # Declare handlers for the root logger
 logger.handlers=CONSOLE
 
+handlers=CONSOLE
 # Console handler configuration
 handler.CONSOLE=org.jboss.logmanager.handlers.ConsoleHandler
 handler.CONSOLE.properties=autoFlush