1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2017 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle;
import java.io.ByteArrayOutputStream;
import java.nio.charset.StandardCharsets;
import java.util.Set;
import java.util.function.BiPredicate;
import javax.xml.parsers.ParserConfigurationException;
import org.junit.Assert;
import org.w3c.dom.Document;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import com.puppycrawl.tools.checkstyle.internal.utils.XmlUtil;
public abstract class AbstractXmlTestSupport extends AbstractModuleTestSupport {
protected static Document getOutputStreamXml(ByteArrayOutputStream outputStream)
throws ParserConfigurationException {
final String xml = new String(outputStream.toByteArray(), StandardCharsets.UTF_8);
return XmlUtil.getRawXml("audit output", xml, xml);
}
protected static void verifyXml(String expectedOutputFile,
ByteArrayOutputStream actualOutputStream, String... messages) throws Exception {
verifyXml(expectedOutputFile, actualOutputStream, null, messages);
}
protected static void verifyXml(String expectedOutputFile,
ByteArrayOutputStream actualOutputStream,
BiPredicate<Node, Node> ordered, String... messages) throws Exception {
String expectedContents = readFile(expectedOutputFile);
for (int i = 0; i < messages.length; i++) {
expectedContents = expectedContents.replace("$" + i, messages[i]);
}
final Document expectedDocument = XmlUtil.getRawXml("audit output", expectedContents,
expectedContents);
final Document actualDocument = getOutputStreamXml(actualOutputStream);
verifyXmlNode(expectedDocument, actualDocument, "/", ordered);
}
private static void verifyXmlNodes(Node expected, Node actual, String path,
BiPredicate<Node, Node> ordered) {
final Node expectedFirstChild = expected.getFirstChild();
final Node actualFirstChild = actual.getFirstChild();
if (expectedFirstChild == null) {
Assert.assertNull("no children nodes should exist: " + path, actualFirstChild);
Assert.assertEquals("text should be the same: " + path, expected.getNodeValue(),
actual.getNodeValue());
}
else {
Assert.assertNotNull("children nodes should exist: " + path, actualFirstChild);
if (ordered == null) {
Node actualChild = actualFirstChild;
for (Node expectedChild = expectedFirstChild; expectedChild != null;
expectedChild = expectedChild.getNextSibling()) {
verifyXmlNode(expectedChild, actualChild, path, ordered);
actualChild = actualChild.getNextSibling();
}
Assert.assertNull("node have same number of children: " + path, actualChild);
}
else {
final Set<Node> expectedChildren = XmlUtil.getChildrenElements(expected);
final Set<Node> actualChildren = XmlUtil.getChildrenElements(actual);
Assert.assertEquals("node have same number of children: " + path,
expectedChildren.size(), actualChildren.size());
for (Node expectedChild : expectedChildren) {
Node foundChild = null;
for (Node actualChild : actualChildren) {
if (ordered.test(expectedChild, actualChild)) {
foundChild = actualChild;
break;
}
}
Assert.assertNotNull("node should exist: " + path + expectedChild.getNodeName()
+ "/", foundChild);
verifyXmlNode(expectedChild, foundChild, path, ordered);
}
}
}
}
private static void verifyXmlNode(Node expected, Node actual, String path,
BiPredicate<Node, Node> ordered) {
if (expected == null) {
if (actual != null) {
Assert.fail("no node should exist: " + path + actual.getNodeName() + "/");
}
}
else {
final String newPath = path + expected.getNodeName() + "/";
Assert.assertNotNull("node should exist: " + newPath, actual);
Assert.assertEquals("node should have same name: " + newPath, expected.getNodeName(),
actual.getNodeName());
Assert.assertEquals("node should have same type: " + newPath, expected.getNodeType(),
actual.getNodeType());
verifyXmlAttributes(expected.getAttributes(), actual.getAttributes(), newPath);
verifyXmlNodes(expected, actual, newPath, ordered);
}
}
private static void verifyXmlAttributes(NamedNodeMap expected, NamedNodeMap actual,
String path) {
if (expected == null) {
Assert.assertNull("no attributes should exist: " + path, actual);
}
else {
Assert.assertNotNull("attributes should exist: " + path, actual);
for (int i = 0; i < expected.getLength(); i++) {
verifyXmlAttribute(expected.item(i), actual.item(i), path);
}
Assert.assertEquals("node have same number of attributes: " + path,
expected.getLength(), actual.getLength());
}
}
private static void verifyXmlAttribute(Node expected, Node actual, String path) {
final String expectedName = expected.getNodeName();
Assert.assertNotNull("attribute value for '" + expectedName + "' should not be null: "
+ path, actual);
Assert.assertEquals("attribute name should match: " + path, expectedName,
actual.getNodeName());
// ignore checkstyle version in xml as it changes each release
if (!"/#document/checkstyle".equals(path) && !"version".equals(expectedName)) {
Assert.assertEquals("attribute value for '" + expectedName + "' should match: " + path,
expected.getNodeValue(), actual.getNodeValue());
}
}
}
|
