-
Notifications
You must be signed in to change notification settings - Fork 108
/
XmlDocumentGenerator.java
179 lines (158 loc) · 6.63 KB
/
XmlDocumentGenerator.java
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
172
173
174
175
176
177
178
179
/*
* Copyright (c) 2017-2018 The Regents of the University of California
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package edu.berkeley.cs.jqf.examples.xml;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import java.io.IOException;
import com.pholser.junit.quickcheck.generator.GenerationStatus;
import com.pholser.junit.quickcheck.generator.Generator;
import com.pholser.junit.quickcheck.generator.Size;
import com.pholser.junit.quickcheck.internal.GeometricDistribution;
import com.pholser.junit.quickcheck.random.SourceOfRandomness;
import edu.berkeley.cs.jqf.examples.common.AlphaStringGenerator;
import edu.berkeley.cs.jqf.examples.common.Dictionary;
import edu.berkeley.cs.jqf.examples.common.DictionaryBackedStringGenerator;
import org.junit.Assume;
import org.w3c.dom.DOMException;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Text;
/**
* A generator for XML documents.
*
* @author Rohan Padhye
*/
public class XmlDocumentGenerator extends Generator<Document> {
private static DocumentBuilderFactory documentBuilderFactory =
DocumentBuilderFactory.newInstance();
private static GeometricDistribution geometricDistribution =
new GeometricDistribution();
/** Mean number of child nodes for each XML element. */
private static final double MEAN_NUM_CHILDREN = 4;
/** Mean number of attributes for each XML element. */
private static final double MEAN_NUM_ATTRIBUTES = 2;
/**
* Minimum size of XML tree.
* @see {@link #configure(Size)}
*/
private int minDepth = 0;
/**
* Maximum size of XML tree.
* @see {@link #configure(Size)}
*/
private int maxDepth = 4;
private Generator<String> stringGenerator = new AlphaStringGenerator();
public XmlDocumentGenerator() {
super(Document.class);
}
/**
* Configures the minimum/maximum size of the XML document.
*
* This method is not usually invoked directly. Instead, use
* the `@Size` annotation on fuzzed parameters to configure
* automatically.
*
* @param size the min/max size of the XML document
*/
public void configure(Size size) {
minDepth = size.min();
maxDepth = size.max();
}
/**
* Configures the string generator used by this generator to use
* a dictionary. This is useful for overriding the default
* arbitrary string generator with something that pulls tag names
* from a predefined list.
*
* @param dict the dictionary file
* @throws IOException if the dictionary file cannot be read
*/
public void configure(Dictionary dict) throws IOException {
stringGenerator = new DictionaryBackedStringGenerator(dict.value(), stringGenerator);
}
/**
* Generators a random XML document.
* @param random a source of pseudo-random values
* @param status generation state
* @return a randomly-generated XML document
*/
@Override
public Document generate(SourceOfRandomness random, GenerationStatus status) {
DocumentBuilder builder;
try {
builder = documentBuilderFactory.newDocumentBuilder();
} catch (ParserConfigurationException e) {
throw new RuntimeException(e);
}
if (stringGenerator == null) {
stringGenerator = gen().type(String.class);
}
Document document = builder.newDocument();
try {
populateDocument(document, random, status);
} catch (DOMException e) {
Assume.assumeNoException(e);
}
return document;
}
private String makeString(SourceOfRandomness random, GenerationStatus status) {
return stringGenerator.generate(random, status);
}
private Document populateDocument(Document document, SourceOfRandomness random, GenerationStatus status) {
Element root = document.createElement(makeString(random, status));
populateElement(document, root, random, status, 0);
document.appendChild(root);
return document;
}
private void populateElement(Document document, Element elem, SourceOfRandomness random, GenerationStatus status, int depth) {
// Add attributes
int numAttributes = Math.max(0, geometricDistribution.sampleWithMean(MEAN_NUM_ATTRIBUTES, random)-1);
for (int i = 0; i < numAttributes; i++) {
elem.setAttribute(makeString(random, status), makeString(random, status));
}
// Make children
if (depth < minDepth || (depth < maxDepth && random.nextBoolean())) {
int numChildren = Math.max(0, geometricDistribution.sampleWithMean(MEAN_NUM_CHILDREN, random)-1);
for (int i = 0; i < numChildren; i++) {
Element child = document.createElement(makeString(random, status));
populateElement(document, child, random, status, depth+1);
elem.appendChild(child);
}
} else if (random.nextBoolean()) {
// Add text
Text text = document.createTextNode(makeString(random, status));
elem.appendChild(text);
} else if (random.nextBoolean()) {
// Add text as CDATA
Text text = document.createCDATASection(makeString(random, status));
elem.appendChild(text);
}
}
}