Allow recommendedPatches for all install types (#192)

* fix latestPSU and recommended patches to include all products

Author: ddsharpe

imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/PatchFile.java

@@ -151,7 +151,8 @@ synchronized void initPatchInfo() throws IOException, XPathExpressionException {
         }
 
         if (checkPsuVersion()) {
-            String patchXpath = String.format("string(/results/patch/release[@name='%s'])", patchSetVersion);
+            String patchXpath = String.format(
+                "string(/results/patch[./platform[@id='2000' or @id='226']]/release[@name='%s'])", patchSetVersion);
             String patch = XPathUtil.applyXPathReturnString(aruInfo, patchXpath);
             // if the patch has a PSU version in ARU, set the patch version to PSU version (download PSU version)
             if (!Utils.isEmptyString(patch)) {
@@ -176,8 +177,10 @@ synchronized void initPatchInfo() throws IOException, XPathExpressionException {
      */
     private void getReleaseInfoFromAru() throws IOException, XPathExpressionException {
         // get release number and release name from ARU data
-        String releasePath = String.format("/results/patch/release[@name='%s']/@id", getVersion());
-        String releaseNamePath = String.format("/results/patch/release[@name='%s']/text()", getVersion());
+        String releasePath = String.format(
+            "/results/patch[./platform[@id='2000' or @id='226']]/release[@name='%s']/@id", getVersion());
+        String releaseNamePath = String.format(
+            "/results/patch[./platform[@id='2000' or @id='226']]/release[@name='%s']/text()", getVersion());
 
         logger.finest("Searching for release number with xpath: {0}", releasePath);
         releaseNumber = XPathUtil.applyXPathReturnString(aruInfo, releasePath);
@@ -227,7 +230,8 @@ public String getReleaseNumber() throws IOException, XPathExpressionException {
      */
     boolean verifyPatchVersion() throws MultiplePatchVersionsException, XPathExpressionException {
         List<String> versionsForPatch =
-            XPathUtil.applyXPathReturnList(getAruInfo(), "/results/patch/release/@name");
+            XPathUtil.applyXPathReturnList(getAruInfo(),
+                "/results/patch[./platform[@id='2000' or @id='226']]/release/@name");
         logger.fine("versions for patch {0} are {1}", getBugNumber(), versionsForPatch);
 
         if (!versionsForPatch.contains(getVersion())) {
@@ -266,7 +270,8 @@ private String downloadPatch(CacheStore cacheStore) throws IOException, XPathExp
         }
 
         // select the patch based on the version requested, or default to the installer version, see getVersion()
-        String patchXpath = String.format("string(/results/patch[release[@name='%s']]", getVersion());
+        String patchXpath = String.format(
+            "string(/results/patch[./platform[@id='2000' or @id='226']][release[@name='%s']]", getVersion());
 
         String downloadUrlXpath = patchXpath + "/files/file/download_url";
         String downLoadLink = XPathUtil.applyXPathReturnString(getAruInfo(),downloadUrlXpath + "/text())");

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

@@ -221,8 +221,8 @@ boolean shouldUpdateOpatch() {
      *
      * @throws Exception in case of error
      */
-    void handlePatchFiles() throws Exception {
-        handlePatchFiles(null, null);
+    void handlePatchFiles(FmwInstallerType installerType) throws Exception {
+        handlePatchFiles(installerType, null, null);
     }
 
     /**
@@ -232,7 +232,8 @@ void handlePatchFiles() throws Exception {
      * @param previousInventory existing inventory found in the "from" image
      * @throws Exception in case of error
      */
-    void handlePatchFiles(String previousInventory, String psuVersion) throws Exception {
+    void handlePatchFiles(FmwInstallerType installerType, String previousInventory, String psuVersion)
+        throws Exception {
         logger.entering(psuVersion);
         if (!applyingPatches()) {
             return;
@@ -249,7 +250,7 @@ void handlePatchFiles(String previousInventory, String psuVersion) throws Except
         if (recommendedPatches) {
             // Get the latest PSU and its recommended patches
             List<String> patchList =
-                AruUtil.getLatestPsuRecommendedPatches(FmwInstallerType.WLS, getInstallerVersion(), userId, password);
+                AruUtil.getRecommendedPatches(installerType, getInstallerVersion(), userId, password);
 
             if (patchList.isEmpty()) {
                 recommendedPatches = false;
@@ -262,14 +263,16 @@ void handlePatchFiles(String previousInventory, String psuVersion) throws Except
             }
         } else if (latestPSU) {
             // PSUs for WLS and JRF installers are considered WLS patches
-            String patchId = AruUtil.getLatestPsuNumber(FmwInstallerType.WLS, getInstallerVersion(), userId, password);
+            List<String> patchIds = AruUtil.getLatestPsuNumber(installerType, getInstallerVersion(), userId, password);
 
-            if (Utils.isEmptyString(patchId)) {
+            if (patchIds.isEmpty()) {
                 latestPSU = false;
                 logger.fine("Latest PSU NOT FOUND, ignoring latestPSU flag");
             } else {
-                logger.fine("Found latest PSU {0}", patchId);
-                patchFiles.add(new PatchFile(patchId, getInstallerVersion(), null, userId, password));
+                logger.fine("Found latest PSU {0}", patchIds);
+                for (String patchId : patchIds) {
+                    patchFiles.add(new PatchFile(patchId, getInstallerVersion(), null, userId, password));
+                }
             }
         }
 

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

@@ -71,7 +71,7 @@ public CommandResponse call() throws Exception {
             wdtOptions.handleWdtArgs(dockerfileOptions, cmdBuilder, tmpDir);
 
             // resolve required patches
-            handlePatchFiles();
+            handlePatchFiles(installerType);
 
             // If patching, patch OPatch first
             if (applyingPatches() && shouldUpdateOpatch()) {

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

@@ -133,7 +133,7 @@ public CommandResponse call() throws Exception {
                 dockerfileOptions.setMiddlewareInstall(install);
 
                 // resolve required patches
-                handlePatchFiles();
+                handlePatchFiles(installerType);
 
                 // If patching, patch OPatch first
                 if (applyingPatches() && shouldUpdateOpatch()) {

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

@@ -15,6 +15,7 @@
 
 import com.oracle.weblogic.imagetool.api.model.CommandResponse;
 import com.oracle.weblogic.imagetool.cachestore.OPatchFile;
+import com.oracle.weblogic.imagetool.installer.FmwInstallerType;
 import com.oracle.weblogic.imagetool.logging.LoggingFacade;
 import com.oracle.weblogic.imagetool.logging.LoggingFactory;
 import com.oracle.weblogic.imagetool.util.Constants;
@@ -145,8 +146,10 @@ public CommandResponse call() throws Exception {
                 return new CommandResponse(-1, "IMG-0055");
             }
 
+            FmwInstallerType installerType = FmwInstallerType.fromValue(
+                baseImageProperties.getProperty("WLS_TYPE", "WLS"));
             // resolve required patches
-            handlePatchFiles(lsinventoryText, psuVersion);
+            handlePatchFiles(installerType, lsinventoryText, psuVersion);
 
             // create dockerfile
             String dockerfile = Utils.writeDockerfile(tmpDir + File.separator + "Dockerfile",

imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/AruProduct.java

@@ -0,0 +1,37 @@
+// 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.installer;
+
+/**
+ * ARU product codes for patching.
+ */
+public enum AruProduct {
+    WLS("15991", "Oracle WebLogic Server"),
+    COH("13964", "Oracle Coherence"),
+    OSB("16011", "Oracle Service Bus"),
+    SOA("12745", "Oracle SOA Suite"),
+    IDM("18391", "Oracle Identity Manager"),
+    OAM("18388", "Oracle Access Manager"),
+    OUD("19748", "Oracle Unified Directory"),
+    WCC("13946", "Oracle WebCenter Content"),
+    WCP("15224", "Oracle WebCenter Portal"),
+    WCS("20995", "Oracle WebCenter Sites")
+    //FIT("33256", "Fusion Internal Tools") No longer used after July 2020 PSU
+    ;
+
+    private String productId;
+    private String description;
+    AruProduct(String productId, String description) {
+        this.productId = productId;
+        this.description = description;
+    }
+
+    public String productId() {
+        return productId;
+    }
+
+    public String description() {
+        return description;
+    }
+}

imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/FmwInstallerType.java

@@ -4,36 +4,98 @@
 package com.oracle.weblogic.imagetool.installer;
 
 import java.util.Arrays;
+import java.util.Collections;
 import java.util.List;
+import java.util.stream.Collectors;
+
+import com.oracle.weblogic.imagetool.util.Utils;
 
 /**
  * Supported Fusion Middleware installer sets.
+ * Each installer set contains a list of ARU Products for resolving the product name and ARU ID,
+ * as well as a list of installers needed to create the Oracle Home for that product.
  */
 public enum FmwInstallerType {
-    WLSSLIM(InstallerType.WLSSLIM),
-    WLSDEV(InstallerType.WLSDEV),
-    WLS(InstallerType.WLS), //WebLogic Server
-    FMW(InstallerType.FMW), //WebLogic Server Infrastructure (JRF)
-    OSB(InstallerType.FMW, InstallerType.OSB),  //Service Bus
-    SOA(InstallerType.FMW, InstallerType.SOA),  //SOA Suite
-    SOA_OSB(InstallerType.FMW, InstallerType.SOA, InstallerType.OSB),
-    IDM(InstallerType.FMW, InstallerType.IDM),
-    IDM_WLS(InstallerType.IDM),
-    OAM(InstallerType.FMW, InstallerType.OAM), //Identity and Access Manager
-    OIG(InstallerType.FMW, InstallerType.SOA, InstallerType.OSB, InstallerType.IDM),
-    OUD(InstallerType.OUD), //Oracle Unified Directory
-    OUD_WLS(InstallerType.FMW, InstallerType.OUD), //Oracle Unified Directory
-    WCC(InstallerType.FMW, InstallerType.WCC), //Web Center Content
-    WCP(InstallerType.FMW, InstallerType.WCP), //Web Center Portal
-    WCS(InstallerType.FMW, InstallerType.WCS)  //Web Center Sites
+    // data from https://updates.oracle.com/Orion/Services/metadata?table=aru_products
+
+    // Oracle WebLogic Server
+    WLSSLIM(Arrays.asList(AruProduct.WLS, AruProduct.COH),
+        InstallerType.WLSSLIM),
+    WLSDEV(Arrays.asList(AruProduct.WLS, AruProduct.COH),
+        InstallerType.WLSDEV),
+    WLS(Arrays.asList(AruProduct.WLS, AruProduct.COH),
+        InstallerType.WLS),
+    // Oracle WebLogic Server Infrastructure (JRF)
+    FMW(Arrays.asList(AruProduct.WLS, AruProduct.COH),
+        InstallerType.FMW),
+    // Oracle Service Bus
+    OSB(Arrays.asList(AruProduct.WLS, AruProduct.COH, AruProduct.OSB),
+        InstallerType.FMW, InstallerType.OSB),
+    // Oracle SOA Suite
+    SOA(Arrays.asList(AruProduct.WLS, AruProduct.COH, AruProduct.SOA),
+        InstallerType.FMW, InstallerType.SOA),
+    // Oracle SOA Suite (with Service Bus)
+    SOA_OSB(Arrays.asList(AruProduct.WLS, AruProduct.COH, AruProduct.SOA, AruProduct.OSB),
+        InstallerType.FMW, InstallerType.SOA, InstallerType.OSB),
+    // Oracle Identity Manager
+    IDM(Arrays.asList(AruProduct.WLS, AruProduct.COH, AruProduct.IDM),
+        InstallerType.FMW, InstallerType.IDM),
+    // Oracle Identity Manager
+    IDM_WLS(Collections.singletonList(AruProduct.IDM),
+        InstallerType.IDM),
+    // Oracle Access Manager
+    OAM(Arrays.asList(AruProduct.WLS, AruProduct.COH, AruProduct.OAM),
+        InstallerType.FMW, InstallerType.OAM),
+    // Oracle Identity Governance
+    OIG(Arrays.asList(AruProduct.WLS, AruProduct.COH, AruProduct.SOA, AruProduct.OSB, AruProduct.IDM),
+        InstallerType.FMW, InstallerType.SOA, InstallerType.OSB, InstallerType.IDM),
+    // Oracle Unified Directory
+    OUD(Collections.singletonList(AruProduct.OUD),
+        InstallerType.OUD),
+    // Oracle Unified Directory
+    OUD_WLS(Arrays.asList(AruProduct.WLS, AruProduct.COH, AruProduct.OUD),
+        InstallerType.FMW, InstallerType.OUD),
+    // Oracle WebCenter Content
+    WCC(Arrays.asList(AruProduct.WLS, AruProduct.COH, AruProduct.WCC),
+        InstallerType.FMW, InstallerType.WCC),
+    // Oracle WebCenter Portal
+    WCP(Arrays.asList(AruProduct.WLS, AruProduct.COH, AruProduct.WCP),
+        InstallerType.FMW, InstallerType.WCP),
+    // Oracle WebCenter Sites
+    WCS(Arrays.asList(AruProduct.WLS, AruProduct.COH, AruProduct.WCS),
+        InstallerType.FMW, InstallerType.WCS)
     ;
 
     private InstallerType[] installers;
-    FmwInstallerType(InstallerType... installers) {
+    private List<AruProduct> products;
+    FmwInstallerType(List<AruProduct> products, InstallerType... installers) {
         this.installers = installers;
+        this.products = products;
     }
 
-    public List<InstallerType> getInstallerList() {
+    public List<InstallerType> installerList() {
         return Arrays.asList(installers);
     }
+
+    public String installerListString() {
+        return Arrays.stream(installers).map(Object::toString).collect(Collectors.joining(", "));
+    }
+
+    public List<AruProduct> products() {
+        return products;
+    }
+
+    /**
+     * Create the FMW installer type Enum from the String value.
+     * @param value the installer type string, ignoring case.
+     * @return the enum installer type.
+     */
+    public static FmwInstallerType fromValue(String value) {
+        for (FmwInstallerType type : values()) {
+            if (type.name().equalsIgnoreCase(value)) {
+                return type;
+            }
+        }
+        throw new IllegalArgumentException(Utils.getMessage("IMG-0080", value));
+    }
 }

imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerType.java

@@ -39,18 +39,4 @@ public enum InstallerType {
     public String toString() {
         return value;
     }
-
-    /**
-     * Create the installer type Enum from the String value.
-     * @param value the installer type string, ignoring case.
-     * @return the enum installer type.
-     */
-    public static InstallerType fromValue(String value) {
-        for (InstallerType eachType : InstallerType.values()) {
-            if (eachType.value.equalsIgnoreCase(value)) {
-                return eachType;
-            }
-        }
-        throw new IllegalArgumentException("argument " + value + " does not match any InstallerType");
-    }
 }

imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java

@@ -10,7 +10,6 @@
 import java.util.ArrayList;
 import java.util.Enumeration;
 import java.util.List;
-import java.util.stream.Collectors;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipFile;
 import javax.xml.xpath.XPathExpressionException;
@@ -26,7 +25,7 @@ public class MiddlewareInstall {
     private static final LoggingFacade logger = LoggingFactory.getLogger(MiddlewareInstall.class);
 
     private List<MiddlewareInstallPackage> installerFiles = new ArrayList<>();
-    private final String installerListString;
+    private FmwInstallerType fmwInstallerType;
 
     /**
      * Get the install metadata for a given middleware install type.
@@ -35,12 +34,10 @@ public class MiddlewareInstall {
     public MiddlewareInstall(FmwInstallerType type, String version, List<Path> responseFiles)
         throws FileNotFoundException {
 
-        List<InstallerType> list = type.getInstallerList();
+        logger.info("IMG-0039", type.installerListString(), version);
+        fmwInstallerType = type;
 
-        installerListString = list.stream().map(Object::toString).collect(Collectors.joining(", "));
-        logger.info("IMG-0039", installerListString, version);
-
-        for (InstallerType installer : list) {
+        for (InstallerType installer : type.installerList()) {
             MiddlewareInstallPackage pkg = new MiddlewareInstallPackage();
             pkg.type = installer;
             pkg.installer = new CachedFile(installer, version);
@@ -112,7 +109,7 @@ private void setResponseFiles(List<Path> responseFiles) throws FileNotFoundExcep
         if (responseFiles.size() != installerFiles.size()) {
             throw new IllegalArgumentException(
                 Utils.getMessage("IMG-0040",
-                    installerListString,
+                    fmwInstallerType.installerListString(),
                     responseFiles.size(),
                     installerFiles.size()));
         }