View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.doxia.util;
20  
21  import java.net.URLEncoder;
22  
23  import org.codehaus.plexus.testing.PlexusTest;
24  import org.junit.jupiter.api.Test;
25  
26  import static org.junit.jupiter.api.Assertions.assertEquals;
27  import static org.junit.jupiter.api.Assertions.assertNotNull;
28  import static org.junit.jupiter.api.Assertions.assertNull;
29  
30  /**
31   * Test case for <code>HtmlTools</code>.
32   *
33   * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
34   */
35  @PlexusTest
36  public class HtmlToolsTest {
37      /**
38       * Verify the expected results.
39       */
40      @Test
41      public void testEscapeHTML() {
42          assertEquals(HtmlTools.escapeHTML(null), "");
43          assertEquals(HtmlTools.escapeHTML(""), "");
44          assertEquals(HtmlTools.escapeHTML("\u0009"), "\u0009");
45          assertEquals(HtmlTools.escapeHTML("\u0001"), "\u0001");
46  
47          // Predefined entities
48          assertEquals(HtmlTools.escapeHTML("<"), "&lt;");
49          assertEquals(HtmlTools.escapeHTML(">"), "&gt;");
50          assertEquals(HtmlTools.escapeHTML("&"), "&amp;");
51          assertEquals(HtmlTools.escapeHTML("\""), "&quot;");
52          assertEquals(HtmlTools.escapeHTML("\'"), "&apos;");
53          assertEquals(HtmlTools.escapeHTML("\'", false), "\'");
54  
55          // xml mode
56          assertEquals(HtmlTools.escapeHTML("&amp;"), "&amp;amp;");
57          assertEquals(HtmlTools.escapeHTML("\u00e4", true), "\u00e4");
58          assertEquals(HtmlTools.escapeHTML("\u00e4", false), "&#xe4;");
59          assertEquals(HtmlTools.escapeHTML("\u0159", false), "&#x159;");
60          assertEquals(HtmlTools.escapeHTML("\uD835\uDFED", false), "&#x1d7ed;");
61      }
62  
63      /**
64       * Verify the expected results.
65       */
66      @Test
67      public void testUnescapeHTML() {
68          assertNull(HtmlTools.unescapeHTML(null));
69          assertEquals("", HtmlTools.unescapeHTML(""));
70          assertEquals("\u0009", HtmlTools.unescapeHTML("\u0009"));
71          assertEquals("\u0001", HtmlTools.unescapeHTML("\u0001"));
72          assertEquals("<", HtmlTools.unescapeHTML("&lt;"));
73          assertEquals(">", HtmlTools.unescapeHTML("&gt;"));
74          assertEquals("&", HtmlTools.unescapeHTML("&amp;"));
75          assertEquals("\"", HtmlTools.unescapeHTML("&quot;"));
76          assertEquals("&apos;", HtmlTools.unescapeHTML("&apos;"));
77          assertEquals("\'", HtmlTools.unescapeHTML("&apos;", true));
78          assertEquals("&amp;", HtmlTools.unescapeHTML("&amp;amp;"));
79          assertEquals("&lt;Fran&ccedil;ais&gt;", HtmlTools.unescapeHTML("&amp;lt;Fran&amp;ccedil;ais&amp;gt;"));
80          assertEquals("\u0159", HtmlTools.unescapeHTML("&#x159;"));
81          assertEquals("\uD808\uDF45", HtmlTools.unescapeHTML("&#x12345;"));
82          assertEquals("\uD835\uDFED", HtmlTools.unescapeHTML("&#x1d7ed;"));
83          assertEquals("\uD808\uDF45\uD835\uDFED", HtmlTools.unescapeHTML("&#x12345;&#x1d7ed;"));
84          assertEquals("&#x1d7ed &#x1d7ed", HtmlTools.unescapeHTML("&#x1d7ed &#x1d7ed"));
85          assertEquals("&#x1d7ed \uD835\uDFED", HtmlTools.unescapeHTML("&#x1d7ed &#x1d7ed;"));
86          assertEquals("&#xQWER;", HtmlTools.unescapeHTML("&#xQWER;"));
87          assertEquals("\u00E5", HtmlTools.unescapeHTML("&#229;"));
88          assertEquals(
89                  "<>&\"\u00E5\u0159\uD835\uDFED", HtmlTools.unescapeHTML("&lt;&gt;&amp;&quot;&#229;&#x159;&#x1d7ed;"));
90      }
91  
92      /**
93       * Verify the expected results.
94       *
95       * @throws Exception should not happen.
96       */
97      @Test
98      public void testEncodeURL() throws Exception {
99          assertNull(HtmlTools.encodeURL(null));
100         assertEquals(HtmlTools.encodeURL(""), "");
101         assertEquals(
102                 HtmlTools.encodeURL("http://www.example.com/?This is a simple test."),
103                 "http://www.example.com/?This%20is%20a%20simple%20test.");
104 
105         assertEquals(
106                 HtmlTools.encodeURL("http://www.example.com/?This is a simple & short test."),
107                 "http://www.example.com/?This%20is%20a%20simple%20&%20short%20test.");
108 
109         String url = "\uD808\uDF45";
110         assertEquals(HtmlTools.encodeURL(url), URLEncoder.encode(url, "UTF-8"));
111     }
112 
113     /**
114      * Verify the expected results.
115      */
116     @Test
117     public void testGetHtmlTag() {
118         assertNull(HtmlTools.getHtmlTag(null));
119         assertNull(HtmlTools.getHtmlTag(""));
120         assertNull(HtmlTools.getHtmlTag("weirdHtmlTag"));
121         assertNotNull(HtmlTools.getHtmlTag("strong"));
122     }
123 }