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.DeclarationOrderCheck;
30  
31  public class XpathRegressionDeclarationOrderTest extends AbstractXpathTestSupport {
32  
33      private final String checkName = DeclarationOrderCheck.class.getSimpleName();
34  
35      @Override
36      protected String getCheckName() {
37          return checkName;
38      }
39  
40      @Test
41      public void testNonStatic() throws Exception {
42          final File fileToProcess =
43                  new File(getPath("InputXpathDeclarationOrderNonStatic.java"));
44  
45          final DefaultConfiguration moduleConfig =
46                  createModuleConfig(DeclarationOrderCheck.class);
47  
48          final String[] expectedViolation = {
49              "5:5: " + getCheckMessage(DeclarationOrderCheck.class,
50                  DeclarationOrderCheck.MSG_ACCESS),
51          };
52  
53          final List<String> expectedXpathQueries = Arrays.asList(
54                  "/COMPILATION_UNIT/CLASS_DEF"
55                          + "[./IDENT[@text='InputXpathDeclarationOrderNonStatic']]"
56                          + "/OBJBLOCK/VARIABLE_DEF[./IDENT[@text='name']]",
57                  "/COMPILATION_UNIT/CLASS_DEF"
58                          + "[./IDENT[@text='InputXpathDeclarationOrderNonStatic']]"
59                          + "/OBJBLOCK/VARIABLE_DEF[./IDENT[@text='name']]/MODIFIERS",
60                  "/COMPILATION_UNIT/CLASS_DEF"
61                          + "[./IDENT[@text='InputXpathDeclarationOrderNonStatic']]"
62                          + "/OBJBLOCK/VARIABLE_DEF[./IDENT[@text='name']]/MODIFIERS/LITERAL_PUBLIC"
63          );
64  
65          runVerifications(moduleConfig, fileToProcess, expectedViolation,
66                  expectedXpathQueries);
67      }
68  
69      @Test
70      public void testStatic() throws Exception {
71          final File fileToProcess =
72                  new File(getPath("InputXpathDeclarationOrderStatic.java"));
73  
74          final DefaultConfiguration moduleConfig =
75                  createModuleConfig(DeclarationOrderCheck.class);
76  
77          final String[] expectedViolation = {
78              "5:5: " + getCheckMessage(DeclarationOrderCheck.class,
79                  DeclarationOrderCheck.MSG_STATIC),
80          };
81  
82          final List<String> expectedXpathQueries = Arrays.asList(
83                  "/COMPILATION_UNIT/CLASS_DEF"
84                          + "[./IDENT[@text='InputXpathDeclarationOrderStatic']]"
85                          + "/OBJBLOCK/VARIABLE_DEF[./IDENT[@text='MAX']]",
86                  "/COMPILATION_UNIT/CLASS_DEF"
87                          + "[./IDENT[@text='InputXpathDeclarationOrderStatic']]"
88                          + "/OBJBLOCK/VARIABLE_DEF[./IDENT[@text='MAX']]/MODIFIERS",
89                  "/COMPILATION_UNIT/CLASS_DEF"
90                          + "[./IDENT[@text='InputXpathDeclarationOrderStatic']]"
91                          + "/OBJBLOCK/VARIABLE_DEF[./IDENT[@text='MAX']]/MODIFIERS/LITERAL_PUBLIC"
92          );
93  
94          runVerifications(moduleConfig, fileToProcess, expectedViolation,
95                  expectedXpathQueries);
96      }
97  }