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 LocalVariableNameCheckExamplesTest extends AbstractExamplesModuleTestSupport {
29  
30      @Override
31      public String getPackageLocation() {
32          return "com/puppycrawl/tools/checkstyle/checks/naming/localvariablename";
33      }
34  
35      @Test
36      public void testExample1() throws Exception {
37          final String pattern = "^([a-z][a-zA-Z0-9]*|_)$";
38          final String[] expected = {
39              "20:14: " + getCheckMessage(MSG_INVALID_PATTERN, "VAR", pattern),
40              "23:14: " + getCheckMessage(MSG_INVALID_PATTERN, "var_1", pattern),
41              "28:14: " + getCheckMessage(MSG_INVALID_PATTERN, "V", pattern),
42              "30:11: " + getCheckMessage(MSG_INVALID_PATTERN, "I", pattern),
43              "36:17: " + getCheckMessage(MSG_INVALID_PATTERN, "O", pattern),
44              "38:14: " + getCheckMessage(MSG_INVALID_PATTERN, "A", pattern),
45          };
46  
47          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
48      }
49  
50      @Test
51      public void testExample2() throws Exception {
52          final String pattern = "^[a-z](_?[a-zA-Z0-9]+)*$";
53          final String[] expected = {
54              "22:14: " + getCheckMessage(MSG_INVALID_PATTERN, "VAR", pattern),
55              "30:14: " + getCheckMessage(MSG_INVALID_PATTERN, "V", pattern),
56              "32:11: " + getCheckMessage(MSG_INVALID_PATTERN, "I", pattern),
57              "38:17: " + getCheckMessage(MSG_INVALID_PATTERN, "O", pattern),
58              "40:14: " + getCheckMessage(MSG_INVALID_PATTERN, "A", pattern),
59          };
60  
61          verifyWithInlineConfigParser(getPath("Example2.java"), expected);
62      }
63  
64      @Test
65      public void testUseCase1() throws Exception {
66          final String pattern = "^[a-z](_?[a-zA-Z0-9]+)*$";
67          final String[] expected = {
68              "20:13: " + getCheckMessage(MSG_INVALID_PATTERN, "K", pattern),
69              "23:17: " + getCheckMessage(MSG_INVALID_PATTERN, "O", pattern),
70          };
71  
72          verifyWithInlineConfigParser(getPath("UseCase1.java"), expected);
73      }
74  
75      @Test
76      public void testExample3() throws Exception {
77          final String pattern = "^[a-z][_a-zA-Z0-9]+$";
78          final String[] expected = {
79              "21:9: " + getCheckMessage(MSG_INVALID_PATTERN, "g", pattern),
80              "23:14: " + getCheckMessage(MSG_INVALID_PATTERN, "VAR", pattern),
81              "29:11: " + getCheckMessage(MSG_INVALID_PATTERN, "a", pattern),
82              "33:11: " + getCheckMessage(MSG_INVALID_PATTERN, "I", pattern),
83              "37:14: " + getCheckMessage(MSG_INVALID_PATTERN, "a", pattern),
84              "41:14: " + getCheckMessage(MSG_INVALID_PATTERN, "A", pattern),
85          };
86  
87          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
88      }
89  
90      @Test
91      public void testUseCase2() throws Exception {
92          final String pattern = "^[a-z][_a-zA-Z0-9]{2,}$";
93          final String[] expected = {
94              "17:9: " + getCheckMessage(MSG_INVALID_PATTERN, "i", pattern),
95              "19:11: " + getCheckMessage(MSG_INVALID_PATTERN, "j", pattern),
96          };
97  
98          verifyWithInlineConfigParser(getPath("UseCase2.java"), expected);
99      }
100 
101 }