This is an automated email from the ASF dual-hosted git repository.
cstamas pushed a commit to branch maven-3.10.x
in repository https://gitbox.apache.org/repos/asf/maven.git
The following commit(s) were added to refs/heads/maven-3.10.x by this push:
new 847220ea46 Fix recursion detection for custom rootDirectory aliases
(#13891)
847220ea46 is described below
commit 847220ea466118a32ace1a6d3cfa33f9b5beac90
Author: Goutam Adwant <[email protected]>
AuthorDate: Mon Nov 9 03:22:44 2026 -0800
Fix recursion detection for custom rootDirectory aliases (#13891)
Follow-up to #13885, related to #13883. Targets `maven-3.10.x`.
The original shadowing fix is already merged. A custom `rootDirectory` that
refers to `${project.rootDirectory}` or `${pom.rootDirectory}` can still fail
interpolation because the recursion detector treats the custom property and the
built-in expression as the same key.
Track bare `rootDirectory` separately and retain prefix-aware cycle
detection for the other expressions. Tests cover model, user and system
aliases, early model consumers, genuine cycles and tracker reset in both
interpolators.
### Validation
- New regressions fail on unchanged current `maven-3.10.x`.
- `mvn -B -ntp verify`: 1,154 tests reported, 8 skipped, zero failures or
errors.
- Four focused Core IT cases pass with the fix; the explicit-root alias
case fails on the current upstream distribution. [Companion integration
tests](https://github.com/goutamadwant/maven/tree/29cb5e6764418ce6f46734e5cbb7ac57e6191b72/its/core-it-suite/src/test/resources/gh-13883-custom-root-directory).
- Full Core IT suite and hosted CI have not been run.
Following this checklist to help us incorporate your
contribution quickly and easily:
- [x] Your pull request should address just one issue, without pulling in
other changes.
- [x] Write a pull request description that is detailed enough to
understand what the pull request does, how, and why.
- [x] Each commit in the pull request should have a meaningful subject line
and body.
Note that commits might be squashed by a maintainer on merge.
- [x] Write unit tests that match behavioral changes, where the tests fail
if the changes to the runtime are not applied.
This may not always be possible but is a best-practice.
- [x] Run `mvn verify` to make sure basic checks pass.
A more thorough check will be performed on your pull request
automatically.
- [ ] You have run the [Core IT][core-its] successfully.
If your pull request is about ~20 lines of code you don't need to sign an
[Individual Contributor License
Agreement](https://www.apache.org/licenses/icla.pdf) if you are unsure
please ask on the developers list.
To make clear that you license your contribution under
the [Apache License Version 2.0, January
2004](http://www.apache.org/licenses/LICENSE-2.0)
you have to acknowledge this by using the following check-box.
- [x] I hereby declare this contribution to be licensed under the [Apache
License Version 2.0, January 2004](https://www.apache.org/licenses/LICENSE-2.0)
- [ ] I hereby declare that I have filed an [Apache Individual Contributor
License Agreement](https://www.apache.org/licenses/icla.pdf).
---
.../AbstractStringBasedModelInterpolator.java | 68 ++++++-
.../AbstractModelInterpolatorTest.java | 210 +++++++++++++++++++++
2 files changed, 276 insertions(+), 2 deletions(-)
diff --git
a/maven-model-builder/src/main/java/org/apache/maven/model/interpolation/AbstractStringBasedModelInterpolator.java
b/maven-model-builder/src/main/java/org/apache/maven/model/interpolation/AbstractStringBasedModelInterpolator.java
index 2164ceff5c..5bbf3327ef 100644
---
a/maven-model-builder/src/main/java/org/apache/maven/model/interpolation/AbstractStringBasedModelInterpolator.java
+++
b/maven-model-builder/src/main/java/org/apache/maven/model/interpolation/AbstractStringBasedModelInterpolator.java
@@ -38,12 +38,12 @@
import org.codehaus.plexus.interpolation.InterpolationPostProcessor;
import org.codehaus.plexus.interpolation.MapBasedValueSource;
import org.codehaus.plexus.interpolation.ObjectBasedValueSource;
-import org.codehaus.plexus.interpolation.PrefixAwareRecursionInterceptor;
import org.codehaus.plexus.interpolation.PrefixedObjectValueSource;
import org.codehaus.plexus.interpolation.PrefixedValueSourceWrapper;
import org.codehaus.plexus.interpolation.RecursionInterceptor;
import org.codehaus.plexus.interpolation.SingleResponseValueSource;
import org.codehaus.plexus.interpolation.ValueSource;
+import org.codehaus.plexus.interpolation.util.ValueSourceUtils;
/**
* Use a regular expression search to find and resolve expressions within the
POM.
@@ -291,7 +291,71 @@ protected List<? extends InterpolationPostProcessor>
createPostProcessors(
return processors;
}
+ private enum PrefixOnlyExpression {
+ ROOT_DIRECTORY("rootDirectory"),
+ BASE_URI("baseUri");
+
+ private final String expression;
+
+ PrefixOnlyExpression(String expression) {
+ this.expression = expression;
+ }
+
+ @Override
+ public String toString() {
+ return "project." + expression;
+ }
+ }
+
protected RecursionInterceptor createRecursionInterceptor() {
- return new PrefixAwareRecursionInterceptor(PROJECT_PREFIXES);
+ return new RecursionInterceptor() {
+ private final List<Object> expressions = new ArrayList<>();
+
+ private Object key(String expression) {
+ String naked = ValueSourceUtils.trimPrefix(expression,
PROJECT_PREFIXES, true);
+ // Built-in keys must also be distinct from custom names with
repeated project prefixes.
+ if (!naked.equals(expression)) {
+ if ("rootDirectory".equals(naked)) {
+ return PrefixOnlyExpression.ROOT_DIRECTORY;
+ }
+ if ("baseUri".equals(naked)) {
+ return PrefixOnlyExpression.BASE_URI;
+ }
+ }
+ return naked;
+ }
+
+ @Override
+ public void expressionResolutionStarted(String expression) {
+ expressions.add(key(expression));
+ }
+
+ @Override
+ public void expressionResolutionFinished(String expression) {
+ expressions.remove(expressions.size() - 1);
+ }
+
+ @Override
+ public boolean hasRecursiveExpression(String expression) {
+ return expressions.contains(key(expression));
+ }
+
+ @Override
+ public List<?> getExpressionCycle(String expression) {
+ int idx = expressions.indexOf(key(expression));
+ List<String> cycle = new ArrayList<>();
+ if (idx >= 0) {
+ for (Object key : expressions.subList(idx,
expressions.size())) {
+ cycle.add(key.toString());
+ }
+ }
+ return cycle;
+ }
+
+ @Override
+ public void clear() {
+ expressions.clear();
+ }
+ };
}
}
diff --git
a/maven-model-builder/src/test/java/org/apache/maven/model/interpolation/AbstractModelInterpolatorTest.java
b/maven-model-builder/src/test/java/org/apache/maven/model/interpolation/AbstractModelInterpolatorTest.java
index 1fe423dbed..c482ac1c88 100644
---
a/maven-model-builder/src/test/java/org/apache/maven/model/interpolation/AbstractModelInterpolatorTest.java
+++
b/maven-model-builder/src/test/java/org/apache/maven/model/interpolation/AbstractModelInterpolatorTest.java
@@ -19,9 +19,12 @@
package org.apache.maven.model.interpolation;
import java.io.File;
+import java.nio.file.Files;
import java.nio.file.Path;
import java.text.SimpleDateFormat;
+import java.util.Arrays;
import java.util.Calendar;
+import java.util.Collections;
import java.util.Date;
import java.util.Iterator;
import java.util.List;
@@ -31,22 +34,32 @@
import org.apache.maven.model.Build;
import org.apache.maven.model.Dependency;
+import org.apache.maven.model.DistributionManagement;
import org.apache.maven.model.Model;
import org.apache.maven.model.Organization;
import org.apache.maven.model.Plugin;
import org.apache.maven.model.Repository;
import org.apache.maven.model.Resource;
import org.apache.maven.model.Scm;
+import org.apache.maven.model.Site;
import org.apache.maven.model.building.DefaultModelBuildingRequest;
import org.apache.maven.model.building.ModelBuildingRequest;
import org.apache.maven.model.building.SimpleProblemCollector;
import org.apache.maven.model.path.PathTranslator;
import org.apache.maven.model.root.DefaultRootLocator;
+import org.codehaus.plexus.interpolation.InterpolationException;
+import org.codehaus.plexus.interpolation.MapBasedValueSource;
+import org.codehaus.plexus.interpolation.RecursionInterceptor;
+import org.codehaus.plexus.interpolation.StringSearchInterpolator;
import org.codehaus.plexus.util.xml.Xpp3Dom;
import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertTrue;
/**
* @author jdcasey
@@ -425,6 +438,203 @@ public void
testUnprefixedRootDirectoryIsNotInterpolated() throws Exception {
assertEquals("${rootDirectory}/temp-repo",
out.getRepositories().get(0).getUrl());
}
+ @Test
+ public void testRootDirectoryAliases(@TempDir Path directory) throws
Exception {
+ for (String prefix : new String[] {"project.", "pom."}) {
+ for (String source : new String[] {"model", "user", "system"}) {
+ Path root = Files.createDirectory(directory.resolve(prefix +
source));
+ Model model = new Model();
+ ModelBuildingRequest request = new
DefaultModelBuildingRequest();
+ Properties properties = "model".equals(source)
+ ? model.getProperties()
+ : "user".equals(source) ? request.getUserProperties()
: request.getSystemProperties();
+ properties.setProperty("rootDirectory", "${" + prefix +
"rootDirectory}");
+
+ assertRootDirectoryInterpolation(root, model, request);
+ }
+ }
+ }
+
+ @Test
+ public void testRootDirectoryCycleIsDetected() throws Exception {
+ Model model = new Model();
+ model.setName("${rootDirectory}");
+ model.getProperties().setProperty("rootDirectory", "${other}");
+ model.getProperties().setProperty("other", "${rootDirectory}");
+ SimpleProblemCollector collector = new SimpleProblemCollector();
+
+ createInterpolator().interpolateModel(model, null, new
DefaultModelBuildingRequest(), collector);
+
+ assertFalse(collector.getErrors().isEmpty());
+ }
+
+ @Test
+ public void testBaseUriAlias(@TempDir Path directory) throws Exception {
+ for (String prefix : new String[] {"project.", "pom."}) {
+ for (String source : new String[] {"model", "user", "system"}) {
+ Model model = new Model();
+ ModelBuildingRequest request = new
DefaultModelBuildingRequest();
+ Properties properties = "model".equals(source)
+ ? model.getProperties()
+ : "user".equals(source) ? request.getUserProperties()
: request.getSystemProperties();
+ properties.setProperty("baseUri", "${" + prefix + "baseUri}");
+ model.getProperties().setProperty("customBase", "${baseUri}");
+ model.setName("${baseUri}");
+ Site site = new Site();
+ site.setName("${baseUri}");
+ DistributionManagement distributionManagement = new
DistributionManagement();
+ distributionManagement.setSite(site);
+ model.setDistributionManagement(distributionManagement);
+ SimpleProblemCollector collector = new
SimpleProblemCollector();
+
+ Model out = createInterpolator().interpolateModel(model,
directory.toFile(), request, collector);
+
+ assertProblemFree(collector);
+ String expected = directory.toUri().toASCIIString();
+ assertEquals(expected, out.getName());
+ assertEquals(expected,
out.getProperties().getProperty("customBase"));
+ assertEquals(expected,
out.getDistributionManagement().getSite().getName());
+ }
+ }
+ }
+
+ @Test
+ public void testNestedProjectPrefixCustomProperties(@TempDir Path
directory) throws Exception {
+ Files.createDirectory(directory.resolve(".mvn"));
+ for (String expression : new String[] {"rootDirectory", "baseUri"}) {
+ for (String prefix : new String[] {"project.project.",
"pom.project.", "project.pom.", "pom.pom."}) {
+ for (String source : new String[] {"model", "user", "system"})
{
+ Model model = new Model();
+ ModelBuildingRequest request = new
DefaultModelBuildingRequest();
+ Properties properties = "model".equals(source)
+ ? model.getProperties()
+ : "user".equals(source) ?
request.getUserProperties() : request.getSystemProperties();
+ String property = prefix + expression;
+ properties.setProperty(property, "${project." + expression
+ "}");
+ model.setName("${" + property + "}");
+ AbstractStringBasedModelInterpolator interpolator =
+ (AbstractStringBasedModelInterpolator)
createInterpolator();
+ interpolator.setRootLocator(new DefaultRootLocator());
+ SimpleProblemCollector collector = new
SimpleProblemCollector();
+
+ Model out = interpolator.interpolateModel(model,
directory.toFile(), request, collector);
+
+ assertProblemFree(collector);
+ assertEquals(
+ "rootDirectory".equals(expression)
+ ? directory.toString()
+ : directory.toUri().toASCIIString(),
+ out.getName());
+ }
+ }
+ }
+ }
+
+ @Test
+ public void testRootDirectoryCycleMessage() throws Exception {
+ Model model = new Model();
+ model.setName("${rootDirectory}");
+ model.getProperties().setProperty("rootDirectory", "${other}");
+ model.getProperties().setProperty("other", "${rootDirectory}");
+ SimpleProblemCollector collector = new SimpleProblemCollector();
+
+ createInterpolator().interpolateModel(model, null, new
DefaultModelBuildingRequest(), collector);
+
+ assertTrue(
+ collector.getErrors().stream().anyMatch(e ->
e.contains("[rootDirectory, other]")),
+ () -> collector.getErrors().toString());
+ }
+
+ @Test
+ public void testPrefixOnlyRecursionNamespaces() throws Exception {
+ RecursionInterceptor interceptor =
+ ((AbstractStringBasedModelInterpolator)
createInterpolator()).createRecursionInterceptor();
+ for (String expression : new String[] {"rootDirectory", "baseUri"}) {
+ assertTrue(interceptor.getExpressionCycle(expression).isEmpty());
+ interceptor.expressionResolutionStarted(expression);
+ assertFalse(interceptor.hasRecursiveExpression("project." +
expression));
+ interceptor.expressionResolutionStarted("project." + expression);
+ assertTrue(interceptor.hasRecursiveExpression("pom." +
expression));
+ assertEquals(
+ Arrays.asList(expression, "project." + expression),
interceptor.getExpressionCycle(expression));
+ interceptor.expressionResolutionFinished("project." + expression);
+ assertTrue(interceptor.hasRecursiveExpression(expression));
+ interceptor.expressionResolutionFinished(expression);
+ assertFalse(interceptor.hasRecursiveExpression(expression));
+
+ interceptor.expressionResolutionStarted(expression);
+ interceptor.expressionResolutionStarted("pom." + expression);
+ interceptor.clear();
+ assertFalse(interceptor.hasRecursiveExpression(expression));
+ assertFalse(interceptor.hasRecursiveExpression("project." +
expression));
+ assertTrue(interceptor.getExpressionCycle(expression).isEmpty());
+ }
+ }
+
+ @Test
+ public void testRecursionInterceptorPreservesAliases() throws Exception {
+ RecursionInterceptor interceptor =
+ ((AbstractStringBasedModelInterpolator)
createInterpolator()).createRecursionInterceptor();
+ for (String expression : new String[] {"basedir", "version",
"build.directory", "properties.custom"}) {
+ for (String prefix : new String[] {"", "project.", "pom."}) {
+ interceptor.expressionResolutionStarted(prefix + expression);
+ assertTrue(interceptor.hasRecursiveExpression(expression));
+ assertTrue(interceptor.hasRecursiveExpression("project." +
expression));
+ assertTrue(interceptor.hasRecursiveExpression("pom." +
expression));
+ assertEquals(Collections.singletonList(expression),
interceptor.getExpressionCycle(expression));
+ interceptor.expressionResolutionFinished(prefix + expression);
+ assertFalse(interceptor.hasRecursiveExpression(expression));
+ }
+ }
+ }
+
+ @Test
+ public void testRecursionInterceptorCleanupAfterCycle() throws Exception {
+ RecursionInterceptor interceptor =
+ ((AbstractStringBasedModelInterpolator)
createInterpolator()).createRecursionInterceptor();
+ Properties properties = new Properties();
+ properties.setProperty("rootDirectory", "${other}");
+ properties.setProperty("other", "${rootDirectory}");
+ properties.setProperty("baseUri", "${project.baseUri}");
+ properties.setProperty("project.baseUri", "file:///valid/");
+ StringSearchInterpolator interpolator = new StringSearchInterpolator();
+ interpolator.addValueSource(new MapBasedValueSource(properties));
+
+ assertEquals("file:///valid/", interpolator.interpolate("${baseUri}",
interceptor));
+ assertThrows(InterpolationException.class, () ->
interpolator.interpolate("${rootDirectory}", interceptor));
+ assertFalse(interceptor.hasRecursiveExpression("rootDirectory"));
+ assertFalse(interceptor.hasRecursiveExpression("other"));
+ assertTrue(interceptor.getExpressionCycle("rootDirectory").isEmpty());
+ assertEquals("file:///valid/", interpolator.interpolate("${baseUri}",
interceptor));
+ }
+
+ private void assertRootDirectoryInterpolation(Path root, Model model,
ModelBuildingRequest request)
+ throws Exception {
+ Files.createDirectory(root.resolve(".mvn"));
+ Path child = Files.createDirectory(root.resolve("child"));
+ model.getProperties().setProperty("customRoot", "${rootDirectory}");
+ model.getProperties().setProperty("projectRoot",
"${project.rootDirectory}");
+ model.getProperties().setProperty("pomRoot", "${pom.rootDirectory}");
+ model.setName("${rootDirectory}");
+ Site site = new Site();
+ site.setName("${rootDirectory}");
+ DistributionManagement distributionManagement = new
DistributionManagement();
+ distributionManagement.setSite(site);
+ model.setDistributionManagement(distributionManagement);
+
+ AbstractStringBasedModelInterpolator interpolator =
(AbstractStringBasedModelInterpolator) createInterpolator();
+ interpolator.setRootLocator(new DefaultRootLocator());
+ SimpleProblemCollector collector = new SimpleProblemCollector();
+ Model out = interpolator.interpolateModel(model, child.toFile(),
request, collector);
+
+ assertProblemFree(collector);
+ assertEquals(root.toString(),
out.getProperties().getProperty("customRoot"));
+ assertEquals(root.toString(), out.getName());
+ assertEquals(root.toString(),
out.getDistributionManagement().getSite().getName());
+ assertEquals(root.toString(),
out.getProperties().getProperty("projectRoot"));
+ assertEquals(root.toString(),
out.getProperties().getProperty("pomRoot"));
+ }
+
@Test
public void testEnvars() throws Exception {
Properties context = new Properties();