View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2025 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.coding;
21  
22  import java.io.File;
23  import java.util.Collections;
24  import java.util.List;
25  
26  import org.checkstyle.suppressionxpathfilter.AbstractXpathTestSupport;
27  import org.junit.jupiter.api.Test;
28  
29  import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
30  import com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck;
31  
32  public class XpathRegressionNestedIfDepthTest extends AbstractXpathTestSupport {
33  
34      private final String checkName = NestedIfDepthCheck.class.getSimpleName();
35  
36      @Override
37      protected String getCheckName() {
38          return checkName;
39      }
40  
41      @Override
42      protected String getPackageLocation() {
43          return "org/checkstyle/suppressionxpathfilter/coding/nestedifdepth";
44      }
45  
46      @Test
47      public void testCorrect() throws Exception {
48          final File fileToProcess =
49                  new File(getPath("InputXpathNestedIfDepth.java"));
50  
51          final DefaultConfiguration moduleConfig =
52                  createModuleConfig(NestedIfDepthCheck.class);
53  
54          final String[] expectedViolation = {
55              "10:17: " + getCheckMessage(NestedIfDepthCheck.class,
56                   NestedIfDepthCheck.MSG_KEY, 2, 1),
57          };
58  
59          final List<String> expectedXpathQueries = Collections.singletonList(
60              "/COMPILATION_UNIT/CLASS_DEF"
61                  + "[./IDENT[@text='InputXpathNestedIfDepth']]/OBJBLOCK"
62                  + "/METHOD_DEF[./IDENT[@text='test']]/SLIST/LITERAL_IF"
63                  + "/SLIST/LITERAL_IF/SLIST/LITERAL_IF"
64          );
65  
66          runVerifications(moduleConfig, fileToProcess, expectedViolation,
67                  expectedXpathQueries);
68      }
69  
70      @Test
71      public void testMax() throws Exception {
72          final File fileToProcess =
73              new File(getPath("InputXpathNestedIfDepthMax.java"));
74  
75          final DefaultConfiguration moduleConfig =
76              createModuleConfig(NestedIfDepthCheck.class);
77          moduleConfig.addProperty("max", "3");
78  
79          final String[] expectedViolation = {
80              "12:25: " + getCheckMessage(NestedIfDepthCheck.class,
81                  NestedIfDepthCheck.MSG_KEY, 4, 3),
82          };
83  
84          final List<String> expectedXpathQueries = Collections.singletonList(
85              "/COMPILATION_UNIT/CLASS_DEF"
86                  + "[./IDENT[@text='InputXpathNestedIfDepthMax']]"
87                  + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]"
88                  + "/SLIST/LITERAL_IF/"
89                  + "SLIST/LITERAL_IF/"
90                  + "SLIST/LITERAL_IF/"
91                  + "SLIST/LITERAL_IF/"
92                  + "SLIST/LITERAL_IF"
93          );
94  
95          runVerifications(moduleConfig, fileToProcess, expectedViolation,
96              expectedXpathQueries);
97      }
98  }