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