Choose latest OPatch when multiple versions of OPatch are recommended (#242)

Author: ddsharpe

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

@@ -21,7 +21,7 @@
  * Metadata for a patch, as defined by ARU.
  * Simple bean for holding metadata obtained from ARU for a given patch ID and version.
  */
-public class AruPatch {
+public class AruPatch implements Comparable<AruPatch> {
     private static final LoggingFacade logger = LoggingFactory.getLogger(AruPatch.class);
 
     private String patchId;
@@ -268,6 +268,9 @@ public static AruPatch selectPatch(List<AruPatch> patches, String providedVersio
     @Override
     public String toString() {
         return patchId + " - " + description;
+    }
 
+    public int compareTo(AruPatch obj) {
+        return version.compareTo(obj.version);
     }
 }

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

@@ -5,6 +5,7 @@
 
 import java.io.FileNotFoundException;
 import java.io.IOException;
+import java.util.Comparator;
 import java.util.List;
 import java.util.Set;
 import java.util.stream.Collectors;
@@ -62,18 +63,25 @@ public static OPatchFile getInstance(String patchId, String userid, String passw
             patches = filteredList.collect(Collectors.toList());
         }
 
+        // For the OPatch use case, only the provided version (--opatchBugNumber) is used to "select" a patch.
+        // selectPatch will return null if there is more than one patch in the patches list.
         AruPatch selectedPatch = AruPatch.selectPatch(patches, providedVersion, null, null);
 
         if (selectedPatch != null) {
             // if offline, find the latest OPatch version available in the cache
             if (isOffline(userid, password) && providedVersion == null) {
                 selectedPatch.version(getLatestCachedVersion(cache, patchNumber));
             }
-            logger.exiting(selectedPatch);
-            return new OPatchFile(selectedPatch, userid, password);
         } else {
-            throw new MultiplePatchVersionsException(patchNumber, patches);
+            // select first recommended patch
+            List<AruPatch> sortedList = patches.stream().sorted(Comparator.reverseOrder()).collect(Collectors.toList());
+            selectedPatch = sortedList.get(0);
+            logger.warning("IMG-0057", selectedPatch.version(), sortedList.stream()
+                .map(s -> s.patchId() + "_" + s.version())
+                .collect(Collectors.joining(", ")));
         }
+        logger.exiting(selectedPatch);
+        return new OPatchFile(selectedPatch, userid, password);
     }
 
     private static boolean isOffline(String userid, String password) {

imagetool/src/main/resources/ImageTool.properties

@@ -55,7 +55,7 @@ IMG-0053=[[brightgreen: Build successful.]] Build time={0}s. Image tag={1}
 IMG-0054=[[brightgreen: Dry run complete.]]  No image created.
 IMG-0055=RunRCU can only be used when creating a new domain.  Please try --wdtOperation=CREATE or removing --wdtRunRCU.
 IMG-0056=Patch {0} is not in the cache store and you have not provided Oracle Support credentials.  Please provide --user with one of the password options or populate the cache store manually.
-IMG-0057=Could not locate patch ID {0} from Oracle
+IMG-0057=Currently, Oracle has marked more than one version of OPatch as recommended, selecting the first recommendatation, {0}.  To override the default selection, use the --opatchBugNumber command line option with one of the recommended versions: {1}
 IMG-0058=A patch cannot have an empty/null bug number: {0}
 IMG-0059=Invalid response from Oracle ARU, unable to locate download URL for {0}
 IMG-0060=Adding patch [[cyan: {0}]] to cache, path={1}

imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/PatchFileTest.java

@@ -353,8 +353,8 @@ void opatchDefaultTest() throws Exception {
         String filePath = patchFile.resolve(cacheStore);
 
         assertNotNull(filePath, "Patch resolve() failed to get file path from XML");
-        assertEquals("13.9.4.2.4", patchFile.getVersion(), "wrong version selected");
-        String filePathFromCache = cacheStore.getValueFromCache(patchId + "_13.9.4.2.4");
+        assertEquals("13.9.4.2.5", patchFile.getVersion(), "wrong version selected");
+        String filePathFromCache = cacheStore.getValueFromCache(patchId + "_13.9.4.2.5");
         assertNotNull(filePathFromCache, "Could not find new patch in cache");
         assertEquals(filePath, filePathFromCache, "Patch in cache does not match");
     }

imagetool/src/test/resources/patch-28186730.xml

@@ -34,6 +34,7 @@
         <translations_available>No</translations_available>
         <classification id="174">General</classification>
         <patch_classification id="174">General</patch_classification>
+        <life_cycle id="175">Recommended</life_cycle>
         <support_level id="G">General Support</support_level>
         <entitlements>
             <entitlement code="SW"/>