View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2026 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.OpenjdkAnnotationLocationCheck;
31  
32  public class XpathRegressionOpenjdkAnnotationLocationTest extends AbstractXpathTestSupport {
33  
34      private final String checkName = OpenjdkAnnotationLocationCheck.class.getSimpleName();
35  
36      @Override
37      public String getPackageLocation() {
38          return "org/checkstyle/suppressionxpathfilter/annotation/openjdkannotationlocation";
39      }
40  
41      @Override
42      protected String getCheckName() {
43          return checkName;
44      }
45  
46      @Test
47      public void testClass() throws Exception {
48          final File fileToProcess = new File(getPath(
49                  "InputXpathOpenjdkAnnotationLocation1.java"));
50  
51          final DefaultConfiguration moduleConfig =
52                  createModuleConfig(OpenjdkAnnotationLocationCheck.class);
53  
54          final String[] expectedViolation = {
55              "6:25: " + getCheckMessage(OpenjdkAnnotationLocationCheck.class,
56                      OpenjdkAnnotationLocationCheck.MSG_KEY_ANNOTATION_ON_TARGET_LINE,
57                      "InputXpathOpenjdkAnnotationLocation1"),
58          };
59  
60          final List<String> expectedXpathQueries = List.of(
61                  "/COMPILATION_UNIT/CLASS_DEF[./IDENT"
62                       + "[@text='InputXpathOpenjdkAnnotationLocation1']]/LITERAL_CLASS"
63          );
64  
65          runVerifications(moduleConfig, fileToProcess, expectedViolation,
66                  expectedXpathQueries);
67      }
68  
69      @Test
70      public void testEnum() throws Exception {
71          final File fileToProcess = new File(getPath(
72                  "InputXpathOpenjdkAnnotationLocation2.java"));
73  
74          final DefaultConfiguration moduleConfig =
75                  createModuleConfig(OpenjdkAnnotationLocationCheck.class);
76  
77          final String[] expectedViolation = {
78              "6:24: " + getCheckMessage(OpenjdkAnnotationLocationCheck.class,
79                      OpenjdkAnnotationLocationCheck.MSG_KEY_ANNOTATION_ON_TARGET_LINE,
80                      "InputXpathOpenjdkAnnotationLocation2"),
81          };
82  
83          final List<String> expectedXpathQueries = List.of(
84                  "/COMPILATION_UNIT/ENUM_DEF[./IDENT"
85                          + "[@text='InputXpathOpenjdkAnnotationLocation2']]/ENUM"
86          );
87  
88          runVerifications(moduleConfig, fileToProcess, expectedViolation,
89                  expectedXpathQueries);
90  
91      }
92  
93      @Test
94      public void testMethod() throws Exception {
95          final File fileToProcess = new File(getPath(
96                  "InputXpathOpenjdkAnnotationLocation3.java"));
97  
98          final DefaultConfiguration moduleConfig =
99                  createModuleConfig(OpenjdkAnnotationLocationCheck.class);
100         moduleConfig.addProperty("tokens", "METHOD_DEF");
101 
102         final String[] expectedViolation = {
103             "7:30: " + getCheckMessage(OpenjdkAnnotationLocationCheck.class,
104                     OpenjdkAnnotationLocationCheck.MSG_KEY_ANNOTATION_ON_TARGET_LINE,
105                     "foo1"),
106         };
107 
108         final List<String> expectedXpathQueries = Arrays.asList(
109                 "/COMPILATION_UNIT/CLASS_DEF[./IDENT[@text='InputXpathOpenjdkAnnotationLocation3']"
110                         + "]/OBJBLOCK/METHOD_DEF[./IDENT[@text='foo1']]/TYPE",
111                 "/COMPILATION_UNIT/CLASS_DEF[./IDENT[@text='InputXpathOpenjdkAnnotationLocation3']"
112                         + "]/OBJBLOCK/METHOD_DEF[./IDENT[@text='foo1']]/TYPE/LITERAL_VOID"
113         );
114 
115         runVerifications(moduleConfig, fileToProcess, expectedViolation,
116                 expectedXpathQueries);
117 
118     }
119 
120 }