Merge branch 'buildargs-option' into 'main'

Added buildArgs option to CLI so that users can pass ARGs into their custom build commands

See merge request weblogic-cloud/weblogic-image-tool!450

Author: ddsharpe

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

@@ -15,6 +15,7 @@
 import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
 import java.util.Objects;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
@@ -98,6 +99,21 @@ public BuildCommand buildArg(String key, String value, boolean conceal) {
         return this;
     }
 
+    /**
+     * Add multiple --build-arg key value pairs to the Docker build command.
+     * @param keyValuePairs A map of key-value pairs to be used directly with the container image builder
+     */
+    public BuildCommand buildArg(Map<String,String> keyValuePairs) {
+        if (keyValuePairs == null || keyValuePairs.isEmpty()) {
+            return this;
+        }
+
+        for (Map.Entry<String,String> entry : keyValuePairs.entrySet()) {
+            buildArg(entry.getKey(), entry.getValue());
+        }
+        return this;
+    }
+
     /**
      * Add a --network to the Docker build command.
      * @param value the Docker network to use

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

@@ -11,6 +11,7 @@
 import java.time.Duration;
 import java.time.Instant;
 import java.util.List;
+import java.util.Map;
 import java.util.Properties;
 import java.util.UUID;
 import java.util.regex.Matcher;
@@ -123,6 +124,7 @@ BuildCommand getInitialBuildCmd(String contextFolder) {
             .tag(imageTag)
             .network(buildNetwork)
             .pull(buildPull)
+            .buildArg(buildArgs)
             .buildArg("http_proxy", httpProxyUrl, httpProxyUrl != null && httpProxyUrl.contains("@"))
             .buildArg("https_proxy", httpsProxyUrl, httpsProxyUrl != null && httpsProxyUrl.contains("@"))
             .buildArg("no_proxy", nonProxyHosts);
@@ -175,6 +177,12 @@ void initializeOptions() throws InvalidCredentialException, IOException, Invalid
         handleChown();
         handleAdditionalBuildCommands();
 
+        if (buildArgs != null) {
+            for (String arg : buildArgs.keySet()) {
+                dockerfileOptions.buildArgs(arg);
+            }
+        }
+
         if (kubernetesTarget == KubernetesTarget.OPENSHIFT) {
             dockerfileOptions.setDomainGroupAsUser(true);
             // if the user did not set the OS user:group, make the default oracle:root, instead of oracle:oracle
@@ -408,6 +416,12 @@ public String buildId() {
     )
     KubernetesTarget kubernetesTarget = KubernetesTarget.DEFAULT;
 
+    @Option(
+        names = {"--buildArgs"},
+        description = "Additional argument passed directly to the build engine."
+    )
+    Map<String,String> buildArgs;
+
     @SuppressWarnings("unused")
     @Unmatched
     List<String> unmatchedOptions;

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

@@ -66,6 +66,7 @@ public class DockerfileOptions {
     private MiddlewareInstall mwInstallers;
     private boolean domainGroupAsUser;
     private boolean usingBusybox;
+    private List<String> buildArgs;
 
     // WDT values
     private String wdtHome;
@@ -97,6 +98,7 @@ public DockerfileOptions(String buildId) {
         skipMiddlewareInstall = false;
         domainGroupAsUser = false;
         usingBusybox = false;
+        buildArgs = new ArrayList<>();
 
         javaHome = DEFAULT_JAVA_HOME;
         oracleHome = DEFAULT_ORACLE_HOME;
@@ -1119,4 +1121,23 @@ public DockerfileOptions usingBusybox(boolean value) {
         usingBusybox = value;
         return this;
     }
+
+    /**
+     * Used by mustache template to retrieve variable names for ARG in Dockerfile.
+     * @return list of variable names
+     */
+    @SuppressWarnings("unused")
+    public List<String> buildArgs() {
+        return buildArgs;
+    }
+
+    /**
+     * Add ARG statements to the Dockerfile.
+     * @param variableName an ARG name.
+     * @return this
+     */
+    public DockerfileOptions buildArgs(String variableName) {
+        buildArgs.add(variableName);
+        return this;
+    }
 }

