refactor (jkube-kit) : Move Dockerfile opinionated ImageConfig logic from ConfigHelper.initImageConfiguration to a dedicated generator

gradle-plugin/kubernetes/pom.xml

@@ -72,6 +72,12 @@
             <artifactId>jkube-kit-generator-java-exec</artifactId>
             <version>${jkube.kit.version}</version>
         </dependency>
+
+        <dependency>
+            <groupId>org.eclipse.jkube</groupId>
+            <artifactId>jkube-kit-generator-dockerfile-simple</artifactId>
+        </dependency>
+
         <dependency>
             <groupId>org.eclipse.jkube</groupId>
             <artifactId>jkube-kit-generator-karaf</artifactId>

gradle-plugin/kubernetes/src/main/resources/META-INF/jkube/profiles-default.yml

@@ -86,6 +86,7 @@
   generator:
     # The order given in "includes" is the order in which generators are called
     includes:
+      - dockerfile-simple
       - quarkus
       - spring-boot
       - thorntail-v2
@@ -118,6 +119,7 @@
   generator:
     # The order given in "includes" is the order in which generators are called
     includes:
+      - dockerfile-simple
       - spring-boot
       - thorntail-v2
       - wildfly-jar

gradle-plugin/kubernetes/src/test/java/org/eclipse/jkube/gradle/plugin/task/KubernetesBuildTaskTest.java

@@ -13,13 +13,25 @@
  */
 package org.eclipse.jkube.gradle.plugin.task;
 
+import java.io.File;
 import java.io.IOException;
+import java.nio.file.Files;
+import java.util.ArrayList;
 import java.util.Collections;
+import java.util.List;
+import java.util.Properties;
 
+import org.assertj.core.api.Assertions;
+import org.assertj.core.api.InstanceOfAssertFactories;
+import org.eclipse.jkube.generator.api.DefaultGeneratorManager;
+import org.eclipse.jkube.generator.api.GeneratorContext;
 import org.eclipse.jkube.gradle.plugin.KubernetesExtension;
 import org.eclipse.jkube.gradle.plugin.TestKubernetesExtension;
 import org.eclipse.jkube.kit.build.service.docker.DockerAccessFactory;
 import org.eclipse.jkube.kit.build.service.docker.access.DockerAccess;
+import org.eclipse.jkube.kit.common.JavaProject;
+import org.eclipse.jkube.kit.common.KitLogger;
+import org.eclipse.jkube.kit.common.Plugin;
 import org.eclipse.jkube.kit.config.image.ImageConfiguration;
 import org.eclipse.jkube.kit.config.image.build.BuildConfiguration;
 import org.eclipse.jkube.kit.config.service.JKubeServiceException;
@@ -29,8 +41,10 @@
 import org.gradle.api.provider.Property;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
+import org.junit.jupiter.api.io.TempDir;
 import org.mockito.MockedConstruction;
 
 import static org.assertj.core.api.Assertions.assertThatIllegalStateException;
@@ -137,4 +151,41 @@ public Property<Boolean> getSkipBuild() {
     assertThat(dockerBuildServiceMockedConstruction.constructed()).isEmpty();
     verify(buildTask.jKubeServiceHub.getBuildService(), times(0)).build(any());
   }
