This is an automated email from the ASF dual-hosted git repository.
slawekjaranowski 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 b40b50ed67 Fix #13883: Do not shadow a custom rootDirectory property
b40b50ed67 is described below
commit b40b50ed672f2bcd7cea48e5f61ab8f2140dea17
Author: Slawomir Jaranowski <[email protected]>
AuthorDate: Sat Nov 7 21:19:29 2026 +0100
Fix #13883: Do not shadow a custom rootDirectory property
Maven 3.10.0 accepted an unprefixed ${rootDirectory} as an alias for
${project.rootDirectory}. As this value source is evaluated before the model
properties, it shadowed a custom rootDirectory property defined in the POM,
e.g. <rootDirectory>${project.basedir}</rootDirectory>, which then resolved
to the project root directory instead of the module basedir.
Only accept the prefixed ${project.rootDirectory} (and
${pom.rootDirectory}),
as for ${project.baseUri}. The unprefixed form was never documented, and
profile activation already supports the prefixed form only.
Add tests for model interpolation and file-based profile activation, and
document ${project.rootDirectory} for profile activation.
Co-Authored-By: Claude Opus 5.5 <[email protected]>
---
.../AbstractStringBasedModelInterpolator.java | 2 +-
maven-model-builder/src/site/markdown/index.md | 6 +-
.../AbstractModelInterpolatorTest.java | 102 +++++++++++++++++++++
.../activation/FileProfileActivatorTest.java | 33 +++++++
4 files changed, 139 insertions(+), 4 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 2088f8d933..2164ceff5c 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
@@ -171,7 +171,7 @@ public Object getValue(String expression) {
}
},
PROJECT_PREFIXES,
- true);
+ false);
valueSources.add(rootDirectoryValueSource);
ValueSource baseUriValueSource = new PrefixedValueSourceWrapper(
diff --git a/maven-model-builder/src/site/markdown/index.md
b/maven-model-builder/src/site/markdown/index.md
index 817710b544..569826f472 100644
--- a/maven-model-builder/src/site/markdown/index.md
+++ b/maven-model-builder/src/site/markdown/index.md
@@ -33,7 +33,7 @@ The main component is `ModelBuilder`
([javadoc](./apidocs/org/apache/maven/model
The sequence is divided into 2 phases:
- phase 1
- - profile activation: see [available
activators](./apidocs/org/apache/maven/model/profile/activation/package-summary.html).
Notice that model interpolation hasn't happened yet, then interpolation for
file-based activation is limited to `${basedir}` (since Maven 3), system
properties and user properties
+ - profile activation: see [available
activators](./apidocs/org/apache/maven/model/profile/activation/package-summary.html).
Notice that model interpolation hasn't happened yet, then interpolation for
file-based activation is limited to `${basedir}` (since Maven 3),
`${project.rootDirectory}` (since Maven 3.10.0), system properties and user
properties
- raw model validation: `ModelValidator`
([javadoc](./apidocs/org/apache/maven/model/validation/ModelValidator.html)),
with its `DefaultModelValidator` implementation
([source](./xref/org/apache/maven/model/validation/DefaultModelValidator.html))
- model normalization - merge duplicates: `ModelNormalizer`
([javadoc](./apidocs/org/apache/maven/model/normalization/ModelNormalizer.html)),
with its `DefaultModelNormalizer` implementation
([source](./xref/org/apache/maven/model/normalization/DefaultModelNormalizer.html))
- profile injection: `ProfileInjector`
([javadoc](./apidocs/org/apache/maven/model/profile/ProfileInjector.html)),
with its `DefaultProfileInjector` implementation
([source](./xref/org/apache/maven/model/profile/DefaultProfileInjector.html))
@@ -69,7 +69,7 @@ Notice that the 5 URLs from the model (`project.url`,
`project.scm.connection`,
Model Interpolation consists in replacing `${...}` with calculated value. It
is done in `StringSearchModelInterpolator`
([javadoc](./apidocs/org/apache/maven/model/interpolation/StringSearchModelInterpolator.html),
[source](./xref/org/apache/maven/model/interpolation/StringSearchModelInterpolator.html)).
-Notice that model interpolation happens _after_ profile activation, then
profile activation doesn't benefit from every values: interpolation for
file-based activation is limited to `${basedir}` (which was introduced in Maven
3 and is not deprecated in this context), system properties and user properties.
+Notice that model interpolation happens _after_ profile activation, then
profile activation doesn't benefit from every values: interpolation for
file-based activation is limited to `${basedir}` (which was introduced in Maven
3 and is not deprecated in this context) and `${project.rootDirectory}`
(introduced in Maven 3.10.0), system properties and user properties.
Values are evaluated in sequence from different syntaxes:
@@ -77,7 +77,7 @@ Values are evaluated in sequence from different syntaxes:
|:---|:---|:---|
|`project.*` <br />`pom.*` (_deprecated_) <br />`*` (_deprecated_)|POM content
(see [POM reference](../maven-model/maven.html))|`${project.version}` <br
/>`${project.build.finalName}` <br />`${project.artifactId}` <br
/>`${project.build.directory}`|
|`project.basedir` <br />`pom.basedir` (_deprecated_) <br />`basedir`
(_deprecated_)|the directory containing the `pom.xml` file|`${project.basedir}`|
-|`project.rootDirectory`|the project's root directory (containing a `.mvn`
directory)|`${project.rootDirectory}`|
+|`project.rootDirectory`|the project's root directory (containing a `.mvn`
directory) _(since Maven 3.10.0)_|`${project.rootDirectory}`|
|`project.baseUri` <br />`pom.baseUri` (_deprecated_)|the directory containing
the `pom.xml` file as URI|`${project.baseUri}`|
|`build.timestamp` <br />`maven.build.timestamp`|the UTC timestamp of build
start, in `yyyy-MM-dd'T'HH:mm:ss'Z'` default format, which can be overridden
with `maven.build.timestamp.format` POM property|`${maven.build.timestamp}`|
|`*`|user properties, set from CLI with `-Dproperty=value`|`${skipTests}`|
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 ac093f8b94..1fe423dbed 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,11 +19,13 @@
package org.apache.maven.model.interpolation;
import java.io.File;
+import java.nio.file.Path;
import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Date;
import java.util.Iterator;
import java.util.List;
+import java.util.Optional;
import java.util.Properties;
import java.util.TimeZone;
@@ -39,6 +41,7 @@
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.util.xml.Xpp3Dom;
import org.junit.jupiter.api.Test;
@@ -337,6 +340,91 @@ public void testBaseUri() throws Exception {
assertEquals("myBaseUri/temp-repo",
(out.getRepositories().get(0)).getUrl());
}
+ @Test
+ public void testRootDirectory() throws Exception {
+ File rootDirectory = new File("/test/root");
+ File projectDirectory = new File(rootDirectory, "module");
+
+ Model model = new Model();
+ model.setVersion("3.8.1");
+ model.setArtifactId("foo");
+
+ Repository repository = new Repository();
+ repository.setUrl("${project.rootDirectory}/temp-repo");
+ model.addRepository(repository);
+
+ ModelInterpolator interpolator = createInterpolator(rootDirectory);
+
+ final SimpleProblemCollector collector = new SimpleProblemCollector();
+ Model out =
+ interpolator.interpolateModel(model, projectDirectory,
createModelBuildingRequest(context), collector);
+ assertProblemFree(collector);
+
+ assertEquals(
+ rootDirectory.getAbsolutePath() + "/temp-repo",
+ out.getRepositories().get(0).getUrl());
+ }
+
+ @Test
+ public void testCustomRootDirectoryPropertyIsNotShadowed() throws
Exception {
+ // GH-13883: a custom ${rootDirectory} property must not be shadowed
by ${project.rootDirectory}
+ File rootDirectory = new File("/test/root");
+ File projectDirectory = new File(rootDirectory, "module");
+
+ Model model = new Model();
+ model.setVersion("3.8.1");
+ model.setArtifactId("foo");
+ model.addProperty("rootDirectory", "${project.basedir}");
+
+ Repository custom = new Repository();
+ custom.setId("custom");
+ custom.setUrl("${rootDirectory}/temp-repo");
+ model.addRepository(custom);
+
+ Repository project = new Repository();
+ project.setId("project");
+ project.setUrl("${project.rootDirectory}/temp-repo");
+ model.addRepository(project);
+
+ ModelInterpolator interpolator = createInterpolator(rootDirectory);
+
+ final SimpleProblemCollector collector = new SimpleProblemCollector();
+ Model out =
+ interpolator.interpolateModel(model, projectDirectory,
createModelBuildingRequest(context), collector);
+ assertProblemFree(collector);
+
+ assertEquals(
+ projectDirectory.getAbsolutePath() + "/temp-repo",
+ out.getRepositories().get(0).getUrl());
+ assertEquals(
+ rootDirectory.getAbsolutePath() + "/temp-repo",
+ out.getRepositories().get(1).getUrl());
+ }
+
+ @Test
+ public void testUnprefixedRootDirectoryIsNotInterpolated() throws
Exception {
+ // GH-13883: only ${project.rootDirectory} is supported,
${rootDirectory} is not an alias
+ File rootDirectory = new File("/test/root");
+ File projectDirectory = new File(rootDirectory, "module");
+
+ Model model = new Model();
+ model.setVersion("3.8.1");
+ model.setArtifactId("foo");
+
+ Repository repository = new Repository();
+ repository.setUrl("${rootDirectory}/temp-repo");
+ model.addRepository(repository);
+
+ ModelInterpolator interpolator = createInterpolator(rootDirectory);
+
+ final SimpleProblemCollector collector = new SimpleProblemCollector();
+ Model out =
+ interpolator.interpolateModel(model, projectDirectory,
createModelBuildingRequest(context), collector);
+ assertProblemFree(collector);
+
+ assertEquals("${rootDirectory}/temp-repo",
out.getRepositories().get(0).getUrl());
+ }
+
@Test
public void testEnvars() throws Exception {
Properties context = new Properties();
@@ -580,4 +668,18 @@ public void
testRecursiveExpressionCycleInPluginConfiguration() throws Exception
protected abstract ModelInterpolator createInterpolator(PathTranslator
translator) throws Exception;
protected abstract ModelInterpolator createInterpolator() throws Exception;
+
+ private ModelInterpolator createInterpolator(File rootDirectory) throws
Exception {
+ return ((AbstractStringBasedModelInterpolator)
createInterpolator()).setRootLocator(new DefaultRootLocator() {
+ @Override
+ public Path findRoot(Path basedir) {
+ return rootDirectory.toPath();
+ }
+
+ @Override
+ protected Optional<Path> getRootDirectoryFallback() {
+ return Optional.empty();
+ }
+ });
+ }
}
diff --git
a/maven-model-builder/src/test/java/org/apache/maven/model/profile/activation/FileProfileActivatorTest.java
b/maven-model-builder/src/test/java/org/apache/maven/model/profile/activation/FileProfileActivatorTest.java
index e0fec0cd90..e01f25d197 100644
---
a/maven-model-builder/src/test/java/org/apache/maven/model/profile/activation/FileProfileActivatorTest.java
+++
b/maven-model-builder/src/test/java/org/apache/maven/model/profile/activation/FileProfileActivatorTest.java
@@ -20,7 +20,9 @@
import java.io.File;
import java.io.IOException;
+import java.nio.file.Files;
import java.nio.file.Path;
+import java.util.Properties;
import org.apache.maven.model.Activation;
import org.apache.maven.model.ActivationFile;
@@ -112,6 +114,37 @@ public void testIsActiveExistsLeavesFileUnchanged() {
assertEquals("file.txt",
profile.getActivation().getFile().getExists());
}
+ @Test
+ public void testCustomRootDirectoryPropertyIsNotShadowed() throws
Exception {
+ // GH-13883: a custom ${rootDirectory} property must not be shadowed
by ${project.rootDirectory}
+ Properties modelProperties = new Properties();
+ modelProperties.setProperty("rootDirectory", "${project.basedir}");
+ DefaultProfileActivationContext moduleContext =
newModuleContext(modelProperties);
+
+ assertActivation(true,
newExistsProfile("${rootDirectory}/module-file.txt"), moduleContext);
+ assertActivation(false, newExistsProfile("${rootDirectory}/file.txt"),
moduleContext);
+ assertActivation(true,
newExistsProfile("${project.rootDirectory}/file.txt"), moduleContext);
+ assertActivation(false,
newExistsProfile("${project.rootDirectory}/module-file.txt"), moduleContext);
+ }
+
+ @Test
+ public void testUnprefixedRootDirectoryIsNotInterpolated() throws
Exception {
+ // GH-13883: only ${project.rootDirectory} is supported,
${rootDirectory} is not an alias
+ DefaultProfileActivationContext moduleContext = newModuleContext(new
Properties());
+
+ assertActivation(false, newExistsProfile("${rootDirectory}/file.txt"),
moduleContext);
+ assertActivation(true, newMissingProfile("${rootDirectory}/file.txt"),
moduleContext);
+ }
+
+ private DefaultProfileActivationContext newModuleContext(Properties
modelProperties) throws IOException {
+ Path moduleDir = Files.createDirectories(tempDir.resolve("module"));
+ Files.createFile(moduleDir.resolve("module-file.txt"));
+
+ return new DefaultProfileActivationContext()
+ .setProjectDirectory(moduleDir.toFile())
+ .setProjectProperties(modelProperties);
+ }
+
private Profile newExistsProfile(String filePath) {
ActivationFile activationFile = new ActivationFile();
activationFile.setExists(filePath);