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.Arrays;
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.OverloadMethodsDeclarationOrderCheck;
30  
31  public class XpathRegressionOverloadMethodsDeclarationOrderTest extends AbstractXpathTestSupport {
32  
33      private final Class<OverloadMethodsDeclarationOrderCheck> clazz =
34              OverloadMethodsDeclarationOrderCheck.class;
35  
36      @Override
37      protected String getCheckName() {
38          return clazz.getSimpleName();
39      }
40  
41      @Test
42      public void testDefault() throws Exception {
43          final File fileToProcess = new File(
44                  getPath("InputXpathOverloadMethodsDeclarationOrderDefault.java"));
45  
46          final DefaultConfiguration moduleConfig = createModuleConfig(clazz);
47  
48          final String[] expectedViolation = {
49              "14:5: " + getCheckMessage(clazz,
50                          OverloadMethodsDeclarationOrderCheck.MSG_KEY, "5"),
51          };
52  
53          final List<String> expectedXpathQueries = Arrays.asList(
54                  "/COMPILATION_UNIT/CLASS_DEF[./IDENT"
55                          + "[@text='InputXpathOverloadMethodsDeclarationOrderDefault']]"
56                          + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='overloadMethod']]",
57                  "/COMPILATION_UNIT/CLASS_DEF[./IDENT"
58                          + "[@text='InputXpathOverloadMethodsDeclarationOrderDefault']]"
59                          + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='overloadMethod']]/MODIFIERS",
60                  "/COMPILATION_UNIT/CLASS_DEF[./IDENT"
61                          + "[@text='InputXpathOverloadMethodsDeclarationOrderDefault']]"
62                          + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='overloadMethod']]"
63                          + "/MODIFIERS/LITERAL_PUBLIC"
64          );
65  
66          runVerifications(moduleConfig, fileToProcess, expectedViolation, expectedXpathQueries);
67      }
68  
69      @Test
70      public void testAnonymous() throws Exception {
71          final File fileToProcess = new File(
72                  getPath("InputXpathOverloadMethodsDeclarationOrderAnonymous.java"));
73  
74          final DefaultConfiguration moduleConfig = createModuleConfig(clazz);
75  
76          final String[] expectedViolation = {
77              "30:9: " + getCheckMessage(clazz,
78                      OverloadMethodsDeclarationOrderCheck.MSG_KEY, "21"),
79          };
80  
81          final List<String> expectedXpathQueries = Arrays.asList(
82                  "/COMPILATION_UNIT/CLASS_DEF[./IDENT[@text="
83                          + "'InputXpathOverloadMethodsDeclarationOrderAnonymous']]"
84                          + "/OBJBLOCK/CLASS_DEF[./IDENT[@text="
85                          + "'MyInputXpathOverloadMethodsDeclarationOrderAnonymous']]"
86                          + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='overloadMethod']]",
87                  "/COMPILATION_UNIT/CLASS_DEF[./IDENT[@text="
88                          + "'InputXpathOverloadMethodsDeclarationOrderAnonymous']]"
89                          + "/OBJBLOCK/CLASS_DEF[./IDENT[@text="
90                          + "'MyInputXpathOverloadMethodsDeclarationOrderAnonymous']]"
91                          + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='overloadMethod']]/MODIFIERS",
92                  "/COMPILATION_UNIT/CLASS_DEF[./IDENT[@text="
93                          + "'InputXpathOverloadMethodsDeclarationOrderAnonymous']]"
94                          + "/OBJBLOCK/CLASS_DEF[./IDENT[@text="
95                          + "'MyInputXpathOverloadMethodsDeclarationOrderAnonymous']]"
96                          + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='overloadMethod']]"
97                          + "/MODIFIERS/LITERAL_PUBLIC"
98          );
99  
100         runVerifications(moduleConfig, fileToProcess, expectedViolation, expectedXpathQueries);
101     }
102 
103 }