fix : RegistryService should also consider buildArgs while resolving …

…base images

Signed-off-by: Rohan Kumar <rohaan@redhat.com>

doc/changelog.md

@@ -2,6 +2,7 @@
 * **0.45-SNAPSHOT**:
   - Automatically create parent directories of portPropertyFile path
   - Added support for `platform` attribute of a container in the docker-compose configuration.
+  - `docker:push` failed with build `ARG` in `FROM` ([1778](https://github.com/fabric8io/docker-maven-plugin/issues/1778))
 
 * **0.44.0** (2024-02-17):
   - Add new option "useDefaultExclusion" for build configuration to handle exclusion of hidden files ([1708](https://github.com/fabric8io/docker-maven-plugin/issues/1708))

it/dockerfile-push-build-arg-from/pom.xml

@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+
+  <modelVersion>4.0.0</modelVersion>
+
+  <parent>
+    <groupId>io.fabric8.dmp.itests</groupId>
+    <artifactId>dmp-it-parent</artifactId>
+    <version>0.45-SNAPSHOT</version>
+    <relativePath>../pom.xml</relativePath>
+  </parent>
+
+  <artifactId>dockerfile-push-build-arg-from</artifactId>
+  <version>0.45-SNAPSHOT</version>
+  <name>dmp-it-dockerfile-build-arg-from</name>
+
+  <properties>
+    <docker.buildArg.baseImage>busybox</docker.buildArg.baseImage>
+  </properties>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>io.fabric8</groupId>
+        <artifactId>docker-maven-plugin</artifactId>
+        <configuration>
+          <images>
+            <image>
+              <name>ttl.sh/%a:5m</name>
+              <alias>dockerfile</alias>
+              <build>
+                <contextDir>${project.basedir}/src/main/docker</contextDir>
+              </build>
+            </image>
+          </images>
+        </configuration>
+        <executions>
+          <execution>
+            <id>build</id>
+            <goals>
+              <goal>build</goal>
+            </goals>
+            <phase>install</phase>
+          </execution>
+          <execution>
+            <id>push</id>
+            <goals>
+              <goal>push</goal>
+            </goals>
+            <phase>install</phase>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
+</project>

it/dockerfile-push-build-arg-from/src/main/docker/Dockerfile

@@ -0,0 +1,2 @@
+ARG baseImage
+FROM ${baseImage}

it/pom.xml

@@ -32,6 +32,7 @@
     <module>dockerfile</module>
     <module>dockerfile-base-as-arg</module>
     <module>dockerfile-base-as-arg-buildconfig</module>
+    <module>dockerfile-push-build-arg-from</module>
     <module>dockerignore</module>
     <module>graceful-container-removal</module>
     <module>healthcheck</module>

pom.xml

@@ -82,6 +82,7 @@
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <surefire.version>3.0.0-M2</surefire.version>
     <system-stubs.version>2.0.1</system-stubs.version>
+    <version.assertj-core>3.25.3</version.assertj-core>
   </properties>
 
   <dependencies>
@@ -212,6 +213,13 @@
       </exclusions>
     </dependency>
 
+    <dependency>
+      <groupId>org.assertj</groupId>
+      <artifactId>assertj-core</artifactId>
+      <version>${version.assertj-core}</version>
+      <scope>test</scope>
+    </dependency>
+
     <dependency>
       <groupId>org.bouncycastle</groupId>
       <artifactId>bcpkix-jdk15on</artifactId>

src/main/java/io/fabric8/maven/docker/AbstractDockerMojo.java

@@ -25,6 +25,7 @@
 import io.fabric8.maven.docker.log.LogDispatcher;
 import io.fabric8.maven.docker.log.LogOutputSpecFactory;
 import io.fabric8.maven.docker.model.Container;
+import io.fabric8.maven.docker.service.BuildService;
 import io.fabric8.maven.docker.service.DockerAccessFactory;
 import io.fabric8.maven.docker.service.ImagePullManager;
 import io.fabric8.maven.docker.service.QueryService;
@@ -242,6 +243,12 @@ public abstract class AbstractDockerMojo extends AbstractMojo implements Context
 
     @Parameter
     protected Map<String, String> buildArgs;
+    // ==============================================================================================================
+    // Parameters required from Maven when building an assembly. They cannot be injected directly
+    // into DockerAssemblyCreator.
+    // See also here: http://maven.40175.n5.nabble.com/Mojo-Java-1-5-Component-MavenProject-returns-null-vs-JavaDoc-parameter-expression-quot-project-quot-s-td5733805.html
+    @Parameter(property = "docker.pull.registry")
+    String pullRegistry;
 
     // Images resolved with external image resolvers and hooks for subclass to
     // mangle the image configurations.
@@ -315,6 +322,14 @@ public void execute() throws MojoExecutionException, MojoFailureException {
         }
     }
 
+    protected BuildService.BuildContext getBuildContext() {
+        return new BuildService.BuildContext.Builder()
+          .buildArgs(buildArgs)
+          .mojoParameters(createMojoParameters())
+          .registryConfig(getRegistryConfig(pullRegistry))
+          .build();
+    }
+
     private void logException(Exception exp) {
         if (exp.getCause() != null) {
             log.error("%s [%s]", exp.getMessage(), exp.getCause().getMessage());

src/main/java/io/fabric8/maven/docker/BuildMojo.java

@@ -7,6 +7,7 @@
 import io.fabric8.maven.docker.service.ImagePullManager;
 import io.fabric8.maven.docker.service.JibBuildService;
 import io.fabric8.maven.docker.service.ServiceHub;
+import io.fabric8.maven.docker.service.helper.BuildArgResolver;
 import io.fabric8.maven.docker.util.EnvUtil;
 import io.fabric8.maven.docker.util.Logger;
 import org.apache.maven.plugin.MojoExecutionException;
@@ -24,6 +25,7 @@
 import java.net.URL;
 import java.util.Date;
 import java.util.Enumeration;
+import java.util.Map;
 
 import static io.fabric8.maven.docker.service.RegistryService.createCompleteAuthConfigList;
 
@@ -34,7 +36,7 @@
  * @since 28.07.14
  */
 @Mojo(name = "build", defaultPhase = LifecyclePhase.INSTALL, requiresDependencyResolution = ResolutionScope.TEST)
-public class BuildMojo extends AbstractBuildSupportMojo {
+public class BuildMojo extends AbstractDockerMojo {
 
     public static final String DMP_PLUGIN_DESCRIPTOR = "META-INF/maven/io.fabric8/dmp-plugin";
     public static final String DOCKER_EXTRA_DIR = "docker-extra";
@@ -101,7 +103,9 @@ private void proceedWithDockerBuild(ServiceHub hub, BuildService.BuildContext bu
         File buildArchiveFile = buildService.buildArchive(imageConfig, buildContext, resolveBuildArchiveParameter());
         if (Boolean.FALSE.equals(shallBuildArchiveOnly())) {
             if (imageConfig.isBuildX()) {
-                hub.getBuildXService().build(createProjectPaths(), imageConfig, null, createCompleteAuthConfigList(false, imageConfig, getRegistryConfig(pullRegistry), createMojoParameters()), buildArchiveFile);
+                BuildArgResolver buildArgResolver = new BuildArgResolver(log);
+                Map<String, String> buildArgsFromExternalSources = buildArgResolver.resolveBuildArgs(buildContext);
+                hub.getBuildXService().build(createProjectPaths(), imageConfig, null, createCompleteAuthConfigList(false, imageConfig, getRegistryConfig(pullRegistry), createMojoParameters(), buildArgsFromExternalSources), buildArchiveFile);
             } else {
                 buildService.buildImage(imageConfig, pullManager, buildContext, buildArchiveFile);
                 if (!skipTag && !imageConfig.getBuildConfiguration().skipTag()) {

src/main/java/io/fabric8/maven/docker/PushMojo.java

@@ -51,7 +51,7 @@ public void executeInternal(ServiceHub hub) throws DockerAccessException, MojoEx
     }
 
     private void executeDockerPush(ServiceHub hub) throws MojoExecutionException, DockerAccessException {
-        hub.getRegistryService().pushImages(createProjectPaths(), getResolvedImages(), retries, getRegistryConfig(pushRegistry), skipTag, createMojoParameters());
+        hub.getRegistryService().pushImages(createProjectPaths(), getResolvedImages(), retries, getRegistryConfig(pushRegistry), skipTag, getBuildContext());
     }
 
     private void executeJibPush(ServiceHub hub) throws MojoExecutionException {

src/main/java/io/fabric8/maven/docker/SourceMojo.java

@@ -45,7 +45,7 @@
  * @since 25/10/15
  */
 @Mojo(name = "source", defaultPhase = LifecyclePhase.PACKAGE)
-public class SourceMojo extends AbstractBuildSupportMojo {
+public class SourceMojo extends AbstractDockerMojo {
 
     @Component
     private MavenProjectHelper projectHelper;

src/main/java/io/fabric8/maven/docker/WatchMojo.java

@@ -41,7 +41,7 @@
  * @since 16/06/15
  */
 @Mojo(name = "watch")
-public class WatchMojo extends AbstractBuildSupportMojo {
+public class WatchMojo extends AbstractDockerMojo {
 
     /**
      * Watching mode for rebuilding images