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