Fix eclipse-jkube#624: Unable to override Image Name in Simple Docker…

…file Mode with `jkube.generator.name`

Modify Mojos logic to consider image name configured from properties

CHANGELOG.md

@@ -37,6 +37,7 @@ Usage:
 * Fix #450: Quarkus port is inferred from application.properties/yaml (considers profile too)
 * Fix #471: Remove the declaration of thrown runtime exceptions across javadoc
 * Fix #620: Added k8s support for NetworkPolicy
+* Fix #624: Unable to override Image Name in Simple Dockerfile Mode with `jkube.generator.name` 
 
 ### 1.1.1 (2021-02-23)
 * Fix #570: Disable namespace creation during k8s:resource with `jkube.namespace` flag

jkube-kit/build/api/src/test/java/org/eclipse/jkube/kit/build/api/helper/DockerFileUtilTest.java

@@ -35,6 +35,7 @@
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
 
 /**
  * @author roland

jkube-kit/common/src/main/java/org/eclipse/jkube/kit/common/util/PropertiesUtil.java

@@ -13,6 +13,8 @@
  */
 package org.eclipse.jkube.kit.common.util;
 
+import io.fabric8.kubernetes.client.utils.Utils;
+
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.URL;
@@ -39,4 +41,23 @@ public static Properties getPropertiesFromResource(URL resource) {
     }
     return ret;
   }
+
+  /**
+   * Return first Non Null set property from a set of provided properties
+   *
+   * @param properties {@link Properties} in a given project
+   * @param keys an array of property key values to find
+   * @return a string which is first non null value found for the provided list
+   */
+  public static String getValueFromProperties(Properties properties, String... keys) {
+    for (String property : keys) {
+      if (properties.containsKey(property)) {
+        String value = properties.get(property).toString();
+        if (Utils.isNotNullOrEmpty(value)) {
+          return value;
+        }
+      }
+    }
+    return null;
+  }
 }

jkube-kit/common/src/test/java/org/eclipse/jkube/kit/common/util/PropertiesUtilTest.java

@@ -20,8 +20,7 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.entry;
 import static org.eclipse.jkube.kit.common.util.PropertiesUtil.getPropertiesFromResource;
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNotNull;
+import static org.eclipse.jkube.kit.common.util.PropertiesUtil.getValueFromProperties;
 
 public class PropertiesUtilTest {
 
@@ -47,4 +46,31 @@ public void testNonExistentPropertiesParsing() {
     // Then
     assertThat(result).isEmpty();
   }
+
+  @Test
+  public void testGetValueFromProperties() {
+    // Given
+    Properties properties = new Properties();
+    String[] keys = new String[] {"property1", "property2"};
+
+    // When
+    String imageName = getValueFromProperties(properties, keys);
+
+    // Then
+    assertThat(imageName).isNull();
+  }
+
+  @Test
+  public void testGetValueFromPropertiesReturnsValidValue() {
+    // Given
+    Properties properties = new Properties();
+    properties.put("property1", "value1");
+    String[] keys = new String[] {"property1", "property2"};
+
+    // When
+    String imageName = getValueFromProperties(properties, keys);
+
+    // Then
+    assertThat(imageName).isNotNull().isEqualTo("value1");
+  }
 }

kubernetes-maven-plugin/plugin/src/main/java/org/eclipse/jkube/maven/plugin/mojo/build/AbstractDockerMojo.java

@@ -31,7 +31,6 @@
 
 import org.eclipse.jkube.generator.api.GeneratorContext;
 import org.eclipse.jkube.kit.build.core.GavLabel;
-import org.eclipse.jkube.kit.build.api.helper.DockerFileUtil;
 import org.eclipse.jkube.kit.config.image.build.JKubeBuildStrategy;
 import org.eclipse.jkube.kit.config.image.build.JKubeConfiguration;
 import org.eclipse.jkube.kit.build.service.docker.DockerAccessFactory;
@@ -94,7 +93,12 @@
 import org.fusesource.jansi.Ansi;
 import org.sonatype.plexus.components.sec.dispatcher.SecDispatcher;
 
+import static org.eclipse.jkube.kit.build.api.helper.DockerFileUtil.addSimpleDockerfileConfig;
+import static org.eclipse.jkube.kit.build.api.helper.DockerFileUtil.createSimpleDockerfileConfig;
+import static org.eclipse.jkube.kit.build.api.helper.DockerFileUtil.getTopLevelDockerfile;
+import static org.eclipse.jkube.kit.build.api.helper.DockerFileUtil.isSimpleDockerFileMode;
 import static org.eclipse.jkube.kit.build.service.docker.DockerAccessFactory.DockerAccessContext.DEFAULT_MAX_CONNECTIONS;
+import static org.eclipse.jkube.kit.common.util.PropertiesUtil.getValueFromProperties;
 import static org.eclipse.jkube.maven.plugin.mojo.build.AbstractJKubeMojo.DEFAULT_LOG_PREFIX;
 
 public abstract class AbstractDockerMojo extends AbstractMojo
