View Javadoc
1   ////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code for adherence to a set of rules.
3   // Copyright (C) 2001-2018 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  import static org.junit.Assert.assertArrayEquals;
24  
25  import org.junit.Test;
26  
27  import com.puppycrawl.tools.checkstyle.AbstractModuleTestSupport;
28  import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
29  import com.puppycrawl.tools.checkstyle.api.TokenTypes;
30  import com.puppycrawl.tools.checkstyle.utils.CommonUtils;
31  
32  public class StaticVariableNameCheckTest
33      extends AbstractModuleTestSupport {
34  
35      @Override
36      protected String getPackageLocation() {
37          return "com/puppycrawl/tools/checkstyle/checks/naming/staticvariablename";
38      }
39  
40      @Test
41      public void testGetRequiredTokens() {
42          final StaticVariableNameCheck checkObj = new StaticVariableNameCheck();
43          final int[] expected = {TokenTypes.VARIABLE_DEF};
44          assertArrayEquals("Default required tokens are invalid",
45              expected, checkObj.getRequiredTokens());
46      }
47  
48      @Test
49      public void testSpecified()
50              throws Exception {
51          final DefaultConfiguration checkConfig =
52              createModuleConfig(StaticVariableNameCheck.class);
53          checkConfig.addAttribute("format", "^s[A-Z][a-zA-Z0-9]*$");
54  
55          final String pattern = "^s[A-Z][a-zA-Z0-9]*$";
56  
57          final String[] expected = {
58              "30:24: " + getCheckMessage(MSG_INVALID_PATTERN, "badStatic", pattern),
59          };
60          verify(checkConfig, getPath("InputStaticVariableName1.java"), expected);
61      }
62  
63      @Test
64      public void testAccessTuning()
65              throws Exception {
66          final DefaultConfiguration checkConfig =
67              createModuleConfig(StaticVariableNameCheck.class);
68          checkConfig.addAttribute("format", "^s[A-Z][a-zA-Z0-9]*$");
69  
70          // allow method names and class names to equal
71          checkConfig.addAttribute("applyToPrivate", "false");
72  
73          final String[] expected = CommonUtils.EMPTY_STRING_ARRAY;
74          verify(checkConfig, getPath("InputStaticVariableName1.java"), expected);
75      }
76  
77      @Test
78      public void testInterfaceOrAnnotationBlock()
79              throws Exception {
80          final DefaultConfiguration checkConfig =
81                  createModuleConfig(StaticVariableNameCheck.class);
82          final String[] expected = CommonUtils.EMPTY_STRING_ARRAY;
83          verify(checkConfig, getPath("InputStaticVariableName.java"), expected);
84      }
85  
86      @Test
87      public void testGetAcceptableTokens() {
88          final StaticVariableNameCheck staticVariableNameCheckObj = new StaticVariableNameCheck();
89          final int[] actual = staticVariableNameCheckObj.getAcceptableTokens();
90          final int[] expected = {
91              TokenTypes.VARIABLE_DEF,
92          };
93          assertArrayEquals("Default acceptable tokens are invalid", expected, actual);
94      }
95  
96  }