Added new feature to create auxiliary image (#322)

* Added CreateAuxImage menu option to create WDT files image

* added option to set WDT home location to override /auxiliary

* refactor code for createAuxImage to remove duplicate code blocks

* added integration test for CreateAuxImage

* static code cleanup

* allow image inspect to run on busybox images

* use default overrides for --fromImage option

* tweaks to option descriptions based on review comments

* changed integration test to use actual permission string so build can be debugged

* update WDT option descriptions

* use default overrides for --wdtHome option

Author: ddsharpe

imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java

@@ -44,16 +44,6 @@ public BuildCommand(String buildEngine, String contextFolder) {
         context = contextFolder;
     }
 
-    /**
-     * If Docker is not on the user's path, set the full path to the executable.
-     * @param value full path to Docker
-     * @deprecated use --builder instead
-     */
-    @Deprecated
-    public void dockerPath(String value) {
-        command.set(0, value);
-    }
-
     /**
      * Add Docker image tag name for this build command.
      * @param value name to be used as the image tag.

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

@@ -67,10 +67,6 @@ public static OPatchFile getInstance(String patchId, String userid, String passw
             }
         }
 
-        // For the OPatch use case, only the provided version (--opatchBugNumber) is used to "select" a patch.
-        // selectPatch will return null if there is more than one patch in the patches list.
-        //AruPatch selectedPatch = AruPatch.selectPatch(patches, providedVersion, null, null);
-
         AruPatch selectedPatch;
         if (patches.isEmpty()) {
             throw new NoPatchesFoundException(Utils.getMessage("IMG-0057", patchNumber));

imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/ImageTool.java

@@ -7,6 +7,7 @@
 
 import com.oracle.weblogic.imagetool.api.model.CommandResponse;
 import com.oracle.weblogic.imagetool.cli.cache.CacheCLI;
+import com.oracle.weblogic.imagetool.cli.menu.CreateAuxImage;
 import com.oracle.weblogic.imagetool.cli.menu.CreateImage;
 import com.oracle.weblogic.imagetool.cli.menu.InspectImage;
 import com.oracle.weblogic.imagetool.cli.menu.RebaseImage;
@@ -28,6 +29,7 @@
         subcommands = {
             CacheCLI.class,
             CreateImage.class,
+            CreateAuxImage.class,
             UpdateImage.class,
             RebaseImage.class,
             InspectImage.class

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

@@ -3,8 +3,7 @@
 
 package com.oracle.weblogic.imagetool.cli.cache;
 
-import java.util.ArrayList;
-import java.util.List;
+import java.util.Collections;
 
 import com.oracle.weblogic.imagetool.api.model.CommandResponse;
 import com.oracle.weblogic.imagetool.util.Utils;
@@ -20,16 +19,15 @@ public class AddPatchEntry extends CacheAddOperation {
 
     @Override
     public CommandResponse call() throws Exception {
-
-        if (patchId != null && !patchId.isEmpty()) {
-            List<String> patches = new ArrayList<>();
-            patches.add(patchId);
-            if (!Utils.validatePatchIds(patches, true)) {
-                return CommandResponse.error("Patch ID validation failed");
+        try {
+            if (patchId != null && !patchId.isEmpty()) {
+                Utils.validatePatchIds(Collections.singletonList(patchId), true);
+                return addToCache(patchId);
+            } else {
+                return CommandResponse.error("IMG-0076", "--patchId");
             }
-            return addToCache(patchId);
-        } else {
-            return CommandResponse.error("IMG-0076", "--patchId");
+        } catch (Exception ex) {
+            return CommandResponse.error(ex.getMessage());
         }
     }
 

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

@@ -0,0 +1,119 @@
+// Copyright (c) 2021, 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;
+
+import java.io.IOException;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.List;
+import javax.xml.xpath.XPathExpressionException;
+
+import com.oracle.weblogic.imagetool.api.model.CachedFile;
+import com.oracle.weblogic.imagetool.aru.AruException;
+import com.oracle.weblogic.imagetool.installer.FmwInstallerType;
+import com.oracle.weblogic.imagetool.installer.InstallerType;
+import com.oracle.weblogic.imagetool.installer.MiddlewareInstall;
+import com.oracle.weblogic.imagetool.logging.LoggingFacade;
+import com.oracle.weblogic.imagetool.logging.LoggingFactory;
+import com.oracle.weblogic.imagetool.util.Constants;
+import com.oracle.weblogic.imagetool.util.Utils;
+import picocli.CommandLine.Option;
+
+import static com.oracle.weblogic.imagetool.cachestore.CacheStoreFactory.cache;
+
+public class CommonCreateOptions extends CommonPatchingOptions {
+
+    private static final LoggingFacade logger = LoggingFactory.getLogger(CommonCreateOptions.class);
+
+    /**
+     * Copy the Java and Middleware installers into the build context directory and set Dockerfile options accordingly.
+     */
+    void prepareNewImage() throws IOException, InterruptedException, XPathExpressionException, AruException {
+
+        logger.entering();
+        copyOptionsFromImage();
+
+        if (dockerfileOptions.installJava()) {
+            CachedFile jdk = new CachedFile(InstallerType.JDK, jdkVersion);
+            Path installerPath = jdk.copyFile(cache(), buildDir());
+            dockerfileOptions.setJavaInstaller(installerPath.getFileName().toString());
+        }
+
+        if (dockerfileOptions.installMiddleware()) {
+            MiddlewareInstall install =
+                new MiddlewareInstall(installerType, installerVersion, installerResponseFiles);
+            install.copyFiles(cache(), buildDir());
+            dockerfileOptions.setMiddlewareInstall(install);
+        } else {
+            dockerfileOptions.setWdtBase(fromImage());
+        }
+
+        // resolve required patches
+        handlePatchFiles(installerType);
+
+        // If patching, patch OPatch first
+        if (applyingPatches() && shouldUpdateOpatch()) {
+            prepareOpatchInstaller(buildDir(), opatchBugNumber);
+        }
+
+        Utils.setOracleHome(installerResponseFiles, dockerfileOptions);
+
+        // Set the inventory oraInst.loc file location (null == default location)
+        dockerfileOptions.setInvLoc(inventoryPointerInstallLoc);
+
+        // Set the inventory location, so that it will be copied
+        if (inventoryPointerFile != null) {
+            Utils.setInventoryLocation(inventoryPointerFile, dockerfileOptions);
+            Utils.copyLocalFile(Paths.get(inventoryPointerFile), Paths.get(buildDir(), "/oraInst.loc"));
+        } else {
+            Utils.copyResourceAsFile("/response-files/oraInst.loc", buildDir());
+        }
+        logger.exiting();
+    }
+
+    String getInstallerVersion() {
+        return installerVersion;
+    }
+
+    @Option(
+        names = {"--type"},
+        description = "Installer type. Default: WLS. Supported values: ${COMPLETION-CANDIDATES}"
+    )
+    private FmwInstallerType installerType = FmwInstallerType.WLS;
+
+    @Option(
+        names = {"--version"},
+        description = "Installer version. Default: ${DEFAULT-VALUE}",
+        required = true,
+        defaultValue = Constants.DEFAULT_WLS_VERSION
+    )
+    private String installerVersion;
+
+    @Option(
+        names = {"--jdkVersion"},
+        description = "Version of server jdk to install. Default: ${DEFAULT-VALUE}",
+        required = true,
+        defaultValue = Constants.DEFAULT_JDK_VERSION
+    )
+    private String jdkVersion;
+
+    @Option(
+        names = {"--installerResponseFile"},
+        split = ",",
+        description = "path to a response file. Override the default responses for the Oracle installer"
+    )
+    private List<Path> installerResponseFiles;
+
+    @Option(
+        names = {"--inventoryPointerFile"},
+        description = "path to a user provided inventory pointer file as input"
+    )
+    private String inventoryPointerFile;
+
+    @Option(
+        names = {"--inventoryPointerInstallLoc"},
+        description = "path to where the inventory pointer file (oraInst.loc) should be stored in the image"
+    )
+    private String inventoryPointerInstallLoc;
+}