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.google.common.truth.Truth.assertWithMessage;
23  import static com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck.MSG_INVALID_PATTERN;
24  
25  import org.junit.jupiter.api.Test;
26  
27  import com.puppycrawl.tools.checkstyle.AbstractModuleTestSupport;
28  import com.puppycrawl.tools.checkstyle.api.TokenTypes;
29  import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
30  
31  public class StaticVariableNameCheckTest
32      extends AbstractModuleTestSupport {
33  
34      @Override
35      public String getPackageLocation() {
36          return "com/puppycrawl/tools/checkstyle/checks/naming/staticvariablename";
37      }
38  
39      @Test
40      public void testGetRequiredTokens() {
41          final StaticVariableNameCheck checkObj = new StaticVariableNameCheck();
42          final int[] expected = {TokenTypes.VARIABLE_DEF};
43          assertWithMessage("Default required tokens are invalid")
44                  .that(checkObj.getRequiredTokens())
45                  .isEqualTo(expected);
46      }
47  
48      @Test
49      public void testSpecifiedA()
50              throws Exception {
51  
52          final String pattern = "^s[A-Z][a-zA-Z0-9]*$";
53  
54          final String[] expected = {
55              "36:24: " + getCheckMessage(MSG_INVALID_PATTERN, "badStatic", pattern),
56          };
57          verifyWithInlineConfigParser(
58                  getPath("InputStaticVariableName1A.java"), expected);
59      }
60  
61      @Test
62      public void testSpecifiedB()
63              throws Exception {
64  
65          final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
66  
67          verifyWithInlineConfigParser(
68                  getPath("InputStaticVariableName1B.java"), expected);
69      }
70  
71      @Test
72      public void testSpecifiedC()
73              throws Exception {
74  
75          final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
76  
77          verifyWithInlineConfigParser(
78                  getPath("InputStaticVariableName1C.java"), expected);
79      }
80  
81      @Test
82      public void testAccessTuningA()
83              throws Exception {
84          final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
85          verifyWithInlineConfigParser(
86                  getPath("InputStaticVariableName2A.java"), expected);
87      }
88  
89      @Test
90      public void testAccessTuningB()
91              throws Exception {
92          final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
93          verifyWithInlineConfigParser(
94                  getPath("InputStaticVariableName2B.java"), expected);
95      }
96  
97      @Test
98      public void testAccessTuningC()
99              throws Exception {
100         final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
101         verifyWithInlineConfigParser(
102                 getPath("InputStaticVariableName2C.java"), expected);
103     }
104 
105     @Test
106     public void testInterfaceOrAnnotationBlock()
107             throws Exception {
108         final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
109         verifyWithInlineConfigParser(
110                 getPath("InputStaticVariableName.java"), expected);
111     }
112 
113     @Test
114     public void testGetAcceptableTokens() {
115         final StaticVariableNameCheck staticVariableNameCheckObj = new StaticVariableNameCheck();
116         final int[] actual = staticVariableNameCheckObj.getAcceptableTokens();
117         final int[] expected = {
118             TokenTypes.VARIABLE_DEF,
119         };
120         assertWithMessage("Default acceptable tokens are invalid")
121                 .that(actual)
122                 .isEqualTo(expected);
123     }
124 
125 }