[MNG-7706] Deprecate 'localRepository' parameter expression by cstamas · Pull Request #1009 · apache/maven

cstamas · 2023-02-21T15:17:51Z

This PR deprecates the 'localRepository' mojo parameter expression, and Core will emit warning if used by any Mojo.

https://issues.apache.org/jira/browse/MNG-7706

cstamas · 2023-02-21T15:45:40Z

Ironically, ITs report this:

Error:  Failures: 
Warning: Tmng5576CdFriendlyVersions.testContinuousDeliveryFriendlyVersionsAreWarningFreeWithBuildConsumer:103->AbstractMavenIntegrationTestCase.assertFalse:703 [WARNING] Parameter 'localRepository' is deprecated core expression; Switch to '${repositorySystemSession}' and get LRM from there instead. ==> expected: <false> but was: <true>
Warning: Tmng5576CdFriendlyVersions.testContinuousDeliveryFriendlyVersionsAreWarningFreeWithoutBuildConsumer:71->AbstractMavenIntegrationTestCase.assertFalse:703 [WARNING] Parameter 'localRepository' is deprecated core expression; Switch to '${repositorySystemSession}' and get LRM from there instead. ==> expected: <false> but was: <true>
[INFO] 
Error:  Tests run: 890, Failures: 2, Errors: 0, Skipped: 84

maven-core/src/main/java/org/apache/maven/plugin/PluginParameterExpressionEvaluator.java

...n-core/src/main/java/org/apache/maven/plugin/internal/DeprecatedCoreExpressionValidator.java

cstamas · 2023-02-22T21:02:16Z

Before this is merged, we need to do something with ITs:

either fix IT plugins, but am afraid that will start unrolling a snow ball of changes
fix the failing 2 IT to be more specific about warning it listens for...

laeubi · 2023-02-23T05:23:14Z

maven-core/src/main/java/org/apache/maven/plugin/PluginParameterExpressionEvaluator.java

 * <tr><td><code>session.*</code></td>         <td>(since Maven 3)</td><td></td></tr>
 * <tr><td><code>localRepository</code></td>   <td></td>
- *                                             <td>{@link MavenSession#getLocalRepository()}</td></tr>
+ *                                             <td>{@link MavenSession#getLocalRepository()} DEPRECATED: Avoid use of {@link org.apache.maven.artifact.repository.ArtifactRepository} type. If you need access to local repository, switch to '${repositorySystemSession}' expression and get LRM from it instead.</td></tr>


I think some Plugin deleopers might have no clue what LRM is, probabbly also give a link to the wiki/jira/... that explains some details.

Updated javadoc, added link to the issue. Issue updated with "how to fix" https://issues.apache.org/jira/browse/MNG-7706

The MNG-7706 deprecates ancient ArtifactRepository type use to get access to local repository, and issues warning as for any other deprecated Mojo parameters. But alas, in ITs the MNG-5576 completely unrelated IT there is an assertion to have WARNING-free log. This IT uses the IT-plugins/IT-plugin-expression EvalMojo, that in turn uses the deprecated `${localRepository}` parameter (but does not use it). Result is, Maven 3.9.1 emits a WARNING about use of deprecated parameter and the IT fails. Further inspection shows, that while EvalMojo injects ArtifactRepository for local repository, there is only one IT that actually uses it, the MNG-4305, but even that one is interested in basedir of the local repository only. So to say, the use of deprecated ArtifactRepository is not needed at all. Fix: * change EvalMojo to not expose in context the localRepository (w/ type ArtifactRepository), but a new expression `localRepositoryBasedir` only, that is injected in non-deprecated way. * adjusted MNG-4305 to use new epxression instead to use object reflection in template to get basedir from ArtifactRepository * This makes the originally failing MNG-5576 pass, as warning due EvalMojo is gone. See https://issues.apache.org/jira/browse/MNG-7706 apache/maven#1009

The MNG-7706 deprecates ancient ArtifactRepository type use to get access to local repository, and issues warning as for any other deprecated Mojo parameters. But alas, in ITs the MNG-5576 completely unrelated IT there is an assertion to have WARNING-free log. This IT uses the IT-plugins/IT-plugin-expression EvalMojo, that in turn uses the deprecated `${localRepository}` parameter (but does not use it). Result is, Maven 3.9.1 emits a WARNING about use of deprecated parameter and the IT fails. Further inspection shows, that while EvalMojo injects ArtifactRepository for local repository, there is only one IT that actually uses it, the MNG-4305, but even that one is interested in basedir of the local repository only. So to say, the use of deprecated ArtifactRepository type is not needed at all. Fix: * change EvalMojo to not expose in context the localRepository (w/ type ArtifactRepository), but a new expression `localRepositoryBasedir` only, that is injected in non-deprecated way (in real life repoSysSession would be injected, but in IT we keep all super-safe and use Object types). * adjusted MNG-4305 to use new epxression instead to use object reflection in template to get basedir from ArtifactRepository * This makes the originally failing MNG-5576 pass, as warning due EvalMojo is gone. See https://issues.apache.org/jira/browse/MNG-7706 apache/maven#1009

This PR deprecates the 'localRepository' mojo parameter expression, and Core will emit warning if used by any Mojo. --- https://issues.apache.org/jira/browse/MNG-7706

) This PR deprecates the 'localRepository' mojo parameter expression, and Core will emit warning if used by any Mojo. --- https://issues.apache.org/jira/browse/MNG-7706

…1012) This PR deprecates the 'localRepository' mojo parameter expression, and Core will emit warning if used by any Mojo. --- https://issues.apache.org/jira/browse/MNG-7706

