Discard Stack Patch Bundle patch numbers and provide warning to the user (#300)

ddsharpe · web-flow · commit d0a539fbd3e5 · 2021-07-26T11:56:02.000-05:00
* Discard Stack Patch Bundle patch numbers and provide warning to the user

* Moved check for Stack Patch Bundle so that --recommendedPatches and --latestPSU could handle SPB differently
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CommandResponse.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CommandResponse.java
@@ -7,9 +7,9 @@
 
 public class CommandResponse {
 
-    private int status;
-    private String message;
-    private Object[] messageParams;
+    private final int status;
+    private final String message;
+    private final Object[] messageParams;
 
     /**
      * For use with PicoCLI to return the response to the command line.
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruHttpHelper.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruHttpHelper.java
@@ -22,23 +22,19 @@ public class AruHttpHelper {
     private boolean success;
     private Document results;
     private String errorMessage;
-    private AruProduct product;
-    private String version;
-    private String userId;
-    private String password;
-    private String release;
+    private final AruProduct product;
+    private final String userId;
+    private final String password;
 
     /**
      * Constructor encapsulating the information for the ARU search.
      *
      * @param product ARU product
-     * @param version of the product
      * @param userId ARU user credentials
      * @param password ARU password credentials
      */
-    AruHttpHelper(AruProduct product, String version, String userId, String password) {
+    AruHttpHelper(AruProduct product, String userId, String password) {
         this.product = product;
-        this.version = version;
         this.userId = userId;
         this.password = password;
         this.success = true;
@@ -52,7 +48,7 @@ public class AruHttpHelper {
      * @param password ARU credentials password
      */
     AruHttpHelper(String userId, String password) {
-        this(null, null, userId, password);
+        this(null, userId, password);
     }
     
     /**
@@ -81,34 +77,6 @@ Document results() {
         return results;
     }
 
-    /**
-     * Return the product version number for the search.
-     *
-     * @return product version number
-     */
-    String version() {
-        return version;
-    }
-
-    /**
-     * Return the Release number for the category and version.
-     *
-     * @return ARU release number
-     */
-    String release() {
-        return release;
-    }
-
-    /**
-     * Set the release number for the product category and version.
-     *
-     * @param release set the product release number
-     */
-    AruHttpHelper release(String release) {
-        this.release = release;
-        return this;
-    }
-
     /**
      * Return the user for the ARU credentials.
      *
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java
@@ -154,6 +154,14 @@ public boolean isRecommended() {
         return "Recommended".equals(lifecycle);
     }
 
+    public boolean notStackPatchBundle() {
+        return !isStackPatchBundle();
+    }
+
+    public boolean isStackPatchBundle() {
+        return description != null && description.contains("STACK PATCH BUNDLE");
+    }
+
     /**
      * Given an XML document with a list of patches, extract each patch into the AruPatch bean and return the list.
      * @param patchList an XML document with a list of patches from ARU
@@ -191,11 +199,6 @@ public static List<AruPatch> getPatches(Document patchList, String patchSelector
                     .downloadHost(XPathUtil.string(nodeList.item(i), "./files/file/download_url/@host"))
                     .downloadPath(XPathUtil.string(nodeList.item(i), "./files/file/download_url/text()"));
 
-                // Stack Patch Bundle (SPB) is not a traditional patch.  Patches in SPB are duplicates of recommended.
-                if (patch.description.contains("STACK PATCH BUNDLE")) {
-                    logger.fine("Discarded Stack Patch Bundle: {0}", patch.description);
-                    continue;
-                }
                 int index = patch.downloadPath().indexOf("patch_file=");
                 if (index < 0) {
                     throw new XPathExpressionException(Utils.getMessage("IMG-0059", patch.patchId()));
@@ -230,9 +233,11 @@ public static List<AruPatch> getPatches(Document patchList, String patchSelector
     public static AruPatch selectPatch(List<AruPatch> patches, String providedVersion, String psuVersion,
                                        String installerVersion) throws VersionNotFoundException {
 
+        logger.entering(patches, providedVersion, psuVersion, installerVersion);
         AruPatch selected = null;
 
         if (patches.isEmpty()) {
+            logger.exiting("Patches list is empty");
             return null;
         }
 
@@ -248,7 +253,19 @@ public static AruPatch selectPatch(List<AruPatch> patches, String providedVersio
                 }
             } else if (providedVersion != null && !selected.version().equals(providedVersion)) {
                 throw new VersionNotFoundException(selected.patchId(), providedVersion, patches);
+            } else {
+                // the patch has a version from ARU, warn the user if the version doesn't match the target install
+                if (psuVersion != null) {
+                    if (!selected.version().equals(psuVersion)) {
+                        logger.warning("IMG-0099", selected.patchId(), selected.version(), psuVersion);
+                    }
+                } else {
+                    if (installerVersion != null && !selected.version().equals(installerVersion)) {
+                        logger.warning("IMG-0099", selected.patchId(), selected.version(), installerVersion);
+                    }
+                }
             }
+            logger.exiting(selected);
             return selected;
         }
 
@@ -267,9 +284,19 @@ public static AruPatch selectPatch(List<AruPatch> patches, String providedVersio
             selected = patchMap.get(installerVersion);
         }
 
+        logger.exiting(selected);
         return selected;
     }
 
+    /**
+     * Find and remove any Stack Patch Bundle type patches from the list.
+      * @param patches the list to scan
+     * @return a new list, with SPB removed
+     */
+    public static List<AruPatch> removeStackPatchBundle(List<AruPatch> patches) {
+        return patches.stream().filter(AruPatch::notStackPatchBundle).collect(Collectors.toList());
+    }
+
     @Override
     public String toString() {
         return patchId + " - " + description;
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java
@@ -100,14 +100,13 @@ List<AruPatch> getLatestPsu(AruProduct product, String version, String userId, S
             String releaseNumber = getReleaseNumber(product, version, userId, password);
             Document aruRecommendations = getRecommendedPatchesMetadata(product, releaseNumber, userId, password);
             logger.exiting();
-            return AruPatch.getPatches(aruRecommendations, "[./psu_bundle]");
+            return AruPatch.removeStackPatchBundle(AruPatch.getPatches(aruRecommendations, "[./psu_bundle]"));
         } catch (NoPatchesFoundException | ReleaseNotFoundException ex) {
             logger.exiting();
             return Collections.emptyList();
         } catch (IOException | XPathExpressionException e) {
-            AruException aruE = new AruException(Utils.getMessage("IMG-0032", product.description(), version), e);
-            logger.throwing(aruE);
-            throw aruE;
+            throw logger.throwing(
+                new AruException(Utils.getMessage("IMG-0032", product.description(), version), e));
         }
     }
 
@@ -151,7 +150,7 @@ List<AruPatch> getRecommendedPatches(AruProduct product, String version, String
             logger.info("IMG-0067", product.description());
             String releaseNumber = getReleaseNumber(product, version, userId, password);
             Document aruRecommendations = getRecommendedPatchesMetadata(product, releaseNumber, userId, password);
-            List<AruPatch> patches = AruPatch.getPatches(aruRecommendations);
+            List<AruPatch> patches = AruPatch.removeStackPatchBundle(AruPatch.getPatches(aruRecommendations));
             String psuVersion = getPsuVersion(patches);
             if (!Utils.isEmptyString(psuVersion)) {
                 patches.forEach(p -> logger.fine("Discarding recommended patch {0} {1}", p.patchId(), p.description()));
@@ -161,7 +160,7 @@ List<AruPatch> getRecommendedPatches(AruProduct product, String version, String
                 String psuReleaseNumber = getReleaseNumber(product, psuVersion, userId, password);
                 // get recommended patches for PSU release (Overlay patches are only recommended on the PSU release)
                 Document psuRecommendation = getRecommendedPatchesMetadata(product, psuReleaseNumber, userId, password);
-                patches = AruPatch.getPatches(psuRecommendation);
+                patches = AruPatch.removeStackPatchBundle(AruPatch.getPatches(psuRecommendation));
             }
             patches.forEach(p -> logger.info("IMG-0068", product.description(), p.patchId(), p.description()));
             logger.exiting(patches);
@@ -240,8 +239,6 @@ static void validatePatches(List<InstalledPatch> installedPatches, List<AruPatch
                     continue;
                 }
 
-                logger.info("IMG-0022", patch.patchId(), patch.releaseName());
-
                 payload.append(String.format("<patch_group rel_id=\"%s\">%s</patch_group>",
                         patch.release(), patch.patchId()));
             }
@@ -402,7 +399,7 @@ public List<AruPatch> getPatches(String bugNumber, String userId, String passwor
         } catch (NoPatchesFoundException patchEx) {
             throw new NoPatchesFoundException(Utils.getMessage("IMG-0086", bugNumber), patchEx);
         }
-        return AruPatch.getPatches(response, "");
+        return AruPatch.getPatches(response);
     }
 
     /**
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/InvalidPatchNumberException.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/InvalidPatchNumberException.java
@@ -0,0 +1,15 @@
+// Copyright (c) 2021, Oracle 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.aru;
+
+public class InvalidPatchNumberException extends AruException {
+    /**
+     * Specified patch number is invalid for this use case.
+     *
+     * @param msg         error message
+     */
+    public InvalidPatchNumberException(String msg) {
+        super(msg);
+    }
+}
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/MultiplePatchVersionsException.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/MultiplePatchVersionsException.java
@@ -1,7 +1,7 @@
 // Copyright (c) 2020, 2021, Oracle 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.cachestore;
+package com.oracle.weblogic.imagetool.aru;
 
 import java.io.IOException;
 import java.util.List;
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java
@@ -24,8 +24,9 @@
 import com.oracle.weblogic.imagetool.aru.AruProduct;
 import com.oracle.weblogic.imagetool.aru.AruUtil;
 import com.oracle.weblogic.imagetool.aru.InstalledPatch;
+import com.oracle.weblogic.imagetool.aru.InvalidPatchNumberException;
+import com.oracle.weblogic.imagetool.aru.MultiplePatchVersionsException;
 import com.oracle.weblogic.imagetool.builder.BuildCommand;
-import com.oracle.weblogic.imagetool.cachestore.MultiplePatchVersionsException;
 import com.oracle.weblogic.imagetool.cachestore.OPatchFile;
 import com.oracle.weblogic.imagetool.cachestore.PatchFile;
 import com.oracle.weblogic.imagetool.cli.HelpVersionProvider;
@@ -286,7 +287,7 @@ void handlePatchFiles(FmwInstallerType installerType, List<InstalledPatch> insta
 
         // add user-provided patch list to any patches that were found for latestPsu or recommendedPatches
         for (String patchId : patches) {
-            // if user mistakenly added the OPatch patch to the WLS patch list, skip it
+            // if user mistakenly added the OPatch patch to the WLS patch list, skip it. WIT updates OPatch anyway
             if (OPatchFile.isOPatchPatch(patchId)) {
                 continue;
             }
@@ -298,13 +299,22 @@ void handlePatchFiles(FmwInstallerType installerType, List<InstalledPatch> insta
                 patchId = patchId.substring(0, split);
             }
             List<AruPatch> patchVersions = AruUtil.rest().getPatches(patchId, userId, password);
-            AruPatch selectedVersion = AruPatch.selectPatch(patchVersions, providedVersion, psuVersion,
-                getInstallerVersion());
 
-            if (selectedVersion != null) {
-                aruPatches.add(selectedVersion);
-            } else {
-                throw new MultiplePatchVersionsException(patchId, aruPatches);
+            // Stack Patch Bundle (SPB) is not a traditional patch.  Patches in SPB are duplicates of recommended.
+            if (patchVersions.stream().anyMatch(AruPatch::isStackPatchBundle)) {
+                // Do not continue if the user specified a patch number that cannot be applied.
+                throw logger.throwing(new InvalidPatchNumberException(Utils.getMessage("IMG-0098", patchId)));
+            }
+
+            if (!patchVersions.isEmpty()) {
+                AruPatch selectedVersion = AruPatch.selectPatch(patchVersions, providedVersion, psuVersion,
+                    getInstallerVersion());
+
+                if (selectedVersion != null) {
+                    aruPatches.add(selectedVersion);
+                } else {
+                    throw logger.throwing(new MultiplePatchVersionsException(patchId, aruPatches));
+                }
             }
         }
 
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/logging/LoggingFacade.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/logging/LoggingFacade.java
@@ -484,11 +484,12 @@ public void severe(String msg, Throwable thrown) {
      *
      * @param pending an Exception to include in the logged message
      */
-    public void throwing(Throwable pending) {
+    public <T extends Throwable> T throwing(T pending) {
         if (isFinerEnabled()) {
             CallerDetails details = inferCaller();
             logger.throwing(details.clazz, details.method, pending);
         }
+        return pending;
     }
 
     /**
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
@@ -427,6 +427,7 @@ public static Properties getBaseImageProperties(String builder, String dockerIma
         Utils.copyResourceAsFile(script, contextDir + File.separator + scriptToRun, true);
         List<String> imageEnvCmd = Utils.getDockerRunCmd(builder,
             contextDir + File.separator + scriptToRun, dockerImage);
+        logger.info("IMG-0097", dockerImage);
         Properties result = Utils.runDockerCommand(imageEnvCmd);
         logger.exiting(result);
         return result;
diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties
@@ -10,7 +10,7 @@ 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 [[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-0012=Checking for conflicting 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}]
@@ -20,7 +20,7 @@ IMG-0018=Downloading patch [[cyan: {0}]]...
 IMG-0019={0} - locating patch number for the latest PSU...
 IMG-0020={0} - the latest PSU patch number is [[cyan: {1}]]
 IMG-0021=ORACLE_HOME value must be the same in both new and old image in order to rebase the domain
-IMG-0022=Validated patch {0} for {1}
+IMG-0022=NOT USED
 IMG-0023=No PSU recommended for {0}, version {1}
 IMG-0024=Cached patch file {0} has an empty path
 IMG-0025=No Domain Home in source image.  Add DOMAIN_HOME environment variable to source image and try again.
@@ -95,3 +95,6 @@ IMG-0093=Patching skipped.  Using CREATE to patch --fromImage with an existing O
 IMG-0094=Source image installer type: ([[green: {0}]])
 IMG-0095=Unable to parse response for Oracle patches in fromImage: {0}
 IMG-0096=Unable to patch image {0}. The installed products could not be identified for patching. The most likely cause is that the registry.xml in this image may be invalid.
+IMG-0097=Inspecting {0}, this may take a few minutes if the image is not available locally.
+IMG-0098=Patch [[red: {0}]] is a Stack Patch Bundle, not a patch. Remove {0} from --patches and use [[cyan: --recommendedPatches]] instead.
+IMG-0099=Patch [[red: {0}]] is only for version {1} and may not be applicable to the target version {2}. Check Oracle Support, there may be another patch number for version {2}. Or check the OPatch output for results for this image.
diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/aru/AruUtilTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/aru/AruUtilTest.java
@@ -27,7 +27,7 @@
 
 @Tag("unit")
 class AruUtilTest {
-    private static LoggingFacade logger = LoggingFactory.getLogger(AruUtil.class);
+    private static final LoggingFacade logger = LoggingFactory.getLogger(AruUtil.class);
     private static Level oldLevel;
 
     @BeforeAll
diff --git a/imagetool/src/test/resources/recommended-patches.xml b/imagetool/src/test/resources/recommended-patches.xml
@@ -40,7 +40,7 @@
             <file>
                 <name>p32755791_122140_Generic.zip</name>
                 <size>417431395</size>
-                <download_url host="https://updates.oracle.com"><![CDATA[/blah/blah/Generic.zip]]></download_url>
+                <download_url host="https://updates.oracle.com"><![CDATA[/blah/blah/Generic.zip?aru=1234&patch_file=p1234_122130_Generic.zip]]></download_url>
                 <digest type="SHA-256">1111</digest>
                 <digest type="SHA-1">22222</digest>
             </file>

Original file line number	Diff line number	Diff line change
`@@ -484,11 +484,12 @@ public void severe(String msg, Throwable thrown) {`
`484`	`484`	`*`
`485`	`485`	`* @param pending an Exception to include in the logged message`
`486`	`486`	`*/`
`487`		`- public void throwing(Throwable pending) {`
	`487`	`+ public <T extends Throwable> T throwing(T pending) {`
`488`	`488`	`if (isFinerEnabled()) {`
`489`	`489`	`CallerDetails details = inferCaller();`
`490`	`490`	`logger.throwing(details.clazz, details.method, pending);`
`491`	`491`	`}`
	`492`	`+ return pending;`
`492`	`493`	`}`
`493`	`494`
`494`	`495`	`/**`