Merge pull request #1946 from venmanyarun/compile_jsp_toolchain_support

configuring toolchain for compile-jsp

Author: venmanyarun

liberty-maven-plugin/pom.xml

@@ -38,7 +38,7 @@
         <dependency>
             <groupId>io.openliberty.tools</groupId>
             <artifactId>liberty-ant-tasks</artifactId>
-            <version>1.9.17</version>
+            <version>1.9.18-SNAPSHOT</version>
         </dependency>
         <dependency>
             <groupId>org.apache.maven</groupId>

liberty-maven-plugin/src/it/compile-jsp-source-17-it/pom.xml

@@ -66,6 +66,9 @@
         <version>@pom.version@</version>
         <extensions>true</extensions>
         <configuration>
+          <jdkToolchain>
+              <version>11</version>
+          </jdkToolchain>
           <stripVersion>true</stripVersion>
           <serverName>test</serverName>
           <serverXmlFile>src/test/resources/server.xml</serverXmlFile>

liberty-maven-plugin/src/it/compile-jsp-source-17-it/src/test/java/net/wasdev/wlp/maven/test/app/CompileJSPTest.java

@@ -1,8 +1,10 @@
 package net.wasdev.wlp.maven.test.app;
 
+
 import java.awt.List;
 import java.util.ArrayList;
 import java.io.File;
+import java.io.FileNotFoundException;
 import java.io.FileInputStream;
 
 import javax.xml.parsers.DocumentBuilder;
@@ -11,8 +13,9 @@
 import javax.xml.xpath.XPathConstants;
 import javax.xml.xpath.XPathFactory;
 
-import org.junit.Assert;
+import java.util.Scanner;
 import org.junit.Test;
+import org.junit.Assert;
 import org.w3c.dom.Document;
 import org.w3c.dom.NodeList;
 import org.w3c.dom.Node;
@@ -28,6 +31,8 @@
 public class CompileJSPTest {
 
     public final String COMPILE_JSP_SEVER_XML = "compileJsp/servers/defaultServer/server.xml";
+    public final String LOG_LOCATION = "liberty/wlp/usr/servers/test/logs/messages.log";
+    static final String TOOLCHAIN_CONFIGURED_FOR_GOAL = "CWWKM4101I: The %s goal is using the configured toolchain JDK located at";
 
     @Test
     public void testServerXMLPropFileExist() throws Exception {
@@ -79,4 +84,36 @@ public void testXmlElements() throws Exception {
             }
         }
     }
+
+    @Test
+    public void testToolchainLogs() throws Exception {
+        File buildLog = new File("../build.log");
+        Assert.assertTrue(buildLog.exists());
+
+        Assert.assertTrue("Did not find toolchain honored message for create goal in build.log", logContainsMessage(buildLog, String.format(TOOLCHAIN_CONFIGURED_FOR_GOAL, "create")));
+        Assert.assertTrue("Did not find toolchain honored message for start goal in build.log", logContainsMessage(buildLog, String.format(TOOLCHAIN_CONFIGURED_FOR_GOAL, "start")));
+        Assert.assertTrue("Did not find toolchain honored message for compile-jsp goal in build.log", logContainsMessage(buildLog, String.format(TOOLCHAIN_CONFIGURED_FOR_GOAL, "compile-jsp")));
+
+        File f = new File(LOG_LOCATION);
+        Assert.assertTrue(f.getCanonicalFile() + " doesn't exist", f.exists());
+        // should contain java.version = 11 since <jdkToolChain> is defined as Java 11
+        Assert.assertTrue("Did not find toolchain version in messages.log", logContainsMessage(f, "java.version = 11"));
+
+    }
+
+
+    private boolean logContainsMessage( File logFile, String message) throws FileNotFoundException {
+        Assert.assertTrue("Log file not found at location: "+ LOG_LOCATION, logFile.exists());
+        boolean found = false;
+
+        try (Scanner scanner = new Scanner(logFile);) {
+            while (scanner.hasNextLine()) {
+                if(scanner.nextLine().contains(message)) {
+                    found = true;
+                }
+            }
+        }
+
+        return found;
+    }
 }

liberty-maven-plugin/src/main/java/io/openliberty/tools/maven/ServerFeatureSupport.java

@@ -22,8 +22,12 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
 import java.text.MessageFormat;
 import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
 import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Map;
@@ -440,4 +444,91 @@ protected String getJdkHomeFromToolchain(Toolchain toolchain) {
         }
         return null;
     }