@@ -789,6 +793,7 @@ protected void executeBuildPlugins() {
 
     // Resolve and customize image configuration
     protected String initImageConfiguration(Date buildTimeStamp) throws DependencyResolutionRequiredException {
+        ImageNameFormatter imageNameFormatter = new ImageNameFormatter(MavenUtil.convertMavenProjectToJKubeProject(project, session), buildTimeStamp);
         // Resolve images
         resolvedImages = ConfigHelper.resolveImages(
                 log,
@@ -805,17 +810,19 @@ protected String initImageConfiguration(Date buildTimeStamp) throws DependencyRe
                 this);                     // customizer (can be overwritten by a subclass)
 
         // Check for simple Dockerfile mode
-        if (DockerFileUtil.isSimpleDockerFileMode(project.getBasedir())) {
-            File topDockerfile = DockerFileUtil.getTopLevelDockerfile(project.getBasedir());
+        if (isSimpleDockerFileMode(project.getBasedir())) {
+            File topDockerfile = getTopLevelDockerfile(project.getBasedir());
+            String defaultImageName = imageNameFormatter.format(getValueFromProperties(project.getProperties(),
+                    new String[] {"jkube.image.name", "jkube.generator.name"}));
             if (resolvedImages.isEmpty()) {
-                resolvedImages.add(DockerFileUtil.createSimpleDockerfileConfig(topDockerfile, MavenUtil.getPropertiesWithSystemOverrides(project).getProperty("jkube.image.name")));
+                resolvedImages.add(createSimpleDockerfileConfig(topDockerfile, defaultImageName));
             } else if (resolvedImages.size() == 1 && resolvedImages.get(0).getBuildConfiguration() == null) {
-                resolvedImages.set(0, DockerFileUtil.addSimpleDockerfileConfig(resolvedImages.get(0), topDockerfile));
+                resolvedImages.set(0, addSimpleDockerfileConfig(resolvedImages.get(0), topDockerfile));
             }
         }
 
         // Initialize configuration and detect minimal API version
-        return ConfigHelper.initAndValidate(resolvedImages, apiVersion, new ImageNameFormatter(MavenUtil.convertMavenProjectToJKubeProject(project, session), buildTimeStamp));
+        return ConfigHelper.initAndValidate(resolvedImages, apiVersion, imageNameFormatter);
     }
 
     /**

kubernetes-maven-plugin/plugin/src/main/java/org/eclipse/jkube/maven/plugin/mojo/build/ResourceMojo.java

@@ -25,7 +25,6 @@
 import javax.validation.ConstraintViolationException;
 
 import org.eclipse.jkube.generator.api.GeneratorContext;
-import org.eclipse.jkube.kit.build.api.helper.DockerFileUtil;
 import org.eclipse.jkube.kit.build.service.docker.config.handler.ImageConfigResolver;
 import org.eclipse.jkube.kit.build.service.docker.helper.ConfigHelper;
 import org.eclipse.jkube.kit.build.service.docker.helper.ImageNameFormatter;
@@ -67,7 +66,12 @@
 import org.apache.maven.shared.filtering.MavenFileFilter;
 import org.apache.maven.shared.filtering.MavenFilteringException;
 
+import static org.eclipse.jkube.kit.build.api.helper.DockerFileUtil.addSimpleDockerfileConfig;
+import static org.eclipse.jkube.kit.build.api.helper.DockerFileUtil.createSimpleDockerfileConfig;
+import static org.eclipse.jkube.kit.build.api.helper.DockerFileUtil.getTopLevelDockerfile;
+import static org.eclipse.jkube.kit.build.api.helper.DockerFileUtil.isSimpleDockerFileMode;
 import static org.eclipse.jkube.kit.common.ResourceFileType.yaml;
+import static org.eclipse.jkube.kit.common.util.PropertiesUtil.getValueFromProperties;
 import static org.eclipse.jkube.kit.common.util.ResourceMojoUtil.DEFAULT_RESOURCE_LOCATION;
 import static org.eclipse.jkube.kit.common.util.ResourceMojoUtil.useDekorate;
 import static org.eclipse.jkube.maven.plugin.mojo.build.BuildMojo.CONTEXT_KEY_BUILD_TIMESTAMP;
@@ -381,18 +385,21 @@ private List<ImageConfiguration> getResolvedImages(List<ImageConfiguration> imag
             });
 
         Date now = getBuildReferenceDate();
+        ImageNameFormatter imageNameFormatter = new ImageNameFormatter(MavenUtil.convertMavenProjectToJKubeProject(project, session), now);
         storeReferenceDateInPluginContext(now);
         // Check for simple Dockerfile mode
-        if (DockerFileUtil.isSimpleDockerFileMode(project.getBasedir())) {
-            File topDockerfile = DockerFileUtil.getTopLevelDockerfile(project.getBasedir());
+        if (isSimpleDockerFileMode(project.getBasedir())) {
+            File topDockerfile = getTopLevelDockerfile(project.getBasedir());
+            String defaultImageName = imageNameFormatter.format(getValueFromProperties(project.getProperties(),
+                    new String[] {"jkube.image.name", "jkube.generator.name"}));
             if (ret.isEmpty()) {
-                ret.add(DockerFileUtil.createSimpleDockerfileConfig(topDockerfile, MavenUtil.getPropertiesWithSystemOverrides(project).getProperty("jkube.image.name")));
+                ret.add(createSimpleDockerfileConfig(topDockerfile, defaultImageName));
             } else if (ret.size() == 1 && ret.get(0).getBuildConfiguration() == null) {
-                ret.set(0, DockerFileUtil.addSimpleDockerfileConfig(resolvedImages.get(0), topDockerfile));
+                ret.set(0, addSimpleDockerfileConfig(resolvedImages.get(0), topDockerfile));
             }
         }
         String minimalApiVersion = ConfigHelper.initAndValidate(ret, null /* no minimal api version */,
-            new ImageNameFormatter(MavenUtil.convertMavenProjectToJKubeProject(project, session), now));
+          imageNameFormatter);
         return ret;
     }