[MPLUGIN-441] Support for the new maven4 api by gnodet · Pull Request #117 · apache/maven-plugin-tools

gnodet · 2022-07-08T09:58:13Z

JIRA issue: https://issues.apache.org/jira/browse/MPLUGIN-441

This PR includes the following:

raise the minimum JDK to 1.8
provide additional support for the new maven4 api using maven 4.0.0-alpha-2

The plugin still supports maven 3 plugins so is compatible with all the existing plugins.
The new support is provided by the annotation scanner which now supports the new package org.apache.maven.api.plugin in addition to the old one. The main difference is that if the new package is detected, a flag will be set on the mojo descriptor so that maven can know that the mojo is a v4 mojo and behave accordingly.

...java/org/apache/maven/tools/plugin/extractor/annotations/scanner/MojoAnnotationsScanner.java

maven-plugin-tools-generators/src/main/resources/help-class-source.vm

gnodet · 2022-11-10T15:30:51Z

@kwin @slawekjaranowski I've rebased, cleaned up and added an IT. The base maven version has been reverted to 3.2.5 so that the plugin remains fully compatible with 3.x.

pom.xml

maven-plugin-plugin/pom.xml

maven-plugin-plugin/src/it/v4api/pom.xml

slawekjaranowski · 2022-11-10T16:18:55Z

maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/util/PluginUtils.java

+        mavenComponents.put( "org.apache.maven.api.Session", "${session}" );
+        mavenComponents.put( "org.apache.maven.api.Project", "${project}" );
+        mavenComponents.put( "org.apache.maven.api.MojoExecution", "${mojoExecution}" );
+        // TODO: apiv4: add PluginDescriptor to the api ?
+        //mavenComponents.put( "org.apache.maven.api.descriptor.PluginDescriptor", "${plugin}" );
+        mavenComponents.put( "org.apache.maven.api.settings.Settings", "${settings}" );


I'm not sure about it ...

Yeah, I was wondering about that as well. When I added the junit test, I copy/pasted an existing one and made sure it was working correcectly.
However, this is tied to maven itself and the way those parameters/components are injected.
From an API pov, using @Parameter( property = "${session}" ) Session session is not really intuitive, whereas @Component Session session looks simplier.

As I remember @Component Session session is translated to @Parameter( property = "${session}" ) - to check if still needed

Yes, and the map is here to do that. So if I remove the population of the mavenComponents with objects from the v4 api, this won't work anymore. The IT actually tests that.

Also, I don't think the use of @Parameter or @Component should be dictated by the implementation. For example, the maven session is available as both a parameter injected by the plugin manager and a sisu bean inside the @SessionScope. Also @Component relates to the sisu components, but this does not have to be made explicit.
I would personally favor the @Component approach for everything that does not come from the configuration.

gnodet · 2022-11-15T10:44:30Z

@slawekjaranowski are you ok with the current PR ?

maven-plugin-plugin/src/it/settings.xml

maven-plugin-tools-annotations/pom.xml

slawekjaranowski · 2022-11-15T14:45:28Z

one for build log ...

The following dependencies are in wrong scope:
 * org.apache.maven:plexus-utils:jar:4.0.0-alpha-2:compile

maven-plugin-plugin/src/it/v4api/pom.xml

slawekjaranowski · 2022-11-15T16:06:52Z

Trying:

mvn org.apache.maven.its:v4api:1.0-SNAPSHOT:first

Apache Maven 4.0.0-alpha-2 (c07700ffc97d3967a8de77d5a1065f5e6115c00e)

[ERROR] Failed to parse plugin descriptor for org.apache.maven.its:v4api:1.0-SNAPSHOT (/Users/.../.m2/repository/org/apache/maven/its/v4api/1.0-SNAPSHOT/v4api-1.0-SNAPSHOT.jar): JAR entry META-INF/maven/lifecycle.xml not found in /Users/.../.m2/repository/org/apache/maven/its/v4api/1.0-SNAPSHOT/v4api-1.0-SNAPSHOT.jar

mvn org.apache.maven.its:v4api:1.0-SNAPSHOT:first

Apache Maven 3.8.6 (84538c9988a25aec085021c365c560670ad80f63)

