Fix #401 - Maven v4 compatibility

slawekjaranowski · slawekjaranowski · commit 0134866dee95 · 2024-02-08T20:11:52.000+01:00
diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml
@@ -24,6 +24,5 @@ jobs:
     name: Verify
     uses: apache/maven-gh-actions-shared/.github/workflows/maven-verify.yml@v3
     with:
-      jdk-matrix: '[ "8", "17", "21" ]'
-      ff-maven: "3.9.5"                              # Maven version for fail-fast-build
-      maven-matrix: '[ "3.6.3", "3.8.8", "3.9.5" ]'  # Maven versions matrix for verify builds
+      ff-maven: "3.9.6"                              # Maven version for fail-fast-build
+      maven-matrix: '[ "3.6.3", "3.9.6", "4.0.0-alpha-12" ]'  # Maven versions matrix for verify builds
diff --git a/pom.xml b/pom.xml
@@ -181,13 +181,6 @@
       <scope>provided</scope>
     </dependency>
 
-    <dependency>
-      <groupId>org.codehaus.plexus</groupId>
-      <artifactId>plexus-component-annotations</artifactId>
-      <version>2.2.0</version>
-      <optional>true</optional>
-    </dependency>
-
     <dependency>
       <groupId>org.apache.commons</groupId>
       <artifactId>commons-exec</artifactId>
@@ -261,6 +254,9 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-compiler-plugin</artifactId>
+        <configuration>
+          <proc>none</proc>
+        </configuration>
         <executions>
           <execution>
             <id>default-testCompile</id>
@@ -296,18 +292,6 @@
           </execution>
         </executions>
       </plugin>
-      <plugin>
-        <groupId>org.codehaus.plexus</groupId>
-        <artifactId>plexus-component-metadata</artifactId>
-        <version>2.2.0</version>
-        <executions>
-          <execution>
-            <goals>
-              <goal>generate-metadata</goal>
-            </goals>
-          </execution>
-        </executions>
-      </plugin>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-dependency-plugin</artifactId>
@@ -352,6 +336,10 @@
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <groupId>org.eclipse.sisu</groupId>
+        <artifactId>sisu-maven-plugin</artifactId>
+      </plugin>
     </plugins>
   </build>
 
diff --git a/src/it/projects/mexec-gh-389-block-exit-non-zero/verify.groovy b/src/it/projects/mexec-gh-389-block-exit-non-zero/verify.groovy
@@ -24,4 +24,4 @@ assert buildLogLines[infoMessageLineNumber - 1] == "[one, two, three]"
 // Verify that subsequent lines contain the beginning of the thrown SystemExitException stack trace
 assert buildLogLines[infoMessageLineNumber + 1].startsWith("[WARNING]")
 assert buildLogLines[infoMessageLineNumber + 2].contains("SystemExitException: System::exit was called with return code 123")
-assert buildLogLines[infoMessageLineNumber + 3].contains("SystemExitManager.exit (SystemExitManager.java")
+assert buildLogLines[infoMessageLineNumber + 3].matches(".*SystemExitManager.exit ?\\(SystemExitManager.java.*")
diff --git a/src/it/projects/setup-parent/pom.xml b/src/it/projects/setup-parent/pom.xml
@@ -86,6 +86,11 @@
           <artifactId>maven-resources-plugin</artifactId>
           <version>@maven-resources-plugin.version@</version>
         </plugin>
+        <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-toolchains-plugin</artifactId>
+          <version>3.1.0</version>
+        </plugin>
       </plugins>
     </pluginManagement>
   </build>
diff --git a/src/it/projects/toolchains-paths/invoker.properties b/src/it/projects/toolchains-paths/invoker.properties
@@ -0,0 +1 @@
+invoker.goals = --toolchains toolchains.xml validate
diff --git a/src/it/projects/toolchains-paths/pom.xml b/src/it/projects/toolchains-paths/pom.xml
@@ -0,0 +1,58 @@
+<project
+  xmlns="http://maven.apache.org/POM/4.0.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <parent>
+    <groupId>org.codehaus.mojo.exec.it</groupId>
+    <artifactId>parent</artifactId>
+    <version>0.1</version>
+  </parent>
+
+  <artifactId>toolchains-paths</artifactId>
+  <version>0.0.1-SNAPSHOT</version>
+  <packaging>pom</packaging>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-toolchains-plugin</artifactId>
+        <configuration>
+          <toolchains>
+            <paths>
+              <id>my-paths</id>
+            </paths>
+          </toolchains>
+        </configuration>
+        <executions>
+          <execution>
+            <goals>
+              <goal>toolchain</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+      <plugin>
+        <groupId>org.codehaus.mojo</groupId>
+        <artifactId>exec-maven-plugin</artifactId>
+        <version>@project.version@</version>
+        <extensions>true</extensions>
+        <configuration>
+          <executable>test</executable>
+          <toolchain>paths</toolchain>
+        </configuration>
+        <executions>
+          <execution>
+            <id>execution</id>
+            <goals>
+              <goal>exec</goal>
+            </goals>
+            <phase>validate</phase>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
+</project>
diff --git a/src/it/projects/toolchains-paths/scripts/test b/src/it/projects/toolchains-paths/scripts/test
@@ -0,0 +1,2 @@
+#! /bin/sh
+echo Hello from exec-maven-plugin
diff --git a/src/it/projects/toolchains-paths/scripts/test.cmd b/src/it/projects/toolchains-paths/scripts/test.cmd
@@ -0,0 +1 @@
+echo Hello from exec-maven-plugin
diff --git a/src/it/projects/toolchains-paths/toolchains.xml b/src/it/projects/toolchains-paths/toolchains.xml
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF8"?>
+<toolchains>
+  <toolchain>
+    <type>paths</type>
+    <provides>
+      <id>my-paths</id>
+    </provides>
+    <configuration>
+      <paths>
+        <path>scripts</path>
+      </paths>
+    </configuration>
+  </toolchain>
+</toolchains>
diff --git a/src/it/projects/toolchains-paths/verify.groovy b/src/it/projects/toolchains-paths/verify.groovy
@@ -0,0 +1,5 @@
+File log = new File(basedir, 'build.log')
+
+assert log.exists()
+assert log.getText().contains( "[INFO] Toolchain in exec-maven-plugin: Paths[scripts]" )
+assert log.getText().contains( "Hello from exec-maven-plugin" )
diff --git a/src/main/java/org/codehaus/mojo/exec/ExecMojo.java b/src/main/java/org/codehaus/mojo/exec/ExecMojo.java
@@ -59,13 +59,13 @@
 import org.apache.maven.artifact.resolver.filter.IncludesArtifactFilter;
 import org.apache.maven.execution.MavenSession;
 import org.apache.maven.plugin.MojoExecutionException;