inad9300 · 2023-03-31T14:06:52Z

In practical terms, what does this mean for people with <localRepository> in their settings.xml? What are we supposed to do now?

cstamas · 2023-03-31T15:20:57Z

As description says "This PR deprecates the 'localRepository' mojo parameter expression". Has nothing to do with settings.xml. Don't mix the two.

cstamas · 2023-03-31T15:27:28Z

Moreover, please use mailing lists for these sort of questions, not old/closed pull requests https://maven.apache.org/mailing-lists.html

inad9300 · 2023-03-31T17:16:44Z

I upgrade to 3.9.x, I see a warning, and I have a single place where I use "localRepository". Maybe make messages more clear, make release notes more clear, and upgrade your communication channels to something more usable.

cstamas · 2023-03-31T17:27:58Z

This is a project maintained by volunteers, hence you can contribute as well! Feel free to produce as many quality patches and other improvements project-wise as you like! We will be glad to review them 😺

cstamas · 2023-03-31T17:43:57Z

Created https://issues.apache.org/jira/browse/MNG-7754

The MNG-7706 deprecates ancient ArtifactRepository type use to get access to local repository, and issues warning as for any other deprecated Mojo parameters. But alas, in ITs the MNG-5576 completely unrelated IT there is an assertion to have WARNING-free log. This IT uses the IT-plugins/IT-plugin-expression EvalMojo, that in turn uses the deprecated `${localRepository}` parameter (but does not use it). Result is, Maven 3.9.1 emits a WARNING about use of deprecated parameter and the IT fails. Further inspection shows, that while EvalMojo injects ArtifactRepository for local repository, there is only one IT that actually uses it, the MNG-4305, but even that one is interested in basedir of the local repository only. So to say, the use of deprecated ArtifactRepository type is not needed at all. Fix: * change EvalMojo to not expose in context the localRepository (w/ type ArtifactRepository), but a new expression `localRepositoryBasedir` only, that is injected in non-deprecated way (in real life repoSysSession would be injected, but in IT we keep all super-safe and use Object types). * adjusted MNG-4305 to use new epxression instead to use object reflection in template to get basedir from ArtifactRepository * This makes the originally failing MNG-5576 pass, as warning due EvalMojo is gone. See https://issues.apache.org/jira/browse/MNG-7706 apache#1009

jira-importer · 2025-07-07T08:19:58Z

Resolve #9271

