Added support to override FMW installer response file. (#57)

* Added support to override FMW installer response file.
* Set Oracle Home based on contents of installer response file

Author: ddsharpe

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

@@ -67,7 +67,6 @@ public CommandResponse call() throws Exception {
                 return result;
             }
 
-            List<String> cmdBuilder = getInitialBuildCmd();
             tmpDir = getTempDirectory();
 
             if (!Utils.validatePatchIds(patches, false)) {
@@ -109,6 +108,8 @@ public CommandResponse call() throws Exception {
                 dockerfileOptions.setPackageInstaller(Constants.YUM);
             }
 
+            List<String> cmdBuilder = getInitialBuildCmd();
+
             // this handles wls, jdk and wdt install files.
             cmdBuilder.addAll(handleInstallerFiles(tmpDir));
 
@@ -120,6 +121,7 @@ public CommandResponse call() throws Exception {
 
             // Copy wls response file to tmpDir
             copyResponseFilesToDir(tmpDir);
+            Utils.setOracleHome(installerResponseFile, dockerfileOptions);
 
             // Create Dockerfile
             Utils.writeDockerfile(tmpDir + File.separator + "Dockerfile", "Create_Image.mustache",
@@ -192,7 +194,7 @@ List<String> handlePatchFiles(String tmpDir, Path tmpPatchesDir) throws Exceptio
                     new ArrayList<>(toValidateSet), installerType.toString(), installerVersion, userId,
                     password);
             if (validationResult.isSuccess()) {
-                logger.info("patch conflict check successful");
+                logger.info("IMG-0006");
             } else {
                 String error = validationResult.getErrorMessage();
                 logger.severe(error);
@@ -329,7 +331,7 @@ private List<InstallerFile> gatherRequiredInstallers() throws Exception {
      * @throws Exception in case of error
      */
     private void addWdtUrl(String wdtKey) throws Exception {
-        logger.finer("Entering CreateImage.wdtKey: ");
+        logger.entering(wdtKey);
         String wdtUrlKey = wdtKey + "_url";
         if (cacheStore.getValueFromCache(wdtKey) == null) {
             if (userId == null || password == null) {
@@ -340,13 +342,13 @@ private void addWdtUrl(String wdtKey) throws Exception {
                     "weblogic-deploy-tooling-" + wdtVersion;
             if (wdtTags.contains(tagToMatch)) {
                 String downloadLink = String.format(Constants.WDT_URL_FORMAT, tagToMatch);
-                logger.info("WDT Download link = " + downloadLink);
+                logger.info("IMG-0007", downloadLink);
                 cacheStore.addToCache(wdtUrlKey, downloadLink);
             } else {
                 throw new Exception("Couldn't find WDT download url for version:" + wdtVersion);
             }
         }
-        logger.finer("Exiting CreateImage.wdtKey: ");
+        logger.exiting();
     }
 
     /**
@@ -356,7 +358,16 @@ private void addWdtUrl(String wdtKey) throws Exception {
      * @throws IOException in case of error
      */
     private void copyResponseFilesToDir(String dirPath) throws IOException {
-        Utils.copyResourceAsFile("/response-files/wls.rsp", dirPath, false);
+        if (installerResponseFile != null && Files.isRegularFile(installerResponseFile)) {
+            logger.fine("IMG-0005", installerResponseFile);
+            Path target = Paths.get(dirPath, "wls.rsp");
+            Files.copy(installerResponseFile, target);
+        } else {
+            final String responseFile = "/response-files/wls.rsp";
+            logger.fine("IMG-0005", responseFile);
+            Utils.copyResourceAsFile(responseFile, dirPath, false);
+        }
+
         Utils.copyResourceAsFile("/response-files/oraInst.loc", dirPath, false);
     }
 
@@ -447,4 +458,9 @@ private void copyResponseFilesToDir(String dirPath) throws IOException {
     private String opatchBugNumber;
 
 
+    @Option(
+            names = {"--installerResponseFile"},
+            description = "path to a response file. Override the default responses for the Oracle installer"
+    )
+    private Path installerResponseFile;
 }

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

@@ -146,7 +146,7 @@ List<String> handlePatchFiles(String tmpDir, Path tmpPatchesDir) throws Exceptio
      */
     List<String> getInitialBuildCmd() {
 
-        logger.finer("Entering ImageOperation.getInitialBuildCmd");
+        logger.entering();
         List<String> cmdBuilder = Stream.of("docker", "build",
                 "--force-rm=true", "--no-cache").collect(Collectors.toList());
 
@@ -171,7 +171,7 @@ List<String> getInitialBuildCmd() {
         if (dockerPath != null && Files.isExecutable(dockerPath)) {
             cmdBuilder.set(0, dockerPath.toAbsolutePath().toString());
         }
-        logger.finer("Exiting ImageOperation.getInitialBuildCmd");
+        logger.exiting();
         return cmdBuilder;
     }
 

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

@@ -89,8 +89,7 @@ public CommandResponse call() throws Exception {
                 String opatchFile = cacheStore.getValueFromCache(opatchBugNumber + "_opatch");
                 if (opatchFile != null) {
                     opatchBugNumberVersion = Utils.getOpatchVersionFromZip(opatchFile);
-                    logger.info(String.format("OPatch patch number %s cached file %s version %s", opatchBugNumber,
-                            opatchFile, opatchBugNumberVersion));
+                    logger.info("IMG-0008", opatchBugNumber, opatchFile, opatchBugNumberVersion);
                 } else {
                     String msg = String.format("OPatch patch number --opatchBugNumber %s cannot be found in cache",
                             opatchBugNumber);
@@ -111,7 +110,7 @@ public CommandResponse call() throws Exception {
             if (latestPSU || !patches.isEmpty()) {
                 logger.finer("Verifying Patches to WLS ");
                 if (userId == null) {
-                    logger.warning("skipping patch conflict check, no support credentials provided ");
+                    logger.warning("IMG-0009");
                 } else {
 
                     if (!Utils.validatePatchIds(patches, false)) {
@@ -152,7 +151,7 @@ public CommandResponse call() throws Exception {
                         if (!validationResult.isSuccess()) {
                             return new CommandResponse(-1, validationResult.getErrorMessage());
                         } else {
-                            logger.info("patch conflict check successful");
+                            logger.info("IMG-0006");
                         }
                     } else {
                         return new CommandResponse(-1, "lsinventory missing. required to check for conflicts");

imagetool/src/main/java/com/oracle/weblogic/imagetool/util/DockerfileOptions.java

@@ -4,7 +4,6 @@
 package com.oracle.weblogic.imagetool.util;
 
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.List;
 import java.util.StringJoiner;
 
@@ -23,6 +22,7 @@ public class DockerfileOptions {
     private String username;
     private String groupname;
     private String javaHome;
+    private String oracleHome;
     private String tempDirectory;
     private String baseImageName;
     private ArrayList<String> wdtModelList;
@@ -42,6 +42,7 @@ public DockerfileOptions() {
         groupname = "oracle";
 
         javaHome = "/u01/jdk";
+        oracleHome = "/u01/oracle";
         tempDirectory = "/tmp/delme";
 
         baseImageName = "oraclelinux:7-slim";
@@ -128,6 +129,14 @@ public String java_home() {
         return javaHome;
     }
 
+    public String oracle_home() {
+        return oracleHome;
+    }
+
+    public void setOracleHome(String value) {
+        oracleHome = value;
+    }
+
     /**
      * Set the JAVA_HOME environment variable for the Dockerfile to be written.
      *

imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java

@@ -5,6 +5,7 @@
 
 import java.io.BufferedReader;
 import java.io.File;
+import java.io.FileNotFoundException;
 import java.io.FileOutputStream;
 import java.io.FileReader;
 import java.io.FileWriter;
@@ -29,7 +30,6 @@
 import java.util.List;
 import java.util.Objects;
 import java.util.Properties;
-import java.util.logging.Logger;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 import java.util.stream.Collectors;
@@ -532,7 +532,7 @@ public static String getPasswordFromInputs(String passwordStr, Path passwordFile
             throws IOException {
         if (!isEmptyString(passwordStr)) {
             return passwordStr;
-        } else if (passwordFile != null && Files.isRegularFile(passwordFile) && Files.size(passwordFile) > 0) {
+        } else if (validFile(passwordFile)) {
             try (BufferedReader bufferedReader = new BufferedReader(new FileReader(passwordFile.toFile()))) {
                 return bufferedReader.readLine();
             }
@@ -674,4 +674,45 @@ public static boolean validatePatchIds(List<String> patches, boolean rigid) {
 
         return result;
     }
+
+    /**
+     * Set the Oracle Home directory based on the installer response file.
+     * If no Oracle Home is provided in the response file, do nothing and accept the default value.
+     * @param installerResponseFile installer response file to parse.
+     * @param options Dockerfile options to use for the build (holds the Oracle Home argument)
+     */
+    public static void setOracleHome(Path installerResponseFile, DockerfileOptions options) throws IOException {
+        if (installerResponseFile == null) {
+            return;
+        }
+
+        Pattern pattern = Pattern.compile("^ORACLE_HOME=(.*)?");
+        Matcher matcher = pattern.matcher("");
+        logger.finest("Reading installer response file: {0}", installerResponseFile.getFileName());
+
+        try {
+            BufferedReader reader = new BufferedReader(new FileReader(installerResponseFile.toFile()));
+            String line;
+            while ((line = reader.readLine()) != null) {
+                logger.finest("Read response file line: {0}", line);
+
+                matcher.reset(line);
+                if (matcher.find()) {
+                    String oracleHome = matcher.group(1);
+                    if (oracleHome != null) {
+                        options.setOracleHome(oracleHome);
+                        logger.info("IMG-0010", oracleHome);
+                    }
+                    break;
+                }
+            }
+        } catch (FileNotFoundException notFound) {
+            logger.severe("Unable to find installer response file: {0}", installerResponseFile);
+            throw notFound;
+        }
+    }
+
+    private static boolean validFile(Path file) throws IOException {
+        return file != null && Files.isRegularFile(file) && Files.size(file) > 0;
+    }
 }

imagetool/src/main/resources/ImageTool.properties

@@ -2,4 +2,10 @@ IMG-0000=JAVA_HOME detected in base image, skipping JDK install: {0}
 IMG-0001=Gathering installer {0}:{1}
 IMG-0002=User specified fromImage {0}
 IMG-0003=Temporary directory used for docker build context: {0}
-IMG-0004=Invalid patch id {0}. The patch id must be in the format of {1}.  Where the first part is the 8 digit patch ID, and the second half, after the underscore, is the release version for the patch. The release version needs to be specified with 5 places such as 12.2.1.3.0 or 12.2.1.3.190416. Release version is required when adding a patch to the cache or when multiple versions of the same patch number exist for different versions.
+IMG-0004=Invalid patch id {0}. The patch id must be in the format of {1}.  Where the first part is the 8 digit patch ID, and the second half, after the underscore, is the release version for the patch. The release version needs to be specified with 5 places such as 12.2.1.3.0 or 12.2.1.3.190416. Release version is required when adding a patch to the cache or when multiple versions of the same patch number exist for different versions.
+IMG-0005=Installer response file: {0}
+IMG-0006=patch conflict check successful
+IMG-0007=WDT Download link = {0}
+IMG-0008=OPatch patch number {0} cached file {1} version {2}
+IMG-0009=skipping patch conflict check, no support credentials provided
+IMG-0010=Oracle Home will be set to {0}