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 StaticVariableNameCheckExamplesTest extends AbstractExamplesModuleTestSupport {
29  
30      public static final String STATIC_VAR_NAME_PATTERN_1 = "^[a-z][a-zA-Z0-9]*$";
31      public static final String STATIC_VAR_NAME_PATTERN_2 = "^[a-z](_?[a-zA-Z0-9]+)*$";
32  
33      @Override
34      protected String getPackageLocation() {
35          return "com/puppycrawl/tools/checkstyle/checks/naming/staticvariablename";
36      }
37  
38      @Test
39      public void testExample1() throws Exception {
40          final String[] expected = {
41              "19:21: " + getCheckMessage(MSG_INVALID_PATTERN,
42                      "ItStatic1", STATIC_VAR_NAME_PATTERN_1),
43              "20:24: " + getCheckMessage(MSG_INVALID_PATTERN,
44                      "ItStatic2", STATIC_VAR_NAME_PATTERN_1),
45              "21:22: " + getCheckMessage(MSG_INVALID_PATTERN,
46                      "ItStatic", STATIC_VAR_NAME_PATTERN_1),
47              "22:21: " + getCheckMessage(MSG_INVALID_PATTERN,
48                      "it_static", STATIC_VAR_NAME_PATTERN_1),
49              "23:21: " + getCheckMessage(MSG_INVALID_PATTERN,
50                      "It_Static", STATIC_VAR_NAME_PATTERN_1),
51              "24:22: " + getCheckMessage(MSG_INVALID_PATTERN,
52                      "It_Static1", STATIC_VAR_NAME_PATTERN_1),
53              "25:14: " + getCheckMessage(MSG_INVALID_PATTERN,
54                      "It_Static2", STATIC_VAR_NAME_PATTERN_1),
55          };
56  
57          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
58      }
59  
60      @Test
61      public void testExample2() throws Exception {
62          final String[] expected = {
63              "21:22: " + getCheckMessage(MSG_INVALID_PATTERN,
64                      "ItStatic", STATIC_VAR_NAME_PATTERN_1),
65              "24:22: " + getCheckMessage(MSG_INVALID_PATTERN,
66                      "It_Static1", STATIC_VAR_NAME_PATTERN_1),
67              "25:14: " + getCheckMessage(MSG_INVALID_PATTERN,
68                      "It_Static2", STATIC_VAR_NAME_PATTERN_1),
69          };
70  
71          verifyWithInlineConfigParser(getPath("Example2.java"), expected);
72      }
73  
74      @Test
75      public void testExample3() throws Exception {
76          final String[] expected = {
77              "19:21: " + getCheckMessage(MSG_INVALID_PATTERN,
78                      "ItStatic1", STATIC_VAR_NAME_PATTERN_2),
79              "20:24: " + getCheckMessage(MSG_INVALID_PATTERN,
80                      "ItStatic2", STATIC_VAR_NAME_PATTERN_2),
81              "23:21: " + getCheckMessage(MSG_INVALID_PATTERN,
82                      "It_Static", STATIC_VAR_NAME_PATTERN_2),
83          };
84  
85          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
86      }
87  }