+
+    /**
+     * @return environment variable map with Toolchain JDK
+     */
+    protected Map<String, String> getToolchainEnvVar() {
+
+        if (toolchain == null) {
+            return Collections.emptyMap();
+        }
+        String jdkHome = getJdkHomeFromToolchain(toolchain);
+        if (jdkHome == null) {
+            getLog().warn("Could not determine JDK home from toolchain. Toolchain will not be honored");
+            return Collections.emptyMap();
+        }
+
+        // 1. Read existing config files
+        List<String> serverEnvLines = readConfigFileLines(getServerEnvFile());
+        List<String> jvmOptionsLines = readConfigFileLines(new File(serverDirectory, "jvm.options"));
+
+        // 2. Check for existing JAVA_HOME configuration
+        // if user has configured JAVA_HOME in server.env or jvm.options, this will get higher precedence over toolchain JDK
+        // hence a warning will be issued
+        if (isJavaHomeSet(serverEnvLines, jvmOptionsLines)) {
+            getLog().warn(MessageFormat.format(
+                    messages.getString("warn.server.env.java.home.configured"),
+                    mojoExecution.getGoal()
+            ));
+        } else {
+            // 3. Apply toolchain configuration
+            return populateEnviornmentVariablesMap(jdkHome);
+        }
+        return Collections.emptyMap();
+    }
+
+    /**
+     * Determines the primary server.env file to read.
+     * Checks serverEnvFile first, then a default location in serverDirectory.
+     *
+     * @return The File object for the server.env, or null if neither exists or is specified.
+     */
+    private File getServerEnvFile() {
+        if (serverEnvFile != null && serverEnvFile.exists()) {
+            return serverEnvFile;
+        }
+        File defaultServerEnv = new File(serverDirectory, "server.env");
+        if (defaultServerEnv.exists()) {
+            return defaultServerEnv;
+        }
+        return null;
+    }
+
+    /**
+     * Reads all lines from a configuration file, handling null/non-existent files
+     * and I/O exceptions gracefully.
+     *
+     * @param configFile The file to read.
+     * @return A list of strings, each representing a line in the file. Returns an empty list on failure.
+     */
+    private List<String> readConfigFileLines(File configFile) {
+        if (configFile == null || !configFile.exists()) {
+            return Collections.emptyList();
+        }
+        Path configPath = configFile.toPath();
+        try {
+            return Files.readAllLines(configPath);
+        } catch (IOException e) {
+            getLog().warn("Error reading config file: " + configPath);
+            return Collections.emptyList();
+        }
+    }
+
+    /**
+     * Applies the toolchain's JDK home to the ServerTask's environment variables.
+     *
+     * @param jdkHome    The resolved JDK home path.
+     * @return envVars
+     */
+    private Map<String, String> populateEnviornmentVariablesMap(String jdkHome) {
+        getLog().info(MessageFormat.format(
+                messages.getString("info.toolchain.configured"),
+                mojoExecution.getGoal(),
+                jdkHome
+        ));
+        Map<String, String> envVars = new HashMap<>();
+        envVars.put("JAVA_HOME", jdkHome);
+        return envVars;
+    }
 }

liberty-maven-plugin/src/main/java/io/openliberty/tools/maven/jsp/CompileJspMojo.java

@@ -20,10 +20,13 @@
 import java.util.HashSet;
 import java.util.Iterator;
 import java.util.List;
+import java.util.Map;
+import java.util.Objects;
 import java.util.Properties;
 import java.util.Set;
 import java.util.TreeSet;
 
+import org.apache.commons.lang3.ObjectUtils;
 import org.apache.maven.artifact.Artifact;
 import org.apache.maven.model.Plugin;
 import org.apache.maven.plugin.MojoExecutionException;
