Adding logging framework to support i18n (#53)

Author: ddsharpe

.gitignore

@@ -2,6 +2,8 @@
 **/build
 *.iml
 .idea/
+!.idea/codeStyles/Project.xml
+!.idea/codeStyles/codeStyleConfig.xml
 **/target
 **/.DS_Store
 .flattened-pom.xml

.idea/codeStyles/Project.xml

@@ -16,23 +16,14 @@ handlers=java.util.logging.ConsoleHandler
 #
 
 com.oracle.weblogic.imagetool.level=INFO
-#com.oracle.weblogic.imagetool.cli.menu.CreateImage.level = FINEST
-#com.oracle.weblogic.imagetool.cli.menu.UpdateImage.level = FINEST
-#com.oracle.weblogic.imagetool.cli.menu.ImageOperation.level = FINEST
-#com.oracle.weblogic.imagetool.util.ARUUtil.level = FINEST
-#com.oracle.weblogic.imagetool.util.XPathUtil.level = FINEST
-#com.oracle.weblogic.imagetool.impl.PatchFile.level = FINEST
-#com.oracle.weblogic.imagetool.impl.InstallerFile.level = FINEST
-#com.oracle.weblogic.imagetool.util.Utils.level = FINEST
 
 #
 # Change log file location and handlers logging level as needed. Note the default level for FileHandler is OFF
 # and ConsoleHandler is INFO
 #
-java.util.logging.FileHandler.pattern=tool.log
+java.util.logging.FileHandler.pattern=imagetool.log
 java.util.logging.FileHandler.count=1
-java.util.logging.FileHandler.formatter=java.util.logging.SimpleFormatter
-java.util.logging.SimpleFormatter.format=[%1$tF %1$tT] [%3$s] [%4$-7s] %5$s %n
-java.util.logging.FileHandler.level=OFF
+java.util.logging.SimpleFormatter.format=[%4$-7s] %5$s %n
+java.util.logging.FileHandler.level=FINEST
 java.util.logging.ConsoleHandler.level=INFO
 

.idea/codeStyles/codeStyleConfig.xml

@@ -5,17 +5,18 @@
 
 import java.nio.file.Files;
 import java.nio.file.Paths;
-import java.util.logging.Logger;
 
 import com.oracle.weblogic.imagetool.api.FileResolver;
 import com.oracle.weblogic.imagetool.api.meta.CacheStore;
+import com.oracle.weblogic.imagetool.logging.LoggingFacade;
+import com.oracle.weblogic.imagetool.logging.LoggingFactory;
 
 /**
  * Base class to represent either an installer or a patch file.
  */
 public abstract class AbstractFile implements FileResolver {
 
-    private static final Logger logger = Logger.getLogger(AbstractFile.class.getName());
+    private static final LoggingFacade logger = LoggingFactory.getLogger(AbstractFile.class);
 
     private String key;
     protected CachePolicy cachePolicy;

imagetool/src/main/bin/logging.properties

@@ -4,12 +4,13 @@
 package com.oracle.weblogic.imagetool.cli;
 
 import java.util.concurrent.Callable;
-import java.util.logging.Logger;
 
 import com.oracle.weblogic.imagetool.api.model.CommandResponse;
 import com.oracle.weblogic.imagetool.cli.cache.CacheCLI;
 import com.oracle.weblogic.imagetool.cli.menu.CreateImage;
 import com.oracle.weblogic.imagetool.cli.menu.UpdateImage;
+import com.oracle.weblogic.imagetool.logging.LoggingFacade;
+import com.oracle.weblogic.imagetool.logging.LoggingFactory;
 import picocli.CommandLine;
 import picocli.CommandLine.Command;
 import picocli.CommandLine.HelpCommand;
@@ -33,6 +34,8 @@
 )
 public class CLIDriver implements Callable<CommandResponse> {
 
+    private static final LoggingFacade logger = LoggingFactory.getLogger(CLIDriver.class);
+
     @Override
     public CommandResponse call() {
         return null;
@@ -43,7 +46,6 @@ public CommandResponse call() {
       * @param args command line arguments.
      */
     public static void main(String[] args) {
-        Logger logger = Logger.getLogger(CLIDriver.class.getName());
         CLIDriver cliDriver = new CLIDriver();
         if (args.length == 0) {
             CommandLine.usage(cliDriver, System.out);

imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/AbstractFile.java

@@ -3,25 +3,18 @@
 
 package com.oracle.weblogic.imagetool.cli.cache;
 
-import java.io.FileInputStream;
-import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.List;
-import java.util.logging.Logger;
 
 import com.oracle.weblogic.imagetool.api.meta.CacheStore;
-import com.oracle.weblogic.imagetool.api.model.AbstractFile;
 import com.oracle.weblogic.imagetool.api.model.CommandResponse;
 import com.oracle.weblogic.imagetool.api.model.WLSInstallerType;
-import com.oracle.weblogic.imagetool.util.ARUUtil;
+import com.oracle.weblogic.imagetool.logging.LoggingFacade;
+import com.oracle.weblogic.imagetool.logging.LoggingFactory;
 import com.oracle.weblogic.imagetool.util.Constants;
-import com.oracle.weblogic.imagetool.util.SearchResult;
 import com.oracle.weblogic.imagetool.util.Utils;
-import com.oracle.weblogic.imagetool.util.XPathUtil;
-import org.apache.commons.codec.digest.DigestUtils;
-import org.w3c.dom.Document;
 import picocli.CommandLine.Command;
 import picocli.CommandLine.Option;
 
@@ -32,7 +25,7 @@
 )
 public class AddPatchEntry extends CacheOperation {
 
-    private final Logger logger = Logger.getLogger(AddPatchEntry.class.getName());
+    private static final LoggingFacade logger = LoggingFactory.getLogger(AddPatchEntry.class);
 
     public AddPatchEntry() {
     }

imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/CLIDriver.java

@@ -18,14 +18,15 @@
 import java.util.Properties;
 import java.util.Set;
 import java.util.logging.Level;
-import java.util.logging.Logger;
 import java.util.stream.Collectors;
 
 import com.oracle.weblogic.imagetool.api.model.CommandResponse;
 import com.oracle.weblogic.imagetool.api.model.DomainType;
 import com.oracle.weblogic.imagetool.api.model.InstallerType;
 import com.oracle.weblogic.imagetool.api.model.WLSInstallerType;
 import com.oracle.weblogic.imagetool.impl.InstallerFile;
+import com.oracle.weblogic.imagetool.logging.LoggingFacade;
+import com.oracle.weblogic.imagetool.logging.LoggingFactory;
 import com.oracle.weblogic.imagetool.util.ARUUtil;
 import com.oracle.weblogic.imagetool.util.Constants;
 import com.oracle.weblogic.imagetool.util.HttpUtil;
@@ -42,7 +43,7 @@
 )
 public class CreateImage extends ImageOperation {
 
-    private final Logger logger = Logger.getLogger(CreateImage.class.getName());
+    private static final LoggingFacade logger = LoggingFactory.getLogger(CreateImage.class);
 
     public CreateImage() {
         super();
@@ -54,7 +55,7 @@ public CreateImage(boolean isCLIMode) {
 
     @Override
     public CommandResponse call() throws Exception {
-        logger.finer("Entering CreateImage call ");
+        logger.entering();
         Instant startTime = Instant.now();
 
         String tmpDir = null;
@@ -69,15 +70,12 @@ public CommandResponse call() throws Exception {
             List<String> cmdBuilder = getInitialBuildCmd();
             tmpDir = getTempDirectory();
 
-            // this handles wls, jdk and wdt install files.
-            cmdBuilder.addAll(handleInstallerFiles(tmpDir));
-
             if (!Utils.validatePatchIds(patches, false)) {
                 return new CommandResponse(-1, "Patch ID validation failed");
             }
 
             if (fromImage != null && !fromImage.isEmpty()) {
-                logger.finer("User specified fromImage " + fromImage);
+                logger.finer("IMG-0002", fromImage);
                 dockerfileOptions.setBaseImage(fromImage);
 
                 Utils.copyResourceAsFile("/probe-env/test-create-env.sh",
@@ -95,7 +93,7 @@ public CommandResponse call() throws Exception {
                 String existingJavaHome = baseImageProperties.getProperty("JAVA_HOME", null);
                 if (existingJavaHome != null) {
                     dockerfileOptions.disableJavaInstall(existingJavaHome);
-                    logger.info("JAVA_HOME detected in base image, skipping JDK install: " + existingJavaHome);
+                    logger.info("IMG-0000", existingJavaHome);
                 }
 
                 if (ohAlreadyExists) {
@@ -111,6 +109,9 @@ public CommandResponse call() throws Exception {
                 dockerfileOptions.setPackageInstaller(Constants.YUM);
             }
 
+            // this handles wls, jdk and wdt install files.
+            cmdBuilder.addAll(handleInstallerFiles(tmpDir));
+
             // build wdt args if user passes --wdtModelPath
             cmdBuilder.addAll(handleWdtArgsIfRequired(tmpDir));
 
@@ -136,7 +137,7 @@ public CommandResponse call() throws Exception {
             }
         }
         Instant endTime = Instant.now();
-        logger.finer("Exiting CreateImage call ");
+        logger.exiting();
         return new CommandResponse(0, "build successful in "
                 + Duration.between(startTime, endTime).getSeconds() + "s. image tag: " + imageTag);
     }
@@ -151,12 +152,12 @@ public CommandResponse call() throws Exception {
      */
     private List<String> handleInstallerFiles(String tmpDir) throws Exception {
 
-        logger.finer("Entering CreateImage.handleInstallerFiles: " + tmpDir);
+        logger.entering(tmpDir);
         List<String> retVal = new LinkedList<>();
         List<InstallerFile> requiredInstallers = gatherRequiredInstallers();
         for (InstallerFile installerFile : requiredInstallers) {
             String targetFilePath = installerFile.resolve(cacheStore);
-            logger.finer("CreateImage.handleInstallerFiles copying targetFilePath: " + targetFilePath);
+            logger.finer("copying targetFilePath: {0}", targetFilePath);
             String filename = new File(targetFilePath).getName();
             try {
                 Files.copy(Paths.get(targetFilePath), Paths.get(tmpDir, filename));
@@ -165,7 +166,7 @@ private List<String> handleInstallerFiles(String tmpDir) throws Exception {
                 ee.printStackTrace();
             }
         }
-        logger.finer("Exiting CreateImage.handleInstallerFiles: ");
+        logger.exiting(retVal);
         return retVal;
     }
 
@@ -302,19 +303,22 @@ private List<String> getWdtRequiredBuildArgs(Path wdtVariablesPath) throws IOExc
      * @throws Exception in case of error
      */
     private List<InstallerFile> gatherRequiredInstallers() throws Exception {
-        logger.finer("Entering CreateImage.gatherRequiredInstallers: ");
+        logger.entering();
         List<InstallerFile> retVal = new LinkedList<>();
         if (wdtModelPath != null) {
+            logger.finer("IMG-0001", InstallerType.WDT, wdtVersion);
             InstallerFile wdtInstaller = new InstallerFile(useCache, InstallerType.WDT, wdtVersion, null, null);
             retVal.add(wdtInstaller);
             addWdtUrl(wdtInstaller.getKey());
         }
+        logger.finer("IMG-0001", installerType, installerVersion);
         retVal.add(new InstallerFile(useCache, InstallerType.fromValue(installerType.toString()), installerVersion,
                 userId, password));
-        retVal.add(new InstallerFile(useCache, InstallerType.JDK, jdkVersion, userId, password));
-        logger.finer("Exiting CreateImage.gatherRequiredInstallers: "
-                + installerType.toString() + ":" + installerVersion + ", "
-                + InstallerType.JDK + ":" + jdkVersion);
+        if (dockerfileOptions.installJava()) {
+            logger.finer("IMG-0001", InstallerType.JDK, jdkVersion);
+            retVal.add(new InstallerFile(useCache, InstallerType.JDK, jdkVersion, userId, password));
+        }
+        logger.exiting(retVal.size());
         return retVal;
     }
 

imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntry.java

@@ -13,7 +13,6 @@
 import java.util.LinkedList;
 import java.util.List;
 import java.util.concurrent.Callable;
-import java.util.logging.Logger;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 import java.util.stream.Collectors;
@@ -26,6 +25,8 @@
 import com.oracle.weblogic.imagetool.api.model.WLSInstallerType;
 import com.oracle.weblogic.imagetool.impl.PatchFile;
 import com.oracle.weblogic.imagetool.impl.meta.CacheStoreFactory;
+import com.oracle.weblogic.imagetool.logging.LoggingFacade;
+import com.oracle.weblogic.imagetool.logging.LoggingFactory;
 import com.oracle.weblogic.imagetool.util.ARUUtil;
 import com.oracle.weblogic.imagetool.util.Constants;
 import com.oracle.weblogic.imagetool.util.DockerfileOptions;
@@ -35,7 +36,7 @@
 
 public abstract class ImageOperation implements Callable<CommandResponse> {
 
-    private final Logger logger = Logger.getLogger(ImageOperation.class.getName());
+    private static final LoggingFacade logger = LoggingFactory.getLogger(ImageOperation.class);
     // DockerfileOptions provides switches and values to the customize the Dockerfile template
     protected DockerfileOptions dockerfileOptions;
     protected CacheStore cacheStore = new CacheStoreFactory().get();
@@ -91,7 +92,7 @@ private String handlePasswordOptions() throws IOException {
      * @throws Exception in case of error
      */
     List<String> handlePatchFiles(String tmpDir, Path tmpPatchesDir) throws Exception {
-        logger.finer("Entering ImageOperation.handlePatchFiles");
+        logger.entering();
         List<String> retVal = new LinkedList<>();
         List<String> patchLocations = new LinkedList<>();
         String toPatchesPath = tmpPatchesDir.toAbsolutePath().toString();
@@ -134,7 +135,7 @@ List<String> handlePatchFiles(String tmpDir, Path tmpPatchesDir) throws Exceptio
             retVal.add("PATCHDIR=" + Paths.get(tmpDir).relativize(tmpPatchesDir).toString());
             dockerfileOptions.setPatchingEnabled();
         }
-        logger.finer("Exiting ImageOperation.handlePatchFiles");
+        logger.exiting(retVal.size());
         return retVal;
     }
 
@@ -178,7 +179,7 @@ public String getTempDirectory() throws IOException {
         Path tmpDir = Files.createTempDirectory(Paths.get(Utils.getBuildWorkingDir()), "wlsimgbuilder_temp",
                 PosixFilePermissions.asFileAttribute(PosixFilePermissions.fromString("rwxr-xr-x")));
         String pathAsString = tmpDir.toAbsolutePath().toString();
-        logger.info("tmp directory used for docker build context: " + pathAsString);
+        logger.info("IMG-0003", pathAsString);
         return pathAsString;
     }
 

imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CreateImage.java

@@ -14,10 +14,11 @@
 import java.util.List;
 import java.util.Properties;
 import java.util.Set;
-import java.util.logging.Logger;
 
 import com.oracle.weblogic.imagetool.api.model.CommandResponse;
 import com.oracle.weblogic.imagetool.api.model.WLSInstallerType;
+import com.oracle.weblogic.imagetool.logging.LoggingFacade;
+import com.oracle.weblogic.imagetool.logging.LoggingFactory;
 import com.oracle.weblogic.imagetool.util.ARUUtil;
 import com.oracle.weblogic.imagetool.util.Constants;
 import com.oracle.weblogic.imagetool.util.Utils;
@@ -33,7 +34,7 @@
 )
 public class UpdateImage extends ImageOperation {
 
-    private final Logger logger = Logger.getLogger(UpdateImage.class.getName());
+    private static final LoggingFacade logger = LoggingFactory.getLogger(UpdateImage.class);
 
     public UpdateImage() {
         super();