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.annotation;
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.annotation.PackageAnnotationCheck;
31  
32  public class XpathRegressionPackageAnnotationTest extends AbstractXpathTestSupport {
33  
34      private final String checkName = PackageAnnotationCheck.class.getSimpleName();
35  
36      @Override
37      protected String getPackageLocation() {
38          return "org/checkstyle/suppressionxpathfilter/annotation/packageannotation";
39      }
40  
41      @Override
42      protected String getCheckName() {
43          return checkName;
44      }
45  
46      @Test
47      public void testOne() throws Exception {
48          final File fileToProcess =
49                  new File(getNonCompilablePath(
50                          "InputXpathPackageAnnotationOne.java"));
51  
52          final DefaultConfiguration moduleConfig =
53                  createModuleConfig(PackageAnnotationCheck.class);
54  
55          final String[] expectedViolation = {
56              "4:1: " + getCheckMessage(PackageAnnotationCheck.class,
57                  PackageAnnotationCheck.MSG_KEY),
58          };
59  
60          final List<String> expectedXpathQueries =
61                  Arrays.asList("/COMPILATION_UNIT", "/COMPILATION_UNIT/PACKAGE_DEF");
62  
63          runVerifications(moduleConfig, fileToProcess, expectedViolation,
64                  expectedXpathQueries);
65      }
66  
67      @Test
68      public void testTwo() throws Exception {
69          final File fileToProcess =
70                  new File(getNonCompilablePath(
71                          "InputXpathPackageAnnotationTwo.java"));
72  
73          final DefaultConfiguration moduleConfig =
74                  createModuleConfig(PackageAnnotationCheck.class);
75  
76          final String[] expectedViolation = {
77              "4:1: " + getCheckMessage(PackageAnnotationCheck.class,
78                  PackageAnnotationCheck.MSG_KEY),
79          };
80  
81          final List<String> expectedXpathQueries =
82                  Arrays.asList("/COMPILATION_UNIT", "/COMPILATION_UNIT/PACKAGE_DEF");
83  
84          runVerifications(moduleConfig, fileToProcess, expectedViolation,
85                  expectedXpathQueries);
86      }
87  }