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.RequireThisCheck;
31  
32  public class XpathRegressionRequireThisTest extends AbstractXpathTestSupport {
33  
34      private final String checkName = RequireThisCheck.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/requirethis";
44      }
45  
46      @Test
47      public void testOne() throws Exception {
48          final File fileToProcess =
49                  new File(getPath("InputXpathRequireThisOne.java"));
50  
51          final DefaultConfiguration moduleConfig =
52                  createModuleConfig(RequireThisCheck.class);
53          moduleConfig.addProperty("validateOnlyOverlapping", "false");
54  
55          final String[] expectedViolation = {
56              "7:9: " + getCheckMessage(RequireThisCheck.class,
57                  RequireThisCheck.MSG_VARIABLE, "age", ""),
58          };
59  
60          final List<String> expectedXpathQueries = Collections.singletonList(
61              "/COMPILATION_UNIT/CLASS_DEF"
62                  + "[./IDENT[@text='InputXpathRequireThisOne']]/OBJBLOCK"
63                  + "/METHOD_DEF[./IDENT[@text='changeAge']]/SLIST/EXPR/ASSIGN"
64                  + "/IDENT[@text='age']"
65          );
66  
67          runVerifications(moduleConfig, fileToProcess, expectedViolation,
68                  expectedXpathQueries);
69      }
70  
71      @Test
72      public void testTwo() throws Exception {
73          final File fileToProcess =
74                  new File(getPath("InputXpathRequireThisTwo.java"));
75  
76          final DefaultConfiguration moduleConfig =
77                  createModuleConfig(RequireThisCheck.class);
78          moduleConfig.addProperty("validateOnlyOverlapping", "false");
79  
80          final String[] expectedViolation = {
81              "9:9: " + getCheckMessage(RequireThisCheck.class,
82                  RequireThisCheck.MSG_METHOD, "method1", ""),
83          };
84  
85          final List<String> expectedXpathQueries = Collections.singletonList(
86              "/COMPILATION_UNIT/CLASS_DEF"
87                  + "[./IDENT[@text='InputXpathRequireThisTwo']]/OBJBLOCK"
88                  + "/METHOD_DEF[./IDENT[@text='method2']]/SLIST/EXPR"
89                  + "/METHOD_CALL/IDENT[@text='method1']"
90          );
91  
92          runVerifications(moduleConfig, fileToProcess, expectedViolation,
93                  expectedXpathQueries);
94      }
95  }