[MPLUGIN-376] Drop legacy dependencies (#42)

cstamas · web-flow · commit d57eaff72823 · 2021-10-21T19:18:39.000+02:00
Plugin used a lot of legacy code, misused Mojo test case
and used old Junit 3.x TestCase, and missed some
dependencies (junit mostly).

Changes:
* drop use of Junit 3 TestCase, use Junit4 everywhere
* fix misuses of AbstractMojoTestCase when it is NOT mojo being tested
* add missing junit test dep where missing
* drop legacy p-c-d, sisu using exclusions/replacements
* align JavaMojoDescriptorExtractorTest.java for semantic difference: current Shim returns empty list instead of null when no components (for null safety). Assers updated but semantic is same: "there are no components discovered".
diff --git a/maven-plugin-plugin/pom.xml b/maven-plugin-plugin/pom.xml
@@ -99,6 +99,12 @@
       <groupId>org.apache.maven.doxia</groupId>
       <artifactId>doxia-sink-api</artifactId>
       <version>${doxiaVersion}</version>
+      <exclusions>
+        <exclusion>
+          <groupId>org.codehaus.plexus</groupId>
+          <artifactId>plexus-container-default</artifactId>
+        </exclusion>
+      </exclusions>
     </dependency>
     <dependency>
       <groupId>org.apache.maven.doxia</groupId>
@@ -120,19 +126,24 @@
     <dependency>
       <groupId>org.apache.maven</groupId>
       <artifactId>maven-plugin-api</artifactId>
+      <!-- TODO: make this provided once 3.6.2+ maven-plugin-plugin is in use -->
+      <scope>compile</scope>
     </dependency>
     <dependency>
       <groupId>org.apache.maven</groupId>
       <artifactId>maven-model</artifactId>
+      <scope>provided</scope>
     </dependency>
     <dependency>
       <groupId>org.apache.maven</groupId>
       <artifactId>maven-repository-metadata</artifactId>
       <version>${mavenVersion}</version>
+      <scope>provided</scope>
     </dependency>
     <dependency>
       <groupId>org.apache.maven</groupId>
       <artifactId>maven-artifact</artifactId>
+      <scope>provided</scope>
     </dependency>
 
     <!-- shared -->
@@ -148,19 +159,13 @@
       <artifactId>plexus-utils</artifactId>
     </dependency>
     <dependency>
-      <groupId>org.sonatype.sisu</groupId>
-      <artifactId>sisu-inject-plexus</artifactId>
-      <version>1.4.2</version>
+      <groupId>org.eclipse.sisu</groupId>
+      <artifactId>org.eclipse.sisu.plexus</artifactId>
+      <scope>provided</scope>
     </dependency>
     <dependency>
       <groupId>org.codehaus.plexus</groupId>
       <artifactId>plexus-velocity</artifactId>
-      <exclusions>
-        <exclusion>
-          <groupId>velocity</groupId>
-          <artifactId>velocity</artifactId>
-        </exclusion>
-      </exclusions>
     </dependency>
 
     <!-- for m2e support: https://www.eclipse.org/m2e/documentation/m2e-making-maven-plugins-compat.html -->
@@ -169,7 +174,14 @@
       <artifactId>plexus-build-api</artifactId>
       <version>0.0.7</version>
     </dependency>
- 
+
+    <!-- tests -->
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <scope>test</scope>
+    </dependency>
+
     <!-- needed for it tests -->
     <dependency>
       <groupId>org.apache.maven.plugin-tools</groupId>
diff --git a/maven-plugin-tools-annotations/pom.xml b/maven-plugin-tools-annotations/pom.xml
@@ -71,11 +71,6 @@
         </exclusion>
       </exclusions>
     </dependency>
-    <dependency>
-      <groupId>org.sonatype.sisu</groupId>
-      <artifactId>sisu-inject-plexus</artifactId>
-      <version>1.4.2</version>
-    </dependency>
     <dependency>
       <groupId>org.codehaus.plexus</groupId>
       <artifactId>plexus-archiver</artifactId>
diff --git a/maven-plugin-tools-api/pom.xml b/maven-plugin-tools-api/pom.xml
@@ -61,11 +61,6 @@
       <groupId>org.codehaus.plexus</groupId>
       <artifactId>plexus-utils</artifactId>
     </dependency>
-    <dependency>
-      <groupId>org.sonatype.sisu</groupId>
-      <artifactId>sisu-inject-plexus</artifactId>
-      <version>1.4.2</version>
-    </dependency>
 
     <!-- test -->
     <dependency>
diff --git a/maven-plugin-tools-api/src/test/java/org/apache/maven/tools/plugin/util/PluginUtilsTest.java b/maven-plugin-tools-api/src/test/java/org/apache/maven/tools/plugin/util/PluginUtilsTest.java
@@ -20,14 +20,16 @@
  */
 
 import org.apache.maven.plugin.descriptor.PluginDescriptor;
-import org.apache.maven.plugin.testing.AbstractMojoTestCase;
+import org.junit.Test;
+
+import static org.junit.Assert.assertEquals;
 
 /**
  * @author jdcasey
  */
 public class PluginUtilsTest
-    extends AbstractMojoTestCase
 {
+    @Test
     public void testShouldTrimArtifactIdToFindPluginId()
     {
         assertEquals( "artifactId", PluginDescriptor.getGoalPrefixFromArtifactId( "maven-artifactId-plugin" ) );
@@ -38,6 +40,7 @@ public void testShouldTrimArtifactIdToFindPluginId()
         assertEquals( "plugin", PluginDescriptor.getGoalPrefixFromArtifactId( "maven-plugin-plugin" ) );
     }
 
+    @Test
     public void testShouldFindTwoScriptsWhenNoExcludesAreGiven()
     {
         String testScript = "test.txt";
@@ -50,6 +53,7 @@ public void testShouldFindTwoScriptsWhenNoExcludesAreGiven()
         assertEquals( 2, files.length );
     }
 
+    @Test
     public void testShouldFindOneScriptsWhenAnExcludeIsGiven()
     {
         String testScript = "test.txt";
diff --git a/maven-plugin-tools-generators/pom.xml b/maven-plugin-tools-generators/pom.xml
@@ -62,12 +62,6 @@
     <dependency>
       <groupId>org.codehaus.plexus</groupId>
       <artifactId>plexus-velocity</artifactId>
-      <exclusions>
-        <exclusion>
-          <groupId>velocity</groupId>
-          <artifactId>velocity</artifactId>
-        </exclusion>
-      </exclusions>
     </dependency>
 
     <!-- other -->
@@ -93,11 +87,22 @@
     </dependency>
 
     <!-- test -->
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <scope>test</scope>
+    </dependency>
     <dependency>
       <groupId>org.apache.maven.reporting</groupId>
       <artifactId>maven-reporting-impl</artifactId>
-      <version>2.1</version>
+      <version>3.0.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.plugin-testing</groupId>
diff --git a/maven-plugin-tools-generators/src/test/java/org/apache/maven/tools/plugin/generator/GeneratorUtilsTest.java b/maven-plugin-tools-generators/src/test/java/org/apache/maven/tools/plugin/generator/GeneratorUtilsTest.java
@@ -20,21 +20,25 @@
  */
 
 import org.apache.maven.plugin.descriptor.PluginDescriptor;
-import org.apache.maven.plugin.testing.AbstractMojoTestCase;
 import org.apache.maven.plugin.testing.stubs.MavenProjectStub;
 import org.codehaus.plexus.component.repository.ComponentDependency;
 import org.codehaus.plexus.util.xml.CompactXMLWriter;
 import org.codehaus.plexus.util.xml.XMLWriter;
+import org.junit.Test;
 
 import java.io.StringWriter;
 import java.util.Collections;
 
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
 /**
  * @author jdcasey
  */
 public class GeneratorUtilsTest
-    extends AbstractMojoTestCase
 {
+    @Test
     public void testShouldWriteDependencies()
         throws Exception
     {
@@ -62,6 +66,7 @@ public void testShouldWriteDependencies()
         assertEquals( pattern, output );
     }
 
+    @Test
     public void testMakeHtmlValid()
     {
         String javadoc = null;
@@ -94,6 +99,7 @@ public void testMakeHtmlValid()
         assertEquals( javadoc, GeneratorUtils.makeHtmlValid( javadoc ) );
     }
 
+    @Test
     public void testDecodeJavadocTags()
     {
         String javadoc = null;
@@ -148,6 +154,7 @@ public void testDecodeJavadocTags()
         assertEquals( "label", GeneratorUtils.decodeJavadocTags( javadoc ) );
     }
 
+    @Test
     public void testToText()
         throws Exception
     {
@@ -179,6 +186,7 @@ public void testToText()
         assertEquals( "Generates something for the project.", GeneratorUtils.toText( javadoc ) );
     }
 
+    @Test
     public void testIsMavenReport()
         throws Exception
     {
@@ -194,7 +202,7 @@ public void testIsMavenReport()
         String impl = "org.apache.maven.tools.plugin.generator.stubs.MavenReportStub";
 
         MavenProjectStub stub = new MavenProjectStub();
-        stub.setCompileSourceRoots( Collections.singletonList( getBasedir() + "/target/classes" ) );
+        stub.setCompileSourceRoots( Collections.singletonList( System.getProperty( "basedir" ) + "/target/classes" ) );
 
         assertTrue( GeneratorUtils.isMavenReport( impl, stub ) );
 
diff --git a/maven-plugin-tools-java/pom.xml b/maven-plugin-tools-java/pom.xml
@@ -58,12 +58,6 @@
     <dependency>
       <groupId>org.codehaus.plexus</groupId>
       <artifactId>plexus-component-annotations</artifactId>
-      <exclusions>
-        <exclusion>
-          <groupId>junit</groupId>
-          <artifactId>junit</artifactId>
-        </exclusion>
-      </exclusions>
     </dependency>
 
     <!-- misc -->
@@ -72,6 +66,12 @@
       <artifactId>qdox</artifactId>
     </dependency>
 
+    <!-- test -->
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <scope>test</scope>
+    </dependency>
     <dependency>
       <groupId>xmlunit</groupId>
       <artifactId>xmlunit</artifactId>
diff --git a/maven-plugin-tools-java/src/test/java/org/apache/maven/tools/plugin/extractor/javadoc/JavaMojoDescriptorExtractorTest.java b/maven-plugin-tools-java/src/test/java/org/apache/maven/tools/plugin/extractor/javadoc/JavaMojoDescriptorExtractorTest.java
@@ -222,7 +222,7 @@ public void testAnnotationInPlugin()
     {
         List<MojoDescriptor> results = extract( "source3" );
 
-        assertNull( results );
+        assertTrue( results.isEmpty() );
     }
 
     /**
@@ -253,7 +253,7 @@ public void testMethodReferenceInEnumConstructor()
     {
         List<MojoDescriptor> results = extract( "MPLUGIN-320" );
 
-        assertNull( results );
+        assertTrue( results.isEmpty() );
     }
 
     @Test
@@ -262,7 +262,7 @@ public void testEnumWithRegexPattern()
     {
         List<MojoDescriptor> results = extract( "MPLUGIN-290" );
 
-        assertNull( results );
+        assertTrue( results.isEmpty() );
     }
 
 }
diff --git a/maven-script/maven-plugin-tools-model/pom.xml b/maven-script/maven-plugin-tools-model/pom.xml
@@ -44,11 +44,6 @@
       <groupId>org.codehaus.plexus</groupId>
       <artifactId>plexus-utils</artifactId>
     </dependency>
-    <dependency>
-      <groupId>org.sonatype.sisu</groupId>
-      <artifactId>sisu-inject-plexus</artifactId>
-      <version>1.4.2</version>
-    </dependency>
     <dependency>
       <groupId>junit</groupId>
       <artifactId>junit</artifactId>
diff --git a/maven-script/maven-script-ant/pom.xml b/maven-script/maven-script-ant/pom.xml
@@ -50,6 +50,12 @@ under the License.
       <groupId>org.codehaus.plexus</groupId>
       <artifactId>plexus-ant-factory</artifactId>
       <version>1.0-alpha-2.1</version>
+      <exclusions>
+        <exclusion>
+          <groupId>org.codehaus.plexus</groupId>
+          <artifactId>plexus-container-default</artifactId>
+        </exclusion>
+      </exclusions>
     </dependency>
     <dependency>
       <groupId>org.codehaus.plexus</groupId>
diff --git a/maven-script/maven-script-beanshell/pom.xml b/maven-script/maven-script-beanshell/pom.xml
@@ -40,6 +40,12 @@ under the License.
       <groupId>org.codehaus.plexus</groupId>
       <artifactId>plexus-bsh-factory</artifactId>
       <version>1.0-alpha-7</version>
+      <exclusions>
+        <exclusion>
+          <groupId>org.codehaus.plexus</groupId>
+          <artifactId>plexus-container-default</artifactId>
+        </exclusion>
+      </exclusions>
     </dependency>
     <dependency>
       <groupId>bsh</groupId>
diff --git a/pom.xml b/pom.xml
@@ -92,9 +92,10 @@
   <properties>
     <surefire.version>2.22.2</surefire.version>
     <javaVersion>7</javaVersion>
-    <pluginTestingHarnessVersion>1.3</pluginTestingHarnessVersion>
-    <mavenVersion>3.2.2</mavenVersion>
+    <pluginTestingHarnessVersion>3.3.0</pluginTestingHarnessVersion>
+    <mavenVersion>3.2.5</mavenVersion>
     <antVersion>1.7.1</antVersion>
+    <sisuVersion>0.3.5</sisuVersion>
     <mavenInvokerPluginVersion>3.2.2</mavenInvokerPluginVersion>
     <maven.site.path>plugin-tools-archives/plugin-tools-LATEST</maven.site.path>
     <asmVersion>9.1</asmVersion>
@@ -171,6 +172,11 @@
       </dependency>
       
       <!-- plexus -->
+      <dependency>
+        <groupId>org.eclipse.sisu</groupId>
+        <artifactId>org.eclipse.sisu.plexus</artifactId>
+        <version>${sisuVersion}</version>
+      </dependency>
       <dependency>
         <groupId>org.codehaus.plexus</groupId>
         <artifactId>plexus-utils</artifactId>
@@ -196,6 +202,16 @@
         <groupId>org.codehaus.plexus</groupId>
         <artifactId>plexus-velocity</artifactId>
         <version>1.2</version>
+        <exclusions>
+          <exclusion>
+            <groupId>org.codehaus.plexus</groupId>
+            <artifactId>plexus-container-default</artifactId>
+          </exclusion>
+          <exclusion>
+            <groupId>velocity</groupId>
+            <artifactId>velocity</artifactId>
+          </exclusion>
+        </exclusions>
       </dependency>
 
       <!-- other -->
@@ -237,7 +253,7 @@
       <dependency>
         <groupId>junit</groupId>
         <artifactId>junit</artifactId>
-        <version>4.13.1</version>
+        <version>4.13.2</version>
         <scope>test</scope>
       </dependency>
     </dependencies>

Original file line number	Diff line number	Diff line change
`@@ -20,14 +20,16 @@`
`20`	`20`	`*/`
`21`	`21`
`22`	`22`	`import org.apache.maven.plugin.descriptor.PluginDescriptor;`
`23`		`-import org.apache.maven.plugin.testing.AbstractMojoTestCase;`
	`23`	`+import org.junit.Test;`
	`24`	`+`
	`25`	`+import static org.junit.Assert.assertEquals;`
`24`	`26`
`25`	`27`	`/**`
`26`	`28`	`* @author jdcasey`
`27`	`29`	`*/`
`28`	`30`	`public class PluginUtilsTest`
`29`		`- extends AbstractMojoTestCase`
`30`	`31`	`{`
	`32`	`+ @Test`
`31`	`33`	`public void testShouldTrimArtifactIdToFindPluginId()`
`32`	`34`	`{`
`33`	`35`	`assertEquals( "artifactId", PluginDescriptor.getGoalPrefixFromArtifactId( "maven-artifactId-plugin" ) );`
`@@ -38,6 +40,7 @@ public void testShouldTrimArtifactIdToFindPluginId()`
`38`	`40`	`assertEquals( "plugin", PluginDescriptor.getGoalPrefixFromArtifactId( "maven-plugin-plugin" ) );`
`39`	`41`	`}`
`40`	`42`
	`43`	`+ @Test`
`41`	`44`	`public void testShouldFindTwoScriptsWhenNoExcludesAreGiven()`
`42`	`45`	`{`
`43`	`46`	`String testScript = "test.txt";`
`@@ -50,6 +53,7 @@ public void testShouldFindTwoScriptsWhenNoExcludesAreGiven()`
`50`	`53`	`assertEquals( 2, files.length );`
`51`	`54`	`}`
`52`	`55`
	`56`	`+ @Test`
`53`	`57`	`public void testShouldFindOneScriptsWhenAnExcludeIsGiven()`
`54`	`58`	`{`
`55`	`59`	`String testScript = "test.txt";`
Original file line number	Diff line number	Diff line change
`@@ -20,21 +20,25 @@`
`20`	`20`	`*/`
`21`	`21`
`22`	`22`	`import org.apache.maven.plugin.descriptor.PluginDescriptor;`
`23`		`-import org.apache.maven.plugin.testing.AbstractMojoTestCase;`
`24`	`23`	`import org.apache.maven.plugin.testing.stubs.MavenProjectStub;`
`25`	`24`	`import org.codehaus.plexus.component.repository.ComponentDependency;`
`26`	`25`	`import org.codehaus.plexus.util.xml.CompactXMLWriter;`
`27`	`26`	`import org.codehaus.plexus.util.xml.XMLWriter;`
	`27`	`+import org.junit.Test;`
`28`	`28`
`29`	`29`	`import java.io.StringWriter;`
`30`	`30`	`import java.util.Collections;`
`31`	`31`
	`32`	`+import static org.junit.Assert.assertEquals;`
	`33`	`+import static org.junit.Assert.assertFalse;`
	`34`	`+import static org.junit.Assert.assertTrue;`
	`35`	`+`
`32`	`36`	`/**`
`33`	`37`	`* @author jdcasey`
`34`	`38`	`*/`
`35`	`39`	`public class GeneratorUtilsTest`
`36`		`- extends AbstractMojoTestCase`
`37`	`40`	`{`
	`41`	`+ @Test`
`38`	`42`	`public void testShouldWriteDependencies()`
`39`	`43`	`throws Exception`
`40`	`44`	`{`
`@@ -62,6 +66,7 @@ public void testShouldWriteDependencies()`
`62`	`66`	`assertEquals( pattern, output );`
`63`	`67`	`}`
`64`	`68`
	`69`	`+ @Test`
`65`	`70`	`public void testMakeHtmlValid()`
`66`	`71`	`{`
`67`	`72`	`String javadoc = null;`
`@@ -94,6 +99,7 @@ public void testMakeHtmlValid()`
`94`	`99`	`assertEquals( javadoc, GeneratorUtils.makeHtmlValid( javadoc ) );`
`95`	`100`	`}`
`96`	`101`
	`102`	`+ @Test`
`97`	`103`	`public void testDecodeJavadocTags()`
`98`	`104`	`{`
`99`	`105`	`String javadoc = null;`
`@@ -148,6 +154,7 @@ public void testDecodeJavadocTags()`
`148`	`154`	`assertEquals( "label", GeneratorUtils.decodeJavadocTags( javadoc ) );`
`149`	`155`	`}`
`150`	`156`
	`157`	`+ @Test`
`151`	`158`	`public void testToText()`
`152`	`159`	`throws Exception`
`153`	`160`	`{`
`@@ -179,6 +186,7 @@ public void testToText()`
`179`	`186`	`assertEquals( "Generates something for the project.", GeneratorUtils.toText( javadoc ) );`
`180`	`187`	`}`
`181`	`188`
	`189`	`+ @Test`
`182`	`190`	`public void testIsMavenReport()`
`183`	`191`	`throws Exception`
`184`	`192`	`{`
`@@ -194,7 +202,7 @@ public void testIsMavenReport()`
`194`	`202`	`String impl = "org.apache.maven.tools.plugin.generator.stubs.MavenReportStub";`
`195`	`203`
`196`	`204`	`MavenProjectStub stub = new MavenProjectStub();`
`197`		`- stub.setCompileSourceRoots( Collections.singletonList( getBasedir() + "/target/classes" ) );`
	`205`	`+ stub.setCompileSourceRoots( Collections.singletonList( System.getProperty( "basedir" ) + "/target/classes" ) );`
`198`	`206`
`199`	`207`	`assertTrue( GeneratorUtils.isMavenReport( impl, stub ) );`
`200`	`208`
Original file line number	Diff line number	Diff line change
`@@ -222,7 +222,7 @@ public void testAnnotationInPlugin()`
`222`	`222`	`{`
`223`	`223`	`List<MojoDescriptor> results = extract( "source3" );`
`224`	`224`
`225`		`- assertNull( results );`
	`225`	`+ assertTrue( results.isEmpty() );`
`226`	`226`	`}`
`227`	`227`
`228`	`228`	`/**`
`@@ -253,7 +253,7 @@ public void testMethodReferenceInEnumConstructor()`
`253`	`253`	`{`
`254`	`254`	`List<MojoDescriptor> results = extract( "MPLUGIN-320" );`
`255`	`255`
`256`		`- assertNull( results );`
	`256`	`+ assertTrue( results.isEmpty() );`
`257`	`257`	`}`
`258`	`258`
`259`	`259`	`@Test`
`@@ -262,7 +262,7 @@ public void testEnumWithRegexPattern()`
`262`	`262`	`{`
`263`	`263`	`List<MojoDescriptor> results = extract( "MPLUGIN-290" );`
`264`	`264`
`265`		`- assertNull( results );`
	`265`	`+ assertTrue( results.isEmpty() );`
`266`	`266`	`}`
`267`	`267`
`268`	`268`	`}`