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 2026/04/12 06:21:09 UTC
(maven) branch fix/issue-11899-additions created (now fd1254c548)
This is an automated email from the ASF dual-hosted git repository.
gnodet pushed a change to branch fix/issue-11899-additions
in repository https://gitbox.apache.org/repos/asf/maven.git
at fd1254c548 Apply same fix to DefaultToolchainsXmlFactory and add tests
This branch includes the following new commits:
new fd1254c548 Apply same fix to DefaultToolchainsXmlFactory and add tests
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(maven) 01/01: Apply same fix to DefaultToolchainsXmlFactory and add tests
Posted by gn...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
gnodet pushed a commit to branch fix/issue-11899-additions
in repository https://gitbox.apache.org/repos/asf/maven.git
commit fd1254c548a6386a48e5cf086a7d09aa8b282451
Author: Guillaume Nodet <gn...@gmail.com>
AuthorDate: Sun Apr 12 08:20:59 2026 +0200
Apply same fix to DefaultToolchainsXmlFactory and add tests
DefaultToolchainsXmlFactory.write() had the same bug as
DefaultSettingsXmlFactory: it always emitted location comments.
Also adds DefaultSettingsXmlFactoryTest to verify the write behavior
with and without an inputLocationFormatter.
Co-Authored-By: Claude Opus 4.6 <no...@anthropic.com>
---
.../maven/impl/DefaultToolchainsXmlFactory.java | 16 +++-
.../maven/impl/DefaultSettingsXmlFactoryTest.java | 106 +++++++++++++++++++++
2 files changed, 120 insertions(+), 2 deletions(-)
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 89452d1367..3400cda47b 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<PersistedToolchains> request) throws XmlWrite
throw new IllegalArgumentException("writer or outputStream must be non null");
}
try {
+ MavenToolchainsStaxWriter xmlWriter = new MavenToolchainsStaxWriter();
+ xmlWriter.setAddLocationInformation(false);
+
+ Function<Object, String> formatter = request.getInputLocationFormatter();
+ if (formatter != null) {
+ xmlWriter.setAddLocationInformation(true);
+ Function<InputLocation, String> 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 0000000000..97aaed395a
--- /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 = """
+ <settings xmlns="http://maven.apache.org/SETTINGS/1.2.0">
+ <localRepository>/path/to/local/repo</localRepository>
+ <mirrors>
+ <mirror>
+ <mirrorOf>external:http:*</mirrorOf>
+ <name>Pseudo repository</name>
+ <url>http://0.0.0.0/</url>
+ <id>pseudo</id>
+ </mirror>
+ </mirrors>
+ </settings>""";
+
+ Settings settings = factory.read(XmlReaderRequest.builder()
+ .reader(new StringReader(xml))
+ .strict(true)
+ .build());
+
+ StringWriter out = new StringWriter();
+ factory.write(XmlWriterRequest.<Settings>builder()
+ .writer(out)
+ .content(settings)
+ .build());
+
+ String result = out.toString();
+ assertFalse(result.contains("<!--"), "No XML comments should be present when no formatter is provided");
+ }
+
+ @Test
+ void testWriteWithFormatterEnablesLocationTracking() throws Exception {
+ String xml = """
+ <settings xmlns="http://maven.apache.org/SETTINGS/1.2.0">
+ <localRepository>/path/to/local/repo</localRepository>
+ <mirrors>
+ <mirror>
+ <mirrorOf>external:http:*</mirrorOf>
+ <name>Pseudo repository</name>
+ <url>http://0.0.0.0/</url>
+ <id>pseudo</id>
+ </mirror>
+ </mirrors>
+ </settings>""";
+
+ Settings settings = factory.read(XmlReaderRequest.builder()
+ .reader(new StringReader(xml))
+ .location("settings.xml")
+ .strict(true)
+ .build());
+
+ StringWriter out = new StringWriter();
+ Function<Object, String> formatter = o -> "LOC_MARK";
+
+ factory.write(XmlWriterRequest.<Settings>builder()
+ .writer(out)
+ .content(settings)
+ .inputLocationFormatter(formatter)
+ .build());
+
+ String result = out.toString();
+ assertTrue(result.contains("LOC_MARK"), "Expected formatter marker in output when tracking is enabled");
+ }
+}