Select patch version for a bug based on PSU version (#176)

* choose the patch version when not supplied based on the PSU of the source image for update

* obfuscate bug numbers from unit test data

Author: ddsharpe

imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java

@@ -10,6 +10,7 @@
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.Objects;
+import javax.xml.xpath.XPathExpressionException;
 
 import com.oracle.weblogic.imagetool.cachestore.CacheStore;
 import com.oracle.weblogic.imagetool.installer.InstallerType;
@@ -38,8 +39,10 @@ public class CachedFile {
      */
     public CachedFile(String id, String version) {
         Objects.requireNonNull(id, "key for the cached file cannot be null");
+        logger.entering(id, version);
         this.id = id;
         this.version = version;
+        logger.exiting();
     }
 
     /**
@@ -66,10 +69,14 @@ public String getKey() {
         if (id.contains(CacheStore.CACHE_KEY_SEPARATOR)) {
             return id;
         } else {
-            return id + CacheStore.CACHE_KEY_SEPARATOR + getVersion();
+            return buildKeyFromVersion(getVersion());
         }
     }
 
+    protected String buildKeyFromVersion(String version) {
+        return id + CacheStore.CACHE_KEY_SEPARATOR + version;
+    }
+
     /**
      * Get the version number for this cache entry/file.
      * @return the string version of this cached file.
@@ -84,7 +91,7 @@ public String getVersion() {
      * @return the Path of the file, if found
      * @throws IOException throws FileNotFoundException, if this cached file (key) could not be located in the cache
      */
-    public String resolve(CacheStore cacheStore) throws IOException {
+    public String resolve(CacheStore cacheStore) throws IOException, XPathExpressionException {
         // check entry exists in cache
         String key = getKey();
         logger.entering(key);
@@ -103,9 +110,9 @@ public String resolve(CacheStore cacheStore) throws IOException {
      * @param buildContextDir directory to copy file to
      * @return the path of the file copied to the Docker build context directory
      */
-    public Path copyFile(CacheStore cacheStore, String buildContextDir) throws IOException {
+    public Path copyFile(CacheStore cacheStore, String buildContextDir) throws IOException, XPathExpressionException {
         logger.entering();
-        Path result = null;
+        Path result;
         String sourceFile = resolve(cacheStore);
         logger.info("IMG-0043", sourceFile);
         String targetFilename = new File(sourceFile).getName();

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

@@ -0,0 +1,27 @@
+// 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.cachestore;
+
+import java.io.IOException;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import com.oracle.weblogic.imagetool.util.Utils;
+
+public class MultiplePatchVersionsException extends IOException {
+
+    /**
+     * Signals that the bug number provided was not unique, and has multiple versions available.
+     *
+     * @param bugNumber         the bug number that was searched
+     * @param versionsAvailable the list of versions for patches of that bug
+     */
+    public MultiplePatchVersionsException(String bugNumber, List<String> versionsAvailable) {
+        super(Utils.getMessage("IMG-0034", bugNumber,
+            versionsAvailable.stream()
+                .map(s -> bugNumber + "_" + s)
+                .collect(Collectors.joining(", ")))
+        );
+    }
+}

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

@@ -29,7 +29,7 @@ public class OPatchFile extends PatchFile {
      * @param password the password to use with the userId to retrieve the patch
      */
     public OPatchFile(String patchId, String userId, String password, CacheStore cache) {
-        super(getPatchId(patchId), latestVersion(cache, patchId, userId, password), userId, password);
+        super(getPatchId(patchId), latestVersion(cache, patchId, userId, password), null, userId, password);
     }
 
     private static String getPatchId(String patchId) {
@@ -74,7 +74,7 @@ private static String latestVersion(CacheStore cache, String patchId, String use
     }
 
     @Override
-    public String resolve(CacheStore cacheStore) throws IOException {
+    public String resolve(CacheStore cacheStore) throws IOException, XPathExpressionException {
         if (needAruInfo()) {
             initPatchInfo();
         }
@@ -86,18 +86,16 @@ public String resolve(CacheStore cacheStore) throws IOException {
     }
 
     @Override
-    void confirmUniquePatchSelection() throws IOException {
-        // if the user did not provide the patch version on the command line, use the latest version from ARU
+    boolean verifyPatchVersion() throws XPathExpressionException {
+        // if the user did not provide the patch version on the command line, use the latest version from Oracle Support
         if (!isPatchVersionProvided()) {
-            // grab the latest version for OPatch from ARU
-            try {
-                String latestVersion = XPathUtil.applyXPathReturnString(getAruInfo(),
-                    "string(/results/patch[access = 'Open access']/release/@name)");
-                setPatchVersion(latestVersion);
-                logger.fine("From ARU, setting OPatch patch version to {0}", latestVersion);
-            } catch (XPathExpressionException xe) {
-                throw new IOException(xe.getMessage());
-            }
+            // grab the latest version for OPatch from Oracle Support
+            String latestVersion = XPathUtil.applyXPathReturnString(getAruInfo(),
+                "string(/results/patch[access = 'Open access']/release/@name)");
+            setPatchVersion(latestVersion);
+            logger.fine("From ARU, setting OPatch patch version to {0}", latestVersion);
+            return true;
         }
+        return false;
     }
 }