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