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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
|
/*
* 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.commons.io.input;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;
import java.io.IOException;
import org.junit.jupiter.api.Test;
/**
* Test the Encoding Utilities part of {@link XmlStreamReader}.
*/
public class XmlStreamReaderUtilitiesTest {
/** Mock {@link XmlStreamReader} implementation */
private static class MockXmlStreamReader extends XmlStreamReader {
MockXmlStreamReader(final String defaultEncoding) throws IOException {
super(CharSequenceInputStream.builder().setCharSequence("").get(), null, true, defaultEncoding);
}
}
private static final String RAWMGS1 = "encoding mismatch";
private static final String RAWMGS2 = "unknown BOM";
private static final String HTTPMGS1 = "BOM must be null";
private static final String HTTPMGS2 = "encoding mismatch";
private static final String HTTPMGS3 = "Illegal MIME";
private static final String APPXML = "application/xml";
private static final String APPXML_UTF8 = "application/xml;charset=UTF-8";
private static final String APPXML_UTF16 = "application/xml;charset=UTF-16";
private static final String APPXML_UTF32 = "application/xml;charset=UTF-32";
private static final String APPXML_UTF16BE = "application/xml;charset=UTF-16BE";
private static final String APPXML_UTF16LE = "application/xml;charset=UTF-16LE";
private static final String APPXML_UTF32BE = "application/xml;charset=UTF-32BE";
private static final String APPXML_UTF32LE = "application/xml;charset=UTF-32LE";
private static final String TXTXML = "text/xml";
protected String calculateHttpEncoding(final String httpContentType, final String bomEnc, final String xmlGuessEnc,
final String xmlEnc, final boolean lenient, final String defaultEncoding) throws IOException {
try (MockXmlStreamReader mock = new MockXmlStreamReader(defaultEncoding)) {
return mock.calculateHttpEncoding(httpContentType, bomEnc, xmlGuessEnc, xmlEnc, lenient);
}
}
protected String calculateRawEncoding(final String bomEnc, final String xmlGuessEnc, final String xmlEnc,
final String defaultEncoding) throws IOException {
try (MockXmlStreamReader mock = new MockXmlStreamReader(defaultEncoding)) {
return mock.calculateRawEncoding(bomEnc, xmlGuessEnc, xmlEnc);
}
}
@SuppressWarnings("boxing")
private void checkAppXml(final boolean expected, final String mime) {
assertEquals(expected, XmlStreamReader.isAppXml(mime), "Mime=[" + mime + "]");
}
private void checkContentTypeEncoding(final String expected, final String httpContentType) {
assertEquals(expected, XmlStreamReader.getContentTypeEncoding(httpContentType), "ContentTypeEncoding=[" + httpContentType + "]");
}
private void checkContentTypeMime(final String expected, final String httpContentType) {
assertEquals(expected, XmlStreamReader.getContentTypeMime(httpContentType), "ContentTypeMime=[" + httpContentType + "]");
}
private void checkHttpEncoding(final String expected, final boolean lenient, final String httpContentType,
final String bomEnc, final String xmlGuessEnc, final String xmlEnc, final String defaultEncoding) throws IOException {
final StringBuilder builder = new StringBuilder();
builder.append("HttpEncoding=[").append(bomEnc).append("], ");
builder.append("lenient=[").append(lenient).append("], ");
builder.append("httpContentType=[").append(httpContentType).append("], ");
builder.append("bomEnc=[").append(bomEnc).append("], ");
builder.append("xmlGuessEnc=[").append(xmlGuessEnc).append("], ");
builder.append("xmlEnc=[").append(xmlEnc).append("], ");
builder.append("defaultEncoding=[").append(defaultEncoding).append("],");
final String encoding = calculateHttpEncoding(httpContentType, bomEnc, xmlGuessEnc, xmlEnc, lenient, defaultEncoding);
assertEquals(expected, encoding, builder.toString());
}
private void checkHttpError(final String msgSuffix, final boolean lenient, final String httpContentType,
final String bomEnc, final String xmlGuessEnc, final String xmlEnc, final String defaultEncoding) {
try {
checkHttpEncoding("XmlStreamReaderException", lenient, httpContentType, bomEnc, xmlGuessEnc, xmlEnc, defaultEncoding);
fail("Expected XmlStreamReaderException");
} catch (final XmlStreamReaderException e) {
assertTrue(e.getMessage().startsWith("Illegal encoding"), "Msg Start: " + e.getMessage());
assertTrue(e.getMessage().endsWith(msgSuffix), "Msg End: " + e.getMessage());
assertEquals(bomEnc, e.getBomEncoding(), "bomEnc");
assertEquals(xmlGuessEnc, e.getXmlGuessEncoding(), "xmlGuessEnc");
assertEquals(xmlEnc, e.getXmlEncoding(), "xmlEnc");
assertEquals(XmlStreamReader.getContentTypeEncoding(httpContentType), e.getContentTypeEncoding(),
"ContentTypeEncoding");
assertEquals(XmlStreamReader.getContentTypeMime(httpContentType), e.getContentTypeMime(), "ContentTypeMime");
} catch (final Exception e) {
fail("Expected XmlStreamReaderException, but threw " + e);
}
}
private void checkRawEncoding(final String expected,
final String bomEnc, final String xmlGuessEnc, final String xmlEnc, final String defaultEncoding) throws IOException {
final StringBuilder builder = new StringBuilder();
builder.append("RawEncoding: ").append(bomEnc).append("], ");
builder.append("bomEnc=[").append(bomEnc).append("], ");
builder.append("xmlGuessEnc=[").append(xmlGuessEnc).append("], ");
builder.append("xmlEnc=[").append(xmlEnc).append("], ");
builder.append("defaultEncoding=[").append(defaultEncoding).append("],");
final String encoding = calculateRawEncoding(bomEnc, xmlGuessEnc, xmlEnc, defaultEncoding);
assertEquals(expected, encoding, builder.toString());
}
private void checkRawError(final String msgSuffix,
final String bomEnc, final String xmlGuessEnc, final String xmlEnc, final String defaultEncoding) {
try {
checkRawEncoding("XmlStreamReaderException", bomEnc, xmlGuessEnc, xmlEnc, defaultEncoding);
fail("Expected XmlStreamReaderException");
} catch (final XmlStreamReaderException e) {
assertTrue(e.getMessage().startsWith("Illegal encoding"), "Msg Start: " + e.getMessage());
assertTrue(e.getMessage().endsWith(msgSuffix), "Msg End: " + e.getMessage());
assertEquals(bomEnc, e.getBomEncoding(), "bomEnc");
assertEquals(xmlGuessEnc, e.getXmlGuessEncoding(), "xmlGuessEnc");
assertEquals(xmlEnc, e.getXmlEncoding(), "xmlEnc");
assertNull(e.getContentTypeEncoding(), "ContentTypeEncoding");
assertNull(e.getContentTypeMime(), "ContentTypeMime");
} catch (final Exception e) {
fail("Expected XmlStreamReaderException, but threw " + e);
}
}
@SuppressWarnings("boxing")
private void checkTextXml(final boolean expected, final String mime) {
assertEquals(expected, XmlStreamReader.isTextXml(mime), "Mime=[" + mime + "]");
}
@Test
public void testAppXml() {
checkAppXml(false, null);
checkAppXml(false, "");
checkAppXml(true, "application/xml");
checkAppXml(true, "application/xml-dtd");
checkAppXml(true, "application/xml-external-parsed-entity");
checkAppXml(true, "application/soap+xml");
checkAppXml(true, "application/atom+xml");
checkAppXml(false, "application/atomxml");
checkAppXml(false, "text/xml");
checkAppXml(false, "text/atom+xml");
checkAppXml(true, "application/xml-dtd");
checkAppXml(true, "application/xml-external-parsed-entity");
}
@Test
public void testCalculateHttpEncoding() throws IOException {
// No BOM Expected Lenient cType BOM Guess XML Default
checkHttpError(HTTPMGS3, true, null, null, null, null, null);
checkHttpError(HTTPMGS3, false, null, null, null, "UTF-8", null);
checkHttpEncoding("UTF-8", true, null, null, null, "UTF-8", null);
checkHttpEncoding("UTF-16LE", true, null, null, null, "UTF-16LE", null);
checkHttpError(HTTPMGS3, false, "text/css", null, null, null, null);
checkHttpEncoding("US-ASCII", false, TXTXML, null, null, null, null);
checkHttpEncoding("UTF-16BE", false, TXTXML, null, null, null, "UTF-16BE");
checkHttpEncoding("UTF-8", false, APPXML, null, null, null, null);
checkHttpEncoding("UTF-16BE", false, APPXML, null, null, null, "UTF-16BE");
checkHttpEncoding("UTF-8", false, APPXML, "UTF-8", null, null, "UTF-16BE");
checkHttpEncoding("UTF-16LE", false, APPXML_UTF16LE, null, null, null, null);
checkHttpEncoding("UTF-16BE", false, APPXML_UTF16BE, null, null, null, null);
checkHttpError(HTTPMGS1, false, APPXML_UTF16LE, "UTF-16LE", null, null, null);
checkHttpError(HTTPMGS1, false, APPXML_UTF16BE, "UTF-16BE", null, null, null);
checkHttpError(HTTPMGS2, false, APPXML_UTF16, null, null, null, null);
checkHttpError(HTTPMGS2, false, APPXML_UTF16, "UTF-8", null, null, null);
checkHttpEncoding("UTF-16LE", false, APPXML_UTF16, "UTF-16LE", null, null, null);
checkHttpEncoding("UTF-16BE", false, APPXML_UTF16, "UTF-16BE", null, null, null);
checkHttpEncoding("UTF-8", false, APPXML_UTF8, null, null, null, null);
checkHttpEncoding("UTF-8", false, APPXML_UTF8, "UTF-16BE", "UTF-16BE", "UTF-16BE", "UTF-16BE");
}
@Test
public void testCalculateHttpEncodingUtf32() throws IOException {
// No BOM Expected Lenient cType BOM Guess XML Default
checkHttpEncoding("UTF-32LE", true, null, null, null, "UTF-32LE", null);
checkHttpEncoding("UTF-32BE", false, TXTXML, null, null, null, "UTF-32BE");
checkHttpEncoding("UTF-32BE", false, APPXML, null, null, null, "UTF-32BE");
checkHttpEncoding("UTF-32LE", false, APPXML_UTF32LE, null, null, null, null);
checkHttpEncoding("UTF-32BE", false, APPXML_UTF32BE, null, null, null, null);
checkHttpError(HTTPMGS1, false, APPXML_UTF32LE, "UTF-32LE", null, null, null);
checkHttpError(HTTPMGS1, false, APPXML_UTF32BE, "UTF-32BE", null, null, null);
checkHttpError(HTTPMGS2, false, APPXML_UTF32, null, null, null, null);
checkHttpError(HTTPMGS2, false, APPXML_UTF32, "UTF-8", null, null, null);
checkHttpEncoding("UTF-32LE", false, APPXML_UTF32, "UTF-32LE", null, null, null);
checkHttpEncoding("UTF-32BE", false, APPXML_UTF32, "UTF-32BE", null, null, null);
checkHttpEncoding("UTF-8", false, APPXML_UTF8, "UTF-32BE", "UTF-32BE", "UTF-32BE", "UTF-32BE");
}
@Test
public void testCalculateRawEncodingAdditionalUTF16() throws IOException {
// BOM Guess XML Default
checkRawError(RAWMGS1, "UTF-16BE", "UTF-16", null, null);
checkRawEncoding("UTF-16BE", "UTF-16BE", null, "UTF-16", null);
checkRawEncoding("UTF-16BE", "UTF-16BE", "UTF-16BE", "UTF-16", null);
checkRawError(RAWMGS1, "UTF-16BE", null, "UTF-16LE", null);
checkRawError(RAWMGS1, "UTF-16BE", "UTF-16BE", "UTF-16LE", null);
checkRawError(RAWMGS1, "UTF-16LE", "UTF-16", null, null);
checkRawEncoding("UTF-16LE", "UTF-16LE", null, "UTF-16", null);
checkRawEncoding("UTF-16LE", "UTF-16LE", "UTF-16LE", "UTF-16", null);
checkRawError(RAWMGS1, "UTF-16LE", null, "UTF-16BE", null);
checkRawError(RAWMGS1, "UTF-16LE", "UTF-16LE", "UTF-16BE", null);
}
@Test
public void testCalculateRawEncodingAdditionalUTF32() throws IOException {
// BOM Guess XML Default
checkRawError(RAWMGS1, "UTF-32BE", "UTF-32", null, null);
checkRawEncoding("UTF-32BE", "UTF-32BE", null, "UTF-32", null);
checkRawEncoding("UTF-32BE", "UTF-32BE", "UTF-32BE", "UTF-32", null);
checkRawError(RAWMGS1, "UTF-32BE", null, "UTF-32LE", null);
checkRawError(RAWMGS1, "UTF-32BE", "UTF-32BE", "UTF-32LE", null);
checkRawError(RAWMGS1, "UTF-32LE", "UTF-32", null, null);
checkRawEncoding("UTF-32LE", "UTF-32LE", null, "UTF-32", null);
checkRawEncoding("UTF-32LE", "UTF-32LE", "UTF-32LE", "UTF-32", null);
checkRawError(RAWMGS1, "UTF-32LE", null, "UTF-32BE", null);
checkRawError(RAWMGS1, "UTF-32LE", "UTF-32LE", "UTF-32BE", null);
}
@Test
public void testCalculateRawEncodingNoBOM() throws IOException {
// No BOM Expected BOM Guess XML Default
checkRawError(RAWMGS2, "UTF-32", null, null, null);
//
checkRawEncoding("UTF-8", null, null, null, null);
checkRawEncoding("UTF-8", null, "UTF-16BE", null, null); /* why default & not Guess? */
checkRawEncoding("UTF-8", null, null, "UTF-16BE", null); /* why default & not XMLEnc? */
checkRawEncoding("UTF-8", null, "UTF-8", "UTF-8", "UTF-16BE");
//
checkRawEncoding("UTF-16BE", null, "UTF-16BE", "UTF-16BE", null);
checkRawEncoding("UTF-16BE", null, null, null, "UTF-16BE");
checkRawEncoding("UTF-16BE", null, "UTF-8", null, "UTF-16BE"); /* why default & not Guess? */
checkRawEncoding("UTF-16BE", null, null, "UTF-8", "UTF-16BE"); /* why default & not Guess? */
checkRawEncoding("UTF-16BE", null, "UTF-16BE", "UTF-16", null);
checkRawEncoding("UTF-16LE", null, "UTF-16LE", "UTF-16", null);
}
@Test
public void testCalculateRawEncodingStandard() throws IOException {
// Standard BOM Checks BOM Other Default
testCalculateRawEncodingStandard("UTF-8", "UTF-16BE", "UTF-16LE");
testCalculateRawEncodingStandard("UTF-16BE", "UTF-8", "UTF-16LE");
testCalculateRawEncodingStandard("UTF-16LE", "UTF-8", "UTF-16BE");
}
private void testCalculateRawEncodingStandard(final String bomEnc, final String otherEnc, final String defaultEnc) throws IOException {
// Expected BOM Guess XMLEnc Default
checkRawEncoding(bomEnc, bomEnc, null, null, defaultEnc);
checkRawEncoding(bomEnc, bomEnc, bomEnc, null, defaultEnc);
checkRawError(RAWMGS1, bomEnc, otherEnc, null, defaultEnc);
checkRawEncoding(bomEnc, bomEnc, null, bomEnc, defaultEnc);
checkRawError(RAWMGS1, bomEnc, null, otherEnc, defaultEnc);
checkRawEncoding(bomEnc, bomEnc, bomEnc, bomEnc, defaultEnc);
checkRawError(RAWMGS1, bomEnc, bomEnc, otherEnc, defaultEnc);
checkRawError(RAWMGS1, bomEnc, otherEnc, bomEnc, defaultEnc);
}
@Test
public void testCalculateRawEncodingStandardUtf32() throws IOException {
// Standard BOM Checks BOM Other Default
testCalculateRawEncodingStandard("UTF-8", "UTF-32BE", "UTF-32LE");
testCalculateRawEncodingStandard("UTF-32BE", "UTF-8", "UTF-32LE");
testCalculateRawEncodingStandard("UTF-32LE", "UTF-8", "UTF-32BE");
}
@Test
public void testContentTypeEncoding() {
checkContentTypeEncoding(null, null);
checkContentTypeEncoding(null, "");
checkContentTypeEncoding(null, "application/xml");
checkContentTypeEncoding(null, "application/xml;");
checkContentTypeEncoding(null, "multipart/mixed;boundary=frontier");
checkContentTypeEncoding(null, "multipart/mixed;boundary='frontier'");
checkContentTypeEncoding(null, "multipart/mixed;boundary=\"frontier\"");
checkContentTypeEncoding("UTF-16", "application/xml;charset=utf-16");
checkContentTypeEncoding("UTF-16", "application/xml;charset=UTF-16");
checkContentTypeEncoding("UTF-16", "application/xml;charset='UTF-16'");
checkContentTypeEncoding("UTF-16", "application/xml;charset=\"UTF-16\"");
checkContentTypeEncoding("UTF-32", "application/xml;charset=utf-32");
checkContentTypeEncoding("UTF-32", "application/xml;charset=UTF-32");
checkContentTypeEncoding("UTF-32", "application/xml;charset='UTF-32'");
checkContentTypeEncoding("UTF-32", "application/xml;charset=\"UTF-32\"");
}
@Test
public void testContentTypeMime() {
checkContentTypeMime(null, null);
checkContentTypeMime("", "");
checkContentTypeMime("application/xml", "application/xml");
checkContentTypeMime("application/xml", "application/xml;");
checkContentTypeMime("application/xml", "application/xml;charset=utf-16");
checkContentTypeMime("application/xml", "application/xml;charset=utf-32");
}
@Test
public void testTextXml() {
checkTextXml(false, null);
checkTextXml(false, "");
checkTextXml(true, "text/xml");
checkTextXml(true, "text/xml-external-parsed-entity");
checkTextXml(true, "text/soap+xml");
checkTextXml(true, "text/atom+xml");
checkTextXml(false, "text/atomxml");
checkTextXml(false, "application/xml");
checkTextXml(false, "application/atom+xml");
}
}
|
