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 org.checkstyle.suppressionxpathfilter.coding;
21  
22  import java.io.File;
23  import java.util.Collections;
24  import java.util.List;
25  
26  import org.checkstyle.suppressionxpathfilter.AbstractXpathTestSupport;
27  import org.junit.jupiter.api.Test;
28  
29  import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
30  import com.puppycrawl.tools.checkstyle.checks.coding.IllegalSymbolCheck;
31  
32  public class XpathRegressionIllegalSymbolTest extends AbstractXpathTestSupport {
33  
34      private final String checkName = IllegalSymbolCheck.class.getSimpleName();
35  
36      @Override
37      protected String getCheckName() {
38          return checkName;
39      }
40  
41      @Override
42      public String getPackageLocation() {
43          return "org/checkstyle/suppressionxpathfilter/coding/illegalsymbol";
44      }
45  
46      @Test
47      public void testEmoji() throws Exception {
48          final File fileToProcess =
49                  new File(getPath("InputXpathIllegalSymbolEmoji.java"));
50  
51          final DefaultConfiguration moduleConfig =
52                  createModuleConfig(IllegalSymbolCheck.class);
53          moduleConfig.addProperty("symbolCodes", "0x2705");
54  
55          final String[] expectedViolation = {
56              "4:18: " + getCheckMessage(IllegalSymbolCheck.class, IllegalSymbolCheck.MSG_KEY, "✅"),
57          };
58  
59          final List<String> expectedXpathQueries = Collections.singletonList(
60                  "/COMPILATION_UNIT/CLASS_DEF[./IDENT[@text='InputXpathIllegalSymbolEmoji']]"
61                  + "/OBJBLOCK/SINGLE_LINE_COMMENT/COMMENT_CONTENT[@text=' ✅ // warn\\n']"
62          );
63  
64          runVerifications(moduleConfig, fileToProcess, expectedViolation,
65                  expectedXpathQueries);
66      }
67  
68      @Test
69      public void testAsciiOnly() throws Exception {
70          final File fileToProcess =
71                  new File(getPath("InputXpathIllegalSymbolAsciiOnly.java"));
72  
73          final DefaultConfiguration moduleConfig =
74                  createModuleConfig(IllegalSymbolCheck.class);
75          moduleConfig.addProperty("symbolCodes", "0x0080-0x10FFFF");
76  
77          final String[] expectedViolation = {
78              "4:18: " + getCheckMessage(IllegalSymbolCheck.class, IllegalSymbolCheck.MSG_KEY, "é"),
79          };
80  
81          final List<String> expectedXpathQueries = Collections.singletonList(
82                  "/COMPILATION_UNIT/CLASS_DEF[./IDENT[@text='InputXpathIllegalSymbolAsciiOnly']]"
83                  + "/OBJBLOCK/SINGLE_LINE_COMMENT/COMMENT_CONTENT[@text=' café // warn\\n']"
84          );
85  
86          runVerifications(moduleConfig, fileToProcess, expectedViolation,
87                  expectedXpathQueries);
88      }
89  
90      @Test
91      public void testStringLiteral() throws Exception {
92          final File fileToProcess =
93              new File(getPath("InputXpathIllegalSymbolStringLiteral.java"));
94  
95          final DefaultConfiguration moduleConfig =
96              createModuleConfig(IllegalSymbolCheck.class);
97          moduleConfig.addProperty("symbolCodes", "0x2705");
98          moduleConfig.addProperty("tokens", "STRING_LITERAL");
99  
100         final String[] expectedViolation = {
101             "4:20: " + getCheckMessage(IllegalSymbolCheck.class, IllegalSymbolCheck.MSG_KEY, "✅"),
102         };
103 
104         final List<String> expectedXpathQueries = List.of(
105             "/COMPILATION_UNIT/CLASS_DEF[./IDENT[@text='InputXpathIllegalSymbolStringLiteral']]"
106                 + "/OBJBLOCK/VARIABLE_DEF[./IDENT[@text='value']]"
107                 + "/ASSIGN/EXPR[./STRING_LITERAL[@text='Hello ✅']]",
108             "/COMPILATION_UNIT/CLASS_DEF[./IDENT[@text='InputXpathIllegalSymbolStringLiteral']]"
109                 + "/OBJBLOCK/VARIABLE_DEF[./IDENT[@text='value']]"
110                 + "/ASSIGN/EXPR/STRING_LITERAL[@text='Hello ✅']"
111         );
112 
113         runVerifications(moduleConfig, fileToProcess, expectedViolation,
114             expectedXpathQueries);
115     }
116 }