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.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      protected 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 testSpecified()
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("InputStaticVariableName1.java"), expected);
59      }
60  
61      @Test
62      public void testAccessTuning()
63              throws Exception {
64          final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
65          verifyWithInlineConfigParser(
66                  getPath("InputStaticVariableName2.java"), expected);
67      }
68  
69      @Test
70      public void testInterfaceOrAnnotationBlock()
71              throws Exception {
72          final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
73          verifyWithInlineConfigParser(
74                  getPath("InputStaticVariableName.java"), expected);
75      }
76  
77      @Test
78      public void testGetAcceptableTokens() {
79          final StaticVariableNameCheck staticVariableNameCheckObj = new StaticVariableNameCheck();
80          final int[] actual = staticVariableNameCheckObj.getAcceptableTokens();
81          final int[] expected = {
82              TokenTypes.VARIABLE_DEF,
83          };
84          assertWithMessage("Default acceptable tokens are invalid")
85                  .that(actual)
86                  .isEqualTo(expected);
87      }
88  
89  }