+import org.apache.maven.plugins.annotations.Component;
 import org.apache.maven.plugins.annotations.Mojo;
 import org.apache.maven.plugins.annotations.Parameter;
 import org.apache.maven.plugins.annotations.ResolutionScope;
 import org.apache.maven.project.MavenProject;
 import org.apache.maven.toolchain.Toolchain;
 import org.apache.maven.toolchain.ToolchainManager;
-import org.codehaus.plexus.component.repository.exception.ComponentLookupException;
 import org.codehaus.plexus.util.StringUtils;
 import org.codehaus.plexus.util.cli.CommandLineException;
 import org.codehaus.plexus.util.cli.CommandLineUtils;
@@ -344,6 +344,9 @@ public class ExecMojo extends AbstractExecMojo {
     @Parameter(property = "exec.asyncDestroyOnShutdown", defaultValue = "true")
     private boolean asyncDestroyOnShutdown = true;
 
+    @Component
+    private ToolchainManager toolchainManager;
+
     public static final String CLASSPATH_TOKEN = "%classpath";
 
     public static final String MODULEPATH_TOKEN = "%modulepath";
@@ -936,22 +939,11 @@ public int[] getSuccessCodes() {
     }
 
     private Toolchain getToolchain() {
-        Toolchain tc = null;
-
-        try {
-            if (session != null) // session is null in tests..
-            {
-                ToolchainManager toolchainManager =
-                        (ToolchainManager) session.getContainer().lookup(ToolchainManager.ROLE);
-
-                if (toolchainManager != null) {
-                    tc = toolchainManager.getToolchainFromBuildContext(toolchain, session);
-                }
-            }
-        } catch (ComponentLookupException componentLookupException) {
-            // just ignore, could happen in pre-2.0.9 builds..
+        // session and toolchainManager can be null in tests ...
+        if (session != null && toolchainManager != null) {
+            return toolchainManager.getToolchainFromBuildContext(toolchain, session);
         }
-        return tc;
+        return null;
     }
 
     /**
diff --git a/src/main/java/org/codehaus/mojo/exec/PathsToolchain.java b/src/main/java/org/codehaus/mojo/exec/PathsToolchain.java
@@ -19,38 +19,59 @@
  * under the License.
  */
 
+import java.util.Collections;
 import java.util.List;
+import java.util.Map;
+import java.util.Objects;
 
-import org.apache.maven.toolchain.DefaultToolchain;
+import org.apache.maven.toolchain.ToolchainPrivate;
 import org.apache.maven.toolchain.model.ToolchainModel;
-import org.codehaus.plexus.logging.Logger;
 
 /**
  * Searches a list of configured paths for the requested tool.
  *
  * @author Markus KARG (markus@headcrashing.eu)
  */
-class PathsToolchain extends DefaultToolchain {
+class PathsToolchain implements ToolchainPrivate {
+    private final ToolchainModel model;
+
     private List<String> paths;
 
-    public PathsToolchain(final ToolchainModel model, final Logger logger) {
-        super(model, "paths", logger); // NOI18N
+    public PathsToolchain(ToolchainModel model) {
+        this.model = model;
+    }
+
+    @Override
+    public ToolchainModel getModel() {
+        return model;
     }
 
-    public List<String> getPaths() {
-        return this.paths;
+    @Override
+    public String getType() {
+        return model.getType();
     }
 
-    public void setPaths(final List<String> paths) {
+    public void setPaths(List<String> paths) {
         this.paths = paths;
     }
 
-    @Override
-    public String toString() {
-        return "Paths" + this.getPaths(); // NOI18N
+    private List<String> getPaths() {
+        return paths != null ? paths : Collections.emptyList();
     }
 
+    @Override
     public String findTool(final String toolName) {
-        return ExecMojo.findExecutable(toolName, this.paths);
+        return ExecMojo.findExecutable(toolName, getPaths());
+    }
+
+    @Override
+    public boolean matchesRequirements(Map<String, String> requirements) {
+        return requirements.entrySet().stream()
+                .anyMatch(entry -> Objects.equals(model.getProvides().get(entry.getKey()), entry.getValue()));
+    }
+
+    @Override
+    public String toString() {
+        return "Paths" + getPaths(); // NOI18N
     }
 }
diff --git a/src/main/java/org/codehaus/mojo/exec/PathsToolchainFactory.java b/src/main/java/org/codehaus/mojo/exec/PathsToolchainFactory.java

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+invoker.goals = --toolchains toolchains.xml validate`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+#! /bin/sh`
	`2`	`+echo Hello from exec-maven-plugin`