Provide options for specifying inventory file and location #103 (#107)

jshum2479 · ddsharpe · commit b4536b602748 · 2019-12-16T11:09:35.000-06:00
* Add support for specifying inventory location and file

* update documentation

* bug fixes

* Copy the user provided inventory pointer file as oraInst.loc

* remove INV_LOC and change final oraInst layer copy

* optimize inventory files copying
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CreateImage.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CreateImage.java
@@ -6,6 +6,7 @@
 import java.io.File;
 import java.time.Duration;
 import java.time.Instant;
+import java.util.ArrayList;
 import java.util.List;
 import java.util.Properties;
 import java.util.UUID;
@@ -76,8 +77,22 @@ public CommandResponse call() throws Exception {
 
             // Copy wls response file to tmpDir
             WLSInstallHelper.copyResponseFilesToDir(tmpDir, installerResponseFile);
+
             Utils.setOracleHome(installerResponseFile, dockerfileOptions);
 
+            // Set where the user want to install the inventor oraInst.loc file
+
+            if (inventoryPointerInstallLoc != null) {
+                dockerfileOptions.setInventoryPointerFileSet(true);
+                dockerfileOptions.setInvLoc(inventoryPointerInstallLoc);
+            }
+
+            // Set the inventory location, so that it will be copied
+            if (inventoryPointerFile != null) {
+                Utils.setInventoryLocation(inventoryPointerFile, dockerfileOptions);
+                Utils.copyLocalFile(inventoryPointerFile, tmpDir + "/oraInst.loc", false);
+            }
+
             // Create Dockerfile
             String dockerfile = Utils.writeDockerfile(tmpDir + File.separator + "Dockerfile",
                 "Create_Image.mustache", dockerfileOptions, dryRun);
@@ -154,6 +169,18 @@ String getInstallerVersion() {
     )
     private String installerResponseFile;
 
+    @Option(
+        names = {"--inventoryPointerFile"},
+        description = "path to a user provided inventory pointer file as input"
+    )
+    private String inventoryPointerFile;
+
+    @Option(
+        names = {"--inventoryPointerInstallLoc"},
+        description = "path to where the inventory pointer file (oraInst.loc) should be stored in the image"
+    )
+    private String inventoryPointerInstallLoc;
+
     @ArgGroup(exclusive = false, heading = "WDT Options%n")
     private WdtOptions wdtOptions = new WdtOptions();
 }
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/DockerfileOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/DockerfileOptions.java
@@ -3,6 +3,7 @@
 
 package com.oracle.weblogic.imagetool.util;
 
