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.whitespace.MethodParamPadCheck;
30  
31  public class XpathRegressionMethodParamPadTest extends AbstractXpathTestSupport {
32  
33      private final String checkName = MethodParamPadCheck.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("InputXpathMethodParamPadOne.java"));
44  
45          final DefaultConfiguration moduleConfig =
46                  createModuleConfig(MethodParamPadCheck.class);
47  
48          final String[] expectedViolation = {
49              "4:37: " + getCheckMessage(MethodParamPadCheck.class,
50                  MethodParamPadCheck.MSG_WS_PRECEDED, "("),
51          };
52  
53          final List<String> expectedXpathQueries = Collections.singletonList(
54              "/COMPILATION_UNIT/CLASS_DEF[./IDENT"
55                  + "[@text='InputXpathMethodParamPadOne']]/OBJBLOCK"
56                  + "/METHOD_DEF[./IDENT[@text='InputMethodParamPad']]/LPAREN"
57          );
58  
59          runVerifications(moduleConfig, fileToProcess, expectedViolation,
60                  expectedXpathQueries);
61      }
62  
63      @Test
64      public void testTwo() throws Exception {
65          final File fileToProcess =
66                  new File(getPath("InputXpathMethodParamPadTwo.java"));
67  
68          final DefaultConfiguration moduleConfig =
69                  createModuleConfig(MethodParamPadCheck.class);
70  
71          final String[] expectedViolation = {
72              "5:13: " + getCheckMessage(MethodParamPadCheck.class,
73                  MethodParamPadCheck.MSG_LINE_PREVIOUS, "("),
74          };
75  
76          final List<String> expectedXpathQueries = Collections.singletonList(
77              "/COMPILATION_UNIT/CLASS_DEF[./IDENT"
78                  + "[@text='InputXpathMethodParamPadTwo']]/OBJBLOCK"
79                  + "/METHOD_DEF[./IDENT[@text='sayHello']]/LPAREN"
80          );
81  
82          runVerifications(moduleConfig, fileToProcess, expectedViolation,
83                  expectedXpathQueries);
84      }
85  
86      @Test
87      public void testThree() throws Exception {
88          final File fileToProcess =
89                  new File(getPath("InputXpathMethodParamPadThree.java"));
90  
91          final DefaultConfiguration moduleConfig =
92                  createModuleConfig(MethodParamPadCheck.class);
93          moduleConfig.addProperty("option", "space");
94  
95          final String[] expectedViolation = {
96              "4:25: " + getCheckMessage(MethodParamPadCheck.class,
97                  MethodParamPadCheck.MSG_WS_NOT_PRECEDED, "("),
98          };
99  
100         final List<String> expectedXpathQueries = Collections.singletonList(
101             "/COMPILATION_UNIT/CLASS_DEF[./IDENT"
102                 + "[@text='InputXpathMethodParamPadThree']]/OBJBLOCK"
103                 + "/METHOD_DEF[./IDENT[@text='sayHello']]/LPAREN"
104         );
105 
106         runVerifications(moduleConfig, fileToProcess, expectedViolation,
107                 expectedXpathQueries);
108     }
109 }