Allow user to override Package Manager type (#181)

ddsharpe · web-flow · commit b3abcdc07530 · 2020-06-24T09:32:54.000-05:00
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java
@@ -13,6 +13,7 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
+import java.util.Properties;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
@@ -318,6 +319,51 @@ void installOpatchInstaller(String tmpDir, String opatchBugNumber) throws Except
         dockerfileOptions.setOPatchFileName(filename);
     }
 
+    /**
+     * Set the docker options for build if fromImage parameter is present.
+     * @param fromImage  image tag
+     * @param tmpDir temporary directory
+     * @throws Exception thrown by getBaseImageProperties
+     */
+    public void copyOptionsFromImage(String fromImage, String tmpDir)
+        throws Exception {
+
+        if (fromImage != null && !fromImage.isEmpty()) {
+            logger.finer("IMG-0002", fromImage);
+            dockerfileOptions.setBaseImage(fromImage);
+
+            Utils.copyResourceAsFile("/probe-env/test-create-env.sh",
+                tmpDir + File.separator + "test-env.sh", true);
+
+            Properties baseImageProperties = Utils.getBaseImageProperties(fromImage, tmpDir);
+
+            if (baseImageProperties.getProperty("WLS_VERSION", null) != null) {
+                throw new IllegalArgumentException(Utils.getMessage("IMG-0038", fromImage,
+                    baseImageProperties.getProperty("ORACLE_HOME")));
+            }
+
+            String existingJavaHome = baseImageProperties.getProperty("JAVA_HOME", null);
+            if (existingJavaHome != null) {
+                dockerfileOptions.disableJavaInstall(existingJavaHome);
+                logger.info("IMG-0000", existingJavaHome);
+            }
+
+            String osProperty = baseImageProperties.getProperty("ID", "ol");
+            PackageManagerType pkgMgr = PackageManagerType.fromOperatingSystem(osProperty);
+            logger.fine("fromImage is {0}, using package manager {1}", osProperty, pkgMgr);
+            if (packageManager != PackageManagerType.OS_DEFAULT && pkgMgr != packageManager) {
+                logger.info("IMG-0079", pkgMgr, packageManager);
+                pkgMgr = packageManager;
+            }
+            dockerfileOptions.setPackageInstaller(pkgMgr);
+        } else if (packageManager == PackageManagerType.OS_DEFAULT) {
+            // Default OS is Oracle Linux, so default package manager is YUM
+            dockerfileOptions.setPackageInstaller(PackageManagerType.YUM);
+        } else {
+            dockerfileOptions.setPackageInstaller(packageManager);
+        }
+    }
+
     String getUserId() {
         return userId;
     }
@@ -475,6 +521,12 @@ String getPassword() {
     )
     Path verrazzanoModel;
 
+    @Option(
+        names = {"--packageManager"},
+        description = "Set the Linux package manager to use for installing OS packages. Default: ${DEFAULT-VALUE}"
+    )
+    PackageManagerType packageManager = PackageManagerType.OS_DEFAULT;
+
     @SuppressWarnings("unused")
     @Unmatched
     List<String> unmatchedOptions;
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CreateImage.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CreateImage.java
@@ -54,7 +54,7 @@ public CommandResponse call() throws Exception {
                 return new CommandResponse(-1, "Patch ID validation failed");
             }
 
