[MNG-8465] Add support for project.rootDirectory in repositories and …

…fix other expressions (#2007) Valid expressions in repositories are: * ${project.basedir} * ${project.basedir.uri} * ${project.rootDirectory} * ${project.rootDirectory.uri}
apache · Dec 22, 2024 · 98dedaf · 98dedaf
1 parent bebc3d4
commit 98dedaf
Show file tree

Hide file tree

Showing 5 changed files with 93 additions and 6 deletions.
diff --git a/...ven-impl/src/main/java/org/apache/maven/internal/impl/model/DefaultModelInterpolator.java b/...ven-impl/src/main/java/org/apache/maven/internal/impl/model/DefaultModelInterpolator.java
@@ -211,7 +211,7 @@ String projectProperty(Model model, Path projectDir, String subExpr, boolean pre
                 return projectDir.toAbsolutePath().toString();
             } else if (subExpr.startsWith("basedir.")) {
                 try {
-                    Object value = ReflectionValueExtractor.evaluate(subExpr, projectDir.toAbsolutePath(), false);
+                    Object value = ReflectionValueExtractor.evaluate(subExpr, projectDir.toAbsolutePath(), true);
                     if (value != null) {
                         return value.toString();
                     }

diff --git a/.../maven-impl/src/main/java/org/apache/maven/internal/impl/model/DefaultModelValidator.java b/.../maven-impl/src/main/java/org/apache/maven/internal/impl/model/DefaultModelValidator.java
@@ -1343,13 +1343,19 @@ private void validateRawRepositories(
                 // only allow ${basedir} and ${project.basedir}
                 Matcher m = EXPRESSION_NAME_PATTERN.matcher(repository.getUrl());
                 while (m.find()) {
-                    if (!("basedir".equals(m.group(1)) || "project.basedir".equals(m.group(1)))) {
-                        validateStringNoExpression(
-                                prefix + prefix2 + "[" + repository.getId() + "].url",
+                    String expr = m.group(1);
+                    if (!("basedir".equals(expr)
+                            || "project.basedir".equals(expr)
+                            || expr.startsWith("project.basedir.")
+                            || "project.rootDirectory".equals(expr)
+                            || expr.startsWith("project.rootDirectory."))) {
+                        addViolation(
                                 problems,
                                 Severity.ERROR,
                                 Version.V40,
-                                repository.getUrl(),
+                                prefix + prefix2 + "[" + repository.getId() + "].url",
+                                null,
+                                "contains an unsupported expression (only expressions starting with 'project.basedir' or 'project.rootDirectory' are supported).",
                                 repository);
                         break;
                     }

diff --git a/...en-impl/src/test/java/org/apache/maven/internal/impl/model/DefaultModelValidatorTest.java b/...en-impl/src/test/java/org/apache/maven/internal/impl/model/DefaultModelValidatorTest.java
@@ -805,7 +805,7 @@ void repositoryWithExpression() throws Exception {
         SimpleProblemCollector result = validateFile("raw-model/repository-with-expression.xml");
         assertViolations(result, 0, 1, 0);
         assertEquals(
-                "'repositories.repository.[repo].url' contains an expression but should be a constant.",
+                "'repositories.repository.[repo].url' contains an unsupported expression (only expressions starting with 'project.basedir' or 'project.rootDirectory' are supported).",
                 result.getErrors().get(0));
     }
 

diff --git a/...t-suite/src/test/java/org/apache/maven/it/MavenITmng8465RepositoryWithProjectDirTest.java b/...t-suite/src/test/java/org/apache/maven/it/MavenITmng8465RepositoryWithProjectDirTest.java
@@ -0,0 +1,52 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.maven.it;
+
+import java.nio.file.Path;
+import java.util.List;
+
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+/**
+ * This is a test set for <a href="https://issues.apache.org/jira/browse/MNG-8465">MNG-8465</a>.
+ */
+class MavenITmng8465RepositoryWithProjectDirTest extends AbstractMavenIntegrationTestCase {
+
+    MavenITmng8465RepositoryWithProjectDirTest() {
+        super("[4.0.0-rc-3-SNAPSHOT,)");
+    }
+
+    /**
+     *  Verify various supported repository URLs.
+     */
+    @Test
+    void testProjectDir() throws Exception {
+        Path basedir = extractResources("/mng-8465").getAbsoluteFile().toPath();
+
+        Verifier verifier = newVerifier(basedir.toString());
+        verifier.addCliArgument("help:effective-pom");
+        verifier.execute();
+        List<String> urls = verifier.loadLogLines().stream()
+                .filter(s -> s.trim().contains("<url>file://"))
+                .toList();
+        assertEquals(4, urls.size());
+    }
+}
diff --git a/its/core-it-suite/src/test/resources/mng-8465/pom.xml b/its/core-it-suite/src/test/resources/mng-8465/pom.xml
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.1.0" root="true">
+  <groupId>org.apache.maven.its.mng8465</groupId>
+  <artifactId>test</artifactId>
+  <version>1.0</version>
+  <packaging>pom</packaging>
+
+  <name>Maven Integration Test :: MNG-8465</name>
+  <description>Test repositories can be defined using ${project.basedir} and ${project.rootDirectory}.</description>
+
+  <repositories>
+    <repository>
+      <id>test</id>
+      <url>file://${project.basedir}/repo</url>
+    </repository>
+    <repository>
+      <id>test2</id>
+      <url>${project.basedir.uri}repo</url>
+    </repository>
+    <repository>
+      <id>test3</id>
+      <url>file://${project.rootDirectory}/repo</url>
+    </repository>
+    <repository>
+      <id>test4</id>
+      <url>${project.rootDirectory.uri}repo</url>
+    </repository>
+  </repositories>
+</project>