[MNG-5001] @readonly Mojo parameter annotation doesn't work any more

[jira-importer]

Jochen Ehret opened MNG-5001 and commented

In Maven 2.2.1, the @readonly annotation works as described: You can't configure a Mojo parameter in the pom <configuration> section. If you do, the build will fail:

[INFO] Error configuring: test:test-plugin. Reason: ERROR: Cannot override read-only parameter: testParameter in goal: test:dumpParameter

In Maven 3.0.2, the @readonly seems to have no effect:

[INFO] --- test-plugin:0.0.1-SNAPSHOT:dumpParameter (test-exec) @ test-project ---
testParameter: readonly parameter configured in pom

You can reproduce the behaviour with the attached example project. Log outputs for Maven 2.2.1 and 3.0.2 are also attached.

---

Affects: 3.0-alpha-1, 3.0.2

Attachments:

• log-maven-2.2.1.txt (3.25 kB)
• log-maven-3.0.2.txt (5.28 kB)
• pom.xml (1.23 kB)
• readonlytest.zip (3.48 kB)

Issue Links:

• MJAR-264 finalName property can be set and is not immutable
  ("fixes")

• MNG-5463 warn if maven-site-plugin's reportPlugins is configured in POM
  ("fixes")

• MNG-5440 default-value on mojo parameter of type collection or array effectively make parameter read-only

• MNG-5222 Maven 3 no longer logs warnings about deprecated plugin parameters.

• MNG-7464 Warn about using read-only parameters for Mojo in configuration

• MNG-5476 [REGRESSION] @required parameter not being enforced for arrays

Remote Links:

• GitHub Pull Request #240
  

5 votes, 12 watchers

[jira-importer]

Michael Osipov commented

This might introduce side effects and should be moved to 3.7.0.

[jira-importer]

Hervé Boutemy commented

+1 to move fail to 3.7.0
perhaps warn in 3.6.2, no?

[jira-importer]

Hervé Boutemy commented

do we have a core IT that tests this feature?

[jira-importer]

Hervé Boutemy commented

core IT created in https://github.com/apache/maven-integration-testing/tree/MNG-5001

[jira-importer]

Hervé Boutemy commented

attached simpler test to easily do local tests, simply overriding "basedir" readonly parameter of maven-compiler-plugin

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-compiler-plugin</artifactId>
  <version>2.5.1</version>
  <configuration>
    <basedir>trying-to-override-default-value-readonly</basedir>
  </configuration>
</plugin>

run with Maven 2 cause:

[INFO] ------------------------------------------------------------------------
[ERROR] BUILD ERROR
[INFO] ------------------------------------------------------------------------
[INFO] Error configuring: org.apache.maven.plugins:maven-compiler-plugin. Reason: ERROR: Cannot override read-only parameter: basedir in goal: compiler:compile
[INFO] ------------------------------------------------------------------------
[INFO] Trace
org.apache.maven.lifecycle.LifecycleExecutionException: Error configuring: org.apache.maven.plugins:maven-compiler-plugin. Reason: ERROR: Cannot override read-only parameter: basedir in goal: compiler:compile
        at org.apache.maven.lifecycle.DefaultLifecycleExecutor.executeGoals(DefaultLifecycleExecutor.java:723)
[...]

[jira-importer]

Hervé Boutemy commented

using this feature in the wild, I went into an issue when building our website:

[INFO] --------------------< org.apache.maven:maven-site >---------------------
[INFO] Building Apache Maven Site 1.0
[INFO] --------------------------------[ pom ]---------------------------------
[INFO] 
[INFO] --- maven-resources-plugin:3.1.0:copy-resources (copy-filtered-resources) @ maven-site ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] Copying 1 resource
[INFO] 
[INFO] --- maven-site-plugin:3.9.0:site (default-site) @ maven-site ---
[INFO] configuring report plugin org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0
[ERROR] Invalid plugin configuration: Cannot override read-only parameter: 'inputEncoding' in goal 'index'
[ERROR] Invalid plugin configuration: Cannot override read-only parameter: 'outputEncoding' in goal 'index'
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  1.210 s
[INFO] Finished at: 2020-05-21T09:42:26+02:00
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-site-plugin:3.9.0:site (default-site) on project maven-site: failed to get report for org.apache.maven.plugins:maven-project-info-reports-plugin: The parameters 'inputEncoding', 'outputEncoding' for goal org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:index are missing, read-only or invalid -> [Help 1]
org.apache.maven.lifecycle.LifecycleExecutionException: Failed to execute goal org.apache.maven.plugins:maven-site-plugin:3.9.0:site (default-site) on project maven-site: failed to get report for org.apache.maven.plugins:maven-project-info-reports-plugin
[...]

I still don't know how these parameters are found as overridden from default...

[jira-importer]

Hervé Boutemy commented

new unexpected issue when trying to do JXR release:

$ mvn release:prepare -e
[INFO] Error stacktraces are turned on.
[INFO] Scanning for projects...
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Build Order:
[INFO] 
[INFO] Maven JXR Parent                                                   [pom]
[INFO] Maven JXR                                                          [jar]
[INFO] Maven JXR Plugin                                          [maven-plugin]
[INFO] 
[INFO] ----------------------< org.apache.maven.jxr:jxr >----------------------
[INFO] Building Maven JXR Parent 3.1.0-SNAPSHOT                           [1/3]
[INFO] --------------------------------[ pom ]---------------------------------
[INFO] 
[INFO] --- maven-release-plugin:3.0.0-M1:prepare (default-cli) @ jxr ---
[ERROR] Invalid plugin configuration: Cannot override read-only parameter: 'allowReleasePluginSnapshot' in goal 'prepare'
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary for Maven JXR Parent 3.1.0-SNAPSHOT:
[INFO] 
[INFO] Maven JXR Parent ................................... FAILURE [  0.476 s]
[INFO] Maven JXR .......................................... SKIPPED
[INFO] Maven JXR Plugin ................................... SKIPPED
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  0.804 s
[INFO] Finished at: 2020-05-23T16:51:40+02:00
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-release-plugin:3.0.0-M1:prepare (default-cli) on project jxr: The parameters 'allowReleasePluginSnapshot' for goal org.apache.maven.plugins:maven-release-plugin:3.0.0-M1:prepare are missing, read-only or invalid -> [Help 1]
org.apache.maven.lifecycle.LifecycleExecutionException: Failed to execute goal org.apache.maven.plugins:maven-release-plugin:3.0.0-M1:prepare (default-cli) on project jxr: The parameters 'allowReleasePluginSnapshot' for goal org.apache.maven.plugins:maven-release-plugin:3.0.0-M1:prepare are missing, read-only or invalid

[jira-importer]

Robert Scholte commented

This one I know. The release plugin contains a check that its own version is a non-SNAPSHOT to ensure a stable release. However that won't work during integration tests. So this property is a hidden (awkward way of saying read-only) parameter. I was already suprised this worked.
The solution here is probably to that during integration tests the version of the maven-release-plugin should be adjusted to something final (replace SNAPSHOT by ...) during the integrations tests.

[jira-importer]

Hervé Boutemy commented

Robert Scholte does that mean that there should be a MRELEASE Jira issue for maven-release-plugin 3.0.0 and this issue depends on it?

[jira-importer]

Robert Scholte commented

Assuming this approach, it will require changes to maven-invoker too. Another option is to provide a hidden flag to the @Parameter annotation. Maybe there are more solutions.

[jira-importer]

Slawomir Jaranowski commented

After long time - my proposition is to in first step generate warning about it.

In most of case stop using read only params must be consulted with plugin authors. And probably need new version of used plugin.