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 ClassTypeParameterNameCheckTest
31      extends AbstractModuleTestSupport {
32  
33      @Override
34      protected String getPackageLocation() {
35          return "com/puppycrawl/tools/checkstyle/checks/naming/classtypeparametername";
36      }
37  
38      @Test
39      public void testGetClassRequiredTokens() {
40          final ClassTypeParameterNameCheck checkObj =
41              new ClassTypeParameterNameCheck();
42          final int[] expected = {TokenTypes.TYPE_PARAMETER};
43          assertWithMessage("Default required tokens are invalid")
44              .that(checkObj.getRequiredTokens())
45              .isEqualTo(expected);
46      }
47  
48      @Test
49      public void testClassDefault()
50              throws Exception {
51  
52          final String pattern = "^[A-Z]$";
53  
54          final String[] expected = {
55              "12:42: " + getCheckMessage(MSG_INVALID_PATTERN, "t", pattern),
56              "20:14: " + getCheckMessage(MSG_INVALID_PATTERN, "foo", pattern),
57              "34:24: " + getCheckMessage(MSG_INVALID_PATTERN, "foo", pattern),
58          };
59          verifyWithInlineConfigParser(
60                  getPath("InputClassTypeParameterName.java"), expected);
61      }
62  
63      @Test
64      public void testClassFooName()
65              throws Exception {
66  
67          final String pattern = "^foo$";
68  
69          final String[] expected = {
70              "12:43: " + getCheckMessage(MSG_INVALID_PATTERN, "t", pattern),
71              "40:19: " + getCheckMessage(MSG_INVALID_PATTERN, "T", pattern),
72          };
73          verifyWithInlineConfigParser(
74                  getPath("InputClassTypeParameterName1.java"), expected);
75      }
76  
77      @Test
78      public void testGetAcceptableTokens() {
79          final ClassTypeParameterNameCheck typeParameterNameCheckObj =
80              new ClassTypeParameterNameCheck();
81          final int[] actual = typeParameterNameCheckObj.getAcceptableTokens();
82          final int[] expected = {
83              TokenTypes.TYPE_PARAMETER,
84          };
85          assertWithMessage("Default acceptable tokens are invalid")
86              .that(actual)
87              .isEqualTo(expected);
88      }
89  
90  }