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.sizes;
21  
22  import static com.puppycrawl.tools.checkstyle.checks.sizes.OuterTypeNumberCheck.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 OuterTypeNumberCheckTest extends AbstractModuleTestSupport {
33  
34      @Override
35      protected String getPackageLocation() {
36          return "com/puppycrawl/tools/checkstyle/checks/sizes/outertypenumber";
37      }
38  
39      @Test
40      public void testGetRequiredTokens() {
41          final OuterTypeNumberCheck checkObj = new OuterTypeNumberCheck();
42          final int[] expected = {
43              TokenTypes.CLASS_DEF,
44              TokenTypes.INTERFACE_DEF,
45              TokenTypes.ENUM_DEF,
46              TokenTypes.ANNOTATION_DEF,
47          };
48          assertArrayEquals("Default required tokens are invalid",
49              expected, checkObj.getRequiredTokens());
50      }
51  
52      @Test
53      public void testGetAcceptableTokens() {
54          final OuterTypeNumberCheck outerTypeNumberObj =
55              new OuterTypeNumberCheck();
56          final int[] actual = outerTypeNumberObj.getAcceptableTokens();
57          final int[] expected = {
58              TokenTypes.CLASS_DEF,
59              TokenTypes.INTERFACE_DEF, TokenTypes.ENUM_DEF,
60              TokenTypes.ANNOTATION_DEF,
61          };
62  
63          assertArrayEquals("Default acceptable tokens are invalid", expected, actual);
64      }
65  
66      @Test
67      public void testDefault() throws Exception {
68          final DefaultConfiguration checkConfig =
69              createModuleConfig(OuterTypeNumberCheck.class);
70          final String[] expected = {
71              "6:1: " + getCheckMessage(MSG_KEY, 3, 1),
72          };
73          verify(checkConfig, getPath("InputOuterTypeNumberSimple.java"), expected);
74      }
75  
76      @Test
77      public void testMax30() throws Exception {
78          final DefaultConfiguration checkConfig =
79              createModuleConfig(OuterTypeNumberCheck.class);
80          checkConfig.addAttribute("max", "30");
81          final String[] expected = CommonUtils.EMPTY_STRING_ARRAY;
82          verify(checkConfig, getPath("InputOuterTypeNumberSimple.java"), expected);
83      }
84  
85      @Test
86      public void testWithInnerClass() throws Exception {
87          final DefaultConfiguration checkConfig =
88              createModuleConfig(OuterTypeNumberCheck.class);
89          checkConfig.addAttribute("max", "1");
90          final String[] expected = CommonUtils.EMPTY_STRING_ARRAY;
91          verify(checkConfig, getPath("InputOuterTypeNumberEmptyInner.java"), expected);
92      }
93  
94  }