[ERROR] Failed to parse plugin descriptor for org.apache.maven.its:v4api:1.0-SNAPSHOT (/Users/.../.m2/repository/org/apache/maven/its/v4api/1.0-SNAPSHOT/v4api-1.0-SNAPSHOT.jar): JAR entry META-INF/maven/lifecycle.xml not found in /Users/.../.m2/repository/org/apache/maven/its/v4api/1.0-SNAPSHOT/v4api-1.0-SNAPSHOT.jar -> [Help 1]

gnodet · 2022-11-15T16:09:20Z

one for build log ...

The following dependencies are in wrong scope:
 * org.apache.maven:plexus-utils:jar:4.0.0-alpha-2:compile

plexus-utils is not provided anymore. I think the plugin is fooled by the org.apache.maven groupid, so I think this is correct. See https://issues.apache.org/jira/browse/MNG-6965

slawekjaranowski · 2022-11-15T16:09:57Z

mvn org.apache.maven.its:v4api:1.0-SNAPSHOT:help
Apache Maven 4.0.0-alpha-2 (c07700ffc97d3967a8de77d5a1065f5e6115c00e)
[INFO] Scanning for projects...
[INFO] 
[INFO] -------------------------------------------< org.apache.maven:standalone-pom >--------------------------------------------
[INFO] Building Maven Stub Project (No POM) 1
[INFO] ---------------------------------------------------------[ pom ]----------------------------------------------------------
[INFO] 
[INFO] --- v4api:1.0-SNAPSHOT:help (default-cli) @ standalone-pom ---
....

hangs forever, stack:

"main" #1 prio=5 os_prio=31 tid=0x00007fa13980c000 nid=0x2103 runnable [0x00007000033e2000]
   java.lang.Thread.State: RUNNABLE
	at java.util.Hashtable.put(Hashtable.java:459)
	- locked <0x0000000715e3fbd8> (a java.util.Properties)
	at java.util.Hashtable.putAll(Hashtable.java:524)
	- locked <0x0000000715e3fbd8> (a java.util.Properties)
	at org.apache.maven.plugin.PluginParameterExpressionEvaluatorV4.<init>(PluginParameterExpressionEvaluatorV4.java:106)
	at org.apache.maven.plugin.internal.DefaultMavenPluginManager.getConfiguredMojo(DefaultMavenPluginManager.java:617)
	at org.apache.maven.plugin.DefaultBuildPluginManager.executeMojo(DefaultBuildPluginManager.java:137)

gnodet · 2022-11-15T16:26:30Z

Trying:

mvn org.apache.maven.its:v4api:1.0-SNAPSHOT:first

Apache Maven 4.0.0-alpha-2 (c07700ffc97d3967a8de77d5a1065f5e6115c00e)

[ERROR] Failed to parse plugin descriptor for org.apache.maven.its:v4api:1.0-SNAPSHOT (/Users/.../.m2/repository/org/apache/maven/its/v4api/1.0-SNAPSHOT/v4api-1.0-SNAPSHOT.jar): JAR entry META-INF/maven/lifecycle.xml not found in /Users/.../.m2/repository/org/apache/maven/its/v4api/1.0-SNAPSHOT/v4api-1.0-SNAPSHOT.jar

mvn org.apache.maven.its:v4api:1.0-SNAPSHOT:first

Apache Maven 3.8.6 (84538c9988a25aec085021c365c560670ad80f63)

[ERROR] Failed to parse plugin descriptor for org.apache.maven.its:v4api:1.0-SNAPSHOT (/Users/.../.m2/repository/org/apache/maven/its/v4api/1.0-SNAPSHOT/v4api-1.0-SNAPSHOT.jar): JAR entry META-INF/maven/lifecycle.xml not found in /Users/.../.m2/repository/org/apache/maven/its/v4api/1.0-SNAPSHOT/v4api-1.0-SNAPSHOT.jar -> [Help 1]

Do we need the plugin to actually run ?
I can either remove the @Execute or add a lifecycle.xml
After that, another error happens because the plugin is being injected with a custom @Component, but there's no such public component in the v4 api. I can also remove the custom component injection. But the IT is testing the plugin.xml generation and not the plugin itself.
Another option is to document that this plugin does not actually work.

