Added --platform for selection of the build target platform

Author: ddsharpe

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2019, 2021, Oracle and/or its affiliates.
+// Copyright (c) 2019, 2024, 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.api.model;
@@ -15,6 +15,7 @@
 import com.oracle.weblogic.imagetool.installer.InstallerType;
 import com.oracle.weblogic.imagetool.logging.LoggingFacade;
 import com.oracle.weblogic.imagetool.logging.LoggingFactory;
+import com.oracle.weblogic.imagetool.util.BuildPlatform;
 import com.oracle.weblogic.imagetool.util.Utils;
 
 /**
@@ -24,31 +25,55 @@ public class CachedFile {
 
     private static final LoggingFacade logger = LoggingFactory.getLogger(CachedFile.class);
 
-    private String id;
-    private String version;
+    private final String id;
+    private final String version;
+    private final String architecture;
 
     /**
      * Represents a locally cached file.
      *
-     * @param id          cache ID (like installer type or patchId)
-     * @param version     version number for the patch or installer.
+     * @param id           cache ID (like installer type or patchId)
+     * @param version      version number for the patch or installer.
+     * @param architecture the system architecture that this file/installer is applicable
      */
-    public CachedFile(String id, String version) {
+    public CachedFile(String id, String version, String architecture) {
         Objects.requireNonNull(id, "key for the cached file cannot be null");
-        logger.entering(id, version);
+        logger.entering(id, version, architecture);
         this.id = id;
         this.version = version;
+        this.architecture = architecture;
         logger.exiting();
     }
 
+    /**
+     * Represents a locally cached file.
+     *
+     * @param id          cache ID (like installer type or patchId)
+     * @param version     version number for the patch or installer.
+     */
+    public CachedFile(String id, String version) {
+        this(id, version, null);
+    }
+
+    /**
+     * Represents a locally cached file.
+     *
+     * @param id           cache ID (like installer type)
+     * @param version      version number for the patch or installer.
+     * @param architecture the system architecture that this file/installer is applicable
+     */
+    public CachedFile(InstallerType id, String version, String architecture) {
+        this(id.toString(), version, architecture);
+    }
+
     /**
      * Represents a locally cached file.
      *
      * @param id          cache ID (like installer type)
      * @param version     version number for the patch or installer.
      */
     public CachedFile(InstallerType id, String version) {
-        this(id.toString(), version);
+        this(id.toString(), version, null);
     }
 
     public static boolean isFileOnDisk(String filePath) {
@@ -62,11 +87,23 @@ public static boolean isFileOnDisk(String filePath) {
      * @return the key to use for this cache entry, like xxxx_yyyy.
      */
     public String getKey() {
+        return getCacheKey(architecture);
+    }
+
+    private String getCacheKey(String architecture) {
         if (id.contains(CacheStore.CACHE_KEY_SEPARATOR)) {
             return id;
-        } else {
-            return id + CacheStore.CACHE_KEY_SEPARATOR + getVersion();
         }
+
+        StringBuilder key = new StringBuilder(32);
+        key.append(id);
+        key.append(CacheStore.CACHE_KEY_SEPARATOR);
+        key.append(version);
+        if (architecture != null) {
+            key.append(CacheStore.CACHE_KEY_SEPARATOR);
+            key.append(architecture);
+        }
+        return key.toString();
     }
 
     /**
@@ -77,8 +114,22 @@ public String getVersion() {
         return version;
     }
 
+    /**
+     * Get the system architecture name for this cache entry/file.
+     * @return the system architecture name applicable fo this cached file.
+     */
+    public String getArchitecture() {
+        return architecture;
+    }
+
     /**
      * Get the path of the file stored locally in the cache.
+     * Searching the cache starts with the specified key.  If the key is not found in the cache,
+     * one additional attempt is made to find an acceptable alternative.  The second search is based on
+     * whether the user specified a platform/architecture.  If the user specified an architecture, check the cache
+     * for an entry listing without the architecture in the key (generic architecture entry).  If the user
+     * did not specify an architecture, check the cache for an entry listing using the local architecture
+     * in case the user added the cache entry with the architecture.
      * @param cacheStore the cache store to search
      * @return the Path of the file, if found
      * @throws IOException throws FileNotFoundException, if this cached file (key) could not be located in the cache
@@ -88,6 +139,25 @@ public String resolve(CacheStore cacheStore) throws IOException {
         String key = getKey();
         logger.entering(key);
         String filePath = cacheStore.getValueFromCache(key);
+        if (filePath == null) {
+            // The KEY for this CachedFile was not found in the local cache.
+            logger.fine("Unable to find cache entry for {0}", key);
+            String alternateKey;
+            if (getArchitecture() == null) {
+                // The user did not specify an architecture in the KEY and that key was not found in the cache.
+                // Try adding the local architecture to the key, and look for that entry.
+                alternateKey = getCacheKey(BuildPlatform.getPlatformName());
+                logger.fine("Trying local architecture: {0}", alternateKey);
+            } else {
+                // The user specified an architecture in the KEY, but that key was not found.
+                // Try removing the architecture from the key, and look for that entry.
+                alternateKey = getCacheKey(null);
+                logger.fine("Trying no-arch/generic architecture: {0}", alternateKey);
+            }
+            // second attempt to find a reasonable cache entry
+            filePath = cacheStore.getValueFromCache(alternateKey);
+        }
+
         if (!isFileOnDisk(filePath)) {
             throw new FileNotFoundException(Utils.getMessage("IMG-0011", key));
         }
@@ -103,7 +173,7 @@ public String resolve(CacheStore cacheStore) throws IOException {
      * @return the path of the file copied to the Docker build context directory
      */
     public Path copyFile(CacheStore cacheStore, String buildContextDir) throws IOException {
-        logger.entering();
+        logger.entering(id, version, architecture, buildContextDir);
         Path result;
         String sourceFile = resolve(cacheStore);
         logger.info("IMG-0043", sourceFile);

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2020, 2021, Oracle and/or its affiliates.
+// Copyright (c) 2020, 2024, 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.builder;
@@ -17,8 +17,6 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
-import java.util.stream.Collectors;
-import java.util.stream.Stream;
 
 import com.oracle.weblogic.imagetool.logging.LoggingFacade;
 import com.oracle.weblogic.imagetool.logging.LoggingFactory;
@@ -28,10 +26,12 @@
 public class BuildCommand {
     private static final LoggingFacade logger = LoggingFactory.getLogger(BuildCommand.class);
 
+    private final String executable;
     private final List<String> command;
     private final List<BuildArg> buildArgs;
     private List<String> additionalOptions;
     private final String context;
+    private boolean useBuildx = false;
 
     /**
      * Create a build command for creating an image.  At some point, it might
@@ -41,7 +41,8 @@ public class BuildCommand {
     public BuildCommand(String buildEngine, String contextFolder) {
         Objects.requireNonNull(contextFolder);
         buildArgs = new ArrayList<>();
-        command = Stream.of(buildEngine, "build", "--no-cache").collect(Collectors.toList());
+        executable = buildEngine;
+        command = new ArrayList<>();
         context = contextFolder;
     }
 
@@ -59,6 +60,22 @@ public BuildCommand tag(String value) {
         return this;
     }
 
+    /**
+     * Add container build platform.  Pass the desired
+     * build architecture to the build process.
+     * @param value a single platform name.
+     * @return this
+     */
+    public BuildCommand platform(String value) {
+        if (Utils.isEmptyString(value)) {
+            return this;
+        }
+        command.add("--platform");
+        command.add(value);
+        useBuildx = true;
+        return this;
+    }
+
     /**
      * Always remove intermediate containers if set to true.
      * By default, Docker leaves intermediate containers when the build fails which is not ideal for CI/CD servers.
@@ -237,7 +254,14 @@ private CloseableList<PrintWriter> createPrintWriters(List<OutputStream> outputS
     }
 
     private List<String> getCommand(boolean showPasswords) {
-        List<String> result = new ArrayList<>(command);
+        List<String> result = new ArrayList<>();
+        result.add(executable);
+        if (useBuildx) {
+            result.add("buildx");
+        }
+        result.add("build");
+        result.add("--no-cache");
+        result.addAll(command);
         if (additionalOptions != null && !additionalOptions.isEmpty()) {
             result.addAll(additionalOptions);
         }

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2019, 2021, Oracle and/or its affiliates.
+// Copyright (c) 2019, 2024, 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.cache;
@@ -22,23 +22,44 @@ public CommandResponse call() throws CacheStoreException {
         if ("NONE".equalsIgnoreCase(version)) {
             throw new IllegalArgumentException("IMG-0105");
         }
-        String key = String.format("%s%s%s", type, CacheStore.CACHE_KEY_SEPARATOR, version);
-        return addToCache(key);
+
+        return addToCache();
+    }
+
+    @Override
+    public String getKey() {
+        StringBuilder key = new StringBuilder(25)
+            .append(type)
+            .append(CacheStore.CACHE_KEY_SEPARATOR)
+            .append(version);
+
+        if (architecture != null) {
+            key.append(CacheStore.CACHE_KEY_SEPARATOR)
+                .append(architecture);
+        }
+
+        return key.toString();
     }
 
     @Option(
-            names = {"--type"},
+            names = {"-t", "--type"},
             description = "Type of installer. Valid values: ${COMPLETION-CANDIDATES}",
             required = true,
             defaultValue = "wls"
     )
     private InstallerType type;
 
     @Option(
-            names = {"--version"},
+            names = {"-v", "--version"},
             description = "Installer version. Ex: For WLS|FMW use 12.2.1.3.0 For jdk, use 8u201",
             required = true
     )
     private String version;
 
+    @Option(
+        names = {"-a", "--architecture"},
+        description = "(Optional) Installer architecture. Ex: linux/amd64 or linux/arm64."
+    )
+    private String architecture;
+
 }

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

@@ -17,12 +17,16 @@
 )
 public class AddPatchEntry extends CacheAddOperation {
 
+    public String getKey() {
+        return patchId;
+    }
+
     @Override
     public CommandResponse call() throws Exception {
         try {
             if (patchId != null && !patchId.isEmpty()) {
                 Utils.validatePatchIds(Collections.singletonList(patchId), true);
-                return addToCache(patchId);
+                return addToCache();
             } else {
                 return CommandResponse.error("IMG-0076", "--patchId");
             }

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

@@ -14,12 +14,15 @@
 
 public abstract class CacheAddOperation extends CacheOperation {
 
-    CommandResponse addToCache(String key) throws CacheStoreException {
+    public abstract String getKey();
+
+    CommandResponse addToCache() throws CacheStoreException {
         // if file is invalid or does not exist, return an error
         if (filePath == null || !Files.isRegularFile(filePath)) {
             return CommandResponse.error("IMG-0049", filePath);
         }
 
+        String key = getKey();
         // if the new value is the same as the existing cache value, do nothing
         String existingValue = cache().getValueFromCache(key);
         if (absolutePath().toString().equals(existingValue)) {
@@ -36,7 +39,7 @@ CommandResponse addToCache(String key) throws CacheStoreException {
         return CommandResponse.success("IMG-0050", key, cache().getValueFromCache(key));
     }
 
-    Path absolutePath() {
+    private Path absolutePath() {
         if (absolutePath == null) {
             absolutePath = filePath.toAbsolutePath();
         }
@@ -53,8 +56,8 @@ Path absolutePath() {
 
 
     @Option(
-        names = {"--path"},
-        description = "Location on disk. For ex: /path/to/patch-or-installer.zip",
+        names = {"-p", "--path"},
+        description = "Location of the file on disk. For ex: /path/to/patch-or-installer.zip",
         required = true
     )
     private Path filePath;

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2021, 2022, Oracle and/or its affiliates.
+// Copyright (c) 2021, 2024, 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;
@@ -34,14 +34,14 @@ void prepareNewImage() throws IOException, InterruptedException, XPathExpression
         copyOptionsFromImage();
 
         if (dockerfileOptions.installJava()) {
-            CachedFile jdk = new CachedFile(InstallerType.JDK, jdkVersion);
+            CachedFile jdk = new CachedFile(InstallerType.JDK, jdkVersion, getBuildPlatform());
             Path installerPath = jdk.copyFile(cache(), buildDir());
             dockerfileOptions.setJavaInstaller(installerPath.getFileName().toString());
         }
 
         if (dockerfileOptions.installMiddleware()) {
             MiddlewareInstall install =
-                new MiddlewareInstall(getInstallerType(), installerVersion, installerResponseFiles);
+                new MiddlewareInstall(getInstallerType(), installerVersion, installerResponseFiles, getBuildPlatform());
             install.copyFiles(cache(), buildDir());
             dockerfileOptions.setMiddlewareInstall(install);
         } else {