cstamas requested review from gnodet, michael-o and slawekjaranowski February 21, 2023 15:17

cstamas self-assigned this Feb 21, 2023

slawekjaranowski reviewed Feb 21, 2023

View reviewed changes

maven-core/src/main/java/org/apache/maven/plugin/PluginParameterExpressionEvaluator.java Outdated Show resolved Hide resolved

slawekjaranowski approved these changes Feb 21, 2023

View reviewed changes

slawekjaranowski reviewed Feb 21, 2023

View reviewed changes

...n-core/src/main/java/org/apache/maven/plugin/internal/DeprecatedCoreExpressionValidator.java Outdated Show resolved Hide resolved

slawekjaranowski approved these changes Feb 22, 2023

View reviewed changes

laeubi reviewed Feb 23, 2023

View reviewed changes

cstamas mentioned this pull request Feb 23, 2023

[MNG-7706] Fix for ITs apache/maven-integration-testing#245

Merged

[MNG-7706] Deprecate 'localRepository' parameter expression

f55f5cb

This PR deprecates the 'localRepository' mojo parameter expression, and Core will emit warning if used by any Mojo. --- https://issues.apache.org/jira/browse/MNG-7706

cstamas force-pushed the maven-3.9.x-MNG-7706-deprecate-localRepository-expr branch from b7fc8d8 to f55f5cb Compare February 23, 2023 12:55

cstamas merged commit 95ceb71 into apache:maven-3.9.x Feb 23, 2023

cstamas deleted the maven-3.9.x-MNG-7706-deprecate-localRepository-expr branch February 23, 2023 14:49

cstamas mentioned this pull request Feb 23, 2023

[MNG-7706] Deprecate 'localRepository' parameter expression (#1009) #1012

Merged

gnodet mentioned this pull request May 16, 2023

[MNG-7785] Clean usage of SessionData #1111

Merged

ramiswailem mentioned this pull request May 16, 2023

nbm-maven-plugin uses deprecated "localRepository" expression apache/netbeans-mavenutils-nbm-maven-plugin#96

Closed

gnodet mentioned this pull request May 24, 2023

MNG 7587 3.9.x #1120

Closed

gnodet mentioned this pull request May 29, 2024

Maven 3.9.x should use Maven 3.1 validation in strict mode #1541

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[MNG-7706] Deprecate 'localRepository' parameter expression#1009

[MNG-7706] Deprecate 'localRepository' parameter expression#1009
cstamas merged 1 commit intoapache:maven-3.9.xfrom
cstamas:maven-3.9.x-MNG-7706-deprecate-localRepository-expr

cstamas commented Feb 21, 2023

Uh oh!

cstamas commented Feb 21, 2023

Uh oh!

Uh oh!

Uh oh!

cstamas commented Feb 22, 2023

Uh oh!

laeubi Feb 23, 2023

Uh oh!

cstamas Feb 23, 2023

Uh oh!

inad9300 commented Mar 31, 2023

Uh oh!

cstamas commented Mar 31, 2023

Uh oh!

cstamas commented Mar 31, 2023

Uh oh!

inad9300 commented Mar 31, 2023

Uh oh!

cstamas commented Mar 31, 2023

Uh oh!

cstamas commented Mar 31, 2023

Uh oh!

jira-importer commented Jul 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

cstamas commented Feb 21, 2023

Uh oh!

cstamas commented Feb 21, 2023

Uh oh!

Uh oh!

Uh oh!

cstamas commented Feb 22, 2023

Uh oh!

laeubi Feb 23, 2023

Choose a reason for hiding this comment

Uh oh!

cstamas Feb 23, 2023

Choose a reason for hiding this comment

Uh oh!

inad9300 commented Mar 31, 2023

Uh oh!

cstamas commented Mar 31, 2023

Uh oh!

cstamas commented Mar 31, 2023

Uh oh!

inad9300 commented Mar 31, 2023

Uh oh!

cstamas commented Mar 31, 2023

Uh oh!

cstamas commented Mar 31, 2023

Uh oh!

jira-importer commented Jul 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants