Pull #3003: fix unused stream in DefaultPluginXmlFactory#write

Author: Vincent Potucek

impl/maven-impl/src/main/java/org/apache/maven/impl/DefaultPluginXmlFactory.java

@@ -93,7 +93,7 @@ public void write(XmlWriterRequest<PluginDescriptor> request) throws XmlWriterEx
                 new PluginDescriptorStaxWriter().write(outputStream, content);
             } else {
                 try (OutputStream os = Files.newOutputStream(path)) {
-                    new PluginDescriptorStaxWriter().write(outputStream, content);
+                    new PluginDescriptorStaxWriter().write(os, content);
                 }
             }
         } catch (Exception e) {
@@ -102,7 +102,7 @@ public void write(XmlWriterRequest<PluginDescriptor> request) throws XmlWriterEx
     }
 
     /**
-     * Simply parse the given xml string.
+     * Parse the given XML string.
      *
      * @param xml the input XML string
      * @return the parsed object
@@ -114,7 +114,7 @@ public static PluginDescriptor fromXml(@Nonnull String xml) throws XmlReaderExce
     }
 
     /**
-     * Simply converts the given content to an XML string.
+     * Convert the given content to an XML string.
      *
      * @param content the object to convert
      * @return the XML string representation

impl/maven-impl/src/test/java/org/apache/maven/impl/DefaultPluginXmlFactoryTest.java

@@ -0,0 +1,134 @@
+package org.apache.maven.impl;
+
+import org.apache.maven.api.services.xml.XmlReaderRequest;
+import org.apache.maven.api.services.xml.XmlWriterRequest;
+import org.apache.maven.api.plugin.descriptor.PluginDescriptor;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
+
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.StringReader;
+import java.io.StringWriter;
+import java.nio.file.Files;
+import java.nio.file.Path;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+class DefaultPluginXmlFactoryTest {
+
+    private DefaultPluginXmlFactory sut;
+    private static final String SAMPLE_PLUGIN_XML = """
+            <?xml version="1.0" encoding="UTF-8"?>
+            <plugin>
+              <name>Sample Plugin</name>
+              <groupId>org.example</groupId>
+              <artifactId>sample-plugin</artifactId>
+              <version>1.0.0</version>
+            </plugin>
+            """;
+
+    @BeforeEach
+    void setUp() {
+        sut = new DefaultPluginXmlFactory();
+    }
+
+    @Test
+    void shouldReadFromInputStream() {
+        PluginDescriptor descriptor = sut.read(XmlReaderRequest.builder()
+                .inputStream(new ByteArrayInputStream(SAMPLE_PLUGIN_XML.getBytes()))
+                .build());
+        assertEquals("Sample Plugin", descriptor.getName());
+        assertEquals("org.example", descriptor.getGroupId());
+        assertEquals("sample-plugin", descriptor.getArtifactId());
+        assertEquals("1.0.0", descriptor.getVersion());
+    }
+
+    @Test
+    void shouldReadFromReader() {
+        assertEquals("Sample Plugin", sut.read(XmlReaderRequest.builder()
+                .reader(new StringReader(SAMPLE_PLUGIN_XML))
+                .build()).getName());
+    }
+
+    @Test
+    void shouldReadFromPath(@TempDir Path tempDir) throws Exception {
+        Path xmlFile = tempDir.resolve("plugin.xml");
+        Files.write(xmlFile, SAMPLE_PLUGIN_XML.getBytes());
+        assertEquals("Sample Plugin", sut.read(XmlReaderRequest.builder()
+                .path(xmlFile)
+                .build()).getName());
+    }
+
+    @Test
+    void shouldThrowExceptionOnInvalidInput() {
+        assertThrows(IllegalArgumentException.class, () -> sut.read(XmlReaderRequest.builder().build()));
+    }
+
+    @Test
+    void shouldWriteToWriter() {
+        StringWriter writer = new StringWriter();
+        sut.write(XmlWriterRequest.<PluginDescriptor>builder()
+                .writer(writer)
+                .content(PluginDescriptor.newBuilder()
+                        .name("Sample Plugin")
+                        .groupId("org.example")
+                        .artifactId("sample-plugin")
+                        .version("1.0.0")
+                        .build())
+                .build());
+        String output = writer.toString();
+        assertTrue(output.contains("<name>Sample Plugin</name>"));
+        assertTrue(output.contains("<groupId>org.example</groupId>"));
+    }
+
+    @Test
+    void shouldWriteToOutputStream() {
+        ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
+        sut.write(XmlWriterRequest.<PluginDescriptor>builder()
+                .outputStream(outputStream)
+                .content(PluginDescriptor.newBuilder()
+                        .name("Sample Plugin")
+                        .build())
+                .build());
+        assertTrue(outputStream.toString().contains("<name>Sample Plugin</name>"));
+    }
+
+    @Test
+    void shouldWriteToPath(@TempDir Path tempDir) throws Exception {
+        Path xmlFile = tempDir.resolve("output-plugin.xml");
+        sut.write(XmlWriterRequest.<PluginDescriptor>builder()
+                .path(xmlFile)
+                .content(PluginDescriptor.newBuilder()
+                        .name("Sample Plugin")
+                        .build())
+                .build());
+        assertTrue(Files.readString(xmlFile).contains("<name>Sample Plugin</name>"));
+    }
+
+    @Test
+    void shouldParseValidXmlString() {
+        PluginDescriptor descriptor = sut.fromXmlString(SAMPLE_PLUGIN_XML);
+        assertEquals("Sample Plugin", descriptor.getName());
+        assertEquals("org.example", descriptor.getGroupId());
+        assertEquals("sample-plugin", descriptor.getArtifactId());
+        assertEquals("1.0.0", descriptor.getVersion());
+    }
+
+    @Test
+    void shouldGenerateValidXmlString() {
+        String xml = sut.toXmlString(PluginDescriptor.newBuilder()
+                .name("Sample Plugin")
+                .groupId("org.example")
+                .artifactId("sample-plugin")
+                .version("1.0.0")
+                .build());
+        assertTrue(xml.contains("<name>Sample Plugin</name>"));
+        assertTrue(xml.contains("<groupId>org.example</groupId>"));
+        assertTrue(xml.contains("<artifactId>sample-plugin</artifactId>"));
+        assertTrue(xml.contains("<version>1.0.0</version>"));
+    }
+}