View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2024 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 LocalVariableNameCheckExamplesTest extends AbstractExamplesModuleTestSupport {
29      @Override
30      protected String getPackageLocation() {
31          return "com/puppycrawl/tools/checkstyle/checks/naming/localvariablename";
32      }
33  
34      @Test
35      public void testExample1() throws Exception {
36          final String pattern = "^([a-z][a-zA-Z0-9]*|_)$";
37          final String[] expected = {
38              "15:14: " + getCheckMessage(MSG_INVALID_PATTERN, "VAR", pattern),
39              "17:14: " + getCheckMessage(MSG_INVALID_PATTERN, "var_1", pattern),
40          };
41  
42          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
43      }
44  
45      @Test
46      public void testExample2() throws Exception {
47          final String pattern = "^[a-z](_?[a-zA-Z0-9]+)*$";
48          final String[] expected = {
49              "17:14: " + getCheckMessage(MSG_INVALID_PATTERN, "VAR", pattern),
50          };
51  
52          verifyWithInlineConfigParser(getPath("Example2.java"), expected);
53      }
54  
55      @Test
56      public void testExample3() throws Exception {
57          final String pattern = "^[a-z](_?[a-zA-Z0-9]+)*$";
58          final String[] expected = {
59              "20:13: " + getCheckMessage(MSG_INVALID_PATTERN, "K", pattern),
60              "23:17: " + getCheckMessage(MSG_INVALID_PATTERN, "O", pattern),
61          };
62  
63          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
64      }
65  
66      @Test
67      public void testExample4() throws Exception {
68          final String pattern = "^[a-z][_a-zA-Z0-9]+$";
69          final String[] expected = {
70              "21:9: " + getCheckMessage(MSG_INVALID_PATTERN, "g", pattern),
71              "23:11: " + getCheckMessage(MSG_INVALID_PATTERN, "a", pattern),
72              "26:11: " + getCheckMessage(MSG_INVALID_PATTERN, "I", pattern),
73              "30:14: " + getCheckMessage(MSG_INVALID_PATTERN, "a", pattern),
74              "33:14: " + getCheckMessage(MSG_INVALID_PATTERN, "A", pattern),
75          };
76  
77          verifyWithInlineConfigParser(getPath("Example4.java"), expected);
78      }
79  
80      @Test
81      public void testExample5() throws Exception {
82          final String pattern = "^[a-z][_a-zA-Z0-9]{2,}$";
83          final String[] expected = {
84              "17:9: " + getCheckMessage(MSG_INVALID_PATTERN, "i", pattern),
85              "19:11: " + getCheckMessage(MSG_INVALID_PATTERN, "j", pattern),
86          };
87  
88          verifyWithInlineConfigParser(getPath("Example5.java"), expected);
89      }
90  }
91