You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by gn...@apache.org on 2025/07/24 11:40:22 UTC
(maven) branch maven-4.0.x updated: Avoid parsing MAVEN_OPTS (master/4.x) (#10970) (#10993)
This is an automated email from the ASF dual-hosted git repository.
gnodet pushed a commit to branch maven-4.0.x
in repository https://gitbox.apache.org/repos/asf/maven.git
The following commit(s) were added to refs/heads/maven-4.0.x by this push:
new 7901fc764c Avoid parsing MAVEN_OPTS (master/4.x) (#10970) (#10993)
7901fc764c is described below
commit 7901fc764cbe2c7c15e5ee8cee24bf94d7c8dc4e
Author: Guillaume Nodet <gn...@gmail.com>
AuthorDate: Thu Jul 24 13:40:18 2025 +0200
Avoid parsing MAVEN_OPTS (master/4.x) (#10970) (#10993)
Fixes #10937 by introducing an additional INTERNAL_MAVEN_OPTS for any arguments that need to be inserted by the script. Parsing the externally-defined MAVEN_OPTS variable can lead to incorrect processing of quotes and special characters, so use the separate variable to avoid doing so.
Additionally JVM_CONFIG_MAVEN_OPTS is introduced as its own variable to preserve the append behaviour.
Remove quotes from the new JVM_CONFIG_MAVEN_OPTS to also allow quoted pipes to work from jvm.config
This is a follow-up to #10937, where the extra layer of quotes causes parsing issues in Windows cmd
Test that adding pipes to either MAVEN_OPTS or jvm.config does not break anything
Note: it is important that a jvm.config exists for the MAVEN_OPTS portion of the test to work
By default xargs handles quotes specially. To avoid this behaviour, `-0` must be used instead, but first we need to convert LF to NUL.
Since quotes are no longer being stripped by xargs, we should also stop trying to add them back in otherwise nested quotes cause further issues
---------
(cherry picked from commit aeff353bd4c97a2e75de3d86d0259e161f4acf83)
Co-authored-by: Bob <16...@users.noreply.github.com>
Co-authored-by: Bob <Bo...@users.noreply.github.com>
---
apache-maven/src/assembly/maven/bin/mvn | 12 ++---
apache-maven/src/assembly/maven/bin/mvn.cmd | 10 +++-
.../MavenITgh10937QuotedPipesInMavenOptsTest.java | 55 ++++++++++++++++++++
.../org/apache/maven/it/TestSuiteOrdering.java | 1 +
.../gh-10937-pipes-maven-opts/.mvn/jvm.config | 2 +
.../resources/gh-10937-pipes-maven-opts/pom.xml | 59 ++++++++++++++++++++++
6 files changed, 130 insertions(+), 9 deletions(-)
diff --git a/apache-maven/src/assembly/maven/bin/mvn b/apache-maven/src/assembly/maven/bin/mvn
index 59cb66a9cc..8559d47af5 100755
--- a/apache-maven/src/assembly/maven/bin/mvn
+++ b/apache-maven/src/assembly/maven/bin/mvn
@@ -171,20 +171,18 @@ concat_lines() {
# First convert all CR to LF using tr
tr '\r' '\n' < "$1" | \
sed -e '/^$/d' -e 's/#.*$//' | \
+ # Replace LF with NUL for xargs
+ tr '\n' '\0' | \
# Split into words and process each argument
- xargs -n 1 | \
+ # Use -0 with NUL to avoid special behaviour on quotes
+ xargs -n 1 -0 | \
while read -r arg; do
# Replace variables first
arg=$(echo "$arg" | sed \
-e "s@\${MAVEN_PROJECTBASEDIR}@$MAVEN_PROJECTBASEDIR@g" \
-e "s@\$MAVEN_PROJECTBASEDIR@$MAVEN_PROJECTBASEDIR@g")
- # Add quotes only if argument contains spaces and isn't already quoted
- if echo "$arg" | grep -q " " && ! echo "$arg" | grep -q "^\".*\"$"; then
- echo "\"$arg\""
- else
- echo "$arg"
- fi
+ echo "$arg"
done | \
tr '\n' ' '
fi
diff --git a/apache-maven/src/assembly/maven/bin/mvn.cmd b/apache-maven/src/assembly/maven/bin/mvn.cmd
index 1d50c0ec32..a3e8600df3 100644
--- a/apache-maven/src/assembly/maven/bin/mvn.cmd
+++ b/apache-maven/src/assembly/maven/bin/mvn.cmd
@@ -35,6 +35,10 @@ title %0
@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on'
@if "%MAVEN_BATCH_ECHO%"=="on" echo %MAVEN_BATCH_ECHO%
+@REM Clear/define a variable for any options to be inserted via script
+@REM We want to avoid trying to parse the external MAVEN_OPTS variable
+SET INTERNAL_MAVEN_OPTS=
+
@REM Execute a user defined script before this one
if not "%MAVEN_SKIP_RC%"=="" goto skipRc
if exist "%PROGRAMDATA%\mavenrc.cmd" call "%PROGRAMDATA%\mavenrc.cmd" %*
@@ -204,7 +208,7 @@ for /F "usebackq tokens=* delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.conf
)
)
)
-@endlocal & set "MAVEN_OPTS=%MAVEN_OPTS% %JVM_CONFIG_MAVEN_OPTS%"
+@endlocal & set JVM_CONFIG_MAVEN_OPTS=%JVM_CONFIG_MAVEN_OPTS%
:endReadJvmConfig
@@ -224,7 +228,7 @@ if "%~1"=="--debug" (
echo Error: Unable to autodetect the YJP library location. Please set YJPLIB variable >&2
exit /b 1
)
- set "MAVEN_OPTS=-agentpath:%YJPLIB%=onexit=snapshot,onexit=memory,tracing,onlylocal %MAVEN_OPTS%"
+ set "INTERNAL_MAVEN_OPTS=-agentpath:%YJPLIB%=onexit=snapshot,onexit=memory,tracing,onlylocal %INTERNAL_MAVEN_OPTS%"
) else if "%~1"=="--enc" (
set "MAVEN_MAIN_CLASS=org.apache.maven.cling.MavenEncCling"
) else if "%~1"=="--shell" (
@@ -248,7 +252,9 @@ set LAUNCHER_CLASS=org.codehaus.plexus.classworlds.launcher.Launcher
if "%MAVEN_MAIN_CLASS%"=="" @set MAVEN_MAIN_CLASS=org.apache.maven.cling.MavenCling
"%JAVACMD%" ^
+ %INTERNAL_MAVEN_OPTS% ^
%MAVEN_OPTS% ^
+ %JVM_CONFIG_MAVEN_OPTS% ^
%MAVEN_DEBUG_OPTS% ^
--enable-native-access=ALL-UNNAMED ^
-classpath %LAUNCHER_JAR% ^
diff --git a/its/core-it-suite/src/test/java/org/apache/maven/it/MavenITgh10937QuotedPipesInMavenOptsTest.java b/its/core-it-suite/src/test/java/org/apache/maven/it/MavenITgh10937QuotedPipesInMavenOptsTest.java
new file mode 100644
index 0000000000..45445cb424
--- /dev/null
+++ b/its/core-it-suite/src/test/java/org/apache/maven/it/MavenITgh10937QuotedPipesInMavenOptsTest.java
@@ -0,0 +1,55 @@
+/*
+ * 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.Properties;
+
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+/**
+ * This is a test set for <a href="https://github.com/apache/maven/issues/10937">gh-10937</a>.
+ */
+class MavenITgh10937QuotedPipesInMavenOptsTest extends AbstractMavenIntegrationTestCase {
+
+ MavenITgh10937QuotedPipesInMavenOptsTest() {
+ super("[3.0.0,)");
+ }
+
+ /**
+ * Verify the dependency management of the consumer POM is computed correctly
+ */
+ @Test
+ void testIt() throws Exception {
+ Path basedir =
+ extractResources("/gh-10937-pipes-maven-opts").getAbsoluteFile().toPath();
+
+ Verifier verifier = newVerifier(basedir.toString());
+ verifier.setEnvironmentVariable("MAVEN_OPTS", "-Dprop.maven-opts=\"foo|bar\"");
+ verifier.addCliArguments("validate");
+ verifier.execute();
+ verifier.verifyErrorFreeLog();
+
+ Properties props = verifier.loadProperties("target/pom.properties");
+ assertEquals("foo|bar", props.getProperty("project.properties.pom.prop.jvm-opts"));
+ assertEquals("foo|bar", props.getProperty("project.properties.pom.prop.maven-opts"));
+ }
+}
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 00d6ce1156..d931454b06 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
@@ -103,6 +103,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(MavenITgh10937QuotedPipesInMavenOptsTest.class);
suite.addTestSuite(MavenITgh2532DuplicateDependencyEffectiveModelTest.class);
suite.addTestSuite(MavenITmng8736ConcurrentFileActivationTest.class);
suite.addTestSuite(MavenITmng8744CIFriendlyTest.class);
diff --git a/its/core-it-suite/src/test/resources/gh-10937-pipes-maven-opts/.mvn/jvm.config b/its/core-it-suite/src/test/resources/gh-10937-pipes-maven-opts/.mvn/jvm.config
new file mode 100644
index 0000000000..a5d1264486
--- /dev/null
+++ b/its/core-it-suite/src/test/resources/gh-10937-pipes-maven-opts/.mvn/jvm.config
@@ -0,0 +1,2 @@
+# One comment
+-Dprop.jvm-opts="foo|bar"
diff --git a/its/core-it-suite/src/test/resources/gh-10937-pipes-maven-opts/pom.xml b/its/core-it-suite/src/test/resources/gh-10937-pipes-maven-opts/pom.xml
new file mode 100644
index 0000000000..d1ef2ca102
--- /dev/null
+++ b/its/core-it-suite/src/test/resources/gh-10937-pipes-maven-opts/pom.xml
@@ -0,0 +1,59 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ 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.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+
+ <groupId>org.apache.maven.its.gh10937</groupId>
+ <artifactId>test</artifactId>
+ <version>1.0</version>
+
+ <name>Maven Integration Test :: GH-10937</name>
+ <description>Verify that JVM args can contain pipes.</description>
+
+ <properties>
+ <pom.prop.maven-opts>${prop.maven-opts}</pom.prop.maven-opts>
+ <pom.prop.jvm-opts>${prop.jvm-opts}</pom.prop.jvm-opts>
+ </properties>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.its.plugins</groupId>
+ <artifactId>maven-it-plugin-expression</artifactId>
+ <version>2.1-SNAPSHOT</version>
+ <executions>
+ <execution>
+ <id>test</id>
+ <goals>
+ <goal>eval</goal>
+ </goals>
+ <phase>validate</phase>
+ <configuration>
+ <outputFile>target/pom.properties</outputFile>
+ <expressions>
+ <expression>project/properties</expression>
+ </expressions>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+</project>