Support for Ansi colors in console logger (#177)

Author: ddsharpe

imagetool/src/main/bin/logging.properties

@@ -23,7 +23,7 @@ com.oracle.weblogic.imagetool.level=INFO
 #
 java.util.logging.FileHandler.pattern=imagetool.log
 java.util.logging.FileHandler.count=1
-java.util.logging.SimpleFormatter.format=[%4$-7s] %5$s %n
 java.util.logging.FileHandler.level=FINEST
 java.util.logging.ConsoleHandler.level=INFO
+#java.util.logging.ConsoleHandler.color=false
 

imagetool/src/main/java/com/oracle/weblogic/imagetool/logging/AnsiColor.java

@@ -0,0 +1,72 @@
+// Copyright (c) 2020, Oracle Corporation and/or its affiliates.
+// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
+
+package com.oracle.weblogic.imagetool.logging;
+
+public enum AnsiColor {
+    RESET("reset", "\u001B[0m"),
+
+    // basic 8 colors (available on almost all basic terminals)
+    BLACK("black","\u001B[30m"),
+    BLUE("blue","\u001B[34m"),
+    CYAN("cyan","\u001B[36m"),
+    GREEN("green","\u001B[32m"),
+    PURPLE("purple","\u001B[35m"),
+    RED("red","\u001B[31m"),
+    WHITE("white","\u001B[37m"),
+    YELLOW("yellow","\u001B[33m"),
+
+    // bright or bold versions of the basic 8
+    BRIGHT_BLACK("brightblack", "\u001b[30;1m"),
+    BRIGHT_BLUE("brightblue", "\u001b[34;1m"),
+    BRIGHT_CYAN("brightcyan", "\u001b[36;1m"),
+    BRIGHT_GREEN("brightgreen", "\u001b[32;1m"),
+    BRIGHT_PURPLE("brightpurple", "\u001b[35;1m"),
+    BRIGHT_RED("brightred", "\u001b[31;1m"),
+    BRIGHT_WHITE("brightwhite", "\u001b[37;1m"),
+    BRIGHT_YELLOW("brightyellow", "\u001b[33;1m"),
+
+    // decorations
+    BOLD("bold","\u001b[1m"),
+    UNDERLINE("underline","\u001b[4m");
+
+    private static boolean colorEnabled = true;
+    private String name;
+    private String value;
+
+    AnsiColor(String name, String value) {
+        this.name = name;
+        this.value = value;
+    }
+
+    /**
+     * Disables color logging.  These enums will resolve to empty strings.
+     */
+    public static void disable() {
+        colorEnabled = false;
+    }
+
+    /**
+     * Convert the string value to a data type enum value.
+     *
+     * @param name color name to search for
+     * @return matching enum for provided name, or null if not found
+     */
+    public static AnsiColor fromValue(String name) {
+        for (AnsiColor eachVal : AnsiColor.values()) {
+            if (eachVal.name.equalsIgnoreCase(name)) {
+                return eachVal;
+            }
+        }
+        return null;
+    }
+
+    @Override
+    public String toString() {
+        if (colorEnabled) {
+            return value;
+        } else {
+            return "";
+        }
+    }
+}

imagetool/src/main/java/com/oracle/weblogic/imagetool/logging/ConsoleFormatter.java

@@ -0,0 +1,116 @@
+// Copyright (c) 2020, Oracle Corporation and/or its affiliates.
+// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
+
+package com.oracle.weblogic.imagetool.logging;
+
+import java.io.PrintWriter;
+import java.io.StringWriter;
+import java.util.logging.Formatter;
+import java.util.logging.Level;
+import java.util.logging.LogManager;
+import java.util.logging.LogRecord;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+/**
+ * A color-capable formatter for the console that defines a fixed output format.
+ * Format is "[ LEVEL ] message", with optional throw-ables.
+ */
+public class ConsoleFormatter extends Formatter {
+    private static final String LINE_SEPARATOR = System.getProperty("line.separator");
+    private static final Pattern colorPattern = Pattern.compile("\\[\\[([a-z]+): (.+?)]]");
+
+    static {
+        // if user is redirecting output, do not print color codes
+        if (System.console() == null) {
+            AnsiColor.disable();
+        } else {
+            // check logging properties to see if the user wants to disable color output
+            String flag = LogManager.getLogManager().getProperty("java.util.logging.ConsoleHandler.color");
+            if (flag == null) {
+                String os = System.getProperty("os.name");
+                if (os != null && os.toLowerCase().contains("win")) {
+                    // For the Windows OS, default the color logging to disabled
+                    // The Windows OS terminal does not enable color by default
+                    AnsiColor.disable();
+                }
+                // The default for non-Windows OS's is color enabled.
+            } else if (flag.equalsIgnoreCase("false")) {
+                AnsiColor.disable();
+            }
+        }
+    }
+
+    private AnsiColor getMessageLevelColor(Level level) {
+        if (level.intValue() > 800) {
+            return AnsiColor.BRIGHT_RED;
+        } else if (level.intValue() < 800) {
+            return AnsiColor.BRIGHT_WHITE;
+        } else {
+            return AnsiColor.BRIGHT_BLUE;
+        }
+    }
+
+    private String replaceColorTokens(String text) {
+        Matcher matcher = colorPattern.matcher(text);
+
+        StringBuilder builder = new StringBuilder();
+        int i = 0;
+        while (matcher.find()) {
+            AnsiColor replacement = AnsiColor.fromValue(matcher.group(1));
+            builder.append(text, i, matcher.start());
+            if (replacement == null) {
+                builder.append(matcher.group(0));
+            } else {
+                builder.append(replacement);
+                builder.append(matcher.group(2));
+                builder.append(AnsiColor.RESET);
+            }
+            i = matcher.end();
+        }
+        builder.append(text.substring(i));
+        return builder.toString();
+    }
+
+    /**
+     * Formats the log record.
+     *
+     * @param record the log record
+     * @return the formatted log record
+     */
+    @Override
+    public synchronized String format(LogRecord record) {
+        StringBuilder sb = new StringBuilder();
+
+        // Level
+        sb.append("[")
+            .append(getMessageLevelColor(record.getLevel()))
+            .append(String.format("%-7s", record.getLevel().getLocalizedName()))
+            .append(AnsiColor.RESET)
+            .append("] ");
+
+        // message
+        sb.append(replaceColorTokens(formatMessage(record)));
+
+        // throwable
+        if (record.getThrown() != null) {
+            try {
+                StringWriter sw = new StringWriter();
+                PrintWriter pw = new PrintWriter(sw);
+                record.getThrown().printStackTrace(pw);
+                pw.close();
+                sb.append(LINE_SEPARATOR)
+                    .append(sw.toString())
+                    .append(LINE_SEPARATOR);
+            } catch (Exception ex) {
+                //ignore
+            }
+        }
+
+        // end of line
+        sb.append(AnsiColor.RESET)
+            .append(LINE_SEPARATOR);
+        return sb.toString();
+    }
+
+}

imagetool/src/main/java/com/oracle/weblogic/imagetool/logging/FileFormatter.java

@@ -18,7 +18,6 @@ public class FileFormatter extends Formatter {
     private static final String CATALOG_KEY_PATTERN_STRING = "^[A-Z]{3,10}?-[0-9]{3,5}?$";
     private static final Pattern CATALOG_KEY_PATTERN = Pattern.compile(CATALOG_KEY_PATTERN_STRING);
 
-    //private static final String DATE_FORMAT_STRING = "####<{0,date} {0,time}>";
     private static final String DATE_FORMAT_STRING = "####<{0,date,yyyy.MM.dd} {0,time,HH:mm:ss}>";
     private static final String LINE_SEPARATOR = System.getProperty("line.separator");
 

imagetool/src/main/java/com/oracle/weblogic/imagetool/logging/LoggingFacade.java

@@ -3,6 +3,7 @@
 
 package com.oracle.weblogic.imagetool.logging;
 
+import java.util.logging.ConsoleHandler;
 import java.util.logging.FileHandler;
 import java.util.logging.Handler;
 import java.util.logging.Level;
@@ -31,6 +32,9 @@ public LoggingFacade(Logger logger) {
             if (handler instanceof FileHandler) {
                 handler.setFormatter(new FileFormatter());
             }
+            if (handler instanceof ConsoleHandler) {
+                handler.setFormatter(new ConsoleFormatter());
+            }
         }
     }
 

imagetool/src/main/java/com/oracle/weblogic/imagetool/logging/LoggingFactory.java

@@ -46,13 +46,7 @@ public static LoggingFacade getLogger(String name) {
      */
     public static synchronized LoggingFacade getLogger(String name, String resourceBundleName) {
 
-        LoggingFacade lf = facade.get(resourceBundleName);
-        if (lf == null) {
-            Logger logger = Logger.getLogger(name, resourceBundleName);
-            lf = new LoggingFacade(logger);
-            facade.put(resourceBundleName, lf);
-        }
-
-        return lf;
+        return facade.computeIfAbsent(resourceBundleName,
+            k -> new LoggingFacade(Logger.getLogger(name, resourceBundleName)));
     }
 }

imagetool/src/main/resources/ImageTool.properties

@@ -8,15 +8,15 @@ IMG-0006=No patch conflicts detected
 IMG-0007={0} is not a directory
 IMG-0008=Updating OPatch in final image from version {0} to version {1}
 IMG-0009=skipping patch conflict check, no support credentials provided
-IMG-0010=Oracle Home will be set to {0}
+IMG-0010=Oracle Home will be set to [[cyan: {0}]]
 IMG-0011=Installer with key="{0}" is not in the local cache, please download the installer and add it to the cache with "imagetool cache addInstaller ..."
 IMG-0012=Validating patches
 IMG-0013=Error parsing additional build commands file {0}
 IMG-0014=Additional build command section, {0}, was not one of the valid sections: {1}
 IMG-0015=Additional build commands, adding {0} lines to section [{1}]
-IMG-0016=Image Tool build ID: {0}
-IMG-0017=Using patch {0} from cache: {1}
-IMG-0018=Downloading patch {0}...
+IMG-0016=Image Tool build ID: [[cyan: {0}]]
+IMG-0017=Using patch [[cyan: {0}]] from cache: {1}
+IMG-0018=Downloading patch [[cyan: {0}]]...
 IMG-0019=Finding patch number for latest PSU...
 IMG-0020=Latest PSU patch number is {0}
 IMG-0021=ORACLE_HOME value must be the same in both new and old image in order to rebase the domain
@@ -37,7 +37,7 @@ IMG-0035=additionalBuildFile could not be copied: {0}
 IMG-0036=Unable to find installer inventory file: {0}
 IMG-0037=Failed to find patch {0} for version {1}
 IMG-0038=In image {0}, the Oracle Home already exists at location: {1}
-IMG-0039=Using middleware installers ({0}) version {1}
+IMG-0039=Using middleware installers ([[green: {0}]]) version [[cyan: {1}]]
 IMG-0040=When providing custom response files, a response file must be provided for each of the installers {0}.  Found {1}, expected {2}.
 IMG-0041=Using provided installer response file: {0} for {1} install
 IMG-0042={0} was not found or is not a regular file
@@ -51,14 +51,14 @@ IMG-0049=Could not find value for --path, file not found: {0}
 IMG-0050=Successfully added to cache. {0}={1}
 IMG-0051=Deleted entry {0}={1}
 IMG-0052=Nothing to delete for key: {0}
-IMG-0053=Build successful. Build time={0}s. Image tag={1}
-IMG-0054=Dry run complete.  No image created.
+IMG-0053=[[brightgreen: Build successful.]] Build time={0}s. Image tag={1}
+IMG-0054=[[brightgreen: Dry run complete.]]  No image created.
 IMG-0055=RunRCU can only be used when creating a new domain.  Please try --wdtOperation=CREATE or removing --wdtRunRCU.
 IMG-0056=Patch {0} is not in the cache store and you have not provided Oracle Support credentials.  Please provide --user with one of the password options or populate the cache store manually.
 IMG-0057=Could not locate patch ID {0} from Oracle
 IMG-0058=A patch cannot have an empty/null bug number: {0}
 IMG-0059=Invalid response from Oracle ARU, unable to locate download URL for {0}
-IMG-0060=Adding patch {0} to cache, path={1}
+IMG-0060=Adding patch [[cyan: {0}]] to cache, path={1}
 IMG-0061=Could not find key {0} in the cache for patch {1}
 IMG-0062=An OPatch version could not be found in the cache store and you have not provided Oracle Support credentials. Please provide --user with one of the password options or populate the cache store manually.
 IMG-0063=Found matching patch for {0}, but version is {1}. Check OPatch messages during build phase for issues with this patch.