/*
* Copyright (C) 2009 The Guava Authors
*
* Licensed 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 com.google.common.xml;
import static com.google.common.escape.testing.EscaperAsserts.assertEscaping;
import static com.google.common.escape.testing.EscaperAsserts.assertUnescaped;
import com.google.common.annotations.GwtCompatible;
import com.google.common.escape.CharEscaper;
import junit.framework.TestCase;
/**
* Tests for the {@link XmlEscapers} class.
*
* @author Alex Matevossian
* @author David Beaumont
*/
@GwtCompatible
public class XmlEscapersTest extends TestCase {
public void testXmlContentEscaper() throws Exception {
CharEscaper xmlContentEscaper = (CharEscaper) XmlEscapers.xmlContentEscaper();
assertBasicXmlEscaper(xmlContentEscaper, false, false);
// Test quotes are not escaped.
assertEquals("\"test\"", xmlContentEscaper.escape("\"test\""));
assertEquals("'test'", xmlContentEscaper.escape("'test'"));
}
public void testXmlAttributeEscaper() throws Exception {
CharEscaper xmlAttributeEscaper = (CharEscaper) XmlEscapers.xmlAttributeEscaper();
assertBasicXmlEscaper(xmlAttributeEscaper, true, true);
// Test quotes are escaped.
assertEquals(""test"", xmlAttributeEscaper.escape("\"test\""));
assertEquals("'test'", xmlAttributeEscaper.escape("\'test'"));
// Test all escapes
assertEquals("a"b<c>d&e"f'",
xmlAttributeEscaper.escape("a\"b<c>d&e\"f'"));
// Test '\t', '\n' and '\r' are escaped.
assertEquals("a	b
c
d", xmlAttributeEscaper.escape("a\tb\nc\rd"));
}
// Helper to assert common properties of xml escapers.
private void assertBasicXmlEscaper(CharEscaper xmlEscaper,
boolean shouldEscapeQuotes, boolean shouldEscapeWhitespaceChars) {
// Simple examples (smoke tests)
assertEquals("xxx", xmlEscaper.escape("xxx"));
assertEquals("test & test & test",
xmlEscaper.escape("test & test & test"));
assertEquals("test << 1", xmlEscaper.escape("test << 1"));
assertEquals("test >> 1", xmlEscaper.escape("test >> 1"));
assertEquals("<tab>", xmlEscaper.escape("<tab>"));
// Test all non-escaped ASCII characters.
String s = "!@#$%^*()_+=-/?\\|]}[{,.;:" +
"abcdefghijklmnopqrstuvwxyz" +
"ABCDEFGHIJKLMNOPQRSTUVWXYZ" +
"1234567890";
assertEquals(s, xmlEscaper.escape(s));
// Test ASCII control characters.
for (char ch = 0; ch < 0x20; ch++) {
if (ch == '\t' || ch == '\n' || ch == '\r') {
// Only these whitespace chars are permitted in XML,
if (shouldEscapeWhitespaceChars) {
assertEscaping(xmlEscaper, "&#x" + Integer.toHexString(ch).toUpperCase() + ";", ch);
} else {
assertUnescaped(xmlEscaper, ch);
}
} else {
// and everything else is replaced with FFFD.
assertEscaping(xmlEscaper, "\uFFFD", ch);
}
}
// Test _all_ allowed characters (including surrogate values).
for (char ch = 0x20; ch <= 0xFFFD; ch++) {
// There are a small number of cases to consider, so just do it manually.
if (ch == '&') {
assertEscaping(xmlEscaper, "&", ch);
} else if (ch == '<') {
assertEscaping(xmlEscaper, "<", ch);
} else if (ch == '>') {
assertEscaping(xmlEscaper, ">", ch);
} else if (shouldEscapeQuotes && ch == '\'') {
assertEscaping(xmlEscaper, "'", ch);
} else if (shouldEscapeQuotes && ch == '"') {
assertEscaping(xmlEscaper, """, ch);
} else {
String input = String.valueOf(ch);
String escaped = xmlEscaper.escape(input);
assertEquals(
"char 0x" + Integer.toString(ch, 16) + " should not be escaped",
input, escaped);
}
}
// Test that 0xFFFE and 0xFFFF are replaced with 0xFFFD
assertEscaping(xmlEscaper, "\uFFFD", '\uFFFE');
assertEscaping(xmlEscaper, "\uFFFD", '\uFFFF');
assertEquals("0xFFFE is forbidden and should be replaced during escaping",
"[\uFFFD]", xmlEscaper.escape("[\ufffe]"));
assertEquals("0xFFFF is forbidden and should be replaced during escaping",
"[\uFFFD]", xmlEscaper.escape("[\uffff]"));
}
}