[MINVOKER-284] Switch to JUnit5, drop maven-compat

apache · Apr 29, 2024 · c706f58 · c706f58
1 parent 7c329e1
commit c706f58
Show file tree

Hide file tree

Showing 16 changed files with 231 additions and 218 deletions.
diff --git a/pom.xml b/pom.xml
@@ -252,33 +252,20 @@ under the License.
     </dependency>
 
     <dependency>
-      <groupId>junit</groupId>
-      <artifactId>junit</artifactId>
-      <version>4.13.2</version>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-api</artifactId>
       <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>org.mockito</groupId>
       <artifactId>mockito-core</artifactId>
-      <version>4.10.0</version>
+      <version>4.11.0</version>
       <scope>test</scope>
     </dependency>
     <dependency>
-      <groupId>org.apache.maven.plugin-testing</groupId>
-      <artifactId>maven-plugin-testing-harness</artifactId>
-      <version>3.3.0</version>
-      <scope>test</scope>
-      <exclusions>
-        <exclusion>
-          <groupId>org.codehaus.plexus</groupId>
-          <artifactId>plexus-container-default</artifactId>
-        </exclusion>
-      </exclusions>
-    </dependency>
-    <dependency>
-      <groupId>org.apache.maven</groupId>
-      <artifactId>maven-compat</artifactId>
-      <version>${mavenVersion}</version>
+      <groupId>org.mockito</groupId>
+      <artifactId>mockito-junit-jupiter</artifactId>
+      <version>4.11.0</version>
       <scope>test</scope>
     </dependency>
     <dependency>

diff --git a/src/it/exec-timeout-invoker-level/pom.xml b/src/it/exec-timeout-invoker-level/pom.xml
@@ -36,6 +36,17 @@ under the License.
   </dependencies>
 
   <build>
+    <pluginManagement>
+      <plugins>
+        <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-plugin-plugin</artifactId>
+          <configuration>
+            <goalPrefix>test</goalPrefix>
+          </configuration>
+        </plugin>
+      </plugins>
+    </pluginManagement>
     <plugins>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>

diff --git a/src/it/exec-timeout-mojo-level/pom.xml b/src/it/exec-timeout-mojo-level/pom.xml
@@ -36,6 +36,17 @@ under the License.
   </dependencies>
 
   <build>
+    <pluginManagement>
+      <plugins>
+        <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-plugin-plugin</artifactId>
+          <configuration>
+            <goalPrefix>test</goalPrefix>
+          </configuration>
+        </plugin>
+      </plugins>
+    </pluginManagement>
     <plugins>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>

diff --git a/src/main/java/org/apache/maven/plugins/invoker/AbstractInvokerMojo.java b/src/main/java/org/apache/maven/plugins/invoker/AbstractInvokerMojo.java
@@ -28,6 +28,7 @@
 import java.io.OutputStreamWriter;
 import java.io.Reader;
 import java.io.Writer;
+import java.nio.charset.Charset;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
@@ -91,13 +92,13 @@
 import org.codehaus.plexus.util.FileUtils;
 import org.codehaus.plexus.util.IOUtil;
 import org.codehaus.plexus.util.InterpolationFilterReader;
-import org.codehaus.plexus.util.ReaderFactory;
 import org.codehaus.plexus.util.ReflectionUtils;
-import org.codehaus.plexus.util.WriterFactory;
 import org.codehaus.plexus.util.cli.CommandLineException;
 import org.codehaus.plexus.util.cli.CommandLineUtils;
 import org.codehaus.plexus.util.cli.Commandline;
 import org.codehaus.plexus.util.cli.StreamConsumer;
+import org.codehaus.plexus.util.xml.XmlStreamReader;
+import org.codehaus.plexus.util.xml.XmlStreamWriter;
 import org.codehaus.plexus.util.xml.Xpp3Dom;
 import org.codehaus.plexus.util.xml.Xpp3DomWriter;
 
@@ -750,9 +751,10 @@ public void execute() throws MojoExecutionException, MojoFailureException {
             return;
         }
 
+
         if (encoding == null || encoding.isEmpty()) {
-            getLog().warn("File encoding has not been set, using platform encoding " + ReaderFactory.FILE_ENCODING
-                    + ", i.e. build is platform dependent!");
+            getLog().warn("File encoding has not been set, using platform encoding "
+                    + Charset.defaultCharset().displayName() + ", i.e. build is platform dependent!");
         }
 
         // done it here to prevent issues with concurrent access in case of parallel run
