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>

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.
    *

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

@@ -15,6 +15,7 @@
 
 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;
@@ -24,6 +25,7 @@
 import java.nio.file.Path;
 import java.util.Collections;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 import java.util.Optional;
 import java.util.Properties;
@@ -115,4 +117,14 @@ public static Properties fromApplicationConfig(JavaProject javaProject, String[]
     }
     return javaProject.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.info("Loading application configuration from : %s", ymlResource);
+      }
+    });
+  }
 }

jkube-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 {

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;
 
@@ -39,6 +40,7 @@ public class SpringBootUtil {
     public static final String SPRING_BOOT_GRADLE_PLUGIN_ARTIFACT_ID = "org.springframework.boot.gradle.plugin";
     public static final String DEV_TOOLS_REMOTE_SECRET = "spring.devtools.remote.secret";
     public static final String DEV_TOOLS_REMOTE_SECRET_ENV = "SPRING_DEVTOOLS_REMOTE_SECRET";
+    private static final String[] SPRING_BOOT_APP_CONFIG_FILES_LIST = new String[] {"application.properties", "application.yml"};
 
     private static final String PLACEHOLDER_PREFIX = "${";
     private static final String PLACEHOLDER_SUFFIX = "}";
@@ -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);
     }
 
     /**
@@ -158,5 +152,9 @@ public static File findNativeArtifactFile(JavaProject project) {
         }
         return null;
     }
+
+    public static List<String> getSpringBootAppConfigFiles() {
+        return Arrays.asList(SPRING_BOOT_APP_CONFIG_FILES_LIST);
+    }
 }
 

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

@@ -15,6 +15,8 @@
 
 import org.eclipse.jkube.kit.common.JavaProject;
 
+import java.util.Arrays;
+import java.util.List;
 import java.util.Properties;
 
 import static org.eclipse.jkube.kit.common.util.PropertiesUtil.fromApplicationConfig;
@@ -34,4 +36,8 @@ private ThorntailUtil() {}
     public static Properties getThorntailProperties(JavaProject javaProject) {
         return fromApplicationConfig(javaProject, THORNTAIL_APP_CONFIG_FILES_LIST);
     }
+
+    public static List<String> getThorntailAppConfigFiles() {
+        return Arrays.asList(THORNTAIL_APP_CONFIG_FILES_LIST);
+    }
 }

jkube-kit/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();
   }
 

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);
 

jkube-kit/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;

jkube-kit/jkube-kit-helidon/src/main/java/org/eclipse/jkube/helidon/HelidonUtils.java

@@ -16,6 +16,8 @@
 import org.eclipse.jkube.kit.common.JavaProject;
 import org.eclipse.jkube.kit.common.util.JKubeProjectUtil;
 
+import java.util.Arrays;
+import java.util.List;
 import java.util.Properties;
 
 import static org.eclipse.jkube.kit.common.util.PropertiesUtil.fromApplicationConfig;
@@ -46,4 +48,8 @@ public static Properties getHelidonConfiguration(JavaProject javaProject) {
   public static String extractPort(Properties properties, String defaultValue) {
     return properties.getProperty(HELIDON_HTTP_PORT, defaultValue);
   }
+
+  public static List<String> getHelidonAppConfigFiles() {
+    return Arrays.asList(HELIDON_APP_CONFIG_FILES_LIST);
+  }
 }

jkube-kit/jkube-kit-helidon/src/main/java/org/eclipse/jkube/helidon/enricher/HelidonHealthCheckEnricher.java

@@ -17,9 +17,11 @@
 import org.eclipse.jkube.microprofile.enricher.AbstractMicroprofileHealthCheckEnricher;
 
 import static org.eclipse.jkube.helidon.HelidonUtils.extractPort;
+import static org.eclipse.jkube.helidon.HelidonUtils.getHelidonAppConfigFiles;
 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(), getHelidonAppConfigFiles());
     return asInteger(extractPort(getHelidonConfiguration(getContext().getProject()), DEFAULT_HELIDON_PORT));
   }
 }

jkube-kit/jkube-kit-helidon/src/main/java/org/eclipse/jkube/helidon/generator/HelidonGenerator.java

@@ -23,8 +23,10 @@
 import java.util.Optional;
 
 import static org.eclipse.jkube.helidon.HelidonUtils.extractPort;
+import static org.eclipse.jkube.helidon.HelidonUtils.getHelidonAppConfigFiles;
 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 +64,7 @@ protected Arguments getBuildEntryPoint() {
 
   @Override
   protected String getDefaultWebPort() {
+    logApplicationConfigurationFileSource(log, getContext().getProject(), getHelidonAppConfigFiles());
     return extractPort(getHelidonConfiguration(getProject()), super.getDefaultWebPort());
   }
 

jkube-kit/jkube-kit-micronaut/src/main/java/org/eclipse/jkube/micronaut/MicronautUtils.java

@@ -16,6 +16,8 @@
 import org.eclipse.jkube.kit.common.JavaProject;
 import org.eclipse.jkube.kit.common.util.JKubeProjectUtil;
 
+import java.util.Arrays;
+import java.util.List;
 import java.util.Properties;
 
 import static org.eclipse.jkube.kit.common.util.PropertiesUtil.fromApplicationConfig;
@@ -53,4 +55,8 @@ public static boolean hasNativeImagePackaging(JavaProject javaProject) {
     }
     return false;
   }
+
+  public static List<String> getMicronautAppConfigFiles() {
+    return Arrays.asList(MICRONAUT_APP_CONFIG_FILES_LIST);
+  }
 }

jkube-kit/jkube-kit-micronaut/src/main/java/org/eclipse/jkube/micronaut/generator/MicronautGenerator.java

@@ -23,7 +23,9 @@
 import org.eclipse.jkube.kit.common.AssemblyConfiguration;
 import org.eclipse.jkube.kit.config.image.ImageConfiguration;
 
+import static org.eclipse.jkube.kit.common.util.PropertiesUtil.logApplicationConfigurationFileSource;
 import static org.eclipse.jkube.micronaut.MicronautUtils.extractPort;
+import static org.eclipse.jkube.micronaut.MicronautUtils.getMicronautAppConfigFiles;
 import static org.eclipse.jkube.micronaut.MicronautUtils.getMicronautConfiguration;
 import static org.eclipse.jkube.micronaut.MicronautUtils.hasMicronautPlugin;
 
@@ -79,6 +81,7 @@ protected AssemblyConfiguration createAssembly() {
 
     @Override
     protected String getDefaultWebPort() {
+        logApplicationConfigurationFileSource(log, getContext().getProject(), getMicronautAppConfigFiles());
         return extractPort(
             getMicronautConfiguration(getProject()), super.getDefaultWebPort()
         );

jkube-kit/jkube-kit-quarkus/src/main/java/org/eclipse/jkube/quarkus/QuarkusUtils.java

@@ -14,6 +14,8 @@
 package org.eclipse.jkube.quarkus;
 
 import java.io.File;
+import java.util.Arrays;
+import java.util.List;
 import java.util.Optional;
 import java.util.Properties;
 import java.util.stream.Collectors;
@@ -198,6 +200,10 @@ public static boolean isStartupEndpointSupported(JavaProject javaProject) {
     return isVersionAtLeast(QUARKUS_MAJOR_VERSION_SINCE_STARTUP_CHANGE, QUARKUS_MINOR_VERSION_SINCE_STARTUP_CHANGE, findQuarkusVersion(javaProject));
   }
 
+  public static List<String> getQuarkusAppConfigFiles() {
+    return Arrays.asList(QUARKUS_APP_CONFIG_FILES_LIST);
+  }
+
   private static String resolveQuarkusNonApplicationRootPath(String quarkusVersion, Properties quarkusProperties) {
     final String defaultValue = isVersionAtLeast(QUARKUS2_MAJOR_VERSION, QUARKUS2_MINOR_VERSION, quarkusVersion) ?
         DEFAULT_NON_APPLICATION_ROOT_AFTER_2_0 : DEFAULT_NON_APPLICATION_ROOT_BEFORE_2_0;

jkube-kit/jkube-kit-quarkus/src/main/java/org/eclipse/jkube/quarkus/enricher/QuarkusHealthCheckEnricher.java

@@ -28,8 +28,10 @@
 import org.apache.commons.lang3.StringUtils;
 
 import static org.eclipse.jkube.kit.common.Configs.asInteger;
+import static org.eclipse.jkube.kit.common.util.PropertiesUtil.logApplicationConfigurationFileSource;
 import static org.eclipse.jkube.quarkus.QuarkusUtils.QUARKUS_GROUP_ID;
 import static org.eclipse.jkube.quarkus.QuarkusUtils.concatPath;
+import static org.eclipse.jkube.quarkus.QuarkusUtils.getQuarkusAppConfigFiles;
 import static org.eclipse.jkube.quarkus.QuarkusUtils.isStartupEndpointSupported;
 import static org.eclipse.jkube.quarkus.QuarkusUtils.resolveCompleteQuarkusHealthRootPath;
 import static org.eclipse.jkube.quarkus.QuarkusUtils.extractPort;
@@ -87,6 +89,7 @@ private Probe discoverQuarkusHealthCheck(int initialDelay, Function<JavaProject,
         if (!getContext().hasDependency(QUARKUS_GROUP_ID, "quarkus-smallrye-health")) {
             return null;
         }
+        logApplicationConfigurationFileSource(log, getContext().getProject(), getQuarkusAppConfigFiles());
         return new ProbeBuilder()
             .withNewHttpGet()
               .withNewPort(asInteger(extractPort(getContext().getProject(), getQuarkusConfiguration(getContext().getProject()), getConfig(Config.PORT))))

jkube-kit/jkube-kit-quarkus/src/main/java/org/eclipse/jkube/quarkus/generator/QuarkusGenerator.java

@@ -30,7 +30,9 @@
 import lombok.Getter;
 import org.apache.commons.lang3.StringUtils;
 
+import static org.eclipse.jkube.kit.common.util.PropertiesUtil.logApplicationConfigurationFileSource;
 import static org.eclipse.jkube.quarkus.QuarkusUtils.extractPort;
+import static org.eclipse.jkube.quarkus.QuarkusUtils.getQuarkusAppConfigFiles;
 import static org.eclipse.jkube.quarkus.QuarkusUtils.getQuarkusConfiguration;
 import static org.eclipse.jkube.quarkus.QuarkusUtils.hasQuarkusPlugin;
 
@@ -68,6 +70,7 @@ public boolean isApplicable(List<ImageConfiguration> configs) {
 
   @Override
   protected String getDefaultWebPort() {
+    logApplicationConfigurationFileSource(log, getContext().getProject(), getQuarkusAppConfigFiles());
     return extractPort(getProject(), getQuarkusConfiguration(getProject()), super.getDefaultWebPort());
   }
 

jkube-kit/jkube-kit-spring-boot/src/main/java/org/eclipse/jkube/springboot/generator/SpringBootGenerator.java

@@ -32,7 +32,9 @@
 import lombok.Getter;
 import org.apache.commons.lang3.StringUtils;
 
+import static org.eclipse.jkube.kit.common.util.PropertiesUtil.logApplicationConfigurationFileSource;
 import static org.eclipse.jkube.kit.common.util.SpringBootUtil.DEV_TOOLS_REMOTE_SECRET;
+import static org.eclipse.jkube.kit.common.util.SpringBootUtil.getSpringBootAppConfigFiles;
 import static org.eclipse.jkube.kit.common.util.SpringBootUtil.isSpringBootRepackage;
 import static org.eclipse.jkube.springboot.SpringBootDevtoolsUtils.addDevToolsFilesToFatJar;
 import static org.eclipse.jkube.springboot.SpringBootDevtoolsUtils.ensureSpringDevToolSecretToken;
@@ -108,6 +110,7 @@ protected boolean isFatJar() {
 
     @Override
     protected String getDefaultWebPort() {
+        logApplicationConfigurationFileSource(log, getProject(), getSpringBootAppConfigFiles());
         return "" + SpringBootConfiguration.from(getProject()).getServerPort();
     }