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  
30  public class MethodTypeParameterNameCheckTest
31      extends AbstractModuleTestSupport {
32  
33      @Override
34      protected String getPackageLocation() {
35          return "com/puppycrawl/tools/checkstyle/checks/naming/methodtypeparametername";
36      }
37  
38      @Test
39      public void testGetAcceptableTokens() {
40          final MethodTypeParameterNameCheck methodTypeParameterNameCheck =
41              new MethodTypeParameterNameCheck();
42          final int[] expected = {TokenTypes.TYPE_PARAMETER};
43  
44          assertWithMessage("Default acceptable tokens are invalid")
45              .that(methodTypeParameterNameCheck.getAcceptableTokens())
46              .isEqualTo(expected);
47      }
48  
49      @Test
50      public void testGetRequiredTokens() {
51          final MethodTypeParameterNameCheck checkObj =
52              new MethodTypeParameterNameCheck();
53          final int[] expected = {TokenTypes.TYPE_PARAMETER};
54          assertWithMessage("Default required tokens are invalid")
55              .that(checkObj.getRequiredTokens())
56              .isEqualTo(expected);
57      }
58  
59      @Test
60      public void testMethodDefault()
61              throws Exception {
62  
63          final String pattern = "^[A-Z]$";
64  
65          final String[] expected = {
66              "14:13: " + getCheckMessage(MSG_INVALID_PATTERN, "TT", pattern),
67              "16:6: " + getCheckMessage(MSG_INVALID_PATTERN, "e_e", pattern),
68              "26:6: " + getCheckMessage(MSG_INVALID_PATTERN, "Tfo$o2T", pattern),
69              "30:6: " + getCheckMessage(MSG_INVALID_PATTERN, "foo", pattern),
70              "35:10: " + getCheckMessage(MSG_INVALID_PATTERN, "_fo", pattern),
71          };
72          verifyWithInlineConfigParser(
73                  getPath("InputMethodTypeParameterName.java"), expected);
74      }
75  
76      @Test
77      public void testMethodFooName()
78              throws Exception {
79  
80          final String pattern = "^foo$";
81  
82          final String[] expected = {
83              "14:13: " + getCheckMessage(MSG_INVALID_PATTERN, "TT", pattern),
84              "16:6: " + getCheckMessage(MSG_INVALID_PATTERN, "e_e", pattern),
85              "26:6: " + getCheckMessage(MSG_INVALID_PATTERN, "Tfo$o2T", pattern),
86              "35:10: " + getCheckMessage(MSG_INVALID_PATTERN, "_fo", pattern),
87              "42:6: " + getCheckMessage(MSG_INVALID_PATTERN, "E", pattern),
88              "44:14: " + getCheckMessage(MSG_INVALID_PATTERN, "T", pattern),
89          };
90          verifyWithInlineConfigParser(
91                  getPath("InputMethodTypeParameterName1.java"), expected);
92      }
93  
94  }