change patching implementation

* change how we handle patches

* add patches conflict check for create image

* Fix cache addPatch to accept new patch id format and remove validation

* update doc to standardized patch number format

* update doc and add rigid patch number pattern when using cache addPatch

* change cache to ALWAYS and no other policy.

useCache is now a hidden option.

If no user credentials are provided then it will failed if the needed patch is not in the cache.  --latestPSU always requires credentials.

* optimize import, fix missing constructor super call and missing mustache

* report validation message error

* fix documentation

* code cleanup

* fix doc

* fix help text for patchid

* Change validatePatchIds not to thrown exception

* remove download installer code

* format error message according to the format requirement

* refine error message

* fix wdt complaining java_home not set for wdt

* Fix volume mount issue when updating image where the local builddir is on nfs system.  This also eliminate the problem with a remote docker daemob

* rename domainType to wdtDomainType

* Fix how the bash command is built for checking image info

* Fix opatch lsinventory to use base64 output to properties instead of file

* Add failure check for lsinventory result

* Correct doc and error message for failure to cleanup temp directory

* fix error message format

Author: jshum2479

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

@@ -20,6 +20,7 @@ public abstract class AbstractFile implements FileResolver {
     protected CachePolicy cachePolicy;
     protected String userId;
     protected String password;
+    private final static Logger logger = Logger.getLogger(AbstractFile.class.getName());
 
     public AbstractFile(String id, String version, CachePolicy cachePolicy, String userId, String password) {
         this.key = generateKey(id, version);
@@ -28,8 +29,24 @@ public AbstractFile(String id, String version, CachePolicy cachePolicy, String u
         this.password = password;
     }
 
-    public static String generateKey(String id, String version) {
-        return id + CacheStore.CACHE_KEY_SEPARATOR + version;
+    public String generateKey(String id, String version) {
+
+        // Note:  this will be invoked by InstallerFile or PatchFile
+        //  for patches there are specific format, currently installers are
+        //  wls, fmw, jdk.
+        //
+        //
+        String mykey = id;
+        if (id == null) {  // should never happens
+            mykey =  id + CacheStore.CACHE_KEY_SEPARATOR + version;
+        } else if (id.indexOf('_') < 0) {
+                if (version != null) {
+                    mykey = mykey + CacheStore.CACHE_KEY_SEPARATOR + version;
+                }
+        }
+
+        logger.finest("AbstractFile generating key returns " + mykey);
+        return mykey;
     }
 
     public static boolean isFileOnDisk(String filePath) {

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

@@ -6,14 +6,18 @@
 package com.oracle.weblogic.imagetool.api.model;
 
 /**
+ * @Deprecated
+ *   This is subject to removal and there is no need to use it
+ *   The logic is changed to use the presence of userId and password to
+ *   determine whether to access online if the item is not in the cache.
+ *   It allows the cache is just a store and nothing more
+ *
  * first - Use cache entries and download artifacts if required
  * always - Use only cache entries and never download artifacts
  * never - Ignore cache entries and always download artifacts
  */
 public enum CachePolicy {
-    FIRST("first"),
-    ALWAYS("always"),
-    NEVER("never");
+    ALWAYS("always");
 
     private String value;
 

imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntry.java

@@ -5,25 +5,20 @@
 package com.oracle.weblogic.imagetool.cli.cache;
 
 import com.oracle.weblogic.imagetool.api.meta.CacheStore;
-import com.oracle.weblogic.imagetool.api.model.AbstractFile;
 import com.oracle.weblogic.imagetool.api.model.CommandResponse;
 import com.oracle.weblogic.imagetool.api.model.WLSInstallerType;
-import com.oracle.weblogic.imagetool.util.ARUUtil;
 import com.oracle.weblogic.imagetool.util.Constants;
-import com.oracle.weblogic.imagetool.util.SearchResult;
 import com.oracle.weblogic.imagetool.util.Utils;
-import com.oracle.weblogic.imagetool.util.XPathUtil;
-import org.apache.commons.codec.digest.DigestUtils;
-import org.w3c.dom.Document;
-import picocli.CommandLine.Command;
-import picocli.CommandLine.Option;
 
-import java.io.FileInputStream;
-import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.logging.Logger;
 
+import picocli.CommandLine.Command;
+import picocli.CommandLine.Option;
+
 @Command(
         name = "addPatch",
         description = "Add cache entry for wls|fmw patch or psu",
@@ -42,24 +37,17 @@ public AddPatchEntry(boolean isCLIMode) {
 
     @Override
     public CommandResponse call() throws Exception {
-        String password = handlePasswordOptions();
 
         if (patchId != null && !patchId.isEmpty()
                 && location != null && Files.exists(location)
                 && Files.isRegularFile(location)) {
 
-            String patchNumber;
-            if (patchId.matches(Constants.PATCH_ID_REGEX)) {
-                patchNumber = patchId.substring(1);
-            } else {
-                return new CommandResponse(-1, "Invalid patch id format: " + patchId);
-            }
-            if (userId != null && !userId.isEmpty() && password != null && !password.isEmpty() ) {
-                return validateAndAddToCache(patchNumber, password);
-            } else {
-                logger.info("Skipping patch validation, username and password were not provided");
-                return addToCache(patchNumber);
+            List<String> patches = new ArrayList<>();
+            patches.add(patchId);
+            if (!Utils.validatePatchIds(patches, true)) {
+                return new CommandResponse(-1, "Patch ID validation failed");
             }
+            return addToCache(patchId);
         }
 
         String msg = "Invalid arguments";
@@ -81,25 +69,7 @@ public CommandResponse call() throws Exception {
      * @throws Exception if the ARU call to get patch details failed
      */
     private CommandResponse validateAndAddToCache(String patchNumber, String password) throws Exception {
-        boolean matches = false;
-
-        SearchResult searchResult = ARUUtil.getPatchDetail(type.toString(), version, patchNumber, userId, password);
-
-        if (searchResult.isSuccess()) {
-            Document document = searchResult.getResults();
-            String patchDigest = XPathUtil.applyXPathReturnString(document, "string"
-                    + "(/results/patch[1]/files/file/digest[@type='SHA-256']/text())");
-            String localDigest = DigestUtils.sha256Hex(new FileInputStream(location.toFile()));
-
-            if (localDigest.equalsIgnoreCase(patchDigest)) {
-                return addToCache(patchNumber);
-            } else {
-                return new CommandResponse(-1, String.format(
-                        "Local file sha-256 digest %s != patch digest %s", localDigest, patchDigest));
-            }
-        }
-
-        return new CommandResponse(-1, String.format("Unable to find patchId %s on Oracle Support", patchId));
+        return addToCache(patchNumber);
     }
 
     /**
@@ -108,33 +78,31 @@ private CommandResponse validateAndAddToCache(String patchNumber, String passwor
      * @return CLI command response
      */
     private CommandResponse addToCache(String patchNumber) {
-        String key = AbstractFile.generateKey(patchNumber, version);
+        logger.info("adding key " + patchNumber);
+        String key = patchNumber;
 
         // Check if it is an Opatch patch
         String opatchNumber = Utils.getOpatchVersionFromZip(location.toAbsolutePath().toString());
         if (opatchNumber != null) {
             int lastSeparator = key.lastIndexOf(CacheStore.CACHE_KEY_SEPARATOR);
             key = key.substring(0,lastSeparator) + CacheStore.CACHE_KEY_SEPARATOR + Constants.OPATCH_PATCH_TYPE;
         }
+        logger.info("adding key " + key);
+        if (cacheStore.getValueFromCache(key) != null ) {
+            String error = String.format("Cache key %s already exists, remove it first", key);
+            logger.severe(error);
+            throw new IllegalArgumentException(error);
+        }
         cacheStore.addToCache(key, location.toAbsolutePath().toString());
         String msg = String.format("Added Patch entry %s=%s for %s", key, location.toAbsolutePath(), type);
         logger.info(msg);
         return new CommandResponse(0, msg);
     }
 
-    /**
-     * Determines the support password by parsing the possible three input options
-     *
-     * @return String form of password
-     * @throws IOException in case of error
-     */
-    private String handlePasswordOptions() throws IOException {
-        return Utils.getPasswordFromInputs(passwordStr, passwordFile, passwordEnv);
-    }
 
     @Option(
             names = {"--patchId"},
-            description = "Patch number. Ex: p28186730",
+            description = "Patch number. Ex: 28186730",
             required = true
     )
     private String patchId;
@@ -147,13 +115,6 @@ private String handlePasswordOptions() throws IOException {
     )
     private WLSInstallerType type;
 
-    @Option(
-            names = {"--version"},
-            description = "version of mw this patch is for. Ex: 12.2.1.3.0",
-            required = true,
-            defaultValue = Constants.DEFAULT_WLS_VERSION
-    )
-    private String version;
 
     @Option(
             names = {"--path"},
@@ -162,31 +123,4 @@ private String handlePasswordOptions() throws IOException {
     )
     private Path location;
 
-    @Option(
-            names = {"--user"},
-            paramLabel = "<support email>",
-            description = "Oracle Support email id"
-    )
-    private String userId;
-
-    @Option(
-            names = {"--password"},
-            paramLabel = "<password for support user id>",
-            description = "Password for support userId"
-    )
-    String passwordStr;
-
-    @Option(
-            names = {"--passwordEnv"},
-            paramLabel = "<environment variable>",
-            description = "environment variable containing the support password"
-    )
-    String passwordEnv;
-
-    @Option(
-            names = {"--passwordFile"},
-            paramLabel = "<password file>",
-            description = "path to file containing just the password"
-    )
-    Path passwordFile;
 }