View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2026 the original author or authors.
4   //
5   // This library is free software; you can redistribute it and/or
6   // modify it under the terms of the GNU Lesser General Public
7   // License as published by the Free Software Foundation; either
8   // version 2.1 of the License, or (at your option) any later version.
9   //
10  // This library is distributed in the hope that it will be useful,
11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  // Lesser General Public License for more details.
14  //
15  // You should have received a copy of the GNU Lesser General Public
16  // License along with this library; if not, write to the Free Software
17  // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  ///////////////////////////////////////////////////////////////////////////////////////////////
19  
20  package com.puppycrawl.tools.checkstyle.checks.coding;
21  
22  import static com.google.common.truth.Truth.assertWithMessage;
23  import static com.puppycrawl.tools.checkstyle.checks.coding.IllegalSymbolCheck.MSG_KEY;
24  
25  import org.junit.jupiter.api.Test;
26  
27  import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport;
28  import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
29  
30  public class IllegalSymbolCheckExamplesTest extends AbstractExamplesModuleTestSupport {
31  
32      @Override
33      public String getPackageLocation() {
34          return "com/puppycrawl/tools/checkstyle/checks/coding/illegalsymbol";
35      }
36  
37      @Test
38      public void testExample1() throws Exception {
39          final String[] expected = {
40              "12:5: " + getCheckMessage(MSG_KEY, "✅"),
41              "13:5: " + getCheckMessage(MSG_KEY, "😀"),
42          };
43  
44          verifyWithInlineConfigParser(
45                  getPath("Example1.java"), expected);
46      }
47  
48      @Test
49      public void testExample2() throws Exception {
50          final String[] expected = {
51              "16:5: " + getCheckMessage(MSG_KEY, "🌟"),
52          };
53  
54          verifyWithInlineConfigParser(
55                  getPath("Example2.java"), expected);
56      }
57  
58      @Test
59      public void testExample3() throws Exception {
60          final String[] expected = {
61              "14:5: " + getCheckMessage(MSG_KEY, "é"),
62          };
63  
64          verifyWithInlineConfigParser(
65                  getPath("Example3.java"), expected);
66      }
67  
68      @Test
69      public void testExample4() throws Exception {
70          final String[] expected = {
71              "18:19: " + getCheckMessage(MSG_KEY, "😀"),
72          };
73  
74          verifyWithInlineConfigParser(
75                  getPath("Example4.java"), expected);
76      }
77  
78      @Test
79      public void testTokens() {
80          final IllegalSymbolCheck check = new IllegalSymbolCheck();
81          assertWithMessage("Required tokens should be empty")
82                  .that(check.getRequiredTokens())
83                  .isEqualTo(CommonUtil.EMPTY_INT_ARRAY);
84          assertWithMessage("Comment nodes should be required")
85                  .that(check.isCommentNodesRequired())
86                  .isTrue();
87      }
88  
89      @Test
90      public void testExample5() throws Exception {
91          final String[] expected = {
92              "16:5: Only ASCII characters are allowed.",
93          };
94  
95          verifyWithInlineConfigParser(
96                  getPath("Example5.java"), expected);
97      }
98  }