Exclude Maven built-in property from circular placeholder reference c…

…heck.
openrewrite · Jul 16, 2024 · 86ae0f1 · 86ae0f1
1 parent 7d056fd
commit 86ae0f1
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 1 deletion.
diff --git a/rewrite-core/src/main/java/org/openrewrite/internal/PropertyPlaceholderHelper.java b/rewrite-core/src/main/java/org/openrewrite/internal/PropertyPlaceholderHelper.java
@@ -15,6 +15,7 @@
  */
 package org.openrewrite.internal;
 
+import org.openrewrite.internal.lang.NonNull;
 import org.openrewrite.internal.lang.Nullable;
 
 import java.util.*;
@@ -27,12 +28,21 @@
  * @author Rob Harrop
  */
 public class PropertyPlaceholderHelper {
+
     private static final Map<String, String> wellKnownSimplePrefixes = new HashMap<>(4);
 
+    private static final List<String> MAVEN_BUILT_IN_PROPERTY_PREFIXES = new ArrayList<>();
+
     static {
         wellKnownSimplePrefixes.put("}", "{");
         wellKnownSimplePrefixes.put("]", "[");
         wellKnownSimplePrefixes.put(")", "(");
+
+        MAVEN_BUILT_IN_PROPERTY_PREFIXES.add("project.");
+        MAVEN_BUILT_IN_PROPERTY_PREFIXES.add("pom.");
+        MAVEN_BUILT_IN_PROPERTY_PREFIXES.add("maven.");
+        MAVEN_BUILT_IN_PROPERTY_PREFIXES.add("env.");
+        MAVEN_BUILT_IN_PROPERTY_PREFIXES.add("settings.");
     }
 
     private final String placeholderPrefix;
@@ -88,7 +98,7 @@ protected String parseStringValue(String value, Function<String, String> placeho
                 if (visitedPlaceholders == null) {
                     visitedPlaceholders = new HashSet<>(4);
                 }
-                if (!visitedPlaceholders.add(originalPlaceholder)) {
+                if (!visitedPlaceholders.add(originalPlaceholder) && !isMavenBuiltInProperty(originalPlaceholder)) {
                     throw new IllegalArgumentException(
                             "Circular placeholder reference '" + originalPlaceholder + "' in property definitions");
                 }
@@ -160,4 +170,13 @@ private static boolean substringMatch(CharSequence str, int index, CharSequence
         }
         return true;
     }
+
+    private static boolean isMavenBuiltInProperty(@NonNull final String originalPlaceholder) {
+        for (final String prefix : MAVEN_BUILT_IN_PROPERTY_PREFIXES) {
+            if (originalPlaceholder.startsWith(prefix)) {
+                return true;
+            }
+        }
+        return false;
+    }
 }
diff --git a/rewrite-core/src/test/java/org/openrewrite/internal/PropertyPlaceholderHelperTest.java b/rewrite-core/src/test/java/org/openrewrite/internal/PropertyPlaceholderHelperTest.java
@@ -17,6 +17,10 @@
 
 import org.junit.jupiter.api.Test;
 
+import java.util.HashSet;
+import java.util.Set;
+import java.util.function.Function;
+
 import static org.assertj.core.api.Assertions.assertThat;
 
 class PropertyPlaceholderHelperTest {
@@ -31,4 +35,25 @@ void dashed() {
         });
         assertThat(s).isEqualTo("hi jon");
     }
+
+    @Test
+    void testMavenBuiltInProperty() {
+        var helper = new PropertyPlaceholderHelper("${", "}", null);
+        final Set<String> visitedPlaceholders = new HashSet<>();
+        visitedPlaceholders.add("project.version");
+        visitedPlaceholders.add("pom.basedir");
+        visitedPlaceholders.add("maven.home");
+        visitedPlaceholders.add("env.PATH");
+        visitedPlaceholders.add("settings.localRepository");
+        assertThat(helper.parseStringValue("${project.version}", Function.identity(), visitedPlaceholders))
+          .isEqualTo("project.version");
+        assertThat(helper.parseStringValue("${pom.basedir}", Function.identity(), visitedPlaceholders))
+          .isEqualTo("pom.basedir");
+        assertThat(helper.parseStringValue("${maven.home}", Function.identity(), visitedPlaceholders))
+          .isEqualTo("maven.home");
+        assertThat(helper.parseStringValue("${env.PATH}", Function.identity(), visitedPlaceholders))
+          .isEqualTo("env.PATH");
+        assertThat(helper.parseStringValue("${settings.localRepository}", Function.identity(), visitedPlaceholders))
+          .isEqualTo("settings.localRepository");
+    }
 }