+import java.io.File;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
@@ -15,6 +16,10 @@ public class DockerfileOptions {
     private static final String DEFAULT_JAVA_HOME = "/u01/jdk";
     private static final String DEFAULT_ORACLE_HOME = "/u01/oracle";
     private static final String DEFAULT_DOMAIN_HOME = "/u01/domains/base_domain";
+    // Default location for the oraInst.loc
+    private static final String DEFAULT_INV_LOC = "/u01/oracle";
+
+    private static final String DEFAULT_ORAINV_DIR = "/u01/oracle/oraInventory";
 
     final String buildId;
     boolean useYum = false;
@@ -26,13 +31,16 @@ public class DockerfileOptions {
     private boolean applyPatches;
     private boolean updateOpatch;
     private boolean skipJavaInstall;
+    private boolean inventoryPointerFileSet = false;
     private boolean isRebaseToTarget;
     private boolean isRebaseToNew;
 
     private String username;
     private String groupname;
     private String javaHome;
     private String oracleHome;
+    private String invLoc;
+    private String oraInvDir;
     private String domainHome;
     private String tempDirectory;
     private String baseImageName;
@@ -70,6 +78,9 @@ public DockerfileOptions(String buildId) {
         javaHome = DEFAULT_JAVA_HOME;
         oracleHome = DEFAULT_ORACLE_HOME;
         domainHome = DEFAULT_DOMAIN_HOME;
+        invLoc = DEFAULT_INV_LOC;
+        oraInvDir = DEFAULT_ORAINV_DIR;
+
         tempDirectory = "/tmp/imagetool";
 
         baseImageName = "oraclelinux:7-slim";
@@ -245,6 +256,16 @@ public String oracle_home() {
         return oracleHome;
     }
 
+
+    public String inv_loc() {
+        return invLoc;
+    }
+
+    public String orainv_dir() {
+        return oraInvDir;
+    }
+
+
     @SuppressWarnings("unused")
     public String domain_home() {
         return domainHome;
@@ -277,6 +298,29 @@ public void setOracleHome(String value) {
         }
     }
 
+
+    /**
+     * Set the INV_LOC environment variable for the Dockerfile to be written.
+     *
+     * @param value the folder where Oracle Middleware is or should be installed, aka INV_LOC.
+     */
+    public void setInvLoc(String value) {
+        if (value != null) {
+            invLoc = value;
+        } else {
+            invLoc = DEFAULT_INV_LOC;
+        }
+    }
+
+
+    public void setOraInvDir(String value) {
+        if (value != null) {
+            oraInvDir = value;
+        } else {
+            oraInvDir = DEFAULT_ORAINV_DIR;
+        }
+    }
+
     /**
      * Set the Domain directory to be used by WDT domain creation.
      * WDT -domain_home.
@@ -391,6 +435,42 @@ public boolean isWdtEnabled() {
         return useWdt;
     }
 
+
+    /**
+     * copyOraInst check if it needs to copy the oraInst.loc file.
+     * @return true if it needs to copy
+     */
+
+    public boolean copyOraInst() {
+        return !isSubDirectoryOrSame(invLoc, oracleHome);
+    }
+
+    /**
+     * copyOraInventoryDir check if it needs to copy the oraInventory Directory.
+     * @return true if it needs to copy
+     */
+
+    public boolean copyOraInventoryDir() {
+        return !isSubDirectoryOrSame(oraInvDir, oracleHome);
+    }
+
+    /**
+     * isSubDirectoryOrSame compare if the child is a subdirectory of parent (non java.io implementation).
+     * @param child  child directory name
+     * @param parent parent directory name
+     * @return true if child is a subdirectory of parent otherwise false
+     */
+
+    private static boolean isSubDirectoryOrSame(String child, String parent) {
+        boolean result = true;
+        child = child.endsWith(File.separator) ? child.substring(0, child.length() - 1) : child;
+        parent = parent.endsWith(File.separator) ? parent.substring(0, parent.length() - 1) : parent;
+        if (!child.equals(parent)) {
+            result = child.startsWith(parent);
+        }
+        return result;
+    }
+
     /**
      * If WDT is enabled, and the model is not in the archive, the model file argument must be set.
      * @param value a model filename, or comma-separated model filenames.
@@ -403,6 +483,19 @@ public DockerfileOptions setWdtModels(List<String> value) {
         return this;
     }
 
+    /**
+     * If inventoryPointerFileSet is set.
+     *
+     * @return true if inventoryPointerFileSet is set
+     */
+    public boolean isInventoryPointerFileSet() {
+        return inventoryPointerFileSet;
+    }
+
+    public void setInventoryPointerFileSet(boolean value) {
+        this.inventoryPointerFileSet = value;
+    }
+
     /**
      * Referenced by Dockerfile template, a simple list of model filenames.
      *
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java
@@ -83,6 +83,27 @@ public static void copyResourceAsFile(String resourcePath, String destPath, bool
         }
     }
 
+    /**
+     * Utility method to copy a local file to another local file system location.
+     *
+     * @param sourcePath   resource path in the local directory
+     * @param destPath     local file to copy to.
+     * @param markExec     sets the executable flag if true
+     * @throws IOException in case of error
+     */
+    public static void copyLocalFile(String sourcePath, String destPath, boolean markExec) throws IOException {
+        Objects.requireNonNull(sourcePath);
+        Objects.requireNonNull(destPath);
+        Files.copy(Paths.get(sourcePath), Paths.get(destPath),
+            StandardCopyOption.REPLACE_EXISTING);
+        if (markExec) {
+            if (!System.getProperty("os.name").toLowerCase().startsWith("windows")) {
+                Files.setPosixFilePermissions(Paths.get(destPath), PosixFilePermissions.fromString("r-xr-xr-x"));
+            }
+        }
+    }
+
+
     /**
      * Create a file with the given path.
      *
@@ -728,6 +749,46 @@ public static void setOracleHome(String installerResponse, DockerfileOptions opt
         }
     }
 
+
+    /**
+     * Set the Inventory Location directory based on the inventory pointer  file.
+     *
+     * @param inventoryLocFile installer response file to parse.
+     * @param options           Dockerfile options to use for the build (holds the Oracle Home argument)
+     */
+    public static void setInventoryLocation(String inventoryLocFile, DockerfileOptions options) throws IOException {
+        if (inventoryLocFile == null) {
+            return;
+        }
+        Path inventoryLoc = Paths.get(inventoryLocFile);
+        Pattern pattern = Pattern.compile("^\\s*inventory_loc=(.*)?");
+        Matcher matcher = pattern.matcher("");
+        logger.finer("Reading inventory location file: {0}", inventoryLoc.getFileName());
+
+        try {
+            BufferedReader reader = new BufferedReader(new FileReader(inventoryLoc.toFile()));
+            String line;
+            while ((line = reader.readLine()) != null) {
+                logger.finest("Read inventory loc file line: {0}", line);
+
+                matcher.reset(line);
+                if (matcher.find()) {
+                    String invLoc = matcher.group(1);
+                    if (invLoc != null) {
+                        options.setOraInvDir(invLoc);
+                    }
+                    break;
+                }
+            }
+        } catch (FileNotFoundException notFound) {
+            logger.severe("IMG-0036", inventoryLoc);
+            throw notFound;
+        }
+    }
+
+
+
+
     private static boolean validFile(Path file) throws IOException {
         return file != null && Files.isRegularFile(file) && Files.size(file) > 0;
     }
diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties
@@ -34,3 +34,4 @@ IMG-0032=Failed to find latest PSU for {0}, version {1}
 IMG-0033=No credentials provided, skipping validation of patches
 IMG-0034=There are multiple patches found with id {0}, please specify the format as one of the following for the release you want
 IMG-0035=Multiple patches with the same patch number detected
+IMG-0036=Unable to find installer inventory file: {0}
diff --git a/imagetool/src/main/resources/docker-files/Create_Image.mustache b/imagetool/src/main/resources/docker-files/Create_Image.mustache
@@ -65,17 +65,19 @@ RUN tar xzf {{{tempDir}}}/$JAVA_PKG -C /u01 \
 FROM OS_UPDATE as WLS_BUILD
 LABEL com.oracle.weblogic.imagetool.buildid="{{buildId}}"
 ARG WLS_PKG
-ARG INV_LOC
-ARG ORAINST
 
 ENV WLS_PKG=${WLS_PKG:-fmw_12.2.1.3.0_wls_Disk1_1of1.zip} \
     JAVA_HOME={{{java_home}}} \
     ORACLE_HOME={{{oracle_home}}} \
-    INV_LOC=${INV_LOC:-/u01/oracle/oraInventory} \
-    ORAINST=${ORAINST:-oraInst.loc} \
     OPATCH_NO_FUSER=true
 
 RUN mkdir -p {{{oracle_home}}} \
+{{#isInventoryPointerFileSet}}
+    && mkdir -p {{inv_loc}} \
+    && chown {{userid}}:{{groupid}} {{inv_loc}} \
+{{/isInventoryPointerFileSet}}
+ && mkdir -p {{orainv_dir}} \
+ && chown {{userid}}:{{groupid}} {{orainv_dir}} \
  && chown {{userid}}:{{groupid}} {{{oracle_home}}}
 
 # Install base WLS
@@ -84,7 +86,7 @@ RUN mkdir -p {{{oracle_home}}} \
 {{/installJava}}
 
 COPY --chown={{userid}}:{{groupid}} $WLS_PKG wls.rsp {{{tempDir}}}/
-COPY --chown={{userid}}:{{groupid}} $ORAINST $INV_LOC/
+COPY --chown={{userid}}:{{groupid}} oraInst.loc {{inv_loc}}/
 
 {{#isOpatchPatchingEnabled}}
     COPY --chown={{userid}}:{{groupid}} {{{opatchFileName}}} {{{tempDir}}}/opatch/
@@ -102,7 +104,7 @@ USER {{userid}}
 
 RUN unzip -q {{{tempDir}}}/$WLS_PKG -d {{{tempDir}}} \
  && {{{java_home}}}/bin/java -Xmx1024m -jar {{{tempDir}}}/fmw_*.jar -silent ORACLE_HOME={{{oracle_home}}} \
-    -responseFile {{{tempDir}}}/wls.rsp -invPtrLoc $INV_LOC/$ORAINST -ignoreSysPrereqs -force -novalidation \
+    -responseFile {{{tempDir}}}/wls.rsp -invPtrLoc {{inv_loc}}/oraInst.loc -ignoreSysPrereqs -force -novalidation \
 {{#isOpatchPatchingEnabled}}
  && cd {{{tempDir}}}/opatch \
  && {{{java_home}}}/bin/jar -xf {{{tempDir}}}/opatch/{{{opatchFileName}}} \
@@ -214,6 +216,12 @@ LABEL com.oracle.weblogic.imagetool.buildid="{{buildId}}"
 {{/installJava}}
 
 COPY --from=WLS_BUILD --chown={{userid}}:{{groupid}} {{{oracle_home}}} {{{oracle_home}}}/
+{{#copyOraInst}}
+    COPY --from=WLS_BUILD --chown={{userid}}:{{groupid}} {{inv_loc}}/oraInst.loc  {{inv_loc}}/oraInst.loc
+{{/copyOraInst}}
+{{#copyOraInventoryDir}}
+    COPY --from=WLS_BUILD --chown={{userid}}:{{groupid}} {{orainv_dir}} {{orainv_dir}}/
+{{/copyOraInventoryDir}}
 
 {{#isWdtEnabled}}
     {{#modelOnly}}
diff --git a/imagetool/src/main/resources/docker-files/Rebase_Image.mustache b/imagetool/src/main/resources/docker-files/Rebase_Image.mustache
@@ -91,13 +91,11 @@ COPY --from=SOURCE_IMAGE --chown={{userid}}:{{groupid}} {{domain_home}} {{domain
     LABEL com.oracle.weblogic.imagetool.buildid="{{buildId}}"
     ARG WLS_PKG
     ARG INV_LOC
-    ARG ORAINST
 
     ENV WLS_PKG=${WLS_PKG:-fmw_12.2.1.3.0_wls_Disk1_1of1.zip} \
     JAVA_HOME={{{java_home}}} \
     ORACLE_HOME={{{oracle_home}}} \
     INV_LOC=${INV_LOC:-/u01/oracle/oraInventory} \
-    ORAINST=${ORAINST:-oraInst.loc} \
     OPATCH_NO_FUSER=true
 
     RUN mkdir -p {{{oracle_home}}} \
@@ -109,7 +107,7 @@ COPY --from=SOURCE_IMAGE --chown={{userid}}:{{groupid}} {{domain_home}} {{domain
     {{/installJava}}
 
     COPY --chown={{userid}}:{{groupid}} $WLS_PKG wls.rsp {{{tempDir}}}/
-    COPY --chown={{userid}}:{{groupid}} $ORAINST $INV_LOC/
+    COPY --chown={{userid}}:{{groupid}} oraInst.loc $INV_LOC/
 
     {{#isOpatchPatchingEnabled}}
         COPY --chown={{userid}}:{{groupid}} {{{opatchFileName}}} {{{tempDir}}}/opatch/
@@ -127,7 +125,7 @@ COPY --from=SOURCE_IMAGE --chown={{userid}}:{{groupid}} {{domain_home}} {{domain
 
     RUN unzip -q {{{tempDir}}}/$WLS_PKG -d {{{tempDir}}} \
     && {{{java_home}}}/bin/java -Xmx1024m -jar {{{tempDir}}}/fmw_*.jar -silent ORACLE_HOME={{{oracle_home}}} \
-    -responseFile {{{tempDir}}}/wls.rsp -invPtrLoc $INV_LOC/$ORAINST -ignoreSysPrereqs -force -novalidation \
+    -responseFile {{{tempDir}}}/wls.rsp -invPtrLoc $INV_LOC/oraInst.loc -ignoreSysPrereqs -force -novalidation \
     {{#isOpatchPatchingEnabled}}
         && cd {{{tempDir}}}/opatch \
         && {{{java_home}}}/bin/jar -xf {{{tempDir}}}/opatch/{{{opatchFileName}}} \
diff --git a/site/create-image.md b/site/create-image.md
@@ -37,6 +37,8 @@ Usage: imagetool create [OPTIONS]
 | `--wdtStrictValidation` | Use strict validation for the WDT validation method. Only applies when using model only.  | `false`  |
 | `--wdtVariables` | Path to the WDT variables file for use with the WDT model.  |   |
 | `--wdtVersion` | WDT tool version to use.  |   |
+| `--inventoryPointerFile` | Path to inventory pointer file.  |   |
+| `--inventoryPointerInstallLoc` | Path to where to store the inventory pointer file.  |   |
 
 ## Additional information
 
