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.coding;
21  
22  import java.io.File;
23  import java.util.Arrays;
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.coding.PackageDeclarationCheck;
31  
32  public class XpathRegressionPackageDeclarationTest extends AbstractXpathTestSupport {
33  
34      private final String checkName = PackageDeclarationCheck.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/coding/packagedeclaration";
44      }
45  
46      @Test
47      public void testWrongPackage() throws Exception {
48          final File fileToProcess =
49                  new File(getNonCompilablePath("InputXpathWrongPackage.java"));
50  
51          final DefaultConfiguration moduleConfig =
52                  createModuleConfig(PackageDeclarationCheck.class);
53  
54          final String[] expectedViolation = {
55              "2:1: " + getCheckMessage(PackageDeclarationCheck.class,
56                      PackageDeclarationCheck.MSG_KEY_MISMATCH),
57          };
58  
59          final List<String> expectedXpathQueries = Arrays.asList(
60                  "/COMPILATION_UNIT", "/COMPILATION_UNIT/PACKAGE_DEF"
61          );
62  
63          runVerifications(moduleConfig, fileToProcess, expectedViolation,
64                  expectedXpathQueries);
65      }
66  
67      @Test
68      public void testMissingPackage() throws Exception {
69          final File fileToProcess =
70                  new File(getNonCompilablePath("InputXpathMissingPackage.java"));
71  
72          final DefaultConfiguration moduleConfig =
73                  createModuleConfig(PackageDeclarationCheck.class);
74  
75          final String[] expectedViolation = {
76              "3:1: " + getCheckMessage(PackageDeclarationCheck.class,
77                      PackageDeclarationCheck.MSG_KEY_MISSING),
78          };
79  
80          final List<String> expectedXpathQueries = Arrays.asList(
81                  "/COMPILATION_UNIT",
82                  "/COMPILATION_UNIT/CLASS_DEF[./IDENT[@text='InputXpathMissingPackage']]",
83                  "/COMPILATION_UNIT/CLASS_DEF"
84                          + "[./IDENT[@text='InputXpathMissingPackage']]/MODIFIERS",
85                  "/COMPILATION_UNIT/CLASS_DEF"
86                          + "[./IDENT[@text='InputXpathMissingPackage']]/MODIFIERS/LITERAL_PUBLIC"
87          );
88  
89          runVerifications(moduleConfig, fileToProcess, expectedViolation,
90                  expectedXpathQueries);
91      }
92  
93  }