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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
|
package com.vaadin.tests.design;
import static java.nio.charset.StandardCharsets.UTF_8;
import static org.junit.Assert.assertNull;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.logging.Handler;
import java.util.logging.LogRecord;
import java.util.logging.Logger;
import org.jsoup.Jsoup;
import org.jsoup.nodes.Attribute;
import org.jsoup.nodes.Element;
import org.jsoup.nodes.Node;
import org.jsoup.nodes.TextNode;
import org.junit.Assert;
import com.vaadin.ui.AbstractComponent;
import com.vaadin.ui.Component;
import com.vaadin.ui.declarative.Design;
import com.vaadin.ui.declarative.DesignContext;
import com.vaadin.ui.declarative.ShouldWriteDataDelegate;
public abstract class DeclarativeTestBaseBase<T extends Component> {
private static final String[] booleanAttributes = { "allowfullscreen",
"async", "autofocus", "checked", "compact", "declare", "default",
"defer", "disabled", "formnovalidate", "hidden", "inert", "ismap",
"itemscope", "multiple", "muted", "nohref", "noresize", "noshade",
"novalidate", "nowrap", "open", "readonly", "required", "reversed",
"seamless", "selected", "sortable", "truespeed", "typemustmatch" };
private static final class AlwaysWriteDelegate
implements ShouldWriteDataDelegate {
private static final long serialVersionUID = -6345914431997793599L;
@Override
public boolean shouldWriteData(Component component) {
return true;
}
}
public static final ShouldWriteDataDelegate ALWAYS_WRITE_DATA = new AlwaysWriteDelegate();
public interface EqualsAsserter<TT> {
public void assertObjectEquals(TT o1, TT o2);
}
protected T read(String design) {
return (T) Design
.read(new ByteArrayInputStream(design.getBytes(UTF_8)));
}
protected DesignContext readAndReturnContext(String design) {
return Design.read(new ByteArrayInputStream(design.getBytes(UTF_8)),
null);
}
protected String write(T object, boolean writeData) {
DesignContext dc = new DesignContext();
if (writeData) {
dc.setShouldWriteDataDelegate(
DeclarativeTestBaseBase.ALWAYS_WRITE_DATA);
}
return write(object, dc);
}
protected String write(T object, DesignContext context) {
try {
ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
context.setRootComponent(object);
Design.write(context, outputStream);
return outputStream.toString(UTF_8.name());
} catch (Exception e) {
throw new RuntimeException(e);
}
}
protected void assertEquals(Object o1, Object o2) {
assertEquals("", o1, o2);
}
protected void assertEquals(String message, Object o1, Object o2) {
if (o1 == null) {
assertNull(message, o2);
return;
}
if (o2 == null) {
assertNull(message, o1);
return;
}
if (!(o1 instanceof Collection && o2 instanceof Collection)) {
Assert.assertEquals(o1.getClass(), o2.getClass());
}
if (o1 instanceof Object[]) {
Object[] a1 = ((Object[]) o1);
Object[] a2 = ((Object[]) o2);
Assert.assertEquals(message + ": array length", a1.length,
a2.length);
for (int i = 0; i < a1.length; i++) {
assertEquals(message + ": element " + i, a1[i], a2[i]);
}
return;
}
List<EqualsAsserter<Object>> comparators = getComparators(o1);
if (!comparators.isEmpty()) {
for (EqualsAsserter<Object> ec : comparators) {
ec.assertObjectEquals(o1, o2);
}
} else {
Assert.assertEquals(message, o1, o2);
}
}
private List<EqualsAsserter<Object>> getComparators(Object o1) {
List<EqualsAsserter<Object>> result = new ArrayList<>();
getComparators(o1.getClass(), result);
return result;
}
private void getComparators(Class<?> c,
List<EqualsAsserter<Object>> result) {
if (c == null || !isVaadin(c)) {
return;
}
EqualsAsserter<Object> comparator = (EqualsAsserter<Object>) getComparator(
c);
if (c.getSuperclass() != Object.class) {
getComparators(c.getSuperclass(), result);
}
for (Class<?> i : c.getInterfaces()) {
getComparators(i, result);
}
if (!result.contains(comparator)) {
result.add(comparator);
}
}
protected abstract <TT> EqualsAsserter<TT> getComparator(Class<TT> c);
private boolean isVaadin(Class<?> c) {
return c.getPackage() != null
&& c.getPackage().getName().startsWith("com.vaadin");
}
public static class TestLogHandler {
final List<String> messages = new ArrayList<>();
Handler handler = new Handler() {
@Override
public void publish(LogRecord record) {
messages.add(record.getMessage());
}
@Override
public void flush() {
}
@Override
public void close() throws SecurityException {
}
};
public TestLogHandler() {
Logger.getLogger(AbstractComponent.class.getName()).getParent()
.addHandler(handler);
}
public String getMessages() {
if (messages.isEmpty()) {
return "";
}
String r = "";
for (String message : messages) {
r += message + "\n";
}
return r;
}
}
public T testRead(String design, T expected) {
TestLogHandler l = new TestLogHandler();
T read = read(design);
assertEquals(expected, read);
Assert.assertEquals("", l.getMessages());
return read;
}
public DesignContext readComponentAndCompare(String design, T expected) {
TestLogHandler l = new TestLogHandler();
DesignContext context = readAndReturnContext(design);
assertEquals(expected, context.getRootComponent());
Assert.assertEquals("", l.getMessages());
return context;
}
public void testWrite(String expected, T component) {
TestLogHandler l = new TestLogHandler();
testWrite(expected, component, false);
Assert.assertEquals("", l.getMessages());
}
public void testWrite(String expectedDesign, T component,
boolean writeData) {
String written = write(component, writeData);
Element producedElem = Jsoup.parse(written).body().child(0);
Element comparableElem = Jsoup.parse(expectedDesign).body().child(0);
String produced = elementToHtml(producedElem);
String comparable = elementToHtml(comparableElem);
Assert.assertEquals(comparable, produced);
}
public void testWrite(T component, String expected, DesignContext context) {
String written = write(component, context);
Element producedElem = Jsoup.parse(written).body().child(0);
Element comparableElem = Jsoup.parse(expected).body().child(0);
String produced = elementToHtml(producedElem);
String comparable = elementToHtml(comparableElem);
Assert.assertEquals(comparable, produced);
}
protected Element createElement(Component c) {
return new DesignContext().createElement(c);
}
private String elementToHtml(Element producedElem) {
StringBuilder stringBuilder = new StringBuilder();
elementToHtml(producedElem, stringBuilder);
return stringBuilder.toString();
}
/**
* Produce predictable html (attributes in alphabetical order), always
* include close tags
*/
private String elementToHtml(Element producedElem, StringBuilder sb) {
HashSet<String> booleanAttributes = new HashSet<>();
List<String> names = new ArrayList<>();
for (Attribute a : producedElem.attributes().asList()) {
names.add(a.getKey());
if (isBooleanAttribute(a.getKey())) {
booleanAttributes.add(a.getKey());
}
}
Collections.sort(names);
sb.append('<').append(producedElem.tagName());
for (String attrName : names) {
sb.append(' ').append(attrName);
if (!booleanAttributes.contains(attrName)) {
sb.append('=').append("\'").append(producedElem.attr(attrName))
.append("\'");
}
}
sb.append('>');
for (Node child : producedElem.childNodes()) {
if (child instanceof Element) {
elementToHtml((Element) child, sb);
} else if (child instanceof TextNode) {
String text = ((TextNode) child).text();
sb.append(text.trim());
}
}
sb.append("</").append(producedElem.tagName()).append('>');
return sb.toString();
}
/**
* Checks if this attribute name is defined as a boolean attribute in HTML5
*/
protected static boolean isBooleanAttribute(final String key) {
return Arrays.binarySearch(booleanAttributes, key) >= 0;
}
protected String stripOptionTags(String design) {
return design.replaceAll("[ \n]*<option(.*)</option>[ \n]*", "");
}
}
|