View Javadoc
1   ////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code for adherence to a set of rules.
3   // Copyright (C) 2001-2017 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      @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          assertArrayEquals("Default required tokens are invalid",
44              expected, checkObj.getRequiredTokens());
45      }
46  
47      @Test
48      public void testSpecified()
49              throws Exception {
50          final DefaultConfiguration checkConfig =
51              createModuleConfig(StaticVariableNameCheck.class);
52          checkConfig.addAttribute("format", "^s[A-Z][a-zA-Z0-9]*$");
53  
54          final String pattern = "^s[A-Z][a-zA-Z0-9]*$";
55  
56          final String[] expected = {
57              "30:24: " + getCheckMessage(MSG_INVALID_PATTERN, "badStatic", pattern),
58          };
59          verify(checkConfig, getPath("InputStaticVariableName1.java"), expected);
60      }
61  
62      @Test
63      public void testAccessTuning()
64              throws Exception {
65          final DefaultConfiguration checkConfig =
66              createModuleConfig(StaticVariableNameCheck.class);
67          checkConfig.addAttribute("format", "^s[A-Z][a-zA-Z0-9]*$");
68  
69          // allow method names and class names to equal
70          checkConfig.addAttribute("applyToPrivate", "false");
71  
72          final String[] expected = CommonUtils.EMPTY_STRING_ARRAY;
73          verify(checkConfig, getPath("InputStaticVariableName1.java"), expected);
74      }
75  
76      @Test
77      public void testInterfaceOrAnnotationBlock()
78              throws Exception {
79          final DefaultConfiguration checkConfig =
80                  createModuleConfig(StaticVariableNameCheck.class);
81          final String[] expected = CommonUtils.EMPTY_STRING_ARRAY;
82          verify(checkConfig, getPath("InputStaticVariableName.java"), expected);
83      }
84  
85      @Test
86      public void testGetAcceptableTokens() {
87          final StaticVariableNameCheck staticVariableNameCheckObj = new StaticVariableNameCheck();
88          final int[] actual = staticVariableNameCheckObj.getAcceptableTokens();
89          final int[] expected = {
90              TokenTypes.VARIABLE_DEF,
91          };
92          assertArrayEquals("Default acceptable tokens are invalid", expected, actual);
93      }
94  }