Add toolchain java path to environment variables in ExecMojo - added tests and various enhancements

Author: mmazur

src/main/java/org/codehaus/mojo/exec/ExecMojo.java

@@ -87,7 +87,6 @@ public class ExecMojo extends AbstractExecMojo {
      * Trying to recognize whether the given {@link #executable} might be a {@code java} binary.
      */
     private static final Pattern ENDS_WITH_JAVA = Pattern.compile("^.*java(\\.exe|\\.bin)?$", Pattern.CASE_INSENSITIVE);
-    private static final String TOOLCHAIN_JAVA_ENV_NAME = "TOOLCHAIN_JAVA";
 
     /**
      * <p>
@@ -339,6 +338,12 @@ public class ExecMojo extends AbstractExecMojo {
     @Parameter(property = "exec.asyncDestroyOnShutdown", defaultValue = "true")
     private boolean asyncDestroyOnShutdown = true;
 
+    /**
+     * Name of environment variable that will contain path to java executable provided by the toolchain (if the toolchain w
+     */
+    @Parameter(property = "exec.toolchainJavaHomeEnvName", defaultValue = "TOOLCHAIN_JAVA_HOME")
+    private String toolchainJavaHomeEnvName = "TOOLCHAIN_JAVA_HOME";
+
     @Component
     private ToolchainManager toolchainManager;
 
@@ -491,7 +496,10 @@ private Map<String, String> handleSystemEnvVariables() throws MojoExecutionExcep
 
         Toolchain tc = getToolchain();
         if (tc != null) {
-            enviro.put(TOOLCHAIN_JAVA_ENV_NAME, tc.findTool("java"));
+            String toolchainJava = tc.findTool("java");
+            if (toolchainJava != null) {
+                enviro.put(toolchainJavaHomeEnvName, toolchainJava.replaceFirst("bin/java$", ""));
+            }
         }
 
         if (this.getLog().isDebugEnabled()) {

src/test/java/org/codehaus/mojo/exec/DummyToolchain.java

@@ -0,0 +1,23 @@
+package org.codehaus.mojo.exec;
+
+import org.apache.commons.lang3.NotImplementedException;
+import org.apache.maven.toolchain.Toolchain;
+
+public class DummyToolchain implements Toolchain {
+
+    private final String testJavaPath;
+
+    public DummyToolchain(String testJavaPath) {
+        this.testJavaPath = testJavaPath;
+    }
+
+    @Override
+    public String getType() {
+        throw new NotImplementedException("testToolchain");
+    }
+
+    @Override
+    public String findTool(String s) {
+        return "java".equals(s) ? testJavaPath : null;
+    }
+}

src/test/java/org/codehaus/mojo/exec/ExecMojoTest.java

@@ -12,7 +12,9 @@
 import java.io.File;
 import java.io.IOException;
 import java.io.OutputStream;
+import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
+import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -28,17 +30,21 @@
 import org.apache.maven.execution.MavenSession;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.testing.AbstractMojoTestCase;
-import org.mockito.Mock;
+import org.apache.maven.toolchain.ToolchainManager;
 
 import static java.util.Collections.emptyMap;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
 
 /**
  * @author Jerome Lacoste
  * @version $Id$
  */
 public class ExecMojoTest extends AbstractMojoTestCase {
-    @Mock
-    private MavenSession session;
+    private MavenSession session = mock(MavenSession.class);
+    private ToolchainManager toolchainManager = mock(ToolchainManager.class);
 
     private static final File LOCAL_REPO = new File("src/test/repository");
 
@@ -287,6 +293,30 @@ public void test_exec_receives_all_parameters() throws MojoExecutionException {
                 Paths.get("target", "dist", "mails").toFile().exists());
     }
 
+    public void testToolchainJavaHomePropertySetWhenToolchainIsUsed() throws Exception {
+        // given
+        String testJavaPath = "/path/to/java/home";
+
+        File pom = new File(getBasedir(), "src/test/projects/project20/pom.xml");
+        ExecMojo mojo = (ExecMojo) lookupMojo("exec", pom);
+
+        setVariableValueToObject(mojo, "session", session);
+        setVariableValueToObject(mojo, "toolchainManager", toolchainManager);
+        when(toolchainManager.getToolchainFromBuildContext(any(), eq(session)))
+                .thenReturn(new DummyToolchain(testJavaPath + "/bin/java"));
+
+        File basedir = new File("target");
+        mojo.setBasedir(basedir);
+
+        // when
+        mojo.execute();
+
+        // then
+        Path resultFilePath = basedir.toPath().resolve("testfile.txt");
+        String result = new String(Files.readAllBytes(resultFilePath), StandardCharsets.UTF_8);
+        assertTrue(result.contains(testJavaPath));
+    }
+
     private void checkMojo(String expectedCommandLine) {
         assertEquals(1, mojo.getAmountExecutedCommandLines());
         CommandLine commandline = mojo.getExecutedCommandline(0);

src/test/projects/project20/pom.xml

@@ -0,0 +1,43 @@
+<project>
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>org.cb.maven.plugins.exec</groupId>
+    <artifactId>project20</artifactId>
+    <version>0.1</version>
+    <packaging>jar</packaging>
+    <name>Maven Exec Plugin</name>
+    <inceptionYear>2005</inceptionYear>
+
+    <licenses>
+        <license>
+            <name>Apache License 2</name>
+            <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
+            <distribution>repo</distribution>
+        </license>
+    </licenses>
+
+    <properties>
+        <test.name>${project.artifactId} project</test.name>
+    </properties>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>exec-maven-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <phase>test</phase>
+                        <goals>
+                            <goal>exec</goal>
+                        </goals>
+                    </execution>
+                </executions>
+                <configuration>
+                    <toolchainJavaHomeEnvName>CUSTOM_NAME_FOR_TOOLCHAIN_JAVA</toolchainJavaHomeEnvName>
+                    <executable>${basedir}/src/test/projects/project20/testscript.sh</executable>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>

src/test/projects/project20/testscript.sh

@@ -0,0 +1 @@
+echo $CUSTOM_NAME_FOR_TOOLCHAIN_JAVA > testfile.txt