Altered process to get PSU overlay patches to allow separate filtering of OHS DB19 overlays

Author: ddsharpe

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

@@ -170,20 +170,8 @@ public List<AruPatch> getRecommendedPatches(FmwInstallerType type, String versio
                                                      String userId, String password) throws AruException {
         List<AruPatch> result = new ArrayList<>();
         for (AruProduct product : type.products()) {
-            List<AruPatch> patches = getRecommendedPatches(product, version, userId, password);
-            // temporary, until OHS stops using same release number and product ID for two different installs
-            if (type == FmwInstallerType.OHS_DB19) {
-                if (product == AruProduct.OHS) {
-                    patches = patches.stream().filter(p -> p.description().contains(" DB19C "))
-                        .collect(Collectors.toList());
-                } else if (product == AruProduct.OAM_WG) {
-                    patches = patches.stream().filter(p -> p.description().contains(" DB19c "))
-                        .collect(Collectors.toList());
-                } else if (product == AruProduct.OSS) {
-                    patches = patches.stream().filter(p -> p.description().contains(" 19C "))
-                        .collect(Collectors.toList());
-                }
-            }
+            List<AruPatch> patches = getRecommendedPatches(type, product, version, userId, password);
+
             if (!patches.isEmpty()) {
                 patches.forEach(p -> logger.info("IMG-0068", product.description(), p.patchId(), p.description()));
                 result.addAll(patches);
@@ -205,8 +193,8 @@ public List<AruPatch> getRecommendedPatches(FmwInstallerType type, String versio
      * @return the recommended patches for the given product and version
      * @throws AruException when response from ARU has an error or fails
      */
-    List<AruPatch> getRecommendedPatches(AruProduct product, String version, String userId, String password)
-        throws AruException {
+    List<AruPatch> getRecommendedPatches(FmwInstallerType type, AruProduct product, String version,
+                                         String userId, String password) throws AruException {
         logger.entering(product, version);
         List<AruPatch> patches = Collections.emptyList();
         try {
@@ -218,6 +206,12 @@ List<AruPatch> getRecommendedPatches(AruProduct product, String version, String
             } else {
                 // Get a list of patches applicable to the given product and release number
                 patches = getReleaseRecommendations(product, releaseNumber, userId, password);
+                logger.fine("Search for {0} recommended patches returned {1}", product, patches.size());
+                if (type == FmwInstallerType.OHS_DB19) {
+                    // Workaround for OHS where the DB19 patches and the DB12 patches have the same product/release ID
+                    patches = filterDb19Patches(patches, product);
+                }
+
                 String psuVersion = getPsuVersion(product.description(), patches);
                 if (psuVersion != null) {
                     // Check to see if there is a release with the PSU version that contains overlay patches.
@@ -227,11 +221,11 @@ List<AruPatch> getRecommendedPatches(AruProduct product, String version, String
                     String psuReleaseNumber = getReleaseNumber(product, psuVersion, userId, password);
                     // If there is a release for the specific PSU, check it for overlay patches
                     if (!Utils.isEmptyString(psuReleaseNumber)) {
-                        // Debug log - useful to know what was thrown away when "patches" is replaced by the new array
-                        patches.forEach(p -> logger.fine("Discarding recommended patch {0} {1}",
-                            p.patchId(), p.description()));
                         // Get recommended patches for PSU release (includes PSU overlay patches)
-                        patches = getReleaseRecommendations(product, psuReleaseNumber, userId, password);
+                        List<AruPatch> overlays =
+                            getReleaseRecommendations(product, psuReleaseNumber, userId, password);
+                        logger.fine("Search for PSU {0} overlay patches returned {1}", psuVersion, overlays.size());
+                        patches.addAll(overlays);
                     } else {
                         // ARU does not have a release number for the PSU version found (no overlays needed)
                         logger.fine("PSU release was not found for {0} : {1}", product, psuVersion);
@@ -247,6 +241,25 @@ List<AruPatch> getRecommendedPatches(AruProduct product, String version, String
         return patches;
     }
 
+    /**
+     * This is a temporary workaround to select DB19 patches from a recommended list of patches.
+     * Currently, OHS is using the same release number and product ID for two different installs (DB19 and DB12).
+     * @param patches patches list to filter
+     * @param product AruProduct that the supplied patches are for
+     */
+    private List<AruPatch> filterDb19Patches(List<AruPatch> patches, AruProduct product) {
+        List<AruPatch> result = patches;
+        // temporary, until OHS stops using same release number and product ID for two different installs
+        if (product == AruProduct.OHS) {
+            result = patches.stream().filter(p -> p.description().contains(" DB19C ")).collect(Collectors.toList());
+        } else if (product == AruProduct.OAM_WG) {
+            result = patches.stream().filter(p -> p.description().contains(" DB19c ")).collect(Collectors.toList());
+        } else if (product == AruProduct.OSS) {
+            result = patches.stream().filter(p -> p.description().contains(" 19C ")).collect(Collectors.toList());
+        }
+        return result;
+    }
+
     private String getPsuVersion(String productName, Collection<AruPatch> patches) {
         String psuBundle = patches.stream()
             .map(AruPatch::psuBundle)
@@ -270,6 +283,7 @@ List<AruPatch> getReleaseRecommendations(AruProduct product, String releaseNumbe
             .filter(not(AruPatch::isStackPatchBundle)) // remove the Stack Patch Bundle patch, if returned
             // TODO: Need an option for the user to request the Coherence additional feature pack.
             .filter(not(AruPatch::isCoherenceFeaturePack)) // remove the Coherence feature pack, if returned
+            .filter(p -> p.release().equals(releaseNumber))
             .collect(Collectors.toList());
     }
 

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

@@ -0,0 +1,50 @@
+// Copyright (c) 2024, 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.cli.menu;
+
+/**
+ * Platform is a menu option that sets the OS and Architecture for the target build.
+ */
+public enum Platform {
+    ARM64(541, "linux/arm64", "arm64"), // Linux ARM 64-bit
+    AMD64(226, "linux/amd64", "amd64"); // Linux AMD 64-bit
+
+    private final int aruPlatform;
+    private final String[] acceptableNames;
+
+    /**
+     * Create Platform definitions.
+     * @param aruPlatform the ARU code for a given OS/architecture.
+     * @param acceptableNames the acceptable strings from a command line input that can be mapped to a Platform.
+     */
+    Platform(int aruPlatform, String... acceptableNames) {
+        this.aruPlatform = aruPlatform;
+        this.acceptableNames = acceptableNames;
+    }
+
+    /**
+     * Get the ARU platform code.
+     * @return the ARU platform code.
+     */
+    public int getAruPlatform() {
+        return aruPlatform;
+    }
+
+    /**
+     * Given a string value from the user, get the Enum type.
+     *
+     * @param value string value to map to a Platform Enum.
+     * @return the Platform type found or null if not found.
+     */
+    public Platform fromString(String value) {
+        for (Platform p: values()) {
+            for (String name: p.acceptableNames) {
+                if (name.equalsIgnoreCase(value)) {
+                    return p;
+                }
+            }
+        }
+        return null;
+    }
+}

imagetool/src/test/java/com/oracle/weblogic/imagetool/aru/AruUtilTest.java

@@ -45,8 +45,10 @@ Document getRecommendedPatchesMetadata(AruProduct product, String releaseNumber,
             Document result;
             try {
                 // these release numbers are fake test data from the fake releases.xml found in test/resources
-                if (releaseNumber.equals("336") || releaseNumber.equals("304")) {
+                if (releaseNumber.equals("336")) {  // 336 == 12.2.1.3.0 (GA release)
                     result = ResourceUtils.getXmlFromResource("/patches/recommended-patches.xml");
+                } else if (releaseNumber.equals("304")) { // 304 == 12.2.1.3.200624 (PSU overlay)
+                    result = ResourceUtils.getXmlFromResource("/patches/recommended-patches-304.xml");
                 } else {
                     result = ResourceUtils.getXmlFromResource("/patches/no-patches.xml");
                 }
@@ -70,14 +72,15 @@ Document patchConflictCheck(String payload, String userId, String password) thro
     @Test
     void testRecommendedPatches() throws Exception {
         List<AruPatch> recommendedPatches =
-            AruUtil.rest().getRecommendedPatches(AruProduct.WLS, "12.2.1.3.0", "x", "x");
-        assertEquals(5, recommendedPatches.size());
+            AruUtil.rest().getRecommendedPatches(FmwInstallerType.WLS, AruProduct.WLS, "12.2.1.3.0", "x", "x");
+        assertEquals(6, recommendedPatches.size());
         List<String> bugs = recommendedPatches.stream().map(AruPatch::patchId).collect(Collectors.toList());
         assertTrue(bugs.contains("31544340"));
         assertTrue(bugs.contains("31535411"));
         assertTrue(bugs.contains("31384951"));
         assertTrue(bugs.contains("28512225"));
         assertTrue(bugs.contains("28278427"));
+        assertTrue(bugs.contains("11112222"));
 
         // if no recommended patches are found, method should return an empty list (test data does not have 12.2.1.4)
         recommendedPatches =
@@ -88,7 +91,7 @@ void testRecommendedPatches() throws Exception {
     @Test
     void testNoRecommendedPatches() throws Exception {
         List<AruPatch> recommendedPatches =
-            AruUtil.rest().getRecommendedPatches(AruProduct.WLS, "12.2.1.4.0", "x", "x");
+            AruUtil.rest().getRecommendedPatches(FmwInstallerType.WLS, AruProduct.WLS, "12.2.1.4.0", "x", "x");
         assertEquals(0, recommendedPatches.size());
     }
 
@@ -109,7 +112,7 @@ void testReleaseNotFound() throws Exception {
         assertEquals(0, latestPsu.size());
 
         List<AruPatch> recommendedPatches =
-            AruUtil.rest().getRecommendedPatches(AruProduct.WLS, "3.0.0.0.0", "x", "x");
+            AruUtil.rest().getRecommendedPatches(FmwInstallerType.WLS, AruProduct.WLS, "3.0.0.0.0", "x", "x");
         assertEquals(0, recommendedPatches.size());
     }