chore : Add a debug log statement for application config file locatio…

…n while inferring ports Add a debug log statement in generators of these frameworks while resolving default web ports: - Spring Boot - Thorntail - Helidon - Quarkus - Micronaut Signed-off-by: Rohan Kumar <rohaan@redhat.com>
eclipse-jkube · Aug 20, 2024 · bfa28f5 · bfa28f5
1 parent 0860e8a
commit bfa28f5
Show file tree

Hide file tree

Showing 25 changed files with 175 additions and 165 deletions.
diff --git a/jkube-kit/common/src/main/java/org/eclipse/jkube/kit/common/JavaProject.java b/jkube-kit/common/src/main/java/org/eclipse/jkube/kit/common/JavaProject.java
@@ -21,7 +21,6 @@
 
 import java.io.File;
 import java.io.Serializable;
-import java.net.URL;
 import java.time.LocalDate;
 import java.util.List;
 import java.util.Locale;
@@ -38,14 +37,7 @@
 public class JavaProject implements Serializable {
 
   private static final long serialVersionUID = 6438404976521622633L;
-
-  /**
-   * Properties file for the project
-   *
-   * @param propertiesFile for the project.
-   * @return Properties file for the project.
-   */
-  private URL propertiesFile;
+
   /**
    * Project's name.
    *

diff --git a/jkube-kit/common/src/main/java/org/eclipse/jkube/kit/common/PropertiesExtender.java b/jkube-kit/common/src/main/java/org/eclipse/jkube/kit/common/PropertiesExtender.java
diff --git a/jkube-kit/common/src/main/java/org/eclipse/jkube/kit/common/util/PropertiesUtil.java b/jkube-kit/common/src/main/java/org/eclipse/jkube/kit/common/util/PropertiesUtil.java
@@ -14,17 +14,26 @@
 package org.eclipse.jkube.kit.common.util;
 
 import io.fabric8.kubernetes.client.utils.Utils;
+import org.eclipse.jkube.kit.common.JavaProject;
+import org.eclipse.jkube.kit.common.KitLogger;
 
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.URL;
+import java.net.URLClassLoader;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 import java.util.Optional;
 import java.util.Properties;
+import java.util.function.Supplier;
+
+import static org.eclipse.jkube.kit.common.util.JKubeProjectUtil.getClassLoader;
+import static org.eclipse.jkube.kit.common.util.YamlUtil.getPropertiesFromYamlResource;
 
 public class PropertiesUtil {
 
@@ -92,4 +101,40 @@ public static Map<String, String> toMap(Properties properties) {
     }
     return map;
   }
+
+  public static List<Supplier<Properties>> getPropertySuppliersList(JavaProject javaProject, List<String> propertySources) {
+    final URLClassLoader urlClassLoader = getClassLoader(javaProject);
+    List<Supplier<Properties>> sources = new ArrayList<>();
+    for (String source : propertySources) {
+      if (source.endsWith(".properties")) {
+        sources.add(() -> getPropertiesFromResource(urlClassLoader.findResource(source)));
+      } else {
+        sources.add(() -> getPropertiesFromYamlResource(urlClassLoader.findResource(source)));
+      }
+    }
+
+    return sources;
+  }
+
+  public static Properties createPropertiesFromApplicationConfig(JavaProject project, List<String> appConfigSources) {
+    final List<Supplier<Properties>> sources = getPropertySuppliersList(project, appConfigSources);
+    for (Supplier<Properties> source : sources) {
+      final Properties props = source.get();
+      if (!props.isEmpty()) {
+        props.putAll(toMap(project.getProperties()));
+        return props;
+      }
+    }
+    return project.getProperties();
+  }
+
+  public static void logApplicationConfigurationFileSource(KitLogger logger, JavaProject javaProject, List<String> appConfigSources) {
+    final URLClassLoader urlClassLoader = getClassLoader(javaProject);
+    appConfigSources.forEach(s -> {
+      URL ymlResource = urlClassLoader.findResource(s);
+      if (ymlResource != null) {
+        logger.debug("The following properties file is used for application configuration: %s", ymlResource);
+      }
+    });
+  }
 }
diff --git a/...e-kit/common/src/main/java/org/eclipse/jkube/kit/common/util/SpringBootConfiguration.java b/...e-kit/common/src/main/java/org/eclipse/jkube/kit/common/util/SpringBootConfiguration.java
@@ -16,7 +16,6 @@
 import lombok.Builder;
 import lombok.Getter;
 import org.eclipse.jkube.kit.common.JavaProject;
-import org.eclipse.jkube.kit.common.PropertiesExtender;
 
 import java.util.Optional;
 import java.util.Properties;
@@ -39,11 +38,9 @@ public class SpringBootConfiguration {
   private boolean managementHealthProbesEnabled;
 
   public static SpringBootConfiguration from(JavaProject project) {
-    final PropertiesExtender properties = SpringBootUtil.getSpringBootApplicationProperties(
+    final Properties properties = SpringBootUtil.getSpringBootApplicationProperties(
       SpringBootUtil.getSpringBootActiveProfile(project),
       JKubeProjectUtil.getClassLoader(project));
-     project.setPropertiesFile(properties.getPropertiesFile());
-
     final int majorVersion = SpringBootUtil.getSpringBootVersion(project)
       .map(semVer -> {
         try {

diff --git a/jkube-kit/common/src/main/java/org/eclipse/jkube/kit/common/util/SpringBootUtil.java b/jkube-kit/common/src/main/java/org/eclipse/jkube/kit/common/util/SpringBootUtil.java
@@ -16,14 +16,15 @@
 import java.io.File;
 import java.net.URL;
 import java.net.URLClassLoader;
+import java.util.Arrays;
 import java.util.Collections;
+import java.util.List;
 import java.util.Map;
 import java.util.Optional;
 import java.util.Properties;
 
 import org.eclipse.jkube.kit.common.JavaProject;
 import org.eclipse.jkube.kit.common.Plugin;
-import org.eclipse.jkube.kit.common.PropertiesExtender;
 
 import static org.eclipse.jkube.kit.common.util.PropertiesUtil.getPropertiesFromResource;
 
@@ -43,6 +44,7 @@ public class SpringBootUtil {
     private static final String PLACEHOLDER_PREFIX = "${";
     private static final String PLACEHOLDER_SUFFIX = "}";
     private static final String VALUE_SEPARATOR = ":";
+    public static final List<String> SPRING_BOOT_APP_CONFIG_FILES_LIST = Arrays.asList("application.properties", "application.yml");
 
     private SpringBootUtil() {}
 
@@ -65,22 +67,14 @@ public static Properties getSpringBootApplicationProperties(URLClassLoader compi
      * @param compileClassLoader compile class loader
      * @return properties object
      */
-    public static PropertiesExtender getSpringBootApplicationProperties(String springActiveProfile, URLClassLoader compileClassLoader) {
+    public static Properties getSpringBootApplicationProperties(String springActiveProfile, URLClassLoader compileClassLoader) {
         URL ymlResource = compileClassLoader.findResource("application.yml");
         URL propertiesResource = compileClassLoader.findResource("application.properties");
-        
+
         Properties props = YamlUtil.getPropertiesFromYamlResource(springActiveProfile, ymlResource);
         props.putAll(getPropertiesFromResource(propertiesResource));
-        props = new SpringBootPropertyPlaceholderHelper(PLACEHOLDER_PREFIX, PLACEHOLDER_SUFFIX, VALUE_SEPARATOR, true)
-            .replaceAllPlaceholders(props);
-
-        // Extend Properties object with resources file path
-        PropertiesExtender propsExtender = new PropertiesExtender();
-        URL propertiesFile = ymlResource != null ? ymlResource : propertiesResource;
-        propsExtender.setPropertiesFile(propertiesFile);
-        propsExtender.putAll(props);
-
-        return propsExtender;
+        return new SpringBootPropertyPlaceholderHelper(PLACEHOLDER_PREFIX, PLACEHOLDER_SUFFIX, VALUE_SEPARATOR, true)
+        .replaceAllPlaceholders(props);
     }
 
     /**

diff --git a/jkube-kit/common/src/main/java/org/eclipse/jkube/kit/common/util/ThorntailUtil.java b/jkube-kit/common/src/main/java/org/eclipse/jkube/kit/common/util/ThorntailUtil.java
@@ -13,11 +13,16 @@
  */
 package org.eclipse.jkube.kit.common.util;
 
-import java.net.URL;
-import java.net.URLClassLoader;
+import org.eclipse.jkube.kit.common.JavaProject;
+
+import java.util.Collections;
+import java.util.List;
 import java.util.Properties;
 
+import static org.eclipse.jkube.kit.common.util.PropertiesUtil.createPropertiesFromApplicationConfig;
+
 public class ThorntailUtil {
+    public static final List<String> THORNTAIL_APP_CONFIG_FILES_LIST = Collections.singletonList("project-defaults.yml");
 
     private ThorntailUtil() {}
 
@@ -28,8 +33,7 @@ private ThorntailUtil() {}
      * @param compileClassLoader URLClassLoader for resource access
      * @return thorntail configuration properties
      */
-    public static Properties getThorntailProperties(URLClassLoader compileClassLoader) {
-        URL ymlResource = compileClassLoader.findResource("project-defaults.yml");
-        return YamlUtil.getPropertiesFromYamlResource(ymlResource);
+    public static Properties getThorntailProperties(JavaProject javaProject) {
+        return createPropertiesFromApplicationConfig(javaProject, THORNTAIL_APP_CONFIG_FILES_LIST);
     }
 }
diff --git a/...t/common/src/test/java/org/eclipse/jkube/kit/common/util/SpringBootConfigurationTest.java b/...t/common/src/test/java/org/eclipse/jkube/kit/common/util/SpringBootConfigurationTest.java
@@ -60,7 +60,6 @@ void setUp(@TempDir Path target) throws IOException {
     project = JavaProject.builder()
       .properties(properties)
       .outputDirectory(target.toFile())
-      .baseDirectory(target.toFile())
       .build();
   }
 

diff --git a/jkube-kit/common/src/test/java/org/eclipse/jkube/kit/common/util/SpringBootUtilTest.java b/jkube-kit/common/src/test/java/org/eclipse/jkube/kit/common/util/SpringBootUtilTest.java
@@ -99,7 +99,6 @@ void getSpringBootApplicationProperties_withCompileClassloader_shouldLoadPropert
         JavaProject javaProject = JavaProject.builder()
             .compileClassPathElement(Objects.requireNonNull(getClass().getResource("/util/springboot/resources")).getPath())
             .outputDirectory(new File("target"))
-            .baseDirectory(new File("target"))
             .build();
         URLClassLoader compileClassLoader = JKubeProjectUtil.getClassLoader(javaProject);
 

diff --git a/.../generator/api/src/main/java/org/eclipse/jkube/generator/api/DefaultGeneratorManager.java b/.../generator/api/src/main/java/org/eclipse/jkube/generator/api/DefaultGeneratorManager.java
@@ -16,7 +16,6 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.HashSet;
-import java.net.URL;
 import java.util.List;
 import java.util.Properties;
 import java.util.Set;
@@ -103,12 +102,6 @@ private List<ImageConfiguration> generateImages(List<ImageConfiguration> imageCo
       if (generator.isApplicable(ret)) {
         log.info("Running generator %s", generator.getName());
         ret = generator.customize(ret, genCtx.isPrePackagePhase());
-        URL propFileURL = genCtx.getProject().getPropertiesFile();
-        if (propFileURL != null) {
-          log.info("The following properties file is used %s", propFileURL);
-        } else {
-          log.info("No properties file found");
-        }
       }
     }
     return ret;

diff --git a/jkube-kit/jkube-kit-helidon/src/main/java/org/eclipse/jkube/helidon/HelidonUtils.java b/jkube-kit/jkube-kit-helidon/src/main/java/org/eclipse/jkube/helidon/HelidonUtils.java
@@ -16,19 +16,15 @@
 import org.eclipse.jkube.kit.common.JavaProject;
 import org.eclipse.jkube.kit.common.util.JKubeProjectUtil;
 
-import java.net.URLClassLoader;
 import java.util.Arrays;
 import java.util.List;
 import java.util.Properties;
-import java.util.function.Supplier;
 
-import static org.eclipse.jkube.kit.common.util.JKubeProjectUtil.getClassLoader;
-import static org.eclipse.jkube.kit.common.util.PropertiesUtil.getPropertiesFromResource;
-import static org.eclipse.jkube.kit.common.util.PropertiesUtil.toMap;
-import static org.eclipse.jkube.kit.common.util.YamlUtil.getPropertiesFromYamlResource;
+import static org.eclipse.jkube.kit.common.util.PropertiesUtil.createPropertiesFromApplicationConfig;
 
 public class HelidonUtils {
   private static final String HELIDON_HTTP_PORT = "server.port";
+  public static final List<String> HELIDON_APP_CONFIG_FILES_LIST = Arrays.asList("META-INF/microprofile-config.properties", "application.yaml", "application.yml");
 
   private HelidonUtils() { }
 
@@ -46,20 +42,7 @@ public static boolean hasHelidonHealthDependency(JavaProject javaProject) {
   }
 
   public static Properties getHelidonConfiguration(JavaProject javaProject) {
-    final URLClassLoader urlClassLoader = getClassLoader(javaProject);
-    final List<Supplier<Properties>> sources = Arrays.asList(
-        () -> getPropertiesFromResource(urlClassLoader.findResource("META-INF/microprofile-config.properties")),
-        () -> getPropertiesFromYamlResource(urlClassLoader.findResource("application.yaml")),
-        () -> getPropertiesFromYamlResource(urlClassLoader.findResource("application.yml"))
-    );
-    for (Supplier<Properties> source : sources) {
-      final Properties props = source.get();
-      if (!props.isEmpty()) {
-        props.putAll(toMap(javaProject.getProperties()));
-        return props;
-      }
-    }
-    return javaProject.getProperties();
+    return createPropertiesFromApplicationConfig(javaProject, HELIDON_APP_CONFIG_FILES_LIST);
   }
 
   public static String extractPort(Properties properties, String defaultValue) {

diff --git a/...-helidon/src/main/java/org/eclipse/jkube/helidon/enricher/HelidonHealthCheckEnricher.java b/...-helidon/src/main/java/org/eclipse/jkube/helidon/enricher/HelidonHealthCheckEnricher.java
@@ -16,10 +16,12 @@
 import org.eclipse.jkube.kit.enricher.api.JKubeEnricherContext;
 import org.eclipse.jkube.microprofile.enricher.AbstractMicroprofileHealthCheckEnricher;
 
+import static org.eclipse.jkube.helidon.HelidonUtils.HELIDON_APP_CONFIG_FILES_LIST;
 import static org.eclipse.jkube.helidon.HelidonUtils.extractPort;
 import static org.eclipse.jkube.helidon.HelidonUtils.getHelidonConfiguration;
 import static org.eclipse.jkube.helidon.HelidonUtils.hasHelidonHealthDependency;
 import static org.eclipse.jkube.kit.common.Configs.asInteger;
+import static org.eclipse.jkube.kit.common.util.PropertiesUtil.logApplicationConfigurationFileSource;
 
 public class HelidonHealthCheckEnricher extends AbstractMicroprofileHealthCheckEnricher {
   private static final String DEFAULT_HELIDON_PORT = "8080";
@@ -34,6 +36,7 @@ protected boolean shouldAddProbe() {
 
   @Override
   protected int getPort() {
+    logApplicationConfigurationFileSource(log, getContext().getProject(), HELIDON_APP_CONFIG_FILES_LIST);
     return asInteger(extractPort(getHelidonConfiguration(getContext().getProject()), DEFAULT_HELIDON_PORT));
   }
 }
diff --git a/...jkube-kit-helidon/src/main/java/org/eclipse/jkube/helidon/generator/HelidonGenerator.java b/...jkube-kit-helidon/src/main/java/org/eclipse/jkube/helidon/generator/HelidonGenerator.java
@@ -17,14 +17,17 @@
 import org.eclipse.jkube.generator.javaexec.JavaExecGenerator;
 import org.eclipse.jkube.kit.common.Arguments;
 import org.eclipse.jkube.kit.common.AssemblyConfiguration;
+import org.eclipse.jkube.kit.common.util.JKubeProjectUtil;
 import org.eclipse.jkube.kit.config.image.ImageConfiguration;
 
 import java.util.List;
 import java.util.Optional;
 
+import static org.eclipse.jkube.helidon.HelidonUtils.HELIDON_APP_CONFIG_FILES_LIST;
 import static org.eclipse.jkube.helidon.HelidonUtils.extractPort;
 import static org.eclipse.jkube.helidon.HelidonUtils.getHelidonConfiguration;
 import static org.eclipse.jkube.helidon.HelidonUtils.hasHelidonDependencies;
+import static org.eclipse.jkube.kit.common.util.PropertiesUtil.logApplicationConfigurationFileSource;
 
 public class HelidonGenerator extends JavaExecGenerator {
   public static final String HELIDON = "helidon";
@@ -62,6 +65,7 @@ protected Arguments getBuildEntryPoint() {
 
   @Override
   protected String getDefaultWebPort() {
+    logApplicationConfigurationFileSource(log, getProject(), HELIDON_APP_CONFIG_FILES_LIST);
     return extractPort(getHelidonConfiguration(getProject()), super.getDefaultWebPort());
   }
 

diff --git a/jkube-kit/jkube-kit-micronaut/src/main/java/org/eclipse/jkube/micronaut/MicronautUtils.java b/jkube-kit/jkube-kit-micronaut/src/main/java/org/eclipse/jkube/micronaut/MicronautUtils.java
@@ -16,14 +16,14 @@
 import org.eclipse.jkube.kit.common.JavaProject;
 import org.eclipse.jkube.kit.common.util.JKubeProjectUtil;
 
-import java.net.URLClassLoader;
+import java.util.Arrays;
+import java.util.List;
 import java.util.Properties;
-import java.util.function.Supplier;
 
-import static org.eclipse.jkube.kit.common.util.PropertiesUtil.getPropertiesFromResource;
-import static org.eclipse.jkube.kit.common.util.YamlUtil.getPropertiesFromYamlResource;
+import static org.eclipse.jkube.kit.common.util.PropertiesUtil.createPropertiesFromApplicationConfig;
 
 public class MicronautUtils {
+  public static final List<String> MICRONAUT_APP_CONFIG_FILES_LIST = Arrays.asList("application.properties", "application.yml", "application.json");
 
   private MicronautUtils() {}
 
@@ -35,20 +35,8 @@ public static boolean isHealthEnabled(Properties properties) {
     return properties.getProperty("endpoints.health.enabled", "false").equalsIgnoreCase("true");
   }
 
-  @SuppressWarnings("unchecked")
-  public static Properties getMicronautConfiguration(URLClassLoader urlClassLoader) {
-    final Supplier<Properties>[] sources = new Supplier[]{
-        () -> getPropertiesFromResource(urlClassLoader.findResource("application.properties")),
-        () -> getPropertiesFromYamlResource(urlClassLoader.findResource("application.yml")),
-        () -> getPropertiesFromYamlResource(urlClassLoader.findResource("application.json"))
-    };
-    for (Supplier<Properties> source : sources) {
-      final Properties props = source.get();
-      if (!props.isEmpty()) {
-        return props;
-      }
-    }
-    return new Properties();
+  public static Properties getMicronautConfiguration(JavaProject javaProject) {
+    return createPropertiesFromApplicationConfig(javaProject, MICRONAUT_APP_CONFIG_FILES_LIST);
   }
 
   public static boolean hasMicronautPlugin(JavaProject javaProject) {