[MPLUGIN-450] Require goalPrefix to be valid (#240)

apache · Dec 25, 2023 · ed4774b · ed4774b
1 parent 331cf42
commit ed4774b
Show file tree

Hide file tree

Showing 47 changed files with 99 additions and 23 deletions.
diff --git a/maven-plugin-plugin/src/it/annotation-with-inheritance-from-deps/pom.xml b/maven-plugin-plugin/src/it/annotation-with-inheritance-from-deps/pom.xml
@@ -91,6 +91,7 @@ under the License.
         <version>@project.version@</version>
         <configuration>
           <skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
+          <goalPrefix>prefix</goalPrefix>
         </configuration>
         <executions>
           <execution>

diff --git a/maven-plugin-plugin/src/it/annotation-with-inheritance-reactor/module-mojo/pom.xml b/maven-plugin-plugin/src/it/annotation-with-inheritance-reactor/module-mojo/pom.xml
@@ -47,6 +47,7 @@ under the License.
         <version>@project.version@</version>
         <configuration>
           <skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
+          <goalPrefix>prefix</goalPrefix>
         </configuration>
         <executions>
           <execution>

diff --git a/maven-plugin-plugin/src/it/annotation-with-inheritance/pom.xml b/maven-plugin-plugin/src/it/annotation-with-inheritance/pom.xml
@@ -87,6 +87,7 @@ under the License.
         <version>@project.version@</version>
         <configuration>
           <skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
+          <goalPrefix>prefix</goalPrefix>
         </configuration>
         <executions>
           <execution>

diff --git a/maven-plugin-plugin/src/it/ant-basic/pom.xml b/maven-plugin-plugin/src/it/ant-basic/pom.xml
@@ -54,7 +54,7 @@
         <artifactId>maven-plugin-plugin</artifactId>
         <version>${pluginPluginVersion}</version>
         <configuration>
-          <prefix>antBasic</prefix>
+          <goalPrefix>antBasic</goalPrefix>
         </configuration>
         <dependencies>
           <dependency>

diff --git a/maven-plugin-plugin/src/it/ant-simple-usage/plugin/pom.xml b/maven-plugin-plugin/src/it/ant-simple-usage/plugin/pom.xml
@@ -54,7 +54,7 @@
         <artifactId>maven-plugin-plugin</artifactId>
         <version>${pluginPluginVersion}</version>
         <configuration>
-          <prefix>antSimpleUsage</prefix>
+          <goalPrefix>antSimpleUsage</goalPrefix>
         </configuration>
         <dependencies>
           <dependency>

diff --git a/maven-plugin-plugin/src/it/ant-since-maven-plugin/pom.xml b/maven-plugin-plugin/src/it/ant-since-maven-plugin/pom.xml
@@ -42,6 +42,9 @@
             <version>@project.version@</version>
           </dependency>
         </dependencies>
+        <configuration>
+          <goalPrefix>prefix</goalPrefix>
+        </configuration>
       </plugin>
     </plugins>
   </build>

diff --git a/maven-plugin-plugin/src/it/asm-failure/pom.xml b/maven-plugin-plugin/src/it/asm-failure/pom.xml
@@ -43,6 +43,9 @@
       <plugin>
         <artifactId>maven-plugin-plugin</artifactId>
         <version>@project.version@</version>
+        <configuration>
+          <goalPrefix>prefix</goalPrefix>
+        </configuration>
       </plugin>
     </plugins>
   </build>

diff --git a/maven-plugin-plugin/src/it/beanshell-simple/pom.xml b/maven-plugin-plugin/src/it/beanshell-simple/pom.xml
@@ -53,7 +53,7 @@
         <artifactId>maven-plugin-plugin</artifactId>
         <version>${pluginPluginVersion}</version>
         <configuration>
-          <prefix>beanshellBasic</prefix>
+          <goalPrefix>beanshellBasic</goalPrefix>
         </configuration>
         <dependencies>
           <dependency>

diff --git a/maven-plugin-plugin/src/it/help-basic-deprecated-annotation-only/pom.xml b/maven-plugin-plugin/src/it/help-basic-deprecated-annotation-only/pom.xml
@@ -65,6 +65,9 @@ under the License.
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-plugin-plugin</artifactId>
         <version>@project.version@</version>
+        <configuration>
+          <goalPrefix>help-deprecated-annotation-only</goalPrefix>
+        </configuration>
         <executions>
           <execution>
             <id>help-goal</id>

diff --git a/maven-plugin-plugin/src/it/help-basic-jdk11/pom.xml b/maven-plugin-plugin/src/it/help-basic-jdk11/pom.xml
@@ -70,6 +70,9 @@ under the License.
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-plugin-plugin</artifactId>
         <version>@project.version@</version>
+        <configuration>
+          <goalPrefix>help-jdk11</goalPrefix>
+        </configuration>
         <executions>
           <execution>
             <id>default-descriptor</id>

diff --git a/maven-plugin-plugin/src/it/help-basic/pom.xml b/maven-plugin-plugin/src/it/help-basic/pom.xml
@@ -65,6 +65,9 @@ under the License.
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-plugin-plugin</artifactId>
         <version>@project.version@</version>
+        <configuration>
+          <goalPrefix>help</goalPrefix>
+        </configuration>
         <executions>
           <execution>
             <id>default-descriptor</id>

diff --git a/maven-plugin-plugin/src/it/help-package/pom.xml b/maven-plugin-plugin/src/it/help-package/pom.xml
@@ -61,6 +61,7 @@ under the License.
         <version>@project.version@</version>
         <configuration>
           <helpPackageName>test.help</helpPackageName>
+          <goalPrefix>prefix</goalPrefix>
         </configuration>
         <executions>
           <execution>

diff --git a/maven-plugin-plugin/src/it/ignore-plugin-class-realm/pom.xml b/maven-plugin-plugin/src/it/ignore-plugin-class-realm/pom.xml
@@ -55,6 +55,9 @@ under the License.
               <groupId>org.apache.maven.plugins</groupId>
               <artifactId>maven-plugin-plugin</artifactId>
               <version>@project.version@</version>
+              <configuration>
+                <goalPrefix>prefix</goalPrefix>
+              </configuration>
             </plugin>
           </plugins>
         </pluginManagement>

diff --git a/maven-plugin-plugin/src/it/ignore-plugin-class-realm/test/pom.xml b/maven-plugin-plugin/src/it/ignore-plugin-class-realm/test/pom.xml
@@ -54,6 +54,9 @@ under the License.
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-plugin-plugin</artifactId>
+        <configuration>
+          <goalPrefix>prefix</goalPrefix>
+        </configuration>
         <dependencies>
           <dependency>
             <groupId>org.apache.maven.its.plugin</groupId>

diff --git a/maven-plugin-plugin/src/it/java-basic-annotations-jdk8/pom.xml b/maven-plugin-plugin/src/it/java-basic-annotations-jdk8/pom.xml
@@ -84,6 +84,7 @@ under the License.
         <version>@project.version@</version>
         <configuration>
           <skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
+          <goalPrefix>prefix</goalPrefix>
         </configuration>
         <executions>
           <execution>

diff --git a/maven-plugin-plugin/src/it/java-basic-annotations-jdkcurrent/pom.xml b/maven-plugin-plugin/src/it/java-basic-annotations-jdkcurrent/pom.xml
@@ -79,6 +79,7 @@ under the License.
         <version>@project.version@</version>
         <configuration>
           <skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
+          <goalPrefix>prefix</goalPrefix>
         </configuration>
         <executions>
           <execution>

diff --git a/maven-plugin-plugin/src/it/java-basic-annotations/pom.xml b/maven-plugin-plugin/src/it/java-basic-annotations/pom.xml
@@ -81,6 +81,7 @@ under the License.
         <version>@project.version@</version>
         <configuration>
           <skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
+          <goalPrefix>prefix</goalPrefix>
         </configuration>
         <executions>
           <execution>

diff --git a/maven-plugin-plugin/src/it/java-basic/pom.xml b/maven-plugin-plugin/src/it/java-basic/pom.xml
@@ -59,6 +59,9 @@ under the License.
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-plugin-plugin</artifactId>
         <version>@project.version@</version>
+        <configuration>
+          <goalPrefix>prefix</goalPrefix>
+        </configuration>
       </plugin>
     </plugins>
   </build>

diff --git a/maven-plugin-plugin/src/it/mplugin-223/pom.xml b/maven-plugin-plugin/src/it/mplugin-223/pom.xml
@@ -64,6 +64,7 @@
             <extractor>java-annotations</extractor>
           </extractors>
           <skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
+          <goalPrefix>prefix</goalPrefix>
         </configuration>
         <executions>
           <execution>

diff --git a/maven-plugin-plugin/src/it/mplugin-272_java8/pom.xml b/maven-plugin-plugin/src/it/mplugin-272_java8/pom.xml
@@ -68,6 +68,7 @@
               <goal>descriptor</goal>
             </goals>
             <configuration>
+              <goalPrefix>prefix</goalPrefix>
             </configuration>
             <phase>process-classes</phase>
           </execution>

diff --git a/maven-plugin-plugin/src/it/mplugin-299_no-configuration/pom.xml b/maven-plugin-plugin/src/it/mplugin-299_no-configuration/pom.xml
@@ -65,6 +65,9 @@ under the License.
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-plugin-plugin</artifactId>
         <version>@project.version@</version>
+        <configuration>
+          <goalPrefix>prefix</goalPrefix>
+        </configuration>
         <executions>
           <execution>
             <id>default-descriptor</id>

diff --git a/maven-plugin-plugin/src/it/mplugin-305_defaultMojoDependencies/pom.xml b/maven-plugin-plugin/src/it/mplugin-305_defaultMojoDependencies/pom.xml
@@ -68,6 +68,7 @@
             <extractor>java-annotations</extractor>
           </extractors>
           <skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
+          <goalPrefix>prefix</goalPrefix>
         </configuration>
         <executions>
           <execution>

diff --git a/maven-plugin-plugin/src/it/mplugin-305_emptyMojoDependencies/pom.xml b/maven-plugin-plugin/src/it/mplugin-305_emptyMojoDependencies/pom.xml
@@ -68,6 +68,7 @@
             <extractor>java-annotations</extractor>
           </extractors>
           <skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
+          <goalPrefix>prefix</goalPrefix>
         </configuration>
         <executions>
           <execution>

diff --git a/maven-plugin-plugin/src/it/mplugin-305_singleMojoDependencies/pom.xml b/maven-plugin-plugin/src/it/mplugin-305_singleMojoDependencies/pom.xml
@@ -71,6 +71,7 @@
           <mojoDependencies>
             <mojoDependency>org.apache.maven.surefire:maven-surefire-common</mojoDependency>
           </mojoDependencies>
+          <goalPrefix>prefix</goalPrefix>
         </configuration>
         <executions>
           <execution>

diff --git a/maven-plugin-plugin/src/it/mplugin-324_javadoc/pom.xml b/maven-plugin-plugin/src/it/mplugin-324_javadoc/pom.xml
@@ -73,6 +73,9 @@ under the License.
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-plugin-plugin</artifactId>
         <version>@project.version@</version>
+        <configuration>
+          <goalPrefix>prefix</goalPrefix>
+        </configuration>
         <executions>
           <execution>
             <id>default-descriptor</id>

diff --git a/maven-plugin-plugin/src/it/mplugin-363_help-reproducible/pom.xml b/maven-plugin-plugin/src/it/mplugin-363_help-reproducible/pom.xml
@@ -65,6 +65,9 @@ under the License.
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-plugin-plugin</artifactId>
         <version>@project.version@</version>
+        <configuration>
+          <goalPrefix>prefix</goalPrefix>
+        </configuration>
         <executions>
           <execution>
             <id>help-goal</id>

diff --git a/maven-plugin-plugin/src/it/mplugin-370-maven-deps-scope-bad/pom.xml b/maven-plugin-plugin/src/it/mplugin-370-maven-deps-scope-bad/pom.xml
@@ -73,6 +73,7 @@ under the License.
         <version>@project.version@</version>
         <configuration>
           <skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
+          <goalPrefix>prefix</goalPrefix>
         </configuration>
         <executions>
           <execution>

diff --git a/maven-plugin-plugin/src/it/mplugin-370-maven-deps-scope-good/pom.xml b/maven-plugin-plugin/src/it/mplugin-370-maven-deps-scope-good/pom.xml
@@ -79,6 +79,7 @@ under the License.
         <version>@project.version@</version>
         <configuration>
           <skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
+          <goalPrefix>prefix</goalPrefix>
         </configuration>
         <executions>
           <execution>

diff --git a/...n-plugin-plugin/src/it/mplugin-372-annotation-with-inheritance-from-provided-deps/pom.xml b/...n-plugin-plugin/src/it/mplugin-372-annotation-with-inheritance-from-provided-deps/pom.xml
@@ -94,6 +94,7 @@ under the License.
         <version>@project.version@</version>
         <configuration>
           <skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
+          <goalPrefix>prefix</goalPrefix>
         </configuration>
         <executions>
           <execution>

diff --git a/maven-plugin-plugin/src/it/mplugin-382-exclude-provided-dependency/pom.xml b/maven-plugin-plugin/src/it/mplugin-382-exclude-provided-dependency/pom.xml
@@ -87,6 +87,9 @@ under the License.
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-plugin-plugin</artifactId>
         <version>@project.version@</version>
+        <configuration>
+          <goalPrefix>prefix</goalPrefix>
+        </configuration>
       </plugin>
     </plugins>
 

diff --git a/maven-plugin-plugin/src/it/mplugin-390/pom.xml b/maven-plugin-plugin/src/it/mplugin-390/pom.xml
@@ -107,6 +107,9 @@ under the License.
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-plugin-plugin</artifactId>
         <version>@project.version@</version>
+        <configuration>
+          <goalPrefix>prefix</goalPrefix>
+        </configuration>
       </plugin>
     </plugins>
 

diff --git a/maven-plugin-plugin/src/it/packaging-jar/pom.xml b/maven-plugin-plugin/src/it/packaging-jar/pom.xml
@@ -72,6 +72,7 @@ under the License.
           <packagingTypes>
             <packaging>jar</packaging>
           </packagingTypes>
+          <goalPrefix>prefix</goalPrefix>
         </configuration>
         <executions>
           <execution>

diff --git a/maven-plugin-plugin/src/it/skip/pom.xml b/maven-plugin-plugin/src/it/skip/pom.xml
@@ -50,6 +50,9 @@ under the License.
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-plugin-plugin</artifactId>
         <version>@project.version@</version>
+        <configuration>
+          <goalPrefix>prefix</goalPrefix>
+        </configuration>
       </plugin>
     </plugins>
   </build>

diff --git a/maven-plugin-plugin/src/it/source-encoding/latin-1/pom.xml b/maven-plugin-plugin/src/it/source-encoding/latin-1/pom.xml
@@ -61,6 +61,9 @@ under the License.
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-plugin-plugin</artifactId>
         <version>@project.version@</version>
+        <configuration>
+          <goalPrefix>prefix</goalPrefix>
+        </configuration>
       </plugin>
     </plugins>
   </build>

diff --git a/maven-plugin-plugin/src/it/source-encoding/utf-8/pom.xml b/maven-plugin-plugin/src/it/source-encoding/utf-8/pom.xml
@@ -61,6 +61,9 @@ under the License.
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-plugin-plugin</artifactId>
         <version>@project.version@</version>
+        <configuration>
+          <goalPrefix>prefix</goalPrefix>
+        </configuration>
       </plugin>
     </plugins>
   </build>

diff --git a/maven-plugin-plugin/src/it/v4api/pom.xml b/maven-plugin-plugin/src/it/v4api/pom.xml
@@ -64,6 +64,9 @@ under the License.
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-plugin-plugin</artifactId>
         <version>@project.version@</version>
+        <configuration>
+          <goalPrefix>prefix</goalPrefix>
+        </configuration>
         <executions>
           <execution>
             <id>help-goal</id>

diff --git a/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/AbstractGeneratorMojo.java b/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/AbstractGeneratorMojo.java
@@ -23,7 +23,6 @@
 
 import org.apache.maven.plugin.AbstractMojo;
 import org.apache.maven.plugin.MojoExecutionException;
-import org.apache.maven.plugin.descriptor.PluginDescriptor;
 import org.apache.maven.plugins.annotations.Parameter;
 import org.apache.maven.project.MavenProject;
 
@@ -81,28 +80,24 @@ public void execute() throws MojoExecutionException {
             return;
         }
 
-        String defaultGoalPrefix = getDefaultGoalPrefix(project);
-
-        if (goalPrefix == null) {
-            goalPrefix = defaultGoalPrefix;
-        } else if (!goalPrefix.equals(defaultGoalPrefix)) {
-            getLog().warn(LS + LS + "Goal prefix is specified as: '" + goalPrefix + "'. "
-                    + "Maven currently expects it to be '" + defaultGoalPrefix + "'." + LS);
+        if (goalPrefix == null || goalPrefix.isEmpty()) {
+            goalPrefix = getDefaultGoalPrefix(project);
+        }
+        if (goalPrefix == null || goalPrefix.isEmpty()) {
+            throw new MojoExecutionException("You need to specify a goalPrefix as it can not be correctly computed");
         }
 
         generate();
     }
 
     static String getDefaultGoalPrefix(MavenProject project) {
-        String defaultGoalPrefix;
-        if ("maven-plugin-report-plugin".equalsIgnoreCase(project.getArtifactId())) {
-            defaultGoalPrefix = "plugin-report";
-        } else if ("maven-plugin".equalsIgnoreCase(project.getArtifactId())) {
-            defaultGoalPrefix =
-                    project.getGroupId().substring(project.getGroupId().lastIndexOf('.') + 1);
+        String artifactId = project.getArtifactId();
+        if (artifactId.endsWith("-maven-plugin")) {
+            return artifactId.substring(0, artifactId.length() - "-maven-plugin".length());
+        } else if (artifactId.startsWith("maven-") && artifactId.endsWith("-plugin")) {
+            return artifactId.substring("maven-".length(), artifactId.length() - "-plugin".length());
         } else {
-            defaultGoalPrefix = PluginDescriptor.getGoalPrefixFromArtifactId(project.getArtifactId());
+            return null;
         }
-        return defaultGoalPrefix;
     }
 }
diff --git a/...ugin-plugin/src/test/java/org/apache/maven/plugin/plugin/DescriptorGeneratorMojoTest.java b/...ugin-plugin/src/test/java/org/apache/maven/plugin/plugin/DescriptorGeneratorMojoTest.java
@@ -36,10 +36,7 @@ public static Stream<Arguments> goalPrefixes() {
                 arguments(null, "maven-plugin-plugin", "plugin"),
                 arguments(null, "maven-plugin-report-plugin", "plugin-report"),
                 arguments(null, "maven-default-plugin", "default"),
-                arguments(null, "default-maven-plugin", "default"),
-                arguments(null, "default-maven-plugin", "default"),
-                arguments("foo.bar", "maven-plugin", "bar"),
-                arguments("foo", "maven-plugin", "foo"));
+                arguments(null, "default-maven-plugin", "default"));
     }
 
     @ParameterizedTest

diff --git a/maven-plugin-report-plugin/src/it/mplugin-191/pom.xml b/maven-plugin-report-plugin/src/it/mplugin-191/pom.xml
@@ -61,6 +61,7 @@ under the License.
         <version>@project.version@</version>
         <configuration>
           <skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
+          <goalPrefix>prefix</goalPrefix>
         </configuration>
       </plugin>
       <plugin>