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.PackageNameCheck.MSG_KEY;
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  import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
30  
31  public class PackageNameCheckTest
32      extends AbstractModuleTestSupport {
33  
34      @Override
35      protected String getPackageLocation() {
36          return "com/puppycrawl/tools/checkstyle/checks/naming/packagename";
37      }
38  
39      @Test
40      public void testGetRequiredTokens() {
41          final PackageNameCheck checkObj = new PackageNameCheck();
42          final int[] expected = {TokenTypes.PACKAGE_DEF};
43          assertWithMessage("Default required tokens are invalid")
44                  .that(checkObj.getRequiredTokens())
45                  .isEqualTo(expected);
46      }
47  
48      @Test
49      public void testSpecified()
50              throws Exception {
51  
52          final String pattern = "[A-Z]+";
53  
54          final String[] expected = {
55              "8:9: " + getCheckMessage(MSG_KEY,
56                  "com.puppycrawl.tools.checkstyle.checks.naming.packagename", pattern),
57          };
58          verifyWithInlineConfigParser(
59                  getPath("InputPackageNameSimple1.java"), expected);
60      }
61  
62      @Test
63      public void testDefault()
64              throws Exception {
65          final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
66          verifyWithInlineConfigParser(
67                  getPath("InputPackageNameSimple.java"), expected);
68      }
69  
70      @Test
71      public void testGetAcceptableTokens() {
72          final PackageNameCheck packageNameCheckObj = new PackageNameCheck();
73          final int[] actual = packageNameCheckObj.getAcceptableTokens();
74          final int[] expected = {
75              TokenTypes.PACKAGE_DEF,
76          };
77          assertWithMessage("Default acceptable tokens are invalid")
78                  .that(actual)
79                  .isEqualTo(expected);
80      }
81  
82  }