refactor "opatch" into Constants and correct documentation of addPatch in quickstart

Author: jshum2479

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

@@ -109,6 +109,13 @@ private CommandResponse validateAndAddToCache(String patchNumber, String passwor
      */
     private CommandResponse addToCache(String patchNumber) {
         String key = AbstractFile.generateKey(patchNumber, version);
+
+        // 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;
+        }
         cacheStore.addToCache(key, location.toAbsolutePath().toString());
         String msg = String.format("Added Patch entry %s=%s for %s", key, location.toAbsolutePath(), type);
         logger.info(msg);

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

@@ -31,7 +31,7 @@ public DeleteEntry(boolean isCLIMode) {
     public CommandResponse call() {
         if (!Utils.isEmptyString(key)) {
             if (Constants.CACHE_DIR_KEY.equals(key.toLowerCase())) {
-                return new CommandResponse(-1, "Error: Cannot delete cache.dir entry. Use setCacheDir instead");
+                return new CommandResponse(0, "Cannot delete key: " + key);
             } else if (Constants.DELETE_ALL_FOR_SURE.equalsIgnoreCase(key)) {
                 Map<String, String> allEntries = cacheStore.getCacheItems();
                 //allEntries.remove(CACHE_DIR_KEY);

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

@@ -175,10 +175,12 @@ void handleProxyUrls() throws IOException {
 
     void addOPatch1394ToImage(Path tmpDir, String opatchBugNumber) throws Exception {
         // opatch patch now is in the format #####_opatch in the cache store
-        //
+        // So the version passing to the constructor of PatchFile is also "opatch".
+        // since opatch releases is on it's own and there is not really a patch to opatch
+        // and the version is embedded in the zip file version.txt
 
         String filePath =
-            new PatchFile(useCache, "opatch", "opatch", opatchBugNumber, userId, password).resolve(cacheStore);
+            new PatchFile(useCache, Constants.OPATCH_PATCH_TYPE, Constants.OPATCH_PATCH_TYPE, opatchBugNumber, userId, password).resolve(cacheStore);
         Files.copy(Paths.get(filePath), Paths.get(tmpDir.toAbsolutePath().toString(), new File(filePath).getName()));
         filterStartTags.add("OPATCH_1394");
         if (this instanceof CreateImage) {

imagetool/src/main/java/com/oracle/weblogic/imagetool/util/ARUUtil.java

@@ -356,7 +356,7 @@ private static Document getAllReleases(String category, String userId, String pa
 
             if ("wls".equalsIgnoreCase(category)) {
                 expression = "/results/release[starts-with(text(), 'Oracle WebLogic Server')]";
-            } else if ("opatch".equalsIgnoreCase(category)) {
+            } else if (Constants.OPATCH_PATCH_TYPE.equalsIgnoreCase(category)) {
                 expression = "/results/release[starts-with(text(), 'OPatch')]";
             } else {
                 expression = "/results/release[starts-with(text(), 'Fusion Middleware Upgrade')]";
@@ -417,13 +417,13 @@ private static String getPatch(String category, String version, String bugNumber
             IOException {
 
         String releaseNumber = "";
-        if (!category.equals("opatch")) {
+        if (!category.equals(Constants.OPATCH_PATCH_TYPE)) {
             releaseNumber = getReleaseNumber(category, version, userId, password);
         }
         String url;
         if ("wls".equalsIgnoreCase(category)) {
             url = String.format(Constants.PATCH_SEARCH_URL, Constants.WLS_PROD_ID, bugNumber, releaseNumber);
-        } else if ("opatch".equalsIgnoreCase(category)) {
+        } else if (Constants.OPATCH_PATCH_TYPE.equalsIgnoreCase(category)) {
             url = String.format(Constants.OPATCH_BUG_URL, bugNumber);
         } else {
             url = String.format(Constants.PATCH_SEARCH_URL, Constants.FMW_PROD_ID, bugNumber, releaseNumber);

imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Constants.java

@@ -24,6 +24,7 @@ public final class Constants {
     static final String WLS_PROD_ID = "15991";
     static final String FMW_PROD_ID = "27638";
     static final String OPATCH_PROD_ID = "31944";
+    public static final String OPATCH_PATCH_TYPE = "opatch";
     public static final String CACHE_DIR_KEY = "cache.dir";
     public static final String DEFAULT_WLS_VERSION = "12.2.1.3.0";
     public static final String DEFAULT_JDK_VERSION = "8u202";

imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java

@@ -626,7 +626,8 @@ public static String getOpatchVersionFromZip(String fileName) {
                 }
             }
         } catch (IOException ioe) {
-            ioe.printStackTrace();
+            logger.warning("Cannot read opatch file " + fileName);
+            logger.finest(ioe.getLocalizedMessage());
         }
         return null;
     }

site/quickstart.md

@@ -151,7 +151,7 @@ For each WebLogic patch, you will need to download it from Oracle Support and se
 27342434 for WebLogic version 12.2.1.3.0:
 
 ```bash
-imagetool cache addPatch --patchId 27342434 --version 12.2.1.3.0 --path /home/acmeuser/cache/p27342434_122130_Generic .zip -user [email protected] --passwordEnv MYPWD
+imagetool cache addPatch --patchId p27342434 --version 12.2.1.3.0 --path /home/acmeuser/cache/p27342434_122130_Generic .zip -user [email protected] --passwordEnv MYPWD
 ```
 
 You need to provide the credentials in the command line. It verifies the MD5 on the file system against the meta data
@@ -168,7 +168,7 @@ downloading the latest OPatch patch and setup the cache.  For example, the lates
 .4.0.0.  You can use this command to set up the cache after downloading from Oracle Support.
 
 ```bash
-imagetool cache addPatch --patchId 28186730 --version 13.9.4.0.0 --path /home/acmeuser/cache/p28186730_139400_Generic.zip
+imagetool cache addPatch --patchId p28186730 --version 13.9.4.0.0 --path /home/acmeuser/cache/p28186730_139400_Generic.zip
 ```
 
 ## Patching an existing image