-            WLSInstallHelper.copyOptionsFromImage(fromImage, dockerfileOptions, tmpDir);
+            copyOptionsFromImage(fromImage, tmpDir);
 
             if (dockerfileOptions.installJava()) {
                 CachedFile jdk = new CachedFile(InstallerType.JDK, jdkVersion);
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/PackageManagerType.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/PackageManagerType.java
@@ -0,0 +1,40 @@
+// 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.cli.menu;
+
+public enum PackageManagerType {
+    OS_DEFAULT,
+    NONE,
+    YUM,
+    APTGET,
+    APK,
+    ZYPPER;
+
+    /**
+     * Returns the package manager that should be used to install software on a given Linux OS.
+     * Defaults to YUM.  Known OS's include: ubuntu, debian, opensuse, centos, ol (Oracle Linux), and rhel.
+     *
+     * @param osID identifier for the OS, like ubuntu, debian, rhel, ol, ...
+     * @return the package manager
+     */
+    public static PackageManagerType fromOperatingSystem(String osID) {
+        if (osID == null) {
+            return YUM;
+        }
+
+        osID = osID.replaceAll("[\"]", "");
+        switch (osID) {
+            case "ubuntu":
+            case "debian":
+                return APTGET;
+            case "opensuse":
+                return ZYPPER;
+            case "centos":
+            case "ol":
+            case "rhel":
+            default:
+                return YUM;
+        }
+    }
+}
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/RebaseImage.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/RebaseImage.java
@@ -121,7 +121,7 @@ public CommandResponse call() throws Exception {
 
             if (dockerfileOptions.isRebaseToNew()) {
 
-                WLSInstallHelper.copyOptionsFromImage(fromImage, dockerfileOptions, tmpDir);
+                copyOptionsFromImage(fromImage, tmpDir);
 
                 CachedFile jdk = new CachedFile(InstallerType.JDK, jdkVersion);
                 Path installerPath = jdk.copyFile(cache(), tmpDir);
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/UpdateImage.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/UpdateImage.java
@@ -61,11 +61,6 @@ public CommandResponse call() throws Exception {
 
             Properties baseImageProperties = Utils.getBaseImageProperties(fromImage, tmpDir);
 
-            String pkgMgr = Utils.getPackageMgrStr(baseImageProperties.getProperty("ID", "ol"));
-            if (!Utils.isEmptyString(pkgMgr)) {
-                dockerfileOptions.setPackageInstaller(pkgMgr);
-            }
-
             String oracleHome = baseImageProperties.getProperty("ORACLE_HOME", null);
             if (oracleHome == null) {
                 return new CommandResponse(-1, "IMG-0072", fromImage);
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/WLSInstallHelper.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/WLSInstallHelper.java
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Constants.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Constants.java
@@ -29,10 +29,6 @@ public final class Constants {
     public static final String HTTPS = "https";
     public static final String PATCH_ID_REGEX =  "^(\\d{8})(?:[_][0-9][0-9]\\.[0-9]\\.[0-9]\\.[0-9]\\.(\\d+))?";
     public static final String RIGID_PATCH_ID_REGEX =  "^(\\d{8})[_][0-9][0-9]\\.[0-9]\\.[0-9]\\.[0-9]\\.(\\d+)";
-    //Option flags
-    public static final String YUM = "_YUM";
-    public static final String APTGET = "_APT";
-    public static final String ZYPPER = "_SUSE";
 
 
     private Constants() {
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/DockerfileOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/DockerfileOptions.java
@@ -10,6 +10,7 @@
 import java.util.Map;
 import java.util.StringJoiner;
 
+import com.oracle.weblogic.imagetool.cli.menu.PackageManagerType;
 import com.oracle.weblogic.imagetool.installer.MiddlewareInstall;
 import com.oracle.weblogic.imagetool.installer.MiddlewareInstallPackage;
 import com.oracle.weblogic.imagetool.wdt.WdtOperation;
@@ -25,10 +26,6 @@ public class DockerfileOptions {
     private static final String DEFAULT_ORAINV_DIR = "/u01/oracle/oraInventory";
 
     final String buildId;
-    boolean useYum = false;
-    boolean useAptGet = false;
-    boolean useApk = false;
-    boolean useZypper = false;
 
     private boolean useWdt;
     private boolean applyPatches;
@@ -50,6 +47,7 @@ public class DockerfileOptions {
     private String opatchFileName;
     private String sourceImage;
     private String targetImage;
+    private PackageManagerType pkgMgr;
 
     // WDT values
     private String wdtHome;
@@ -227,31 +225,36 @@ public void setRebaseToNew(boolean rebaseToNew) {
     }
 
     /**
-     * Only one package installer should be allowed.
+     * Set the Linux package Manager type to use during the build.
      *
-     * @param option the String constant identifying the installer to use.
+     * @param option the Linux package Manager type to use during the build.
      * @return this DockerfileOptions object
      */
-    public DockerfileOptions setPackageInstaller(String option) {
-        useZypper = false;
-        useAptGet = false;
-        useApk = false;
-        useYum = false;
-        switch (option) {
-            case Constants.YUM:
-                useYum = true;
-                break;
-            case Constants.APTGET:
-                useAptGet = true;
-                break;
-            case Constants.ZYPPER:
-                useZypper = true;
-                break;
-            default:
-        }
+    public DockerfileOptions setPackageInstaller(PackageManagerType option) {
+        pkgMgr = option;
         return this;
     }
 
+    @SuppressWarnings("unused")
+    public boolean useYum() {
+        return pkgMgr == PackageManagerType.YUM;
+    }
+
+    @SuppressWarnings("unused")
+    public boolean useAptGet() {
+        return pkgMgr == PackageManagerType.APTGET;
+    }
+
+    @SuppressWarnings("unused")
+    public boolean useZypper() {
+        return pkgMgr == PackageManagerType.ZYPPER;
+    }
+
+    @SuppressWarnings("unused")
+    public boolean useApk() {
+        return pkgMgr == PackageManagerType.APK;
+    }
+
     @SuppressWarnings("unused")
     public String java_home() {
         return javaHome;
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java
@@ -407,36 +407,6 @@ public static boolean isEmptyString(String s) {
         return (s == null) || s.isEmpty();
     }
 
-    /**
-     * Returns the package manager that should be used to install software on a given Linux OS.
-     * Defaults to YUM.  Known OS's include: ubuntu, debian, opensuse, centos, ol, and rhel.
-     *
-     * @param osID identifier for the OS, like ubuntu, debian, rhel, ol, ...
-     * @return the package manager
-     */
-    public static String getPackageMgrStr(String osID) {
-        String retVal = Constants.YUM;
-        if (osID != null) {
-            osID = osID.replaceAll("[\"]", "");
-            switch (osID) {
-                case "ubuntu":
-                case "debian":
-                    retVal = Constants.APTGET;
-                    break;
-                case "opensuse":
-                    retVal = Constants.ZYPPER;
-                    break;
-                case "centos":
-                case "ol":
-                case "rhel":
-                default:
-                    retVal = Constants.YUM;
-                    break;
-            }
-        }
-        return retVal;
-    }
-
     /**
      * Reads the docker image environment variables into Java Properties.
      *
diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties
@@ -77,3 +77,4 @@ IMG-0075=Added patch entry [[cyan: {0}]]={1}
 IMG-0076=Cache key {0} already exists, remove it first
 IMG-0077=Skipping duplicate patch {0}. Patch file already exists in the build context folder. Did you accidentally list the patch twice?
 IMG-0078=[[cyan: --type]] is [[brightred: DEPRECATED]] and will be removed in an upcoming release.
+IMG-0079=OS Package Manager override, changed from {0} to {1}
diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/DockerfileBuilderTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/DockerfileBuilderTest.java
@@ -11,6 +11,7 @@
 import com.github.mustachejava.DefaultMustacheFactory;
 import com.github.mustachejava.Mustache;
 import com.github.mustachejava.MustacheFactory;
+import com.oracle.weblogic.imagetool.cli.menu.PackageManagerType;
 import com.oracle.weblogic.imagetool.installer.FmwInstallerType;
 import com.oracle.weblogic.imagetool.installer.MiddlewareInstall;
 import org.junit.jupiter.api.Tag;
@@ -35,7 +36,7 @@ void validateMustacheAliases() throws IOException {
             .setWdtEnabled()
             .setWdtDomainType("WLS")
             .setWdtModels(Arrays.asList("model1.yaml", "model2.yaml"))
-            .setPackageInstaller(Constants.YUM)
+            .setPackageInstaller(PackageManagerType.YUM)
             .setMiddlewareInstall(install);
 
         MustacheFactory mf = new DefaultMustacheFactory(new File("src/main/resources/docker-files"));
@@ -47,13 +48,13 @@ void validateMustacheAliases() throws IOException {
 
     @Test
     void setPackageInstaller() {
-        DockerfileOptions options = new DockerfileOptions("123").setPackageInstaller(Constants.YUM);
-        assertTrue(options.useYum, "Failed to set YUM installer");
+        DockerfileOptions options = new DockerfileOptions("123").setPackageInstaller(PackageManagerType.YUM);
+        assertTrue(options.useYum(), "Failed to set YUM installer");
 
-        options = new DockerfileOptions("123").setPackageInstaller(Constants.APTGET);
-        assertTrue(options.useAptGet, "Failed to set 'APTGET' installer");
+        options = new DockerfileOptions("123").setPackageInstaller(PackageManagerType.APTGET);
+        assertTrue(options.useAptGet(), "Failed to set 'APTGET' installer");
 
-        options = new DockerfileOptions("123").setPackageInstaller(Constants.ZYPPER);
-        assertTrue(options.useZypper, "Failed to set 'ZYPPER' installer");
+        options = new DockerfileOptions("123").setPackageInstaller(PackageManagerType.ZYPPER);
+        assertTrue(options.useZypper(), "Failed to set 'ZYPPER' installer");
     }
 }
diff --git a/site/create-image.md b/site/create-image.md
@@ -23,6 +23,7 @@ Usage: imagetool create [OPTIONS]
 | `--jdkVersion` | Version of the server JDK to install.  | `8u202`  |
 | `--latestPSU` | Find and apply the latest PatchSet Update.  |   |
 | `--opatchBugNumber` | The patch number for OPatch (patching OPatch).  |   |
+| `--packageManager` | Override the default package manager for the base image's operating system. Supported values: `APK`, `APTGET`, `NONE`, `OS_DEFAULT`, `YUM`, `ZYPPER`  | `OS_DEFAULT`  |
 | `--password` | Request password for the Oracle Support `--user` on STDIN, see `--user`.  |   |
 | `--passwordEnv` | Environment variable containing the Oracle Support password, see `--user`.  |   |
 | `--passwordFile` | Path to a file containing just the Oracle Support password, see `--user`.  |   |
diff --git a/site/rebase-image.md b/site/rebase-image.md
@@ -25,6 +25,7 @@ Usage: imagetool rebase [OPTIONS]
 | `--jdkVersion` | Version of the server JDK to install.  | `8u202`  |
 | `--latestPSU` | Find and apply the latest PatchSet Update.  |   |
 | `--opatchBugNumber` | The patch number for OPatch (patching OPatch).  |   |
+| `--packageManager` | Override the default package manager for the base image's operating system. Supported values: `APK`, `APTGET`, `NONE`, `OS_DEFAULT`, `YUM`, `ZYPPER`  | `OS_DEFAULT`  |
 | `--password` | Request password for the Oracle Support `--user` on STDIN, see `--user`.  |   |
 | `--passwordEnv` | Environment variable containing the Oracle Support password, see `--user`.  |   |
 | `--passwordFile` | Path to a file containing just the Oracle Support password, see `--user`.  |   |

Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ public CommandResponse call() throws Exception {`
`54`	`54`	`return new CommandResponse(-1, "Patch ID validation failed");`
`55`	`55`	`}`
`56`	`56`
`57`		`- WLSInstallHelper.copyOptionsFromImage(fromImage, dockerfileOptions, tmpDir);`
	`57`	`+ copyOptionsFromImage(fromImage, tmpDir);`
`58`	`58`
`59`	`59`	`if (dockerfileOptions.installJava()) {`
`60`	`60`	`CachedFile jdk = new CachedFile(InstallerType.JDK, jdkVersion);`