+
+  @Test
+  @DisplayName("when Dockerfile present in project base directory, then generate opinionated ImageConfiguration for Dockerfile")
+  void simpleDockerfileModeWorksAsExpected(@TempDir File temporaryFolder) throws IOException {
+    // Given
+    File dockerFileInProjectBaseDir = temporaryFolder.toPath().resolve("Dockerfile").toFile();
+    Files.createFile(dockerFileInProjectBaseDir.toPath());
+    extension = new TestKubernetesExtension() {
+      @Override
+      public Property<File> getResourceSourceDirectory() {
+        return super.getResourceSourceDirectory().value(new File(temporaryFolder, "src/main/jkube"));
+      }
+    };
+    extension.javaProject = JavaProject.builder()
+        .baseDirectory(temporaryFolder)
+        .outputDirectory(temporaryFolder.toPath().resolve("target").toFile())
+        .buildDirectory(temporaryFolder.toPath().resolve("target").toFile())
+        .plugin(Plugin.builder().groupId("org.springframework.boot").artifactId("org.springframework.boot.gradle.plugin").build())
+        .properties(new Properties()).build();
+    when(taskEnvironment.project.getExtensions().getByType(KubernetesExtension.class)).thenReturn(extension);
+    final KubernetesBuildTask buildTask = new KubernetesBuildTask(KubernetesExtension.class);
+    buildTask.kitLogger = new KitLogger.SilentLogger();
+    GeneratorContext generatorContext = buildTask.initGeneratorContextBuilder().build();
+    List<ImageConfiguration> imageConfigurations = new ArrayList<>();
+    DefaultGeneratorManager generatorManager = new DefaultGeneratorManager(generatorContext);
+
+    // When
+    List<ImageConfiguration> imageConfigurationList = generatorManager.generate(imageConfigurations);
+
+    // Then
+    Assertions.assertThat(imageConfigurationList)
+        .hasSize(1)
+        .singleElement(InstanceOfAssertFactories.type(ImageConfiguration.class))
+        .extracting(ImageConfiguration::getBuild)
+        .extracting(BuildConfiguration::getDockerFileRaw)
+        .isEqualTo(dockerFileInProjectBaseDir.getAbsolutePath());
+  }
 }

gradle-plugin/openshift/src/main/resources/META-INF/jkube/profiles-default.yml

@@ -87,6 +87,7 @@
   generator:
     # The order given in "includes" is the order in which generators are called
     includes:
+    - dockerfile-simple
     - quarkus
     - spring-boot
     - thorntail-v2
@@ -119,6 +120,7 @@
   generator:
     # The order given in "includes" is the order in which generators are called
     includes:
+    - dockerfile-simple
     - spring-boot
     - thorntail-v2
     - wildfly-jar

jkube-kit/build/api/src/main/java/org/eclipse/jkube/kit/build/api/helper/ConfigHelper.java

@@ -23,7 +23,6 @@
 import org.eclipse.jkube.kit.common.KitLogger;
 import org.eclipse.jkube.kit.common.util.JKubeProjectUtil;
 
-import java.io.File;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Date;
@@ -33,12 +32,6 @@
 import java.util.Set;
 import java.util.stream.Collectors;
 