gnodet · 2022-11-15T16:27:27Z

one for build log ...
The following dependencies are in wrong scope:
 * org.apache.maven:plexus-utils:jar:4.0.0-alpha-2:compile
plexus-utils is not provided anymore. I think the plugin is fooled by the org.apache.maven groupid, so I think this is correct. See https://issues.apache.org/jira/browse/MNG-6965

I've removed the warning.

gnodet · 2022-11-15T16:35:57Z

mvn org.apache.maven.its:v4api:1.0-SNAPSHOT:help
Apache Maven 4.0.0-alpha-2 (c07700ffc97d3967a8de77d5a1065f5e6115c00e)
[INFO] Scanning for projects...
[INFO] 
[INFO] -------------------------------------------< org.apache.maven:standalone-pom >--------------------------------------------
[INFO] Building Maven Stub Project (No POM) 1
[INFO] ---------------------------------------------------------[ pom ]----------------------------------------------------------
[INFO] 
[INFO] --- v4api:1.0-SNAPSHOT:help (default-cli) @ standalone-pom ---
....

hangs forever, stack:

"main" #1 prio=5 os_prio=31 tid=0x00007fa13980c000 nid=0x2103 runnable [0x00007000033e2000]
   java.lang.Thread.State: RUNNABLE
	at java.util.Hashtable.put(Hashtable.java:459)
	- locked <0x0000000715e3fbd8> (a java.util.Properties)
	at java.util.Hashtable.putAll(Hashtable.java:524)
	- locked <0x0000000715e3fbd8> (a java.util.Properties)
	at org.apache.maven.plugin.PluginParameterExpressionEvaluatorV4.<init>(PluginParameterExpressionEvaluatorV4.java:106)
	at org.apache.maven.plugin.internal.DefaultMavenPluginManager.getConfiguredMojo(DefaultMavenPluginManager.java:617)
	at org.apache.maven.plugin.DefaultBuildPluginManager.executeMojo(DefaultBuildPluginManager.java:137)

This looks like a bug in https://github.com/apache/maven/blob/master/maven-core/src/main/java/org/apache/maven/internal/impl/PropertiesAsMap.java

I've raised https://issues.apache.org/jira/browse/MNG-7597 with maven#872.

slawekjaranowski · 2022-11-15T17:12:15Z

This looks like a bug in https://github.com/apache/maven/blob/master/maven-core/src/main/java/org/apache/maven/internal/impl/PropertiesAsMap.java

Yes - iterator next method always return the same element 😄

slawekjaranowski

As plugin under test is only used for generating descriptor - it is ok for me.

jira-importer · 2025-06-19T01:18:58Z

Resolve #754

gnodet marked this pull request as draft July 8, 2022 11:01

This was referenced Jul 18, 2022

[MINSTALL-187] Switch to the Maven 4 API apache/maven-install-plugin#35

Merged

[MDEPLOY-301] Switch to the Maven 4 API apache/maven-deploy-plugin#27

Merged

gnodet force-pushed the m-api branch 2 times, most recently from 05804d9 to bc87d15 Compare July 22, 2022 09:18

gnodet mentioned this pull request Jul 25, 2022

[MCLEAN-123] Switch to Maven 4 API and the new api apache/maven-clean-plugin#20

Merged

gnodet mentioned this pull request Aug 24, 2022

[MNG-7553] New clean API with immutable model apache/maven#703

Merged

gnodet changed the title ~~Support mojos using the new API~~ Switch to maven 4 and the new api Aug 24, 2022

gnodet changed the title ~~Switch to maven 4 and the new api~~ Switch to maven 4 and the new api Aug 24, 2022

gnodet force-pushed the m-api branch from bac100c to a6b937b Compare September 1, 2022 07:24

gnodet marked this pull request as ready for review September 1, 2022 07:25

gnodet force-pushed the m-api branch from d5e8df5 to 4a4b1f0 Compare October 12, 2022 12:13

gnodet changed the title ~~Switch to maven 4 and the new api~~ [4.x] Switch to maven 4 and the new api Oct 12, 2022

gnodet force-pushed the m-api branch from 4a4b1f0 to 64c492a Compare October 12, 2022 14:56