@@ -1522,7 +1524,7 @@ private void runBuild(
         File interpolatedPomFile = interpolatePomFile(pomFile, basedir);
         // FIXME: Think about the following code part -- ^^^^^^^ END
 
-        getLog().info(buffer().a("Building: ").strong(buildJob.getProject()).toString());
+        getLog().info(buffer().a("Building: ").strong(buildJob.getProject()).build());
 
         InvokerProperties invokerProperties = getInvokerProperties(basedir, globalInvokerProperties);
 
@@ -2274,13 +2276,12 @@ void buildInterpolatedFile(File originalFile, File interpolatedFile) throws Mojo
 
             // interpolation with token @...@
             try (Reader reader =
-                    new InterpolationFilterReader(ReaderFactory.newXmlReader(originalFile), composite, "@", "@")) {
+                    new InterpolationFilterReader(new XmlStreamReader(originalFile), composite, "@", "@")) {
                 xml = IOUtil.toString(reader);
             }
 
-            try (Writer writer = WriterFactory.newXmlWriter(interpolatedFile)) {
+            try (Writer writer = new XmlStreamWriter(interpolatedFile)) {
                 interpolatedFile.getParentFile().mkdirs();
-
                 writer.write(xml);
             }
         } catch (IOException e) {

diff --git a/src/main/java/org/apache/maven/plugins/invoker/InvokerReport.java b/src/main/java/org/apache/maven/plugins/invoker/InvokerReport.java
@@ -32,7 +32,6 @@
 import org.apache.maven.reporting.AbstractMavenReport;
 import org.apache.maven.reporting.MavenReportException;
 import org.codehaus.plexus.i18n.I18N;
-import org.codehaus.plexus.util.ReaderFactory;
 import org.codehaus.plexus.util.xml.XmlStreamReader;
 import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
 
@@ -64,7 +63,7 @@ protected void executeReport(Locale locale) throws MavenReportException {
         BuildJobXpp3Reader buildJobReader = new BuildJobXpp3Reader();
         List<BuildJob> buildJobs = new ArrayList<>(reportFiles.length);
         for (File reportFile : reportFiles) {
-            try (XmlStreamReader xmlReader = ReaderFactory.newXmlReader(reportFile)) {
+            try (XmlStreamReader xmlReader = new XmlStreamReader(reportFile)) {
                 buildJobs.add(buildJobReader.read(xmlReader));
             } catch (XmlPullParserException e) {
                 throw new MavenReportException("Failed to parse report file: " + reportFile, e);
@@ -103,6 +102,7 @@ private File[] getReportFiles() {
         return ReportUtils.getReportFiles(reportsDirectory);
     }
 
+    @Override
     public boolean canGenerateReport() {
         return getReportFiles().length > 0;
     }

diff --git a/src/main/java/org/apache/maven/plugins/invoker/InvokerSession.java b/src/main/java/org/apache/maven/plugins/invoker/InvokerSession.java
@@ -27,7 +27,7 @@
 import org.apache.maven.plugin.MojoFailureException;
 import org.apache.maven.plugin.logging.Log;
 import org.apache.maven.plugins.invoker.model.BuildJob;
-import org.apache.maven.shared.utils.io.IOUtil;
+import org.codehaus.plexus.util.IOUtil;
 
 import static org.apache.maven.shared.utils.logging.MessageUtils.buffer;
 
@@ -38,7 +38,7 @@
  */
 class InvokerSession {
     private static final String SEPARATOR =
-            buffer().strong("-------------------------------------------------").toString();
+            buffer().strong("-------------------------------------------------").build();
 
     private List<BuildJob> buildJobs;
 

diff --git a/src/main/java/org/apache/maven/plugins/invoker/PomUtils.java b/src/main/java/org/apache/maven/plugins/invoker/PomUtils.java
@@ -25,7 +25,7 @@
 import org.apache.maven.model.Model;
 import org.apache.maven.model.io.xpp3.MavenXpp3Reader;
 import org.apache.maven.plugin.MojoExecutionException;
-import org.codehaus.plexus.util.ReaderFactory;
+import org.codehaus.plexus.util.xml.XmlStreamReader;
 import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
 
 /**
@@ -43,7 +43,7 @@ class PomUtils {
      * @throws MojoExecutionException If the POM file could not be loaded.
      */
     public static Model loadPom(File pomFile) throws MojoExecutionException {
-        try (Reader reader = ReaderFactory.newXmlReader(pomFile)) {
+        try (Reader reader = new XmlStreamReader(pomFile)) {
             return new MavenXpp3Reader().read(reader, false);
         } catch (XmlPullParserException e) {
             throw new MojoExecutionException("Failed to parse POM: " + pomFile, e);

diff --git a/src/main/java/org/apache/maven/plugins/invoker/VerifyMojo.java b/src/main/java/org/apache/maven/plugins/invoker/VerifyMojo.java
@@ -29,7 +29,7 @@
 import org.apache.maven.plugins.annotations.Mojo;
 import org.apache.maven.plugins.annotations.Parameter;
 import org.apache.maven.plugins.invoker.model.io.xpp3.BuildJobXpp3Reader;
-import org.codehaus.plexus.util.ReaderFactory;
+import org.codehaus.plexus.util.xml.XmlStreamReader;
 import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
 
 /**
@@ -117,7 +117,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
         InvokerSession invokerSession = new InvokerSession();
 
         for (File reportFile : reportFiles) {
-            try (Reader xmlReader = ReaderFactory.newXmlReader(reportFile)) {
+            try (Reader xmlReader = new XmlStreamReader(reportFile)) {
                 invokerSession.addJob(reader.read(xmlReader));
             } catch (XmlPullParserException e) {
                 throw new MojoExecutionException("Failed to parse report file: " + reportFile, e);

diff --git a/...ins/invoker/ExtendedMavenProjectStub.java → ...ven/plugins/invoker/AbstractTestUtil.java b/...ins/invoker/ExtendedMavenProjectStub.java → ...ven/plugins/invoker/AbstractTestUtil.java
@@ -18,33 +18,18 @@
  */
 package org.apache.maven.plugins.invoker;
 
-import java.util.Properties;
+import java.io.File;
 
-import org.apache.maven.model.Scm;
-import org.apache.maven.plugin.testing.stubs.MavenProjectStub;
+import org.codehaus.plexus.util.ReflectionUtils;
 
-/**
- * @author Olivier Lamy
- * @since 22 nov. 07
- */
-public class ExtendedMavenProjectStub extends MavenProjectStub {
-    private Scm scm;
-
-    private Properties properties;
-
-    public Scm getScm() {
-        return scm;
-    }
-
-    public void setScm(Scm scm) {
-        this.scm = scm;
-    }
+abstract class AbstractTestUtil {
 
-    public Properties getProperties() {
-        return properties;
+    protected String getBasedir() {
+        String path = System.getProperty("basedir");
+        return path != null ? path : new File("").getAbsolutePath();
     }
 
-    public void setProperties(Properties properties) {
-        this.properties = properties;
+    protected void setVariableValueToObject(Object object, String filed, Object value) throws IllegalAccessException {
+        ReflectionUtils.setVariableValueInObject(object, filed, value);
     }
 }
diff --git a/src/test/java/org/apache/maven/plugins/invoker/InterpolationTest.java b/src/test/java/org/apache/maven/plugins/invoker/InterpolationTest.java
@@ -20,80 +20,80 @@
 
 import java.io.File;
 import java.io.Reader;
+import java.util.HashMap;
 import java.util.Map;
 import java.util.Properties;
 
 import org.apache.maven.model.Scm;
-import org.apache.maven.plugin.testing.AbstractMojoTestCase;
-import org.apache.maven.plugin.testing.stubs.MavenProjectStub;
+import org.apache.maven.project.MavenProject;
 import org.apache.maven.settings.Settings;
 import org.codehaus.plexus.util.IOUtil;
-import org.codehaus.plexus.util.ReaderFactory;
+import org.codehaus.plexus.util.xml.XmlStreamReader;
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
 
 /**
  * @author Olivier Lamy
  * @since 22 nov. 07
  */
-public class InterpolationTest extends AbstractMojoTestCase {
+class InterpolationTest extends AbstractTestUtil {
 
-    protected MavenProjectStub buildMavenProjectStub() {
-        ExtendedMavenProjectStub project = new ExtendedMavenProjectStub();
+    private MavenProject buildMavenProjectStub() {
+        MavenProject project = new MavenProject();
         project.setVersion("1.0-SNAPSHOT");
         project.setArtifactId("foo");
         project.setGroupId("bar");
+        project.setFile(new File(getBasedir(), "pom.xml"));
         Properties properties = new Properties();
         properties.put("fooOnProject", "barOnProject");
-        project.setProperties(properties);
+        project.getModel().setProperties(properties);
         Scm scm = new Scm();
         scm.setConnection("http://blabla");
         project.setScm(scm);
         return project;
     }
 
-    public void testCompositeMap() {
+    @Test
+    void testCompositeMap() {
 
-        Properties properties = new Properties();
+        Map<String, Object> properties = new HashMap<>();
         properties.put("foo", "bar");
         properties.put("version", "2.0-SNAPSHOT");
-        CompositeMap compositeMap = new CompositeMap(buildMavenProjectStub(), (Map) properties, false);
-        assertEquals("1.0-SNAPSHOT", compositeMap.get("pom.version"));
-        assertEquals("bar", compositeMap.get("foo"));
-        assertEquals("bar", compositeMap.get("pom.groupId"));
-        assertEquals("http://blabla", compositeMap.get("pom.scm.connection"));
-        assertEquals("barOnProject", compositeMap.get("fooOnProject"));
+        CompositeMap compositeMap = new CompositeMap(buildMavenProjectStub(), properties, false);
+        assertThat(compositeMap).containsEntry("pom.version", "1.0-SNAPSHOT");
+        assertThat(compositeMap).containsEntry("foo", "bar");
+        assertThat(compositeMap).containsEntry("pom.groupId", "bar");
+        assertThat(compositeMap).containsEntry("pom.scm.connection", "http://blabla");
+        assertThat(compositeMap).containsEntry("fooOnProject", "barOnProject");
     }
 
-    public void testPomInterpolation() throws Exception {
-        Reader reader = null;
+    @Test
+    void testPomInterpolation() throws Exception {
         File interpolatedPomFile;
-        try {
-            InvokerMojo invokerMojo = new InvokerMojo();
-            setVariableValueToObject(invokerMojo, "project", buildMavenProjectStub());
-            setVariableValueToObject(invokerMojo, "settings", new Settings());
-            Properties properties = new Properties();
-            properties.put("foo", "bar");
-            properties.put("version", "2.0-SNAPSHOT");
-            setVariableValueToObject(invokerMojo, "filterProperties", properties);
-            String dirPath =
-                    getBasedir() + File.separatorChar + "src" + File.separatorChar + "test" + File.separatorChar
-                            + "resources" + File.separatorChar + "unit" + File.separatorChar + "interpolation";
+        InvokerMojo invokerMojo = new InvokerMojo();
+        setVariableValueToObject(invokerMojo, "project", buildMavenProjectStub());
+        setVariableValueToObject(invokerMojo, "settings", new Settings());
+        Properties properties = new Properties();
+        properties.put("foo", "bar");
+        properties.put("version", "2.0-SNAPSHOT");
+        setVariableValueToObject(invokerMojo, "filterProperties", properties);
+        String dirPath = getBasedir() + File.separatorChar + "src" + File.separatorChar + "test" + File.separatorChar
+                + "resources" + File.separatorChar + "unit" + File.separatorChar + "interpolation";
 
-            interpolatedPomFile = new File(getBasedir(), "target/interpolated-pom.xml");
-            invokerMojo.buildInterpolatedFile(new File(dirPath, "pom.xml"), interpolatedPomFile);
-            reader = ReaderFactory.newXmlReader(interpolatedPomFile);
+        interpolatedPomFile = new File(getBasedir(), "target/interpolated-pom.xml");
+        invokerMojo.buildInterpolatedFile(new File(dirPath, "pom.xml"), interpolatedPomFile);
+        try (Reader reader = new XmlStreamReader(interpolatedPomFile)) {
+            String content = IOUtil.toString(reader);
+            assertThat(content.indexOf("<interpolateValue>bar</interpolateValue>"))
+                    .isPositive();
+        }
+        // recreate it to test delete if exists before creation
+        invokerMojo.buildInterpolatedFile(new File(dirPath, "pom.xml"), interpolatedPomFile);
+        try (Reader reader = new XmlStreamReader(interpolatedPomFile)) {
             String content = IOUtil.toString(reader);
-            assertTrue(content.indexOf("<interpolateValue>bar</interpolateValue>") > 0);
-            reader.close();
-            reader = null;
-            // recreate it to test delete if exists before creation
-            invokerMojo.buildInterpolatedFile(new File(dirPath, "pom.xml"), interpolatedPomFile);
-            reader = ReaderFactory.newXmlReader(interpolatedPomFile);
-            content = IOUtil.toString(reader);
-            assertTrue(content.indexOf("<interpolateValue>bar</interpolateValue>") > 0);
-            reader.close();
-            reader = null;
-        } finally {
-            IOUtil.close(reader);
+            assertThat(content.indexOf("<interpolateValue>bar</interpolateValue>"))
+                    .isPositive();
         }
     }
 }