-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.util.PropertiesUtil.getValueFromProperties;
-
 /**
  * Utility class which helps in resolving, customizing, initializing and validating
  * image configuration.
@@ -174,16 +167,6 @@ public static List<ImageConfiguration> initImageConfiguration(Date buildTimeStam
                 filter,                   // A filter which image to process
                 generatorManager);        // GeneratorManager which will invoke generator
 
-        // Check for simple Dockerfile mode
-        ImageConfiguration dockerFileImageConfig = createImageConfigurationForSimpleDockerfile(resolvedImages, jKubeConfiguration, imageNameFormatter);
-        if (dockerFileImageConfig != null) {
-            if (resolvedImages.isEmpty()) {
-                resolvedImages.add(dockerFileImageConfig);
-            } else {
-                resolvedImages.set(0, dockerFileImageConfig);
-            }
-        }
-
         // Init and validate Image configurations. After this step, getResolvedImages() contains the valid configuration.
         for (ImageConfiguration imageConfiguration : resolvedImages) {
             imageConfiguration.setName(imageNameFormatter.format(imageConfiguration.getName()));
@@ -196,20 +179,6 @@ public static List<ImageConfiguration> initImageConfiguration(Date buildTimeStam
         return resolvedImages;
     }
 
-    private static ImageConfiguration createImageConfigurationForSimpleDockerfile(List<ImageConfiguration> resolvedImages, JKubeConfiguration jKubeConfiguration, ImageNameFormatter imageNameFormatter) {
-        if (isSimpleDockerFileMode(jKubeConfiguration.getBasedir())) {
-            File topDockerfile = getTopLevelDockerfile(jKubeConfiguration.getBasedir());
-            String defaultImageName = imageNameFormatter.format(getValueFromProperties(jKubeConfiguration.getProject().getProperties(),
-                "jkube.image.name", "jkube.generator.name"));
-            if (resolvedImages.isEmpty()) {
-                return createSimpleDockerfileConfig(topDockerfile, defaultImageName);
-            } else if (resolvedImages.size() == 1 && resolvedImages.get(0).getBuildConfiguration() == null) {
-                return addSimpleDockerfileConfig(resolvedImages.get(0), topDockerfile);
-            }
-        }
-        return null;
-    }
-
     // =========================================================================
 
     private static void printDockerfileInfoIfDockerfileMode(ImageConfiguration imageConfiguration, KitLogger log, JKubeConfiguration jKubeConfiguration) {

jkube-kit/build/api/src/main/java/org/eclipse/jkube/kit/build/api/helper/DockerFileUtil.java

@@ -18,14 +18,12 @@
 import java.io.FileReader;
 import java.io.IOException;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Map;
-import java.util.Objects;
 import java.util.Properties;
 import java.util.Set;
 import java.util.regex.Matcher;
@@ -34,7 +32,6 @@
 import com.fasterxml.jackson.core.type.TypeReference;
 import org.eclipse.jkube.kit.common.JKubeFileInterpolator;
 import org.eclipse.jkube.kit.common.util.Serialization;
-import org.eclipse.jkube.kit.config.image.ImageConfiguration;
 import org.eclipse.jkube.kit.config.image.build.BuildConfiguration;
 
 import org.apache.commons.lang3.StringUtils;
@@ -192,42 +189,6 @@ public static Map<String, Object> readDockerConfig() {
         }
     }
 
-    public static boolean isSimpleDockerFileMode(File projectBaseDirectory) {
-        if (projectBaseDirectory != null) {
-            return getTopLevelDockerfile(projectBaseDirectory).exists();
-        }
-        return false;
-    }
-
-    public static File getTopLevelDockerfile(File projectBaseDirectory) {
-        return new File(projectBaseDirectory, "Dockerfile");
-    }
-
-    public static ImageConfiguration createSimpleDockerfileConfig(File dockerFile, String defaultImageName) {
-        if (defaultImageName == null) {
-            // Default name group/artifact:version (or 'latest' if SNAPSHOT)
-            defaultImageName = "%g/%a:%l";
-        }
-
-        final BuildConfiguration buildConfig = BuildConfiguration.builder()
-                .dockerFile(dockerFile.getPath())
-                .ports(extractPorts(dockerFile))
-                .build();
-
-        return ImageConfiguration.builder()
-                .name(defaultImageName)
-                .build(buildConfig)
-                .build();
-    }
-
-    public static ImageConfiguration addSimpleDockerfileConfig(ImageConfiguration image, File dockerfile) {
-        final BuildConfiguration buildConfig = BuildConfiguration.builder()
-                .dockerFile(dockerfile.getPath())
-                .ports(extractPorts(dockerfile))
-                .build();
-        return image.toBuilder().build(buildConfig).build();
-    }
-
     private static void updateMapWithArgValue(Map<String, String> result, Map<String, String> args, String argString) {
         if (argString.contains("=") || argString.contains(":")) {
             String[] argStringParts = argString.split("[=:]");
@@ -269,25 +230,6 @@ private static void validateArgValue(String argStringParam) {
         }
     }
 
-    static List<String> extractPorts(File dockerFile) {
-        Properties properties = new Properties();
-        try {
-            return extractPorts(extractLines(dockerFile, "EXPOSE", properties, null));
-        } catch (IOException ioException) {
-            throw new IllegalArgumentException("Error in reading Dockerfile", ioException);
-        }
-    }
-
-    static List<String> extractPorts(List<String[]> dockerLinesContainingExpose) {
-        Set<String> ports = new HashSet<>();
-        dockerLinesContainingExpose.forEach(line -> Arrays.stream(line)
-                .skip(1)
-                .filter(Objects::nonNull)
-                .filter(StringUtils::isNotBlank)
-                .forEach(ports::add));
-        return new ArrayList<>(ports);
-    }
-
     static String resolveDockerfileFilter(String filter) {
         return filter != null ? filter : BuildConfiguration.DEFAULT_FILTER;
     }