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 LocalFinalVariableNameCheckTest
33      extends AbstractModuleTestSupport {
34  
35      @Override
36      protected String getPackageLocation() {
37          return "com/puppycrawl/tools/checkstyle/checks/naming/localfinalvariablename";
38      }
39  
40      @Test
41      public void testGetRequiredTokens() {
42          final LocalFinalVariableNameCheck checkObj =
43              new LocalFinalVariableNameCheck();
44          assertArrayEquals(
45              "LocalFinalVariableNameCheck#getRequiredTokens should return empty array by default",
46              CommonUtils.EMPTY_INT_ARRAY, checkObj.getRequiredTokens());
47      }
48  
49      @Test
50      public void testDefault()
51              throws Exception {
52          final DefaultConfiguration checkConfig =
53              createModuleConfig(LocalFinalVariableNameCheck.class);
54  
55          final String pattern = "^[a-z][a-zA-Z0-9]*$";
56  
57          final String[] expected = {
58              "123:19: " + getCheckMessage(MSG_INVALID_PATTERN, "CDE", pattern),
59          };
60          verify(checkConfig, getPath("InputLocalFinalVariableName.java"), expected);
61      }
62  
63      @Test
64      public void testSet()
65              throws Exception {
66          final DefaultConfiguration checkConfig =
67              createModuleConfig(LocalFinalVariableNameCheck.class);
68          checkConfig.addAttribute("format", "[A-Z]+");
69  
70          final String pattern = "[A-Z]+";
71  
72          final String[] expected = {
73              "122:19: " + getCheckMessage(MSG_INVALID_PATTERN, "cde", pattern),
74          };
75          verify(checkConfig, getPath("InputLocalFinalVariableName.java"), expected);
76      }
77  
78      @Test
79      public void testInnerClass()
80              throws Exception {
81          final DefaultConfiguration checkConfig =
82              createModuleConfig(LocalFinalVariableNameCheck.class);
83          final String[] expected = CommonUtils.EMPTY_STRING_ARRAY;
84          verify(checkConfig, getPath("InputLocalFinalVariableNameInnerClass.java"), expected);
85      }
86  
87      @Test
88      public void testGetAcceptableTokens() {
89          final LocalFinalVariableNameCheck localFinalVariableNameCheckObj =
90              new LocalFinalVariableNameCheck();
91          final int[] actual = localFinalVariableNameCheckObj.getAcceptableTokens();
92          final int[] expected = {
93              TokenTypes.VARIABLE_DEF,
94              TokenTypes.PARAMETER_DEF,
95              TokenTypes.RESOURCE,
96          };
97          assertArrayEquals("Default acceptable tokens are invalid", expected, actual);
98      }
99  
100     @Test
101     public void testTryWithResources() throws Exception {
102         final DefaultConfiguration checkConfig =
103             createModuleConfig(LocalFinalVariableNameCheck.class);
104         checkConfig.addAttribute("format", "[A-Z]+");
105 
106         final String pattern = "[A-Z]+";
107 
108         final String[] expected = {
109             "23:30: " + getCheckMessage(MSG_INVALID_PATTERN, "br", pattern),
110             "33:29: " + getCheckMessage(MSG_INVALID_PATTERN, "br", pattern),
111             "53:22: " + getCheckMessage(MSG_INVALID_PATTERN, "zf", pattern),
112             "71:30: " + getCheckMessage(MSG_INVALID_PATTERN, "fis8859_1", pattern),
113             "73:32: " + getCheckMessage(MSG_INVALID_PATTERN, "isrutf8", pattern),
114         };
115         verify(checkConfig, getPath("InputLocalFinalVariableNameTryResources.java"), expected);
116     }
117 
118 }