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 org.checkstyle.suppressionxpathfilter;
21  
22  import java.io.File;
23  import java.util.Collections;
24  import java.util.List;
25  
26  import org.junit.jupiter.api.Test;
27  
28  import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
29  import com.puppycrawl.tools.checkstyle.checks.coding.NestedForDepthCheck;
30  
31  public class XpathRegressionNestedForDepthTest extends AbstractXpathTestSupport {
32  
33      private final String checkName = NestedForDepthCheck.class.getSimpleName();
34  
35      @Override
36      protected String getCheckName() {
37          return checkName;
38      }
39  
40      @Test
41      public void testCorrect() throws Exception {
42          final File fileToProcess =
43                  new File(getPath("InputXpathNestedForDepth.java"));
44  
45          final DefaultConfiguration moduleConfig =
46                  createModuleConfig(NestedForDepthCheck.class);
47  
48          final String[] expectedViolation = {
49              "7:17: " + getCheckMessage(NestedForDepthCheck.class,
50                  NestedForDepthCheck.MSG_KEY, 2, 1),
51          };
52  
53          final List<String> expectedXpathQueries = Collections.singletonList(
54              "/COMPILATION_UNIT/CLASS_DEF"
55                  + "[./IDENT[@text='InputXpathNestedForDepth']]/OBJBLOCK"
56                  + "/METHOD_DEF[./IDENT[@text='test']]/SLIST/LITERAL_FOR"
57                  + "/SLIST/LITERAL_FOR/SLIST/LITERAL_FOR"
58          );
59  
60          runVerifications(moduleConfig, fileToProcess, expectedViolation,
61                  expectedXpathQueries);
62      }
63  
64      @Test
65      public void testMax() throws Exception {
66          final File fileToProcess =
67                  new File(getPath("InputXpathNestedForDepthMax.java"));
68  
69          final DefaultConfiguration moduleConfig =
70                  createModuleConfig(NestedForDepthCheck.class);
71          moduleConfig.addProperty("max", "2");
72  
73          final String[] expectedViolation = {
74              "8:21: " + getCheckMessage(NestedForDepthCheck.class,
75                  NestedForDepthCheck.MSG_KEY, 3, 2),
76          };
77  
78          final List<String> expectedXpathQueries = Collections.singletonList(
79              "/COMPILATION_UNIT/CLASS_DEF"
80                  + "[./IDENT[@text='InputXpathNestedForDepthMax']]"
81                  + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]"
82                  + "/SLIST/LITERAL_FOR/"
83                  + "SLIST/LITERAL_FOR/"
84                  + "SLIST/LITERAL_FOR/"
85                  + "SLIST/LITERAL_FOR"
86          );
87  
88          runVerifications(moduleConfig, fileToProcess, expectedViolation,
89                  expectedXpathQueries);
90      }
91  }