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.PackageNameCheck.MSG_KEY;
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 PackageNameCheckTest
33      extends AbstractModuleTestSupport {
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          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(PackageNameCheck.class);
52          checkConfig.addAttribute("format", "[A-Z]+");
53  
54          final String pattern = "[A-Z]+";
55  
56          final String[] expected = {
57              "6:9: " + getCheckMessage(MSG_KEY,
58                  "com.puppycrawl.tools.checkstyle.checks.naming.packagename", pattern),
59          };
60          verify(checkConfig, getPath("InputPackageNameSimple.java"), expected);
61      }
62  
63      @Test
64      public void testDefault()
65              throws Exception {
66          final DefaultConfiguration checkConfig =
67              createModuleConfig(PackageNameCheck.class);
68          final String[] expected = CommonUtils.EMPTY_STRING_ARRAY;
69          verify(checkConfig, getPath("InputPackageNameSimple.java"), expected);
70      }
71  
72      @Test
73      public void testGetAcceptableTokens() {
74          final PackageNameCheck packageNameCheckObj = new PackageNameCheck();
75          final int[] actual = packageNameCheckObj.getAcceptableTokens();
76          final int[] expected = {
77              TokenTypes.PACKAGE_DEF,
78          };
79          assertArrayEquals("Default acceptable tokens are invalid", expected, actual);
80      }
81  }