From d035c49cd2ee47feaa9e4a9b36c151f256621992 Mon Sep 17 00:00:00 2001 From: Guillaume Nodet Date: Sat, 11 Apr 2026 12:13:51 +0200 Subject: [PATCH] Fix #11899: DefaultSettingsXmlFactory.write() always emits location comments DefaultSettingsXmlFactory and DefaultToolchainsXmlFactory always emitted InputLocation comments because they created bare StaxWriter instances whose addLocationInformation field defaults to true. This aligns both factories with DefaultModelXmlFactory by defaulting location tracking to false and only enabling it when an explicit inputLocationFormatter is provided via XmlWriterRequest. Co-Authored-By: Claude Opus 4.6 --- .../maven/impl/DefaultSettingsXmlFactory.java | 16 ++- .../impl/DefaultToolchainsXmlFactory.java | 16 ++- .../impl/DefaultSettingsXmlFactoryTest.java | 106 ++++++++++++++++++ 3 files changed, 134 insertions(+), 4 deletions(-) create mode 100644 impl/maven-impl/src/test/java/org/apache/maven/impl/DefaultSettingsXmlFactoryTest.java diff --git a/impl/maven-impl/src/main/java/org/apache/maven/impl/DefaultSettingsXmlFactory.java b/impl/maven-impl/src/main/java/org/apache/maven/impl/DefaultSettingsXmlFactory.java index 0aecc0460ba2..25c3ba5d2f2a 100644 --- a/impl/maven-impl/src/main/java/org/apache/maven/impl/DefaultSettingsXmlFactory.java +++ b/impl/maven-impl/src/main/java/org/apache/maven/impl/DefaultSettingsXmlFactory.java @@ -22,6 +22,7 @@ import java.io.OutputStream; import java.io.Reader; import java.io.Writer; +import java.util.function.Function; import org.apache.maven.api.annotations.Nonnull; import org.apache.maven.api.di.Named; @@ -31,6 +32,7 @@ import org.apache.maven.api.services.xml.XmlReaderRequest; import org.apache.maven.api.services.xml.XmlWriterException; import org.apache.maven.api.services.xml.XmlWriterRequest; +import org.apache.maven.api.settings.InputLocation; import org.apache.maven.api.settings.InputSource; import org.apache.maven.api.settings.Settings; import org.apache.maven.settings.v4.SettingsStaxReader; @@ -79,10 +81,20 @@ public void write(XmlWriterRequest request) throws XmlWriterException throw new IllegalArgumentException("writer or outputStream must be non null"); } try { + SettingsStaxWriter xmlWriter = new SettingsStaxWriter(); + xmlWriter.setAddLocationInformation(false); + + Function formatter = request.getInputLocationFormatter(); + if (formatter != null) { + xmlWriter.setAddLocationInformation(true); + Function adapter = formatter::apply; + xmlWriter.setStringFormatter(adapter); + } + if (writer != null) { - new SettingsStaxWriter().write(writer, content); + xmlWriter.write(writer, content); } else { - new SettingsStaxWriter().write(outputStream, content); + xmlWriter.write(outputStream, content); } } catch (Exception e) { throw new XmlWriterException("Unable to write settings: " + getMessage(e), getLocation(e), e); diff --git a/impl/maven-impl/src/main/java/org/apache/maven/impl/DefaultToolchainsXmlFactory.java b/impl/maven-impl/src/main/java/org/apache/maven/impl/DefaultToolchainsXmlFactory.java index 89452d1367a1..3400cda47bd8 100644 --- a/impl/maven-impl/src/main/java/org/apache/maven/impl/DefaultToolchainsXmlFactory.java +++ b/impl/maven-impl/src/main/java/org/apache/maven/impl/DefaultToolchainsXmlFactory.java @@ -23,6 +23,7 @@ import java.io.Reader; import java.io.Writer; import java.util.Objects; +import java.util.function.Function; import org.apache.maven.api.annotations.Nonnull; import org.apache.maven.api.di.Named; @@ -32,6 +33,7 @@ import org.apache.maven.api.services.xml.XmlReaderRequest; import org.apache.maven.api.services.xml.XmlWriterException; import org.apache.maven.api.services.xml.XmlWriterRequest; +import org.apache.maven.api.toolchain.InputLocation; import org.apache.maven.api.toolchain.InputSource; import org.apache.maven.api.toolchain.PersistedToolchains; import org.apache.maven.toolchain.v4.MavenToolchainsStaxReader; @@ -81,10 +83,20 @@ public void write(XmlWriterRequest request) throws XmlWrite throw new IllegalArgumentException("writer or outputStream must be non null"); } try { + MavenToolchainsStaxWriter xmlWriter = new MavenToolchainsStaxWriter(); + xmlWriter.setAddLocationInformation(false); + + Function formatter = request.getInputLocationFormatter(); + if (formatter != null) { + xmlWriter.setAddLocationInformation(true); + Function adapter = formatter::apply; + xmlWriter.setStringFormatter(adapter); + } + if (writer != null) { - new MavenToolchainsStaxWriter().write(writer, content); + xmlWriter.write(writer, content); } else { - new MavenToolchainsStaxWriter().write(outputStream, content); + xmlWriter.write(outputStream, content); } } catch (Exception e) { throw new XmlWriterException("Unable to write toolchains: " + getMessage(e), getLocation(e), e); diff --git a/impl/maven-impl/src/test/java/org/apache/maven/impl/DefaultSettingsXmlFactoryTest.java b/impl/maven-impl/src/test/java/org/apache/maven/impl/DefaultSettingsXmlFactoryTest.java new file mode 100644 index 000000000000..97aaed395aec --- /dev/null +++ b/impl/maven-impl/src/test/java/org/apache/maven/impl/DefaultSettingsXmlFactoryTest.java @@ -0,0 +1,106 @@ +/* + * 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.impl; + +import java.io.StringReader; +import java.io.StringWriter; +import java.util.function.Function; + +import org.apache.maven.api.services.xml.XmlReaderRequest; +import org.apache.maven.api.services.xml.XmlWriterRequest; +import org.apache.maven.api.settings.Settings; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertTrue; + +class DefaultSettingsXmlFactoryTest { + + private DefaultSettingsXmlFactory factory; + + @BeforeEach + void setUp() { + factory = new DefaultSettingsXmlFactory(); + } + + @Test + void testWriteWithoutFormatterDisablesLocationTracking() throws Exception { + String xml = """ + + /path/to/local/repo + + + external:http:* + Pseudo repository + http://0.0.0.0/ + pseudo + + + """; + + Settings settings = factory.read(XmlReaderRequest.builder() + .reader(new StringReader(xml)) + .strict(true) + .build()); + + StringWriter out = new StringWriter(); + factory.write(XmlWriterRequest.builder() + .writer(out) + .content(settings) + .build()); + + String result = out.toString(); + assertFalse(result.contains("