imagetool/src/main/resources/docker-files/Create_Image.mustache

@@ -3,6 +3,8 @@
 #
 
 FROM {{baseImage}} as os_update
+{{#buildArgs}}ARG {{{.}}}
+{{/buildArgs}}
 LABEL com.oracle.weblogic.imagetool.buildid="{{buildId}}"
 USER root
 {{#initialBuildCommands}}
@@ -29,7 +31,8 @@ USER root
 {{/isWdtEnabled}}
 
 FROM os_update as final_build
-
+{{#buildArgs}}ARG {{{.}}}
+{{/buildArgs}}
 ENV ORACLE_HOME={{{oracle_home}}} \
     LD_LIBRARY_PATH={{{oracle_home}}}/oracle_common/adr:$LD_LIBRARY_PATH \
 {{#installJava}}

imagetool/src/main/resources/docker-files/Rebase_Image.mustache

@@ -5,6 +5,8 @@
 {{#isRebaseToTarget}}
 FROM {{sourceImage}} as source_image
 FROM {{targetImage}} as final_build
+{{#buildArgs}}ARG {{{.}}}
+{{/buildArgs}}
 
 ENV DOMAIN_HOME={{{domain_home}}}
 LABEL com.oracle.weblogic.imagetool.buildid="{{buildId}}"
@@ -38,7 +40,8 @@ LABEL com.oracle.weblogic.imagetool.buildid="{{buildId}}"
     {{/installMiddleware}}
 
     FROM os_update as final_build
-
+    {{#buildArgs}}ARG {{{.}}}
+    {{/buildArgs}}
     ENV ORACLE_HOME={{{oracle_home}}} \
         LD_LIBRARY_PATH={{{oracle_home}}}/oracle_common/adr:$LD_LIBRARY_PATH \
     {{#installJava}}

imagetool/src/main/resources/docker-files/Update_Image.mustache

@@ -7,6 +7,8 @@
 {{/isWdtEnabled}}
 
 FROM {{baseImage}} as final_build
+{{#buildArgs}}ARG {{{.}}}
+{{/buildArgs}}
 USER root
 
 ENV OPATCH_NO_FUSER=true

imagetool/src/main/resources/docker-files/aux-image.mustache

@@ -6,6 +6,8 @@
 # Create Auxiliary Image for WebLogic Kubernetes Operator
 
 FROM {{baseImage}} as os_update
+{{#buildArgs}}ARG {{{.}}}
+{{/buildArgs}}
 LABEL com.oracle.weblogic.imagetool.buildid="{{buildId}}"
 
 USER root

imagetool/src/main/resources/docker-files/install-java.mustache

@@ -4,6 +4,8 @@
 # Installing Java
 
 FROM os_update as jdk_build
+{{#buildArgs}}ARG {{{.}}}
+{{/buildArgs}}
 LABEL com.oracle.weblogic.imagetool.buildid="{{buildId}}"
 
 ENV JAVA_HOME={{{java_home}}}

imagetool/src/main/resources/docker-files/install-middleware.mustache

@@ -4,6 +4,8 @@
 # Installing Middleware
 
 FROM os_update as wls_build
+{{#buildArgs}}ARG {{{.}}}
+{{/buildArgs}}
 LABEL com.oracle.weblogic.imagetool.buildid="{{buildId}}"
 
 ENV JAVA_HOME={{{java_home}}} \

imagetool/src/main/resources/docker-files/run-wdt.mustache

@@ -4,6 +4,8 @@
 # Create WLS domain (or model)
 
 FROM {{{wdtBase}}} as wdt_build
+{{#buildArgs}}ARG {{{.}}}
+{{/buildArgs}}
 LABEL com.oracle.weblogic.imagetool.buildid="{{buildId}}"
 
 ENV WLSDEPLOY_PROPERTIES="{{{wlsdeploy_properties}}} -Djava.security.egd=file:/dev/./urandom" \