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.design;
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.design.ThrowsCountCheck;
31  
32  public class XpathRegressionThrowsCountTest extends AbstractXpathTestSupport {
33  
34      private final String checkName = ThrowsCountCheck.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/design/throwscount";
44      }
45  
46      @Test
47      public void testDefault() throws Exception {
48          final File fileToProcess =
49                  new File(getPath("InputXpathThrowsCountDefault.java"));
50          final DefaultConfiguration moduleConfig =
51                  createModuleConfig(ThrowsCountCheck.class);
52          final String[] expectedViolation = {
53              "4:30: " + getCheckMessage(ThrowsCountCheck.class,
54                          ThrowsCountCheck.MSG_KEY, 5, 4),
55          };
56          final List<String> expectedXpathQueries = Collections.singletonList(
57                  "/COMPILATION_UNIT"
58                      + "/CLASS_DEF[./IDENT[@text='InputXpathThrowsCountDefault']]"
59                      + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='myFunction']]"
60                      + "/LITERAL_THROWS[./IDENT[@text='CloneNotSupportedException']]"
61  
62          );
63  
64          runVerifications(moduleConfig, fileToProcess, expectedViolation,
65                  expectedXpathQueries);
66      }
67  
68      @Test
69      public void testCustomMax() throws Exception {
70          final File fileToProcess =
71                  new File(getPath("InputXpathThrowsCountCustomMax.java"));
72          final DefaultConfiguration moduleConfig =
73                  createModuleConfig(ThrowsCountCheck.class);
74  
75          moduleConfig.addProperty("max", "2");
76  
77          final String[] expectedViolation = {
78              "4:30: " + getCheckMessage(ThrowsCountCheck.class,
79                          ThrowsCountCheck.MSG_KEY, 3, 2),
80          };
81          final List<String> expectedXpathQueries = Collections.singletonList(
82                  "/COMPILATION_UNIT"
83                      + "/INTERFACE_DEF[./IDENT[@text='InputXpathThrowsCountCustomMax']]"
84                      + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='myFunction']]"
85                      + "/LITERAL_THROWS[./IDENT[@text='IllegalStateException']]"
86  
87          );
88  
89          runVerifications(moduleConfig, fileToProcess, expectedViolation,
90                  expectedXpathQueries);
91      }
92  
93      @Test
94      public void testPrivateMethods() throws Exception {
95          final File fileToProcess =
96                  new File(getPath("InputXpathThrowsCountPrivateMethods.java"));
97          final DefaultConfiguration moduleConfig =
98                  createModuleConfig(ThrowsCountCheck.class);
99  
100         moduleConfig.addProperty("ignorePrivateMethods", "false");
101 
102         final String[] expectedViolation = {
103             "9:40: " + getCheckMessage(ThrowsCountCheck.class,
104                         ThrowsCountCheck.MSG_KEY, 5, 4),
105         };
106         final List<String> expectedXpathQueries = Collections.singletonList(
107                 "/COMPILATION_UNIT"
108                     + "/CLASS_DEF[./IDENT[@text='InputXpathThrowsCountPrivateMethods']]"
109                     + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='myFunc']]"
110                     + "/SLIST/VARIABLE_DEF[./IDENT[@text='foo']]"
111                     + "/ASSIGN/EXPR/LITERAL_NEW[./IDENT[@text='myClass']]"
112                     + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='privateFunc']]"
113                     + "/LITERAL_THROWS[./IDENT[@text='CloneNotSupportedException']]"
114 
115         );
116 
117         runVerifications(moduleConfig, fileToProcess, expectedViolation,
118                 expectedXpathQueries);
119     }
120 }