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