Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 3 commits into from
Dec 25, 2023
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0b27ea3
[MPLUGIN-450] Require goalPrefix to be valid
gnodet Nov 10, 2023
83341d4
Fix ITs
gnodet Nov 14, 2023
539fc8a
Fix m-plugin-report-p ITs
gnodet Nov 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions maven-plugin-plugin/src/it/annotation-with-inheritance-from-deps/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ under the License.
<version>@project.version@</version>
<configuration>
<skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
<goalPrefix>prefix</goalPrefix>
</configuration>
<executions>
<execution>
Expand Down
1 change: 1 addition & 0 deletions maven-plugin-plugin/src/it/annotation-with-inheritance-reactor/module-mojo/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ under the License.
<version>@project.version@</version>
<configuration>
<skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
<goalPrefix>prefix</goalPrefix>
</configuration>
<executions>
<execution>
Expand Down
1 change: 1 addition & 0 deletions maven-plugin-plugin/src/it/annotation-with-inheritance/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ under the License.
<version>@project.version@</version>
<configuration>
<skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
<goalPrefix>prefix</goalPrefix>
</configuration>
<executions>
<execution>
Expand Down
2 changes: 1 addition & 1 deletion maven-plugin-plugin/src/it/ant-basic/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
<artifactId>maven-plugin-plugin</artifactId>
<version>${pluginPluginVersion}</version>
<configuration>
<prefix>antBasic</prefix>
<goalPrefix>antBasic</goalPrefix>
</configuration>
<dependencies>
<dependency>
Expand Down
2 changes: 1 addition & 1 deletion maven-plugin-plugin/src/it/ant-simple-usage/plugin/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
<artifactId>maven-plugin-plugin</artifactId>
<version>${pluginPluginVersion}</version>
<configuration>
<prefix>antSimpleUsage</prefix>
<goalPrefix>antSimpleUsage</goalPrefix>
</configuration>
<dependencies>
<dependency>
Expand Down
3 changes: 3 additions & 0 deletions maven-plugin-plugin/src/it/ant-since-maven-plugin/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@
<version>@project.version@</version>
</dependency>
</dependencies>
<configuration>
<goalPrefix>prefix</goalPrefix>
</configuration>
</plugin>
</plugins>
</build>
Expand Down
3 changes: 3 additions & 0 deletions maven-plugin-plugin/src/it/asm-failure/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@
<plugin>
<artifactId>maven-plugin-plugin</artifactId>
<version>@project.version@</version>
<configuration>
<goalPrefix>prefix</goalPrefix>
</configuration>
</plugin>
</plugins>
</build>
Expand Down
2 changes: 1 addition & 1 deletion maven-plugin-plugin/src/it/beanshell-simple/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<artifactId>maven-plugin-plugin</artifactId>
<version>${pluginPluginVersion}</version>
<configuration>
<prefix>beanshellBasic</prefix>
<goalPrefix>beanshellBasic</goalPrefix>
</configuration>
<dependencies>
<dependency>
Expand Down
3 changes: 3 additions & 0 deletions maven-plugin-plugin/src/it/help-basic-deprecated-annotation-only/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
3 changes: 3 additions & 0 deletions maven-plugin-plugin/src/it/help-basic-jdk11/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
3 changes: 3 additions & 0 deletions maven-plugin-plugin/src/it/help-basic/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
1 change: 1 addition & 0 deletions maven-plugin-plugin/src/it/help-package/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ under the License.
<version>@project.version@</version>
<configuration>
<helpPackageName>test.help</helpPackageName>
<goalPrefix>prefix</goalPrefix>
</configuration>
<executions>
<execution>
Expand Down
3 changes: 3 additions & 0 deletions maven-plugin-plugin/src/it/ignore-plugin-class-realm/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
3 changes: 3 additions & 0 deletions maven-plugin-plugin/src/it/ignore-plugin-class-realm/test/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
1 change: 1 addition & 0 deletions maven-plugin-plugin/src/it/java-basic-annotations-jdk8/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ under the License.
<version>@project.version@</version>
<configuration>
<skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
<goalPrefix>prefix</goalPrefix>
</configuration>
<executions>
<execution>
Expand Down
1 change: 1 addition & 0 deletions maven-plugin-plugin/src/it/java-basic-annotations-jdkcurrent/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ under the License.
<version>@project.version@</version>
<configuration>
<skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
<goalPrefix>prefix</goalPrefix>
</configuration>
<executions>
<execution>
Expand Down
1 change: 1 addition & 0 deletions maven-plugin-plugin/src/it/java-basic-annotations/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ under the License.
<version>@project.version@</version>
<configuration>
<skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
<goalPrefix>prefix</goalPrefix>
</configuration>
<executions>
<execution>
Expand Down
3 changes: 3 additions & 0 deletions maven-plugin-plugin/src/it/java-basic/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
1 change: 1 addition & 0 deletions maven-plugin-plugin/src/it/mplugin-223/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@
<extractor>java-annotations</extractor>
</extractors>
<skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
<goalPrefix>prefix</goalPrefix>
</configuration>
<executions>
<execution>
Expand Down
1 change: 1 addition & 0 deletions maven-plugin-plugin/src/it/mplugin-272_java8/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@
<goal>descriptor</goal>
</goals>
<configuration>
<goalPrefix>prefix</goalPrefix>
</configuration>
<phase>process-classes</phase>
</execution>
Expand Down
3 changes: 3 additions & 0 deletions maven-plugin-plugin/src/it/mplugin-299_no-configuration/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
1 change: 1 addition & 0 deletions maven-plugin-plugin/src/it/mplugin-305_defaultMojoDependencies/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@
<extractor>java-annotations</extractor>
</extractors>
<skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
<goalPrefix>prefix</goalPrefix>
</configuration>
<executions>
<execution>
Expand Down
1 change: 1 addition & 0 deletions maven-plugin-plugin/src/it/mplugin-305_emptyMojoDependencies/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@
<extractor>java-annotations</extractor>
</extractors>
<skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
<goalPrefix>prefix</goalPrefix>
</configuration>
<executions>
<execution>
Expand Down
1 change: 1 addition & 0 deletions maven-plugin-plugin/src/it/mplugin-305_singleMojoDependencies/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@
<mojoDependencies>
<mojoDependency>org.apache.maven.surefire:maven-surefire-common</mojoDependency>
</mojoDependencies>
<goalPrefix>prefix</goalPrefix>
</configuration>
<executions>
<execution>
Expand Down
3 changes: 3 additions & 0 deletions maven-plugin-plugin/src/it/mplugin-324_javadoc/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
3 changes: 3 additions & 0 deletions maven-plugin-plugin/src/it/mplugin-363_help-reproducible/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
1 change: 1 addition & 0 deletions maven-plugin-plugin/src/it/mplugin-370-maven-deps-scope-bad/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ under the License.
<version>@project.version@</version>
<configuration>
<skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
<goalPrefix>prefix</goalPrefix>
</configuration>
<executions>
<execution>
Expand Down
1 change: 1 addition & 0 deletions maven-plugin-plugin/src/it/mplugin-370-maven-deps-scope-good/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ under the License.
<version>@project.version@</version>
<configuration>
<skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
<goalPrefix>prefix</goalPrefix>
</configuration>
<executions>
<execution>
Expand Down
1 change: 1 addition & 0 deletions ...n-plugin-plugin/src/it/mplugin-372-annotation-with-inheritance-from-provided-deps/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ under the License.
<version>@project.version@</version>
<configuration>
<skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
<goalPrefix>prefix</goalPrefix>
</configuration>
<executions>
<execution>
Expand Down
3 changes: 3 additions & 0 deletions maven-plugin-plugin/src/it/mplugin-382-exclude-provided-dependency/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand Down
3 changes: 3 additions & 0 deletions maven-plugin-plugin/src/it/mplugin-390/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand Down
1 change: 1 addition & 0 deletions maven-plugin-plugin/src/it/packaging-jar/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ under the License.
<packagingTypes>
<packaging>jar</packaging>
</packagingTypes>
<goalPrefix>prefix</goalPrefix>
</configuration>
<executions>
<execution>
Expand Down
3 changes: 3 additions & 0 deletions maven-plugin-plugin/src/it/skip/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
3 changes: 3 additions & 0 deletions maven-plugin-plugin/src/it/source-encoding/latin-1/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
3 changes: 3 additions & 0 deletions maven-plugin-plugin/src/it/source-encoding/utf-8/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
3 changes: 3 additions & 0 deletions maven-plugin-plugin/src/it/v4api/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
27 changes: 11 additions & 16 deletions maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/AbstractGeneratorMojo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down Expand Up @@ -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());
michael-o marked this conversation as resolved.
Show resolved Hide resolved
return null;
}
return defaultGoalPrefix;
}
}
5 changes: 1 addition & 4 deletions ...ugin-plugin/src/test/java/org/apache/maven/plugin/plugin/DescriptorGeneratorMojoTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions maven-plugin-report-plugin/src/it/mplugin-191/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ under the License.
<version>@project.version@</version>
<configuration>
<skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
<goalPrefix>prefix</goalPrefix>
</configuration>
</plugin>
<plugin>
Expand Down
Loading