gnodet changed the title ~~[4.x] Switch to maven 4 and the new api~~ [4.x] Support for the new maven4 api Oct 13, 2022

gnodet mentioned this pull request Oct 19, 2022

[MPLUGIN-419] Allow @Parameter on setters methods #151

Merged

gnodet requested review from kwin and slawekjaranowski October 20, 2022 21:49

kwin reviewed Oct 21, 2022

View reviewed changes

...java/org/apache/maven/tools/plugin/extractor/annotations/scanner/MojoAnnotationsScanner.java Show resolved Hide resolved

gnodet force-pushed the m-api branch 3 times, most recently from 931f8e6 to 4a5998a Compare October 27, 2022 12:09

gnodet requested review from cstamas and kwin October 30, 2022 19:45

slawekjaranowski reviewed Nov 8, 2022

View reviewed changes

maven-plugin-tools-generators/src/main/resources/help-class-source.vm Outdated Show resolved Hide resolved

gnodet force-pushed the m-api branch from 025e16e to c4e2b59 Compare November 10, 2022 06:24

gnodet changed the title ~~[4.x] Support for the new maven4 api~~ [MPLUGIN-441] Support for the new maven4 api Nov 10, 2022

gnodet force-pushed the m-api branch 2 times, most recently from 939348f to 07a5f84 Compare November 10, 2022 13:47

[MPLUGIN-441] Support mojos using the new maven v4 api

b31a929

gnodet force-pushed the m-api branch from 07a5f84 to b31a929 Compare November 10, 2022 15:12

slawekjaranowski reviewed Nov 10, 2022

View reviewed changes

gnodet added 3 commits November 10, 2022 18:22

Cleanup

58e8011

Do not switch to 4.0.0

5f97cb4

Do not reorder groupId/artifactId

a180328

cstamas reviewed Nov 15, 2022

View reviewed changes

maven-plugin-plugin/src/it/settings.xml Show resolved Hide resolved

slawekjaranowski reviewed Nov 15, 2022

View reviewed changes

maven-plugin-tools-annotations/pom.xml Outdated Show resolved Hide resolved

slawekjaranowski reviewed Nov 15, 2022

View reviewed changes

maven-plugin-plugin/src/it/v4api/pom.xml Show resolved Hide resolved

Remove unnecessary plugin definition

b9a91a2

Remove plexus-utils from the list of banned compile time dependencies

9875ca2

Document the mojo to indicate that it can't be actually used

ab48e26

slawekjaranowski approved these changes Nov 15, 2022

View reviewed changes

gnodet added this to the 3.8.0 milestone Nov 15, 2022

gnodet merged commit 50482ba into apache:master Nov 15, 2022

Conversation

gnodet commented Jul 8, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gnodet commented Nov 10, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

slawekjaranowski Nov 10, 2022

Choose a reason for hiding this comment

Uh oh!

gnodet Nov 10, 2022

Choose a reason for hiding this comment

Uh oh!

slawekjaranowski Nov 10, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gnodet Nov 10, 2022

Choose a reason for hiding this comment

Uh oh!

gnodet Nov 10, 2022

Choose a reason for hiding this comment

Uh oh!

cstamas Nov 15, 2022

Choose a reason for hiding this comment

Uh oh!

gnodet commented Nov 15, 2022

Uh oh!

Uh oh!

Uh oh!

slawekjaranowski commented Nov 15, 2022

Uh oh!

Uh oh!

slawekjaranowski commented Nov 15, 2022

Uh oh!

gnodet commented Nov 15, 2022

Uh oh!

slawekjaranowski commented Nov 15, 2022

Uh oh!

gnodet commented Nov 15, 2022

Uh oh!

gnodet commented Nov 15, 2022

Uh oh!

gnodet commented Nov 15, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

slawekjaranowski commented Nov 15, 2022

Uh oh!

slawekjaranowski left a comment

Choose a reason for hiding this comment

Uh oh!

jira-importer commented Jun 19, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

gnodet commented Jul 8, 2022 •

edited

Loading

slawekjaranowski Nov 10, 2022 •

edited

Loading

gnodet commented Nov 15, 2022 •

edited

Loading