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.naming;
21  
22  import static com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck.MSG_INVALID_PATTERN;
23  
24  import org.junit.jupiter.api.Test;
25  
26  import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport;
27  
28  public class IllegalIdentifierNameCheckExamplesTest extends AbstractExamplesModuleTestSupport {
29  
30      @Override
31      public String getPackageLocation() {
32          return "com/puppycrawl/tools/checkstyle/checks/naming/illegalidentifiername";
33      }
34  
35      @Test
36      public void testExample1() throws Exception {
37          final String format = "^(?!var$|\\S*\\$)\\S+$";
38  
39          final String[] expected = {
40              "17:11: " + getCheckMessage(MSG_INVALID_PATTERN, "var", format),
41              "21:10: " + getCheckMessage(MSG_INVALID_PATTERN, "test$stuff", format),
42          };
43  
44          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
45      }
46  
47      @Test
48      public void testExample2() throws Exception {
49          final String format =
50                  "(?i)^(?!(when|record|yield|var|permits|sealed|open|transitive|_)$|(.*\\$)).+$";
51  
52          final String[] expected = {
53              "17:11: " + getCheckMessage(MSG_INVALID_PATTERN, "var", format),
54              "18:7: " + getCheckMessage(MSG_INVALID_PATTERN, "record", format),
55              "19:10: " + getCheckMessage(MSG_INVALID_PATTERN, "yield", format),
56              "21:10: " + getCheckMessage(MSG_INVALID_PATTERN, "test$stuff", format),
57              "22:10: " + getCheckMessage(MSG_INVALID_PATTERN, "when", format),
58              "23:10: " + getCheckMessage(MSG_INVALID_PATTERN, "Record", format),
59              "25:19: " + getCheckMessage(MSG_INVALID_PATTERN, "record", format),
60              "33:7: " + getCheckMessage(MSG_INVALID_PATTERN, "open", format),
61              "34:10: " + getCheckMessage(MSG_INVALID_PATTERN, "transitive", format),
62          };
63  
64          verifyWithInlineConfigParser(getPath("Example2.java"), expected);
65      }
66  
67      @Test
68      public void testExample3() throws Exception {
69          final String format = "^(?!var$|\\S*\\$)\\S+$";
70  
71          final String[] expected = {
72              "16:11: " + getCheckMessage(MSG_INVALID_PATTERN, "var", format),
73              "20:10: " + getCheckMessage(MSG_INVALID_PATTERN, "test$stuff", format),
74          };
75  
76          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
77      }
78  
79  }