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.coding;
21  
22  import static com.puppycrawl.tools.checkstyle.checks.coding.NestedForDepthCheck.MSG_KEY;
23  
24  import org.junit.Assert;
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.utils.CommonUtils;
30  
31  public class NestedForDepthCheckTest extends AbstractModuleTestSupport {
32  
33      @Override
34      protected String getPackageLocation() {
35          return "com/puppycrawl/tools/checkstyle/checks/coding/nestedfordepth";
36      }
37  
38      /**
39       * Call the check allowing 2 layers of nested for-statements. This
40       * means the top-level for can contain up to 2 levels of nested for
41       * statements. As the test input has 4 layers of for-statements below
42       * the top-level for statement, this must cause 2 error-messages.
43       *
44       * @throws Exception necessary to fulfill JUnit's
45       *     interface-requirements for test-methods.
46       */
47      @Test
48      public void testNestedTooDeep() throws Exception {
49          final DefaultConfiguration checkConfig =
50              createModuleConfig(NestedForDepthCheck.class);
51          checkConfig.addAttribute("max", "2");
52  
53          final String[] expected = {
54              "43:11: " + getCheckMessage(MSG_KEY, 3, 2),
55              "44:13: " + getCheckMessage(MSG_KEY, 4, 2),
56              "47:13: " + getCheckMessage(MSG_KEY, 4, 2),
57          };
58  
59          verify(checkConfig, getPath("InputNestedForDepth.java"),
60                 expected);
61      }
62  
63      /**
64       * Call the check allowing 4 layers of nested for-statements. This
65       * means the top-level for can contain up to 4 levels of nested for
66       * statements. As the test input has 4 layers of for-statements below
67       * the top-level for statement, this must not cause an
68       * error-message.
69       *
70       * @throws Exception necessary to fulfill JUnit's
71       *     interface-requirements for test-methods.
72       */
73      @Test
74      public void testNestedOk() throws Exception {
75          final DefaultConfiguration checkConfig =
76              createModuleConfig(NestedForDepthCheck.class);
77          checkConfig.addAttribute("max", "4");
78  
79          final String[] expected = CommonUtils.EMPTY_STRING_ARRAY;
80  
81          verify(checkConfig, getPath("InputNestedForDepth.java"),
82                 expected);
83      }
84  
85      @Test
86      public void testTokensNotNull() {
87          final NestedForDepthCheck check = new NestedForDepthCheck();
88          Assert.assertNotNull("Acceptable tokens should not be null", check.getAcceptableTokens());
89          Assert.assertNotNull("Default tokens should not be null", check.getDefaultTokens());
90          Assert.assertNotNull("Required tokens should not be null", check.getRequiredTokens());
91      }
92  
93  }