@@ -83,7 +86,11 @@ private void doCompileJsps() throws MojoExecutionException {
         compile.setDestdir(new File(getProject().getBuild().getOutputDirectory()));
         compile.setTempdir(new File(getProject().getBuild().getDirectory()));
         compile.setTimeout(timeout);
-
+        // put toolchain jdk into environment variables
+        Map<String, String> envVars = getToolchainEnvVar();
+        if(ObjectUtils.isNotEmpty(envVars)) {
+            compile.setEnvironmentVariables(envVars);
+        }
         // don't delete temporary server dir
         compile.setCleanup(false);
 

liberty-maven-plugin/src/main/java/io/openliberty/tools/maven/server/StartDebugMojoSupport.java

@@ -32,7 +32,6 @@
 import java.nio.file.Paths;
 import java.text.MessageFormat;
 import java.util.ArrayList;
-import java.util.Collections;
 import java.util.Date;
 import java.util.EnumSet;
 import java.util.HashMap;
@@ -47,6 +46,7 @@
 import javax.xml.parsers.ParserConfigurationException;
 import javax.xml.transform.TransformerException;
 
+import org.apache.commons.lang3.ObjectUtils;
 import org.apache.maven.artifact.Artifact;
 import org.apache.maven.artifact.versioning.ComparableVersion;
 import org.apache.maven.execution.MavenSession;
@@ -173,93 +173,11 @@ protected ServerTask initializeJava() {
         serverTask.setServerName(serverName);
         serverTask.setUserDir(userDirectory);
         serverTask.setOutputDir(outputDirectory);
-        configureToolchainEnvVar(serverTask);
-        return serverTask;
-    }
-    /**
-     * @param serverTask
-     */
-    private void configureToolchainEnvVar(ServerTask serverTask) {
-
-        if (toolchain == null) {
-            return;
-        }
-        String jdkHome = getJdkHomeFromToolchain(toolchain);
-        if (jdkHome == null) {
-            getLog().warn("Could not determine JDK home from toolchain. Toolchain will not be honored");
-            return;
-        }
-
-        // 1. Read existing config files
-        List<String> serverEnvLines = readConfigFileLines(getServerEnvFile());
-        List<String> jvmOptionsLines = readConfigFileLines(new File(serverDirectory, "jvm.options"));
-
-        // 2. Check for existing JAVA_HOME configuration
-        // if user has configured JAVA_HOME in server.env or jvm.options, this will get higher precedence over toolchain JDK
-        // hence a warning will be issued
-        if (isJavaHomeSet(serverEnvLines, jvmOptionsLines)) {
-            getLog().warn(MessageFormat.format(
-                    messages.getString("warn.server.env.java.home.configured"),
-                    mojoExecution.getGoal()
-            ));
-        } else {
-            // 3. Apply toolchain configuration
-            applyToolchainToTask(serverTask, jdkHome);
-        }
-    }
-
-    /**
-     * Determines the primary server.env file to read.
-     * Checks serverEnvFile first, then a default location in serverDirectory.
-     *
-     * @return The File object for the server.env, or null if neither exists or is specified.
-     */
-    private File getServerEnvFile() {
-        if (serverEnvFile != null && serverEnvFile.exists()) {
-            return serverEnvFile;
+        Map<String, String> envVars = getToolchainEnvVar();
+        if(ObjectUtils.isNotEmpty(envVars)) {
+            serverTask.setEnvironmentVariables(envVars);
         }
-        File defaultServerEnv = new File(serverDirectory, "server.env");
-        if (defaultServerEnv.exists()) {
-            return defaultServerEnv;
-        }
-        return null;
-    }
-
-    /**
-     * Reads all lines from a configuration file, handling null/non-existent files
-     * and I/O exceptions gracefully.
-     *
-     * @param configFile The file to read.
-     * @return A list of strings, each representing a line in the file. Returns an empty list on failure.
-     */
-    private List<String> readConfigFileLines(File configFile) {
-        if (configFile == null || !configFile.exists()) {
-            return Collections.emptyList();
-        }
-        Path configPath = configFile.toPath();
-        try {
-            return Files.readAllLines(configPath);
-        } catch (IOException e) {
-            getLog().warn("Error reading config file: " + configPath);
-            return Collections.emptyList();
-        }
-    }
-
-    /**
-     * Applies the toolchain's JDK home to the ServerTask's environment variables.
-     *
-     * @param serverTask The task to modify.
-     * @param jdkHome    The resolved JDK home path.
-     */
-    private void applyToolchainToTask(ServerTask serverTask, String jdkHome) {
-        getLog().info(MessageFormat.format(
-                messages.getString("info.toolchain.configured"),
-                mojoExecution.getGoal(),
-                jdkHome
-        ));
-        Map<String, String> envVars = new HashMap<>();
-        envVars.put("JAVA_HOME", jdkHome);
-        serverTask.setEnvironmentVariables(envVars);
+        return serverTask;
     }
 
     protected void runMojo(String groupId, String artifactId, String goal) throws MojoExecutionException {