From b77c3c2e01ffba957d960232d29e164414dfcdc3 Mon Sep 17 00:00:00 2001 From: Guillaume Nodet Date: Mon, 31 Mar 2025 11:09:50 +0200 Subject: [PATCH 1/4] [MNG-3558] Ensure properties can be escaped --- .../MavenITmng3558PropertyEscapingTest.java | 62 +++++++++++++++ .../apache/maven/it/TestSuiteOrdering.java | 1 + .../mng-3558-property-escaping/pom.xml | 79 +++++++++++++++++++ 3 files changed, 142 insertions(+) create mode 100644 its/core-it-suite/src/test/java/org/apache/maven/it/MavenITmng3558PropertyEscapingTest.java create mode 100644 its/core-it-suite/src/test/resources/mng-3558-property-escaping/pom.xml diff --git a/its/core-it-suite/src/test/java/org/apache/maven/it/MavenITmng3558PropertyEscapingTest.java b/its/core-it-suite/src/test/java/org/apache/maven/it/MavenITmng3558PropertyEscapingTest.java new file mode 100644 index 000000000000..1ec315599e71 --- /dev/null +++ b/its/core-it-suite/src/test/java/org/apache/maven/it/MavenITmng3558PropertyEscapingTest.java @@ -0,0 +1,62 @@ +/* + * 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.io.File; +import java.util.Properties; + +import org.junit.jupiter.api.Test; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +/** + * This is a test case for MNG-3558. + * + * Verifies that property references can be properly escaped in both model properties + * and plugin configuration using backslash. + */ +class MavenITmng3558PropertyEscapingTest extends AbstractMavenIntegrationTestCase { + MavenITmng3558PropertyEscapingTest() { + super("[4.0.0-beta-5,)"); + } + + @Test + public void testPropertyEscaping() throws Exception { + File testDir = extractResources("/mng-3558-property-escaping"); + + Verifier verifier = newVerifier(testDir.getAbsolutePath()); + verifier.setAutoclean(false); + verifier.deleteDirectory("target"); + verifier.addCliArgument("validate"); + verifier.execute(); + verifier.verifyErrorFreeLog(); + + // Verify model properties + Properties modelProps = verifier.loadProperties("target/property-values.properties"); + assertEquals("${test.value}", modelProps.getProperty("project.properties.escaped.property")); + assertEquals("prefix-${test.value}-suffix", modelProps.getProperty("project.properties.escaped.with.context")); + assertEquals("interpolated-value", modelProps.getProperty("project.properties.normal.property")); + + // Verify plugin configuration + Properties configProps = verifier.loadProperties("target/config-values.properties"); + assertEquals("${test.value}", configProps.getProperty("param")); + assertEquals("prefix-${test.value}-suffix", configProps.getProperty("paramWithContext")); + assertEquals("interpolated-value", configProps.getProperty("normalParam")); + } +} diff --git a/its/core-it-suite/src/test/java/org/apache/maven/it/TestSuiteOrdering.java b/its/core-it-suite/src/test/java/org/apache/maven/it/TestSuiteOrdering.java index 1d948a9468fa..391b525bb2ce 100644 --- a/its/core-it-suite/src/test/java/org/apache/maven/it/TestSuiteOrdering.java +++ b/its/core-it-suite/src/test/java/org/apache/maven/it/TestSuiteOrdering.java @@ -101,6 +101,7 @@ public TestSuiteOrdering() { * the tests are to finishing. Newer tests are also more likely to fail, so this is * a fail fast technique as well. */ + suite.addTestSuite(MavenITmng3558PropertyEscapingTest.class); suite.addTestSuite(MavenITmng8598JvmConfigSubstitutionTest.class); suite.addTestSuite(MavenITmng8653AfterAndEachPhasesWithConcurrentBuilderTest.class); suite.addTestSuite(MavenITmng5668AfterPhaseExecutionTest.class); diff --git a/its/core-it-suite/src/test/resources/mng-3558-property-escaping/pom.xml b/its/core-it-suite/src/test/resources/mng-3558-property-escaping/pom.xml new file mode 100644 index 000000000000..aadbcf1d64f6 --- /dev/null +++ b/its/core-it-suite/src/test/resources/mng-3558-property-escaping/pom.xml @@ -0,0 +1,79 @@ + + + + 4.0.0 + + org.apache.maven.its.mng3558 + test + 1.0 + + Maven Integration Test :: MNG-3558 + Verify that property references can be escaped in both model properties and plugin configuration. + + + + interpolated-value + + + \${test.value} + prefix-\${test.value}-suffix + + + ${test.value} + + + + + + org.apache.maven.its.plugins + maven-it-plugin-expression + 2.1-SNAPSHOT + + + test + + eval + + validate + + target/property-values.properties + + project/properties + + + + + + + org.apache.maven.its.plugins + maven-it-plugin-configuration + 2.1-SNAPSHOT + + target/config-values.properties + + \${test.value} + prefix-\${test.value}-suffix + ${test.value} + + + + + + From 48b04fc33af9713a18b82c6e4eedcbe11a15cbb8 Mon Sep 17 00:00:00 2001 From: Guillaume Nodet Date: Mon, 31 Mar 2025 12:25:31 +0200 Subject: [PATCH 2/4] Maybe using the proper syntax will help --- .../src/test/resources/mng-3558-property-escaping/pom.xml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/its/core-it-suite/src/test/resources/mng-3558-property-escaping/pom.xml b/its/core-it-suite/src/test/resources/mng-3558-property-escaping/pom.xml index aadbcf1d64f6..2292c6b357f4 100644 --- a/its/core-it-suite/src/test/resources/mng-3558-property-escaping/pom.xml +++ b/its/core-it-suite/src/test/resources/mng-3558-property-escaping/pom.xml @@ -32,8 +32,8 @@ under the License. interpolated-value - \${test.value} - prefix-\${test.value}-suffix + $\{test.value\} + prefix-$\{test.value\}-suffix ${test.value} @@ -68,8 +68,8 @@ under the License. target/config-values.properties - \${test.value} - prefix-\${test.value}-suffix + $\{test.value\} + prefix-$\{test.value\}-suffix ${test.value} From 93b2b812d74ed0bbe59753e6cc728fb1a42caf55 Mon Sep 17 00:00:00 2001 From: Guillaume Nodet Date: Mon, 31 Mar 2025 14:05:54 +0200 Subject: [PATCH 3/4] Fix plugin config --- .../MavenITmng3558PropertyEscapingTest.java | 3 ++- .../mng-3558-property-escaping/pom.xml | 25 +++++++++++++------ 2 files changed, 19 insertions(+), 9 deletions(-) diff --git a/its/core-it-suite/src/test/java/org/apache/maven/it/MavenITmng3558PropertyEscapingTest.java b/its/core-it-suite/src/test/java/org/apache/maven/it/MavenITmng3558PropertyEscapingTest.java index 1ec315599e71..8f05d3a55aef 100644 --- a/its/core-it-suite/src/test/java/org/apache/maven/it/MavenITmng3558PropertyEscapingTest.java +++ b/its/core-it-suite/src/test/java/org/apache/maven/it/MavenITmng3558PropertyEscapingTest.java @@ -43,7 +43,8 @@ public void testPropertyEscaping() throws Exception { Verifier verifier = newVerifier(testDir.getAbsolutePath()); verifier.setAutoclean(false); verifier.deleteDirectory("target"); - verifier.addCliArgument("validate"); + verifier.addCliArgument("resources"); + verifier.addCliArgument("org.apache.maven.its.plugins:maven-it-plugin-configuration:config"); verifier.execute(); verifier.verifyErrorFreeLog(); diff --git a/its/core-it-suite/src/test/resources/mng-3558-property-escaping/pom.xml b/its/core-it-suite/src/test/resources/mng-3558-property-escaping/pom.xml index 2292c6b357f4..1d90c56e5f78 100644 --- a/its/core-it-suite/src/test/resources/mng-3558-property-escaping/pom.xml +++ b/its/core-it-suite/src/test/resources/mng-3558-property-escaping/pom.xml @@ -65,14 +65,23 @@ under the License. org.apache.maven.its.plugins maven-it-plugin-configuration 2.1-SNAPSHOT - - target/config-values.properties - - $\{test.value\} - prefix-$\{test.value\}-suffix - ${test.value} - - + + + config + + config + + validate + + target/config-values.properties + + $$\{test.value\} + prefix-$$\{test.value\}-suffix + ${test.value} + + + + From 4539eec4d9ae11fde4eff4f7f6375c3413c92603 Mon Sep 17 00:00:00 2001 From: Guillaume Nodet Date: Mon, 31 Mar 2025 14:17:01 +0200 Subject: [PATCH 4/4] Fix IT --- .../maven/it/MavenITmng3558PropertyEscapingTest.java | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/its/core-it-suite/src/test/java/org/apache/maven/it/MavenITmng3558PropertyEscapingTest.java b/its/core-it-suite/src/test/java/org/apache/maven/it/MavenITmng3558PropertyEscapingTest.java index 8f05d3a55aef..3b1aac67dfc6 100644 --- a/its/core-it-suite/src/test/java/org/apache/maven/it/MavenITmng3558PropertyEscapingTest.java +++ b/its/core-it-suite/src/test/java/org/apache/maven/it/MavenITmng3558PropertyEscapingTest.java @@ -43,8 +43,7 @@ public void testPropertyEscaping() throws Exception { Verifier verifier = newVerifier(testDir.getAbsolutePath()); verifier.setAutoclean(false); verifier.deleteDirectory("target"); - verifier.addCliArgument("resources"); - verifier.addCliArgument("org.apache.maven.its.plugins:maven-it-plugin-configuration:config"); + verifier.addCliArgument("validate"); verifier.execute(); verifier.verifyErrorFreeLog(); @@ -56,8 +55,8 @@ public void testPropertyEscaping() throws Exception { // Verify plugin configuration Properties configProps = verifier.loadProperties("target/config-values.properties"); - assertEquals("${test.value}", configProps.getProperty("param")); - assertEquals("prefix-${test.value}-suffix", configProps.getProperty("paramWithContext")); - assertEquals("interpolated-value", configProps.getProperty("normalParam")); + assertEquals("${test.value}", configProps.getProperty("mapParam.param")); + assertEquals("prefix-${test.value}-suffix", configProps.getProperty("mapParam.paramWithContext")); + assertEquals("interpolated-value", configProps.getProperty("mapParam.normalParam")); } }