This is an automated email from the ASF dual-hosted git repository.
gnodet pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven.git
The following commit(s) were added to refs/heads/master by this push:
new 93a0ecfd2 Additional XmlNode tests from plexus-utils (#994)
93a0ecfd2 is described below
commit 93a0ecfd2d71928a56c29059cf624448b4057115
Author: Guillaume Nodet <[email protected]>
AuthorDate: Thu Mar 9 21:14:20 2023 +0100
Additional XmlNode tests from plexus-utils (#994)
---
.../maven/internal/xml/XmlNodeBuilderTest.java | 44 +++
.../apache/maven/internal/xml/XmlNodeImplTest.java | 340 +++++++++++++++++++++
2 files changed, 384 insertions(+)
diff --git
a/maven-xml-impl/src/test/java/org/apache/maven/internal/xml/XmlNodeBuilderTest.java
b/maven-xml-impl/src/test/java/org/apache/maven/internal/xml/XmlNodeBuilderTest.java
new file mode 100644
index 000000000..bde7cd588
--- /dev/null
+++
b/maven-xml-impl/src/test/java/org/apache/maven/internal/xml/XmlNodeBuilderTest.java
@@ -0,0 +1,44 @@
+/*
+ * 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.internal.xml;
+
+import java.io.IOException;
+import java.io.StringReader;
+
+import org.apache.maven.api.xml.XmlNode;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+public class XmlNodeBuilderTest {
+
+ @Test
+ public void testReadMultiDoc() throws Exception {
+ String doc = "<?xml version='1.0'?><doc><child>foo</child></doc>";
+ StringReader r = new StringReader(doc + doc) {
+ @Override
+ public int read(char[] cbuf, int off, int len) throws IOException {
+ return super.read(cbuf, off, 1);
+ }
+ };
+ XmlNode node1 = XmlNodeBuilder.build(r);
+ XmlNode node2 = XmlNodeBuilder.build(r);
+ assertEquals(node1, node2);
+ }
+}
diff --git
a/maven-xml-impl/src/test/java/org/apache/maven/internal/xml/XmlNodeImplTest.java
b/maven-xml-impl/src/test/java/org/apache/maven/internal/xml/XmlNodeImplTest.java
index b803799ae..ab8139fe5 100644
---
a/maven-xml-impl/src/test/java/org/apache/maven/internal/xml/XmlNodeImplTest.java
+++
b/maven-xml-impl/src/test/java/org/apache/maven/internal/xml/XmlNodeImplTest.java
@@ -20,15 +20,23 @@ package org.apache.maven.internal.xml;
import java.io.IOException;
import java.io.StringReader;
+import java.util.ArrayList;
+import java.util.HashMap;
import java.util.List;
+import java.util.Map;
import java.util.stream.Collectors;
import org.apache.maven.api.xml.XmlNode;
+import org.codehaus.plexus.util.xml.Xpp3Dom;
+import org.codehaus.plexus.util.xml.Xpp3DomBuilder;
import org.codehaus.plexus.util.xml.pull.XmlPullParser;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertNotSame;
import static org.junit.jupiter.api.Assertions.assertNull;
public class XmlNodeImplTest {
@@ -271,6 +279,338 @@ public class XmlNodeImplTest {
assertNull(mergeResult.getValue());
}
+ /**
+ * <p>testShouldPerformAppendAtFirstSubElementLevel.</p>
+ */
+ @Test
+ public void testShouldPerformAppendAtFirstSubElementLevel() {
+ // create the dominant DOM
+ Xpp3Dom t1 = new Xpp3Dom("top");
+ t1.setAttribute(Xpp3Dom.CHILDREN_COMBINATION_MODE_ATTRIBUTE,
Xpp3Dom.CHILDREN_COMBINATION_APPEND);
+ t1.setInputLocation("t1top");
+
+ Xpp3Dom t1s1 = new Xpp3Dom("topsub1");
+ t1s1.setValue("t1s1Value");
+ t1s1.setInputLocation("t1s1");
+
+ t1.addChild(t1s1);
+
+ // create the recessive DOM
+ Xpp3Dom t2 = new Xpp3Dom("top");
+ t2.setInputLocation("t2top");
+
+ Xpp3Dom t2s1 = new Xpp3Dom("topsub1");
+ t2s1.setValue("t2s1Value");
+ t2s1.setInputLocation("t2s1");
+
+ t2.addChild(t2s1);
+
+ // merge and check results.
+ Xpp3Dom result = Xpp3Dom.mergeXpp3Dom(t1, t2);
+
+ assertEquals(2, result.getChildren("topsub1").length);
+ assertEquals("t2s1Value", result.getChildren("topsub1")[0].getValue());
+ assertEquals("t1s1Value", result.getChildren("topsub1")[1].getValue());
+
+ assertEquals("t1top", result.getInputLocation());
+ assertEquals("t2s1",
result.getChildren("topsub1")[0].getInputLocation());
+ assertEquals("t1s1",
result.getChildren("topsub1")[1].getInputLocation());
+ }
+
+ /**
+ * <p>testShouldOverrideAppendAndDeepMerge.</p>
+ */
+ @Test
+ public void testShouldOverrideAppendAndDeepMerge() {
+ // create the dominant DOM
+ Xpp3Dom t1 = new Xpp3Dom("top");
+ t1.setAttribute(Xpp3Dom.CHILDREN_COMBINATION_MODE_ATTRIBUTE,
Xpp3Dom.CHILDREN_COMBINATION_APPEND);
+ t1.setInputLocation("t1top");
+
+ Xpp3Dom t1s1 = new Xpp3Dom("topsub1");
+ t1s1.setValue("t1s1Value");
+ t1s1.setInputLocation("t1s1");
+
+ t1.addChild(t1s1);
+
+ // create the recessive DOM
+ Xpp3Dom t2 = new Xpp3Dom("top");
+ t2.setInputLocation("t2top");
+
+ Xpp3Dom t2s1 = new Xpp3Dom("topsub1");
+ t2s1.setValue("t2s1Value");
+ t2s1.setInputLocation("t2s1");
+
+ t2.addChild(t2s1);
+
+ // merge and check results.
+ Xpp3Dom result = Xpp3Dom.mergeXpp3Dom(t1, t2, Boolean.TRUE);
+
+ assertEquals(1, result.getChildren("topsub1").length);
+ assertEquals("t1s1Value", result.getChildren("topsub1")[0].getValue());
+
+ assertEquals("t1top", result.getInputLocation());
+ assertEquals("t1s1",
result.getChildren("topsub1")[0].getInputLocation());
+ }
+
+ /**
+ * <p>testShouldPerformSelfOverrideAtTopLevel.</p>
+ */
+ @Test
+ public void testShouldPerformSelfOverrideAtTopLevel() {
+ // create the dominant DOM
+ Xpp3Dom t1 = new Xpp3Dom("top");
+ t1.setAttribute("attr", "value");
+ t1.setInputLocation("t1top");
+
+ t1.setAttribute(Xpp3Dom.SELF_COMBINATION_MODE_ATTRIBUTE,
Xpp3Dom.SELF_COMBINATION_OVERRIDE);
+
+ // create the recessive DOM
+ Xpp3Dom t2 = new Xpp3Dom("top");
+ t2.setAttribute("attr2", "value2");
+ t2.setValue("t2Value");
+ t2.setInputLocation("t2top");
+
+ // merge and check results.
+ Xpp3Dom result = Xpp3Dom.mergeXpp3Dom(t1, t2);
+
+ assertEquals(2, result.getAttributeNames().length);
+ assertNull(result.getValue());
+ assertEquals("t1top", result.getInputLocation());
+ }
+
+ /**
+ * <p>testShouldMergeValuesAtTopLevelByDefault.</p>
+ */
+ @Test
+ public void testShouldNotMergeValuesAtTopLevelByDefault() {
+ // create the dominant DOM
+ Xpp3Dom t1 = new Xpp3Dom("top");
+ t1.setAttribute("attr", "value");
+ t1.setInputLocation("t1top");
+
+ // create the recessive DOM
+ Xpp3Dom t2 = new Xpp3Dom("top");
+ t2.setAttribute("attr2", "value2");
+ t2.setValue("t2Value");
+ t2.setInputLocation("t2top");
+
+ // merge and check results.
+ Xpp3Dom result = Xpp3Dom.mergeXpp3Dom(t1, t2);
+
+ // this is still 2, since we're not using the merge-control attribute.
+ assertEquals(2, result.getAttributeNames().length);
+
+ assertNull(result.getValue());
+ assertEquals("t1top", result.getInputLocation());
+ }
+
+ /**
+ * <p>testShouldMergeValuesAtTopLevel.</p>
+ */
+ @Test
+ public void testShouldNotMergeValuesAtTopLevel() {
+ // create the dominant DOM
+ Xpp3Dom t1 = new Xpp3Dom("top");
+ t1.setAttribute("attr", "value");
+
+ t1.setAttribute(Xpp3Dom.SELF_COMBINATION_MODE_ATTRIBUTE,
Xpp3Dom.SELF_COMBINATION_MERGE);
+
+ // create the recessive DOM
+ Xpp3Dom t2 = new Xpp3Dom("top");
+ t2.setAttribute("attr2", "value2");
+ t2.setValue("t2Value");
+
+ // merge and check results.
+ Xpp3Dom result = Xpp3Dom.mergeXpp3Dom(t1, t2);
+
+ assertEquals(3, result.getAttributeNames().length);
+ assertNull(result.getValue());
+ }
+
+ /**
+ * <p>testEquals.</p>
+ */
+ @Test
+ public void testEquals() {
+ XmlNodeImpl dom = new XmlNodeImpl("top");
+
+ assertEquals(dom, dom);
+ assertNotEquals(dom, null);
+ assertNotEquals(dom, new XmlNodeImpl(""));
+ }
+
+ /**
+ * <p>testEqualsIsNullSafe.</p>
+ *
+ * @throws org.codehaus.plexus.util.xml.pull.XmlPullParserException if any.
+ * @throws java.io.IOException if any.
+ */
+ @Test
+ public void testEqualsIsNullSafe() throws XmlPullParserException,
IOException {
+ String testDom = "<configuration><items
thing='blah'><item>one</item><item>two</item></items></configuration>";
+ Xpp3Dom dom = Xpp3DomBuilder.build(new StringReader(testDom));
+
+ Map<String, String> attributes = new HashMap<>();
+ attributes.put("nullValue", null);
+ attributes.put(null, "nullKey");
+ List<XmlNode> childList = new ArrayList<>();
+ childList.add(null);
+ Xpp3Dom dom2 = new Xpp3Dom(new XmlNodeImpl(dom.getName(), null,
attributes, childList, null));
+
+ assertNotEquals(dom, dom2);
+ assertNotEquals(dom2, dom);
+ }
+
+ /**
+ * <p>testShouldOverwritePluginConfigurationSubItemsByDefault.</p>
+ *
+ * @throws org.codehaus.plexus.util.xml.pull.XmlPullParserException if any.
+ * @throws java.io.IOException if any.
+ */
+ @Test
+ public void testShouldOverwritePluginConfigurationSubItemsByDefault()
throws XmlPullParserException, IOException {
+ String parentConfigStr =
"<configuration><items><item>one</item><item>two</item></items></configuration>";
+ XmlNode parentConfig =
+ XmlNodeBuilder.build(new StringReader(parentConfigStr), new
FixedInputLocationBuilder("parent"));
+
+ String childConfigStr =
"<configuration><items><item>three</item></items></configuration>";
+ XmlNode childConfig =
+ XmlNodeBuilder.build(new StringReader(childConfigStr), new
FixedInputLocationBuilder("child"));
+
+ XmlNode result = XmlNode.merge(childConfig, parentConfig);
+ XmlNode items = result.getChild("items");
+
+ assertEquals(1, items.getChildren().size());
+
+ XmlNode item = items.getChildren().get(0);
+ assertEquals("three", item.getValue());
+ assertEquals("child", item.getInputLocation());
+ }
+
+ /**
+ * <p>testShouldMergePluginConfigurationSubItemsWithMergeAttributeSet.</p>
+ *
+ * @throws org.codehaus.plexus.util.xml.pull.XmlPullParserException if any.
+ * @throws java.io.IOException if any.
+ */
+ @Test
+ public void
testShouldMergePluginConfigurationSubItemsWithMergeAttributeSet()
+ throws XmlPullParserException, IOException {
+ String parentConfigStr =
"<configuration><items><item>one</item><item>two</item></items></configuration>";
+ XmlNode parentConfig =
+ XmlNodeBuilder.build(new StringReader(parentConfigStr), new
FixedInputLocationBuilder("parent"));
+
+ String childConfigStr =
+ "<configuration><items
combine.children=\"append\"><item>three</item></items></configuration>";
+ XmlNode childConfig =
+ XmlNodeBuilder.build(new StringReader(childConfigStr), new
FixedInputLocationBuilder("child"));
+
+ XmlNode result = XmlNode.merge(childConfig, parentConfig);
+ XmlNode items = result.getChild("items");
+
+ XmlNode[] item = items.getChildren().toArray(new XmlNode[0]);
+ assertEquals(3, item.length);
+ assertEquals("one", item[0].getValue());
+ assertEquals("parent", item[0].getInputLocation());
+ assertEquals("two", item[1].getValue());
+ assertEquals("parent", item[1].getInputLocation());
+ assertEquals("three", item[2].getValue());
+ assertEquals("child", item[2].getInputLocation());
+ }
+
+ /**
+ *
<p>testShouldNotChangeUponMergeWithItselfWhenFirstOrLastSubItemIsEmpty.</p>
+ *
+ * @throws java.lang.Exception if any.
+ */
+ @Test
+ public void
testShouldNotChangeUponMergeWithItselfWhenFirstOrLastSubItemIsEmpty() throws
Exception {
+ String configStr =
"<configuration><items><item/><item>test</item><item/></items></configuration>";
+ Xpp3Dom dominantConfig = Xpp3DomBuilder.build(new
StringReader(configStr));
+ Xpp3Dom recessiveConfig = Xpp3DomBuilder.build(new
StringReader(configStr));
+
+ Xpp3Dom result = Xpp3Dom.mergeXpp3Dom(dominantConfig, recessiveConfig);
+ Xpp3Dom items = result.getChild("items");
+
+ assertEquals(3, items.getChildCount());
+
+ assertNull(items.getChild(0).getValue());
+ assertEquals("test", items.getChild(1).getValue());
+ assertNull(items.getChild(2).getValue());
+ }
+
+ /**
+ * <p>testShouldCopyRecessiveChildrenNotPresentInTarget.</p>
+ *
+ * @throws java.lang.Exception if any.
+ */
+ @Test
+ public void testShouldCopyRecessiveChildrenNotPresentInTarget() throws
Exception {
+ String dominantStr = "<configuration><foo>x</foo></configuration>";
+ String recessiveStr = "<configuration><bar>y</bar></configuration>";
+ Xpp3Dom dominantConfig = Xpp3DomBuilder.build(new
StringReader(dominantStr));
+ Xpp3Dom recessiveConfig = Xpp3DomBuilder.build(new
StringReader(recessiveStr));
+
+ Xpp3Dom result = Xpp3Dom.mergeXpp3Dom(dominantConfig, recessiveConfig);
+
+ assertEquals(2, result.getChildCount());
+
+ assertEquals("x", result.getChild("foo").getValue());
+ assertEquals("y", result.getChild("bar").getValue());
+ assertNotSame(result.getChild("bar"), recessiveConfig.getChild("bar"));
+ }
+
+ /**
+ * <p>testDupeChildren.</p>
+ *
+ * @throws java.io.IOException if any.
+ * @throws org.codehaus.plexus.util.xml.pull.XmlPullParserException if any.
+ */
+ @Test
+ public void testDupeChildren() throws IOException, XmlPullParserException {
+ String dupes =
"<configuration><foo>x</foo><foo>y</foo></configuration>";
+ Xpp3Dom dom = Xpp3DomBuilder.build(new StringReader(dupes));
+ assertNotNull(dom);
+ assertEquals("y", dom.getChild("foo").getValue());
+ }
+
+ /**
+ * <p>testShouldRemoveEntireElementWithAttributesAndChildren.</p>
+ *
+ * @throws java.lang.Exception if any.
+ */
+ @Test
+ public void testShouldRemoveEntireElementWithAttributesAndChildren()
throws Exception {
+ String dominantStr = "<config><service
combine.self=\"remove\"/></config>";
+ String recessiveStr =
"<config><service><parameter>parameter</parameter></service></config>";
+ Xpp3Dom dominantConfig = Xpp3DomBuilder.build(new
StringReader(dominantStr));
+ Xpp3Dom recessiveConfig = Xpp3DomBuilder.build(new
StringReader(recessiveStr));
+
+ Xpp3Dom result = Xpp3Dom.mergeXpp3Dom(dominantConfig, recessiveConfig);
+
+ assertEquals(0, result.getChildCount());
+ assertEquals("config", result.getName());
+ }
+
+ /**
+ * <p>testShouldRemoveDoNotRemoveTagWhenSwappedInputDOMs.</p>
+ *
+ * @throws java.lang.Exception if any.
+ */
+ @Test
+ public void testShouldRemoveDoNotRemoveTagWhenSwappedInputDOMs() throws
Exception {
+ String dominantStr = "<config><service
combine.self=\"remove\"/></config>";
+ String recessiveStr =
"<config><service><parameter>parameter</parameter></service></config>";
+ Xpp3Dom dominantConfig = Xpp3DomBuilder.build(new
StringReader(dominantStr));
+ Xpp3Dom recessiveConfig = Xpp3DomBuilder.build(new
StringReader(recessiveStr));
+
+ // same DOMs as
testShouldRemoveEntireElementWithAttributesAndChildren(), swapping dominant
<--> recessive
+ Xpp3Dom result = Xpp3Dom.mergeXpp3Dom(recessiveConfig, dominantConfig);
+
+ assertEquals(recessiveConfig.toString(), result.toString());
+ }
+
private static List<XmlNode> getChildren(XmlNode node, String name) {
return node.getChildren().stream().filter(n ->
n.getName().equals(name)).collect(Collectors.toList());
}
