Added ARU retry for patch conflict checks (#361)

* refactor and simplify patch validation, adding unit tests and i18n for patch conflicts

* added retry for ARU conflict check service

* move patch conflict message to resource bundle for i18n

* remove unused method in FmwInstallerType (deleted unit test and message from bundle)

* for translation, changed "groupid" to "GID (group ID)"

* refactor overly complex handlePatches, adding new unit tests, and fixing bug with multiple patches error message

Author: ddsharpe

imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruHttpHelper.java

@@ -1,17 +1,14 @@
-// Copyright (c) 2019, 2021, Oracle and/or its affiliates.
+// Copyright (c) 2019, 2022, 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;
 
 import java.io.IOException;
-import javax.xml.parsers.ParserConfigurationException;
 import javax.xml.xpath.XPathExpressionException;
 
 import com.oracle.weblogic.imagetool.util.HttpUtil;
 import com.oracle.weblogic.imagetool.util.XPathUtil;
 import org.w3c.dom.Document;
-import org.w3c.dom.Element;
-import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
 
 /**
@@ -20,8 +17,6 @@
  */
 public class AruHttpHelper {
     private boolean success;
-    private Document results;
-    private String errorMessage;
     private final AruProduct product;
     private final String userId;
     private final String password;
@@ -38,7 +33,6 @@ public class AruHttpHelper {
         this.userId = userId;
         this.password = password;
         this.success = true;
-        this.results = null;
     }
 
     /**
@@ -50,15 +44,6 @@ public class AruHttpHelper {
     AruHttpHelper(String userId, String password) {
         this(null, userId, password);
     }
-    
-    /**
-     * Get the error errorMessage.
-     *
-     * @return the search error message
-     */
-    String errorMessage() {
-        return errorMessage;
-    }
 
     /**
      * Returns true if no conflicts ; false if there is conflicts.
@@ -68,15 +53,6 @@ boolean success() {
         return success;
     }
 
-    /**
-     * Get the result object from the search.
-     *
-     * @return dom document detailing about the conflicts
-     */
-    Document results() {
-        return results;
-    }
-
     /**
      * Return the user for the ARU credentials.
      *
@@ -114,123 +90,12 @@ AruHttpHelper execSearch(String url) throws IOException {
         return this;
     }
 
-    /**
-     * Call ARU via the HTTPUtil methods and check the result for conflict messages about
-     * patches not compatible.
-     *
-     * @param url to the ARU conflict patch numbers site.
-     * @param payload XML string containing the patch number being validated
-     * @return this instance of encapsulation of ARU search information
-     * @throws IOException if the ARU request is not successful
-     */
-    AruHttpHelper execValidation(String url, String payload) throws IOException {
-        results = HttpUtil.postCheckConflictRequest(url, payload, userId, password);
-        return this;
-    }
-
-    /**
-     * Check the resulting document from the execValidation for conflicts.
-     *
-     * @return this instance of the encapsulation of the validated results
-     * @throws IOException if not able to parse the returned Document for conflict messages
-     */
-    AruHttpHelper validation() throws IOException {
-        NodeList conflictSets;
-        try {
-            conflictSets = XPathUtil.nodelist(results(),
-                "/conflict_check/conflict_sets/set");
-        } catch (XPathExpressionException xee) {
-            throw new IOException(xee);
-        }
-        if (conflictSets.getLength() > 0) {
-            try {
-                success = false;
-                String expression = "/conflict_check/conflict_sets/set/merge_patches";
-
-                NodeList nodeList = XPathUtil.nodelist(results(), expression);
-
-                createResultDocument(nodeList);
-
-                errorMessage = parsePatchValidationError();
-
-            } catch (XPathExpressionException xpe) {
-                throw new IOException(xpe);
-            }
-            return this;
-        }
-        return this;
-    }
-
-    /**
-     * Create an XML document from an XML NodeList.
-     * @param nodeList partial XML document
-     * @return a Document based on the NodeList provided
-     * @throws IOException if an XML parser exception occurs trying to build the document
-     */
-    AruHttpHelper createResultDocument(NodeList nodeList) throws IOException {
-        try {
-            Document doc = HttpUtil.documentBuilder().newDocument();
-            Element element = doc.createElement("results");
-
-            for (int i = 0; i < nodeList.getLength(); i++) {
-                Node n = nodeList.item(i);
-                Node copyNode = doc.importNode(n, true);
-
-                if (n instanceof Element) {
-                    element.appendChild(copyNode);
-                }
-            }
-
-            doc.appendChild(element);
-
-            results = doc;
-        } catch (ParserConfigurationException pce) {
-            throw new IOException(pce);
-        }
-        return this;
-    }
-
-    /**
-     * Parses the patch conflict check result and returns a string of patch conflicts grouped by each conflict.
-     *
-     * @return String
-     */
-    private String parsePatchValidationError() {
-        StringBuilder stringBuilder = new StringBuilder();
-        Node conflictsResultNode = results();
-        if (conflictsResultNode != null) {
-            try {
-                NodeList patchSets = XPathUtil.nodelist(conflictsResultNode, "//merge_patches");
-                stringBuilder.append("patch conflicts detected: ");
-                for (int i = 0; i < patchSets.getLength(); i++) {
-                    stringBuilder.append("[");
-                    NodeList bugNumbers = XPathUtil.nodelist(patchSets.item(i), "patch/bug/number"
-                        + "/text()");
-                    for (int j = 0; j < bugNumbers.getLength(); j++) {
-                        stringBuilder.append(bugNumbers.item(j).getNodeValue());
-                        stringBuilder.append(",");
-                    }
-                    if (bugNumbers.getLength() > 0) {
-                        stringBuilder.deleteCharAt(stringBuilder.length() - 1);
-                    }
-                    stringBuilder.append("]");
-                }
-            } catch (XPathExpressionException e) {
-                return "Exception occurred in parsePatchValidationError: " + e.getMessage();
-            }
-        }
-        return stringBuilder.toString();
-    }
-
     private void searchResult(Document result) throws IOException {
         success = true;
         try {
             NodeList nodeList = XPathUtil.nodelist(result, "/results/error");
             if (nodeList.getLength() > 0) {
                 success = false;
-                errorMessage = XPathUtil.string(result, "/results/error/message");
-            } else {
-                results = result;
             }
         } catch (XPathExpressionException xpe) {
             throw new IOException(xpe);

imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java

@@ -1,4 +1,4 @@
-// Copyright (c) 2020, 2021, Oracle and/or its affiliates.
+// Copyright (c) 2020, 2022, 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;
@@ -101,6 +101,10 @@ public AruPatch psuBundle(String value) {
         return this;
     }
 
+    public String psuVersion() {
+        return psuBundle.substring(psuBundle.lastIndexOf(' ') + 1);
+    }
+
     public boolean isPsu() {
         return !Utils.isEmptyString(psuBundle);
     }
@@ -231,34 +235,15 @@ public static List<AruPatch> getPatches(Document patchList, String patchSelector
      * @throws VersionNotFoundException if the user requested a version that was not in the list.
      */
     public static AruPatch selectPatch(List<AruPatch> patches, String providedVersion, String psuVersion,
-                                       String installerVersion) throws VersionNotFoundException {
+                                       String installerVersion)
+        throws VersionNotFoundException, MultiplePatchVersionsException {
 
         logger.entering(patches, providedVersion, psuVersion, installerVersion);
         AruPatch selected = null;
 
-        if (patches.isEmpty()) {
-            logger.exiting("Patches list is empty");
-            return null;
-        }
-
-        if (patches.size() == 1) {
-            selected = patches.get(0);
-            if (selected.version() == null) {
-                if (providedVersion != null) {
-                    selected.version(providedVersion);
-                } else if (psuVersion != null) {
-                    selected.version(psuVersion);
-                } else {
-                    selected.version(installerVersion);
-                }
-            } else if (providedVersion != null && !selected.version().equals(providedVersion)) {
-                throw new VersionNotFoundException(selected.patchId(), providedVersion, patches);
-            } else {
-                logger.info("IMG-0099", selected.patchId(), selected.version(), selected.description());
-            }
-            
-            logger.exiting(selected);
-            return selected;
+        if (patches.size() < 2) {
+            // 0 or 1 patch, fill in a patch version and just return what have
+            return selectPatchOffline(patches, providedVersion, psuVersion, installerVersion);
         }
 
         Map<String, AruPatch> patchMap = patches.stream().collect(Collectors
@@ -278,11 +263,42 @@ public static AruPatch selectPatch(List<AruPatch> patches, String providedVersio
             selected = patchMap.get(installerVersion);
         }
 
-        if (selected != null) {
+        logger.exiting(selected);
+        if (selected == null) {
+            throw logger.throwing(new MultiplePatchVersionsException(patches.get(0).patchId(), patches));
+        } else {
             logger.info("IMG-0099", selected.patchId(), selected.version(), selected.description());
+            return selected;
         }
-        logger.exiting(selected);
-        return selected;
+    }
+
+    private static AruPatch selectPatchOffline(List<AruPatch> patches, String providedVersion, String psuVersion,
+                                               String installerVersion) throws VersionNotFoundException {
+        AruPatch result = null;
+
+        if (patches.isEmpty()) {
+            logger.fine("Patches list is empty");
+        } else if (patches.size() == 1) {
+            result = patches.get(0);
+            // if the version is filled in, we are working online and there is nothing more to do.
+            if (result.version() == null) {
+                // no version means the patch is from the cache. Set the version as best we can.
+                // TODO: this could be improved if the cache was improved to store patch version.
+                if (providedVersion != null) {
+                    result.version(providedVersion);
+                } else if (psuVersion != null) {
+                    result.version(psuVersion);
+                } else {
+                    result.version(installerVersion);
+                }
+            } else if (providedVersion != null && !result.version().equals(providedVersion)) {
+                throw logger.throwing(new VersionNotFoundException(result.patchId(), providedVersion, patches));
+            } else {
+                logger.info("IMG-0099", result.patchId(), result.version(), result.description());
+            }
+        }
+        logger.exiting(result);
+        return result;
     }
 
     /**